You are here

Home » API reference » Simple LDAP 8

README.txt in Simple LDAP 8

Same filename and directory in other branches
  1. 7.2 README.txt
  2. 7 README.txt
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.

Currently, the 8.x-1.x branch consists of one main module and one submodule.

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).

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

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. 

  8. The current implementation was developed against OpenLDAP, with some testing

  9. against Active Directory. Most functionality should work with any LDAPv3

  10. compliant server, but this is largely untested.

  11. 

  12. Currently, the 8.x-1.x branch consists of one main module and one submodule.

  13. 

  14. Simple LDAP

  15. ===========

  16. 

  17. This is the main module, on which all of the other modules are based. It

  18. provides an interface to the configured LDAP directory with basic low-level

  19. LDAP functions and no bells or whistles. It does not provide anything to

  20. Drupal on its own.

  21. 

  22. Simple LDAP User

  23. ================

  24. 

  25. This module allows authentication to the LDAP directory configured in the

  26. Simple LDAP module. It also provides synchronization services both to and from

  27. LDAP and Drupal. It supports mapping LDAP attributes to Drupal user object

  28. fields (both native, and using Field API).

  29. 

  30. ===============================================================================

  31. 

  32. DEVELOPERS:

  33. 

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

  35. settings.php

  36. 

  37. $conf['simple_ldap_devel'] = TRUE;

  38. 

  39. Vagrant

  40. =======

  41. 

  42. There is a Vagrantfile included that will build a VM with a working LDAP

  43. directory and a fresh Drupal installation with simple_ldap installed. If OS X

  44. is the Vagrant host, then the vagrant box is available at simpleldap.local.

  45. For other operating systems, the IP address will need to be obtainted manually,

  46. and added to the local hosts file for best results.

  47. 

  48. Drupal

  49. ------

  50. 

  51. The Drupal installation is set up with the following credentials:

  52. 

  53. http://simpleldap.local/

  54. 

  55. username: admin

  56. password: admin

  57. 

  58. LDAP

  59. ----

  60. 

  61. The LDAP is pre-populated with some dummy data

  62. 

  63. ldap://simpleldap.local

  64. 

  65. DN: cn=admin,dc=local

  66. password: admin

  67. 

  68. DN: cn=ldapuser,ou=people,dc=local

  69. password: ldapuser

  70. 

  71. phpLDAPadmin

  72. ------------

  73. 

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