Skip to content

System Configuration Reference

Designed with cloud-native architectural philosophies, all microservices in CXMind (covering the underlying Ingestion Engine, backend logic processing, and administration interfaces) are isolated and managed through environment configuration parameters (.env).

1. Configuration Injection Method

In a standard Docker Compose-based deployment, all relevant environment variables are centrally maintained in the .env file located in the project root directory.

When deploying for the first time, you can directly copy the sample configuration file bundled with the project:

bash
cp .env.example .env

Afterward, please use your preferred text editor to modify the critical parameters within.

2. Core Module Configuration Description

2.1 Basic Engine Connection Parameters (IE)

Variable NameDefault ValueGlobal Description
REDIS_ADDRredis:6379Address for real-time alerts, monitoring streams, and distributed memory queue service
DB_DSN...Backend persistent database connection string, used to store Call Detail Records (CDR)
LISTEN_HEP0.0.0.0:9060IP and port where the Ingestion Engine listens for HEP encapsulated data streams from Homer/PBX

2.2 JWT and Authentication Configuration (AS & AU)

To ensure communication security, the API behind the admin console requires token validation:

  • JWT_SECRET: (Required) Used for signing and verifying all authorization tokens. In production deployments, be sure to change this value to a strong, randomly generated string.
  • ADMIN_EMAIL: The default network management email account during initial deployment.
  • ADMIN_PASSWORD_HASH: The secret hash for the default account during initial deployment.

2.3 Cross-Origin Resource Sharing Control (CORS)

In an architecture where the frontend and backend are separated, cross-origin policies are restricted via configuration to prevent security attacks:

  • ALLOWED_ORIGINS: A whitelist of domain names allowed to access the admin console backend API. For example: http://localhost:5173,https://admin.yourdomain.com.

3. Special Configuration Options for Pro Advanced Features

When you import a valid commercial license LICENSE_KEY, the following configurations will be activated and take effect:

  • AI_PROVIDER: Integration choice for voice emotion and intent analysis providers (e.g., OpenAI, Azure).
  • AUDIO_STORAGE_PATH: The mount path for the physical media storing RTP audio recording files.
  • MAX_CONCURRENT_CALLS: A soft limit on the maximum number of RTP parsings per node read from the License.

For a full list of detailed and hidden development debugging parameters in this release, please consult the declaration section in the docker-compose.yml located in the root directory of the source code repository.

Released under the BSL License.