mirror of
https://github.com/scsibug/nostr-rs-relay.git
synced 2024-11-23 01:29:06 -05:00
8bf52646c7
* improvement: use appropriate paths for systemd example * improvement: add a configurable postgres write conn string This adds a new configurable connection string for postgres writes. * improvement: document pg connection_write config * build: upgrade checkout action for github ci * perf: use standard allocator, limit sqlite mmap to 4GB This is an experimental change to see if we can reduce memory usage with large SQLite databases. If successful, we'll do this again and further reduce the database mmap size. This will cause greater use of the page cache, but that is more easily reclaimed by the kernel, and should reduce memory pressure, as well as making it clearer how much memory the application is actually using for connections, subscriptions, etc. * docs: reformatting * docs: allow host header prefix matching, required for Damus compatibility * perf: disable sqlite mmap to reduce memory pressure * perf: switch to jemalloc allocator * docs: helpful ubuntu packages for building * perf: reduce SQLite connection count and idle lifetime On lightly loaded relays, we free up memory faster by letting idle connections be reclaimed in 10 seconds instead of the default 10 minutes. This also sets the minimum to zero connections, instead of always trying to hold one open. --------- Co-authored-by: Petr Kracik <petrkr@petrkr.net> Co-authored-by: Kieran <kieran@harkin.me> Co-authored-by: Greg Heartsfield <scsibug@imap.cc>
168 lines
7.3 KiB
Markdown
168 lines
7.3 KiB
Markdown
# [nostr-rs-relay](https://git.sr.ht/~gheartsfield/nostr-rs-relay)
|
|
|
|
This is a [nostr](https://github.com/nostr-protocol/nostr) relay,
|
|
written in Rust. It currently supports the entire relay protocol, and
|
|
persists data with SQLite. There is experimental support for
|
|
Postgresql.
|
|
|
|
The project master repository is available on
|
|
[sourcehut](https://sr.ht/~gheartsfield/nostr-rs-relay/), and is
|
|
mirrored on [GitHub](https://github.com/scsibug/nostr-rs-relay).
|
|
|
|
[](https://builds.sr.ht/~gheartsfield/nostr-rs-relay/commits/master?)
|
|
|
|
|
|
|
|
|
|
## Features
|
|
|
|
[NIPs](https://github.com/nostr-protocol/nips) with a relay-specific implementation are listed here.
|
|
|
|
- [x] NIP-01: [Basic protocol flow description](https://github.com/nostr-protocol/nips/blob/master/01.md)
|
|
* Core event model
|
|
* Hide old metadata events
|
|
* Id/Author prefix search
|
|
- [x] NIP-02: [Contact List and Petnames](https://github.com/nostr-protocol/nips/blob/master/02.md)
|
|
- [ ] NIP-03: [OpenTimestamps Attestations for Events](https://github.com/nostr-protocol/nips/blob/master/03.md)
|
|
- [x] NIP-05: [Mapping Nostr keys to DNS-based internet identifiers](https://github.com/nostr-protocol/nips/blob/master/05.md)
|
|
- [x] NIP-09: [Event Deletion](https://github.com/nostr-protocol/nips/blob/master/09.md)
|
|
- [x] NIP-11: [Relay Information Document](https://github.com/nostr-protocol/nips/blob/master/11.md)
|
|
- [x] NIP-12: [Generic Tag Queries](https://github.com/nostr-protocol/nips/blob/master/12.md)
|
|
- [x] NIP-15: [End of Stored Events Notice](https://github.com/nostr-protocol/nips/blob/master/15.md)
|
|
- [x] NIP-16: [Event Treatment](https://github.com/nostr-protocol/nips/blob/master/16.md)
|
|
- [x] NIP-20: [Command Results](https://github.com/nostr-protocol/nips/blob/master/20.md)
|
|
- [x] NIP-22: [Event `created_at` limits](https://github.com/nostr-protocol/nips/blob/master/22.md) (_future-dated events only_)
|
|
- [ ] NIP-26: [Event Delegation](https://github.com/nostr-protocol/nips/blob/master/26.md) (_implemented, but currently disabled_)
|
|
- [x] NIP-28: [Public Chat](https://github.com/nostr-protocol/nips/blob/master/28.md)
|
|
- [x] NIP-33: [Parameterized Replaceable Events](https://github.com/nostr-protocol/nips/blob/master/33.md)
|
|
- [x] NIP-40: [Expiration Timestamp](https://github.com/nostr-protocol/nips/blob/master/40.md)
|
|
- [x] NIP-42: [Authentication of clients to relays](https://github.com/nostr-protocol/nips/blob/master/42.md)
|
|
|
|
## Quick Start
|
|
|
|
The provided `Dockerfile` will compile and build the server
|
|
application. Use a bind mount to store the SQLite database outside of
|
|
the container image, and map the container's 8080 port to a host port
|
|
(7000 in the example below).
|
|
|
|
The examples below start a rootless podman container, mapping a local
|
|
data directory and config file.
|
|
|
|
```console
|
|
$ podman build -t nostr-rs-relay .
|
|
|
|
$ mkdir data
|
|
|
|
$ podman unshare chown 100:100 data
|
|
|
|
$ podman run -it --rm -p 7000:8080 \
|
|
--user=100:100 \
|
|
-v $(pwd)/data:/usr/src/app/db:Z \
|
|
-v $(pwd)/config.toml:/usr/src/app/config.toml:ro,Z \
|
|
--name nostr-relay nostr-rs-relay:latest
|
|
|
|
Nov 19 15:31:15.013 INFO nostr_rs_relay: Starting up from main
|
|
Nov 19 15:31:15.017 INFO nostr_rs_relay::server: listening on: 0.0.0.0:8080
|
|
Nov 19 15:31:15.019 INFO nostr_rs_relay::server: db writer created
|
|
Nov 19 15:31:15.019 INFO nostr_rs_relay::server: control message listener started
|
|
Nov 19 15:31:15.019 INFO nostr_rs_relay::db: Built a connection pool "event writer" (min=1, max=4)
|
|
Nov 19 15:31:15.019 INFO nostr_rs_relay::db: opened database "/usr/src/app/db/nostr.db" for writing
|
|
Nov 19 15:31:15.019 INFO nostr_rs_relay::schema: DB version = 0
|
|
Nov 19 15:31:15.054 INFO nostr_rs_relay::schema: database pragma/schema initialized to v7, and ready
|
|
Nov 19 15:31:15.054 INFO nostr_rs_relay::schema: All migration scripts completed successfully. Welcome to v7.
|
|
Nov 19 15:31:15.521 INFO nostr_rs_relay::db: Built a connection pool "client query" (min=4, max=128)
|
|
```
|
|
|
|
Use a `nostr` client such as
|
|
[`noscl`](https://github.com/fiatjaf/noscl) to publish and query
|
|
events.
|
|
|
|
```console
|
|
$ noscl publish "hello world"
|
|
Sent to 'ws://localhost:8090'.
|
|
Seen it on 'ws://localhost:8090'.
|
|
$ noscl home
|
|
Text Note [81cf...2652] from 296a...9b92 5 seconds ago
|
|
hello world
|
|
```
|
|
|
|
A pre-built container is also available on DockerHub:
|
|
https://hub.docker.com/r/scsibug/nostr-rs-relay
|
|
|
|
## Build and Run (without Docker)
|
|
|
|
Building `nostr-rs-relay` requires an installation of Cargo & Rust: https://www.rust-lang.org/tools/install
|
|
|
|
The following OS packages will be helpful; on Debian/Ubuntu:
|
|
```console
|
|
$ sudo apt-get install build-essentials cmake protobuf-compiler pkg-config libssl-dev
|
|
```
|
|
|
|
Clone this repository, and then build a release version of the relay:
|
|
|
|
```console
|
|
$ git clone -q https://git.sr.ht/\~gheartsfield/nostr-rs-relay
|
|
$ cd nostr-rs-relay
|
|
$ cargo build -q -r
|
|
```
|
|
|
|
The relay executable is now located in
|
|
`target/release/nostr-rs-relay`. In order to run it with logging
|
|
enabled, execute it with the `RUST_LOG` variable set:
|
|
|
|
```console
|
|
$ RUST_LOG=warn,nostr_rs_relay=info ./target/release/nostr-rs-relay
|
|
Dec 26 10:31:56.455 INFO nostr_rs_relay: Starting up from main
|
|
Dec 26 10:31:56.464 INFO nostr_rs_relay::server: listening on: 0.0.0.0:8080
|
|
Dec 26 10:31:56.466 INFO nostr_rs_relay::server: db writer created
|
|
Dec 26 10:31:56.466 INFO nostr_rs_relay::db: Built a connection pool "event writer" (min=1, max=2)
|
|
Dec 26 10:31:56.466 INFO nostr_rs_relay::db: opened database "./nostr.db" for writing
|
|
Dec 26 10:31:56.466 INFO nostr_rs_relay::schema: DB version = 11
|
|
Dec 26 10:31:56.467 INFO nostr_rs_relay::db: Built a connection pool "maintenance writer" (min=1, max=2)
|
|
Dec 26 10:31:56.467 INFO nostr_rs_relay::server: control message listener started
|
|
Dec 26 10:31:56.468 INFO nostr_rs_relay::db: Built a connection pool "client query" (min=4, max=8)
|
|
```
|
|
|
|
You now have a running relay, on port `8080`. Use a `nostr` client or
|
|
`websocat` to connect and send/query for events.
|
|
|
|
## Configuration
|
|
|
|
The sample [`config.toml`](config.toml) file demonstrates the
|
|
configuration available to the relay. This file is optional, but may
|
|
be mounted into a docker container like so:
|
|
|
|
```console
|
|
$ docker run -it -p 7000:8080 \
|
|
--mount src=$(pwd)/config.toml,target=/usr/src/app/config.toml,type=bind \
|
|
--mount src=$(pwd)/data,target=/usr/src/app/db,type=bind \
|
|
nostr-rs-relay
|
|
```
|
|
|
|
Options include rate-limiting, event size limits, and network address
|
|
settings.
|
|
|
|
## Reverse Proxy Configuration
|
|
|
|
For examples of putting the relay behind a reverse proxy (for TLS
|
|
termination, load balancing, and other features), see [Reverse
|
|
Proxy](docs/reverse-proxy.md).
|
|
|
|
## Dev Channel
|
|
|
|
For development discussions, please feel free to use the [sourcehut
|
|
mailing list](https://lists.sr.ht/~gheartsfield/nostr-rs-relay-devel).
|
|
Or, drop by the [Nostr Telegram Channel](https://t.me/nostr_protocol).
|
|
|
|
To chat about `nostr-rs-relay` on `nostr` itself; visit our channel on [anigma](https://anigma.io/) or another client that supports [NIP-28](https://github.com/nostr-protocol/nips/blob/master/28.md) chats:
|
|
* `2ad246a094fee48c6e455dd13d759d5f41b5a233120f5719d81ebc1935075194`
|
|
|
|
License
|
|
---
|
|
This project is MIT licensed.
|
|
|
|
External Documentation and Links
|
|
---
|
|
|
|
* [BlockChainCaffe's Nostr Relay Setup Guide](https://github.com/BlockChainCaffe/Nostr-Relay-Setup-Guide)
|