LDAP syncing scripts

General plugins (Local) ::: local_ldap
Maintained by Charles Fulton, Andrew Zito
This plugin synchronizes Moodle cohorts against an LDAP directory using either group memberships or attribute values.

LDAP syncing scripts v3.4.1

Moodle 3.4, 3.5, 3.6, 3.7
Released: Saturday, 8 September 2018, 12:05 AM

Code prechecks

phplint phpcs0 | 2 js css phpdoc34 | 0 savepoint thirdparty grunt shifter mustache
HTML | XML

LDAP syncing scripts

Build Status

This plugin synchronizes Moodle cohorts against an LDAP directory using either group memberships or attribute values. This is a continuation of Patrick Pollet's local_ldap plugin, which in turn was inspired by MDL-25011 and MDL-25054.

Requirements

  • Moodle 3.4.0 (build 2017111300 or later)
  • OpenLDAP or Active Directory

Installation

Copy the ldap folder into your /local directory and visit your Admin Notification page to complete the installation. You must have either the CAS or LDAP authentication method enabled.

Configuration

Depending on your environment the plugin may work with default options. Configuration settings include the group class (groupOfNames by default) and whether to automatically import all found LDAP groups as cohorts. By default this setting is disabled.

Usage

Previous versions of this plugin used a CLI script. This is deprecated in favor of two scheduled tasks, one for syncing by group and another for syncing by attribute. Both are configured to run hourly and are disabled by default.

Testing

The code is tested against OpenLDAP on Travis CI. If you have a local Active Directory environment you may run the tests against it. See PHPUnit#LDAP for more information. You will need to set an additional constant, TEST_AUTH_LDAP_USER_TYPE, to ad.

Author

  • Charles Fulton (fultonc@lafayette.edu)
  • Patrick Pollet

Version information

Version build number
2018090700
Version release name
v3.4.1
Can be updated from
v2.0.0 (2016071200), v2.0.1 (2017042400), v3.2.0 (2016071201), v3.3.0 (2017080900), v3.1.0 (2016071203), v3.2.1 (2016071300), v3.3.1 (2017080901), v3.4.0 (2018050400)
Can be updated to
v3.4.2 (2018090701), v3.6.0 (2020061500), v3.7.0 (2020110900), v3.7.1 (2020110901)
Maturity
Stable version
MD5 Sum
dc04951e773f0bbaaf6e69254855ac8c
Supported software
Moodle 3.4, Moodle 3.5, Moodle 3.6, Moodle 3.7
Change log URL
Alternative download URL

Version control information

Version control system (VCS)
GIT
VCS repository URL
VCS branch
master
VCS tag
v3.4.1

Default installation instructions for plugins of the type General plugins (Local)

  1. Make sure you have all the required versions.
  2. Download and unpack the module.
  3. Place the folder in the "local" subdirectory.
  4. Visit http://yoursite.com/admin to finish the installation.