| Sommaire |
|---|
...
Récupération des sources
Une fois les prérequis installés et PostgreSQL configuré, vous pouvez récupérer les sources du projet.
...
Pour toutes les informations relatives à l'exploitation et la mise à jour du code, consultez la page dédiée : Exploitation coté serveur.
...
Validation et commit de la configuration
Lorsque votre configuration du fichier application.yml sera terminée, créez un commit git afin d'éviter tout problème lors d'une prochaine mise à jour.
| Bloc de code | ||
|---|---|---|
| ||
git add . git commit -m "Configuration de production" |
...
Structure du fichier application.yml
La configuration principale d'esup-signature se fait au travers du fichier application.yml.
Fichier de base fourni
Le dépôt est livré avec un fichier de configuration de base : src/main/resources/application.yml. Ce fichier contient les paramètres les plus courants avec des valeurs par défaut ou commentées.
Important : Ce fichier ne contient pas toutes les options disponibles. Pour voir la liste complète des paramètres possibles, consultez le code source : https://github.com/EsupPortail/esup-signature/blob/master/src/main/java/org/esupportail/esupsignature/config/GlobalProperties.java
Localisation du fichier
Le fichier de configuration peut être situé à deux endroits :
- Chemin standard :
src/main/resources/application.yml(utilisé lors de la compilation avec Maven) - Chemin alternatif : Vous pouvez placer le fichier ailleurs sur le système de fichiers en précisant son emplacement lors de la compilation avec l'option
-Dspring.config.location=/<DOSSIER>/application.yml
Règles d'édition
Lors de la modification du fichier application.yml, respectez ces règles importantes :
Format YAML
Le fichier utilise le format YAML (YAML Ain't Markup Language). Ce format est sensible à l'indentation.
Indentation
CRITIQUE : Une mauvaise indentation peut faire échouer la compilation.
- Utilisez des espaces, pas des tabulations
- Chaque niveau d'imbrication ajoute 2 espaces (ou 4, mais soyez cohérent)
Autres règles
- Commentaires : Ajoutez un
#au début de la ligne pour commenter - Encodage : Le fichier doit impérativement être encodé en UTF-8, sinon la compilation peut échouer (erreur type :
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-resources-plugin:3.2.0:resources (default-resources) on project esup-signature: Input length = 1)
Organisation générale
Le fichier application.yml est organisé en sections principales correspondant aux différents aspects de l'application :
...