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.