Configuration

happyDomain respecte la méthodologie 12 factor et permet notamment d’agir sur la configuration de l’application de plusieurs manières.

Par quels moyens configurer happyDomain ?

Il est possible de configurer happyDomain de trois manières différentes : fichier de configuration, environnement, ligne de commande. Toutes les options sont disponibles pour chacun de ces mécanismes.

La précédence, lorsqu’une option est définie par plusieurs mécanismes simultanément, est qu’une option présente dans un fichier de configuration sera écrasé par l’environnement, qui sera écrasée par une option passée sur la ligne de commande.

Configuration par fichier

Au lancement de l’application, le premier fichier de configuration parmi la liste suivante sera utilisé :

• ./happydomain.conf
• $XDG_CONFIG_HOME/happydomain/happydomain.conf
• /etc/happydomain.conf

Seulement le premier fichier existant est pris en compte. Il n’est pas possible d’avoir une partie de ses options dans /etc/happydomain.conf et une autre dans ./happydomain.conf, seul ce dernier fichier de configuration sera pris en compte.

Il est possible de préciser un chemin personnalisé en l’ajoutant comme paramètre supplémentaire à la ligne de commande. Ainsi, pour utiliser le fichier de configuration situé à /etc/happydomain/config, on utilisera :

./happydomain /etc/happydomain/config

Format du fichier de configuration

Une ligne de commentaires commence par #, il n’est pas possible d’avoir des commentaires à la fin d’une ligne, en ajoutant # suivi d’un commentaire.

Placez sur chaque ligne le nom de l’option de configuration et la valeur attendue, séparés par =. Par exemple :

storage-engine=leveldb
leveldb-path=/var/lib/happydomain/db/

Configuration par l’environnement

Au lancement d’happyDomain, toutes les variables commençant par HAPPYDOMAIN_ sont analysées à la recherche d’options de configuration valides.

Vous pouvez réaliser la même chose que dans l’exemple précédent, avec les variables d’environnement suivantes :

HAPPYDOMAIN_STORAGE_ENGINE=leveldb
HAPPYDOMAIN_LEVELDB_PATH=/var/lib/happydomain/db/

Notez que les - sont remplacés par des _ dans les variables d’environnement.

Configuration par la ligne de commande

Enfin, la ligne de commande peut être utilisée pour passer des options, selon le format UNIX usuel.

Pour continuer l’exemple précédent, nous pouvons réaliser la même configuration avec la ligne de commande suivante :

./happydomain -storage-engine leveldb -leveldb-path /var/lib/happydomain/db/

ou encore en utilisant le signe = pour assigner clairement la valeur.

./happydomain -storage-engine=leveldb -leveldb-path=/var/lib/happydomain/db/

Éléments de configuration

La liste exhaustive des éléments configurables peut être listé en appelant happyDomain avec l’option -h ou --help.

Voici la liste des principales options :

Paramètres généraux

bind

Interface (ip, port) à utiliser pour exposer le service happyDomain.

admin-bind

Interface (ip, port ou socket) à utiliser pour exposer l’API d’administration.

default-ns

Adresse et port du serveur résolveur de noms à utiliser par défaut lorsqu’une résolution de nom est nécessaire.

dev

URL vers laquelle toutes les requêtes liées à l’interface graphique seront renvoyées.

externalurl

URL du service, tel qu’il doit apparaître dans les mails et contenus à destination du public.

Mise en page

custom-head-html

Chaîne de caractères à placer avant la fin de l’en-tête HTML.

custom-body-html

Chaîne de caractères à placer avant la fin du corps HTML.

Stockage des données

storage-engine

Permet de choisir le mécanisme de stockage des données parmi tous les mécanismes supportés.

LevelDB (storage-engine=leveldb)

leveldb-path

Chemin vers le dossier contenant la base LevelDB à utiliser.

Paramètres e-mail

Nous employons go-mail comme bibliothèque pour envoyer les mails.

mail-from

Définit le nom et l’adresse de l’expéditeur des mails envoyés par le service.

Notez que sans les options mail-smtp-*, happyDomain utilisera le binaire sendmail pour envoyer les mails. Cela peut être couplé aux paquets msmtp ou ssmtp par exemple, pour définir les paramètres pour tout le système.

mail-smtp-host

IP ou nom d’hôte du serveur SMTP à utiliser.

mail-smtp-port

Port à utiliser sur le serveur distant.

mail-smtp-username

Lorsque de l’authentification est nécessaire sur le serveur distant, nom d’utilisateur à utiliser.

mail-smtp-password

Lorsque de l’authentification est nécessaire sur le serveur distant, mot de passe à utiliser.

Authentification

no-auth

Désactive la notion d’utilisateurs et de contrôle d’accès. Un compte par défaut est utilisé.

external-auth

Base de l’URL du service d’authentification et d’enregistrement à utiliser à la place du système de connexion embarqué.

jwt-secret-key

Clef secrète utilisée pour vérifier les tokens JWT.

Spécifique aux bureaux d’enregistrement

Certain bureau d’enregistrement nécessitent que les applications tierces s’identifient en plus d’identifier l’utilisateur.

OVH

Veuillez vous référer à cette documentation afin de générer les identifiants: https://docs.ovh.com/gb/en/api/api-rights-delegation/#application-registration.

ovh-application-key

Application key pour l’API d’OVH

ovh-application-secret

Clef secrète pour l’API d’OVH