You are here

INSTALL.txt in Lightweight Directory Access Protocol (LDAP) 7.2

Same filename and directory in other branches
  1. 8.2 INSTALL.txt
  2. 6 INSTALL.txt
  3. 7 INSTALL.txt
==================================================================================
Prerequisites
==================================================================================

To set up LDAP efficiently, you need to acquire the relevant information for the
domain you are authenticating against.

Contact your organization's staff to receive the necessary information. This
should include:

* The servers available to you (hostname, port, encryption preference)
* The binding method (service account including credentials, if necessary)
* If applicable, the structure of the data you are trying to sync, e.g.
sAMAccountName is the unique name attribute for your Active Directory.

### Requirements

The following requirements need to be met for you to work with any of the LDAP
modules.

* PHP version 5.6.
* PHP LDAP extension.

==================================================================================
 Installation instructions:
==================================================================================

1) Download the LDAP module as you would any other.

2) Go to admin/build/modules and enable the needed modules from the
   Lightweight Directory Access Protocol group.

3) Enable and configure ldap servers and configure at least one server.

4) Enable the other LDAP modules you need.

5) LDAP Help is just for debugging and administrator help. Use it if you have
problems. Disable it in production; it adds no functionality or end user help.

==================================================================================
 Configuration overrides
==================================================================================

If you need to selectively disable LDAP functionality and cannot disable the
modules, use configuration overrides, such as the following in settings.php and
clearing your cache afterwards.

// Disable the server you are syncing users from LDAP to Drupal.
$conf['ldap_user_conf']['drupalAcctProvisionServer'] = 0;
// Disable LDAP authentication.
$conf['ldap_authentication_conf']['sids'] = [];
// Set bind DN and bind password for service account.
$conf['ldap_servers_overrides']['my_server']['binddn'] = 'my_dn';
$conf['ldap_servers_overrides']['my_server']['bindpw'] = 'my_password';

IMPORTANT: These overrides will change the data in your admin forms, saving them
will save them permanently in the database.

==================================================================================
More documentation is available at:

 http://drupal.org/project/ldap -- project homepage
 http://drupal.org/node/997082 - project documentation
==================================================================================

File

INSTALL.txt
View source
  1. ==================================================================================
  2. Prerequisites
  3. ==================================================================================
  4. To set up LDAP efficiently, you need to acquire the relevant information for the
  5. domain you are authenticating against.
  6. Contact your organization's staff to receive the necessary information. This
  7. should include:
  8. * The servers available to you (hostname, port, encryption preference)
  9. * The binding method (service account including credentials, if necessary)
  10. * If applicable, the structure of the data you are trying to sync, e.g.
  11. sAMAccountName is the unique name attribute for your Active Directory.
  12. ### Requirements
  13. The following requirements need to be met for you to work with any of the LDAP
  14. modules.
  15. * PHP version 5.6.
  16. * PHP LDAP extension.
  17. ==================================================================================
  18. Installation instructions:
  19. ==================================================================================
  20. 1) Download the LDAP module as you would any other.
  21. 2) Go to admin/build/modules and enable the needed modules from the
  22. Lightweight Directory Access Protocol group.
  23. 3) Enable and configure ldap servers and configure at least one server.
  24. 4) Enable the other LDAP modules you need.
  25. 5) LDAP Help is just for debugging and administrator help. Use it if you have
  26. problems. Disable it in production; it adds no functionality or end user help.
  27. ==================================================================================
  28. Configuration overrides
  29. ==================================================================================
  30. If you need to selectively disable LDAP functionality and cannot disable the
  31. modules, use configuration overrides, such as the following in settings.php and
  32. clearing your cache afterwards.
  33. // Disable the server you are syncing users from LDAP to Drupal.
  34. $conf['ldap_user_conf']['drupalAcctProvisionServer'] = 0;
  35. // Disable LDAP authentication.
  36. $conf['ldap_authentication_conf']['sids'] = [];
  37. // Set bind DN and bind password for service account.
  38. $conf['ldap_servers_overrides']['my_server']['binddn'] = 'my_dn';
  39. $conf['ldap_servers_overrides']['my_server']['bindpw'] = 'my_password';
  40. IMPORTANT: These overrides will change the data in your admin forms, saving them
  41. will save them permanently in the database.
  42. ==================================================================================
  43. More documentation is available at:
  44. http://drupal.org/project/ldap -- project homepage
  45. http://drupal.org/node/997082 - project documentation
  46. ==================================================================================