mirror of
https://gitlab.easter-eggs.com/ee/ldapsaisie.git
synced 2024-12-18 14:33:49 +01:00
doc: add sections missing IDs
This commit is contained in:
Benjamin Renard
parent
2c64eb8e97
commit
d6aad3acc8
10 changed files with 55 additions and 56 deletions
|
|
@ -5,7 +5,7 @@
|
|||
traitements d'un &LSattribute;, des fonctions que vous pourrez développer vous
|
||||
même. De plus, le résultat de l'exécution de vos fonctions pourra influer
|
||||
sur le déroulement des processus.</para>
|
||||
|
||||
|
||||
<para>Actuellement, les évènements suivant sont gérés :
|
||||
|
||||
<informaltable>
|
||||
|
|
@ -57,10 +57,10 @@
|
|||
l'exécution des actions liées, si une des fonctions retourne <literal>false
|
||||
</literal>, le processus s'arrêtera.</simpara></note>
|
||||
</para>
|
||||
<sect4>
|
||||
<sect4 id="config-LSattribute-triggers-config">
|
||||
<title>Configuration</title>
|
||||
<para>La configuration des déclencheurs se fait dans la définition des
|
||||
&LSattributes;. Par exemple, pour définir les fonctions à exécuter après la
|
||||
<para>La configuration des déclencheurs se fait dans la définition des
|
||||
&LSattributes;. Par exemple, pour définir les fonctions à exécuter après la
|
||||
modification de la valeur de l'attribut <emphasis>mail</emphasis> du type de
|
||||
&LSobject; <emphasis>LSpeople</emphasis>, c'est à dire lors de leur évenement
|
||||
<literal>after_modify</literal>, il faut définir la variable suivante :
|
||||
|
|
@ -69,8 +69,8 @@ l'exécution des actions liées, si une des fonctions retourne <literal>false
|
|||
nom de la fonction à exécuter, soit un tableau de chaînes de caractères
|
||||
correspondant aux noms des fonctions à exécuter.</para>
|
||||
</sect4>
|
||||
<sect4>
|
||||
<title>Ecriture d'une fonction</title>
|
||||
<sect4 id="config-LSattribute-triggers-writing">
|
||||
<title>Écriture d'une fonction</title>
|
||||
<para>Une fonction exécuté par un déclencheur d'un LSattribute se déclare de
|
||||
la manière suivante :
|
||||
<programlisting linenumbering="unnumbered"><![CDATA[
|
||||
|
|
@ -92,7 +92,7 @@ function maFonction ($object) {
|
|||
|
||||
}
|
||||
]]></programlisting>
|
||||
Cette fonction doit prendre pour seul paramètre, le LSobject contenant le
|
||||
Cette fonction doit prendre pour seul paramètre, le LSobject contenant le
|
||||
LSattribute sur lequel l'évenement survient et doit retourner soit
|
||||
<literal>True</literal> si tout s'est bien passé, soit <literal>False</literal>
|
||||
en cas de problème. Dans le cas d'un événement bloquant, si la fonction retourne
|
||||
|
|
|
|||
|
|
@ -503,7 +503,7 @@ contexte dans lequel cette recherche est effectuée.</para>
|
|||
|
||||
</variablelist>
|
||||
|
||||
<sect4>
|
||||
<sect4 id="config-LSobject-customSearchActions-writing">
|
||||
<title>Ecriture d'une fonction implémentant une customAction</title>
|
||||
<para>Une fonction implémentant une <emphasis>customAction</emphasis> se déclare de
|
||||
la manière suivante :
|
||||
|
|
|
|||
|
|
@ -130,7 +130,7 @@
|
|||
|
||||
</variablelist>
|
||||
|
||||
<sect3>
|
||||
<sect3 id="config-LSobject-customActions-writing">
|
||||
<title>Ecriture d'une fonction implémentant une customAction</title>
|
||||
<para>Une fonction implémentant une <emphasis>customAction</emphasis> se déclare de
|
||||
la manière suivante :
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
traitements d'un &LSobject;, des fonctions que vous pourrez développer vous
|
||||
même. De plus, le résultat de l'exécution de vos fonctions pourra influer
|
||||
sur le déroulement des processus.</para>
|
||||
|
||||
|
||||
<para>Actuellement, les évenements suivant sont gérés :
|
||||
|
||||
<informaltable>
|
||||
|
|
@ -65,10 +65,10 @@
|
|||
l'exécution des actions liées, si une des fonctions retourne <literal>false
|
||||
</literal>, le processus s'arrêtera.</simpara></note>
|
||||
</para>
|
||||
<sect3>
|
||||
<sect3 id="config-LSobject-triggers-config">
|
||||
<title>Configuration</title>
|
||||
<para>La configuration des déclencheurs se fait dans la définition des types
|
||||
d'&LSobjects;. Par exemple, pour définir les fonctions à exécuter après la
|
||||
d'&LSobjects;. Par exemple, pour définir les fonctions à exécuter après la
|
||||
modification des LSobjects de type <emphasis>LSpeople</emphasis>, c'est à
|
||||
dire lors de leur évènement <literal>after_modify</literal>, il faut définir
|
||||
la variable suivante :
|
||||
|
|
@ -77,7 +77,7 @@ l'exécution des actions liées, si une des fonctions retourne <literal>false
|
|||
nom de la fonction à exécuter, soit un tableau de chaînes de caractères
|
||||
correspondant aux noms des fonctions à exécuter.</para>
|
||||
</sect3>
|
||||
<sect3>
|
||||
<sect3 id="config-LSobject-triggers-writing">
|
||||
<title>Ecriture d'une fonction</title>
|
||||
<para>Une fonction exécuté par un déclencheur d'un LSobject se déclare de la
|
||||
manière suivante :
|
||||
|
|
@ -102,7 +102,7 @@ function maFonction ($object) {
|
|||
Cette fonction doit prendre pour seul paramètre, le LSobject sur lequel l'évènement
|
||||
survient et doit retourner soit <literal>True</literal> si tout s'est bien passé,
|
||||
soit <literal>False</literal> en cas de problème. Dans le cas d'un événement
|
||||
bloquant, si la fonction retourne <literal>False</literal>, le processus est
|
||||
bloquant, si la fonction retourne <literal>False</literal>, le processus est
|
||||
arrêté.</para>
|
||||
</sect3>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,19 +1,19 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<chapter>
|
||||
<chapter id="config">
|
||||
<title>Configuration</title>
|
||||
|
||||
|
||||
<para>
|
||||
La configuration du projet est située principalement dans le dossier 'conf/'.
|
||||
La configuration du projet est située principalement dans le dossier 'conf/'.
|
||||
Les exceptions seront détaillées par la suite.
|
||||
</para>
|
||||
|
||||
|
||||
<warning>
|
||||
<simpara>Toute la configuration du projet se fait par l'intermédiaire de
|
||||
fichiers définissant des variables &php; dont les valeurs sont utilisées par
|
||||
le programme. Ceci signifie que la syntaxe de ces fichiers doit être valide
|
||||
avec l'interpréteur &php; utilisé.</simpara>
|
||||
</warning>
|
||||
|
||||
|
||||
&conf-globale;
|
||||
|
||||
&conf-LSobject;
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<sect1 id='config-globale'>
|
||||
<sect1 id='config-global'>
|
||||
<title>Configuration globale</title>
|
||||
<para>
|
||||
La plus grande partie de la configuration globale se trouve dans le fichier
|
||||
|
|
@ -23,7 +23,7 @@ define('CONST2','val2')
|
|||
?>]]>
|
||||
</programlisting>
|
||||
|
||||
<sect2>
|
||||
<sect2 id='config-global-variables'>
|
||||
<title>Variables globales</title>
|
||||
|
||||
<!-- Début Variables globales -->
|
||||
|
|
@ -97,7 +97,7 @@ define('CONST2','val2')
|
|||
|
||||
</variablelist>
|
||||
|
||||
<sect3>
|
||||
<sect3 id='config-global-preferences'>
|
||||
<title>Préférences globales</title>
|
||||
|
||||
<important><simpara>Les variables globales suivantes ont une action globale, mais
|
||||
|
|
@ -173,7 +173,7 @@ chacun des serveurs LDAP.</simpara></important>
|
|||
|
||||
</sect2>
|
||||
|
||||
<sect2>
|
||||
<sect2 id='config-global-independent-variables-constants'>
|
||||
<title>Variables et constantes indépendantes</title>
|
||||
|
||||
<!-- Début Variables globales -->
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<chapter>
|
||||
<chapter id="contrib">
|
||||
|
||||
<title>Contribution</title>
|
||||
|
||||
|
|
|
|||
|
|
@ -221,7 +221,7 @@ du dossier d'installation, c'est à dire dans notre exemple
|
|||
<literal>local.sh</literal>). Il s'agit en particulier dans ce fichier
|
||||
de configurer la connexion à votre annuaire. Vous pouvez vous inspirer
|
||||
du fichier d'exemple fourni et pour plus de détails, reportez-vous à
|
||||
<link linkend="config-globale">la section concernée</link>.
|
||||
<link linkend="config-global">la section concernée</link>.
|
||||
</simpara>
|
||||
<note><simpara>Notez qu'il est possible de passer l'application en mode
|
||||
<emphasis>debug</emphasis> ce qui peut être utile par la suite.</simpara></note>
|
||||
|
|
|
|||
|
|
@ -1,26 +1,26 @@
|
|||
<chapter>
|
||||
<chapter id="intro">
|
||||
<title>Introduction</title>
|
||||
<para>LdapSaisie est une application web d'administration d'annuaire LDAP développée
|
||||
en PHP/Javascript. Cette application a pour but d'abstraire la complexité d'un
|
||||
en PHP/Javascript. Cette application a pour but d'abstraire la complexité d'un
|
||||
annuaire par l'intermédiraire d'une interface d'administration simple et intuitive.
|
||||
L'application a été concue avec pour objectif premier une modularité maximum, ce
|
||||
qui permet l'extention ou l'adaptation facile de l'application par l'intermédiaire
|
||||
de modules, d'extentions et de greffons. Cette application peut être utilisée pour
|
||||
administrer le système d'information basé sur l'annuaire LDAP et également en
|
||||
administrer le système d'information basé sur l'annuaire LDAP et également en
|
||||
paralèlle pour permettre aux utilisateurs d'avoir accès aux données les concernants
|
||||
et éventuellement de les modifier.</para>
|
||||
|
||||
<sect1>
|
||||
<sect1 id='intro-features'>
|
||||
<title>Fonctionnalités</title>
|
||||
<para>De part sa modularité, &LdapSaisie; est facilement extensible. Cependant,
|
||||
voici une liste non-exhaustive de ses fonctionnalités :</para>
|
||||
<itemizedlist>
|
||||
<listitem><simpara>Gestion d'annuaire simple et multi-branches</simpara></listitem>
|
||||
<listitem><simpara>Gestion d'un nombre illimité de types d'objets</simpara></listitem>
|
||||
<listitem><simpara>Gestion d'un nombre illimité de populations se connectant à
|
||||
<listitem><simpara>Gestion d'un nombre illimité de populations se connectant à
|
||||
l'interface</simpara></listitem>
|
||||
<listitem><simpara>Gestion fine des droits des utilisateurs, permettant la
|
||||
maitrise des droits d'accès sur les objets de l'annuaire et leurs atributs, tout
|
||||
<listitem><simpara>Gestion fine des droits des utilisateurs, permettant la
|
||||
maitrise des droits d'accès sur les objets de l'annuaire et leurs atributs, tout
|
||||
en permettant la délégation de droits.</simpara></listitem>
|
||||
|
||||
<listitem><simpara>Gestion d'un grand nombre de types d'attributs :</simpara>
|
||||
|
|
@ -30,7 +30,7 @@ en permettant la délégation de droits.</simpara></listitem>
|
|||
<listitem><simpara>Date (format paramétrable)</simpara></listitem>
|
||||
<listitem><simpara>Booléen (valeurs paramétrables)</simpara></listitem>
|
||||
<listitem><simpara>Image/Photo</simpara></listitem>
|
||||
<listitem><simpara>Mot de passe (génération de mot passe avec gestion d'une
|
||||
<listitem><simpara>Mot de passe (génération de mot passe avec gestion d'une
|
||||
politique fine)</simpara></listitem>
|
||||
<listitem><simpara>Adresse mail</simpara></listitem>
|
||||
<listitem><simpara>Flux RSS</simpara></listitem>
|
||||
|
|
@ -40,20 +40,20 @@ en permettant la délégation de droits.</simpara></listitem>
|
|||
<listitem><simpara>Quota de mails</simpara></listitem>
|
||||
<listitem><simpara>Clef publique SSH</simpara></listitem>
|
||||
<listitem><simpara>Liste déroulante à choix simple ou multiple</simpara></listitem>
|
||||
<listitem><simpara>Relation à d'autres objets de l'annuaire/ Exemple : membres
|
||||
<listitem><simpara>Relation à d'autres objets de l'annuaire/ Exemple : membres
|
||||
d'un groupe, parrain d'un utilisateur, ... (valeur clé paramétrable)</simpara></listitem>
|
||||
</itemizedlist>
|
||||
|
||||
|
||||
<note><simpara>Chaque type d'attribut à des fonctionnalités qui lui sont propres
|
||||
et qui rendent plus facile et agréable l'utilisation de l'interface (génération
|
||||
automatique de mot de passe, génération des valeurs d'un champ à partir
|
||||
et qui rendent plus facile et agréable l'utilisation de l'interface (génération
|
||||
automatique de mot de passe, génération des valeurs d'un champ à partir
|
||||
d'autres, ...).</simpara></note>
|
||||
|
||||
|
||||
</listitem>
|
||||
|
||||
<listitem><simpara>Gestion d'un grand nombre de règles de vérification des valeurs
|
||||
des attributs :</simpara>
|
||||
|
||||
|
||||
<itemizedlist>
|
||||
<listitem><simpara>Alpha-numérique</simpara></listitem>
|
||||
<listitem><simpara>Lettres uniquement</simpara></listitem>
|
||||
|
|
@ -70,10 +70,10 @@ en permettant la délégation de droits.</simpara></listitem>
|
|||
<listitem><simpara>Politique de mot de passe (longueur/caractères
|
||||
autorisés/caractères obligatoires)</simpara></listitem>
|
||||
</itemizedlist>
|
||||
|
||||
|
||||
</listitem>
|
||||
|
||||
<listitem><simpara>Gestion simplifiée des relations entre les objets de
|
||||
<listitem><simpara>Gestion simplifiée des relations entre les objets de
|
||||
l'annuaire</simpara></listitem>
|
||||
<listitem><simpara>Interface facilement personnalisable grâce à l'utilisation
|
||||
d'un système de template.</simpara></listitem>
|
||||
|
|
@ -94,4 +94,3 @@ dépendance.</simpara></listitem>
|
|||
</itemizedlist>
|
||||
</sect1>
|
||||
</chapter>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<chapter>
|
||||
<chapter id="upgrade">
|
||||
|
||||
<title>Mise à jour</title>
|
||||
|
||||
|
|
@ -7,10 +7,10 @@
|
|||
et regroupe des informations pratiques et utiles pour des montées de versions spécifiques entrainant par
|
||||
exemple une perte de rétrocompatibilité de la configuration.</para>
|
||||
|
||||
<sect1>
|
||||
<sect1 id="upgrade-process">
|
||||
<title>Procédure de mise à jour</title>
|
||||
|
||||
<sect2>
|
||||
<sect2 id="upgrade-from-debian-packages">
|
||||
<title>Installation via paquet Debian</title>
|
||||
<para>Lors d’une installation par paquet Debian, la mise à jour est grandement facilité par le packaging:
|
||||
Il vous suffit de mettre à jour le paquet <literal>ldapsaisie</literal> :
|
||||
|
|
@ -22,7 +22,7 @@ apt install ldapsaisie</programlisting>
|
|||
la section suivante.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2>
|
||||
<sect2 id="upgrade-from-sources">
|
||||
<title>Installation à partir des sources</title>
|
||||
<para>Lors d’une installation par à partir des sources, le script <literal>upgradeFromGit.sh</literal> permet
|
||||
d’automatiser la mise à jour, à condition que vous ayez suivi la procédure d’installation à ce sujet.</para>
|
||||
|
|
@ -50,7 +50,7 @@ apt install ldapsaisie</programlisting>
|
|||
|
||||
</sect1>
|
||||
|
||||
<sect1>
|
||||
<sect1 id="upgrade-2.4.1-to-3.0.0">
|
||||
<title>Mise à jour 2.4.1 -> 3.0.0</title>
|
||||
|
||||
<para>Cette mise à jour majeure apporte de nombreuses nouveautés auxquelles il est important de prêter attention.
|
||||
|
|
@ -59,7 +59,7 @@ url="&GIT_RAW_ROOT_URL;/debian/ldapsaisie.NEWS">debian/ldapsaisie.NEWS
|
|||
</ulink> pour cela. Cette section listera en outre les points de vigilances à avoir et les adaptations à apporter
|
||||
sur votre configuration et votre code personnalisé.</para>
|
||||
|
||||
<sect2>
|
||||
<sect2 id="upgrade-2.4.1-to-3.0.0-config.inc.php">
|
||||
<title>Fichier config.inc.php</title>
|
||||
<itemizedlist>
|
||||
<listitem><simpara>ajout du paramètre <literal>ConsoleTable</literal> avec pour valeur par défaut sous
|
||||
|
|
@ -107,7 +107,7 @@ sur votre configuration et votre code personnalisé.</para>
|
|||
</itemizedlist>
|
||||
</sect2>
|
||||
|
||||
<sect2>
|
||||
<sect2 id="upgrade-2.4.1-to-3.0.0-css">
|
||||
<title>Fichiers CSS</title>
|
||||
<note><para>Les fichiers <literal>light-*.css</literal> ont été retravaillés pour tous <emphasis>hériter
|
||||
</emphasis> du fichier <literal>light-blue.css</literal> qui défini les couleurs de l'interface au travers
|
||||
|
|
@ -133,7 +133,7 @@ grep -Er 'url\(.*\.(png|gif|jpg)' /etc/ldapsaisie/local/css</programlisting></pa
|
|||
</itemizedlist>
|
||||
</sect2>
|
||||
|
||||
<sect2>
|
||||
<sect2 id="upgrade-2.4.1-to-3.0.0-php">
|
||||
<title>Fichiers PHP</title>
|
||||
<itemizedlist>
|
||||
<listitem><para><literal>LSsession :: redirect()</literal> devient <literal>LSurl :: redirect()</literal>.
|
||||
|
|
@ -217,10 +217,10 @@ grep -Er '(LSsession|LStemplate) *:: *addCssFile\(.*\.\.\/' /etc/ldapsaisie/loca
|
|||
</itemizedlist>
|
||||
</sect2>
|
||||
|
||||
<sect2>
|
||||
<sect2 id="upgrade-2.4.1-to-3.0.0-templates">
|
||||
<title>Fichiers templates :</title>
|
||||
|
||||
<sect3>
|
||||
<sect3 id="upgrade-2.4.1-to-3.0.0-templates-includes">
|
||||
<title>Changement de l’inclusion des templates</title>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
|
|
@ -308,7 +308,7 @@ défaut):
|
|||
</para>
|
||||
</sect3>
|
||||
|
||||
<sect3>
|
||||
<sect3 id="upgrade-2.4.1-to-3.0.0-templates-default">
|
||||
<title>Fichiers templates fournis par defaut :</title>
|
||||
<para>Vérifier les modifications des fichiers templates fourni avec l’application et que vous auriez personnalisé.
|
||||
Pour cela, vous pouvez utiliser la commande suivante :<programlisting><![CDATA[for i in $( ls /etc/ldapsaisie/local/templates/* )
|
||||
|
|
@ -322,7 +322,7 @@ done]]></programlisting>
|
|||
recoverpassword.tpl</literal> qui ont particulièrement changés.</simpara></note>
|
||||
</sect3>
|
||||
|
||||
<sect3>
|
||||
<sect3 id="upgrade-2.4.1-to-3.0.0-templates-images-urls">
|
||||
<title>Corriger les URL des images :</title>
|
||||
<para><literal>../../images/default/find.png</literal> devient <literal>../image/find</literal></para>
|
||||
|
||||
|
|
@ -332,7 +332,7 @@ grep -Er '\.(png|gif|jpg)' /etc/ldapsaisie/local/templates</programlisting>
|
|||
</para>
|
||||
</sect3>
|
||||
|
||||
<sect3>
|
||||
<sect3 id="upgrade-2.4.1-to-3.0.0-LSsession_css-LSsession_js">
|
||||
<title>Le cas de variable de template <literal>{$LSsession_css}</literal> et <literal>{$LSsession_js}</literal> :</title>
|
||||
<note><simpara>Ceci est déjà géré si vous étendez bien vos templates du fichier <literal>base.tpl</literal> (pour
|
||||
les pages non-connectées) ou <literal>base_connected.tpl</literal> (pour les pages connectées).</simpara></note>
|
||||
|
|
@ -352,7 +352,7 @@ grep -Er '\.(png|gif|jpg)' /etc/ldapsaisie/local/templates</programlisting>
|
|||
|
||||
</sect2>
|
||||
|
||||
<sect2>
|
||||
<sect2 id="upgrade-2.4.1-to-3.0.0-urls">
|
||||
<title>Tous les fichiers : Modification des URLs</title>
|
||||
|
||||
<itemizedlist>
|
||||
|
|
|
|||
Loading…
Reference in a new issue