You are here

README.txt in Simple LDAP 7.2

The Simple LDAP project is a set of modules to provide Drupal integration with
an LDAPv3 server. It is an alternative to the Lightweight Directory Access
Protocol (LDAP) module, with a much narrower set of features. The goal of the
project is to provide very basic LDAP functionality which should cover most
common use cases. Any edge case functionality or site-specific requirements
should be implemented using a helper module.

The current implementation was developed against OpenLDAP, with some testing
against Active Directory. Most functionality should work with any LDAPv3
compliant server, but this is largely untested.

The project consists of one main module, and three submodules.

Simple LDAP
===========

This is the main module, on which all of the other modules are based. It
provides an interface to the configured LDAP directory with basic low-level
LDAP functions and no bells or whistles. It does not provide anything to
Drupal on its own.

Simple LDAP User
================

This module allows authentication to the LDAP directory configured in the
Simple LDAP module. It also provides synchronization services both to and from
LDAP and Drupal. It supports mapping LDAP attributes to Drupal user object
fields (both native, and using Field API).

Simple LDAP Role
================

This module allows Drupal roles to be derived from LDAP groups, and
vice-versa. It is dependent on the Simple LDAP User module.

Simple LDAP Test
================

This is a hidden module, which provides the glue to allow SimpleTest
integration to the other modules. In order to perform the other modules'
simpletests, there is a configuration file at
simple_ldap_test/simple_ldap_test.config.inc which needs to be edited.

===============================================================================

DEVELOPERS:

Enable debugging using devel module by adding the following setting to
settings.php

$conf['simple_ldap_devel'] = TRUE;

Vagrant
=======

There is a Vagrantfile included that will build a VM with a working LDAP
directory and a fresh Drupal installation with simple_ldap installed. If OS X
is the Vagrant host, then the vagrant box is available at simpleldap.local.
For other operating systems, the IP address will need to be obtainted manually,
and added to the local hosts file for best results.

Drupal
------

The Drupal installation is set up with the following credentials:

http://simpleldap.local/

username: admin
password: admin

LDAP
----

The LDAP is pre-populated with some dummy data

ldap://simpleldap.local

DN: cn=admin,dc=local
password: admin

DN: cn=ldapuser,ou=people,dc=local
password: ldapuser

phpLDAPadmin
------------

phpLDAPadmin is available at http://simpleldap.local/pma

File

README.txt
View source
  1. The Simple LDAP project is a set of modules to provide Drupal integration with
  2. an LDAPv3 server. It is an alternative to the Lightweight Directory Access
  3. Protocol (LDAP) module, with a much narrower set of features. The goal of the
  4. project is to provide very basic LDAP functionality which should cover most
  5. common use cases. Any edge case functionality or site-specific requirements
  6. should be implemented using a helper module.
  7. The current implementation was developed against OpenLDAP, with some testing
  8. against Active Directory. Most functionality should work with any LDAPv3
  9. compliant server, but this is largely untested.
  10. The project consists of one main module, and three submodules.
  11. Simple LDAP
  12. ===========
  13. This is the main module, on which all of the other modules are based. It
  14. provides an interface to the configured LDAP directory with basic low-level
  15. LDAP functions and no bells or whistles. It does not provide anything to
  16. Drupal on its own.
  17. Simple LDAP User
  18. ================
  19. This module allows authentication to the LDAP directory configured in the
  20. Simple LDAP module. It also provides synchronization services both to and from
  21. LDAP and Drupal. It supports mapping LDAP attributes to Drupal user object
  22. fields (both native, and using Field API).
  23. Simple LDAP Role
  24. ================
  25. This module allows Drupal roles to be derived from LDAP groups, and
  26. vice-versa. It is dependent on the Simple LDAP User module.
  27. Simple LDAP Test
  28. ================
  29. This is a hidden module, which provides the glue to allow SimpleTest
  30. integration to the other modules. In order to perform the other modules'
  31. simpletests, there is a configuration file at
  32. simple_ldap_test/simple_ldap_test.config.inc which needs to be edited.
  33. ===============================================================================
  34. DEVELOPERS:
  35. Enable debugging using devel module by adding the following setting to
  36. settings.php
  37. $conf['simple_ldap_devel'] = TRUE;
  38. Vagrant
  39. =======
  40. There is a Vagrantfile included that will build a VM with a working LDAP
  41. directory and a fresh Drupal installation with simple_ldap installed. If OS X
  42. is the Vagrant host, then the vagrant box is available at simpleldap.local.
  43. For other operating systems, the IP address will need to be obtainted manually,
  44. and added to the local hosts file for best results.
  45. Drupal
  46. ------
  47. The Drupal installation is set up with the following credentials:
  48. http://simpleldap.local/
  49. username: admin
  50. password: admin
  51. LDAP
  52. ----
  53. The LDAP is pre-populated with some dummy data
  54. ldap://simpleldap.local
  55. DN: cn=admin,dc=local
  56. password: admin
  57. DN: cn=ldapuser,ou=people,dc=local
  58. password: ldapuser
  59. phpLDAPadmin
  60. ------------
  61. phpLDAPadmin is available at http://simpleldap.local/pma