Documentation
¶
Overview ¶
Package config loads and validates Githome's runtime configuration from the environment (with an optional file overlay) into a single immutable Config.
Precedence is defaults, then an optional KEY=VALUE file pointed to by GITHOME_CONFIG_FILE, then GITHOME_* environment variables (highest). URLs are parsed once at startup and handed to the presenter layer so every response builds links from the configured host, never a hardcoded one.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var Version = "dev"
Version is the build version, set at link time with -ldflags "-X github.com/tamnd/githome/config.Version=<v>". It is reported by the /healthz endpoint and stamped onto the default logger.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
URLs URLs
Listen Listen
DatabaseURL string // GITHOME_DATABASE_URL; scheme selects the dialect
DBPoolSize int // GITHOME_DB_POOL_SIZE; Postgres max-open-connections, default 25
DataDir string // GITHOME_DATA_DIR; bare repos live under DataDir/repos
GitBinaryPath string // GITHOME_GIT_BINARY; resolved on PATH when empty
GitBackend string // GITHOME_GIT_BACKEND; auto|gogit|gitcli|git2go
RateLimit RateLimit
Secrets Secrets
Worker Worker
Log Log
ShutdownTimeout time.Duration // GITHOME_SHUTDOWN_TIMEOUT; default 30s
Env string // GITHOME_ENV; "production" switches slog to JSON
}
Config is the fully resolved server configuration. It is built once by Load and treated as immutable afterwards.
func Load ¶
Load builds a Config from defaults, an optional file overlay, and the environment, in that order of increasing precedence. It then resolves the derived URLs and validates the result.
func (Config) Validate ¶
Validate checks that the resolved configuration is internally consistent and safe to serve from. In particular it refuses to run with base URLs that point at an upstream GitHub host, since presenters build every link from these and a misconfiguration would emit the wrong host in responses.
type Listen ¶
type Listen struct {
HTTP string // GITHOME_LISTEN_HTTP default ":3000"
SSH string // GITHOME_LISTEN_SSH default ":2222"
}
Listen holds the bind addresses for the two listeners.
type Log ¶
type Log struct {
Level string // GITHOME_LOG_LEVEL debug|info|warn|error default info
Format string // GITHOME_LOG_FORMAT json|text; empty resolves from Env
}
Log configures the structured logger.
type RateLimit ¶
type RateLimit struct {
AuthedPerHour int // GITHOME_RL_AUTHED_PER_HOUR default 5000
AnonPerHour int // GITHOME_RL_ANON_PER_HOUR default 60
GraphQLPoints int // GITHOME_RL_GRAPHQL_POINTS default 5000
SearchPerMin int // GITHOME_RL_SEARCH_PER_MIN default 30
Window time.Duration // fixed 1h to match GitHub reset semantics
}
RateLimit configures the per-actor rate-limit buckets that back the x-ratelimit-* headers and the /rate_limit endpoint.
type Secrets ¶
type Secrets struct {
SessionKey []byte // GITHOME_SESSION_KEY (>= 32 bytes)
TokenPepper []byte // GITHOME_TOKEN_PEPPER (>= 16 bytes)
SSHHostKey []byte // GITHOME_SSH_HOST_KEY or GITHOME_SSH_HOST_KEY_FILE
WebhookSigningDefault []byte // GITHOME_WEBHOOK_SECRET
}
Secrets holds the sensitive material the server needs. Values may be supplied inline or, for the SSH host key, via a *_FILE indirection.
type URLs ¶
type URLs struct {
API *url.URL // GITHOME_API_BASE_URL e.g. https://git.example.com/api/v3
HTML *url.URL // GITHOME_HTML_BASE_URL e.g. https://git.example.com
GraphQL *url.URL // GITHOME_GRAPHQL_URL e.g. https://git.example.com/api/graphql
SSHHost string // GITHOME_GIT_SSH_HOST e.g. git.example.com
SSHPort int // GITHOME_GIT_SSH_PORT default 22
// contains filtered or unexported fields
}
URLs are the resolved external base URLs. API and GraphQL default to the HTML base plus the GHES-style suffixes when not set explicitly.
Source Files