Environment Variables

Breign API

VARIABLE	Description	Valeur par défaut
LOGGER__LEVEL	Niveau de logging (info, debug, verbose)	info
PORT	Port découte du serveur http	8080
SERVER__HOST	Endpoint complet de l'API (utilisée dans les callbacks)	http://localhost:8080
SERVER__HOSTNAME	Hostname (domaine) du serveur de l'API	localhost
SERVICES__WEAVIATE__SCHEME	Protocole de connexion à Weaviate (https ou http)	https
SERVICES__WEAVIATE__HOST	Endpoint de weaviate (accédé par les server components)	https://weaviate.breign.eu
SERVICES__WEAVIATE__AUTHENTICATION	Méthode d'authentification à weaviate, API_KEY ou NONE	API_KEY
SERVICES__WEAVIATE__API_KEY	API key de connexion à Weaviate	878484-42E2
SERVICES__WEAVIATE__OLLAMA__HOST	Endpoint ollama pour le vectorizer (si applicable)	https://ollama.breign.eu
SERVICES__WEAVIATE__VECTORIZER	Le module activé dans weaviate	text2vec-ollama
SERVICES__WEAVIATE__VECTORIZER_API_KEY	Clé API pour Ollama	ollama-test-key-ignored
SERVICES__WEAVIATE__OLLAMA__VECTORIZER_MODEL	Modèle à utiliser pour les embeddings des connaissances (si applicable, doit être pull sur l'instance ollama)	nomic-embed-text
SERVICES__WEAVIATE__OLLAMA__VECTORIZER_DIMENSIONS	Dimension du model	256
SERVICES__MONGODB__URI	URI de connexion à la base de donnée Breign	mongodb://user:password@localhost:27017/breign
SERVICES__MONGODB__DBNAME	Nom de la base de donnée breign	breign
SERVICES__MAILS__PROVIDER	Type de provider pour les emails	CONSOLE
SERVICES__FILES__PROVIDER	Provider de stockage (SDK utilisé)	minio
SERVICES__FILES__BUCKET_NAME	Nom du bucket pour le stockage	breign-files
SERVICES__FILES__PUBLIC_BUCKET_NAME	Nom du bucket pour le stockage d'assets public (non utilisé)	breign-public
SERVICES__FILES__ENDPOINT	Endpoint du service de stockage S3	http://localhost:9000
SERVICES__FILES__PORT	Port du service de stockage S3	9000
SERVICES__FILES__USE_SSL	Utilisation SSL pour le stockage S3	false
SERVICES__FILES__REGION	Région stockage S3 (si applicable)	eu-west-1
SERVICES__FILES__ACCESS_KEY_ID	ID de clé d'accès su stockage S3 (si applicable)	''
SERVICES__FILES__SECRET_ACCESS_KEY	Clé secrète d'accès au stockage S3 (si applicable)	''
SERVICES__SCRAPPING__ENDPOINT	Endpoint du service de scrapping (réseau interne)	http://localhost:9001
SERVICES__SCRAPPING__API_KEY	Clé d'API d'accès au service de scrapping	''
SERVICES__DOCUMENTS_SERVICE__ENDPOINT	Endpoint du service de documents (réseau interne)	http://localhost:9002
SERVICES__DOCUMENTS_SERVICE__API_KEY	Clé d'API d'accès au service de documents	''
AUTHENTICATION__API_KEY	Clé d'API système admin de Breign API	''
AUTHENTICATION__JWT__ISSUER	domaine de l'api pour la génération de JWT (indiquer une valeur vide pour désactiver la génération de JWT)	""
AUTHENTICATION__JWT__PRIVATE_KEY	Clé privée de génération de JWT (laisser vide)	""
AUTHENTICATION__JWT__PUBLIC_KEY	Clé public de vérification des JWT (laisser vide)	""
AUTHENTICATION__TRUSTED_ORIGINS	Liste JSON stringified des URL autorisées pour l'authentification	"[]"
AUTHENTICATION__AUTH_SECRET	Variable aléatoire pour le chiffrement des clés JWKs dans la db	openssl rand -base64 32

Configuration Proxy

Si votre infrastructure utilise un proxy, Node.js doit être configuré pour en tenir compte. Pour cela, définissez la variable d’environnement suivante :

Variable	Description	Requis	Valeur
NODE_USE_ENV_PROXY	Indique à Node.js d’utiliser les variables d’environnement HTTP_PROXY, HTTPS_PROXY et NO_PROXY pour configurer le proxy global.	Non	1

Lorsque Node.js crée l’agent global, si NODE_USE_ENV_PROXY est défini à 1 ou true, le proxy configuré dans les variables d’environnement sera automatiquement pris en compte pour toutes les requêtes HTTP/HTTPS. Les variables d’environnement pour configurer le proxy sont les suivantes : | Variable | Description | Exemple | | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | | HTTP_PROXY ou http_proxy | URL du serveur proxy pour les requêtes HTTP. Si les deux sont définis, http_proxy prend le dessus. | http://proxy.example.com:3128 | | HTTPS_PROXY ou https_proxy | URL du serveur proxy pour les requêtes HTTPS. Si les deux sont définis, https_proxy prend le dessus. | http://proxy.example.com:3128 | | NO_PROXY ou no_proxy | Liste des hôtes à bypasser pour le proxy, séparés par des virgules. Si les deux sont définis, no_proxy prend le dessus. | localhost,127.0.0.1,.breign.lu | Cette configuration permet à Breign API de communiquer correctement avec les services internes et externes tout en passant par le proxy défini.

Breign APP

VARIABLE	Description	Exemple
BETTER_AUTH_SECRET	Random secret pour l'authentification (openssl rand -base64 32)	x3Bk98hnKQaatJ9lThLDqlxpBnsVOAmuCF6J0VGCZ2U=
BETTER_AUTH_URL	URL de l'application déployée	https://app.breign.eu
NEXT_PUBLIC_SSO_PROVIDER_ID	ID du provider sso ajouté dans la collection ssoProvider	keycloak-breign
BRAIN_API_ENDPOINT	URL de l'API Breign (appelée par les server components)	https://api.breign.eu
NEXT_PUBLIC_BRAIN_API_ENDPOINT	URL de l'API Breign (appelée par les server components et le user agent/navigateur)	https://api.breign.eu
NEXT_PUBLIC_BRAIN_WS_ENDPOINT	Endpoint pour les connexion websocket	wss://api.breugn.eu
BRAIN_API_KEY	API Key (system admin, valeur de breign-api.AUTHENTICATION__API_KEY) pour l'API Breign	breign-....
MONGODB_URI	URI de connexion à la base de donnée Breign	mongodb://user:password@localhost:27017/breign
MONGODB_DBNAME	Nom de la base de donnée breign	breign
WEAVIATE_SCHEME	Protocole de connexion à Weaviate (https ou http)	https
WEAVIATE_HOST	Endpoint de weaviate (accédé par les server components)	https://weaviate.breign.eu
WEAVIATE_AUTH	Méthode d'authentification à weaviate, API_KEY ou NONE	API_KEY
WEAVIATE_API_KEY	API key de connexion à Weaviate	878484-42E2
RESEND_API_KEY	Clé d'API pour le service d'envoi de mail, cf https://resend.com, ou CONSOLE	CONSOLE

Breign Document API

Variable	Description	Requis	Valeur
API_KEY	Clé API utilisée pour sécuriser l’accès au service Breign Document.	Oui	breign-document-api-key
API_KEY_NAME	Nom du header HTTP utilisé pour transmettre la clé API.	Oui	x-api-Key
MODE	Mode d’exécution de l’application (prod, dev).	Oui	prod
ENABLE_TABLE_EXTRACTION	Active l’extraction de tableaux lors de l’analyse des documents.	Oui	false
OCR_UTILISATION	Active l’OCR pour les documents scannés (yes / no).	Oui	no
SIMILARITY_THRESHOLD	Seuil de similarité utilisé pour la déduplication ou la comparaison de documents.	Oui	0.98
EXPIRATION_PRESIGNED_URL	Durée de validité (en secondes) des URLs pré-signées pour l’accès aux fichiers.	Oui	86400
MINIO_ENDPOINT	Endpoint du service de stockage MinIO.	Oui	files.company.eu
MINIO_PORT	Port du service MinIO.	Oui	443
MINIO_PROTOCOL	Protocole utilisé pour MinIO (http ou https).	Oui	https
MINIO_BUCKET_NAME	Nom du bucket MinIO utilisé pour stocker les documents.	Oui	breign-files
MINIO_ACCESS_KEY	Clé d’accès au service MinIO.	Oui	breign-minio-user
MINIO_SECRET_KEY	Clé secrète d’accès au service MinIO.	Oui	minio-secret-key
MONGODB_URI	URI de connexion à la base de données MongoDB.	Oui	mongodb://user:password@localhost:27017/breign-files
MONGO_DB_NAME	Nom de la base de données MongoDB utilisée.	Oui	breign
MONGO_COLLECTION_NAME	Nom de la collection MongoDB principale pour les documents.	Oui	document-api-base
MONGO_COLLECTION_NAME_PARSING	Nom de la collection MongoDB utilisée pour le parsing des documents.	Oui	document-api-parsing
OPENAI_API_KEY	Clé API OpenAI utilisée pour l’analyse et le parsing des documents.	Non	openai-api-key