Skip to content

Repository navigation

docs: add first-party production setup guide (#897) #1000

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cameri merged 16 commits into from
Oct 31, 2026
Merged

docs: add first-party production setup guide (#897) #1000

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
dff00ba
docs: add first-party production setup guide and update README (#897)
avantikonde Oct 22, 2026
06f08ad
docs(setup): fix six defects found in review
chappie-daemon Oct 29, 2026
9668ac1
docs(setup): make proxy trust mandatory and fix backup advice
chappie-daemon Oct 29, 2026
9d594b4
docs(setup): fix proxy-trust placement and backup commands
chappie-daemon Oct 29, 2026
3095759
docs(setup): handle quoted .env values and the silent settings reset
chappie-daemon Oct 29, 2026
1b0b0b4
docs(setup): stop the proxy example from dropping default entries
chappie-daemon Oct 29, 2026
f71f20a
docs(setup): stop the metadata step from duplicating a YAML key, cove…
chappie-daemon Oct 29, 2026
6c5cf97
docs(setup): correct which compose file defines the 10.10.10 network
chappie-daemon Oct 29, 2026
2ae1d39
docs(setup): the client-address log line needs debug level
chappie-daemon Oct 29, 2026
efcd320
Merge remote-tracking branch 'origin/main' into docs/897-setup-guide
chappie-daemon Oct 31, 2026
e2833b3
docs(setup): make the proxy trust instructions match what Docker forw…
chappie-daemon Oct 31, 2026
cdc70e9
docs(setup): refresh release files on update and never leave a partia…
chappie-daemon Oct 31, 2026
f023328
docs(setup): point the TLS recipes at the proxy-trust step
chappie-daemon Oct 31, 2026
27d4ba1
docs(setup): size the database for the host and restart it on config …
chappie-daemon Oct 31, 2026
f9a981a
docs(setup): wait for PostgreSQL before reading its settings
chappie-daemon Oct 31, 2026
af3a916
Merge branch 'main' into docs/897-setup-guide
cameri Oct 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/operator-setup-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"nostream": patch
"nostream-website": patch
---

Add canonical first-party production relay setup guide at `/docs/setup` and replace outdated third-party guides in `README.md`.
11 changes: 6 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ The project master repository is available on [GitHub](https://github.com/cameri
- [Importing events from JSON Lines or JSON Arrays](#importing-events-from-json-lines-or-json-arrays)
- [NIP-43 invite codes](#nip-43-invite-codes)
- [Quick start (Standalone)](#quick-start-standalone)
- [Full guide](#full-guide)
- [Production Setup Guide](#production-setup-guide)
- [Accepting payments](#accepting-payments)
- [Running as a Service](#running-as-a-service)
- [Troubleshooting](#troubleshooting)
Expand Down Expand Up @@ -349,15 +349,16 @@ To clean up the build, coverage and test reports run:
```
pnpm clean
```
## Full Guide
## Production Setup Guide
Comment thread
chappie-daemon marked this conversation as resolved.
Resolved

- [Set up a Paid Nostr relay with Nostream and ZEBEDEE](https://docs.zbdpay.com/payments/nostr/nostr-relay) by [André Neves](https://primal.net/andre) (CTO & Co-Founder at [ZEBEDEE](https://zebedee.io/))
- [Set up a Nostr relay in under 5 minutes](https://andreneves.xyz/p/set-up-a-nostr-relay-server-in-under) by [André Neves](https://twitter.com/andreneves) (CTO & Co-Founder at [ZEBEDEE](https://zebedee.io/))
For a step-by-step walkthrough covering host preparation, Docker Compose deployment, reverse proxy configuration with TLS, and verification, see the official [Production Setup Guide](https://nostream.dev/docs/setup).

Prefer to explore all reference guides? See the [documentation index](https://nostream.dev/docs).

### Accepting Payments

1. Before you begin
- Complete one of the Quick Start guides in this document
- Complete the [Production Setup Guide](https://nostream.dev/docs/setup) or one of the Quick Start guides in this document
- Create a `.env` file
- On `.nostr/settings.yaml` file make the following changes:
- Set `payments.enabled` to `true`
Expand Down
Loading
Loading