settings

type ProvisionMode string

type Settings struct {
	ConfigDir     string
	MongoURI      string
	HTTPAddr      string
	ProvisionMode ProvisionMode
	LogLevel      slog.Level
	MaxBodyBytes  int64
	// MaxUploadBytes caps one file of a proxy upload (BACKD_MAX_UPLOAD_BYTES), apart from
	// MaxBodyBytes, which is for JSON.
	MaxUploadBytes int64
	// ImageMaxPixels is the most pixels (width × height) an image may have to get
	// versions (BACKD_IMAGE_MAX_PIXELS); a file field may only lower it.
	ImageMaxPixels int64
	// ImageTimeout bounds the making of one image's versions (BACKD_IMAGE_TIMEOUT).
	ImageTimeout time.Duration
	// Expand are the instance's limits for reference expansion (BACKD_EXPAND_MAX_*).
	Expand registry.ExpandLimits
	// Aggregate are the instance's limits for aggregations (BACKD_AGGREGATE_*).
	Aggregate registry.AggregateLimits
	// DeploymentID is BACKD_DEPLOYMENT_ID (default "default"): what keeps the trigger dispatcher
	// of this backd deployment apart from another one's when both share a MongoDB cluster.
	DeploymentID string
	// TriggerLimits are the instance's trigger limits (BACKD_TRIGGER_MAX_CHAIN).
	TriggerLimits registry.TriggerLimits
	// Realtime are the instance's realtime limits (BACKD_REALTIME_*); zero fields mean the defaults.
	Realtime realtime.Limits
	// ImageConcurrency is how many images one worker process makes versions of at once
	// (BACKD_IMAGE_CONCURRENCY); 0 derives it from the container's CPU and memory limits.
	ImageConcurrency int
	MongoOpTimeout   time.Duration
	ShutdownTimeout  time.Duration
	// PasswordHashConcurrency caps concurrent password hashes; 0 means
	// auth.DefaultHashConcurrency (CPU and memory limits).
	PasswordHashConcurrency int
	// TrustedProxies are networks whose X-Forwarded-For header is believed.
	TrustedProxies []netip.Prefix
	// Functions: the executor (BACKD_EXECUTOR_URL, BACKD_EXECUTOR_TOKEN),
	// the internal listener it and the functions reach backd on
	// (BACKD_INTERNAL_ADDR, as BACKD_CALLBACK_URL from their side), and the
	// key callback tokens are signed with (BACKD_CALLBACK_KEY).
	ExecutorURL   string
	ExecutorToken string
	// EgressProxy (EXECUTOR_PROXY) and EgressKey (BACKD_EGRESS_KEY) are how push providers are
	// reached: through the egress proxy, with a token the worker signs for each delivery unit.
	// Without a proxy the senders dial the providers directly, and only public addresses.
	EgressProxy  string
	EgressKey    string
	InternalAddr string
	CallbackURL  string
	CallbackKey  string
	// BackdURL is backd's public address (BACKD_URL), the base of the links
	// in emails; a realm's email.public_url overrides it. No trailing slash.
	BackdURL string
	// SecretsKey is the master key functions' secrets (roadmap F5) are
	// encrypted under (BACKD_SECRETS_KEY, or BACKD_SECRETS_KEY_FILE for a
	// file holding it). Empty when neither is set: functions that declare
	// secrets are refused at startup (checked against the config, so it
	// isn't here).
	SecretsKey []byte
	// Dev enables BACKD_DEV: functions rebuild automatically when their
	// sources change. Local development only; serve refuses it unless
	// HTTPAddr is bound to localhost.
	Dev bool
	// DisableAdminAPI is BACKD_ADMIN_API=false: this instance serves no
	// /_admin route at all (they answer 404 like any unknown route), for public
	// instances when an internal one has the admin API.
	DisableAdminAPI bool
	// AdminUI is BACKD_ADMIN_UI=true: this instance serves the admin web
	// interface. It needs the admin API on the same instance.
	AdminUI bool
	// AdminUIIdle is BACKD_ADMIN_UI_IDLE: how long the admin UI may sit
	// untouched before it signs out and revokes its session (default 30m).
	AdminUIIdle time.Duration
	// DevAnyAddr (BACKD_DEV_ANY_ADDR) lets dev mode run on an address that
	// isn't localhost, for a container whose ports are published on the
	// host's localhost only.
	DevAnyAddr bool
	// Deno is the deno binary dev mode bundles with; "" means "deno" on
	// the PATH (BACKD_DEV only; `functions build` reads DENO itself).
	Deno string
	// WorkerConcurrency caps how many async jobs one worker process runs
	// at once (WORKER_CONCURRENCY, roadmap F11); default 10.
	WorkerConcurrency int
	// Events is BACKD_EVENTS (default true): this instance may read the change stream for
	// realtime subscribers and serve /_realtime. Triggers is BACKD_TRIGGERS (default true): it may
	// hold the trigger dispatcher's lease. Neither reads anything until there is something to
	// serve (design/triggers-and-realtime.md §3).
	Events   bool
	Triggers bool
	// MetricsAddr (METRICS_ADDR) is where a process serves /metrics; empty
	// means it doesn't. MetricsToken (METRICS_TOKEN) makes it ask for that
	// bearer token. The port must be private (design/metrics.md).
	MetricsAddr  string
	MetricsToken string
}