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

doc: fix markup

Browse Source
This commit is contained in:
Maxime Besson 2020-05-20 15:44:46 +02:00
parent 08dd5edd0b
commit 131a09cbd4
14 changed files with 36 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -8,7 +8,7 @@ the backup-node.
Configuration
-------------
Just enable it in the manager (\**General Parameters* » *Plugins* »
Just enable it in the manager (*General Parameters* » *Plugins* »
*State Check*). You must also set a shared secret.
Usage

3
doc/sources/admin/error.rst
View File

@ -5,7 +5,7 @@ Error messages
.. note::
This page do not reference all error messages, but only the
frequentest
most common
Lemonldap::NG::Common
---------------------
@ -61,6 +61,7 @@ configStorageOptionsor file permissions.
→ The cache has been created by another user than Apache's user. Restart
Apache to purge it.
.. important::
This can append when you use

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

@ -243,7 +243,7 @@ Simple usage example:
listMatch
~~~~~~~~~
(|image0| // since 2.0.7)//
(|image0| since 2.0.7)
This function lets you test if a particular value can be found with a
multi-valued session attribute.
@ -271,7 +271,7 @@ found.
inGroup
~~~~~~~
(|image1| // since 2.0.8)//
(|image1| since 2.0.8)
This function lets you test if the user is in a given group. It is
case-insensitive.

2
doc/sources/admin/fastcgiserver.rst
View File

@ -24,7 +24,7 @@ Using "make install"
To enable the FastCGI server at startup, copy the script
``llng-fastcgi-server`` installed in INITDIR (default
``/usr/local/lemonldap-ng/etc/init.d/``) in ``/etc/init.d`` and enable
it (links to ``/etc/rc//x//.d``).
it (links to ``/etc/rc<x>.d``).
Configuration
-------------

2
doc/sources/admin/managertests.rst
View File

@ -5,7 +5,7 @@ Each time you save a configuration, Manager launch a lot of tests:
- unit tests for each key: they are declared in
Lemonldap::NG::Manager::Attributes *(source
Lemonldap::NG::Manager::Build::Attributes)*
Lemonldap::NG::Manager::Build::Attributes)*
- more advanced tests declared in Lemonldap::NG::Manager::Conf::Tests
In some case *(conf overridden in INI file,...)*, you may have to ignore

3
doc/sources/admin/monitoring.rst
View File

@ -1,3 +1,6 @@
Monitoring
==========
Handler can be monitored by using MRTG. See
:doc:`MRTG monitoring<mrtg>`.

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

@ -452,8 +452,8 @@ by using SOAP request, once SOAP is activated:
JSON notifications through REST
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
\* Insertion example with REST API
''''''''''''''''''''''''''''''''''
Insertion example with REST API
'''''''''''''''''''''''''''''''
Using JSON, you just have to POST json files.
@ -463,8 +463,8 @@ For example with curl:
curl -X POST -H "Content-Type: application/json" -H "Accept: application/json" -d @notif.json http://auth.example.com/notifications
\* Deletion example with REST API
'''''''''''''''''''''''''''''''''
Deletion example with REST API
''''''''''''''''''''''''''''''
DELETE API is available with LLNG ≥ 2.0.6
@ -474,8 +474,8 @@ For example with curl:
curl -X DELETE -H "Content-Type: application/json" -H "Accept: application/json" http://auth.example.com/notifications/<uid>/<reference>
\* List example with REST API
'''''''''''''''''''''''''''''
List example with REST API
''''''''''''''''''''''''''
GET API is available with LLNG ≥ 2.0.6

3
doc/sources/admin/openidconnectservice.rst
View File

@ -92,8 +92,7 @@ run for example each week:
Session management
------------------
LL::NG implements the change notification as defined here:
http://openid.net/specs/openid-connect-session-1_0.html#ChangeNotification
LL::NG implements the `OpenID Connect Chance Notification specification <http://openid.net/specs/openid-connect-session-1_0.html#ChangeNotification>`__
A ``changed`` state will be sent if the user is disconnected from LL::NG
portal (or has destroyed its SSO cookie). Else the ``unchanged`` state

3
doc/sources/admin/psgi.rst
View File

@ -62,8 +62,9 @@ LLNG FastCGI Server
==================== ===================== ===================== ==========================================================================================
Command-line options Environment variable Explanation
==================== ===================== ===================== ==========================================================================================
------------------------------------------ --------------------- ------------------------------------------------------------------------------------------
Short Long
==================== ===================== ===================== ==========================================================================================
-p --pid PID Process PID
-u --user USER Unix uid
-g --group GROUP Unix gid

1
doc/sources/admin/restminihowto.rst
View File

@ -4,6 +4,7 @@ Configure LemonLDAP::NG to use REST proxy mechanism
LL::NG use 2 internal databases to store its configuration and sessions.
It can be configured to use REST instead of direct access to those
databases (for remote servers).
.. tip::
This mechanism can be used to

12
doc/sources/admin/samlservice.rst
View File

@ -60,7 +60,7 @@ RHEL/CentOS/Fedora
^^^^^^^^^^^^^^^^^^
RPMs are available in LL::NG RPM "extras" repository (see
:ref:`installrpm#yum_repository<installrpm-yum-repository>`)
:ref:`installrpm-yum-repository`)
Then install lasso and lasso-perl packages:
@ -329,9 +329,7 @@ Identity Provider
General parameters
^^^^^^^^^^^^^^^^^^
::
* **Want Authentication Request Signed**: set to On to require that received authentication request are signed.
* **Want Authentication Request Signed**: set to On to require that received authentication request are signed.
.. tip::
@ -360,10 +358,8 @@ Single Logout
For each binding you can set:
::
* **Location**: Access Point for SLO request.
* **Response Location**: Access Point for SLO response.
* **Location**: Access Point for SLO request.
* **Response Location**: Access Point for SLO response.
Available bindings are:

6
doc/sources/admin/secondfactor.rst
View File

@ -8,7 +8,7 @@ It is a method to confirm a user's claimed identity by using a
combination of two different factors between:
#. something they know *(login / password, …)*
#. something they have //(U2F Key, smartphone, …) //
#. something they have *(U2F Key, smartphone, …)*
#. something they are *(biometrics like fingerprints, ...)*
Since 2.0, LLNG provides some second factor plugins that can be used to
@ -16,9 +16,9 @@ complete authentication module with 2FA :
- :doc:`U2F-or-TOTP<utotp2f>` *(enable both U2F and TOTP)*
- :doc:`TOTP<totp2f>` *(to use
with*\ `FreeOTP <https://freeotp.github.io/>`__\ *,*\ `Google-Authenticator <https://en.wikipedia.org/wiki/Google_Authenticator>`__\ *,…)*
with* `FreeOTP <https://freeotp.github.io/>`__\ *,*\ `Google-Authenticator <https://en.wikipedia.org/wiki/Google_Authenticator>`__\ *,…)*
- :doc:`U2F tokens<u2f>`
- :doc:`Yubikey tokens<yubikey2f>` // provide by Yubico//
- :doc:`Yubikey tokens<yubikey2f>` *(provided by Yubico)*
- :doc:`E-Mail 2F<mail2f>` *(Send a code to an email address)*
- :doc:`External 2F<external2f>` *(to call an external command)*
- :doc:`REST<rest2f>` *(Remote REST app)*

6
doc/sources/admin/selfmadeapplication.rst
View File

@ -16,9 +16,9 @@ To get more information on user (name, mail, etc.), you have to read
.. tip::
If your application is based on `Perl CGI
package <http://search.cpan.org/perldoc?CGI>`, you can simply replace
CGI by Lemonldap::NG::Handler::CGI
If your application is based on `Perl CGI package
<http://search.cpan.org/perldoc?CGI>`__, you can simply replace CGI by
:ref:`Lemonldap::NG::Handler::CGI<selfmadeapplication-perl-auto-protected-cgi>`
Code snippet
------------

13
doc/sources/admin/smtp.rst
View File

@ -3,14 +3,13 @@ SMTP server setup
Go in ``General Parameters`` > ``Advanced Parameters`` > ``SMTP``:
::
* ** Session key containing mail address**: choose which session field contains mail address
* **SMTP Server**: IP or hostname of the SMTP server
* **SMTP Port**: Port of the SMTP server
* **SMTP User**: SMTP user if authentication is required
* **SMTP Password**: SMTP password if authentication is required
* ** SSL/TLS protocol** and **SSL/TLS options**: Here you can enable SMTPS or startTLS
* **Session key containing mail address**: choose which session field contains mail address
* **SMTP Server**: IP or hostname of the SMTP server
* **SMTP Port**: Port of the SMTP server
* **SMTP User**: SMTP user if authentication is required
* **SMTP Password**: SMTP password if authentication is required
* **SSL/TLS protocol** and **SSL/TLS options**: Here you can enable SMTPS or startTLS
.. tip::