Platform Configuration Reference
Reference documentation for configuring the platform using environment variables, including required settings, database, authentication, and build
Overview
The platform's behavior and deployment settings are controlled through environment variables. These variables are typically defined in a .env file, which is loaded at startup. This approach allows for flexible configuration across different deployment environments. (source: deploy/docs/configuration-reference.md)
When to Use
- Initial Setup: Essential for the first deployment of the platform to define critical settings like database credentials and encryption keys.
- Deployment Customization: Adjusting default behaviors for database connections, authentication modes, port assignments, and internal service routing.
- Build Pipeline Integration: Configuring the build process for different cloud providers (AWS, Azure) and private image registries.
- Security Hardening: Enabling authentication for the admin UI and securing ingest endpoints.
When Not to Use
- Runtime Changes: Most variables are processed once at startup; changing them on a running system may require a restart to take effect. Bootstrap user variables, for instance, are only processed on first startup.
- Internal Configuration: Some variables are automatically set by the system (e.g.,
S2R_DB_DSN) and should not be manually overridden unless explicitly instructed for advanced scenarios.
How it Works
Platform configuration is managed by setting environment variables. The recommended practice is to copy the docker-compose.env.example file to .env and then edit the .env file with your specific settings before starting the platform services. (source: deploy/docs/configuration-reference.md)
Configuration variables are categorized as either Required or Optional:
- Required Variables: These variables have no safe default values and must be set before the platform can run successfully. Failure to set them will result in startup errors or insecure configurations.
- Optional Variables: These variables come with working default values suitable for standard deployments. They only need to be changed if your deployment requires non-standard settings (e.g., connecting to an external database, custom ports, or specific authentication methods).
(source: deploy/docs/configuration-reference.md)
Configuration Reference
This section details all available configuration variables, their types, default values (if optional), and descriptions.
Required Variables
These variables are critical for platform operation and must be set. (source: deploy/docs/configuration-reference.md)
| Name | Type | Default | Description |
|---|