Docs
Configuration

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.

VariableDescriptionRequiredExample
ACCOUNT_IDYour unique tenant identifier provided by SuperAlignYesacme-corp
CLIENT_IDOAuth2 client identifier from your App configurationYesmy-firewall-app
CLIENT_SECRETOAuth2 client secret from your App configurationYessk_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.

VariableDescriptionRequiredDefault
SUPERALIGN_RADAR_BASE_URLBase URL for the SuperAlign APINohttps://api.superalign.ai
AUTH_URLURL for the authentication service (Keycloak)Nohttps://auth.superalign.ai

Log Forwarder

Configure the log forwarder service that receives syslog messages from your firewall.

VariableDescriptionRequiredDefault
UDP_PORTUDP port for receiving syslog messagesNo5514
TCP_PORTTCP port for receiving syslog messagesNo5514
LOG_LEVELLogging verbosity levelNoinfo

Log Level Options

  • debug - Detailed debugging information
  • info - General operational messages
  • warn - Warning messages for potentially harmful situations
  • error - Error messages for serious problems

ClickHouse Database

Configure the ClickHouse database used for storing and querying log data.

VariableDescriptionRequiredDefault
CLICKHOUSE_USERClickHouse database usernameNoadmin
CLICKHOUSE_PASSWORDClickHouse database passwordNosupersecret
CLICKHOUSE_HTTP_PORTClickHouse HTTP interface portNo8123
CLICKHOUSE_TCP_PORTClickHouse native TCP portNo9000

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:

.env
# ==============================================
# 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

On this page