Liking cljdoc? Tell your friends :D

Default values

Network

SettingDefault
Transactor listen address127.0.0.1:4334
Peer server listen address127.0.0.1:4336
PostgreSQL server listen address127.0.0.1:5432
Metrics listen addressDisabled
Client transactor endpointhttp://127.0.0.1:4334

Storage

SettingDefault
--storefs
--data-dirNone. Required.
--turso-path<data-dir>/store.db
--s3-prefixBucket root
S3 read-only role duration900 seconds

Lease and availability

SettingDefault
--lease-ttl-ms5000
--lease-wait-ms15000
--heartbeat-ms10000
--haOff
--ownertransactor-$HOSTNAME
Peer reconnect backoff100 ms to 5 s
Peer failover timeout30 s

Index publication

SettingDefault
--index-interval-ms5000
--index-backoff4
--index-tail-threshold0
--index-tail-deadline-ms60000

Garbage collection

SettingDefault
--gc-interval1h
--gc-window72h
corium gc --window72h

Query and function budgets

SettingDefault
--max-fuel (peer server)10000000
--db-fn-fuel1000000
--db-fn-memory-bytes16777216 (16 MiB)
--authz-max-depth8

Segment cache

SettingDefault
--segment-cache-dirDisabled
--segment-cache-capacityNone. Required with the directory.
--segment-cache-memory64 MiB, or the capacity when smaller

Security

SettingDefault
AuthenticationPermissive: development token accepted, anonymous admitted
AuthorizationPermit-all
TLSOff
Encryption at restOff
Authorization database namecorium_authz
authz init --adminoperator
authz init --providerstatic-token
Attribute protectionOff
--key-policystrict when authentication is configured, server-wide when it is not
on-missing-key (protection class)redact
legacy-plaintext (protection class)redact
scope (protection class)attribute

Schema

SettingDefault
corium schema update modeRead-only. --apply is needed to write.
Permitted execution classadditive only
--pruneOff. Absent attributes are reported as unmanaged.
Exit code with changes planned0, or 2 with --detailed-exit-code

Interactive surfaces

SettingDefault
corium tui --refresh-ms2000, minimum 250
corium log --from0
corium log --to0, meaning open-ended
corium postgres-server write modeRead-only

Duration and size formats

A duration accepts one of the suffixes ms, s, m, h, and d, for example 1h, 30m, 72h. A bare number is seconds. off disables the scheduled collection duty.

A byte size accepts B, KiB, MiB, GiB, TiB, kB, MB, GB, and TB. A bare number is bytes.

Can you improve this documentation? These fine people already did:
Claude & Casey Marshall
Edit on GitHub

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close