Skip to main content

Module config

Module config 

Source
Expand description

Configuration types for the Forge framework.

Each config section lives in its own sub-module for locality. The root ForgeConfig struct ties them together and owns parsing, env-var substitution, and cross-field validation.

Re-exports§

pub use cluster::ClusterConfig;
pub use signals::SignalsConfig;
pub use types::DurationStr;
pub use types::SizeStr;

Modules§

cluster
signals
Signals configuration for product analytics and diagnostics.
types

Structs§

AuthConfig
Authentication configuration.
CronConfig
Cron scheduler configuration.
DaemonConfig
Daemon runner configuration.
DatabaseConfig
Database configuration. One pool, no per-workload isolation: workload separation belongs at the worker level, not the connection level. The single-pool contention model and sizing formula are documented at the runtime side in forge_runtime::pg::pool module docs.
ForgeConfig
Root configuration. Loaded from forge.toml with ${ENV_VAR} / ${VAR-default} substitution. Only database.url is required.
FunctionConfig
Function execution configuration.
GatewayConfig
Gateway configuration.
LegacySecret
A retired HMAC secret kept around for a bounded window so tokens minted before rotation still validate. After valid_until the entry is silently dropped at startup and never used for verification — leaked old keys cannot extend their reach indefinitely.
McpConfig
MCP server configuration.
NodeConfig
Node role configuration.
ObservabilityConfig
Observability configuration for OTLP telemetry.
ProjectConfig
Project metadata.
QueueWorkerConfig
Per-queue worker pool reservation.
RateLimitSettings
[rate_limit] configuration.
RealtimeConfig
Configuration for the real-time subscription engine and SSE transport.
SecurityConfig
Security configuration.
TlsConfig
TLS configuration for the gateway listener.
WorkerConfig
Worker configuration.
WorkflowConfig
Workflow scheduler configuration.

Enums§

JwtAlgorithm
JWT signing algorithm.
NodeRole
Available node roles.
RateLimitMode
Rate-limiter mode selector.
SignatureCheckMode
Controls how strictly workflow signatures are validated on resume.

Constants§

CRON_QUEUE
Queue name reserved for $cron:<name> jobs.
DEFAULT_QUEUE
Queue name that drains untagged user jobs.
WORKFLOWS_QUEUE
Queue name reserved for the $workflow_resume job kind.

Functions§

substitute_env_vars
Substitute environment variables in the format ${VAR_NAME}.