diff --git a/README.md b/README.md index db41c1b..73aed09 100644 --- a/README.md +++ b/README.md @@ -21,10 +21,10 @@ Setting the groups settings will check the user is a member of that group before Configuration ------------- - * define( 'LDAPAUTH_HOST', 'ldaps://ldap.domain.com' ) LDAP host name, IP or URL. You can use ldaps://host for LDAP with TLS - * define( 'LDAPAUTH_PORT', '636' ) LDAP server port - often 389 or 636 for TLS (LDAPS) - * define( 'LDAPAUTH_BASE', 'dc=domain,dc=com' ) Base DN (location of users) - * define( 'LDAPAUTH_USERNAME_FIELD', 'uid') (optional) LDAP field name in which username is store + * define( 'LDAPAUTH_HOST', 'ldaps://ldap.domain.com' ) // LDAP host name, IP or URL. You can use ldaps://host for LDAP with TLS + * define( 'LDAPAUTH_PORT', '636' ) // LDAP server port - often 389 or 636 for TLS (LDAPS) + * define( 'LDAPAUTH_BASE', 'dc=domain,dc=com' ) // Base DN (location of users) + * define( 'LDAPAUTH_USERNAME_FIELD', 'uid') // (optional) LDAP field name in which username is store To use a privileged account for the user search: * define( 'LDAPAUTH_SEARCH_USER', 'cn=your-user,dc=domain,dc=com' ) // (optional) Privileged user to search with @@ -33,6 +33,10 @@ To use a privileged account for the user search: To check group membership before authenticating: * define( 'LDAPAUTH_GROUP_ATTR', 'memberof' ) // (optional) LDAP groups attr * define( 'LDAPAUTH_GROUP_REQ', 'the-group') // (only if LDAPAUTH_GROUP_REQ set) Group user must be in + +To automatically add LDAP users to config.php: + * define( 'LDAPAUTH_ADD_NEW', true ) // (optional) Add LDAP users to config.php +NOTE: This will require config.php to be writable by your webserver user Troubleshooting ---------------