mirror of
https://github.com/scsibug/nostr-rs-relay.git
synced 2024-11-09 21:29:06 -05:00
docs: README gives quickstart for docker
This commit is contained in:
parent
108938f709
commit
ee8862be81
23
README.md
23
README.md
|
@ -1,5 +1,4 @@
|
||||||
[nostr-rs-relay](https://git.sr.ht/~gheartsfield/nostr-rs-relay)
|
# [nostr-rs-relay](https://git.sr.ht/~gheartsfield/nostr-rs-relay)
|
||||||
===
|
|
||||||
|
|
||||||
This is a [nostr](https://github.com/fiatjaf/nostr) relay, written in
|
This is a [nostr](https://github.com/fiatjaf/nostr) relay, written in
|
||||||
Rust. It currently supports the entire relay protocol, and has a
|
Rust. It currently supports the entire relay protocol, and has a
|
||||||
|
@ -9,6 +8,26 @@ The project master repository is available on
|
||||||
[sourcehut](https://sr.ht/~gheartsfield/nostr-rs-relay/), and is
|
[sourcehut](https://sr.ht/~gheartsfield/nostr-rs-relay/), and is
|
||||||
mirrored on [GitHub](https://github.com/scsibug/nostr-rs-relay).
|
mirrored on [GitHub](https://github.com/scsibug/nostr-rs-relay).
|
||||||
|
|
||||||
|
## 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 (8090 in the example below).
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ docker build -t nostr-rs-relay .
|
||||||
|
$ docker run -p 8090:8080 --mount src=$(pwd)/nostr_data,target=/usr/src/app/db,type=bind nostr-rs-relay
|
||||||
|
```
|
||||||
|
|
||||||
|
Use a `nostr` client such as [`noscl`](https://github.com/fiatjaf/noscl) to publish and query events.
|
||||||
|
|
||||||
|
```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
|
||||||
|
```
|
||||||
|
|
||||||
License
|
License
|
||||||
---
|
---
|
||||||
This project is MIT licensed.
|
This project is MIT licensed.
|
||||||
|
|
Loading…
Reference in New Issue
Block a user