diff --git a/docs/deploy.rst b/docs/deploy.rst index 00a481d..2686e8c 100644 --- a/docs/deploy.rst +++ b/docs/deploy.rst @@ -1,12 +1,14 @@ Deploy ====== -LdapCherry aims at being as simple as possible to deploy. +LdapCherry aims to be as simple as possible to deploy. The Application is constituted of: -* ldapcherryd: the daemon to lauch LdapCherry -* one ini file (ldapcherry.ini by default): the entry point for the configuration, containing all the "technical" attributes -* two yaml files (roles.yml and attributes by default): the files containing the roles and attributes definition +* ldapcherryd: the daemon to lauch LdapCherry. +* one ini file (ldapcherry.ini by default): the entry point for the configuration, containing all the "technical" attributes. +* two yaml files (roles.yml and attributes by default): the files containing the roles and attributes definition. + +The default configuration directory is **/etc/ldapcherry/**. Launch ------ @@ -31,10 +33,10 @@ Entry point in main configuration ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The main configuration file (ldapcherry.ini by default) contains two parameters locating the roles and attributes configuration files: +The main configuration file (**ldapcherry.ini** by default) contains two parameters locating the roles and attributes configuration files: +-----------------+------------+-------------------------------+-------------------+ -| Parameter | Section | Description | Values | +| Parameter | Section | Description | Values | +=================+============+===============================+===================+ | attributes.file | attributes | Attributes configuration file | Path to conf file | +-----------------+------------+-------------------------------+-------------------+ @@ -44,7 +46,7 @@ Attributes Configuration ~~~~~~~~~~~~~~~~~~~~~~~~ -The attributes configuration is done in a yaml file (attributes.yml by default). +The attributes configuration is done in a yaml file (**attributes.yml** by default). Mandatory parameters ^^^^^^^^^^^^^^^^^^^^ @@ -68,8 +70,8 @@ .. warning:: - (the backend id) must be defined in main configuration - (ldapcherry.ini by default). LdapCherry won't start if it's not. + (the backend id) must be defined in main ini configuration file. + LdapCherry won't start if it's not. Type stringlist values ^^^^^^^^^^^^^^^^^^^^^^ @@ -117,7 +119,7 @@ Authorize self modification ^^^^^^^^^^^^^^^^^^^^^^^^^^^ -A user can modify some of it's attributes (self modification). +A user can modify some of his attributes (self modification). In such case, the parameter **self** must set to **True**: .. sourcecode:: yaml @@ -168,7 +170,7 @@ Available **autofill** functions: -* lcUid: generate 8 characters uid from 2 other fields (first letter of the first field, 7 first letters of the second): +* lcUid: generate 8 characters ascii uid from 2 other fields (first letter of the first field, 7 first letters of the second): .. sourcecode:: yaml @@ -179,7 +181,7 @@ - $name -* lcDisplayName: concatenate two fields +* lcDisplayName: concatenate two fields (with a space as separator): .. sourcecode:: yaml @@ -189,7 +191,7 @@ - $first-name - $name -* lcMail: generate an email address from 2 other fields and a domain (+domain) +* lcMail: generate an email address from 2 other fields and a domain (+domain): .. sourcecode:: yaml @@ -201,7 +203,7 @@ - '@example.com' -* lcUidNumber: generate an uid number from 2 other fields and between a minimum and maximum value +* lcUidNumber: generate an uid number from 2 other fields and between a minimum and maximum value: .. sourcecode:: yaml @@ -213,7 +215,7 @@ - '10000' - '40000' -* lcHomeDir: generate an home directory from 2 other fields and a root (+) +* lcHomeDir: generate an home directory from 2 other fields and a root (+): .. sourcecode:: yaml @@ -227,7 +229,7 @@ Roles Configuration ~~~~~~~~~~~~~~~~~~~ -The roles configuration is done in a yaml file (roles.yml by default). +The roles configuration is done in a yaml file (**roles.yml** by default). Mandatory parameters ^^^^^^^^^^^^^^^^^^^^ @@ -237,7 +239,7 @@ .. sourcecode:: yaml : - display_name: + display_name: description: backends_groups: # list of backends : # list of groups in backend @@ -252,7 +254,7 @@ Defining LdapCherry Administrator role ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -One of the declared roles must be tagged to be LdapCherry administrators. +At least one of the declared roles must be tagged to be LdapCherry administrators. Doing so is done by setting **LC_admins** to **True** for the selected role: @@ -367,7 +369,10 @@ [backends] # backend python module path - .module = 'python.module.path' + .module = + + # display name of the backend in forms + .display_name = # parameters of the module instance for backend . . =