Configuration Reference

All environment variables used by Football Infrastructure services, organized by component.

Overview

Configuration is handled through environment variables. In development, the Dev Container sets all required values automatically. In production, values are configured via CloudFormation parameters and the deployment script.

API Service

The Go API service (apps/api) accepts these environment variables:

Server Settings

Authentication

Kafka Producer

ClickHouse (for metrics queries)

Consumer Service

The Go consumer service (apps/consumer) processes events from Kafka and writes to ClickHouse:

Kafka Consumer

Event Processing

High-Volume Engagement Processing

ClickHouse Writer

Kafka (KRaft Mode)

Apache Kafka runs in KRaft mode (no Zookeeper). These are container-level settings:

Broker Configuration

Listeners

Topic Defaults

ClickHouse

ClickHouse OLAP database settings:

Grafana

Grafana monitoring dashboard:

Authentication

Anonymous Access

Server (Production)

Plugins

Traefik (Production)

Traefik reverse proxy settings for production:

Generating Basic Auth

# Install htpasswd (if needed)
# Ubuntu: apt-get install apache2-utils
# macOS: brew install httpd

# Generate password hash
htpasswd -nb admin your_secure_password

# Output: admin:$apr1$xyz...
# Use this value for TRAEFIK_AUTH (escape $ as $$ in compose files)

Prometheus (Production)

Docker Registry (Production)

Development vs Production

Development (Dev Container)

All values are pre-configured in the Dev Container. Services communicate via Docker network DNS names (kafka, clickhouse, etc.).

Production (AWS)

Values are set by the CloudFormation deployment:

1. CloudFormation parameters configure domain, SSL, instance type
2. User data script generates credentials and writes /opt/football/.env
3. Deploy script uses environment variables for Docker Swarm services

See Deployment Guide for production setup.

Configuration Loading

Both Go services load configuration at startup using environment variables with defaults:

// apps/api/internal/app/config.go
// apps/consumer/internal/app/config.go

func getEnv(key, defaultValue string) string {
    if value, exists := os.LookupEnv(key); exists {
        return value
    }
    return defaultValue
}

func getEnvDuration(key string, defaultValue time.Duration) time.Duration {
    if value, exists := os.LookupEnv(key); exists {
        if duration, err := time.ParseDuration(value); err == nil {
            return duration
        }
    }
    return defaultValue
}

Duration values support Go duration format: 10s, 5m, 1h, 200ms.