dani/lemonldap-ng
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update doc

Browse Source
This commit is contained in:
Christophe Maudoux 2020-05-20 23:41:40 +02:00 committed by Maxime Besson
parent 131a09cbd4
commit 6f06c22a58
5 changed files with 21 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/sources/admin/autosignin.rst
View File

@ -1,15 +1,15 @@
Auto Signin Addon
=================
Auto-Signin add-on provides an easy way to bypass authentication process
Auto-Signin plugin provides an easy way to bypass authentication process
based on rules. For example, a TV can be automatically authenticated by
its IP address.
Configuration
-------------
This add-on is automatically enabled if a rule is declared. A rule links
rule to a username. The only usable variable here is ``$env``. Example:
This add-on is automatically enabled if a rule is defined. A rule links
rule to an username. The only availble variable here is ``$env``. Example:
============== ===========================================
Key (username) Rule
@ -20,4 +20,4 @@ dwho ''$env->{REMOTE_ADDR} eq '192.168.42.42' ''
.. important::
Username must be defined in the user database.
Username must be defined in users database.

4
doc/sources/admin/bruteforceprotection.rst
View File

@ -14,7 +14,7 @@ seconds.
Configuration
-------------
To enable Brute Force Attack protection :
To enable Brute Force Attack protection:
Go in Manager, ``General Parameters`` » ``Advanced Parameters`` »
``Security`` » ``Brute-force attack protection`` » ``Activation``\ and
@ -75,4 +75,4 @@ of allowed failed login attempts (3 by default) edit
Number of failed login attempts stored in history MUST
be higher than allowed failed logins for this plugin takes effect.
See :doc:`History plugin<loginhistory>`

10
doc/sources/admin/checkstate.rst
View File

@ -7,15 +7,15 @@ the backup-node.
Configuration
-------------
Just enable it in the manager (*General Parameters* » *Plugins* »
*State Check*). You must also set a shared secret.
To enable Check state:
Go in Manager, ``General Parameters`` » ``Plugins`` » ``State Check``.
You must also set a shared secret.
Usage
-----
When enabled, ``/checkstate`` URL path is handled by this plugin. GET
parameters:
When enabled, ``/checkstate`` URL path is handled by this plugin.
GET parameters:
============= ======== ============================================================
GET Parameter Need Value

5
doc/sources/admin/grantsession.rst
View File

@ -24,3 +24,8 @@ You can then create rules with these fields:
does not return true, then the session is refused.
- **Message**: The message that will be displayed. That message can
contain session data as user attributes or macros.
.. tip::
By example, you can set a message like this:
"hello $uid your are not allowed to login"

9
doc/sources/admin/notifications.rst
View File

@ -18,8 +18,9 @@ Installation
Activation
~~~~~~~~~~
You just have to activate Notifications in the Manager (General
Parameters > Advanced Parameters > Notifications > Activation)
To activate notifications system:
Go to Manager ``General Parameters`` » ``Advanced Parameters`` »
``Notifications`` » ``Activation``
or in ``lemonldap-ng.ini`` [portal] section:
@ -33,8 +34,8 @@ Explorer
Notifications explorer allows users to see and display theirs accepted
notifications. Disable by default, you just have to activate it in the
Manager (General Parameters > Advanced Parameters > Notifications >
Explorer)
Manager (``General Parameters`` » ``Advanced Parameters`` » ``Notifications`` »
``Explorer``)
or in ``lemonldap-ng.ini`` [portal] section: