Doc : Change 'Installation Steps' section in a tutorial of the installation with...
authorBenjamin Renard <brenard@aconit.easter-eggs.fr>
Fri, 4 Dec 2009 16:43:20 +0000 (17:43 +0100)
committerBenjamin Renard <brenard@aconit.easter-eggs.fr>
Fri, 4 Dec 2009 16:43:20 +0000 (17:43 +0100)
doc/install/arbo.docbook
doc/install/install.docbook

index 7ae597e..346f397 100644 (file)
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<sect1>
+<sect1 id="install-arbo">
   <title>Arborescence du projet</title>
   
   <variablelist>
index 854b421..700537f 100644 (file)
 &install-arbo;
 
 <sect1>
-  <title>Les étapes de l'installation</title>
-  <para>Cette section décrit rapidement les différentes étapes de l'installation
-  de LdapSaisie.</para>
+  <title>Tutoriel d'installation</title>
+  <para>Cette section décrit les différentes étapes de l'installation de
+  LdapSaisie. Aucune version d'LdapSaisie n'étant pour le moment sortie,
+  cette méthode d'installation se base sur la récupération des sources
+  directement dans le repos Git du projet. Des scripts ont été développés
+  pour faciliter ces opérations de mises à jours tout en permettant une
+  grande souplesse de confirguration et de personnalisation de l'application.</para>
+  
+  
+  <para>Dans ce tutoriel, nous partirons du principe que vous avez 
+  pleinement la main sur votre serveur (installation de nouveau paquet et
+  configuration de votre serveur web) et que l'installation se fera 
+  dans le dossier <literal>/var/www/ldapsaisie</literal>. Nous partons
+  également du principe que votre annuaire LDAP est déjà en place. Nous
+  utiliserons pour cette exemple de mise ne oeuvre l'annuaire correspondant
+  au schéma et à la configuration présente dans les sources du projet dans
+  le dossier <literal>lsexample</literal>.</para>
   
 <orderedlist>
-  <listitem><simpara>Téléchargement et décompression si nécessaire. 
-  <link linkend="install-download">Plus de détails</link></simpara></listitem>
+  <listitem>
+  <para>La première étape consiste à faire un clonage du 
+  repos Git. Pour cela il vous faut avoir installés les outils de Git 
+  contenu, dans Debian, dans le paquet <literal>git-core</literal>. Le
+  dépôt Git doit ensuite être récupéré anonymement en utilisant la
+  commande suivante :
+  <screen>
+    <command>git clone git://git.labs.libre-entreprise.org/ldapsaisie.git</command>
+  </screen>
+  La suite des opérations se déroulera donc maintenant dans le dossier
+  <literal>/var/www/ldapsaisie</literal>. Pour avoir plus de détails sur
+  les élements qu'on retrouve dans ce dossier, vous pouvez consulter 
+  <link linkend="install-arbo">la section concernée</link>. Nous allons 
+  nous instérésser plus particulièrement :
+  <itemizedlist>
+    <listitem><simpara>au script <literal>upgradeFromGit.sh</literal>
+    permettant la mise à jour de votre repos tout en concervant les adaptations
+    que nous ferons pour l'usage d'LdapSaisie adapté à notre annuaire ;</simpara>
+    </listitem>
+    <listitem><simpara>au dossier <literal>config.local</literal> dans 
+    lequel seront stockés vos fichiers et vos adaptations de l'application ;
+    </simpara></listitem>
+    <listitem><simpara>au dossier <literal>public_html</literal> qui
+    correspond à la futur racine du site web de l'application.</simpara>
+    </listitem>
+  </itemizedlist>
+  Le principe de l'adaptation est ici de mettre vos fichiers personnalisés
+  dans le dossier <literal>config.local</literal>, de les déclarer dans
+  votre fichier <literal>config.local/local.sh</literal> contenant la liste
+  des fichiers devant être installés. Le fichier <literal>local.sh</literal>
+  est la source de configuration du script <literal>upgradeFromGit.sh</literal>.
+  Il faut donc dans un premier temps créer votre fichier
+  <literal>local.sh</literal> en copiant le fichier d'example
+  <literal>local.sh.example</literal>. Ce fichier est un script bash
+  déclarant les variables de configurations suivantes :
+  
+<variablelist>
   
-  <listitem><simpara>Configuration globale : Cette partie est principalement 
-  contenue dans le fichier <emphasis>conf/config.inc.php</emphasis>. Il s'agit en
-  particulier de configurer la connexion à votre annuaire. Pour plus de détails,
-  reportez-vous à <link linkend="config-globale">la section concernée</link>.
+<varlistentry>
+  <term>LOCAL_FILES</term>
+  <listitem>
+    <simpara>La liste des chemins des fichiers à installer dans l'arboressence
+    du site. Cette élément doivent être séparés par des espaces ou des
+    retour à la liste. Exemple :</simpara>
+<programlisting>public_html/conf/config.inc.php
+public_html/lang/fr_FR.UTF8/lang.php</programlisting>
+  </listitem>
+</varlistentry>
+
+<varlistentry>
+  <term>LOG_FILE</term>
+  <listitem>
+    <simpara>Nom du fichier de log des mises à jour.</simpara>
+  </listitem>
+</varlistentry>
+
+<varlistentry>
+  <term>THEME</term>
+  <listitem>
+    <simpara>Le nom du theme à installer (facultatif et non traité dans
+    ce tutoriel).</simpara>
+  </listitem>
+</varlistentry>
+
+<varlistentry>
+  <term>BUILD_DOC</term>
+  <listitem>
+    <simpara>Variable booléene définissant si la documentation doit être
+    compiler en utilisant le script <literal>buildDocExports.sh</literal>.
+    Ceci ne sera pas expliqué dans ce tutoriel et nous partirons donc du
+    principe que cette variable est à <literal>0</literal>.</simpara>
+  </listitem>
+</varlistentry>
+
+</variablelist>
+
+<note><simpara>D'autres variables sont présentes dans ce fichier et
+concerne uniquement la compilation de la documentation. Elle peuvent
+être ignorée à partir du moment ou la variable
+<literal>BUILD_DOC</literal> vaut <literal>0</literal>.</simpara></note>
+
+<note><simpara>Il est possible d'utiliser dans ce fichier de configuration
+la variable bash <literal>$ROOT_DIR</literal> correspondant au chemin
+du dossier d'installation, c'est à dire dans notre exemple
+<literal>/var/www/ldapsaisie</literal>.</simpara></note>
+  
+  </para>
+  </listitem>
+  
+  <listitem><simpara>La deuxième étape concerne la configuration globale
+  de l'application : Cette partie est principalement contenue dans le
+  fichier <emphasis>conf/config.inc.php</emphasis>. Il faut donc dans un
+  premier temps copier ce fichier dans le dossier <literal>config.local</literal>
+  et le déclarer dans la liste des fichiers à déployer lors des mises à
+  jour (variable <literal>LOCAL_FILES</literal> dans le fichier 
+  <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>.
   </simpara>
-  <note><simpara>Il est possible de passer l'application en mode <emphasis>debug
-  </emphasis> ce qui peut être utile par la suite.</simpara></note>
+  <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>
   </listitem>
   
-  <listitem><simpara>Configuration des types de &LSobjects; : Chaque type d'objet
-    manipulé par LdapSaisie doit correspondre avec un type de LSobject.</simpara>
+  <listitem><simpara>La troisième étape concerne la configuration des
+  types de &LSobjects; : Chaque type d'objet manipulé par LdapSaisie doit
+  correspondre avec un type de LSobject.</simpara>
     
     <orderedlist>
     
     <emphasis>/includes/class/</emphasis> et portent les noms composés de la 
     manière suivante : 
     <programlisting>class.LSobjects.[nom du type d'LSobject].php</programlisting>
-    Le plus simple pour cette étape est de recopier un des fichiers d'exemple et
-    de l'adapter en changeant le nom du type d'objet dans l'ensemble du fichier.
-    Pour cela, le fichier de classe du type <emphasis>LSpeople</emphasis> est 
-    le plus simple car il ne contient que le strict minimum.</para></listitem>
+    Le plus simple pour cette étape est de copier un des fichiers d'exemple dans
+    le dossier <literal>config.local</literal> et de l'adapter en changeant
+    le nom du type d'objet dans l'ensemble du fichier. Pour cela, le fichier
+    de classe du type <emphasis>LSpeople</emphasis> est le plus simple
+    car il ne contient que le strict minimum. Pour un fichier de classe
+    ayant des &LSrelations; à gérer, le fichier de classe <emphasis>LSgroup
+    </emphasis> contient déjà les méthodes nécéssaires pour gérer ces cas.
+    </para></listitem>
     
     <listitem><simpara>Configurer vos LSobject : Cette partie est certainement la
     plus longue et consiste à déclarer l'ensemble des informations relatives aux
     types des objets LDAP manipulés. Les fichiers d'exemples fournis vous seront
-    certainement d'une aide précieuse. Pour plus de détails, reportez-vous à 
+    alors d'une aide précieuse. basé vous sur l'un de pour créer le votre. Pour
+    cela le fichier de configuration du type d'LSobjet <emphasis>LSpeople</emphasis>
+    est le plus complet et est un bon point de départ. Pour plus de détails sur les
+    élements de configuration de ce fichier, reportez-vous à 
     <link linkend="config-LSobject">la section concernée</link>.</simpara>
     </listitem>
     
     
   </orderedlist>
   
+  <important><simpara>Pensez à déclarer les fichiers que vous venez de créer dans la variable
+  <literal>LOCAL_FILES</literal> du fichier <literal>local.sh</literal>. Exemple pour le
+  type d'LSobjet portant comme nom <literal>LSexample</literal> :</simpara>
+<programlisting>public_html/conf/LSobjects/config.LSobjects.LSexample.php
+public_html/includes/class/class.LSobjects.LSexample.php</programlisting>
+  </important>
+  
+  <note><simpara>Vous pouvez également personnaliser l'interface : Il est
+  possible de personnaliser à votre goût l'interface en écrivant votre
+  template ou en modifiant simplement les fichiers CSS. Une partie de
+  cette documentation concernera bientôt cette problématique. Patience...
+  </simpara></note>
+  
   </listitem>
   
-  <listitem><simpara>Personnaliser l'interface : Il est possible de personnaliser
-  à votre goût l'interface en écrivant votre template ou en modifiant simplement
-  les fichiers CSS. Une partie de cette documentation concernera bientôt cette
-  problématique. Patience...</simpara></listitem>
+  <listitem><simpara>La dernière étape à ce niveau consiste à lancer le script
+  <literal>upgradeFromGit.sh</literal> pour qu'il installe les fichiers
+  que vous venez de créer. Ce script est conçu pour dire tout ce qu'il fait
+  donc en cas de problème vous devriez rapidement comprendre où cela coince.
+  Dans tout les cas, n'hésitez pas à poser vos questions à la communauté sur
+  la liste <email>ldapsaisie-users@lists.labs.libre-entreprise.org</email>.
+  </simpara></listitem>
+  
+  <listitem><simpara>Vous devriez dès à présent accèder à l'application
+  via votre navigateur web à l'URL suivante :
+  <programlisting>http://[IP ou nom du serveur]/ldapsaisie/public_html</programlisting>
+  </simpara></listitem>
   
 </orderedlist>
+
+
+
 </sect1>
  
 </chapter>