- added readme file for ldap support

1 files changed, 51 insertions, 0 deletions

diff --git a/README.LDAP b/README.LDAP
new file mode 100644
index 0000000..05260f5
--- /dev/null
+++ b/README.LDAP
@@ -0,0 +1,51 @@
+A Repsys plugin for obtaining users from a LDAP server.
+
+In order to enable the plugin, the user must define the following 
+options in the [global] section of repsys.conf:
+
+    ldap-server [required]
+        the host name of the LDAP server
+    ldap-port [optional] [default: 389]
+        the port of the LDAP server
+    ldap-base [required]
+        the base DN where the search will be performed
+    ldap-binddn [optional] [default: empty]
+        the DN used to bind
+    ldap-bindpw [optional] [default: empty]
+        the password used to bind
+    ldap-filterformat [optional] 
+                      [default: (&(objectClass=inetOrgPerson)(uid=%s))]
+        RFC-2254 filter string used in the search of the user entry.
+        Note that this is a python format string and will have the user
+        name as parameter. For example:
+
+           ldap-filterformat = (&(objectClass=inetOrgPerson)(uid=%s))
+
+        Will result in the search filter:
+
+           (&(objectClass=inetOrgPerson)(uid=john))
+
+    ldap-format [optional] [default: %(cn)s <%(mail)s>]
+        This is a python format string. This string will be 
+        formatted using one dict object containing the fields
+        returned in the LDAP search, for example:
+
+          >>> format = "%(cn)s <%(mail)s>"
+          >>> d = search(basedn, filter)
+          >>> d = {"cn": "John Doe", "mail": "john@mandriva.org", 
+                   "uidNumber": "1290", "loginShell": "/bin/bash", 
+                   ... many other attributes ... }
+          >>> value = format % d
+          >>> print value
+          John Doe <john@mandriva.org>
+
+        Note that only the first value of the attributes will be 
+        used.
+
+When the searched option is not found, it will try in repsys.conf. All
+the values found (including from repsys.conf) will be cached between
+each configuration access.
+
+This plugin requires the package python-ldap.
+
+For more information, look http://qa.mandriva.com/show_bug.cgi?id=30549