configured
[bMailZu.git] / docs / AD_README
blobd12b135fff12718deab02536cc59a479d1f51f0e
1 Active Directory Autentication Settings
2 ----------------------------------------
4 To configure MailZu to authenticate users against Active Directory.
5 Edit the config/config.php and tailor the variables mentioned here for your
6 environment.
8   // Set an authentication method: 'ldap','ad', or 'sql'
9   $conf['auth']['serverType'] = 'ad';
11 Set the AD host(s) and search base
13   // List of AD Domain controllers 
14   $conf['auth']['ad_hosts'] = array( 'dc1.example.com' );
15   // if set to true, LDAP connection over SSL (PHP 4.0.4 minimum)
16   // if set to false or not set, unencrypted LDAP connection on port 389
17   $conf['auth']['ad_ssl'] = false;
19   // AD base dn, e.g. 'dc=example,dc=com'
20   $conf['auth']['ad_basedn'] = 'dc=example,dc=com';
22 Set the Active Directory domain:
24   // AD domain, e.g. 'example.com'
25   $conf['auth']['ad_domain'] = 'example.com';
27 Set the attribute usually used to identify a user in Active Directory:
29   // AD attribute used to identify a person
30   $conf['auth']['ad_user_identifier'] = 'samaccoutname';
32 Now we must set the login format. For AD the default is the 'samaccountname'
33 attribute, or if you want a fully qualified email address as the login, it
34 could be 'mail'. 
36   // AD attribute used as login, e.g. 'samaccountname' or 'mail'
37   $conf['auth']['ad_login'] = 'samaccountname';
39 At the login page of MailZu, with this setting the user would use the login
40 'user', or if the configuration variable was set to the 'mail' attribute, the
41 login would be 'user@example.com'.
43 These two attributes are enough to be authenticated to the MailZu interface,
44 but the third attribute is what determines which messages the authenticated
45 user is permitted to view. This attribute is the final recipient address. It is
46 the email address that amavisd-new reports as the envelope recipient. 
48 For example, if the login used was 'user', than there must be an attribute or
49 field that determines the email address associated with this user. Even if the
50 login was 'user@example.com' the third attribute may or may not be the same.
51 The address might have been aliased to an internal address 
52 'user@internal.example.com'.
54   // AD mail attribute used as the final recipient address
55   // Could be the actual mail attribute or another attribute
56   // (in the latter case look for the "%m" token in the ldap query filter in 
57   // amavisd.conf)
58   $conf['auth']['ad_mailAttr'] = 'mail';
60 If the attribute listed for the login format is not the same as the binding 
61 username, we must be able to search the directory. The settings below binds 
62 using this account to search the directory. AD does not allow anonymous
63 binds.
65   $conf['auth']['ad_searchUsername'] = 'manager';
66   $conf['auth']['ad_searchPassword'] = 'secret';
68 If you want to specify the name of the user in the welcome message, you need to set the parameter below. AD attribute such as 'g
69 ivenName', 'cn' or 'displayName' can be used:
70 $conf['auth']['ad_name'] = 'givenName';