Configure Optional
Version 3 (Bryan Heath, 06/27/2012 06:13 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 | 2 | Bryan Heath | h1. @$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 | 2 | Bryan Heath | h2. 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 | 2 | Bryan Heath | h1. @$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 | 2 | Bryan Heath | h2. Example: |
| 32 | 1 | ||
| 33 | 1 | $valid_user_groups = array('Customer Service', 'IS'); |
|
| 34 | 1 | ||
| 35 | 3 | Bryan Heath | h1. @define('KAYAKO_LDAP_VERIFY_CONTROLLER', true);@ |
| 36 | 3 | Bryan Heath | |
| 37 | 3 | Bryan Heath | This is only used if more than one domain controller is used for authentication. |
| 38 | 3 | Bryan Heath | |
| 39 | 3 | Bryan Heath | * true - adLDAP will attempt to verify it can connect to one of the controllers. If failed it will try another until one is found or all have been tried |
| 40 | 3 | Bryan Heath | * false - The default behavior is used where adLDAP will to try to connect to one random controller in the list. If failed it will NOT try another server. |
| 41 | 3 | Bryan Heath | |
| 42 | 2 | Bryan Heath | h1. @define('KAYAKO_LDAP_ERROR_USERGROUP', true);@ |
| 43 | 1 | ||
| 44 | 1 | * true - User will receive an error if they are not in any of the user groups |
|
| 45 | 1 | * false - Users not in the $user_group can still login they just will not be in a User Group |
|
| 46 | 1 | ||
| 47 | 2 | Bryan Heath | h1. @define('KAYAKO_LDAP_TEST', false);@ |
| 48 | 1 | ||
| 49 | 1 | * true - Test mode enabled |
|
| 50 | 1 | * false - Test mode disabled |
|
| 51 | 1 | ** username and password is ignored |
|
| 52 | 1 | ||
| 53 | 3 | Bryan Heath | h1. @define('KAYAKO_LDAP_SHOW_ERRORS', false);@ |
| 54 | 3 | Bryan Heath | |
| 55 | 3 | Bryan Heath | * true - Show errors and/or warnings on the screen. Please note that this will cause login to fail if there is even one displayed. Thus this should +*only*+ be used for testing |
| 56 | 3 | Bryan Heath | * false - Hides them |
| 57 | 3 | Bryan Heath | |
| 58 | 2 | Bryan Heath | h1. @define('KAYAKO_LDAP_LOG', false);@ |
| 59 | 1 | ||
| 60 | 1 | * true - Logging enabled |
|
| 61 | 1 | * false - Logging disabled |
|
| 62 | 1 | * The /ldap/log directory must be writable (755 or 777) |
|
| 63 | 1 | * You should leave this disabled unless needed as it does extensive logging |
|
| 64 | 3 | Bryan Heath | |
| 65 | 3 | Bryan Heath | h1. @define('KAYAKO_LDAP_LOG_XML', false);@ |
| 66 | 3 | Bryan Heath | |
| 67 | 3 | Bryan Heath | * true - Log the XML output |
| 68 | 3 | Bryan Heath | * false - Disabled |
| 69 | 3 | Bryan Heath | |
| 70 | 3 | Bryan Heath | h1. @define('KAYAKO_LDAP_LOG_OUTPUT', false);@ |
| 71 | 3 | Bryan Heath | |
| 72 | 3 | Bryan Heath | * true - Attempts to log everything displayed to the screen |
| 73 | 3 | Bryan Heath | * false - Disabled |
| 74 | 1 | ||
| 75 | 2 | Bryan Heath | h1. @define('KAYAKO_LDAP_USERNAME', 'username');@ |
| 76 | 1 | ||
| 77 | 1 | A valid AD username to test with |
|
| 78 | 1 | ||
| 79 | 2 | Bryan Heath | h1. @define('KAYAKO_LDAP_PASSWORD', 'password');@ |
| 80 | 1 | ||
| 81 | 1 | The password to go with KAYAKO_LDAP_USERNAME |
|
| 82 | 1 | ||
| 83 | 2 | Bryan Heath | h1. @define('KAYAKO_LDAP_STRIP_EMAIL', true);@ |
| 84 | 1 | ||
| 85 | 1 | If found will strip email or domain suffix from a username |
|
| 86 | 1 | ||
| 87 | 1 | * true - Enabled |
|
| 88 | 1 | * false - Disabled |
|
| 89 | 1 | ||
| 90 | 2 | Bryan Heath | h2. Example: |
| 91 | 1 | ||
| 92 | 1 | If enabled: |
|
| 93 | 1 | If the username entered was username@mysite.com it would be changed to username |
|
| 94 | 1 | ||
| 95 | 2 | Bryan Heath | h1. @define('KAYAKO_LDAP_PHONE_NUMBER', true);@ |
| 96 | 1 | ||
| 97 | 1 | * true - The AD mobile or home number will be used if the AD telephone number is empty |
|
| 98 | 1 | * false - Disabled |