Environment Variables
The .env file contains the necessary configurations for the proper functioning of the application. Here is an explanation of the variables used:
BASE SETTINGS
| Variable | Description | Default Value | Expected Values |
|---|
| POSTGRES_USER | Database username | - | string |
| POSTGRES_PASSWORD | Database password | - | string |
| POSTGRES_DB | Database name | - | string |
| POSTGRES_HOST | Database host | db | string |
| DATABASE_URL | Database URL | -(url de la base de donnée) | string |
| PORT | Main API port | 8500 | number |
| WORKERS | Number of main API threads, typically 1 thread per processor core | 8 | number |
| CORS_ALLOWED_DOMAINS | Allowed domains | "*" | string |
| SYS_ADMIN_EMAIL | Administrator email | - | string |
| ENCRYPTION_KEY | Main 256-bit encryption key. Do not modify | - | string |
| SECRET_KEY | Encryption secret key | - | string |
| TLS_CERT_PATH | Path to the TLS certificate | certs/cert.pem | string |
| TLS_KEY_PATH | Path to the TLS key | certs/key.pem | string |
| HSM_MODE | Enable HSM mode (0/1) | 0 | number |
REDIS CACHE
| Variable | Description | Default Value | Expected Values |
|---|
| REDIS_URL | URL for Redis | redis://redis:6379 | string |
| REDIS_PASSWORD | Redis password | - | string |
TOKENS SETTINGS
| Variable | Description | Default Value | Expected Values |
|---|
| JWT_TOKEN_DURATION | Specifies the validity duration of the Lagertha JWT token (in seconds) | 3600 | number |
| JWT_REFRESH_TOKEN_DURATION | Specifies the validity duration of the Lagertha JWT refresh token (in days) | 30 | number |
| OPENID_TOKEN_DURATION | Specifies the validity duration of the Lagertha OpenID connect token (in seconds) | 3600 | number |
| OAUTH_TOKEN_DURATION | Specifies the validity duration of the Lagertha OAuth token (in seconds) | 300 | number |
MOD (dev/prod)
| Variable | Description | Default Value | Expected Values |
|---|
| MODE | Indicates the API operating mode. In "prod" mode, authenticated requests must include anti-replay headers, and Swagger is disabled | dev | string |
SMTP
| Variable | Description | Default Value | Expected Values |
|---|
| SMTP_FROM | Email address used for transactional emails | - | string |
| SMTP_FROM_NAME | Sender name for transactional emails | - | string |
| SMTP_HOST | SMTP server URL for sending emails | - | string |
| SMTP_PORT | Port used by the SMTP server | - | number |
| SMTP_TLS | Enable TLS (true/false) | false | boolean |
| SMTP_CREDENTIALS_REQUIRED | Requires authentication (true/false) | true | boolean |
| SMTP_USERNAME | SMTP username | - | string |
| SMTP_PASSWORD | SMTP password | - | string |
OPEN_SEARCH SETTINGS
| Variable | Description | Default Value | Expected Values |
|---|
| OPEN_SEARCH_USER | OpenSearch username | admin | string |
| OPENSEARCH_INITIAL_ADMIN_PASSWORD | OpenSearch password | - | string |
| OPEN_SEARCH_PASSWORD | MOpenSearch password | - | string |
| OPEN_SEARCH_URL | URL for OpenSearch | https://log-node1:9200 | string |