---
title: Variables d'environnement
slug: oip-next/jHpS-environnement
icon: {"lucideIcon":"📘"}
createdAt: 2025-12-02T15:05:56.000Z
---

# 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](https://doc.fasst.tech/oip-next/v4/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](https://doc.fasst.tech/oip-next/5cQ6-environnement-dexecution) 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.

:::BlockQuote
**\[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`.

:::BlockQuote
**\[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`.

:::BlockQuote
**\[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`.

:::BlockQuote
**\[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`.

:::BlockQuote
**\[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.

:::BlockQuote
**\[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*.

:::BlockQuote
**\[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*.

:::BlockQuote
**\[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.

:::BlockQuote
**\[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`.
