# .env.example — docker-compose.yml environment for nginx-logtail.
#
# Copy to .env and edit. `.env` is gitignored so local edits stay local:
#
#   cp .env.example .env
#   $EDITOR .env
#   docker compose up -d

# ---------------------------------------------------------------------------
# Which containers start
# ---------------------------------------------------------------------------
# Docker Compose "profiles" decide which services actually start when you
# run `docker compose up`. Set COMPOSE_PROFILES below to a comma-separated
# list of the services you want. Valid values:
#
#   collector   — ingests nginx logs (file + UDP); runs on each nginx host
#   aggregator  — merges collectors into a central view
#   frontend    — HTTP dashboard (reads aggregator or a single collector)
#
# Leave empty (or delete the line) to start nothing.

# Default: central host stack (aggregator + frontend), mirrors the
# shipped docker-compose.yml layout.
COMPOSE_PROFILES=aggregator,frontend

# Examples:
#COMPOSE_PROFILES=collector,aggregator,frontend   # single-host all-in-one
#COMPOSE_PROFILES=collector                       # nginx host running only the collector
#COMPOSE_PROFILES=frontend                        # frontend pointing at a remote aggregator
#COMPOSE_PROFILES=                                # nothing

# ---------------------------------------------------------------------------
# Collector  (nginx-logtail-collector)
# ---------------------------------------------------------------------------
# The variable names below mirror /etc/default/nginx-logtail on a Debian
# install, so an operator moving between bare-metal and containers can
# reuse muscle memory. Each variable is read by the collector via an
# envOr(..., COLLECTOR_*, ...) fallback in cmd/collector/main.go.

# gRPC listen address inside the container. Host-networked, so this is
# also the address the aggregator dials.
COLLECTOR_LISTEN=:9090

# Prometheus /metrics listen address. Set to "" to disable the endpoint.
COLLECTOR_PROM_LISTEN=:9100

# Comma-separated log file paths or glob patterns. At least one of
# COLLECTOR_LOGS, COLLECTOR_LOGS_FILE, or COLLECTOR_LOGTAIL_PORT > 0 must
# be set; otherwise the collector refuses to start. Leave empty to run
# UDP-only. The shipped compose file bind-mounts /var/log/nginx:ro so
# paths under that tree are readable.
COLLECTOR_LOGS=

# File containing one path/glob per line.
COLLECTOR_LOGS_FILE=

# Name for this collector in query responses and ListTargets. Docker's
# default container hostname is the short container id; set something
# stable here if you want meaningful source names across restarts.
#COLLECTOR_SOURCE=nginx1

# IPv4 / IPv6 prefix lengths for client address bucketing.
COLLECTOR_V4PREFIX=24
COLLECTOR_V6PREFIX=48

# How often to rescan COLLECTOR_LOGS globs for new/removed files.
COLLECTOR_SCAN_INTERVAL=10s

# UDP port for ipng_stats_logtail datagrams from nginx-ipng-stats-plugin.
# Set to 0 to disable the UDP listener entirely.
COLLECTOR_LOGTAIL_PORT=9514

# UDP bind address. Host-networked default accepts localhost traffic
# from host nginx; change to 0.0.0.0 if packets come from off-host.
COLLECTOR_LOGTAIL_BIND=127.0.0.1

# Extra arguments appended to the collector argv. Useful for temporary
# overrides or flags without an env-var form.
COLLECTOR_ARGS=

# ---------------------------------------------------------------------------
# Aggregator  (nginx-logtail-aggregator)
# ---------------------------------------------------------------------------

# gRPC listen address. The compose file publishes 9091 regardless.
AGGREGATOR_LISTEN=:9091

# Comma-separated collector addresses (MANDATORY). How you spell them
# depends on whether the collectors are in the same compose stack:
#
#   same-host all-in-one (COMPOSE_PROFILES=collector,aggregator,frontend):
#     the collector uses network_mode: host, so reach it via the host's
#     address — "host.docker.internal:9090" on Docker Desktop, or the
#     host's LAN address on Linux.
#
#   central aggregator pointing at remote collectors:
#     list each remote host, e.g. "nginx1:9090,nginx2:9090,nginx3:9090".
AGGREGATOR_COLLECTORS=nginx1:9090

# Display name for this aggregator. Uncomment to override the short
# container id that os.Hostname() returns inside Docker.
#AGGREGATOR_SOURCE=agg-prod

# Extra arguments appended to the aggregator argv.
AGGREGATOR_ARGS=

# ---------------------------------------------------------------------------
# Frontend  (nginx-logtail-frontend)
# ---------------------------------------------------------------------------

# HTTP listen address. The compose file publishes 8080 regardless.
FRONTEND_LISTEN=:8080

# Default gRPC endpoint the dashboard queries. When the aggregator runs
# in the same compose stack, Docker's internal DNS resolves the service
# name to the bridge IP — "aggregator:9091" just works. Point at a
# remote aggregator instead for a frontend-only deployment.
FRONTEND_TARGET=aggregator:9091

# Default number of table rows. Override per-URL with ?n=N.
FRONTEND_N=25

# Meta-refresh interval (seconds). Set 0 to disable auto-refresh.
FRONTEND_REFRESH=30

# Extra arguments appended to the frontend argv.
FRONTEND_ARGS=