Configuration

No package, framework or standalone module, reads env vars on its own: each one exports a Config struct, which you compose in your project's internal/platform/config/config.go and load with envconf.MustLoad[config.Config](). See envconf and 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 VALKEY_/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_"`
}

The sections below follow the module map's order: the framework's own chassis configs first, then one section per standalone module (skipping the handful with no env-configurable state at all).

The framework's chassis

server.Config: no prefix

github.com/gp-system/framework/server. Lifecycle and limits of the HTTP server. See Server.

worker.Config: WORKER_*

github.com/gp-system/framework/worker. The background-processing chassis: asynq server + outbox relay + scheduler in one binary. See Worker.

worker.Config also embeds queue.Config (VALKEY_*), scheduler.Config (SCHEDULER_*) and telemetry.Config (standard OTEL_*/LOG_*/SENTRY_*).

realtime.Config: REALTIME_*

github.com/gp-system/framework/realtime. The WebSocket/SSE gateway. See Realtime.

realtime.Config also embeds broadcast.Config (envPrefix:"REALTIME_", so its one variable becomes REALTIME_CHANNEL_PREFIX), queue.Config (VALKEY_*, the same Valkey the centrifuge broker uses), auth.Config (JWT_*, authenticates the connect handshake) and telemetry.Config (standard names, no prefix).

dbx: envPrefix:"DB_"

github.com/gp-system/dbx. PostgreSQL connection, see dbx: 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:

errs, httperr and paginate have no Config struct: errs and paginate carry no configurable state at all, and httperr reads nothing from the environment either (its HTTP_EXPOSE_INTERNAL_ERRORS behavior lives in server.Config, above). envconf is the loader itself, not something that's loaded; see envconf: Overview for its own .env-file and tag conventions.

queue.Config: envPrefix:"VALKEY_"

github.com/gp-system/queue. The Valkey connection shared by asynq and every module built on it. See Queue.

events

github.com/gp-system/events. The event/listener core has no Config of its own; its two subpackages do.

events/outbox.Config: envPrefix:"OUTBOX_"

The relay's behavior, see Outbox.

events/scheduler.Config: envPrefix:"SCHEDULER_"

The scheduled-job runner, see Scheduler.

auth.Config: envPrefix:"JWT_"

github.com/gp-system/auth. JWT issuing and verification, see Authentication.

auth/rbac and auth/policy have no Config of their own: role/permission checks and per-request policies run entirely on data already in the token or the request, nothing further to configure.

mail/smtp.Config: envPrefix:"MAIL_"

github.com/gp-system/mail/smtp. SMTP sending and default sender, see Mail: Overview.

mail itself and mail/mjml have no Config: the Mailer interface and MJML rendering take no environment-sourced settings.

notify

github.com/gp-system/notify. The Hub/Sender core has no Config; notify/database has none either (it takes a *pg.DB/*bun.DB directly, no variables of its own). notify/broadcast does:

notify/broadcast.Config: CHANNEL_PREFIX

See Broadcast.

broadcast.Config carries no fixed env prefix of its own (unlike dbx.Config or smtp.Config): the embedding struct's envPrefix tag decides the real variable name. The framework's own realtime.Config embeds it as Broadcast broadcast.Config `envPrefix:"REALTIME_"`, so in a generated project this variable is actually REALTIME_CHANNEL_PREFIX, not the bare CHANNEL_PREFIX shown above.

storage

github.com/gp-system/storage. The Driver/Disk/Manager core and storage/local carry no fixed env prefix either: storage/local.Config has ROOT (required, the local root directory), PUBLIC_BASE_URL, BASE_URL and SECRET (for signed URLs), and it's the caller's envPrefix choice, same as broadcast.Config above, that decides the real variable names in a project.

minio-storage-driver (s3.Config): envPrefix:"S3_"

github.com/gp-system/minio-storage-driver, storage's S3-compatible driver as a standalone module (the declared package name is s3; its own go.mod pulls in the minio-go client). See S3.

telemetry.Config: nested, no prefix

github.com/gp-system/telemetry. 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 Telemetry: Overview. All variables are read under standard names at the top level, regardless of nesting depth.

telemetry/otelx.Config: OTel bootstrap

See OpenTelemetry.

logx.Config: the default slog logger

Provided by the standalone logx module, not telemetry itself; telemetry.Config consumes it as its embedded Log field. See logx: Overview and Telemetry: Logging.

telemetry/sentryx.Config: the optional Sentry integration

See Sentry.

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

These are generated into .env.example by new project; they don't belong to any 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.