Skip to content
Snippets Groups Projects
Commit df577275 authored by Alexander Bias's avatar Alexander Bias
Browse files

Improve Markdown Syntax in README.md

parent e0770989
Branches
Tags
No related merge requests found
moodle-auth_ldap_syncplus moodle-auth_ldap_syncplus
========================= =========================
Moodle authentication method which provides all functionality of auth_ldap, but supports advanced features for the LDAP synchronization script: Moodle authentication method which provides all functionality of auth_ldap, but supports advanced features for the LDAP synchronization script:
* It adds the possibility to the LDAP synchronization script to suspend users which have disappeared in LDAP for a configurable amount of days and delete them only after this grace period (the Moodle core LDAP synchronization script only provides you the option to suspend _or_ delete users which have disappeared in LDAP - MDL-47018). * It adds the possibility to the LDAP synchronization script to suspend users which have disappeared in LDAP for a configurable amount of days and delete them only after this grace period (the Moodle core LDAP synchronization script only provides you the option to suspend _or_ delete users which have disappeared in LDAP - MDL-47018).
...@@ -11,11 +12,13 @@ Moodle authentication method which provides all functionality of auth_ldap, but ...@@ -11,11 +12,13 @@ Moodle authentication method which provides all functionality of auth_ldap, but
Requirements Requirements
------------ ------------
This plugin requires Moodle 2.8+ This plugin requires Moodle 2.8+
Changes Changes
------- -------
* 2015-01-29 - Check compatibility for Moodle 2.8, no functionality change * 2015-01-29 - Check compatibility for Moodle 2.8, no functionality change
* 2015-01-23 - Adopt a code change in Moodle core auth_ldap * 2015-01-23 - Adopt a code change in Moodle core auth_ldap
* 2014-10-08 - Adopt a code change in Moodle core auth_ldap * 2014-10-08 - Adopt a code change in Moodle core auth_ldap
...@@ -33,6 +36,7 @@ Changes ...@@ -33,6 +36,7 @@ Changes
Installation Installation
------------ ------------
Install the plugin like any other plugin to folder Install the plugin like any other plugin to folder
/auth/ldap_syncplus /auth/ldap_syncplus
...@@ -41,6 +45,7 @@ See http://docs.moodle.org/en/Installing_plugins for details on installing Moodl ...@@ -41,6 +45,7 @@ See http://docs.moodle.org/en/Installing_plugins for details on installing Moodl
Usage & Settings Usage & Settings
---------------- ----------------
auth_ldap_syncplus is a plugin which inherits and reuses most of the code from the Moodle core auth_ldap plugin. All functions from auth_ldap are still working. auth_ldap_syncplus is a plugin which inherits and reuses most of the code from the Moodle core auth_ldap plugin. All functions from auth_ldap are still working.
After installing auth_ldap_syncplus, you will find a new authentification method on the admin page /admin/settings.php?section=manageauths. After installing auth_ldap_syncplus, you will find a new authentification method on the admin page /admin/settings.php?section=manageauths.
...@@ -63,6 +68,7 @@ UPDATE mdl_user SET auth='ldap_syncplus' WHERE auth='ldap' ...@@ -63,6 +68,7 @@ UPDATE mdl_user SET auth='ldap_syncplus' WHERE auth='ldap'
Running LDAP synchronization script Running LDAP synchronization script
----------------------------------- -----------------------------------
To leverage the additional LDAP synchronization features of auth_ldap_syncplus, you have to change your synchronization cronjob from /auth/ldap/cli/sync_users.php to /auth/ldap_syncplus/cli/sync_users.php. To leverage the additional LDAP synchronization features of auth_ldap_syncplus, you have to change your synchronization cronjob from /auth/ldap/cli/sync_users.php to /auth/ldap_syncplus/cli/sync_users.php.
If you don't know how to setup your synchronization cronjob, see http://docs.moodle.org/en/LDAP_authentication#Setting_up_regular_automatic_synchronisation_using_cron and the comments in /auth/ldap/cli/sync_users.php for details. If you don't know how to setup your synchronization cronjob, see http://docs.moodle.org/en/LDAP_authentication#Setting_up_regular_automatic_synchronisation_using_cron and the comments in /auth/ldap/cli/sync_users.php for details.
...@@ -70,6 +76,7 @@ If you don't know how to setup your synchronization cronjob, see http://docs.moo ...@@ -70,6 +76,7 @@ If you don't know how to setup your synchronization cronjob, see http://docs.moo
Fetching user details from LDAP on manual user creation Fetching user details from LDAP on manual user creation
------------------------------------------------------- -------------------------------------------------------
Normally, when a new user logs into Moodle for the first time and a Moodle account is automatically created, Moodle pulls the user's details from LDAP and stores them in the Moodle user profile according to the LDAP plugin's settings. Normally, when a new user logs into Moodle for the first time and a Moodle account is automatically created, Moodle pulls the user's details from LDAP and stores them in the Moodle user profile according to the LDAP plugin's settings.
auth_ldap_syncplus extends this behaviour of pulling user details from LDAP: auth_ldap_syncplus extends this behaviour of pulling user details from LDAP:
...@@ -80,11 +87,13 @@ This feature is enabled automatically and can be used as soon as you are using a ...@@ -80,11 +87,13 @@ This feature is enabled automatically and can be used as soon as you are using a
Themes Themes
------ ------
The auth_ldap_syncplus plugin acts behind the scenes, therefore it works with all moodle themes. The auth_ldap_syncplus plugin acts behind the scenes, therefore it works with all moodle themes.
Further information Further information
------------------- -------------------
auth_ldap_syncplus is found in the Moodle Plugins repository: https://moodle.org/plugins/view/auth_ldap_syncplus auth_ldap_syncplus is found in the Moodle Plugins repository: https://moodle.org/plugins/view/auth_ldap_syncplus
Report a bug or suggest an improvement: https://github.com/moodleuulm/moodle-auth_ldap_syncplus/issues Report a bug or suggest an improvement: https://github.com/moodleuulm/moodle-auth_ldap_syncplus/issues
...@@ -92,6 +101,7 @@ Report a bug or suggest an improvement: https://github.com/moodleuulm/moodle-aut ...@@ -92,6 +101,7 @@ Report a bug or suggest an improvement: https://github.com/moodleuulm/moodle-aut
Moodle release support Moodle release support
---------------------- ----------------------
Due to limited ressources, auth_ldap_syncplus is only maintained for the most recent major release of Moodle. However, previous versions of this plugin which work in legacy major releases of Moodle are still available as-is without any further updates in the Moodle Plugins repository. Due to limited ressources, auth_ldap_syncplus is only maintained for the most recent major release of Moodle. However, previous versions of this plugin which work in legacy major releases of Moodle are still available as-is without any further updates in the Moodle Plugins repository.
There may be several weeks after a new major release of Moodle has been published until we can do a compatibility check and fix problems if necessary. If you encounter problems with a new major release of Moodle - or can confirm that auth_ldap_syncplus still works with a new major relase - please let us know on https://github.com/moodleuulm/moodle-auth_ldap_syncplus/issues There may be several weeks after a new major release of Moodle has been published until we can do a compatibility check and fix problems if necessary. If you encounter problems with a new major release of Moodle - or can confirm that auth_ldap_syncplus still works with a new major relase - please let us know on https://github.com/moodleuulm/moodle-auth_ldap_syncplus/issues
...@@ -99,6 +109,7 @@ There may be several weeks after a new major release of Moodle has been publishe ...@@ -99,6 +109,7 @@ There may be several weeks after a new major release of Moodle has been publishe
Right-to-left support Right-to-left support
--------------------- ---------------------
This plugin has not been tested with Moodle's support for right-to-left (RTL) languages. This plugin has not been tested with Moodle's support for right-to-left (RTL) languages.
If you want to use this plugin with a RTL language and it doesn't work as-is, you are free to send me a pull request on If you want to use this plugin with a RTL language and it doesn't work as-is, you are free to send me a pull request on
github with modifications. github with modifications.
...@@ -106,6 +117,7 @@ github with modifications. ...@@ -106,6 +117,7 @@ github with modifications.
Contribution to Moodle Core Contribution to Moodle Core
--------------------------- ---------------------------
There is a Moodle tracker ticket on https://tracker.moodle.org/browse/MDL-47030 which proposes to add the improved features of this plugin to Moodle core auth_ldap plugin. There is a Moodle tracker ticket on https://tracker.moodle.org/browse/MDL-47030 which proposes to add the improved features of this plugin to Moodle core auth_ldap plugin.
Please vote for this ticket if you want to have this realized. Please vote for this ticket if you want to have this realized.
...@@ -113,6 +125,7 @@ Please vote for this ticket if you want to have this realized. ...@@ -113,6 +125,7 @@ Please vote for this ticket if you want to have this realized.
Copyright Copyright
--------- ---------
University of Ulm University of Ulm
kiz - Media Department kiz - Media Department
Team Web & Teaching Support Team Web & Teaching Support
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please to comment