[doc] Fix wrong styles in LDAP documentation

This commit is contained in:
Manuel Rego Casasnovas 2011-12-01 08:44:28 +01:00
parent 61fe490fb1
commit 2569f598d3
3 changed files with 63 additions and 25 deletions

View file

@ -3,45 +3,81 @@ LDAP Configuration
.. contents::
This screen allows to establish a connection with LDAP to delegate authentication and/or authorization.
This screen allows to establish a connection with LDAP to delegate
authentication and/or authorization.
It is divided in four different areas related which are explained below:
Activation
==========
This area is used to set the properties about the way in which *LibrePlan* uses LDAP.
This area is used to set the properties about the way in which *LibrePlan* uses
LDAP.
If the field *Enable LDAP authentication* is checked, *LibrePlan* will look in LDAP each time an user tries to login in the application.
If the field *Enable LDAP authentication* is checked, *LibrePlan* will look in
LDAP each time an user tries to login in the application.
The field *Use LDAP roles* checked means that a mapping between LDAP roles and LibrePlan roles is established, so the permissions for an user in LibrePlan will depend on the roles in LDAP that the user has.
The field *Use LDAP roles* checked means that a mapping between LDAP roles and
LibrePlan roles is established, so the permissions for an user in LibrePlan
will depend on the roles in LDAP that the user has.
Configuration
=============
This section has the parameter values for accessing LDAP.*Base, UserDN and Password* are parameters used to connect to LDAP and search for the users, so given user must have permission to do that operation in LDAP. At bottom part of this section there is a button to check if LDAP connection is possible with the given parameters. It is a good idea to try it before continuing the configuration.
This section has the parameter values for accessing LDAP.*Base, UserDN and
Password* are parameters used to connect to LDAP and search for the users, so
given user must have permission to do that operation in LDAP. At bottom part of
this section there is a button to check if LDAP connection is possible with the
given parameters. It is a good idea to try it before continuing the
configuration.
Authentication
==============
Here can be configured the property in LDAP nodes where should be found the given login name. The property *UserId* must be filled with the name of the property where the login name is stored in LDAP.
Here can be configured the property in LDAP nodes where should be found the
given login name. The property *UserId* must be filled with the name of the
property where the login name is stored in LDAP.
The checkbox *Save passwords in database* when it is checked, means that the password is stored also in LibrePlan database. In this way, if LDAP is offline or unreachable, LDAP users could authenticate against LibrePlan database. If it is not checked, LDAP users can only be authenticated against LDAP.
The checkbox *Save passwords in database* when it is checked, means that the
password is stored also in LibrePlan database. In this way, if LDAP is offline
or unreachable, LDAP users could authenticate against LibrePlan database. If it
is not checked, LDAP users can only be authenticated against LDAP.
Authorization
=============
This section allows to define an strategy for matching LDAP roles with LibrePlan roles. In fact, the first choice is the strategy to use, depending on LDAP implementation.
This section allows to define an strategy for matching LDAP roles with
LibrePlan roles. In fact, the first choice is the strategy to use, depending on
LDAP implementation.
Group strategy
--------------
When this strategy is used, it means that LDAP has a role-group strategy. It means that users in LDAP are nodes that hang directly from a branch which represents the group. In this way, considering as example an LDAP with a branch (group) called *Admin* and two nodes (users) in the branch called *John* and *William*, an administrator could assign to both users a role in LibrePlan. The only parameter needed in this case is the *Group path* that represents the path in LDAP to find the branches with the groups.
When this strategy is used, it means that LDAP has a role-group strategy. It
means that users in LDAP are nodes that hang directly from a branch which
represents the group. In this way, considering as example an LDAP with a branch
(group) called *Admin* and two nodes (users) in the branch called *John* and
*William*, an administrator could assign to both users a role in LibrePlan. The
only parameter needed in this case is the *Group path* that represents the path
in LDAP to find the branches with the groups.
Property strategy
-----------------
When administrator decides to use this strategy, it means that each user is a LDAP node and in the node exists a property that represents the group(s) for the user. In this case, the configuration needs two parameters. The "Role property" represents the property in user's node in LDAP which contains all the roles for that user. The "Role search query" represents the path in LDAP to find the nodes of the users; in this case, note that is important to know that string "[USER_ID]" represents the place where the login name given in the login form should be placed to get the correct user's node in LDAP.
When administrator decides to use this strategy, it means that each user is a
LDAP node and in the node exists a property that represents the group(s) for
the user. In this case, the configuration needs two parameters:
At the bottom of this section there is a table with all the LibrePlan roles and a text field next to each one. This is for matching roles. For instance, if administrator decides that *Administration* LibrePlan role matches with *admin* and *administrators* roles of LDAP, in the text field should appear: "admin;administrators". The character for splitting roles is ";".
* *Role property*. It represents the property in user's node in LDAP which
contains all the roles for that user.
* *Role search query*. It represents the path in LDAP to find the nodes of
the users; in this case, note that is important to know that string
"[USER_ID]" represents the place where the login name given in the login
form should be placed to get the correct user's node in LDAP.
At the bottom of this section there is a table with all the LibrePlan roles and
a text field next to each one. This is for matching roles. For instance, if
administrator decides that *Administration* LibrePlan role matches with *admin*
and *administrators* roles of LDAP, in the text field should appear:
"admin;administrators". The character for splitting roles is ";".

View file

@ -73,13 +73,14 @@ usuario es un nodo de LDAP y que en el nodo existe una propiedad que representa
el grupo o grupos al que pertenece el usuairo. En este caso, la configuración
necesita dos parámetros:
* *Propiedad del rol*. Representa la propiedad en el nodo del usuario que
contiene todos los roles para el mismo.
* *Consulta para la búsqueda de roles*. Representa la ruta en el LDAP para
encontrar los nodos de los usuarios. En este caso, hay que tener en cuenta que
la cadena "[USER_ID]" representa el lugar en el que el nombre del usuario
proporcionado en el formulario de entrada debe ser situado para obtener el
nodo apropiado correspondiente al usuario en el LDAP.
* *Propiedad del rol*. Representa la propiedad en el nodo del usuario que
contiene todos los roles para el mismo.
* *Consulta para la búsqueda de roles*. Representa la ruta en el LDAP para
encontrar los nodos de los usuarios. En este caso, hay que tener en cuenta que
la cadena "[USER_ID]" representa el lugar en el que el nombre del usuario
proporcionado en el formulario de entrada debe ser situado para obtener el
nodo apropiado correspondiente al usuario en el LDAP.
En el fondo de la pantalla de esta sección hay una tabla con todos los roles de
LibrePlan y un campo de texto anexo a cada uno de ellos. Esta área es para la

View file

@ -73,13 +73,14 @@ usuario é un nodo de LDAP e que no nodo existe unha propiedade que representa
o grupo ou grupos ao que pertence o usuairo. Neste caso, a configuración
necesita dous parámetros:
* *Propiedade do rol*. Representa a propiedade no nodo do usuario que
contén todos os roles para o mesmo.
* *Consulta para a procura de roles*. Representa a ruta no LDAP para
atopar os nodos dos usuarios. Neste caso, hai que ter en conta que
a cadea "[USER_IDE]" representa o lugar no que o nome do usuario
proporcionado no formulario de entrada debe ser situado para obter o
nodo apropiado correspondente ao usuario no LDAP.
* *Propiedade do rol*. Representa a propiedade no nodo do usuario que
contén todos os roles para o mesmo.
* *Consulta para a procura de roles*. Representa a ruta no LDAP para
atopar os nodos dos usuarios. Neste caso, hai que ter en conta que
a cadea "[USER_IDE]" representa o lugar no que o nome do usuario
proporcionado no formulario de entrada debe ser situado para obter o
nodo apropiado correspondente ao usuario no LDAP.
No fondo da pantalla desta sección hai unha táboa con todos os roles de LibrePlan
e un campo de texto anexo a cada un deles. Esta área é para a