Variables d'environnement

27 min

Vue d'ensemble

La configuration d'un OAV est intégralement portée par des variables d'environnement. Aucune valeur de configuration n'est codée en dur : le même artefact est déployé sur tous les environnements, seule la configuration change.

Ces variables sont validées au démarrage. Une variable obligatoire manquante ou invalide provoque l'arrêt immédiat du serveur.

Cette page décrit les variables consommées par l'OAV et par l'outillage. Les variables des services annexes (notamment celles d'OIP Headless) sont décrites dans la section « Services annexes ».

Groupe	Objet
Variables générales	Environnement d'exécution, port d'écoute, journalisation.
Authentification client / serveur	Dialogue authentifié entre l'application React et le serveur Express.
Service OIP Headless	Accès au service de persistance.
Messagerie RabbitMQ	Accès au bus d'évènements.
Session et décrochage	Cookie, magasin de sessions, résolution du contexte client.
Shadow CRM	Prise en charge optionnelle du Shadow CRM.
OIP Tools	Exécution des commandes de l'outillage.

Tableau de synthèse

Variable	Groupe	Statut	Valeur par défaut
API_KEYS	Authentification	Obligatoire	—
AUTH_KEYCLOAK_URL	OIP Tools	Optionnelle	https://oip-keycloak.fasst.tech
CLIENT_ID	Authentification	Obligatoire	—
CLIENT_SECRET	Authentification	Obligatoire	—
JWT_SECRET	Authentification	Obligatoire	—
LOGGER_LEVEL	Générales	Optionnelle	ERROR
NODE_ENV	Générales	Obligatoire	—
OAV_ID	OIP Headless	Obligatoire	—
OIP_API_KEY	OIP Headless	Obligatoire	—
OIP_API_URL	OIP Headless	Obligatoire	—
OIP_TOOLS_CLIENT_ID	OIP Tools	Optionnelle	oip-tools
OIP_TOOLS_CLIENT_SECRET	OIP Tools	Obligatoire	—
PORT	Générales	Obligatoire	—
RABBIT_MQ_HOST	RabbitMQ	Obligatoire	—
RABBIT_MQ_PASSWORD	RabbitMQ	Obligatoire	—
RABBIT_MQ_USER	RabbitMQ	Obligatoire	—
RABBIT_MQ_VHOST	RabbitMQ	Obligatoire	—
ROOT_DIR	Générales	Optionnelle	.
SECURE_COOKIE	Session	Optionnelle	true
SECURE_SESSION	Session	Optionnelle	true
SECURE_WS	Générales	Optionnelle	true
SERVER_URL	Générales	Optionnelle	—
SESSION_COOKIE_MAX_AGE	Session	Optionnelle	60
SESSION_SECRET	Session	Obligatoire	—
SESSION_SERVICE_URL	Session	Obligatoire	—
SESSION_STORE_URL	Session	Obligatoire	—
SHADOW_CRM_TEAM_API_KEY	Shadow CRM	Optionnelle	—
SHADOW_CRM_URL	Shadow CRM	Optionnelle	—
URL_OIP_API	OIP Tools	Optionnelle	https://oip-api.fasst.tech/api
USER_ID	OIP Headless	Obligatoire	—

Variables générales

LOGGER_LEVEL

[optionnelle] Niveau de journalisation.

Ce niveau dépend de l'implémentation du logger dans votre projet. L'implémentation par défaut propose quatre niveaux : ERROR, WARNING, INFO et DEBUG.

La valeur par défaut est ERROR.

NODE_ENV

[obligatoire] Définit l'environnement d'exécution de l'application.

La valeur production configure l'environnement en mode production ; toute autre valeur le configure en mode développement.

PORT

[obligatoire] Numéro du port d'écoute du serveur.

ROOT_DIR

[optionnelle] Chemin relatif du répertoire racine.

Cette valeur détermine notamment l'emplacement des fichiers statiques (ROOT_DIR/public) et des vues.

La valeur par défaut est ..

SECURE_WS

[optionnelle] Valeur booléenne indiquant si le web socket doit être servi uniquement via HTTPS.

La valeur par défaut est true.

SERVER_URL

[optionnelle] URL du serveur OIP de l'OAV.

[info] Cette variable n'est nécessaire que dans le cas d'un projet multi-origines. Elle doit alors être accompagnée de la définition de __SERVER_URL__ dans le fichier vite.config.js.

Authentification client / serveur

API_KEYS

[obligatoire] Clé utilisée par votre OAV pour l'authentification entre l'application React et le serveur Express.

Le format de la clé est CLIENT_ID:CLIENT_SECRET, où CLIENT_ID et CLIENT_SECRET correspondent aux variables d'environnement utilisées lors de la génération de l'image Docker de votre OAV.

Exemple : fasst-oav-oip:00000000-0000-0000-0000-000000000000.

CLIENT_ID

[obligatoire] Identifiant de l'application client de votre OAV.

Exemple : fasst-oav-oip.

[info] Cette valeur doit également être exposée au client via la définition de __CLIENT_ID__ dans le fichier vite.config.js.

CLIENT_SECRET

[obligatoire] Clé relative à l'authentification de l'application client de votre OAV.

Exemple : 00000000-0000-0000-0000-000000000000.

[info] Cette valeur doit également être exposée au client via la définition de __CLIENT_SECRET__ dans le fichier vite.config.js.

JWT_SECRET

[obligatoire] Clé utilisée pour la signature et la vérification des JWTs.

Exemple : 33333333-3333-3333-3333333333.

Service OIP Headless

OAV_ID

[obligatoire] Identifiant public de votre application.

Cet identifiant préfixe également les files AMQP consommées et produites par l'OAV : <OAV_ID>.events et <OAV_ID>.entities.

OIP_API_KEY

[obligatoire] Clé API associée à votre application.

Cette valeur doit correspondre à la donnée enregistrée dans le champ key de la table applications_keys de la base de données gérée par OIP Headless.

OIP_API_URL

[obligatoire] URL du service OIP Headless.

USER_ID

[obligatoire] UUID de l'utilisateur connecté sur le parcours de vente.

Messagerie RabbitMQ

RABBIT_MQ_HOST

[obligatoire] Nom de l'hôte RabbitMQ.

RABBIT_MQ_PASSWORD

[obligatoire] Mot de passe de l'utilisateur RabbitMQ.

RABBIT_MQ_USER

[obligatoire] Nom de l'utilisateur RabbitMQ.

RABBIT_MQ_VHOST

[obligatoire] Nom de l'hôte virtuel RabbitMQ.

Session et décrochage

SECURE_COOKIE

[optionnelle] Valeur booléenne indiquant si le cookie de session doit être chiffré.

La valeur par défaut est true.

[warn] Si la valeur de SECURE_COOKIE est true, il est obligatoire d'utiliser le protocole HTTPS.

SECURE_SESSION

[optionnelle] Valeur booléenne indiquant si la session doit être validée auprès du service de sessions.

La valeur par défaut est true.

[warn] En production, la variable est ignorée : la validation de la session est toujours active.

Avec la valeur false, en développement, la séquence de décrochage ne résout pas le contexte client auprès du service de sessions : un contexte simulé peut alors être utilisé dans resolveProjectFromContext.

SESSION_COOKIE_MAX_AGE

[optionnelle] Durée de validité d'une session, exprimée en minutes.

La valeur par défaut est 60.

SESSION_SECRET

[obligatoire] Clé utilisée pour le chiffrement du cookie de session.

SESSION_SERVICE_URL

[obligatoire] URL du service responsable de la résolution du contexte client (Fasst Sessions ou équivalent).

SESSION_STORE_URL

[obligatoire] URL de la base de données PostgreSQL utilisée pour la sauvegarde des sessions de navigation.

[warn] Il est recommandé d'utiliser une base dédiée, distincte de celle utilisée par OIP Headless.

Shadow CRM

SHADOW_CRM_TEAM_API_KEY

[optionnelle] Clé API permettant l'authentification auprès du service Shadow CRM.

[info] Cette variable est requise dès lors que la prise en charge du Shadow CRM est activée.

SHADOW_CRM_URL

[optionnelle] URL du service Shadow CRM.

[info] Renseigner cette variable active la prise en charge du Shadow CRM lors du décrochage, pour la résolution du contexte client.

OIP Tools

Ces variables configurent l'exécution des commandes d'OIP Tools, et non le serveur de l'OAV.

AUTH_KEYCLOAK_URL

[optionnelle] URL de Keycloak utilisée pour l'authentification.

La valeur par défaut est https://oip-keycloak.fasst.tech.

OIP_TOOLS_CLIENT_ID

[optionnelle] Identifiant client utilisé pour l'authentification.

La valeur par défaut est oip-tools.

OIP_TOOLS_CLIENT_SECRET

[obligatoire] Clé d'authentification du client OIP Tools.

[warn] Cette variable est requise par toutes les commandes qui appellent l'API OIP ou Keycloak. Si elle est absente ou invalide, ces commandes échouent.

URL_OIP_API

[optionnelle] URL de l'API OIP utilisée par les commandes qui appellent l'API.

La valeur par défaut est https://oip-api.fasst.tech/api.

Résumé

La configuration d'un OAV est entièrement externalisée dans des variables d'environnement, validées au démarrage ;

API_KEYS doit toujours valoir CLIENT_ID:CLIENT_SECRET ;

SECURE_COOKIE, SECURE_SESSION et SECURE_WS valent true par défaut : leur assouplissement est réservé au développement local ;

trois valeurs doivent être répercutées dans vite.config.js pour être visibles du client : CLIENT_ID, CLIENT_SECRET et SERVER_URL.