added support for list users from ldap.
[moodle.git] / auth / ldap / README-LDAP
1 LDAP-module README
2 07.10.2002 Version 0.1, Petri Asikainen <>
4 Ldap-authetication module is work in progress. 
5 Right now we are building config-interface to use also with all other auth-modules, 
6 but it will take sometime.
8 If you like to try ldap-authentication now , create following $CFG->variables to
9 /moodle/config.php or directly to config-table and activate ldap authentication 
10 from admin-configuration page.
12 Variable                        Description
13 $CFG->ldap_bind_dn              "If your like to use bind-user to search
14                                 users, specify it here. Something like 
15                                 'cn=ldapuser,ou=public,o=org'"
16 $CFG->ldap_bind_pw              "Password for bind-user."
17 $CFG->ldap_contexts             "List of contexts where users are located.
18                                  Separate different contexts with ';'.
19                                 Something like 
20                                 'ou=users,o=org; ou=other,o=org'"
21 $CFG->ldap_host_url             "Specify LDAP host in URL-form, like
22                                 'ldap://' or 
23                                 'ldaps//' "
24 $CFG->ldap_search_sub           "Put value <> 0 if  you like to 
25                                 search users from subcontexts. 
26                                 (Subsearching is sometimes slow)"
27 $CFG->ldap_user_attribute       "What attribute is used to name/search
28                                 users. Usually 'cn' when using 
29                                 Novell e-directory
30 $CFG->ldap_objectclass          When filtering objects from ldap this filter is used
31                                 defaults to "objectClass=*"
33 And if you like to _very_ experimental:
34 Edit /auth/ldap/lib.php function auth_get_userinfo() attribute-mappings and
35 set $CFG->auth_update_userinfo = 1
36 Then moodle will get user first-, lastname and other information from ldap
37 when user is login first time.