Skip to content

Commit 57de0fc

Browse files
committed
docs: add missing settings/env to configuration.md
1 parent 7469d97 commit 57de0fc

File tree

1 file changed

+19
-10
lines changed

1 file changed

+19
-10
lines changed

CONFIGURATION.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,26 @@
44

55
The following environment variables can be set:
66

7-
| Name | Description | Default |
8-
|------------------|--------------------------------|-------------------|
9-
| PORT | Relay's server port | 8008 |
10-
| DB_HOST | PostgresSQL Hostname | |
11-
| DB_PORT | PostgreSQL Port | |
12-
| DB_USER | PostgreSQL Username | |
13-
| DB_PASSWORD | PostgreSQL Password | |
14-
| DB_NAME | PostgreSQL Database name | |
15-
| NOSTR_CONFIG_DIR | Configuration directory | ~/.nostr/ |
7+
| Name | Description | Default |
8+
|------------------|--------------------------------|------------------------|
9+
| RELAY_PORT | Relay's server port | 8008 |
10+
| DB_HOST | PostgresSQL Hostname | |
11+
| DB_PORT | PostgreSQL Port | 5432 |
12+
| DB_USER | PostgreSQL Username | nostr_ts_relay |
13+
| DB_PASSWORD | PostgreSQL Password | nostr_ts_relay |
14+
| DB_NAME | PostgreSQL Database name | nostr_ts_relay |
15+
| DB_MIN_POOL_SIZE | Min. connections per worker | 16 |
16+
| DB_MAX_POOL_SIZE | Max. connections per worker | 32 |
17+
| REDIS_HOST | | |
18+
| REDIS_PORT | Redis Port | 6379 |
19+
| REDIS_USER | Redis User | default |
20+
| REDIS_PASSWORD | Redis Password | nostr_ts_relay |
21+
| NOSTR_CONFIG_DIR | Configuration directory | <project_root>/.nostr/ |
22+
| DEBUG | Debugging filter | |
1623

1724
# Settings
1825

19-
Running `nostr-ts-relay` for the first time creates the settings file in `~/.nostr/settings.json`. If the file is not created and an error is thrown ensure that the `~/.nostr` folder exists. The configuration directory can be changed by setting the `NOSTR_CONFIG_DIR` environment variable.
26+
Running `nostr-ts-relay` for the first time creates the settings file in `<project_root>/.nostr/settings.json`. If the file is not created and an error is thrown ensure that the `<project_root>/.nostr` folder exists. The configuration directory can be changed by setting the `NOSTR_CONFIG_DIR` environment variable.
2027

2128
| Name | Description |
2229
|---------------------------------------------|-------------------------------------------------------------------------------|
@@ -25,6 +32,8 @@ Running `nostr-ts-relay` for the first time creates the settings file in `~/.nos
2532
| info.description | Public description of your relay. (e.g. Toronto Bitcoin Group Public Relay) |
2633
| info.pubkey | Relay operator's Nostr pubkey in hex format. |
2734
| info.contact | Relay operator's contact. (e.g. mailto:[email protected]) |
35+
| network.max_payload_size | Maximum number of bytes accepted per WebSocket frame |
36+
| network.remote_ip_header | HTTP header from proxy containing IP address from client. |
2837
| workers.count | Number of workers to spin up to handle incoming connections. |
2938
| | Spin workers as many CPUs are available when set to zero. Defaults to zero. |
3039
| limits.event.eventId.minLeadingZeroBits | Leading zero bits required on every incoming event for proof of work. |

0 commit comments

Comments
 (0)