Environnement
Environnement d'exécution
L'environnement d'exécution a deux configurations possibles : production ou développement. Il est déterminé par la variable d'environnement NODE_ENV. Si cette dernière est égale à production alors l'environnement d'exécution est configuré en mode production sinon en mode développement.
Variables d'environnement
Variables générales
NODE_ENV
[obligatoire] Définit l’environnement d’exécution de l’application.
ROOT_DIR
[optionnelle] Chemin relatif du répertoire racine.
La valeur par défaut est .
PORT
[obligatoire] Numéro du port d'écoute du server.
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] Dans le cas d'un projet multi-origines, cette variable est requise pour préciser l'URL du server OIP de l'OAV.
Si c'est le cas, veuillez également vous assurer de définir la variable relative __SERVER_URL__ dans le fichier de configuration vite.config.js à la racine de votre OAV.
Exemple :
import { defineConfig, loadEnv } from 'vite';
export default defineConfig(({ mode }) => {
const env = loadEnv(mode, process.cwd(), '');
return {
// ...
define: {
__SERVER_URL__: JSON.stringify(env.SERVER_URL),
},
};
});Variable relatives à l'authentification client / server
CLIENT_ID
[obligatoire] Identifiant de l'application client de votre OAV.
Exemple : fasst-oav-oip
Assurez vous de définir la variable relative __CLIENT_ID__ dans le fichier de configuration vite.config.js à la racine de votre OAV.
Exemple :
import { defineConfig, loadEnv } from 'vite';
export default defineConfig(({ mode }) => {
const env = loadEnv(mode, process.cwd(), '');
return {
// ...
define: {
__CLIENT_ID__: JSON.stringify(env.CLIENT_ID),
},
};
});CLIENT_SECRET
[obligatoire] Clé relative à l'authentification de l'application client de votre OAV.
Exemple : 00000000-0000-0000-0000-000000000000
Assurez vous de définir la variable relative __CLIENT_SECRET__ dans le fichier de configuration vite.config.js à la racine de votre OAV.
Exemple :
import { defineConfig, loadEnv } from 'vite';
export default defineConfig(({ mode }) => {
const env = loadEnv(mode, process.cwd(), '');
return {
// ...
define: {
__CLIENT_SECRET__: JSON.stringify(env.CLIENT_SECRET),
},
};
});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
JWT_SECRET
[obligatoire] Clé utilisée pour la signature et la vérification des JWTs.
Exemple : 33333333-3333-3333-3333333333
Variables relatives au service OIP Headless
OAV_ID
[obligatoire] Identifiant public de votre application.
OIP_API_KEY
[obligatoire] Clé API associée à votre application.
OIP_API_URL
[obligatoire] URL du service OIP Headless.
USER_ID
Coming soon..
Variables relatives à la configuration de la session
SECURE_SESSION
[optionnelle] Valeur booléenne indiquant si la session doit être validée auprès du service fasst-sessions ou équivalent.
La valeur par défaut est true
SECURE_COOKIE
[optionnelle] Valeur booléenne indiquant si le cookie de session doit être chiffré.
La valeur par défaut est true
SESSION_COOKIE_MAX_AGE
[optionnelle] Durée de la validité d'une session (valeur 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 (service fasst-sessions ou équivalent).
SESSION_STORE_URL
[obligatoire] URL de la database PostgreSQL utilisée pour la sauvegarde des sessions de navigation.
Variables relatives à la prise en charge du Shadow CRM
SHADOW_CRM_URL
[optionnelle] URL du service Shadow CRM.
SHADOW_CRM_TEAM_API_KEY
[optionnelle] Clé API permettant l'authentification auprès du service Shadow CRM.