aboutsummaryrefslogtreecommitdiff
path: root/app
diff options
context:
space:
mode:
Diffstat (limited to 'app')
-rw-r--r--app/README.md34
-rw-r--r--app/requirements.txt3
2 files changed, 37 insertions, 0 deletions
diff --git a/app/README.md b/app/README.md
index a877cfa..21eb936 100644
--- a/app/README.md
+++ b/app/README.md
@@ -1,3 +1,37 @@
+## How to install `secretmgr`
+
+How to install its dependencies:
+
+```bash
+# on fedora:
+dnf install -y openldap-devel
+# on ubuntu:
+apt-get install -y libldap2-dev
+
+# for eveyrone:
+pip3 install --user --requirement requirements.txt
+```
+
+## How to use `secretmgr`
+
+Check that all secrets are correctly deployed for app `dummy`:
+
+```bash
+./secretmgr.py check dummy
+```
+
+Generate secrets for app `dummy` if they don't already exist:
+
+```bash
+./secretmgr.py gen dummy
+```
+
+Rotate secrets for app `dummy`, overwriting existing ones (be careful, this is dangerous!):
+
+```bash
+./secretmgr.py regen dummy
+```
+
## How to upgrade our packaged apps to a new version?
1. Edit `docker-compose.yml`
diff --git a/app/requirements.txt b/app/requirements.txt
new file mode 100644
index 0000000..7874d93
--- /dev/null
+++ b/app/requirements.txt
@@ -0,0 +1,3 @@
+python-consul==1.1.0
+python-ldap==3.3.1
+passlib==1.7.4