Aller au contenu

Variables du .env ​

Le fichier .env, à la racine de l'application, contient toute la configuration du serveur. Le modèle .env.example, livré avec l'application, contient chaque variable avec son commentaire : copiez-le sous le nom .env, puis complétez-le (voir Configurer le serveur).

Une valeur vide prend la valeur par défaut. Après chaque modification, redémarrez le serveur et vérifiez ses logs.

Serveur ​

VariableObligatoirePar défautRôle
NODE_ENVOuiproduction sur un serveur réel.
LOG_LEVELNonwarnerror, warn, info, http ou debug. info est recommandé.
SERVER_PROTOCOLOuihttpshttps : le serveur gère son certificat ; http : derrière un proxy qui gère le HTTPS.
SERVER_PORTNon4999Port d'écoute.
SERVER_TRUST_PROXYNonDerrière un proxy : nombre de proxys (ex : 1) ou leurs adresses IP.
TLS_KEY_FILEEn mode httpsClé privée du certificat, au format PEM.
TLS_CERT_FILEEn mode httpsCertificat suivi des certificats intermédiaires, au format PEM.

Les chemins de fichiers sont absolus, ou relatifs au dossier de l'application.

Licence et textes ​

VariableObligatoirePar défautRôle
LICENSE_FILENonlicense.licFichier de licence (voir Installer et renouveler la licence).
LICENSE_USERS_FILENondata/license-users.jsonRegistre des utilisateurs comptés, pour une licence limitée. Le serveur doit pouvoir écrire dans son dossier.
TRANSLATIONS_OVERRIDE_DIRNonDossier de vos propres textes (voir Personnaliser les textes du panneau).

Connexion et cookies ​

VariableObligatoirePar défautRôle
OAUTH_CALLBACK_URIOuiAdresse publique du serveur suivie de /auth/callback, déclarée à l'identique dans le client OAuth2 du système cible.
OAUTH_COOKIE_CRYPTO_KEYOuiClé de chiffrement des jetons : 32 octets encodés en base64.
OAUTH_COOKIE_SIGN_KEYOuiClé de signature des cookies, différente de la précédente. La changer déconnecte tous les utilisateurs.
OAUTH_COOKIE_MAXAGENon7 joursDurée de la session, en millisecondes.
COOKIE_PREFIXNonPréfixe des noms de cookies, uniquement pour deux serveurs Save2ERP sur le même nom d'hôte (voir Cookies).
MAX_LOGGED_BODY_LENGTHNon1000Taille maximale d'une réponse d'erreur du système cible recopiée dans les logs.

Pour générer une clé :

bash
node -e "console.log(require('crypto').randomBytes(32).toString('base64'))"

Systèmes SAP : valeurs communes ​

Ces valeurs s'appliquent à tous les systèmes SAP de l'installation. Chacune peut être remplacée pour un système par la variable SAP_<système>_… de même nom (voir ci-dessous).

VariableObligatoirePar défautRôle
SAP_OAUTH_SCOPEOui, sauf si chaque système a le sienScope OAuth2 du service des pièces jointes.
SAP_ATTACHMENTS_PATHNon/attachmentsChemin du service d'envoi.
SAP_CHECK_PATHNon/attachments/checkChemin du service de vérification.
SAP_HEALTHCHECK_PATHNon/attachments/healthcheckChemin du service de test.
SAP_PERMISSIONS_PATHNon/attachments/permissionsChemin du service des droits de l'utilisateur (mode concepteur).
SAP_TEMPLATE_PATHNon/attachments/readTemplateXmlChemin du service des modèles (mode concepteur).
SAP_CALL_TIMEOUT_MSNon60000Délai maximal d'attente d'une réponse, en millisecondes.
SAP_ICONNonicône SAPIcône du panneau : fichier .svg ou .png.

Systèmes SAP : un bloc par système ​

<système> est le système logique SAP, tel qu'il figure dans la propriété S2E_SystemKey des documents (ex : P01CLNT100). Un système n'est accessible que si toutes ses variables obligatoires sont renseignées.

VariableObligatoireRôle
SAP_<système>_ENVOuiSBX, DEV, QUAL ou PROD : donne la couleur du panneau.
SAP_<système>_SIDOuiSID du système.
SAP_<système>_MANDTOuiMandant.
SAP_<système>_APIBASEOuiAdresse de base des services REST, sans / final.
SAP_<système>_OAUTH_SERVEROuiAdresse du serveur OAuth2 de SAP.
SAP_<système>_OAUTH_CLIENT_IDOuiIdentifiant du client OAuth2 déclaré dans SAP.
SAP_<système>_OAUTH_CLIENT_SECRETOuiSecret de ce client.
SAP_<système>_APIKEYNAME, SAP_<système>_APIKEYNonNom de l'en-tête et valeur de la clé d'API exigée par une passerelle.
SAP_<système>_COLORNonCouleur des boutons au format "#RRGGBB" (entre guillemets), à la place de celle de l'environnement.
SAP_<système>_ICONNonIcône du panneau pour ce système.
SAP_<système>_OAUTH_SCOPE, _ATTACHMENTS_PATH, _CHECK_PATH, _HEALTHCHECK_PATH, _PERMISSIONS_PATH, _TEMPLATE_PATH, _CALL_TIMEOUT_MSNonRemplacent la valeur commune pour ce système.

Valeurs invalides

Un chemin invalide, un délai qui n'est pas un nombre entier positif, ou une icône absente rendent le système inutilisable : les documents de ce système affichent l'erreur « Système mal configuré » et la cause est indiquée dans les logs au démarrage.

Ne jamais désactiver la vérification des certificats

Ne définissez jamais NODE_TLS_REJECT_UNAUTHORIZED=0. Si le système cible utilise un certificat d'une autorité interne, indiquez le chemin du certificat de cette autorité (format PEM) dans la variable d'environnement NODE_EXTRA_CA_CERTS du serveur (voir Prérequis).