Skip to content

Commit a788c03

Browse files
committed
docs: add nip-20 support, redis
1 parent b36b625 commit a788c03

File tree

2 files changed

+27
-5
lines changed

2 files changed

+27
-5
lines changed

README.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,18 +51,25 @@ NIPs with a relay-specific implementation are listed here.
5151
- [x] NIP-13: Proof of Work
5252
- [x] NIP-15: End of Stored Events Notice
5353
- [x] NIP-16: Event Treatment
54+
- [x] NIP-20: Command Results
5455
- [x] NIP-22: Event `created_at` Limits
5556
- [x] NIP-26: Delegated Event Signing
5657
- [x] NIP-33: Parameterized Replaceable Events
5758

5859
## Requirements
5960

60-
- PostgreSQL 15.0 (For standalone steps only)
61+
### Standalone setup
62+
- PostgreSQL 15.0
63+
- Redis
6164
- Node v18
6265
- Typescript
63-
- Docker (For docker steps only, version 20 or higher)
6466

65-
## Quick Start (Docker Compose) (Best)
67+
### Docker setups
68+
- Node v18
69+
- Docker v20.10
70+
- Docker compose v2.10
71+
72+
## Quick Start (Docker Compose)
6673

6774
Install Docker following the [official guide](https://docs.docker.com/engine/install/).
6875
You may have to uninstall Docker if you installed it using a different guide.
@@ -75,7 +82,7 @@ Clone repository and enter directory:
7582

7683
Start with:
7784
```
78-
npm run docker:compose:start &
85+
npm run docker:compose:start -- --detach
7986
```
8087

8188
Stop the server with:
@@ -84,6 +91,7 @@ Stop the server with:
8491
```
8592

8693
## Quick Start (over Tor)
94+
`Docker` `Tor`
8795

8896
Install Docker following the [official guide](https://docs.docker.com/engine/install/).
8997
You may have to uninstall Docker if you installed it using a different guide.
@@ -96,7 +104,7 @@ Clone repository and enter directory:
96104

97105
Start with:
98106
```
99-
npm run tor:docker:compose:start &
107+
npm run tor:docker:compose:start
100108
```
101109

102110
Print the Tor hostname:
@@ -119,6 +127,10 @@ Set the following environment variables:
119127
DB_NAME=nostr_ts_relay
120128
DB_USER=postgres
121129
DB_PASSWORD=postgres
130+
REDIS_HOST=localhost
131+
REDIS_PORT=6379
132+
REDIS_USER=default
133+
REDIS_PASSWORD=nostr_ts_relay
122134
```
123135

124136
Create `nostr_ts_relay` database:
@@ -129,6 +141,15 @@ Create `nostr_ts_relay` database:
129141
postgres=# quit
130142
```
131143

144+
Start Redis and use `redis-cli` to set the default password and verify:
145+
```
146+
$ redis-cli
147+
127.0.0.1:6379> CONFIG SET requirepass "nostr_ts_relay"
148+
OK
149+
127.0.0.1:6379> AUTH nostr_ts_relay
150+
Ok
151+
```
152+
132153
Clone repository and enter directory:
133154
```
134155
git clone [email protected]:Cameri/nostr-ts-relay.git

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
12,
1212
15,
1313
16,
14+
20,
1415
22,
1516
26,
1617
33

0 commit comments

Comments
 (0)