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

Configuration (floonet-strfry)

Summary. Two files matter: strfry.conf (the relay itself) and the plugin/authority environment (the Floonet policy). The compose deployment reduces both to one .env.

strfry.conf

The Floonet spec ships a strfry.conf with these keys set; everything else is stock strfry.

KeyFloonet defaultMeaning
relay.info.nameFloonet RelayNIP-11 name; keep it payment-neutral
relay.info.descriptionA strfry Floonet relay for the Grin community Nostr network.NIP-11 description; same rule
relay.writePolicy.pluginpath to the Floonet pluginThe policy engine; see The write-policy plugin
relay.auth.enabledfalseNIP-42; enable for auth-gated modes
events.maxEventSizelarge enough for gift-wrapped slatepacksDo not shrink; see Gift wraps

Floonet policy environment

The plugin and the bundled name authority read one shared environment (in compose, the .env file):

KeyDefaultMeaning
FLOONET_ALLOWED_KINDSthe Goblin + Magick Market set (24 kinds)The whitelist; default deny. .env.example pins the wallet-only core (0,3,5,13,1059,10002,10050,27235) as a conservative starting point
FLOONET_REQUIRE_AUTHfalseReject events unless the connection completed NIP-42 AUTH (also enable relay.auth in strfry.conf)
FLOONET_PAY_MODEoffoff, name (pay to claim a name), or write (pay to write)
FLOONET_NAME_PRICE_GRINunsetPrice of a name in GRIN when FLOONET_PAY_MODE=name
FLOONET_PAID_CACHE_SECS60TTL for the plugin’s cached paid-status lookups
GOBLINPAY_URLunsetYour GoblinPay server, required for any paid mode
GOBLINPAY_TOKENunsetGoblinPay API token; keep it out of the repo, mount it 0400

Reaching the relay over Tor

There is nothing to configure. Wallets reach the relay over Tor by dialing the stack’s ordinary clearnet host through a Tor exit; the Caddy TLS front and the relay behind it stay a normal public endpoint. Just make sure nothing upstream blocks Tor exit IPs. See Tor: how wallets reach a relay.

The full key table for both packages lives in the config keys reference.

The one-file experience

In the compose deployment, .env.example documents every key above with comments. Turning on paid names is three edits:

FLOONET_PAY_MODE=name
FLOONET_NAME_PRICE_GRIN=5
GOBLINPAY_URL=https://pay.yourdomain

See Charge GRIN for your relay for the walkthrough.