Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/atdixon/me.untethr.nostr-relay
A fast nostr relay, written in Clojure.
https://github.com/atdixon/me.untethr.nostr-relay
nostr
Last synced: 24 days ago
JSON representation
A fast nostr relay, written in Clojure.
- Host: GitHub
- URL: https://github.com/atdixon/me.untethr.nostr-relay
- Owner: atdixon
- Created: 2022-01-26T02:56:56.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-31T23:20:53.000Z (almost 2 years ago)
- Last Synced: 2024-08-04T11:01:15.131Z (4 months ago)
- Topics: nostr
- Language: Clojure
- Homepage:
- Size: 298 KB
- Stars: 44
- Watchers: 4
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-nostr - me.untethr.nostr-relay - relay.svg?style=social) - a relay written in Clojure (Relays / Implementations)
README
## me.untethr.nostr-relay
A [nostr](https://github.com/fiatjaf/nostr/) relay, written in Clojure, backed by sqlite3.
**Supported NIPs**: [NIP-01](https://github.com/nostr-protocol/nips/blob/master/01.md),
[NIP-02](https://github.com/nostr-protocol/nips/blob/master/02.md),
[NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md),
[NIP-11](https://github.com/nostr-protocol/nips/blob/master/11.md),
[NIP-12](https://github.com/nostr-protocol/nips/blob/master/12.md),
[NIP-15](https://github.com/nostr-protocol/nips/blob/master/15.md),
[NIP-16](https://github.com/nostr-protocol/nips/blob/master/16.md),
[NIP-20](https://github.com/nostr-protocol/nips/blob/master/20.md),
[NIP-22](https://github.com/nostr-protocol/nips/blob/master/22.md),
[NIP-42](https://github.com/nostr-protocol/nips/blob/master/42.md)
([NIP-09](https://github.com/nostr-protocol/nips/blob/master/09.md),
[NIP-26](https://github.com/nostr-protocol/nips/blob/master/26.md),
[NIP-33](https://github.com/nostr-protocol/nips/blob/master/33.md),
[NIP-40](https://github.com/nostr-protocol/nips/blob/master/40.md),
[NIP-50](https://github.com/nostr-protocol/nips/blob/master/50.md) not yet
supported, but please request with your client & use case if you're interested.)
### Project Goals
* solid [nips](https://github.com/nostr-protocol/nips) coverage & data completeness + accuracy
* speed and performance on modest hardware
### Run Locally
For a [real deployment](#how-to-deploy), you'll want to deploy with ssl
termination (e.g. using [ngnix](https://www.nginx.com/)) but for local testing,
simply:
```
$ brew install clojure/tools/clojure
$ make run
```
The relay will be reachable at `ws://localhost:9090` and data
in a git-ignored `./n.db` sqlite file
With various app metrics available at `http://localhost:9090/metrics`.
Edit `./conf/relay.yaml` to change port, file, etc.
### Known Deployments
* wss://nostr-relay.untethr.me
* wss://relay.kronkltd.net
### How to Deploy
Use a latest release from [releases](https://github.com/atdixon/me.untethr.nostr-relay/releases/).
A released `tar.gz` archive has these contents:
```
me.untethr.nostr-relay.jar
conf/relay.yaml
conf/nip05.json
conf/nip11.json
conf/logback.xml
```
Unpack on server, update config files to your personal liking (note: leave
the "supported_nips" and "version" as-is in the `nip11.json` file), and run
(using java 11+):
```
$ java -Xms1g -Xmx1g \
-Dlogback.configurationFile=conf/logback.xml \
-cp me.untethr.nostr-relay.jar \
clojure.main -m me.untethr.nostr.app
```
This runs the relay on the port specified in `conf/relay.yaml` (default 9090).
You'll want your users to hit a reverse proxy, configured to serve SSL traffic
(wss://...) and proxy to the relay server.
See [Deploy](./doc/deploy.md) for more information on how to run a real
deployment.
### Develop
The best place to start reading the code is from the `-main` method in the
well-documented [me.untethr.nostr.app](./src/me/untethr/nostr/app.clj) namespace.
If you're developing you can build a jar or deployment archive from latest
source, like so:
```
$ make uberjar
```
or
```
$ make deploy-archive
```