bedc378624
Updating async-trait v0.1.53 -> v0.1.56 Updating bumpalo v3.9.1 -> v3.10.0 Updating crossbeam-utils v0.8.8 -> v0.8.10 Updating crypto-common v0.1.3 -> v0.1.4 Updating getrandom v0.2.6 -> v0.2.7 Updating http v0.2.7 -> v0.2.8 Updating indexmap v1.8.2 -> v1.9.1 Updating js-sys v0.3.57 -> v0.3.58 Updating linked-hash-map v0.5.4 -> v0.5.6 Updating mio v0.8.3 -> v0.8.4 Updating once_cell v1.12.0 -> v1.12.1 Updating openssl-sys v0.9.73 -> v0.9.74 Removing parking_lot v0.11.2 Removing parking_lot_core v0.8.5 Updating proc-macro2 v1.0.39 -> v1.0.40 Updating quote v1.0.18 -> v1.0.20 Updating r2d2 v0.8.9 -> v0.8.10 Updating ron v0.7.0 -> v0.7.1 Updating serde v1.0.137 -> v1.0.138 Updating serde_derive v1.0.137 -> v1.0.138 Updating serde_json v1.0.81 -> v1.0.82 Updating smallvec v1.8.0 -> v1.9.0 Updating syn v1.0.95 -> v1.0.98 Updating tokio v1.18.2 -> v1.19.2 Updating tokio-macros v1.7.0 -> v1.8.0 Updating tokio-util v0.7.2 -> v0.7.3 Updating tower-service v0.3.1 -> v0.3.2 Updating tracing v0.1.34 -> v0.1.35 Removing tracing-attributes v0.1.21 Updating tracing-core v0.1.26 -> v0.1.28 Updating unicode-ident v1.0.0 -> v1.0.1 Updating unicode-normalization v0.1.19 -> v0.1.21 Updating wasm-bindgen v0.2.80 -> v0.2.81 Updating wasm-bindgen-backend v0.2.80 -> v0.2.81 Updating wasm-bindgen-macro v0.2.80 -> v0.2.81 Updating wasm-bindgen-macro-support v0.2.80 -> v0.2.81 Updating wasm-bindgen-shared v0.2.80 -> v0.2.81 Updating web-sys v0.3.57 -> v0.3.58 |
||
|---|---|---|
| docs | ||
| src | ||
| .gitignore | ||
| Cargo.lock | ||
| Cargo.toml | ||
| config.toml | ||
| Dockerfile | ||
| LICENSE | ||
| 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 has a SQLite persistence layer.
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: Core event model
- NIP-01: Hide old metadata events
- NIP-01: Id/Author prefix search (experimental)
- NIP-02: Hide old contact list events
- NIP-03: OpenTimestamps
- NIP-05: Mapping Nostr keys to DNS identifiers
- NIP-09: Event deletion
- NIP-11: Relay information document
- NIP-12: Generic tag search (experimental)
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).
$ docker build -t nostr-rs-relay .
$ docker run -it -p 7000:8080 \
--mount src=$(pwd)/data,target=/usr/src/app/db,type=bind nostr-rs-relay
[2021-12-31T19:58:31Z INFO nostr_rs_relay] listening on: 0.0.0.0:8080
[2021-12-31T19:58:31Z INFO nostr_rs_relay::db] opened database "/usr/src/app/db/nostr.db" for writing
[2021-12-31T19:58:31Z INFO nostr_rs_relay::db] DB version = 2
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.
License
This project is MIT licensed.