Référence des propriétés de configuration

Cette page recense l’ensemble des propriétés du fichier application.properties d’ESUP-Stage, y compris les propriétés optionnelles absentes du fichier d’exemple.

  • Le fichier est lu par Spring Boot : il peut être placé à la racine du projet, ou dans un répertoire externe renseigné via -Dspring.config.additional-location=/etc/estage/application.properties.

  • Une partie de ces propriétés peut être surchargée en base de données depuis l’écran d’administration « Configuration de l’application » (voir Configuration en base). Une valeur non vide saisie en base est prioritaire sur la valeur du fichier.

Authentification CAS

Propriété Obligatoire Description

cas.url.service

Oui

URL de base du serveur CAS, utilisée pour la validation des tickets (serviceValidate).

cas.url.login

Non (défaut : /login)

Chemin de connexion CAS. Peut contenir uniquement le path (/login) ou une URL complète (https://…​;).

cas.url.logout

Non (défaut : /logout)

Chemin de déconnexion CAS. Même logique que cas.url.login.

cas.response_type

Non

Mettre xml si votre serveur CAS renvoie la réponse de validation au format XML (JSON par défaut).

Base de données

Propriété Obligatoire Description

appli.datasource.url

Oui

URL JDBC de la base MariaDB (ex : jdbc:mariadb://monserveur:3306/estage).

appli.datasource.username

Oui

Utilisateur de la base de données.

appli.datasource.password

Oui

Mot de passe de la base de données.

appli.datasource.driver

Oui

Driver JDBC : org.mariadb.jdbc.Driver.

appli.datasource.context

Oui

Contexte Liquibase : baseline pour une base neuve, legacy pour une base reprise de pStage. Ne doit jamais être changé après le premier démarrage (voir la documentation d’installation).

appli.datasource.hikari.pool-name

Non

Nom du pool de connexions HikariCP (utile pour la supervision).

Application

Propriété Obligatoire Description

appli.url

Oui

URL publique de l’application, utilisée notamment dans les liens envoyés par mail.

appli.localapi

Non

URL utilisée par l’application pour s’appeler elle-même (remplace appli.url pour les appels internes, cas d’un reverse proxy).

appli.admin_technique

Oui

Logins des administrateurs techniques, séparés par des ;. Ces utilisateurs sont créés au premier lancement et ont accès aux écrans techniques (configuration, logs…​).

appli.data_dir

Oui

Répertoire de stockage des fichiers (logos, consignes, images, signatures, documents déposés). L’utilisateur du Tomcat doit avoir les droits en écriture.

appli.tokens

Non

Tokens d’accès à l’API publique /public/api, séparés par des ; (anciennement appli.public.tokens).

appli.jwt_secret

Oui

Secret de signature des JWT de session (HS256/HS512). Minimum recommandé : 32 caractères aléatoires (openssl rand -base64 64).

appli.nb_jours_valide_token

Oui

Durée de validité d’un token JWT, en jours (ex : 60).

appli.config_encryption_key

Non (fortement recommandé)

Clé de chiffrement (AES-GCM) des secrets saisis dans l’écran « Configuration de l’application ». Sans cette clé, aucun secret ne peut être enregistré en base (voir Configuration en base).

appli.footer.github
appli.footer.site
appli.footer.support
appli.footer.wiki

Non

URLs des liens du pied de page. Un lien non renseigné n’est pas affiché. Valeurs par défaut : celles d’ESUP-Portail.

Référentiel ESUP-SIscol

Ces quatre propriétés sont vérifiées au démarrage : si l’une manque, l’application affiche l’écran « Configuration requise » et reste bloquée tant qu’elles ne sont pas renseignées (fichier ou base de données).
Propriété Description

referentiel.ws.login

Identifiant d’accès aux web services ESUP-SIscol (section credential de la configuration SIscol).

referentiel.ws.password

Mot de passe associé.

referentiel.ws.ldap_url

URL du service LDAP exposé par ESUP-SIscol.

referentiel.ws.apogee_url

URL du service Apogée/Pégase exposé par ESUP-SIscol.

Envoi de mails (SMTP)

Voir le détail des trois modes (STARTTLS, SSL/TLS, sans chiffrement) dans Configuration SMTP.

Propriété Obligatoire Description

appli.mailer.protocol

Oui

smtp (STARTTLS ou sans chiffrement) ou smtps (SSL/TLS direct).

appli.mailer.host

Oui

Serveur SMTP.

appli.mailer.port

Oui

Port SMTP : 587 (STARTTLS), 465 (SSL/TLS), 25 ou 1025 (sans chiffrement, dev).

appli.mailer.auth

Oui

true si le serveur exige une authentification.

appli.mailer.username / appli.mailer.password

Si auth

Identifiants SMTP.

appli.mailer.from

Oui

Adresse d’expédition.

appli.mailer.ssl.enable

Non

true pour le mode SSL/TLS direct (port 465).

appli.mailer.starttls.enable / appli.mailer.starttls.required

Non

true pour le mode STARTTLS (port 587).

appli.mailer.disable_delivery

Non (défaut : false)

true pour désactiver totalement l’envoi de mails (développement).

appli.mailer.delivery_address

Non

Si renseignée, tous les mails sont redirigés vers cette adresse au lieu des destinataires réels (développement/recette).

Signature électronique (optionnel)

La signature électronique est activée si l’une des configurations ci-dessous est présente. Si plusieurs solutions sont configurées, Docaposte est prioritaire. Voir Signature électronique (optionnel).

Propriété Description

docaposte.uri

URL du parapheur Docaposte (SOAP).

docaposte.siren

SIREN de l’établissement.

docaposte.keystore.path / docaposte.keystore.password

Certificat client .p12 et son mot de passe.

docaposte.truststore.path / docaposte.truststore.password

Truststore .jks et son mot de passe.

webhook.signature.uri

URI de l’API externe de signature (solution maison ou intermédiaire vers ESUP-Signature).

webhook.signature.token

Token d’accès au webhook de signature.

esupsignature.uri

URL des web services ESUP-Signature.

esupsignature.circuit

Numéro du circuit de signature ESUP-Signature.

API Sirene (optionnel)

Voir la procédure de création du compte INSEE dans Activer l’API Sirene. Ne renseigner aucune de ces propriétés pour désactiver l’API Sirene.

Propriété Description

sirene.url

URL de l’API Sirene (ex : https://api.insee.fr/api-sirene/3.11).

sirene.token

Clé d’API INSEE.

sirene.nombre_minimum_resultats

Nombre minimum de résultats attendus (doit être > 0 pour que l’API soit considérée active).

Logs

Ces valeurs se pilotent par variables d’environnement (valeurs par défaut entre parenthèses). Voir Logs.

Variable d’environnement Description

ESUP_STAGE_LOG_DIR

Répertoire des fichiers de logs (logs en relatif par défaut ; avec Docker : ${DATA_PATH}/logs).

ESUP_STAGE_LOG_FILE

Chemin complet du fichier de log (${ESUP_STAGE_LOG_DIR}/esup-stage.log par défaut).

ESUP_STAGE_LOG_MAX_SIZE

Taille maximale d’un fichier avant rotation (50MB).

ESUP_STAGE_LOG_MAX_HISTORY

Nombre de jours d’historique conservés (30). La taille totale est plafonnée à 2 Go.

Dépôt de documents

Variable d’environnement Description

ESUP_STAGE_MAX_FILE_SIZE

Taille maximale d’un fichier envoyé (garde-fou Spring, 100MB par défaut). La limite fonctionnelle est réglée dans les paramètres généraux et doit rester inférieure ou égale à cette valeur.

ESUP_STAGE_MAX_REQUEST_SIZE

Taille maximale d’une requête multipart (100MB par défaut).