Skip to content

Option ​

What it is ​

Option is a KV store for system-level switches and config — the "runtime parameters" of the system, as opposed to business entities like User or Channel.

Where to find it ​

  • Admin → System Settings: site name, logo, signup policy, Turnstile, mail signature
  • Admin → Operation Settings: announcements, mail templates

Operator-relevant fields ​

SettingMeaningEffect
Site nameBrowser title, mail, PDFImmediate.
Logo URLHeader logoImmediate.
Default new-user quotaQuotaForNewUserInitial User.quota for newly registered users.
Signup switchAllow new registrationsOff → register page returns 403.
Invite rewardBonus for both inviter and inviteeApplies on the next signup.
Turnstile / CaptchaCloudflare keyAnti-bot signup; leave blank to disable.
Mail signatureSMTP mail footerApplies on the next mail.
Terms / Privacy URLLink in copyFrontend pages swap in.

What does NOT live in Option ​

Option is reserved for "no dedicated UI, no dedicated data model, but might need tuning at any time" globals.

  • GET /api/option/ — get all (sensitive values are masked)
  • PUT /api/option/ — update one (Root)