ltb-project#128: Added documentation to configure displaying audit logs.

docs/audit.rst

@@ -71,3 +71,51 @@ In nginx.conf:
 .. warning:: Using Nginx, headers with underscores in their names are discarded by default. In order for these headers to be considered valid, we need to add ``underscores_in_headers on`` to ``nginx.conf``.
 
 .. tip:: If no header defined or if header is empty, actions will be logged as "anonymous"
+
+Display Audit logs
+==================
+
+Enabling audit logs display
+--------------------------
+
+When the audit logs are enabled, they can be displayed in a table by setting the following variable:
+
+.. code-block:: php
+
+   $use_showauditlog = true;
+
+Days of Audit logs
+------------------
+
+The number of days that can be displayed in the table can be configured as follows:
+
+.. code-block:: php
+
+   $audit_log_days = 5;
+
+Display table columns
+------------------
+
+The table columns to be displayed can be configured with the following variable:
+
+.. code-block:: php
+
+   $audit_log_items = array('date','ip','dn','done_by','action','result','comment');
+
+Audit table sorting 
+------------------
+
+The table can be sorted by default by the setting:
+
+.. code-block:: php
+
+   $audit_log_sortby = "date";
+
+Audit user link
+------------------
+
+Users present in the audit table can be linked by setting:
+
+.. code-block:: php
+
+   $audit_log_linkto = array("dn");

docs/presentation.rst

@@ -23,3 +23,4 @@ Features
   * 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)
+  * Audit logs