Aller au contenu principal
Version: 2.1.x

Environment Variables

All environment variables are defined in the .env file at the root of the project.

Application

VariableDefaultDescription
APP_ENVdevApplication environment. Use prod for production deployments.
DEFAULT_URIhttp://localhostBase URL of your Auditix instance. Used for generating links.
HTTP_PORT80The port Nginx listens on.

Database (PostgreSQL)

VariableDefaultDescription
POSTGRES_DBauditixDatabase name.
POSTGRES_USERauditixDatabase user.
POSTGRES_PASSWORDauditixDatabase password. Change in production.

Message Queue (RabbitMQ)

VariableDefaultDescription
RABBITMQ_USERauditixRabbitMQ user.
RABBITMQ_PASSWORDauditixRabbitMQ password. Change in production.

Real-time (Mercure)

VariableDefaultDescription
MERCURE_JWT_SECRET!ChangeThisMercureHubJWTSecretKey!JWT secret for Mercure hub authentication. Change in production.

Worker Replicas

Scale workers based on your infrastructure size and needs:

VariableDefaultDescription
WORKER_SCHEDULER_REPLICAS1Monitoring scheduler instances.
WORKER_MONITORING_REPLICAS3SNMP/ICMP monitoring workers.
WORKER_COLLECTOR_REPLICAS2Data collection workers.
WORKER_COMPLIANCE_REPLICAS2Compliance evaluation workers.
WORKER_GENERATOR_REPLICAS1Report generation workers.

Scaling Guidelines

  • Small (< 50 nodes): Default values are sufficient.
  • Medium (50-200 nodes): Increase collector to 4, monitoring to 3.
  • Large (200+ nodes): Increase collector to 6-8, monitoring to 5, compliance to 4.

Example Production Configuration

.env
APP_ENV=prod
DEFAULT_URI=https://auditix.example.com
HTTP_PORT=443

POSTGRES_DB=auditix
POSTGRES_USER=auditix
POSTGRES_PASSWORD=s3cur3-p4ssw0rd-h3r3

RABBITMQ_USER=auditix
RABBITMQ_PASSWORD=4n0th3r-s3cur3-p4ss

MERCURE_JWT_SECRET=y0ur-m3rcur3-jwt-s3cr3t

WORKER_SCHEDULER_REPLICAS=1
WORKER_MONITORING_REPLICAS=3
WORKER_COLLECTOR_REPLICAS=4
WORKER_COMPLIANCE_REPLICAS=2
WORKER_GENERATOR_REPLICAS=1