added documentation about LDAP setup

1 files changed, 31 insertions, 0 deletions

diff --git a/askbot/doc/source/optional-modules.rst b/askbot/doc/source/optional-modules.rst
index d7ca2f24..9b73a5a8 100644
--- a/askbot/doc/source/optional-modules.rst
+++ b/askbot/doc/source/optional-modules.rst
@@ -5,6 +5,37 @@ Optional modules
 Askbot supports a number of optional modules, enabling certain features, not available 
 in askbot by default.
 
+.. _ldap:
+
+LDAP authentication
+===================
+
+To enable authentication via LDAP
+(Lightweight Directory Access Protocol, see more info elsewhere)
+, first :ref:`install <installation-of-python-packages>`
+``python-ldap`` package:
+
+    pip install python-ldap
+
+After that, add configuration parameters in :ref:`live settings <live-settings>`, section
+"Keys to connect the site with external services ..." 
+(url ``/settings/EXTERNAL_KEYS``, relative to the domain name)
+
+.. note::
+    Location of these parameters is likely to change in the future.
+    When that happens, an update notice will appear in the documentation.
+
+The parameters are:
+
+* "Use LDAP authentication for the password login" - enable/disable the feature.
+  When enabled, the user name and password will be routed to use the LDAP protocol.
+  Default system password authentication will be overridden.
+* "LDAP service provider name" - any string - just come up with a name for the provider service.
+* "URL fro the LDAP service" - a correct url to access the service.
+* "Explain how to change the LDAP password"
+  - askbot does not provide a method to change LDAP passwords
+  , therefore - use this field to explain users how they can change their passwords.
+
 Uploaded avatars
 ================