Variables d'environnement
Variables d’environnement
OIP Tools peut utiliser plusieurs variables d’environnement afin de configurer son exécution.
Ces variables permettent notamment de définir le dossier racine utilisé par les commandes, l’URL de l’API OIP ou encore les informations nécessaires à l’authentification auprès de Keycloak.
Liste des variables disponibles
Variable | Description | Valeur par défaut |
|---|---|---|
ROOT_DIR | Dossier racine utilisé par les commandes OIP Tools. | Dossier courant |
URL_OIP_API | URL de l’API OIP utilisée par les commandes qui appellent l’API. | https://oip-api.fasst.tech/api |
AUTH_KEYCLOAK_URL | URL de Keycloak utilisée pour l’authentification. | https://oip-keycloak.fasst.tech |
OIP_TOOLS_CLIENT_ID | Client ID utilisé pour l’authentification. | oip-tools |
OIP_TOOLS_CLIENT_SECRET | Secret client utilisé pour les appels API. | Requis |
Variable ROOT_DIR
La variable ROOT_DIR permet de définir le dossier racine utilisé par les commandes OIP Tools.
Si cette variable n’est pas renseignée, le dossier courant est utilisé par défaut.
Variables liées à l’API OIP
La variable URL_OIP_API permet de définir l’URL de l’API OIP utilisée par les commandes nécessitant un accès distant.
Par défaut, l’URL utilisée est :
Variables liées à Keycloak
Les variables AUTH_KEYCLOAK_URL, OIP_TOOLS_CLIENT_ID et OIP_TOOLS_CLIENT_SECRET permettent de configurer l’authentification auprès de Keycloak.
La variable OIP_TOOLS_CLIENT_SECRET est obligatoire pour les commandes qui appellent l’OIP API ou Keycloak.
Point d’attention
Si la variable OIP_TOOLS_CLIENT_SECRET est absente ou invalide, certaines commandes peuvent échouer lors des appels à l’API OIP ou à Keycloak.
Dans ce cas, vérifiez que la variable est bien définie dans votre environnement avant de relancer la commande.