From dcb4d4deed4a2a1e0b11562d3c5a49ac4522d174 Mon Sep 17 00:00:00 2001 From: Benjamin Renard Date: Wed, 19 Jun 2013 04:02:20 +0200 Subject: [PATCH] Doc : update documentation with last change --- doc/conf/globale.docbook | 8 ++-- doc/install/arbo.docbook | 9 +++- doc/install/install.docbook | 96 ++++++++++++++++++++++--------------- 3 files changed, 70 insertions(+), 43 deletions(-) diff --git a/doc/conf/globale.docbook b/doc/conf/globale.docbook index 3e47eb59..2e2de594 100644 --- a/doc/conf/globale.docbook +++ b/doc/conf/globale.docbook @@ -160,7 +160,7 @@ define('CONST2','val2') LS_TEMPLATES_DIR Constante déterminant le chemin du dossier des templates. - Valeur par défaut : templates/LS_THEME + Valeur par défaut : templates @@ -168,7 +168,7 @@ define('CONST2','val2') LS_IMAGES_DIR Constante déterminant le chemin du dossier des images. - Valeur par défaut : images/LS_THEME + Valeur par défaut : images @@ -176,7 +176,7 @@ define('CONST2','val2') LS_CSS_DIR Constante déterminant le chemin du dossier des CSS. - Valeur par défaut : css/LS_THEME + Valeur par défaut : css @@ -229,7 +229,7 @@ define('CONST2','val2') $GLOBALS['defaultJSscipts'] - Tableau déterminant les fichiers CSS à charger sur toute les pages. + Tableau déterminant les fichiers Javascript à charger sur toute les pages. diff --git a/doc/install/arbo.docbook b/doc/install/arbo.docbook index 49dd94d0..33253e30 100644 --- a/doc/install/arbo.docbook +++ b/doc/install/arbo.docbook @@ -137,7 +137,14 @@ d'image. - + + + local/ + + Les fichiers personnalisés de l'installation. + + + tmp/ diff --git a/doc/install/install.docbook b/doc/install/install.docbook index 6a0583bf..6b60c4a1 100644 --- a/doc/install/install.docbook +++ b/doc/install/install.docbook @@ -12,7 +12,7 @@ Le support json dans &php; (pear install pecl/json sur RedHat, intégré au paquet php5-common dans Debian) &netldap; (paquet php-net-ldap2 dans Debian ou pear install net_ldap2) &smarty; (paquet smarty dans Debian) - L'utisateur exécutant le serveur web doit avoir les droits d'écriture sur le dossier 'tmp'. + L'utisateur exécutant le serveur web doit avoir les droits d'écriture sur le dossier 'tmp'. En cas d'installation à partir du paquet Debian, ce dossier est remplacé par un lien symbolique vers le dossier /var/tmp/ldapsaisie/. La librairie &netldap; oblige le fait que la racine DSE de l'annuaire soit lisible en anonyme sinon la connexion à l'annuaire échouera @@ -31,10 +31,25 @@ Téléchargement - Il n'existe pas encore de version stable publiée. Vous pouvez obtenir le - code source soit en le rapatriant à partir du serveur Git, soit en téléchargeant - le dernier snapshot nocturne de l'arbre Git. - + + + A partir du paquet Debian + L'installation à partir du paquet Debian peut être réalisée soit en + téléchargeant manuellement le paquet, soit en déclarant le dépôt APT suivant + dans votre fichier /etc/apt/sources.list : + + deb http://ldapsaisie.easter-eggs.org/debian stable main + + Il ne vous restera ensuite plus qu'a installer le paquet ldapsaisie + avec la commande suivante : + + apt-get install ldapsaisie + + Le fichier /etc/ldapsaisie/apache.conf est un example de + configuration du serveur web Apache. La configuration du logiciel ce fera ensuite + dans le dossier /etc/ldapsaisie/local/. + + A partir de Git @@ -64,17 +79,13 @@ 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. - + LdapSaisie. Deux méthodes d'installation sont présentées ici, l'une à + partir des sources du projet et l'autre à partir du paquet Debian. 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 + configuration de votre serveur web) et que l'installation à partir des sources + 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 @@ -82,8 +93,19 @@ - La première étape consiste à faire un clonage du - repos Git. Pour cela il vous faut avoir installés les outils de Git + La première étape consiste à installer le locigiel en tant que tel. + Pour une installation à partir du paquet Debian référez vous au chapitre + Téléchargement. Une fois le paquet + Debian, la configuration du logiciel se fera dans le dossier + /etc/ldapsaisie/local/. Les fichiers placés dans ce + dossier prévaleront toujours aux fichiers fournis par le paquet Debian, + vous permettant facilement de modifier un composant existant ou dans écrire + de nouveaux. Ainsi, pour modifier un fichier CSS par exemple, il vous + suffira de le placer dans le dossier + /etc/ldapsaisie/local/css/. + + Pour une installation à partir du code source, il vous faut + cloner le 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 : @@ -175,10 +197,13 @@ du dossier d'installation, c'est à dire dans notre exemple 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 + fichier conf/config.inc.php (ou + /etc/ldapsaisie/local/conf/config.inc.php en cas + d'installation à partir du paquet Debian). En cas d'installation à partir + du code source, 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 à @@ -202,11 +227,10 @@ du dossier d'installation, c'est à dire dans notre exemple /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 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 + Le plus simple pour cette étape est de copier un des fichiers d'exemple afin + 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. @@ -232,9 +256,10 @@ du dossier d'installation, c'est à dire dans notre exemple - 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 : + En cas d'installation à partir du code source, 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 @@ -247,19 +272,14 @@ public_html/includes/class/class.LSobjects.LSexample.php - 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. + En cas d'installation à partir du code source, une 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 - -