Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
coudot committed Nov 28, 2024
1 parent 9b2bc80 commit bad69e6
Show file tree
Hide file tree
Showing 5 changed files with 72 additions and 7 deletions.
9 changes: 9 additions & 0 deletions docs/display-parameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,3 +54,12 @@ You can disable the expire status panel:
.. code-block:: php
$show_expirestatus = false;
Validity status
---------------

You can disable the validity status panel:

.. code-block:: php
$show_validitytatus = false;
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ LDAP Tool Box Service Desk documentation
resetpassword.rst
lockaccount.rst
enableaccount.rst
updatestartendtime.rst
hook.rst
dashboards.rst
configuration-mail.rst
Expand Down
4 changes: 3 additions & 1 deletion docs/presentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,12 @@ Features
* Test current password
* Reset password and force password change at next connection
* Lock and unlock account
* Update account validity dates
* Create and view audit logs
* Dashboards:

* Accounts locked
* Accounts with a password that will soon expire
* Accounts with an expired password
* Accounts idle (never connected or not connected since a number of days)
* Accounts idle (never connected or not connected since a number of days)
* Accounts invalid (for which start date is in the future, or end date is in the past)
39 changes: 39 additions & 0 deletions docs/updatestartendtime.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
Update start and end validity dates
===================================

Some LDAP directories provide attributes to define start and end account validify dates.

For OpenLDAP since 2.5 version, attributes are ``pwdStartTime`` and ``pwdEndTime``.

For Active Directory, only end time is available, in ``accountExpires`` attribute.

Show validity status
-------------------

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

.. code-block:: php
$show_validitystatus = true;
Update start date
-----------------

This feature allows to edit the account start validity date. This requires to have the `starttime` field defined in the attributes map.

To enable this feature:

.. code-block:: php
$use_updatestarttime = true;
Update end date
-----------------

This feature allows to edit the account end validity date. This requires to have the `endtime` field defined in the attributes map.

To enable this feature:

.. code-block:: php
$use_updateendtime = true;
26 changes: 20 additions & 6 deletions docs/upgrade.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Upgrade
From 0.5 to 0.6
---------------

bundled dependencies
Bundled dependencies
~~~~~~~~~~~~~~~~~~~~

The dependencies are now explicitly listed in the service-desk package, including the bundled ones.
Expand All @@ -15,7 +15,7 @@ You can find bundled dependencies list:
* in Provides field in rpm package


configuration
Configuration
~~~~~~~~~~~~~

The configuration files are now in ``/etc/service-desk`` directory.
Expand All @@ -29,7 +29,7 @@ Please take in consideration that ``config.inc.php`` is now replaced systematica

Avoid as much as possible editing the ``/etc/service-desk/config.inc.php`` file. Prefer modifying the ``/etc/service-desk/config.inc.local.php``.

password policy
Password policy
~~~~~~~~~~~~~~~

When you change the password for a user, you can now configure a local password policy for ensuring the password strength is sufficient.
Expand All @@ -43,15 +43,15 @@ You can give a look to the :doc:`password policy documentation <ppolicy>` for mo
The local password policy is now defined in a library: `ltb-common <https://github.com/ltb-project/ltb-common>`_.


cache cleaning
Cache cleaning
~~~~~~~~~~~~~~

Now the cache is being cleaned-up during service-desk upgrade / install.

This is intended to avoid smarty problems due to service-desk templates upgrade, and possibly smarty upgrade itself.


dependencies update
Dependencies update
~~~~~~~~~~~~~~~~~~~

Removed packaged dependencies:
Expand Down Expand Up @@ -117,7 +117,6 @@ Removed bundled dependencies:
Note that hidden files (.gitignore,...) from bundled dependencies are now removed from packages.



Last authentication time and idle accounts
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand All @@ -142,3 +141,18 @@ You can enable this feature by setting a non-zero value to the page size paramet
.. code-block:: php
$ldap_page_size = 100;
Account validity
~~~~~~~~~~~~~~~~

Account validity feature is enabled by default. For OpenLDAP it relies on ``pwdStartTime`` and ``pwdEndTime`` attributes available since OpenLDAP 2.5.
For Active Directory, only the end time is available, in ``accountExpires`` attribute.

You can disable this new feature if you don't want to use it:

.. code-block:: php
$show_validitystatus = false;
$use_updatestarttime = false;
$use_updateendtime = false;
$use_searchinvalid = false;

0 comments on commit bad69e6

Please sign in to comment.