2021-12-11 23:19:49 -05:00
# [nostr-rs-relay](https://git.sr.ht/~gheartsfield/nostr-rs-relay)
2021-12-11 16:58:45 -05:00
2022-09-18 11:30:25 -04:00
This is a [nostr ](https://github.com/nostr-protocol/nostr ) relay, written in
2021-12-11 16:58:45 -05:00
Rust. It currently supports the entire relay protocol, and has a
SQLite persistence layer.
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 ).
2022-09-10 23:53:41 -04:00
[](https://builds.sr.ht/~gheartsfield/nostr-rs-relay/commits/master?)
2022-09-10 23:48:23 -04:00
2022-01-16 09:16:42 -05:00
## Features
2022-09-18 11:30:25 -04:00
[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-22: [Event `created_at` limits (_future-dated events only_) ](https://github.com/nostr-protocol/nips/blob/master/22.md )
2022-01-16 09:16:42 -05:00
2021-12-11 23:19:49 -05:00
## Quick Start
2021-12-31 15:08:04 -05:00
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).
2021-12-11 23:19:49 -05:00
```console
$ docker build -t nostr-rs-relay .
2021-12-31 15:08:04 -05:00
$ docker run -it -p 7000:8080 \
2021-12-31 16:28:26 -05:00
--mount src=$(pwd)/data,target=/usr/src/app/db,type=bind nostr-rs-relay
2021-12-31 15:08:04 -05:00
[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
2021-12-11 23:19:49 -05:00
```
2021-12-31 15:08:04 -05:00
Use a `nostr` client such as
[`noscl` ](https://github.com/fiatjaf/noscl ) to publish and query
events.
2021-12-11 23:19:49 -05:00
```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
```
2022-01-01 13:27:09 -05:00
A pre-built container is also available on DockerHub:
2022-01-20 23:02:42 -05:00
https://hub.docker.com/r/scsibug/nostr-rs-relay
2022-01-01 13:27:09 -05:00
2021-12-31 15:08:04 -05:00
## Configuration
2022-01-15 12:41:31 -05:00
The sample [`config.toml` ](config.toml ) file demonstrates the
2021-12-31 15:08:04 -05:00
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 \
2021-12-31 16:28:26 -05:00
nostr-rs-relay
2021-12-31 15:08:04 -05:00
```
Options include rate-limiting, event size limits, and network address
settings.
2022-01-15 12:41:31 -05:00
## Reverse Proxy Configuration
For examples of putting the relay behind a reverse proxy (for TLS
termination, load balancing, and other features), see [Reverse
Proxy](reverse-proxy.md).
2022-01-17 09:35:13 -05:00
## Dev Channel
2022-02-28 18:19:24 -05:00
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 ).
2022-01-17 09:35:13 -05:00
2022-09-10 20:45:23 -04:00
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`
2021-12-11 16:58:45 -05:00
License
---
This project is MIT licensed.
