mirror of
https://github.com/Such-Software/smirk-backend-core.git
synced 2026-10-17 15:31:38 +02:00
jwinterm
d96f457b69
Add ready-to-run .env + README recipes (personal, public-free, friends, paid-access, paid-relay, community) and the premium-relay design overview, with audit fixes to the config template and spec: - Drop the inert INSTANCE_ID knob (config never read it) and document the real per-node id, which is derived from ADMIN_PUBLIC_URL. - Warn that a placeholder PUBLIC_API_URL is rejected at boot in production (Nostr identity is on by default); soften the recipe "boots today" status. - Remove dead template vars: BTC/LTC Core-RPC settings and the non-existent PUBLIC_EXPOSE_FEATURES (replaced with the real per-field landing switches). - Mark ALTCHA_HMAC_KEY conditional in PoW-off recipes; blank placeholder payment creds so a recipe doesn't ship a key that fails validation. - Fix premium-relay spec drift: the migration creates no premium_until index, disabled endpoints return 400/200 (not 404), and neutralize operator voice.
11 lines
528 B
Markdown
11 lines
528 B
Markdown
# friends — a backend for a known group
|
|
|
|
Invite-only registration plus a locked-down relay (`inbox-outbox`) so your circle
|
|
has a private DM inbox. No payment; generous restore.
|
|
|
|
- **Config:** [`.env.example`](.env.example) — `REGISTRATION_REQUIRE_INVITE=true`,
|
|
`RELAY_ENABLED=true`, `RELAY_WRITE_POLICY=inbox-outbox`.
|
|
- **Invites:** mint codes with `smirk-admin mint-invite --count <n>` and hand them out.
|
|
- **Relay:** you host user messages — review the content notes in
|
|
[`../LEGAL_AND_OPS.md`](../LEGAL_AND_OPS.md).
|