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
| Variable | Obligatoire | Par défaut | Rôle |
|---|---|---|---|
NODE_ENV | Oui | production sur un serveur réel. | |
LOG_LEVEL | Non | warn | error, warn, info, http ou debug. info est recommandé. |
SERVER_PROTOCOL | Oui | https | https : le serveur gère son certificat ; http : derrière un proxy qui gère le HTTPS. |
SERVER_PORT | Non | 4999 | Port d'écoute. |
SERVER_TRUST_PROXY | Non | Derrière un proxy : nombre de proxys (ex : 1) ou leurs adresses IP. | |
TLS_KEY_FILE | En mode https | Clé privée du certificat, au format PEM. | |
TLS_CERT_FILE | En mode https | Certificat suivi des certificats intermédiaires, au format PEM. |
Les chemins de fichiers sont absolus, ou relatifs au dossier de l'application.
Licence et textes
| Variable | Obligatoire | Par défaut | Rôle |
|---|---|---|---|
LICENSE_FILE | Non | license.lic | Fichier de licence (voir Installer et renouveler la licence). |
LICENSE_USERS_FILE | Non | data/license-users.json | Registre des utilisateurs comptés, pour une licence limitée. Le serveur doit pouvoir écrire dans son dossier. |
TRANSLATIONS_OVERRIDE_DIR | Non | Dossier de vos propres textes (voir Personnaliser les textes du panneau). |
Connexion et cookies
| Variable | Obligatoire | Par défaut | Rôle |
|---|---|---|---|
OAUTH_CALLBACK_URI | Oui | Adresse publique du serveur suivie de /auth/callback, déclarée à l'identique dans le client OAuth2 du système cible. | |
OAUTH_COOKIE_CRYPTO_KEY | Oui | Clé de chiffrement des jetons : 32 octets encodés en base64. | |
OAUTH_COOKIE_SIGN_KEY | Oui | Clé de signature des cookies, différente de la précédente. La changer déconnecte tous les utilisateurs. | |
OAUTH_COOKIE_MAXAGE | Non | 7 jours | Durée de la session, en millisecondes. |
COOKIE_PREFIX | Non | Préfixe des noms de cookies, uniquement pour deux serveurs Save2ERP sur le même nom d'hôte (voir Cookies). | |
MAX_LOGGED_BODY_LENGTH | Non | 1000 | Taille maximale d'une réponse d'erreur du système cible recopiée dans les logs. |
Pour générer une clé :
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).
| Variable | Obligatoire | Par défaut | Rôle |
|---|---|---|---|
SAP_OAUTH_SCOPE | Oui, sauf si chaque système a le sien | Scope OAuth2 du service des pièces jointes. | |
SAP_ATTACHMENTS_PATH | Non | /attachments | Chemin du service d'envoi. |
SAP_CHECK_PATH | Non | /attachments/check | Chemin du service de vérification. |
SAP_HEALTHCHECK_PATH | Non | /attachments/healthcheck | Chemin du service de test. |
SAP_PERMISSIONS_PATH | Non | /attachments/permissions | Chemin du service des droits de l'utilisateur (mode concepteur). |
SAP_TEMPLATE_PATH | Non | /attachments/readTemplateXml | Chemin du service des modèles (mode concepteur). |
SAP_CALL_TIMEOUT_MS | Non | 60000 | Délai maximal d'attente d'une réponse, en millisecondes. |
SAP_ICON | Non | icône SAP | Icô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.
| Variable | Obligatoire | Rôle |
|---|---|---|
SAP_<système>_ENV | Oui | SBX, DEV, QUAL ou PROD : donne la couleur du panneau. |
SAP_<système>_SID | Oui | SID du système. |
SAP_<système>_MANDT | Oui | Mandant. |
SAP_<système>_APIBASE | Oui | Adresse de base des services REST, sans / final. |
SAP_<système>_OAUTH_SERVER | Oui | Adresse du serveur OAuth2 de SAP. |
SAP_<système>_OAUTH_CLIENT_ID | Oui | Identifiant du client OAuth2 déclaré dans SAP. |
SAP_<système>_OAUTH_CLIENT_SECRET | Oui | Secret de ce client. |
SAP_<système>_APIKEYNAME, SAP_<système>_APIKEY | Non | Nom de l'en-tête et valeur de la clé d'API exigée par une passerelle. |
SAP_<système>_COLOR | Non | Couleur des boutons au format "#RRGGBB" (entre guillemets), à la place de celle de l'environnement. |
SAP_<système>_ICON | Non | Icône du panneau pour ce système. |
SAP_<système>_OAUTH_SCOPE, _ATTACHMENTS_PATH, _CHECK_PATH, _HEALTHCHECK_PATH, _PERMISSIONS_PATH, _TEMPLATE_PATH, _CALL_TIMEOUT_MS | Non | Remplacent 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).