Guide du développeur de la bibliothèque numérique Greenstone

Chapter 4 Configurer son site Greenstone

Contents

Fichier de configuration principal
Fichier de configuration de site

Dans Greenstone, deux fichiers de configuration sont utilisés pour configurer divers aspects du site Greenstone. Il s'agit du fichier de configuration «principal» main.cfg, qui se trouve dans GSDLHOME/etc, et du fichier de configuration «de site» gsdlsite.cfg, qui se trouve dans GSDLHOME/cgi-bin. Ces fichiers contrôlent tous deux des aspects spécifiques de la configuration du site, et tous deux peuvent être visualisés depuis la page d'administration de Greenstone.

4.1 Fichier de configuration principal

Le fichier de configuration principal main.cfg sert à configurer le réceptionniste -- la partie de Greenstone qui présente les requêtes et affiche les pages. Vous pouvez tout contrôler, des langues que l'interface peut utiliser aux journaux qui seront conservés.

Maintenance du site et journalisation

Les lignes du fichier de configuration dictent la manière dont votre site Greenstone sera maintenu, quelles fonctionnalités il offrira, quels événements seront journalisés, et quelles notifications seront faites au mainteneur. La table 20 détaille certaines des options disponibles; les options restantes sont décrites dans les sections suivantes.

Table 20  Options de configuration pour la maintenance et la journalisation

Valeur

But

maintainer

vide ou une adresse de courrier électronique

Adresse de courrier électronique du mainteneur de site à utiliser pour certaines notifications. Si elle est vide, les événements de courrier électronique sont désactivés

MailServer

vide ou un nom de serveur

Serveur de courrier électronique sortant pour le site. Si elle est vide, c'estmail.domaine-du-mainteneurqui sera utilisé (si par exemple le mainteneur estaide@exemple.com, la valeur par défaut seramail.exemple.com). Si ceci n'aboutit pas à un serveur SMTP valide, les événements de courrier électronique ne fonctionneront pas

status

enabled(activée) oudisabled(désactivée)

Détermine si la page deMaintenance et administrationdoit être rendue disponible

collector

enabled(activée) oudisabled(désactivée)

Détermine si l'outil «Collector» de construction de collection pour l'utilisateur final est disponible

logcgiargs

true(vraie) oufalse(fausse)

Si la valeur esttrue, , un journal d'utilisation est conservé dans le fichier usage.txt.

usecookies

true(vraie) oufalse(fausse)

Si la valeur esttrue,des informations relatives aux utilisateurs du site sont collectées (à l'aide decookies) et consignées dans le journalusage.txt(ceci ne fonctionne que si l'optionlogcgiargsa la valeurtrue)

LogDateFormat

LocalTime(heure locale) ou
UTCTime(heure du temps universel—GMT) ou
Absolute(heure absolue)

Format dans lequel consigner les dates et les heures dans les journaux.LocalTimeproduit le format «Thu Dec 07 12:34 NZDT 2000»,UTCTimeest le même format mais en temps universel, etabsoluteest un entier représentant le nombre de secondes écoulées depuis «00:00:00 01/01/1970 GMT»

LogEvents

AllEvents(tous les événements) ou
CollectorEvents(événements du Collector) ou
disabled(désactivée)

Consigne certains événements dans le journalevents.txt.AllEventsconsigne tous les événements de Greenstone,CollectorEventsne consigne que les événements liés au Collector, etdisabledne consigne aucun événement

EmailEvents

enabled(activée) oudisabled(désactivée)

Envoie un courrier électronique au mainteneur (s'il y en a un—voir l'option maintainer) à chaque fois qu'un événement se produit

EmailUserEvents

enabled(activée) oudisabled(désactivée)

Envoie un courrier électronique à l'utilisateur lors de certains événements—tels que la fin de la construction d'une collection par le Collector

macrofiles

liste de noms de fichiers de macros

Détermine quelles macros sont disponibles pour le logiciel d'interface utilisateur de Greenstone


Support des langues

Le fichier de configuration main.cfg contient deux types d'entrées qui affectent la gestion des différentes langues. Elles déterminent quelles langues et quels encodages seront disponibles dans la page de Préférences. Les lignes encoding (encodage) spécifient les différents types d'encodage de caractères qui peuvent être sélectionnés. Les lignes language (langue) spécifient quelles langues on pourra sélectionner pour l'interface utilisateur (il doit bien sûr exister une macro de langue pour chaque langue possible).

La ligne encoding peut contenir quatre valeurs possibles: shortname (nom court), longname (nom long), map (correspondance), et multibyte (multi-octets). La valeur shortname est l'étiquette du jeu de caractères standard, et doit être spécifiée pour tous les encodages. La valeur longname donne le nom d'encodage spécifié sur la page de Préférences. En son absence la valeur par défaut est celle de shortname. La valeur map est obligatoire pour tous les encodages à l'exception de l'UTF-8, qui est géré de manière interne (et qui devrait toujours être activé). La valeur multibyte devrait être positionnée pour tous les jeux de caractères qui nécessitent plus d'un octet par caractère. Le fichier main.cfg spécifie de nombreux encodages, dont la plupart sont désactivés car commentés. Pour activer un encodage, ôtez le caractère de commentaire «#».

Chaque ligne language peut contenir trois valeurs possibles: shortname (nom court), longname (nom long), et default_encoding (encodage par défaut). La valeur shortname est le symbole de langue en deux lettres ISO 639, et elle est obligatoire. La valeur longname donne le nom de la langue spécifié sur la page de Préférences. En son absence la valeur par défaut est celle de shortname. L'option default_encoding sert à spécifier l'encodage préféré pour cette langue.

Paramètres de page et arguments CGI

On peut définir des paramètres de page et des arguments CGI dans le fichier de configuration main.cfg. Rappelez-vous qu'à la figure 40 la plupart des arguments CGI sont définis au sein même du code C++ de la bibliothèque. Cependant, il est parfois utile de définir de nouveaux arguments ou d'éditer les arguments existants dans les fichiers de configuration, ce qui évite de recompiler la bibliothèque.

Pour ce faire, vous utiliserez l'option de configuration cgiarg. Elle peut prendre jusqu'à six arguments, qui sont les suivants: shortname (nom court), longname (nom long), multiplechar (caractères multiples), argdefault (argument par défaut), defaultstatus (état par défaut), et savedarginfo (informations de sauvegarde d'argument). Ces arguments correspondent aux options d'arguments CGI décrits section 3.8. Par exemple, dans le fichier main.cfg, par défaut, l'option de configuration cgiarg sert à positionner les valeurs par défaut des arguments CGI existants a et p à p et home, respectivement.

Les paramètres de page sont un cas particulier d'arguments CGI qui correspondent aux paramètres des fichiers de macros de Greenstone. Par exemple, l'argument CGI l correspond directement au paramètre l= dans les fichiers de macros. On utilise l'option de configuration pageparam pour définir un argument CGI comme étant également un paramètre de page.

La meilleure manière d'apprendre les différentes options de configuration possibles dans le fichier de configuration main.cfg est de faire des expériences avec ce dernier. Souvenez-vous que si vous utilisez la version «Bibliothèque locale» de Greenstone sous Windows, il faut redémarrer le serveur pour que toute modification des fichiers de configuration soit prise en compte.

4.2 Fichier de configuration de site

Table 21  Lignes du fichiergsdlsite.cfg

Ligne

Fonction

gsdlhome

Un chemin vers le répertoireGSDLHOME.

httpprefix

L'adresse web deGSDLHOME. Si la racine de documents de votre serveur web a la valeurGSDLHOMEvous n'avez pas besoin de cette ligne.

httpimage

L'adresse web du répertoire contenant les images de l'interface utilisateur. Si la racine de documents de votre serveur web a la valeurGSDLHOMEceci vaudra/images.

gwcgi

L'adresse web du présent script CGI (se termine généralement parlibrary). Ceci n'est pas nécessaire si votre serveur web positionne la variable d'environnementSCRIPT_NAME(nom de script).

maxrequests

(Ne s'applique que si l'on utilisefast-cgi.) Nombre de requêtes que Fast-CGI doit traiter avant de rendre la main. Lors du débogage de la bibliothèque il faut positionner ceci à une faible valeur, et à une valeur élevée dans le cas contraire, en production.


Le fichier de configuration de site gsdlsite.cfg positionne des variables utilisées par le logiciel de bibliothèque et le serveur web au moment de l'exécution, et se trouve dans le même répertoire que le programme library. La table 21 décrit les lignes de ce fichier; elles sont expliquées dans la section 5 du Guide d'installation de la bibliothèque numérique Greenstone.


Copyright © 2002 2003 2004 2005 2006 2007 by the New Zealand Digital Library Project at the University of Waikato, New Zealand.

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled “GNU Free Documentation License.”