From 482c3320ea889496bfc695fd9c47f08788c02e62 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Andreas=20=C3=85kre=20Solberg?= <andreas.solberg@uninett.no>
Date: Fri, 27 Feb 2009 22:12:48 +0000
Subject: [PATCH] Added documentation placeholder for more information about
 the LDAP configuration...

git-svn-id: https://simplesamlphp.googlecode.com/svn/trunk@1340 44740490-163a-0410-bde0-09ae8108e29a
---
 docs/ldap_config.txt | 44 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)
 create mode 100644 docs/ldap_config.txt

diff --git a/docs/ldap_config.txt b/docs/ldap_config.txt
new file mode 100644
index 000000000..8c1f07d7f
--- /dev/null
+++ b/docs/ldap_config.txt
@@ -0,0 +1,44 @@
+The LDAP configuration array
+============================
+
+
+The LDAP configuration array is used in all of the LDAP based authentication modules. 
+
+We distinguish between two modes of deciding the DN of the user.
+
+  1. Search for DN by userid attribute, usually `eduPersonPrincipalName`.
+  2. Decide the DN based on a known pattern and then filling in the username.
+
+
+Example configuration for DN search
+-----------------------------------
+
+TBA
+
+Example configuration for DN pattern
+------------------------------------
+
+TBA
+
+
+
+List of parameters
+------------------
+
+
+  * type which LDAP backend to use.
+  * testType A class that defines a test for it.
+  * hostname (required)
+  * enable_tls (optional)
+  * debugLDAP (optional)
+  * timeout (optional)  default: 20s
+  * adminUser (optional)
+  * adminPassword (required if adminUser is set)
+  * useridAttr (optional) default: eduPersonPrincipalName
+  * searchbase (required)
+  * dnpattern
+  * attributesize.max (optional) defualt: 
+  * debug
+  * contactMail
+  * contactUrl
+  * comment
-- 
GitLab