---
title: Environnement
slug: oip-next/hftf-environnement
icon: {"lucideIcon":"📘"}
createdAt: 2025-10-17T09:41:59.000Z
---

# 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]&#x20;**&#x44;éfinit l’environnement d’exécution de l’application.&#x20;

[cf. Environnement d'exécution](https://doc.fasst.tech/oip/environnement#LHMsT)\*\*

### ROOT\_DIR

**\[optionnelle]** Chemin relatif du répertoire racine.

La valeur par défaut est `.`

### PORT

**\[obligatoire]&#x20;**&#x4E;umé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]&#x20;**&#x44;ans le cas d'un projet multi-origines, cette variable est requise pour préciser l'URL du server OIP de l'OAV.&#x20;

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.&#x20;

Exemple :

:::CodeblockTabs
vite.config.js

```javascript
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]&#x20;**&#x49;dentifiant 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.&#x20;

Exemple :

:::CodeblockTabs
vite.config.js

```javascript
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.&#x20;

Exemple :

:::CodeblockTabs
vite.config.js

```javascript
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

:::BlockQuote
**\[info]&#x20;**&#x4C;a validation de la session aurpès du service relatif sera toujours activée en production.
:::

**\[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

:::BlockQuote
**\[warn]&#x20;**&#x53;i la valeur de `SECURE_COOKIE` est `true`, il est obligatoire d'utiliser le protocole HTTPS.
:::

**\[optionnelle]** Valeur booléenne indiquant si le cookie de session doit être chiffré.&#x20;

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 (servic&#x65;*&#x20;fasst-sessions&#x20;*&#x6F;u équivalent).

### SESSION\_STORE\_URL

:::BlockQuote
**\[warn]** Assurez-vous que la database existe, créez-la si nécessaire. Il est préférable d'utiliser une database différente de celle utilisée pour la sauvegarde des données de l'OAV.
:::

**\[obligatoire]&#x20;**&#x55;RL 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

:::BlockQuote
**\[info]** Renseigner cette variable active la prise en charge du *Shadow CRM* lors du décrochage sur l'OAV pour la résolution du contexte client.
:::

**\[optionnelle]** URL du service *Shadow CRM*.

### SHADOW\_CRM\_TEAM\_API\_KEY

:::BlockQuote
**\[info]** Cette variable est requise pour la prise en charge du *Shadow CRM*.
:::

**\[optionnelle]&#x20;**&#x43;lé API permettant l'authentification auprès du service *Shadow CRM*.
