mirror of https://github.com/Such-Software/smirk-backend-core.git synced 2026-10-17 15:31:38 +02:00

Files

T

jwinterm a455c60ed0 docs: operator console guide + fix example recipes + document all env vars

- New docs/operations/CONSOLE.md: reaching /admin, NIP-98 login, the
  defaults->env->DB precedence model, per-section runtime-safe vs
  restart-required table, expected_versions concurrency, restart_apply_mode
  (with the systemd Restart=always requirement for auto), clearing a DB
  override. Linked from README + OPERATOR_SETUP.
- All six example recipes gained an explicit chain-enablement block
  (FEATURE_XMR/WOW on, BTC/LTC/GRIN off) so they no longer hard-fail
  Config::validate in production (default-on chains with empty sources).
- Documented all 16 previously-undocumented env vars in .env.example
  (RESTART_APPLY_MODE, TOR_ADMIN_ONION, DEPLOYMENT_MODE, TIP_SHARE_BASE_URL,
  ...); RELAY.md gained the premium-post policy + RELAY_WRITE_ALLOWLIST_NPUBS;
  ADMIN_PUBKEYS noted as reserved/inert.

2026-07-19 15:52:07 -04:00

.env.example

docs: operator console guide + fix example recipes + document all env vars

2026-07-19 15:52:07 -04:00

README.md

docs(examples): operator cookbook — six deployment recipes + premium-relay spec

2026-07-02 19:47:46 -04:00

README.md

public-free — a free, open public instance

Anyone can register and use the wallet; spam is gated by proof-of-work, not payment. This is the shape a free, open public instance runs.

Config: .env.example — POW_REQUIRED=true, no invite/payment gate, WALLET_RESTORE_POLICY=bounded + PoW-priced, relay off at launch.
Boot: copy → .env, generate secrets, reuse your existing daemons / LWS, run the binary. Front it with TLS; bind the API to 127.0.0.1.
No money changes hands, so there is no payment/consumer-sale surface — just have a Terms + Privacy that disclose what the backend receives (see ../LEGAL_AND_OPS.md).