Skip to content

Commit 3fbebaf

Browse files
committed
doc: add sample settings file
1 parent 951e1c2 commit 3fbebaf

File tree

2 files changed

+38
-1
lines changed

2 files changed

+38
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,8 +116,10 @@ You can change the default folder by setting the `NOSTR_CONFIG_DIR` environment
116116
Run nostr-ts-relay using one of the quick-start guides at least once and `~/.nostr/settings.json` will be created.
117117
Any changes made to the settings file will be read on the next start.
118118

119-
See [CONFIGURATION.md](CONFIGURATION.md) for a detailed explanation of each environment variable and setting.
119+
A sample settings file is included at the project root under the name `settings.sample.json`. Feel free to copy it to `~/.nostr/settings.json`
120+
if you would like to have a settings file before running the relay first.
120121

122+
See [CONFIGURATION.md](CONFIGURATION.md) for a detailed explanation of each environment variable and setting.
121123
## Dev Channel
122124

123125
For development discussions, please use the [Nostr Typescript Relay Dev Channel](https://t.me/nostr_ts_relay).

settings.sample.json

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
{
2+
"info": {
3+
"relay_url": "wss://nostr-ts-relay.your-domain.com",
4+
"name": "nostr-ts-relay.your-domain.com",
5+
"description": "A nostr relay written in Typescript.",
6+
"pubkey": "replace-with-your-pubkey",
7+
"contact": "[email protected]"
8+
},
9+
"limits": {
10+
"event": {
11+
"eventId": {
12+
"minLeadingZeroBits": 0
13+
},
14+
"kind": {
15+
"whitelist": [],
16+
"blacklist": []
17+
},
18+
"pubkey": {
19+
"minLeadingZeroBits": 0,
20+
"whitelist": [],
21+
"blacklist": []
22+
},
23+
"createdAt": {
24+
"maxPositiveDelta": 900,
25+
"maxNegativeDelta": 0
26+
}
27+
},
28+
"client": {
29+
"subscription": {
30+
"maxSubscriptions": 10,
31+
"maxFilters": 10
32+
}
33+
}
34+
}
35+
}

0 commit comments

Comments
 (0)