La configuration d'Alambic réside dans un unique fichier. Nous vous recommandons d'utiliser le fichier d'exemple fourni comme base pour la création de votre propre configuration.

La configuration consiste à assigner des valeurs à différentes primitives dans le fichier de configuration. Ces valeurs sont définies en ajoutant des lignes de la forme PRIMITIVE=VALEUR au contenu du fichier de configuration (sans espace autour du signe égal). La dernière valeur donnée à une primitive est celle prise en compte par Alambic.

Les lignes ne contenant pas une primitive valide sont ignorées.

Les primitives de configuration sont décrites ci-après :

Lang

Cette primitive permet de sélectionner la langue utilisée par Alambic pour ses messages. Pour le moment seuls le français (fr), l'allemand (de) et l'anglais (en) sont des valeurs possibles. Si une valeur non supportée est donnée à cette primitive, Alambic utilisera l'anglais par défaut.

La valeur de cette primitive est le nom d'un répertoire dans lequel Alambic va créer tous ses fichiers de travail. Ces fichiers incluent les messages à envoyer aux utilisateurs, les fichiers PostScript temporaires ainsi que les fichiers PDF générés, temporaires ou non. Ce répertoire doit être accessible en écriture à l'utilisateur root et disposer de suffisamment d'espace pour qu'Alambic puisse fonctionner correctement.

Cette primitive doit apparaître dans le fichier de configuration si vous souhaitez offrir la récupértion des documents PDF générés via le protocole HTTP. Sa valeur est le préfixe à utiliser pour les URLs de récupération des fichiers PDF. Si cette primitive est présente, le répertoire WorkDir doit contenir un sous-répertoire htdocs dans lequel les fichiers PDF à récupérer par HTTP seront créés. Merci de vous référer à la documentation de configuration d'Apache pour utiliser ce serveur conjointement à Alambic. Notez également que si la récupération par HTTP est active, vous devriez mettre en place une purge périodique du répertoire htdocs (par exemple en supprimant les fichiers vieux de plus de 2 heures).

Cette primitive sélectionne la méthode d'association d'adresses de courriel à un nom d'utilisateur. La valeur de cette primitive est soit un chemin vers un programme ou script à appeler ou une chaîne du type builtin:/CHEMIN/VERS/UNE/BASE/UTILISATEURS. Le fichier /CHEMIN/VERS/UNE/BASE/UTILISATEURS contient des lignes de la forme utilisateur:adresses où adresses est une liste d'adresses de courriel où envoyer les documents PDF demandés par utilisateur. Si un utilisateur vide est présent dans le fichier, le champ adresses associé sera la liste d'adresses par défaut qui sera utilisée pour les utilisateurs n'apparaissant pas ailleurs dans le fichier. Si plusieurs adresses sont spécifiées elles doivent être séparées par un espace. Si un programme ou un script est spécifié, il sera appelé avec le nom de l'utilisateur effectuant la requête comme unique argument, il doit alors renvoyer des données sur la sortie standard au même format que le fichier /CHEMIN/VERS/UNE/BASE/UTILISATEURS.

La valeur de cette primitive est la commande à utiliser pour la conversion PostScript vers PDF. La première occurence de %s dans cette chaîne sera remplacée par le chemin complet du fichier PostScript, la second par celui du fichier PDF. Si vous utilisez Ghostscript par exemple, la valeur pourrait être ps2pdf %s %s.

Cette primitive indique l'emplacement du fichier de journal qu'Alambic doit utiliser. Si aucun fichier journal n'est précisé, la journalisation sera faite à un serveur syslog si les primitives liées à syslog sont présentes ou sur la sortie d'erreur standard sinon. Ce fichier est ouvert puis fermé à chaque invocationd'Alambic, il peut par conséquent facilement être archiver par simple renommage à l'aide de la commande unix mv.

La valeur de cette primitive détermine le nom de la machine vers laquelle envoyer des messages syslog. Si cette primitive est absente, les messages seront écrits dans le fichier de journal spécifié ou sur la sortie d'erreur standard.

La valeur de cette primitive indique le port à utiliser pour le service syslog. Cette primitive peut être omise la plupart du temps, le port syslog par défaut (514) est alors utilisé.

Cette primitive positionne la catégorie à utiliser par Alambic pour ses messages syslog. La valeur est à choisir parmi auth, authpriv, cron, daemon, kern, lpr, mail, news, syslog, user, uucp, ftp et local0 à local7. Si aucune catégorie n'est spécifiée, la catégorie lpr sera utilisée.

La valeur de cette primitive est le nom ou l'adresse IP du server SMTP qu'Alambic utilisera pour l'envoi de courriels.

Cette primitive sélectionne le port à utiliser pour contacter le serveur SMTP. Si elle est absente, le port par défaut (25) sera utilisé.

Cette primitive définit la taille maximale en octets des fichiers PDF distribuables par courriel. Si un fichier PDF généré dépasse cette limite et que URLPrefix a été spécifié, le fichier PDF sera stocké sur le serveur Alambic et un lien permettant de le récupéré sera envoyé à l'utilisateur ayant fait la requête. Si la valeur de SMTPMax est 0, aucune limite ne sera appliquée et tous les fichiers PDF seront envoyés par courriel, même si URLPrefix a été spécifié. Si SMTPMax n'apparaît pas dans la configuration alors seule la récupération par HTTP sera possible. Si URLPrefix n'apparaît pas non plus, Alambic sera dans l'impossibilité de distribuer les fichiers PDF générés.

Cette primitive définit l'adresse de courriel qui apparaîtra dans l'en-tête From: de tous les courriels générés par Alambic. Cette adresse devrait être une adresse valide à laquelle les utilisateurs du service pourront envoyer des messages en cas de problème.

Cette primitive de type booléen détermine la conduite à tenir au cas où un fichier PostScript ne peut pas être converti en PDF. Si aucune valeur n'est spécifiée, ou si la valeur est false, le fichier PostScript est détruit. Si la valeur est true, le fichier PostScript est renommé d'après le nom de l'utilisateur et l'heure de la requête et laissé dans le répertoire WorkDir.