Environment Variables
Complete reference of all configuration options for Radar deployment
Complete reference of all configuration options for Radar deployment.
Required Credentials
These credentials are required for Radar to authenticate with the SuperAlign API.
| Variable | Description | Required | Example |
|---|---|---|---|
ACCOUNT_ID | Your unique tenant identifier provided by SuperAlign | Yes | acme-corp |
CLIENT_ID | OAuth2 client identifier from your App configuration | Yes | my-firewall-app |
CLIENT_SECRET | OAuth2 client secret from your App configuration | Yes | sk_live_xxxxxxxxxxxx |
Keep your CLIENT_SECRET secure and never commit it to version control or share it publicly.
API Configuration
Configure the SuperAlign API endpoints. These typically don't need to be changed unless you're using a custom deployment.
| Variable | Description | Required | Default |
|---|---|---|---|
SUPERALIGN_RADAR_BASE_URL | Base URL for the SuperAlign API | No | https://api.superalign.ai |
AUTH_URL | URL for the authentication service (Keycloak) | No | https://auth.superalign.ai |
Log Forwarder
Configure the log forwarder service that receives syslog messages from your firewall.
| Variable | Description | Required | Default |
|---|---|---|---|
UDP_PORT | UDP port for receiving syslog messages | No | 5514 |
TCP_PORT | TCP port for receiving syslog messages | No | 5514 |
LOG_LEVEL | Logging verbosity level | No | info |
Log Level Options
debug- Detailed debugging informationinfo- General operational messageswarn- Warning messages for potentially harmful situationserror- Error messages for serious problems
ClickHouse Database
Configure the ClickHouse database used for storing and querying log data.
| Variable | Description | Required | Default |
|---|---|---|---|
CLICKHOUSE_USER | ClickHouse database username | No | admin |
CLICKHOUSE_PASSWORD | ClickHouse database password | No | supersecret |
CLICKHOUSE_HTTP_PORT | ClickHouse HTTP interface port | No | 8123 |
CLICKHOUSE_TCP_PORT | ClickHouse native TCP port | No | 9000 |
The ClickHouse database name is derived from ACCOUNT_ID. Each tenant gets their own isolated database.
For production deployments, always change the default ClickHouse credentials.
Example .env File
Here's a complete example .env file with all available options:
# ==============================================
# Required: Your SuperAlign Credentials
# Get these from the Configure page after creating an App
# ==============================================
ACCOUNT_ID=your-account-id
CLIENT_ID=your-client-id
CLIENT_SECRET=your-client-secret
# ==============================================
# Optional: SuperAlign API (defaults shown)
# ==============================================
# SUPERALIGN_RADAR_BASE_URL=https://api.superalign.ai
# AUTH_URL=https://auth.superalign.ai
# ==============================================
# Optional: Environment and Logging
# ==============================================
ENV=prod
LOG_LEVEL=info
# ==============================================
# Optional: Log Forwarder Ports
# ==============================================
UDP_PORT=5514
TCP_PORT=5514
# ==============================================
# Optional: ClickHouse Configuration
# ==============================================
CLICKHOUSE_USER=admin
CLICKHOUSE_PASSWORD=supersecret
CLICKHOUSE_HTTP_PORT=8123
CLICKHOUSE_TCP_PORT=9000