From 76d3ab6487205ced216df531efabcaeacf58f66a Mon Sep 17 00:00:00 2001 From: Benjamin Renard Date: Fri, 4 Dec 2009 17:43:20 +0100 Subject: [PATCH] Doc : Change 'Installation Steps' section in a tutorial of the installation with more details. --- doc/install/arbo.docbook | 2 +- doc/install/install.docbook | 184 +++++++++++++++++++++++++++++++----- 2 files changed, 162 insertions(+), 24 deletions(-) diff --git a/doc/install/arbo.docbook b/doc/install/arbo.docbook index 7ae597e6..346f3971 100644 --- a/doc/install/arbo.docbook +++ b/doc/install/arbo.docbook @@ -1,5 +1,5 @@ - + Arborescence du projet diff --git a/doc/install/install.docbook b/doc/install/install.docbook index 854b421c..700537fd 100644 --- a/doc/install/install.docbook +++ b/doc/install/install.docbook @@ -51,25 +51,132 @@ &install-arbo; - Les étapes de l'installation - Cette section décrit rapidement les différentes étapes de l'installation - de LdapSaisie. + Tutoriel d'installation + 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. + + + 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 /var/www/ldapsaisie. 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 lsexample. - Téléchargement et décompression si nécessaire. - Plus de détails + + 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 git-core. Le + dépôt Git doit ensuite être récupéré anonymement en utilisant la + commande suivante : + + git clone git://git.labs.libre-entreprise.org/ldapsaisie.git + + La suite des opérations se déroulera donc maintenant dans le dossier + /var/www/ldapsaisie. Pour avoir plus de détails sur + les élements qu'on retrouve dans ce dossier, vous pouvez consulter + la section concernée. Nous allons + nous instérésser plus particulièrement : + + au script upgradeFromGit.sh + permettant la mise à jour de votre repos tout en concervant les adaptations + que nous ferons pour l'usage d'LdapSaisie adapté à notre annuaire ; + + au dossier config.local dans + lequel seront stockés vos fichiers et vos adaptations de l'application ; + + au dossier public_html qui + correspond à la futur racine du site web de l'application. + + + Le principe de l'adaptation est ici de mettre vos fichiers personnalisés + dans le dossier config.local, de les déclarer dans + votre fichier config.local/local.sh contenant la liste + des fichiers devant être installés. Le fichier local.sh + est la source de configuration du script upgradeFromGit.sh. + Il faut donc dans un premier temps créer votre fichier + local.sh en copiant le fichier d'example + local.sh.example. Ce fichier est un script bash + déclarant les variables de configurations suivantes : - Configuration globale : Cette partie est principalement - contenue dans le fichier conf/config.inc.php. Il s'agit en - particulier de configurer la connexion à votre annuaire. Pour plus de détails, - reportez-vous à la section concernée. - - Il est possible de passer l'application en mode debug - ce qui peut être utile par la suite. + + + + LOCAL_FILES + + 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 : +public_html/conf/config.inc.php +public_html/lang/fr_FR.UTF8/lang.php + + + + + LOG_FILE + + Nom du fichier de log des mises à jour. + + + + + THEME + + Le nom du theme à installer (facultatif et non traité dans + ce tutoriel). + + + + + BUILD_DOC + + Variable booléene définissant si la documentation doit être + compiler en utilisant le script buildDocExports.sh. + Ceci ne sera pas expliqué dans ce tutoriel et nous partirons donc du + principe que cette variable est à 0. + + + + + +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 +BUILD_DOC vaut 0. + +Il est possible d'utiliser dans ce fichier de configuration +la variable bash $ROOT_DIR correspondant au chemin +du dossier d'installation, c'est à dire dans notre exemple +/var/www/ldapsaisie. + + - Configuration des types de &LSobjects; : Chaque type d'objet - manipulé par LdapSaisie doit correspondre avec un type de LSobject. + La deuxième étape concerne la configuration globale + de l'application : Cette partie est principalement contenue dans le + fichier conf/config.inc.php. Il faut donc dans un + premier temps copier ce fichier dans le dossier config.local + et le déclarer dans la liste des fichiers à déployer lors des mises à + jour (variable LOCAL_FILES dans le fichier + local.sh). 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 à + la section concernée. + + Notez qu'il est possible de passer l'application en mode + debug ce qui peut être utile par la suite. + + + 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. @@ -81,15 +188,22 @@ /includes/class/ et portent les noms composés de la manière suivante : class.LSobjects.[nom du type d'LSobject].php - 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 LSpeople est - le plus simple car il ne contient que le strict minimum. + Le plus simple pour cette étape est de copier un des fichiers d'exemple dans + le dossier config.local 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 LSpeople 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 LSgroup + contient déjà les méthodes nécéssaires pour gérer ces cas. + 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 LSpeople + 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 à la section concernée. @@ -104,14 +218,38 @@ + Pensez à déclarer les fichiers que vous venez de créer dans la variable + LOCAL_FILES du fichier local.sh. Exemple pour le + type d'LSobjet portant comme nom LSexample : +public_html/conf/LSobjects/config.LSobjects.LSexample.php +public_html/includes/class/class.LSobjects.LSexample.php + + + 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... + + - 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... + La dernière étape à ce niveau consiste à lancer le script + upgradeFromGit.sh 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 ldapsaisie-users@lists.labs.libre-entreprise.org. + + + Vous devriez dès à présent accèder à l'application + via votre navigateur web à l'URL suivante : + http://[IP ou nom du serveur]/ldapsaisie/public_html + + + +