Django 1.11 compatible and cleaned up

1 files changed, 46 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2714a2a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,46 @@
+
+## Installing
+
+```
+docker build --no-cache=true -t ndn-pwman .
+```
+
+Migrate db if necessary.
+
+```
+docker run --rm -ti ndn-pwman migrate
+```
+
+Then run a collect static:
+
+```
+docker run --rm --ti ndn-pwman -v /opt/pwman-statics:/opt/statics collectstatic
+```
+
+You need a useradmin keytab file, and the admin password for our ldap.
+
+## Running pwman
+
+```
+	docker run --rm -ti --name pwman -e LDAP_PASSWORD="1234secrets" -v useradmin.keytab:/etc/useradmin.keytab ndn-pwman server
+```
+
+
+## Debugging
+
+You can run the image with the argument shell.
+
+```
+docker run --rm -ti ndn-pwman shell
+```
+
+## Environement variables
+
+- LDAP_URL
+- LDAP_USER
+- LDAP_PASSWORD
+- KERBEROS_SCRIPT 
+- DEBUG_MODE
+- SECRET_KEY_FILE
+- SECRET_KEY
+- DATA_DIR - defaults to `/opt/pwman`