Variables d'environement

Le fichier .env contient les configurations nécessaires au bon fonctionnement de l'application. Voici une explication des variables utilisées :

BASE SETTINGS

Variable	Description	Valeur par défaut	Valeurs attendues
POSTGRES_USER	Username de la base de donnée	-	string
POSTGRES_PASSWORD	Mot de passe de la base de donnée	-	string
POSTGRES_DB	Nom de la base de donnée	-	string
POSTGRES_HOST	Host de la base de donnée	db	string
DATABASE_URL	Url de la base de donnée	-(url de la base de donnée)	string
PORT	Port de l'api principale	8500	number
WORKERS	Nombre de threads de l'api principale, en principe 1 thread par coeur de processeur	8	number
CORS_ALLOWED_DOMAINS	Domaine authorisés	"*"	string
SYS_ADMIN_EMAIL	Email de l'administrateur	-	string
ENCRYPTION_KEY	Clé 256bits d'encryption principale. Ne pas modifier	-	string
SECRET_KEY	secret key d'encryption	-	string
TLS_CERT_PATH	chemin vers le certificat TLS	certs/cert.pem	string
TLS_KEY_PATH	chemin vers la clé TLS	certs/key.pem	string
HSM_MODE	Active le mode HSM (0/1)	0	number

REDIS CACHE

Variable	Description	Valeur par défaut	Valeurs attendues
REDIS_URL	Url pour Redis	redis://redis:6379	string
REDIS_PASSWORD	Mot de passe pour Redis	-	string

TOKENS SETTINGS

Variable	Description	Valeur par défaut	Valeurs attendues
JWT_TOKEN_DURATION	Indique la durée de validité du token jwt lagertha (en secondes)	3600	number
JWT_REFRESH_TOKEN_DURATION	Indique la durée de validité du token jwt de rafraichissement lagertha (en jours)	30	number
OPENID_TOKEN_DURATION	Indique la durée de validité du token OpenID connect lagertha (en secondes)	3600	number
OAUTH_TOKEN_DURATION	Indique la durée de validité du token Oauth lagertha (en secondes)	300	number

MOD (dev/prod)

Variable	Description	Valeur par défaut	Valeurs attendues
MODE	indique le mode d'exploitation de l'api. En mode "prod", les requêtes authentifiés doivent comptenir les headers anti rejeu (dev/prod) et le swagger est desactivé	dev	string

SMTP

Variable	Description	Valeur par défaut	Valeurs attendues
SMTP_FROM	Adresse email utilisé pour les envois de emails transactionnels	-	string
SMTP_FROM_NAME	Nom d'expediteur des emails transactionnels	-	string
SMTP_HOST	url du serveur SMTP d'envois	-	string
SMTP_PORT	Port utilisé par le serveur SMTP	-	number
SMTP_TLS	Activation du TLS (true/false)	false	boolean
SMTP_CREDENTIALS_REQUIRED	Nécessité d'authentification (true/false)	true	boolean
SMTP_USERNAME	Utilisateur SMTP	-	string
SMTP_PASSWORD	Mot de passe SMTP	-	string

OPEN_SEARCH SETTINGS

Variable	Description	Valeur par défaut	Valeurs attendues
OPEN_SEARCH_USER	Nom d'utilisateur opensearch	admin	string
OPENSEARCH_INITIAL_ADMIN_PASSWORD	Mot de passe opensearch	-	string
OPEN_SEARCH_PASSWORD	Mot de passe opensearch	-	string
OPEN_SEARCH_URL	Url pour opensearch	https://log-node1:9200	string