Configuration

Kit packages never read env vars on their own: each package exports a Config struct, which you compose in your project's internal/platform/config/config.go and load with envconf.MustLoad[config.Config](). See the configuration concept. In development a .env file is read; real environment variables always win.

A generated project's config composes like this:

type Config struct {
    Server server.Config                 // no prefix: LISTEN_ADDR, ...
    DB     dbx.Config    `envPrefix:"DB_"`
    Worker worker.Config                 // WORKER_* + embedded REDIS_/SCHEDULER_
    Outbox outbox.Config `envPrefix:"OUTBOX_"`
    // added by hand when needed:
    Storage s3.Config     `envPrefix:"S3_"`
    Mail    smtp.Config   `envPrefix:"MAIL_"`
    JWT     auth.Config   `envPrefix:"JWT_"`
}

server.Config: no prefix

Lifecycle and limits of the HTTP server, regardless of engine. See Server.

telemetry.Config: nested, no prefix

server.Config.Telemetry and worker.Config.Telemetry both carry the telemetry.Config{Otel, Log, Sentry} trio; telemetry.Setup composes the three subsystems in one call. See the observability overview. All variables are read under standard names at the top level, regardless of nesting depth.

otelx.Config: OTel bootstrap

See OpenTelemetry.

logx.Config: the default slog logger

See Logging.

sentryx.Config: the optional Sentry integration

See Sentry.

dbx.Config: envPrefix:"DB_"

PostgreSQL connection, see the database overview.

Named connections

Each named connection (add db <module> <name>) adds another dbx.Config under DB_<NAME>_*, the same variables and defaults as above, with the connection's (uppercased) name spliced into the prefix. add db news analytics adds:

auth.Config: envPrefix:"JWT_"

JWT issuing and verification, see Authentication.

s3.Config: envPrefix:"S3_"

S3-compatible object storage, see Storage.

smtp.Config: envPrefix:"MAIL_"

SMTP sending and default sender, see Email.

queue.Config: envPrefix:"REDIS_"

The queue's (asynq's) Redis connection, see Queue.

outbox.Config: envPrefix:"OUTBOX_"

The relay's behavior, see Outbox.

scheduler.Config: envPrefix:"SCHEDULER_"

The scheduled-job runner, see Scheduler.

worker.Config: the cmd/worker binary

Its own WORKER_-prefixed fields, plus embedded: queue.Config (REDIS_), scheduler.Config (SCHEDULER_) and telemetry.Config (standard OTEL_*/LOG_*/SENTRY_*, see above). See Worker.

The compose dev stack's env variables (not a kit Config field)

These are generated into .env.example by new project; they don't belong to any kit package's Config struct, they drive compose.yml/Dockerfile substitution and Traefik routing.

The shipped MAIL_*/S3_* lines (MAIL_HOST=mailpit, S3_ENDPOINT=http://rustfs:9000, ...) match the smtp.Config/s3.Config prefixes above: the mailpit/rustfs compose services boot with these, but wiring them (adding the fields to the project's config.go) stays opt-in.