Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/barkyq/gnost-relay
nostr relay written in go
https://github.com/barkyq/gnost-relay
nostr
Last synced: 3 months ago
JSON representation
nostr relay written in go
- Host: GitHub
- URL: https://github.com/barkyq/gnost-relay
- Owner: barkyq
- License: gpl-3.0
- Created: 2023-02-02T01:36:04.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-06T00:48:25.000Z (about 1 year ago)
- Last Synced: 2024-05-30T08:00:11.611Z (5 months ago)
- Topics: nostr
- Language: Go
- Homepage:
- Size: 72.3 KB
- Stars: 42
- Watchers: 3
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-nostr - gnost-relay - relay.svg?style=social) - nostr relay written in go backed by postgresql database. (Relays / Implementations)
README
# gnost-relay
Nostr relay written in go
## Features
- NIPs supported: [1][1], [9][9], [11][11], [12][12], [15][15], [16][16], [20][20], [26][26], [28][28], [33][33], [40][40], [42][42].
- Websocket compression support (`permessage-deflate`), with support for client and server context takeover (i.e., sliding window support).
- Hot config reloading. Edits to the `config.json` file will be instantly applied without requiring restart.
- `--import` command line flag allows new events to be added via `stdin`. Events should be in `jsonl` format. Use in conjunction with [gnost-deflate-client][gnost-deflate-client]
- Event handling logic happens via SQL triggers (i.e., NIPs [9][9], [16][16], [33][33], [40][40]).
- New events are notified to listeners via postgresql's built in `pg_notify` feature. This implies that different instances of `gnost-relay` can be run concurrently. Indeed, any software which writes to the DB will automatically notify listeners connected to the relay.
- Memory allocations are minimized using pools.
- Token bucket style rate limiters for handling the messages are enabled on each websocket connection.
## Example usage
#### Running the relay
```zsh
DATABASE_URL=postgres://x gnost-relay --config config.json
```
#### Importing events
With `keepalive` set, the connection will remain open, and new events will be added to the `gnost-relay` database, and notified to any listeners. See [gnost-deflate-client][gnost-deflate-client] for more info.
```zsh
echo '[{"since":1676863922,"kinds":[1]}]' |\
gnost-deflate-client --port 443 --scheme wss --host nos.lol --keepalive 30 --output - |\
DATABASE_URL=postgres://x gnost-relay --import
```
[1]: https://github.com/nostr-protocol/nips/blob/master/01.md
[9]: https://github.com/nostr-protocol/nips/blob/master/09.md
[11]: https://github.com/nostr-protocol/nips/blob/master/11.md
[12]: https://github.com/nostr-protocol/nips/blob/master/12.md
[15]: https://github.com/nostr-protocol/nips/blob/master/15.md
[16]: https://github.com/nostr-protocol/nips/blob/master/16.md
[20]: https://github.com/nostr-protocol/nips/blob/master/20.md
[26]: https://github.com/nostr-protocol/nips/blob/master/26.md
[28]: https://github.com/nostr-protocol/nips/blob/master/28.md
[33]: https://github.com/nostr-protocol/nips/blob/master/33.md
[40]: https://github.com/nostr-protocol/nips/blob/master/40.md
[42]: https://github.com/nostr-protocol/nips/blob/master/42.md
[gnost-deflate-client]: https://github.com/barkyq/gnost-deflate-client
## Installation notes
- Needs to have a `postgresql` database configured. The executable expects that the `DATABASE_URL` environment variable is set.
- Should be run with a reverse proxy in front (e.g., NGINX).
- See the [instructions](INSTALL.md) for more details.