Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Config keys

The keys an operator actually touches, across both packages. Package-specific pages: floonet-strfry configuration, floonet-rs configuration.

Shared Floonet keys (environment)

KeyDefaultMeaning
ALLOWED_KINDS0,3,5,13,1059,10002,10050,27235The whitelist. Default deny; everything not listed is dropped.
FLOONET_PAY_MODEoffoff, name (pay to claim a name), or write (pay to publish).
FLOONET_NAME_PRICE_GRINunsetPrice of a name in GRIN. Required when FLOONET_PAY_MODE=name.
GOBLINPAY_URLunsetThe operator’s GoblinPay server. Required for any paid mode.
GOBLINPAY_TOKENunsetGoblinPay API token. Secret: environment or 0400 file only.

floonet-strfry (strfry.conf)

KeyFloonet defaultMeaning
relay.info.nameFloonet RelayNIP-11 name, payment-neutral.
relay.info.descriptionA strfry Floonet relay.NIP-11 description, same rule.
relay.writePolicy.pluginplugin pathThe write-policy plugin.
relay.auth.enabledfalseNIP-42 authentication.
events.maxEventSizeshipped defaultKeep large enough for gift-wrapped slatepacks.

The read side may also set filterValidation.allowedKinds to mirror the whitelist on subscriptions.

floonet-rs (config.toml)

KeyFloonet defaultMeaning
info.namefloonet-rs-relayNIP-11 name, payment-neutral.
info.descriptionneutral Floonet wordingNIP-11 description, same rule.
limits.event_kind_allowlist[0, 3, 5, 13, 1059, 10002, 10050, 27235]The whitelist, enforced in admission.
limits.max_event_bytesshipped defaultKeep large enough for gift-wrapped slatepacks.
authorization.nip42_authfalseRequire AUTH before writes.
authorization.nip42_dmsfalseRequire AUTH to read your gift wraps.
authorization.pubkey_whitelistunsetRestrict writes to these pubkeys.
pay_to_relay.enabledfalseMaster switch for the GoblinPay processor.
pay_to_relay.processorGoblinPayPayment backend selection.
name_authority.enabledtrueServe the name authority in-process.
name_authority.domainoperator’s domainThe NIP-05 domain names resolve under.