From c075872b437898ce76e2422bb92fd0c43dca4e50 Mon Sep 17 00:00:00 2001
From: downhill <downhill@geekhabitat.de>
Date: Sun, 14 Oct 2018 23:30:58 +0200
Subject: [PATCH] wrote README.md, some minor changes to settings.py and
 nameko.conf

---
 README.md           | 26 ++++++++++++++++++++++++++
 dal/dal/settings.py |  1 +
 nameko.conf         |  5 +++++
 3 files changed, 32 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..79100d4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+== Userservice using LDAP ==
+
+=== What is it? ===
+
+The userservice is just using LDAP to authenticate, create, delete, and change data for users\. With it, you can easily create a user in the
+LDAP, change some data (for now: firstname, lastname, email) for your user, change your password, or delete the useraccount\. The request for
+a password reset is still WIP\.
+
+
+=== Installation ===
+
+In the requirements\.txt are the python modules it uses\. Install with a virtualenv with python3\.
+Be aware that django-auth-ldap uses python-ldap and thus wants some system libraries\. Also, since it's using nameko, you should
+provide a rabbitmq for it to use\.
+Also django-nameko has a typo and you should edit the $virtualenv/lib/python3.5/site-packages/django\_nameko/\_\_init\_\_\.py from 
+```
+from rpc import
+``` 
+to
+```
+from .rpc import
+```
+till it's fixed\.
+Config options are in nameko\.conf and of course the dal/dal/settings\.py 
+The standard settings there work fine with a LDAP server set up with the information on our wiki\. Except the manager password,
+set that to what you choose\.
diff --git a/dal/dal/settings.py b/dal/dal/settings.py
index 2ce1abe..7ee1070 100644
--- a/dal/dal/settings.py
+++ b/dal/dal/settings.py
@@ -55,6 +55,7 @@ NAMEKO_CONFIG = {
 # Standard pool size
 NAMEKO_POOL_SIZE = 4
 
+# Django nameko config end
 
 # Build paths inside the project like this: os.path.join(BASE_DIR, ...)
 BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
diff --git a/nameko.conf b/nameko.conf
index 67c7576..7510441 100644
--- a/nameko.conf
+++ b/nameko.conf
@@ -1,14 +1,19 @@
 [System]
 
+# where the rabbitmq server lives and how to connect
 RABBITMQ = guest:guest@localhost
 
+# where to put the ldap.log
 LOGDIR = /home/downhill/ungleich/dal/
 
 [LDAP]
 
+# How many ldapservers are supplied
 SERVERMULTIPLE = 1
 
+# the list of ldapservers, just number sequentially
 LDAPSERVER1 = localhost
 
+# Change to something which has enough access to create users, change things around, etc
 LDAPMANAGER = cn=manager,dc=ungleich,dc=ch
 LDAPMANAGERPASSWORD = foobar