Module config

Expand description

The server’s configuration: one TOML file. A configuration error stops the start and names its key, and an unknown key is an error.

Structs§

Config: The configuration serve runs with. Durations are written in whole seconds and sizes in bytes; each must be more than zero, and each has a default.
ConfigError: A configuration that could not be read, naming the key at fault.
Export: The [export] table.
ExportS3: How to reach the S3-compatible service an export writes to: every key of [storage.s3] but the bucket and prefix, which --to names, and allow_versioning, which only the server’s own storage reads.
ParquetSettings: The [storage.parquet] table.
S3Settings: How to reach the bucket: the [storage.s3] table.
Storage: Where the server keeps its data: the [storage] table. A file without it keeps everything in data_dir.
StorageError: Why the storage the configuration names cannot be used: the message says which setting or step.

BODY_LIMIT: The largest request body unless configured: 16 MiB. The largest of 34,885 vCon files measured (public datasets and recorded test calls) was 5,141,813 bytes, a two-minute recording held inline; nearly all of their recordings are referenced by URL instead.
INFLATED_LIMIT: The largest inflation unless configured: four times BODY_LIMIT, so any vCon accepted plain is also accepted gzipped, with room left for gzipped payloads inside its signed layers.
PACK_INTERVAL: Time between pack runs unless configured.
PACK_LIMIT: The largest sealed object packed unless configured: 16 MiB, the default largest request body.
PURGE_INTERVAL: Time between purge sweeps unless configured: a version is purged within an hour of falling due.
READER_GRACE: How long an older manifest, and a file a compaction stopped naming, stays for readers outside the server unless configured: 15 minutes.
READ_TIMEOUT: How long a request body may take to arrive unless configured: a body at BODY_LIMIT needs about 2.2 Mbit/s.
ROTATION_WARN: Age of the oldest work waiting for key rotation before serve warns, unless configured: 30 days.
S3_TIMEOUT: How long one S3 request may take unless configured.