Configure Optional
Version 1 (Bryan Heath, 06/08/2012 03:18 pm)
| 1 | 1 | h1. Configure Optional |
|
|---|---|---|---|
| 2 | 1 | ||
| 3 | 1 | Everything is pretty well documented in the /ldap/config.php file however here is a more inclusive documentation |
|
| 4 | 1 | ||
| 5 | 1 | For all the examples below we will be using mysite.com as the AD prefix and DC=mysite,DC=com as the base DN |
|
| 6 | 1 | ||
| 7 | 1 | h2. @$user_groups = array();@ |
|
| 8 | 1 | ||
| 9 | 1 | +*This is not required for a user to login*+ |
|
| 10 | 1 | ||
| 11 | 1 | A valid AD user groups (see KAYAKO_LDAP_ERROR_USERGROUP as well) to user group |
|
| 12 | 1 | * AD_Group => Kayako_User_Group |
|
| 13 | 1 | * Can do more than one |
|
| 14 | 1 | ||
| 15 | 1 | h3. Example: |
|
| 16 | 1 | ||
| 17 | 1 | Lets say you have a AD group called Customer Service and a Kayako user group called Service: |
|
| 18 | 1 | ||
| 19 | 1 | @$user_groups = array('Customer Service' => 'Service');@ |
|
| 20 | 1 | More than one: |
|
| 21 | 1 | @$user_groups = array('Customer Service' => 'Service', 'Finance' => 'Service');@ |
|
| 22 | 1 | ||
| 23 | 1 | h2. @$valid_user_groups = array();@ |
|
| 24 | 1 | ||
| 25 | 1 | +*This is not required for a user to login*+ |
|
| 26 | 1 | ||
| 27 | 1 | A AD groups a user +must+ be in to login |
|
| 28 | 1 | * If they are not in one of these groups they will +*not*+ be able to login |
|
| 29 | 1 | * Can do more than one |
|
| 30 | 1 | ||
| 31 | 1 | h3. Example: |
|
| 32 | 1 | ||
| 33 | 1 | $valid_user_groups = array('Customer Service', 'IS'); |
|
| 34 | 1 | ||
| 35 | 1 | h2. @define('KAYAKO_LDAP_ERROR_USERGROUP', true);@ |
|
| 36 | 1 | ||
| 37 | 1 | * true - User will receive an error if they are not in any of the user groups |
|
| 38 | 1 | * false - Users not in the $user_group can still login they just will not be in a User Group |
|
| 39 | 1 | ||
| 40 | 1 | h2. @define('KAYAKO_LDAP_TEST', false);@ |
|
| 41 | 1 | ||
| 42 | 1 | * true - Test mode enabled |
|
| 43 | 1 | * false - Test mode disabled |
|
| 44 | 1 | ** username and password is ignored |
|
| 45 | 1 | ||
| 46 | 1 | h2. @define('KAYAKO_LDAP_LOG', false);@ |
|
| 47 | 1 | ||
| 48 | 1 | * true - Logging enabled |
|
| 49 | 1 | * false - Logging disabled |
|
| 50 | 1 | * The /ldap/log directory must be writable (755 or 777) |
|
| 51 | 1 | * You should leave this disabled unless needed as it does extensive logging |
|
| 52 | 1 | ||
| 53 | 1 | h2. @define('KAYAKO_LDAP_USERNAME', 'username');@ |
|
| 54 | 1 | ||
| 55 | 1 | A valid AD username to test with |
|
| 56 | 1 | ||
| 57 | 1 | h2. @define('KAYAKO_LDAP_PASSWORD', 'password');@ |
|
| 58 | 1 | ||
| 59 | 1 | The password to go with KAYAKO_LDAP_USERNAME |
|
| 60 | 1 | ||
| 61 | 1 | h2. @define('KAYAKO_LDAP_STRIP_EMAIL', true);@ |
|
| 62 | 1 | ||
| 63 | 1 | If found will strip email or domain suffix from a username |
|
| 64 | 1 | ||
| 65 | 1 | * true - Enabled |
|
| 66 | 1 | * false - Disabled |
|
| 67 | 1 | ||
| 68 | 1 | h3. Example: |
|
| 69 | 1 | ||
| 70 | 1 | If enabled: |
|
| 71 | 1 | If the username entered was username@mysite.com it would be changed to username |
|
| 72 | 1 | ||
| 73 | 1 | h2. @define('KAYAKO_LDAP_PHONE_NUMBER', true);@ |
|
| 74 | 1 | ||
| 75 | 1 | * true - The AD mobile or home number will be used if the AD telephone number is empty |
|
| 76 | 1 | * false - Disabled |