Konfiguráció

Sem a kit, sem egyetlen önálló modul nem olvas env-változót magától: mindegyik exportál egy Config structot, amit a projekted internal/platform/config/config.go-jában komponálsz össze, és envconf.MustLoad[config.Config]()-fel töltesz be. Lásd az envconf oldalt és a konfiguráció-koncepciót. Fejlesztésben a .env fájl beolvasásra kerül; a valódi környezeti változók mindig nyernek.

Egy generált projekt configja így áll össze:

type Config struct {
    Server server.Config                 // prefix nélkül: LISTEN_ADDR, ...
    DB     dbx.Config    `envPrefix:"DB_"`
    Worker worker.Config                 // WORKER_* + beágyazott VALKEY_/SCHEDULER_
    Outbox outbox.Config `envPrefix:"OUTBOX_"`
    // kézzel hozzáadva, ha kell:
    Storage s3.Config     `envPrefix:"S3_"`
    Mail    smtp.Config   `envPrefix:"MAIL_"`
    JWT     auth.Config   `envPrefix:"JWT_"`
}

A lenti szakaszok a modultérkép sorrendjét követik: elöl a kit saját chassis-configjai, utána modulonként egy szakasz (kihagyva azt a maroknyit, aminek egyáltalán nincs env-konfigurálható állapota).

A kit chassisa

server.Config: prefix nélkül

github.com/gp-system/gpsystem/server. A HTTP-szerver életciklusa és limitjei. Lásd Szerver.

worker.Config: WORKER_*

github.com/gp-system/gpsystem/worker. A háttérfeldolgozó chassis: asynq szerver + outbox relay + ütemező egy binárisban. Lásd Worker.

A worker.Config emellett beágyazza a queue.Config-ot (VALKEY_*), a scheduler.Config-t (SCHEDULER_*) és a telemetry.Config-ot (standard OTEL_*/LOG_*/SENTRY_* nevekkel).

realtime.Config: REALTIME_*

github.com/gp-system/gpsystem/realtime. A WebSocket/SSE gateway. Lásd Realtime.

A realtime.Config emellett beágyazza a broadcast.Config-ot (envPrefix:"REALTIME_", így az egyetlen változója REALTIME_CHANNEL_PREFIX-ként jelenik meg), a queue.Config-ot (VALKEY_*, ugyanaz a Valkey, amit a centrifuge broker használ), az auth.Config-ot (JWT_*, ez authentikálja a connect-handshake-et) és a telemetry.Config-ot (standard nevek, prefix nélkül).

dbx: envPrefix:"DB_"

github.com/gp-system/dbx. PostgreSQL-kapcsolat, lásd dbx: Áttekintés.

Nevesített kapcsolatok

Minden nevesített kapcsolat (add db <modul> <név>) egy másik dbx.Config-ot ad hozzá DB_<NÉV>_* alatt, ugyanazokkal a változókkal és defaultokkal mint fent, a kapcsolat (nagybetűs) nevével a prefixbe illesztve. Az add db news analytics a következőket adja:

Az errs-nek, a httperr-nek és a paginate-nek nincs Config structja: az errs és a paginate egyáltalán nem hordoz konfigurálható állapotot, a httperr pedig szintén nem olvas semmit a környezetből (a HTTP_EXPOSE_INTERNAL_ERRORS viselkedése a fenti server.Config-ban él). Az envconf maga a loader, nem valami, amit betöltenek; a saját .env-fájl- és tag-konvencióiért lásd az envconf: Áttekintés oldalt.

queue.Config: envPrefix:"VALKEY_"

github.com/gp-system/queue. A Valkey-kapcsolat, amin az asynq és minden rá épülő modul osztozik. Lásd Queue.

events

github.com/gp-system/events. Az event/listener magnak önmagában nincs Config-ja; a két alcsomagjának viszont van.

events/outbox.Config: envPrefix:"OUTBOX_"

A relay viselkedése, lásd Outbox.

events/scheduler.Config: envPrefix:"SCHEDULER_"

Az ütemezett jobok futtatója, lásd Ütemezés.

auth.Config: envPrefix:"JWT_"

github.com/gp-system/auth. JWT-kibocsátás és -ellenőrzés, lásd Autentikáció.

Az auth/rbac-nak és az auth/policy-nak nincs saját Config-ja: a szerep-/permission-ellenőrzés és a kérésenkénti policy-k teljes egészében a tokenben vagy a kérésben már meglévő adatokon futnak, nincs mit tovább konfigurálni.

mail/smtp.Config: envPrefix:"MAIL_"

github.com/gp-system/mail/smtp. SMTP-küldés és default feladó, lásd Mail: Áttekintés.

A mail-nek magának és a mail/mjml-nek nincs Config-ja: a Mailer interfész és az MJML-renderelés nem vesz fel környezetből beállítást.

notify

github.com/gp-system/notify. A Hub/Sender magnak nincs Config-ja; a notify/database-nek sincs (közvetlenül *pg.DB/*bun.DB-t kap, saját változó nélkül). A notify/broadcast-nak viszont van:

notify/broadcast.Config: CHANNEL_PREFIX

Lásd Broadcast.

A broadcast.Config-nak nincs fix saját env-prefixe (a dbx.Config-gal vagy az smtp.Config-gal ellentétben): a beágyazó struct envPrefix tagje dönti el a valódi változónevet. A kit saját realtime.Config-ja Broadcast broadcast.Config `envPrefix:"REALTIME_"` alakban ágyazza be, így egy generált projektben ez a változó valójában REALTIME_CHANNEL_PREFIX, nem a fent látott csupasz CHANNEL_PREFIX.

storage

github.com/gp-system/storage. A Driver/Disk/Manager magnak és a storage/local-nak sincs fix env-prefixe: a storage/local.Config-nak van ROOT-ja (kötelező, a lokális gyökérmappa), PUBLIC_BASE_URL-je, BASE_URL-je és SECRET-je (signed URL-ekhez), és a hívó envPrefix-választása dönti el a valódi változóneveket egy projektben, ugyanúgy, mint a fenti broadcast.Config-nál.

storage/driver/s3.Config: envPrefix:"S3_"

github.com/gp-system/storage/driver/s3, a lista egyetlen beágyazott Go modulja (saját go.mod-dal, ami behúzza az AWS-SDK-alakú minio-go klienst). Lásd S3.

telemetry.Config: beágyazva, prefix nélkül

github.com/gp-system/telemetry. A server.Config.Telemetry és a worker.Config.Telemetry egyaránt a telemetry.Config{Otel, Log, Sentry} hármast hordozza; a telemetry.Setup egy hívásban komponálja a három alrendszert. Lásd Telemetry: Áttekintés. Minden változó standard néven, a legfelső szinten olvasódik, a beágyazás mélységétől függetlenül.

telemetry/otelx.Config: OTel bootstrap

Lásd OpenTelemetry.

telemetry/logx.Config: a default slog logger

Lásd Logolás.

telemetry/sentryx.Config: az opcionális Sentry-integráció

Lásd Sentry.

A compose dev-stack env-változói (nem egy Config mező)

Ezeket a new project generálja a .env.example-be; egyik package Config structjához sem tartoznak, a compose.yml/Dockerfile szubsztitúcióját és a Traefik routingot hajtják.

A leszállított MAIL_*/S3_* sorok (MAIL_HOST=mailpit, S3_ENDPOINT=http://rustfs:9000, ...) a fenti smtp.Config/s3.Config prefixekkel egyeznek: a mailpit/rustfs compose-service ezekkel indul, de a bekötésük (a mezők felvétele a projekt config.go-jába) opt-in marad.