Skip to content

Commit

Permalink
Doc for OpenLDAP/AD
Browse files Browse the repository at this point in the history
  • Loading branch information
coudot committed Sep 27, 2024
1 parent 6f8356e commit 91a0dda
Show file tree
Hide file tree
Showing 5 changed files with 59 additions and 4 deletions.
3 changes: 2 additions & 1 deletion conf/config.inc.php
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@
# All the default values are kept here, you should not modify it but use
# config.inc.local.php file instead to override the settings from here.
#==============================================================================

# LDAP
$ldap_type = "openldap";
$ldap_url = "ldap://localhost";
$ldap_starttls = false;
$ldap_binddn = "cn=manager,dc=example,dc=com";
Expand All @@ -38,7 +40,6 @@
#$ldap_default_ppolicy = "cn=default,ou=ppolicy,dc=example,dc=com";
$ldap_lastauth_attribute = "authTimestamp";
#$ldap_network_timeout = 10;
$ldap_type = "openldap";

# Override LDAP password policy configuration
#$ldap_lockout_duration = 3600; # 1 hour
Expand Down
33 changes: 33 additions & 0 deletions docs/enableaccount.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
Enable and disable account
==========================

Show enabled status
-------------------

Service Desk will display if account is enabled or not. To allow this feature:

.. code-block:: php
$show_enablestatus = true;
Enable account
--------------

This feature allows to enable the account. The button is only displayed if the account is disabled.

To enable this feature:

.. code-block:: php
$use_enableaccount = true;
Disable account
---------------

This feature allows to disable the account. It is only displayed if the account is enabled.

To enable this feature:

.. code-block:: php
$use_disableaccount = true;
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ LDAP Tool Box Service Desk documentation
checkpassword.rst
resetpassword.rst
lockaccount.rst
enableaccount.rst
hook.rst
dashboards.rst
configuration-mail.rst
Expand Down
22 changes: 21 additions & 1 deletion docs/ldap-parameters.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@
LDAP parameters
===============

Type of directory
-----------------

You can define the type of LDAP directory (``openldap`` or ``activedirectory``). The default value is ``openldap``.

.. code-block:: php
$ldap_type = "openldap";
.. tip:: Other configuration parameters could be impacted by this choice, check their documentation.

Server address
--------------

Expand Down Expand Up @@ -40,7 +51,7 @@ Configure DN and password in ``$ldap_bindn`` and ``$ldap_bindpw``:
$ldap_binddn = "cn=manager,dc=example,dc=com";
$ldap_bindpw = "secret";
.. tip:: You can use the LDAP admin account or any service account. The account needs to read users, password policy entries and write ``userPassword`` and ``pwdReset`` attributes in user entries. Note that using the LDAP admin account will bypass any password policy like minimal size or password history when reseting the password.
.. tip:: You can use the LDAP admin account or any service account. The account needs to read users, password policy entries and write password and some other related attributes in user entries. On OpenLDAP, using the LDAP admin account will bypass any password policy like minimal size or password history when reseting the password.

LDAP Base
---------
Expand Down Expand Up @@ -106,6 +117,13 @@ Set ``$ldap_default_ppolicy`` value if a default policy is configured in your LD
.. tip:: Password policy is first searched in ``pwdPolicySubentry`` attribute of user entry, then fallback to default policy.

You can override some policies, like lockout duration or password maximal age:

.. code-block:: php
$ldap_lockout_duration = 3600; # 1 hour
$ldap_password_max_age = 7889400; # 3 months
Last authentication attribute
-----------------------------

Expand All @@ -114,3 +132,5 @@ The last authentication date can be stored in different attributes depending on
.. code-block:: php
$ldap_lastauth_attribute = "pwdLastSuccess";
.. tip:: This attribute is automatically configured for Active Directory.
4 changes: 2 additions & 2 deletions docs/lockaccount.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Lock account
============
Lock and unlock account
=======================

Show lock status
----------------
Expand Down

0 comments on commit 91a0dda

Please sign in to comment.