update openldap documentations

This commit is contained in:
egarette@silique.fr 2023-08-10 10:15:12 +02:00
parent e8e9e8719e
commit 8b42374f4f
2 changed files with 38 additions and 38 deletions

View file

@ -9,7 +9,7 @@ include_toc: true
OpenLDAP, the LDAP server.
[More informations about this software.](https://www.openldap.org/)
[Software's website.](https://www.openldap.org/)
This service provides a LDAP server.
@ -27,37 +27,37 @@ Other services may also require automatic user creation.
### Accounts
#### Gestion des utilisateurs
#### Users management
This a family is a leadership.
Management of manually created local users. Those users are not classified.. This family is a leadership.
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------|
| **[accounts.users.ldap_user_mail](extras/accounts/00_account.xml)**<br/>multiple<br/>**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Adresse courriel du compte.<br/>**Example:** johndoe@example.net |
| **[accounts.users.ldap_user_aliases](extras/accounts/00_account.xml)**<br/>multiple<br/>**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Aliases du mail. |
| **[accounts.users.ldap_user_uid](extras/accounts/00_account.xml)**<br/>mandatory<br/>**Type:** [`unix_user`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de compte.<br/>**Example:** jdoe |
| **[accounts.users.ldap_user_sn](extras/accounts/00_account.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Prénom.<br/>**Example:** John |
| **[accounts.users.ldap_user_gn](extras/accounts/00_account.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de famille.<br/>**Example:** Doe |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------|
| **[accounts.users.ldap_user_mail](extras/accounts/00_account.xml)**<br/>multiple<br/>**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Email address.<br/>An user is identify by his email address.<br/>**Example:** johndoe@example.net |
| **[accounts.users.ldap_user_aliases](extras/accounts/00_account.xml)**<br/>multiple<br/>**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Emails aliases.<br/>**Example:** jdoe@example.net |
| **[accounts.users.ldap_user_uid](extras/accounts/00_account.xml)**<br/>mandatory<br/>**Type:** [`unix_user`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Account name.<br/>**Example:** jdoe |
| **[accounts.users.ldap_user_gn](extras/accounts/00_account.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Given Name.<br/>**Example:** John |
| **[accounts.users.ldap_user_sn](extras/accounts/00_account.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Surname.<br/>**Example:** Doe |
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|
| **[accounts.families](extras/accounts/00_account.xml)**<br/>multiple<br/>**Type:** [`unix_user`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Familles. |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|
| **[accounts.families](extras/accounts/00_account.xml)**<br/>multiple<br/>**Type:** [`unix_user`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Families to create.<br/>Users can be classified into families. This variable contains all the names of the families to be created. |
#### Gestion de la famille
#### Management of family *suffix name*
This a dynamic family generated from the variable "accounts.families".
Management of manually created users. Those users an classified in a family.. This a dynamic family generated from the variable "accounts.families".
##### Gestion des utilisateurs de la famille
This a family is a leadership.
This family is a leadership.
| Parameter | Comments |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------|
| **[accounts.family_.users_.ldap_user_mail_](extras/accounts/00_account.xml)**<br/>multiple<br/>**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Adresse courriel du compte de la famille . |
| **[accounts.family_.users_.ldap_user_aliases_](extras/accounts/00_account.xml)**<br/>multiple<br/>**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Aliases du mail de la famille . |
| **[accounts.family_.users_.ldap_user_uid_](extras/accounts/00_account.xml)**<br/>mandatory<br/>**Type:** [`unix_user`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de compte de la famille . |
| **[accounts.family_.users_.ldap_user_sn_](extras/accounts/00_account.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Prénom de la famille . |
| **[accounts.family_.users_.ldap_user_gn_](extras/accounts/00_account.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de famille de la famille . |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------|
| **[accounts.family_*suffix name*.users_*suffix name*.ldap_user_mail_*suffix name*](extras/accounts/00_account.xml)**<br/>multiple<br/>**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Adresse courriel du compte de la famille . |
| **[accounts.family_*suffix name*.users_*suffix name*.ldap_user_aliases_*suffix name*](extras/accounts/00_account.xml)**<br/>multiple<br/>**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Aliases du mail de la famille . |
| **[accounts.family_*suffix name*.users_*suffix name*.ldap_user_uid_*suffix name*](extras/accounts/00_account.xml)**<br/>mandatory<br/>**Type:** [`unix_user`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de compte de la famille . |
| **[accounts.family_*suffix name*.users_*suffix name*.ldap_user_sn_*suffix name*](extras/accounts/00_account.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Prénom de la famille . |
| **[accounts.family_*suffix name*.users_*suffix name*.ldap_user_gn_*suffix name*](extras/accounts/00_account.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de famille de la famille . |
## Variables for expert

View file

@ -1,23 +1,23 @@
<?xml version='1.0' encoding='UTF-8'?>
<rougail version="0.10">
<variables>
<variable name="remotes" description="Serveurs distant ayant un compte" type="domainname" multi="True" provider="LDAP"/>
<family name="remote_" description="Compte LDAP pour " dynamic="accounts.remotes">
<variable name="family_" description="Nom de la familly de " hidden="True" provider="LDAP:family"/>
<variable name="dn_" description="LDAP DN de " hidden="True" provider="LDAP:dn"/>
<variable name="password_" type ="password" description="Mot de passe de " hidden="True" provider="LDAP:password"/>
<variable name="base_dn_" description="LDAP base DN de " hidden="True" provider="LDAP:base_dn"/>
<variable name="remotes" description="Remote services with an account" type="domainname" multi="True" provider="LDAP"/>
<family name="remote_" dynamic="accounts.remotes" hidden="True">
<variable name="family_" provider="LDAP:family"/>
<variable name="dn_" provider="LDAP:dn"/>
<variable name="password_" type="password" provider="LDAP:password"/>
<variable name="base_dn_" provider="LDAP:base_dn"/>
</family>
<family name="users" description="Gestion des utilisateurs" leadership="True">
<variable name='ldap_user_mail' type="mail" description="Adresse courriel du compte" multi="True" test="johndoe@example.net"/>
<variable name='ldap_user_aliases' type="mail" description="Aliases du mail" multi="True"/>
<variable name='ldap_user_uid' type="unix_user" description="Nom de compte" mandatory="True" test="jdoe"/>
<variable name='ldap_user_sn' type="string" description="Prénom" mandatory="True" test="John"/>
<variable name='ldap_user_gn' type="string" description="Nom de famille" mandatory="True" test="Doe"/>
<variable name='ldap_user_password' type="password" description="Mot de passe" mandatory="True" hidden="True"/>
<family name="users" description="Users management" leadership="True" help="Management of manually created local users. Those users are not classified.">
<variable name='ldap_user_mail' type="mail" description="Email address" multi="True" test="johndoe@example.net" help="An user is identify by his email address."/>
<variable name='ldap_user_aliases' type="mail" description="Emails aliases" multi="True" test="jdoe@example.net"/>
<variable name='ldap_user_uid' type="unix_user" description="Account name" mandatory="True" test="jdoe"/>
<variable name='ldap_user_gn' type="string" description="Given Name" mandatory="True" test="John"/>
<variable name='ldap_user_sn' type="string" description="Surname" mandatory="True" test="Doe"/>
<variable name='ldap_user_password' type="password" mandatory="True" hidden="True"/>
</family>
<variable name="families" description="Familles" type="unix_user" multi="True"/>
<family name="family_" description="Gestion de la famille " dynamic="accounts.families">
<variable name="families" description="Families to create" type="unix_user" multi="True" help="Users can be classified into families. This variable contains all the names of the families to be created."/>
<family name="family_" description="Management of family " dynamic="accounts.families" help="Management of manually created users. Those users an classified in a family.">
<family name="users_" description="Gestion des utilisateurs de la famille " leadership="True">
<variable name='ldap_user_mail_' type="mail" description="Adresse courriel du compte de la famille " multi="True"/>
<variable name='ldap_user_aliases_' type="mail" description="Aliases du mail de la famille " multi="True"/>