ffe7aac066
Updating aho-corasick v0.7.19 -> v0.7.20 Updating async-trait v0.1.58 -> v0.1.59 Updating axum v0.5.17 -> v0.6.1 Updating axum-core v0.2.9 -> v0.3.0 Updating bytes v1.2.1 -> v1.3.0 Updating cc v1.0.76 -> v1.0.78 Updating crossbeam-utils v0.8.12 -> v0.8.14 Updating cxx v1.0.82 -> v1.0.83 Updating cxx-build v1.0.82 -> v1.0.83 Updating cxxbridge-flags v1.0.82 -> v1.0.83 Updating cxxbridge-macro v1.0.82 -> v1.0.83 Updating flate2 v1.0.24 -> v1.0.25 Updating libc v0.2.137 -> v0.2.138 Updating matchit v0.5.0 -> v0.7.0 Updating miniz_oxide v0.5.4 -> v0.6.2 Updating openssl v0.10.42 -> v0.10.44 Updating openssl-sys v0.9.77 -> v0.9.79 Updating parking_lot_core v0.9.4 -> v0.9.5 Updating pest v2.4.1 -> v2.5.1 Updating pest_derive v2.4.1 -> v2.5.1 Updating pest_generator v2.4.1 -> v2.5.1 Updating pest_meta v2.4.1 -> v2.5.1 Updating prost v0.11.2 -> v0.11.3 Adding rustversion v1.0.9 Updating serde v1.0.147 -> v1.0.150 Updating serde_derive v1.0.147 -> v1.0.150 Updating serde_json v1.0.88 -> v1.0.89 Updating sha-1 v0.10.0 -> v0.10.1 Updating syn v1.0.103 -> v1.0.105 Updating tokio v1.22.0 -> v1.23.0 Updating tokio-macros v1.8.0 -> v1.8.2 Updating toml v0.5.9 -> v0.5.10 Updating tonic v0.8.2 -> v0.8.3 Updating tower-http v0.3.4 -> v0.3.5 Updating typenum v1.15.0 -> v1.16.0 |
||
---|---|---|
.cargo | ||
docs | ||
src | ||
tests | ||
.build.yml | ||
.gitignore | ||
.pre-commit-config.yaml | ||
Cargo.lock | ||
Cargo.toml | ||
config.toml | ||
Dockerfile | ||
LICENSE | ||
mk-platform-agnostic-dockerfile.sh | ||
README.md | ||
reverse-proxy.md | ||
rustfmt.toml |
nostr-rs-relay
This is a nostr relay, written in Rust. It currently supports the entire relay protocol, and persists data with SQLite.
The project master repository is available on sourcehut, and is mirrored on GitHub.
Features
NIPs with a relay-specific implementation are listed here.
- NIP-01: Basic protocol flow description
- Core event model
- Hide old metadata events
- Id/Author prefix search
- NIP-02: Contact List and Petnames
- NIP-03: OpenTimestamps Attestations for Events
- NIP-05: Mapping Nostr keys to DNS-based internet identifiers
- NIP-09: Event Deletion
- NIP-11: Relay Information Document
- NIP-12: Generic Tag Queries
- NIP-15: End of Stored Events Notice
- NIP-16: Event Treatment
- NIP-20: Command Results
- NIP-22: Event
created_at
limits (future-dated events only) - NIP-26: Event Delegation
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.
$ 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
to publish and query
events.
$ 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
Configuration
The sample config.toml
file demonstrates the
configuration available to the relay. This file is optional, but may
be mounted into a docker container like so:
$ 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.
Dev Channel
For development discussions, please feel free to use the sourcehut mailing list. Or, drop by the Nostr Telegram Channel.
To chat about nostr-rs-relay
on nostr
itself; visit our channel on anigma or another client that supports NIP-28 chats:
2ad246a094fee48c6e455dd13d759d5f41b5a233120f5719d81ebc1935075194
License
This project is MIT licensed.