Configuration Reference

info

This reference is generated from the core server's configuration structs and pulled from jsonschema/api-docs.md at build time — it always reflects the current configuration surface. For how configuration loads and where secrets belong, see Config and Secrets.

object

Config contains the configuration for the core server

Properties

Name	Type	Description	Required
domain	string	Domain provides a global domain value for other modules to inherit
refreshinterval	integer	RefreshInterval determines how often to reload the config
server	object	Server settings for the echo server	yes
entconfig	object	Config holds the configuration for the ent server
auth	object	Auth settings including oauth2 providers and token configuration	yes
authz	object		yes
db	object		yes
jobqueue	object
redis	object
sessions	object
totp	object
ratelimit	object	Config defines the configuration settings for the rate limiter middleware.
ratelimitunmatched	object	Config defines the configuration settings for the rate limiter middleware.
objectstorage	object	ProviderConfig contains configuration for object storage providers
subscription	object
keywatcher	object	KeyWatcher contains settings for the key watcher that manages JWT signing keys
integrations	object
workflows	object
cloudflare	object	CloudflareConfig contains configuration for Cloudflare integration.
shortlinks	object
backfill	object	Backfill configures one-time startup data backfill routines that populate fields introduced by recent

Additional Properties: not allowed 
Example

{
    "server": {
        "tls": {},
        "cors": {
            "prefixes": {}
        },
        "secure": {},
        "cachecontrol": {
            "nocacheheaders": {}
        },
        "mime": {},
        "graphpool": {},
        "csrfprotection": {}
    },
    "entconfig": {
        "summarizer": {
            "llm": {
                "anthropic": {},
                "cloudflare": {},
                "openai": {}
            }
        },
        "modules": {},
        "emailvalidation": {
            "allowedemailtypes": {}
        },
        "billing": {},
        "notifications": {}
    },
    "auth": {
        "token": {
            "keys": {},
            "redis": {
                "config": {}
            },
            "apitokens": {
                "keys": {}
            }
        },
        "providers": {
            "github": {},
            "google": {},
            "webauthn": {}
        },
        "supportaccess": {}
    },
    "authz": {
        "credentials": {},
        "parentcontextconditions": [
            {
                "context": {}
            }
        ]
    },
    "db": {},
    "jobqueue": {
        "riverconf": {
            "Logger": {},
            "PeriodicJobs": [
                {}
            ],
            "Queues": {},
            "Test": {},
            "Workers": {}
        },
        "metrics": {}
    },
    "redis": {},
    "sessions": {},
    "totp": {},
    "ratelimit": {
        "options": [
            {}
        ]
    },
    "ratelimitunmatched": {
        "options": [
            {}
        ]
    },
    "objectstorage": {
        "providers": {
            "s3": {
                "backup": {},
                "credentials": {}
            },
            "r2": {
                "backup": {},
                "credentials": {}
            },
            "gcs": {
                "backup": {}
            },
            "disk": {
                "backup": {}
            },
            "database": {
                "backup": {}
            }
        }
    },
    "subscription": {
        "stripewebhooksecrets": {}
    },
    "keywatcher": {},
    "integrations": {
        "awssecurityhub": {},
        "cloudflareruntime": {
            "domainscan": {}
        },
        "githubapp": {},
        "slack": {},
        "slackruntime": {},
        "googledrive": {},
        "googleworkspace": {},
        "azureentraid": {},
        "microsoftteams": {},
        "onedrive": {},
        "oidclocal": {},
        "email": {
            "resend": {},
            "postmark": {}
        },
        "paymentreminder": {
            "paymentmethodinterval": 30,
            "deletiondays": 7,
            "enabled": false,
            "dryrun": true
        },
        "organizationdelete": {
            "maxdeletesperrun": 25
        },
        "integrationlifecycle": {
            "enabled": true,
            "dryrun": true,
            "maxperrun": 100
        }
    },
    "workflows": {
        "cel": {},
        "gala": {}
    },
    "cloudflare": {},
    "shortlinks": {},
    "backfill": {}
}

 

$defs/config.Server: object

Server settings for the echo server

Properties

Name	Type	Description	Required
dev	boolean	Dev enables echo's dev mode options	no
listen	string	Listen sets the listen address to serve the echo server on	yes
metricsport	string	MetricsPort sets the port for the metrics endpoint	no
shutdowngraceperiod	integer	ShutdownGracePeriod sets the grace period for in flight requests before shutting down	no
readtimeout	integer	ReadTimeout sets the maximum duration for reading the entire request including the body	no
writetimeout	integer	WriteTimeout sets the maximum duration before timing out writes of the response	no
idletimeout	integer	IdleTimeout sets the maximum amount of time to wait for the next request when keep-alives are enabled	no
readheadertimeout	integer	ReadHeaderTimeout sets the amount of time allowed to read request headers	no
tls	object	TLS settings for the server for secure connections
cors	object	Config holds the cors configuration settings
secure	object	Config contains the types used in the mw middleware
cachecontrol	object	Config is the config values for the cache-control middleware
mime	object	Config defines the config for Mime middleware
graphpool	object	PoolConfig contains the settings for the goroutine pool
enablegraphextensions	boolean	EnableGraphExtensions enables the graph extensions for the graph resolvers	no
enablegraphsubscriptions	boolean	EnableGraphSubscriptions enables graphql subscriptions to the server using websockets or sse	no
complexitylimit	integer	ComplexityLimit sets the maximum complexity allowed for a query	no
maxresultlimit	integer	MaxResultLimit sets the maximum number of results allowed for a query	no
csrfprotection	object	Config defines configuration for the CSRF middleware wrapper.
secretmanager	string	SecretManagerSecret is the name of the GCP Secret Manager secret containing the JWT signing key	no
defaulttrustcenterdomain	string	DefaultTrustCenterDomain is the default domain to use for the trust center if no custom domain is set	no
trustcentercnametarget	string	TrustCenterCnameTarget is the cname target for the trust center Used for mapping the vanity domains to the trust centers	no
trustcenterpreviewzoneid	string	TrustCenterPreviewZoneID is the cloudflare zone id that holds trust center preview domain records	no
notificationlookbackdays	integer	NotificationLookbackDays is the number of days of read notifications to pull when starting a notification subscription Unread notifications are always pulled regardless of this setting	no

Additional Properties: not allowed 
Example

{
    "tls": {},
    "cors": {
        "prefixes": {}
    },
    "secure": {},
    "cachecontrol": {
        "nocacheheaders": {}
    },
    "mime": {},
    "graphpool": {},
    "csrfprotection": {}
}

 

$defs/config.TLS: object

TLS settings for the server for secure connections

Properties

Name	Type	Description	Required
enabled	boolean	Enabled turns on TLS settings for the server
certfile	string	CertFile location for the TLS server
certkey	string	CertKey file location for the TLS server
autocert	boolean	AutoCert generates the cert with letsencrypt, this does not work on localhost

Additional Properties: not allowed 
 

$defs/cors.Config: object

Config holds the cors configuration settings

Properties

Name	Type	Description	Required
enabled	boolean	Enable or disable the CORS middleware
prefixes	object
alloworigins	string[]
cookieinsecure	boolean	CookieInsecure sets the cookie to be insecure

Additional Properties: not allowed 
Example

{
    "prefixes": {}
}

 

$defs/map[string][]string: object

Additional Properties

Name	Type	Description	Required
Additional Properties	string[]

 

$defs/[]string: array

Items

Item Type: string 
 

$defs/[]string: array

Items

Item Type: string 
 

$defs/secure.Config: object

Config contains the types used in the mw middleware

Properties

Name	Type	Description	Required
enabled	boolean	Enabled indicates if the secure middleware should be enabled
xssprotection	string	XSSProtection is the value to set the X-XSS-Protection header to - default is 1; mode=block
contenttypenosniff	string	ContentTypeNosniff is the value to set the X-Content-Type-Options header to - default is nosniff
xframeoptions	string	XFrameOptions is the value to set the X-Frame-Options header to - default is SAMEORIGIN
hstspreloadenabled	boolean	HSTSPreloadEnabled is a boolean to enable HSTS preloading - default is false
hstsmaxage	integer	HSTSMaxAge is the max age to set the HSTS header to - default is 31536000
contentsecuritypolicy	string	ContentSecurityPolicy is the value to set the Content-Security-Policy header to - default is default-src 'self'
referrerpolicy	string	ReferrerPolicy is the value to set the Referrer-Policy header to - default is same-origin
cspreportonly	boolean	CSPReportOnly is a boolean to enable the Content-Security-Policy-Report-Only header - default is false

Additional Properties: not allowed 
 

$defs/cachecontrol.Config: object

Config is the config values for the cache-control middleware

Properties

Name	Type	Description	Required
enabled	boolean
nocacheheaders	object
etagheaders	string[]

Additional Properties: not allowed 
Example

{
    "nocacheheaders": {}
}

 

$defs/map[string]string: object

Additional Properties

Name	Type	Description	Required
Additional Properties	string

 

$defs/[]string: array

Items

Item Type: string 
 

$defs/mime.Config: object

Config defines the config for Mime middleware

Properties

Name	Type	Description	Required
enabled	boolean	Enabled indicates if the mime middleware should be enabled
mimetypesfile	string	MimeTypesFile is the file to load mime types from
defaultcontenttype	string	DefaultContentType is the default content type to set if no mime type is found

Additional Properties: not allowed 
 

$defs/config.PoolConfig: object

PoolConfig contains the settings for the goroutine pool

Properties

Name	Type	Description	Required
maxworkers	integer	MaxWorkers is the maximum number of workers in the pool

Additional Properties: not allowed 
 

$defs/csrf.Config: object

Config defines configuration for the CSRF middleware wrapper.

Properties

Name	Type	Description	Required
enabled	boolean	Enabled indicates whether CSRF protection is enabled.
header	string	Header specifies the header name to look for the CSRF token.
cookie	string	Cookie specifies the cookie name used to store the CSRF token.
secure	boolean	Secure sets the Secure flag on the CSRF cookie.
samesite	string	SameSite configures the SameSite attribute on the CSRF cookie. Valid values are "Lax", "Strict", "None" and "Default".
cookiehttponly	boolean	CookieHTTPOnly indicates whether the CSRF cookie is HTTP only.
cookiedomain	string	CookieDomain specifies the domain for the CSRF cookie, default to no domain
cookiepath	string	CookiePath specifies the path for the CSRF cookie, default to "/"

Additional Properties: not allowed 
 

$defs/entconfig.Config: object

Config holds the configuration for the ent server

Properties

Name	Type	Description	Required
entitytypes	string[]
summarizer	object	Config holds configuration for the text summarization functionality
maxpoolsize	integer	MaxPoolSize is the max worker pool size that can be used by the ent client
modules	object	Modules settings for features access
maxschemaimportsize	integer	MaxSchemaImportSize is the maximum size allowed for schema imports in bytes
emailvalidation	object	EmailVerificationConfig is the configuration for email verification
billing	object	Billing settings for feature access
notifications	object	Notifications settings for notifications sent to users based on events
questionnaireproducturl	string	QuestionnaireProductURL is the product URL used to build questionnaire access links

Additional Properties: not allowed 
Example

{
    "summarizer": {
        "llm": {
            "anthropic": {},
            "cloudflare": {},
            "openai": {}
        }
    },
    "modules": {},
    "emailvalidation": {
        "allowedemailtypes": {}
    },
    "billing": {},
    "notifications": {}
}

 

$defs/[]string: array

Items

Item Type: string 
 

$defs/summarizer.Config: object

Config holds configuration for the text summarization functionality

Properties

Name	Type	Description	Required
type	string	Type specifies the summarization algorithm to use
llm	object	LLM contains configuration for multiple LLM providers
maximumsentences	integer	MaximumSentences specifies the maximum number of sentences in the summary

Additional Properties: not allowed 
Example

{
    "llm": {
        "anthropic": {},
        "cloudflare": {},
        "openai": {}
    }
}

 

$defs/summarizer.LLM: object

LLM contains configuration for multiple LLM providers

Properties

Name	Type	Description	Required
provider	string	Provider specifies which LLM service to use
anthropic	object	AnthropicConfig contains Anthropic specific configuration
cloudflare	object	CloudflareConfig contains Cloudflare specific configuration
openai	object	OpenAIConfig contains OpenAI specific configuration

Additional Properties: not allowed 
Example

{
    "anthropic": {},
    "cloudflare": {},
    "openai": {}
}

 

$defs/summarizer.AnthropicConfig: object

AnthropicConfig contains Anthropic specific configuration

Properties

Name	Type	Description	Required
betaheader	string	BetaHeader specifies the beta API features to enable
legacytextcompletion	boolean	LegacyTextCompletion enables legacy text completion API
baseurl	string	BaseURL specifies the API endpoint
model	string	Model specifies the model name to use
apikey	string	APIKey contains the authentication key for the service

Additional Properties: not allowed 
 

$defs/summarizer.CloudflareConfig: object

CloudflareConfig contains Cloudflare specific configuration

Properties

Name	Type	Description	Required
model	string	Model specifies the model name to use
apikey	string	APIKey contains the authentication key for the service
accountid	string	AccountID specifies the Cloudflare account ID
serverurl	string	ServerURL specifies the API endpoint

Additional Properties: not allowed 
 

$defs/summarizer.OpenAIConfig: object

OpenAIConfig contains OpenAI specific configuration

Properties

Name	Type	Description	Required
model	string	Model specifies the model name to use
apikey	string	APIKey contains the authentication key for the service
url	string	URL specifies the API endpoint
organizationid	string	OrganizationID specifies the OpenAI organization ID

Additional Properties: not allowed 
 

$defs/entconfig.Modules: object

Modules settings for features access

Properties

Name	Type	Description	Required
enabled	boolean	Enabled indicates whether to check and verify module access
usesandbox	boolean	UseSandbox indicates whether to use the sandbox catalog for module access checks
devmode	boolean	DevMode enables all modules for local development regardless of trial status

Additional Properties: not allowed 
 

$defs/validator.EmailVerificationConfig: object

EmailVerificationConfig is the configuration for email verification

Properties

Name	Type	Description	Required
enabled	boolean	Enabled indicates whether email verification is enabled
enableautoupdatedisposable	boolean	EnableAutoUpdateDisposable indicates whether to automatically update disposable email addresses
enablegravatarcheck	boolean	EnableGravatarCheck indicates whether to check for Gravatar existence
enablesmtpcheck	boolean	EnableSMTPCheck indicates whether to check email by smtp
allowedemailtypes	object	AllowedEmailTypes defines the allowed email types for verification
blockeddomains	string[]

Additional Properties: not allowed 
Example

{
    "allowedemailtypes": {}
}

 

$defs/validator.AllowedEmailTypes: object

AllowedEmailTypes defines the allowed email types for verification

Properties

Name	Type	Description	Required
disposable	boolean	Disposable indicates whether disposable email addresses are allowed
free	boolean	Free indicates whether free email addresses are allowed
role	boolean	Role indicates whether role-based email addresses are allowed

Additional Properties: not allowed 
 

$defs/[]string: array

Items

Item Type: string 
 

$defs/entconfig.Billing: object

Billing settings for feature access

Properties

Name	Type	Description	Required
requirepaymentmethod	boolean	RequirePaymentMethod indicates whether to check if a payment method exists for orgs before they can access some resource
bypassemaildomains	string[]

Additional Properties: not allowed 
 

$defs/[]string: array

Items

Item Type: string 
 

$defs/entconfig.Notifications: object

Notifications settings for notifications sent to users based on events

Properties

Name	Type	Description	Required
consoleurl	string	ConsoleURL for ui links used in notifications

Additional Properties: not allowed 
 

$defs/config.Auth: object

Auth settings including oauth2 providers and token configuration

Properties

Name	Type	Description	Required
enabled	boolean	Enabled authentication on the server, not recommended to disable	no
token	object		yes
supportedproviders	string[]
providers	object	OauthProviderConfig represents the configuration for OAuth providers such as Github and Google
supportaccess	object	SupportAccessConfig contains configuration for the Openlane support access flow. The support

Additional Properties: not allowed 
Example

{
    "token": {
        "keys": {},
        "redis": {
            "config": {}
        },
        "apitokens": {
            "keys": {}
        }
    },
    "providers": {
        "github": {},
        "google": {},
        "webauthn": {}
    },
    "supportaccess": {}
}

 

$defs/tokens.Config: object

Properties

Name	Type	Description	Required
kid	string		yes
audience	string		yes
refreshaudience	string		no
issuer	string		yes
accessduration	integer		no
refreshduration	integer		no
refreshoverlap	integer		no
jwksendpoint	string		no
keys	object
generatekeys	boolean		no
jwkscachettl	integer		no
redis	object
apitokens	object
assessmentaccessduration	integer		no
trustcenterndarequestaccessduration	integer		no

Additional Properties: not allowed 
Example

{
    "keys": {},
    "redis": {
        "config": {}
    },
    "apitokens": {
        "keys": {}
    }
}

 

$defs/map[string]string: object

Additional Properties

Name	Type	Description	Required
Additional Properties	string

 

$defs/tokens.RedisConfig: object

Properties

Name	Type	Description	Required
enabled	boolean
config	object
blacklistprefix	string

Additional Properties: not allowed 
Example

{
    "config": {}
}

 

$defs/cache.Config: object

Properties

Name	Type	Description	Required
enabled	boolean
address	string
name	string
username	string
password	string
db	integer
dialtimeout	integer
readtimeout	integer
writetimeout	integer
maxretries	integer
minidleconns	integer
maxidleconns	integer
maxactiveconns	integer

Additional Properties: not allowed 
 

$defs/tokens.APITokenConfig: object

Properties

Name	Type	Description	Required
enabled	boolean
envprefix	string
keys	object
secretsize	integer
delimiter	string
prefix	string

Additional Properties: not allowed 
Example

{
    "keys": {}
}

 

$defs/map[string]tokens.APITokenKeyConfig: object

Additional Properties

Name	Type	Description	Required
Additional Properties	object

 

$defs/tokens.APITokenKeyConfig: object

Properties

Name	Type	Description	Required
secret	string
status	string

Additional Properties: not allowed 
 

$defs/[]string: array

Items

Item Type: string 
 

$defs/handlers.OauthProviderConfig: object

OauthProviderConfig represents the configuration for OAuth providers such as Github and Google

Properties

Name	Type	Description	Required
redirecturl	string	RedirectURL is the URL that the OAuth2 client will redirect to after authentication is complete
github	object		yes
google	object		yes
webauthn	object		yes

Additional Properties: not allowed 
Example

{
    "github": {},
    "google": {},
    "webauthn": {}
}

 

$defs/github.ProviderConfig: object

Properties

Name	Type	Description	Required
clientid	string		yes
clientsecret	string		yes
clientendpoint	string		no
scopes	string[]
redirecturl	string		yes

Additional Properties: not allowed 
 

$defs/[]string: array

Items

Item Type: string 
 

$defs/google.ProviderConfig: object

Properties

Name	Type	Description	Required
clientid	string		yes
clientsecret	string		yes
clientendpoint	string		no
scopes	string[]
redirecturl	string		yes

Additional Properties: not allowed 
 

$defs/[]string: array

Items

Item Type: string 
 

$defs/webauthn.ProviderConfig: object

Properties

Name	Type	Description	Required
enabled	boolean		no
displayname	string		yes
relyingpartyid	string		yes
requestorigins	string[]
maxdevices	integer		no
enforcetimeout	boolean		no
timeout	integer		no
debug	boolean		no

Additional Properties: not allowed 
 

$defs/[]string: array

Items

Item Type: string 
 

$defs/handlers.SupportAccessConfig: object

SupportAccessConfig contains configuration for the Openlane support access flow. The support identity is virtual and authenticated entirely from these values, never from the database. This is the single place that holds the support identity, its shared password, and the second factor identity provider configuration, since both authentications must occur together

Properties

Name	Type	Description	Required
enabled	boolean	Enabled toggles the support access endpoints
email	string	Email is the email of the virtual support identity, used as the first factor username
displayname	string	DisplayName is the display name of the virtual support identity, used for record attribution
subjectid	string	SubjectID is the stable subject id of the virtual support identity used for created_by/updated_by attribution. It must be a valid ULID and is consistent without a backing user row. Default should match auth.SupportSubjectID
password	string	Password is the shared password for the virtual support identity, validated against this value
clientid	string	ClientID is the client ID for the second factor identity provider
clientsecret	string	ClientSecret is the client secret for the second factor identity provider
issuerurl	string	IssuerURL is the issuer URL of the second factor identity provider
discoveryendpoint	string	DiscoveryEndpoint is the optional OIDC discovery endpoint of the second factor identity provider
redirecturl	string	RedirectURL is the callback URL registered with the second factor identity provider
alloweddomain	string	AllowedDomain restricts which email domain may complete the second factor (e.g. theopenlane.io)

Additional Properties: not allowed 
 

$defs/fgax.Config: object

Properties

Name	Type	Description	Required
enabled	boolean	enables authorization checks with openFGA	no
storename	string	name of openFGA store	no
hosturl	string	host url with scheme of the openFGA API	yes
storeid	string	id of openFGA store	no
modelid	string	id of openFGA model	no
createnewmodel	boolean	force create a new model	no
modelfile	string	path to the fga model file	no
modulefile	string	path to the fga module file	no
credentials	object
maxbatchwritesize	integer	maximum number of writes per batch in a transaction	no
enableparentcontext	boolean	disables the automatic addition of parent context tuples	no
parentcontextskipkinds	string[]
parentcontextconditions	array

Additional Properties: not allowed 
Example

{
    "credentials": {},
    "parentcontextconditions": [
        {
            "context": {}
        }
    ]
}

 

$defs/fgax.Credentials: object

Properties

Name	Type	Description	Required
apitoken	string	api token for the openFGA client
clientid	string	client id for the openFGA client
clientsecret	string	client secret for the openFGA client
audience	string	audience for the openFGA client
issuer	string	issuer for the openFGA client
scopes	string	scopes for the openFGA client

Additional Properties: not allowed 
 

$defs/[]string: array

Items

Item Type: string 
 

$defs/[]fgax.ParentContextConditionConfig: array

Items

Example

[
    {
        "context": {}
    }
]

 

$defs/entx.Config: object

Properties

Name	Type	Description	Required
debug	boolean	debug enables printing the debug database logs	no
databasename	string	the name of the database to use with otel tracing	no
drivername	string	sql driver name	no
multiwrite	boolean	enables writing to two databases simultaneously	no
primarydbsource	string	dsn of the primary database	yes
secondarydbsource	string	dsn of the secondary database if multi-write is enabled	no
cachettl	integer	cache results for subsequent requests	no
runmigrations	boolean	run migrations on startup	no
migrationprovider	string	migration provider to use for running migrations	no
enablehistory	boolean	enable history data to be logged to the database	no
maxconnections	integer	maximum number of connections to the database	no
maxidleconnections	integer	maximum number of idle connections to the database	no

Additional Properties: not allowed 
 

$defs/riverqueue.Config: object

Properties

Name	Type	Description	Required
connectionuri	string
runmigrations	boolean
riverconf	object
metrics	object

Additional Properties: not allowed 
Example

{
    "riverconf": {
        "Logger": {},
        "PeriodicJobs": [
            {}
        ],
        "Queues": {},
        "Test": {},
        "Workers": {}
    },
    "metrics": {}
}

 

$defs/river.Config: object

Properties

Name	Type	Description	Required
AdvisoryLockPrefix	integer
CancelledJobRetentionPeriod	integer
CompletedJobRetentionPeriod	integer
DiscardedJobRetentionPeriod	integer
ErrorHandler
FetchCooldown	integer
FetchPollInterval	integer
ID	string
JobCleanerTimeout	integer
JobInsertMiddleware	array
JobStuckHandler
JobStuckThreshold	integer
JobTimeout	integer
Hooks	array
Logger	object
MaxAttempts	integer
Middleware	array
Plugins	array
PeriodicJobs	array
PollOnly	boolean
Queues	object
ReindexerSchedule
ReindexerIndexNames	string[]
ReindexerTimeout	integer
RescueStuckJobsAfter	integer
RetryPolicy
Schema	string
SoftStopTimeout	integer
SkipJobKindValidation	boolean
SkipUnknownJobCheck	boolean
Test	object
TestOnly	boolean
Workers	object
WorkerMiddleware	array

Additional Properties: not allowed 
Example

{
    "Logger": {},
    "PeriodicJobs": [
        {}
    ],
    "Queues": {},
    "Test": {},
    "Workers": {}
}

 

$defs/[]rivertype.JobInsertMiddleware: array

Items

 

$defs/[]rivertype.Hook: array

Items

 

$defs/slog.Logger: object

No properties.

Additional Properties: not allowed 
 

$defs/[]rivertype.Middleware: array

Items

 

$defs/[]rivertype.Plugin: array

Items

 

$defs/[]*river.PeriodicJob: array

Items

Example

[
    {}
]

 

$defs/map[string]river.QueueConfig: object

Additional Properties

Name	Type	Description	Required
Additional Properties	object

 

$defs/river.QueueConfig: object

Properties

Name	Type	Description	Required
FetchCooldown	integer
FetchPollInterval	integer
MaxWorkers	integer

Additional Properties: not allowed 
 

$defs/[]string: array

Items

Item Type: string 
 

$defs/river.TestConfig: object

Properties

Name	Type	Description	Required
DisableUniqueEnforcement	boolean
Time

Additional Properties: not allowed 
 

$defs/river.Workers: object

No properties.

Additional Properties: not allowed 
 

$defs/[]rivertype.WorkerMiddleware: array

Items

 

$defs/riverqueue.MetricsConfig: object

Properties

Name	Type	Description	Required
enablemetrics	boolean
metricsdurationunit	string
enablesemanticmetrics	boolean

Additional Properties: not allowed 
 

$defs/cache.Config: object

Properties

Name	Type	Description	Required
enabled	boolean
address	string
name	string
username	string
password	string
db	integer
dialtimeout	integer
readtimeout	integer
writetimeout	integer
maxretries	integer
minidleconns	integer
maxidleconns	integer
maxactiveconns	integer

Additional Properties: not allowed 
 

$defs/sessions.Config: object

Properties

Name	Type	Description	Required
signingkey	string
encryptionkey	string
domain	string
maxage	integer
secure	boolean
httponly	boolean
samesite	string

Additional Properties: not allowed 
 

$defs/totp.Config: object

Properties

Name	Type	Description	Required
enabled	boolean
codelength	integer
issuer	string
redis	boolean
secret	string
recoverycodecount	integer
recoverycodelength	integer

Additional Properties: not allowed 
 

$defs/ratelimit.Config: object

Config defines the configuration settings for the rate limiter middleware.

Properties

Name	Type	Description	Required
enabled	boolean
options	array
headers	string[]
forwardedindexfrombehind	integer	ForwardedIndexFromBehind selects which IP from X-Forwarded-For should be used. 0 means the closest client, 1 the proxy behind it, etc.
includepath	boolean	IncludePath appends the request path to the limiter key when true.
includemethod	boolean	IncludeMethod appends the request method to the limiter key when true.
keyprefix	string	KeyPrefix allows scoping the limiter key space with a static prefix.
denystatus	integer	DenyStatus overrides the HTTP status code returned when a rate limit is exceeded.
denymessage	string	DenyMessage customises the error payload when a rate limit is exceeded.
sendretryafterheader	boolean	SendRetryAfterHeader toggles whether the Retry-After header should be added when available.
dryrun	boolean	DryRun enables logging rate limit decisions without blocking requests.

Additional Properties: not allowed 
Example

{
    "options": [
        {}
    ]
}

 

$defs/[]ratelimit.RateOption: array

Items

Example

[
    {}
]

 

$defs/[]string: array

Items

Item Type: string 
 

$defs/storage.ProviderConfig: object

ProviderConfig contains configuration for object storage providers

Properties

Name	Type	Description	Required
enabled	boolean	Enabled indicates if object storage is enabled
keys	string[]
maxsizemb	integer	MaxSizeMB is the maximum file size allowed in MB
maxmemorymb	integer	MaxMemoryMB is the maximum memory to use for file uploads in MB
devmode	boolean	DevMode automatically configures a local disk storage provider (and ensures directories exist) and ignores other provider configs
providers	object	Providers contains the configuration for each storage provider

Additional Properties: not allowed 
Example

{
    "providers": {
        "s3": {
            "backup": {},
            "credentials": {}
        },
        "r2": {
            "backup": {},
            "credentials": {}
        },
        "gcs": {
            "backup": {}
        },
        "disk": {
            "backup": {}
        },
        "database": {
            "backup": {}
        }
    }
}

 

$defs/[]string: array

Items

Item Type: string 
 

$defs/storage.Providers: object

Providers contains the configuration for each storage provider

Properties

Name	Type	Description	Required
s3	object	S3Config configures the Amazon S3 provider
r2	object	R2Config configures the Cloudflare R2 provider
gcs	object	GCSConfig configures the Google Cloud Storage provider
disk	object	DiskConfig configures the local filesystem provider
database	object	DatabaseConfig configures the provider that stores file bytes in the database

Additional Properties: not allowed 
Example

{
    "s3": {
        "backup": {},
        "credentials": {}
    },
    "r2": {
        "backup": {},
        "credentials": {}
    },
    "gcs": {
        "backup": {}
    },
    "disk": {
        "backup": {}
    },
    "database": {
        "backup": {}
    }
}

 

$defs/storage.S3Config: object

S3Config configures the Amazon S3 provider

Properties

Name	Type	Description	Required
enabled	boolean	Enabled indicates if this provider is enabled
ensureavailable	boolean	EnsureAvailable enforces provider availability before completing server startup
bucket	string	Bucket is the bucket name, or the directory path for the disk provider
backup	object	BackupConfig defines an asynchronous replication target for a provider's objects. It only
proxypresignenabled	boolean	ProxyPresignEnabled toggles proxy-signed download URL generation
baseurl	string	BaseURL is the prefix for proxy download URLs (e.g., http://localhost:17608/v1/files)
region	string	Region the bucket lives in
endpoint	string	Endpoint overrides the AWS endpoint for S3 compatible services
credentials	object	AccessKeyCredentials is the access key pair used by S3 compatible providers

Additional Properties: not allowed 
Example

{
    "backup": {},
    "credentials": {}
}

 

$defs/storage.BackupConfig: object

BackupConfig defines an asynchronous replication target for a provider's objects. It only names whether backups run and where they go; the destination provider's own configuration supplies the region, endpoint, and credentials

Properties

Name	Type	Description	Required
enabled	boolean	Enabled indicates if this backup target is enabled
provider	string	Provider names the destination backend type, e.g. s3; empty replicates to the source provider itself, which writes the backup to the suffixed bucket alongside the live one
readfrombackup	boolean	ReadFromBackup serves reads from this backup target instead of the source provider, intended to be enabled during a disaster recovery event when the source provider storage is lost
region	string	Region optionally overrides the destination provider's region, so a backup can replicate into a region other than the one holding the live objects

Additional Properties: not allowed 
 

$defs/storage.AccessKeyCredentials: object

AccessKeyCredentials is the access key pair used by S3 compatible providers

Properties

Name	Type	Description	Required
accesskeyid	string	AccessKeyID for the bucket
secretaccesskey	string	SecretAccessKey for the bucket

Additional Properties: not allowed 
 

$defs/storage.R2Config: object

R2Config configures the Cloudflare R2 provider

Properties

Name	Type	Description	Required
enabled	boolean	Enabled indicates if this provider is enabled
ensureavailable	boolean	EnsureAvailable enforces provider availability before completing server startup
bucket	string	Bucket is the bucket name, or the directory path for the disk provider
backup	object	BackupConfig defines an asynchronous replication target for a provider's objects. It only
proxypresignenabled	boolean	ProxyPresignEnabled toggles proxy-signed download URL generation
baseurl	string	BaseURL is the prefix for proxy download URLs (e.g., http://localhost:17608/v1/files)
endpoint	string	Endpoint overrides the account endpoint derived from the account ID
credentials	object	R2Credentials is the access key pair plus the Cloudflare account that owns the bucket

Additional Properties: not allowed 
Example

{
    "backup": {},
    "credentials": {}
}

 

$defs/storage.BackupConfig: object

BackupConfig defines an asynchronous replication target for a provider's objects. It only names whether backups run and where they go; the destination provider's own configuration supplies the region, endpoint, and credentials

Properties

Name	Type	Description	Required
enabled	boolean	Enabled indicates if this backup target is enabled
provider	string	Provider names the destination backend type, e.g. s3; empty replicates to the source provider itself, which writes the backup to the suffixed bucket alongside the live one
readfrombackup	boolean	ReadFromBackup serves reads from this backup target instead of the source provider, intended to be enabled during a disaster recovery event when the source provider storage is lost
region	string	Region optionally overrides the destination provider's region, so a backup can replicate into a region other than the one holding the live objects

Additional Properties: not allowed 
 

$defs/storage.R2Credentials: object

R2Credentials is the access key pair plus the Cloudflare account that owns the bucket

Properties

Name	Type	Description	Required
accesskeyid	string	AccessKeyID for the bucket
secretaccesskey	string	SecretAccessKey for the bucket
accountid	string	AccountID for Cloudflare R2

Additional Properties: not allowed 
 

$defs/storage.GCSConfig: object

GCSConfig configures the Google Cloud Storage provider

Properties

Name	Type	Description	Required
enabled	boolean	Enabled indicates if this provider is enabled
ensureavailable	boolean	EnsureAvailable enforces provider availability before completing server startup
bucket	string	Bucket is the bucket name, or the directory path for the disk provider
backup	object	BackupConfig defines an asynchronous replication target for a provider's objects. It only
proxypresignenabled	boolean	ProxyPresignEnabled toggles proxy-signed download URL generation
baseurl	string	BaseURL is the prefix for proxy download URLs (e.g., http://localhost:17608/v1/files)
endpoint	string	Endpoint overrides the Google API endpoint, for an emulator
projectid	string	ProjectID is the Google Cloud project that owns the bucket

Additional Properties: not allowed 
Example

{
    "backup": {}
}

 

$defs/storage.BackupConfig: object

BackupConfig defines an asynchronous replication target for a provider's objects. It only names whether backups run and where they go; the destination provider's own configuration supplies the region, endpoint, and credentials

Properties

Name	Type	Description	Required
enabled	boolean	Enabled indicates if this backup target is enabled
provider	string	Provider names the destination backend type, e.g. s3; empty replicates to the source provider itself, which writes the backup to the suffixed bucket alongside the live one
readfrombackup	boolean	ReadFromBackup serves reads from this backup target instead of the source provider, intended to be enabled during a disaster recovery event when the source provider storage is lost
region	string	Region optionally overrides the destination provider's region, so a backup can replicate into a region other than the one holding the live objects

Additional Properties: not allowed 
 

$defs/storage.DiskConfig: object

DiskConfig configures the local filesystem provider

Properties

Name	Type	Description	Required
enabled	boolean	Enabled indicates if this provider is enabled
ensureavailable	boolean	EnsureAvailable enforces provider availability before completing server startup
bucket	string	Bucket is the bucket name, or the directory path for the disk provider
backup	object	BackupConfig defines an asynchronous replication target for a provider's objects. It only
proxypresignenabled	boolean	ProxyPresignEnabled toggles proxy-signed download URL generation
baseurl	string	BaseURL is the prefix for proxy download URLs (e.g., http://localhost:17608/v1/files)
endpoint	string	Endpoint is the URL files are served from when proxy presigning is disabled

Additional Properties: not allowed 
Example

{
    "backup": {}
}

 

$defs/storage.BackupConfig: object

BackupConfig defines an asynchronous replication target for a provider's objects. It only names whether backups run and where they go; the destination provider's own configuration supplies the region, endpoint, and credentials

Properties

Name	Type	Description	Required
enabled	boolean	Enabled indicates if this backup target is enabled
provider	string	Provider names the destination backend type, e.g. s3; empty replicates to the source provider itself, which writes the backup to the suffixed bucket alongside the live one
readfrombackup	boolean	ReadFromBackup serves reads from this backup target instead of the source provider, intended to be enabled during a disaster recovery event when the source provider storage is lost
region	string	Region optionally overrides the destination provider's region, so a backup can replicate into a region other than the one holding the live objects

Additional Properties: not allowed 
 

$defs/storage.DatabaseConfig: object

DatabaseConfig configures the provider that stores file bytes in the database

Properties

Name	Type	Description	Required
enabled	boolean	Enabled indicates if this provider is enabled
ensureavailable	boolean	EnsureAvailable enforces provider availability before completing server startup
bucket	string	Bucket is the bucket name, or the directory path for the disk provider
backup	object	BackupConfig defines an asynchronous replication target for a provider's objects. It only
baseurl	string	BaseURL is the prefix for proxy download URLs (e.g., http://localhost:17608/v1/files)

Additional Properties: not allowed 
Example

{
    "backup": {}
}

 

$defs/storage.BackupConfig: object

BackupConfig defines an asynchronous replication target for a provider's objects. It only names whether backups run and where they go; the destination provider's own configuration supplies the region, endpoint, and credentials

Properties

Name	Type	Description	Required
enabled	boolean	Enabled indicates if this backup target is enabled
provider	string	Provider names the destination backend type, e.g. s3; empty replicates to the source provider itself, which writes the backup to the suffixed bucket alongside the live one
readfrombackup	boolean	ReadFromBackup serves reads from this backup target instead of the source provider, intended to be enabled during a disaster recovery event when the source provider storage is lost
region	string	Region optionally overrides the destination provider's region, so a backup can replicate into a region other than the one holding the live objects

Additional Properties: not allowed 
 

$defs/entitlements.Config: object

Properties

Name	Type	Description	Required
enabled	boolean	Enabled determines if the entitlements service is enabled
privatestripekey	string	PrivateStripeKey is the key for the stripe service
stripewebhooksecret	string	StripeWebhookSecret is the secret for the stripe service (legacy, use StripeWebhookSecrets for version-specific secrets)
stripewebhooksecrets	object
stripewebhookurl	string	StripeWebhookURL is the URL for the stripe webhook
stripebillingportalsuccessurl	string	StripeBillingPortalSuccessURL
stripecancellationreturnurl	string	StripeCancellationReturnURL is the URL for the stripe cancellation return
stripewebhookevents	string[]
stripewebhookapiversion	string	StripeWebhookAPIVersion is the Stripe API version currently accepted by the webhook handler
stripewebhookdiscardapiversion	string	StripeWebhookDiscardAPIVersion is the Stripe API version to discard during migration

Additional Properties: not allowed 
Example

{
    "stripewebhooksecrets": {}
}

 

$defs/map[string]string: object

Additional Properties

Name	Type	Description	Required
Additional Properties	string

 

$defs/[]string: array

Items

Item Type: string 
 

$defs/config.KeyWatcher: object

KeyWatcher contains settings for the key watcher that manages JWT signing keys

Properties

Name	Type	Description	Required
enabled	boolean	Enabled indicates whether the key watcher is enabled
keydir	string	KeyDir is the path to the directory containing PEM keys for JWT signing

Additional Properties: not allowed 
 

$defs/catalog.Config: object

Properties

Name	Type	Description	Required
consoleintegrationpath	string
awssecurityhub	object
cloudflareruntime	object
githubapp	object
slack	object
slackruntime	object
googledrive	object
googleworkspace	object
azureentraid	object
microsoftteams	object
onedrive	object
oidclocal	object
email	object		yes
paymentreminder	object
organizationdelete	object
integrationlifecycle	object

Additional Properties: not allowed 
Example

{
    "awssecurityhub": {},
    "cloudflareruntime": {
        "domainscan": {}
    },
    "githubapp": {},
    "slack": {},
    "slackruntime": {},
    "googledrive": {},
    "googleworkspace": {},
    "azureentraid": {},
    "microsoftteams": {},
    "onedrive": {},
    "oidclocal": {},
    "email": {
        "resend": {},
        "postmark": {}
    },
    "paymentreminder": {
        "paymentmethodinterval": 30,
        "deletiondays": 7,
        "enabled": false,
        "dryrun": true
    },
    "organizationdelete": {
        "maxdeletesperrun": 25
    },
    "integrationlifecycle": {
        "enabled": true,
        "dryrun": true,
        "maxperrun": 100
    }
}

 

$defs/awssecurityhub.Config: object

Properties

Name	Type	Description	Required
accesskeyid	string
secretaccesskey	string
arn	string

Additional Properties: not allowed 
 

$defs/cloudflare.RuntimeConfig: object

Properties

Name	Type	Description	Required
apitoken	string	Cloudflare API token for the operator-owned account
accountid	string	Cloudflare account ID for the operator-owned account
domainscan	object

Additional Properties: not allowed 
Example

{
    "domainscan": {}
}

 

$defs/domainscan.ReportConfig: object

Properties

Name	Type	Description	Required
bulkscan	boolean
nonvendorcategories	string[]
deniedvendornames	string[]
scanttl	integer

Additional Properties: not allowed 
 

$defs/[]string: array

Items

Item Type: string 
 

$defs/githubapp.Config: object

Properties

Name	Type	Description	Required
appid	string
privatekey	string
webhooksecret	string
appslug	string

Additional Properties: not allowed 
 

$defs/slack.Config: object

Properties

Name	Type	Description	Required
clientid	string
clientsecret	string
redirecturl	string
appid	string

Additional Properties: not allowed 
 

$defs/slack.RuntimeSlackConfig: object

Properties

Name	Type	Description	Required
webhookURL	string	Slack incoming webhook URL for fire-and-forget system notifications
botToken	string	Bot User OAuth Token for full Web API access to the platform workspace
defaultChannel	string	Default channel id for system messages when no explicit channel is provided

Additional Properties: not allowed 
 

$defs/googledrive.Config: object

Properties

Name	Type	Description	Required
clientid	string
clientsecret	string
redirecturl	string

Additional Properties: not allowed 
 

$defs/googleworkspace.Config: object

Properties

Name	Type	Description	Required
clientid	string
clientsecret	string
redirecturl	string

Additional Properties: not allowed 
 

$defs/azureentraid.Config: object

Properties

Name	Type	Description	Required
clientid	string
clientsecret	string
redirecturl	string
defaulttenant	string
applicationid	string

Additional Properties: not allowed 
 

$defs/microsoftteams.Config: object

Properties

Name	Type	Description	Required
clientid	string
clientsecret	string
redirecturl	string
applicationid	string

Additional Properties: not allowed 
 

$defs/onedrive.Config: object

Properties

Name	Type	Description	Required
clientid	string
clientsecret	string
redirecturl	string
contentmode	string
applicationid	string

Additional Properties: not allowed 
 

$defs/oidclocal.Config: object

Properties

Name	Type	Description	Required
enabled	boolean
clientid	string
clientsecret	string
discoveryurl	string
redirecturl	string

Additional Properties: not allowed 
 

$defs/email.RuntimeEmailConfig: object

Properties

Name	Type	Description	Required
testdir	string	Directory for dev-mode email output	no
provider	string	Email service provider Enum: "resend", "postmark"	yes
resend	object		yes
postmark	object		yes
fromemail	string	Sender email address	yes
supportemail	string	Support contact email address	no
questionnaireemail	string	Sender override for questionnaire auth emails	no
rooturl	string	Root application URL used to construct email action links	no
producturl	string	Product home URL	no
docsurl	string	Documentation URL	no
apiurl	string	Public base URL of the API for email links that hit the API directly	no
CompanyName	string	Company display name	no
CompanyAddress	string	Company mailing address	no
Corporation	string	Legal corporation name	no
LogoURL	string	Hero logo URL displayed in the email body	no
HeaderLogoURL	string	Small logo or icon displayed in the top header bar	no
Copyright	string	Copyright override for email footers; when empty the template renders a dynamic notice from Corporation and the current year	no
TroubleText	string	Fallback help text shown below action buttons; {ACTION} is replaced with the button text at render time	no
TermsURL	string	Terms of service link for email footers	no
PrivacyURL	string	Privacy policy link for email footers	no
UnsubscribeURL	string	Unsubscribe link override for email footers; when empty the template constructs one from ProductURL and the recipient email	no
HeaderText	string	Text displayed in the upper-right corner of the modern theme header	no
CardStyle	string	Card visual style Enum: "flat", "elevated"	no
BodyBackgroundColor	string	Outer page background color	no
CardBackgroundColor	string	Card container background color	no
HeroBackgroundColor	string	Hero banner section background color	no
ButtonColor	string	Call-to-action button background color	no
ButtonTextColor	string	Call-to-action button text color	no
HeadingColor	string	Heading and title text color	no
TextColor	string	Body paragraph text color	no
FooterTextColor	string	Muted text color for headers footers and secondary content	no
AccentBorderColor	string	Decorative accent color applied to borders only	no
Tagline	string	Short descriptive footer line rendered above the social row in modern themes	no

Additional Properties: not allowed 
Example

{
    "resend": {},
    "postmark": {}
}

 

$defs/email.ResendConfig: object

Properties

Name	Type	Description	Required
apikey	string	Resend API key	yes
webhooksecret	string	Resend webhook signing secret	no

Additional Properties: not allowed 
 

$defs/email.PostmarkConfig: object

Properties

Name	Type	Description	Required
servertoken	string	Postmark server API token	yes
messagestream	string	Postmark message stream ID (defaults to outbound)	no
trackopens	boolean	Enable Postmark open tracking	no
tracklinks	string	Postmark link tracking mode Enum: "None", "HtmlAndText", "HtmlOnly", "TextOnly"	no
webhooksecret	string	Postmark webhook basic auth password	no

Additional Properties: not allowed 
 

$defs/system.PaymentReminderConfig: object

Properties

Name	Type	Description	Required
paymentmethodinterval	integer	Days after org creation before marking for deletion Default: 30
deletiondays	integer	Days between marking and actual deletion Default: 7
enabled	boolean	Whether the payment reminder listener is enabled Default: false
dryrun	boolean	If true only log organization IDs that would be processed Default: true

Additional Properties: not allowed 
Example

{
    "paymentmethodinterval": 30,
    "deletiondays": 7,
    "enabled": false,
    "dryrun": true
}

 

$defs/system.OrganizationDeleteConfig: object

Properties

Name	Type	Description	Required
maxdeletesperrun	integer	Maximum overdue organizations to delete per run Default: 25
enabled	boolean	Whether the organization deletion listener is enabled

Additional Properties: not allowed 
Example

{
    "maxdeletesperrun": 25
}

 

$defs/system.IntegrationLifecycleConfig: object

Properties

Name	Type	Description	Required
enabled	boolean	Whether the integration lifecycle sweep is enabled Default: true
dryrun	boolean	If true only log integration IDs and actions that would be dispatched Default: true
maxperrun	integer	Maximum integrations to evaluate per run Default: 100

Additional Properties: not allowed 
Example

{
    "enabled": true,
    "dryrun": true,
    "maxperrun": 100
}

 

$defs/workflows.Config: object

Properties

Name	Type	Description	Required
enabled	boolean
cel	object
gala	object
webhookallowprivateaddresses	boolean

Additional Properties: not allowed 
Example

{
    "cel": {},
    "gala": {}
}

 

$defs/workflows.CELConfig: object

Properties

Name	Type	Description	Required
timeout	integer
costlimit	integer
interruptcheckfrequency	integer
parserrecursionlimit	integer
parserexpressionsizelimit	integer
comprehensionnestinglimit	integer
extendedvalidations	boolean
optionaltypes	boolean
identifierescapesyntax	boolean
crosstypenumericcomparisons	boolean
macrocalltracking	boolean
evaloptimize	boolean
trackstate	boolean

Additional Properties: not allowed 
 

$defs/workflows.GalaConfig: object

Properties

Name	Type	Description	Required
enabled	boolean
workercount	integer
maxretries	integer
failonenqueueerror	boolean
queuename	string

Additional Properties: not allowed 
 

$defs/handlers.CloudflareConfig: object

CloudflareConfig contains configuration for Cloudflare integration.

Properties

Name	Type	Description	Required
enabled	boolean	Enabled toggles the Cloudflare snapshot handler
apitoken	string	APIToken is the API token used for Cloudflare client initialization
accountid	string	AccountID is the Cloudflare account ID to use for snapshot operations
clientid	string	ClientID is the Cloudflare Access client ID for shortlink API requests
clientsecret	string	ClientSecret is the Cloudflare Access client secret for shortlink API requests

Additional Properties: not allowed 
 

$defs/shortlinks.Config: object

Properties

Name	Type	Description	Required
enabled	boolean
clientid	string
clientsecret	string
endpointurl	string
linkttl	integer

Additional Properties: not allowed 
 

$defs/config.Backfill: object

Backfill configures one-time startup data backfill routines that populate fields introduced by recent migrations for organizations and memberships that pre-date them

Properties

Name	Type	Description	Required
enabled	boolean	Enabled runs the backfill routines on server startup, this only setups up the main job, all configured backfills will run based on their settings

Additional Properties: not allowed