diff options
Diffstat (limited to 'docs/reference')
| -rw-r--r-- | docs/reference/configuration.md | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/docs/reference/configuration.md b/docs/reference/configuration.md index 80ae45c..204fbd1 100644 --- a/docs/reference/configuration.md +++ b/docs/reference/configuration.md | |||
| @@ -269,28 +269,29 @@ NGIT_DATABASE_BACKEND=lmdb | |||
| 269 | 269 | ||
| 270 | These options configure the proactive sync feature that synchronizes events from other relays. | 270 | These options configure the proactive sync feature that synchronizes events from other relays. |
| 271 | 271 | ||
| 272 | #### `NGIT_SYNC_RELAY_URL` | 272 | #### `NGIT_SYNC_BOOTSTRAP_RELAY_URL` |
| 273 | 273 | ||
| 274 | **Description:** URL of the primary relay to sync events from | 274 | **Description:** URL of the bootstrap relay to initially sync events from |
| 275 | **Type:** String (WebSocket URL) | 275 | **Type:** String (WebSocket URL) |
| 276 | **Default:** None (sync disabled) | 276 | **Default:** None (relay discovery only) |
| 277 | **Required:** No | 277 | **Required:** No |
| 278 | 278 | ||
| 279 | **Examples:** | 279 | **Examples:** |
| 280 | ```bash | 280 | ```bash |
| 281 | # Sync from a public relay | 281 | # Sync from a public relay |
| 282 | NGIT_SYNC_RELAY_URL=wss://relay.example.com | 282 | NGIT_SYNC_BOOTSTRAP_RELAY_URL=wss://relay.example.com |
| 283 | 283 | ||
| 284 | # Sync from another GRASP relay | 284 | # Sync from another GRASP relay |
| 285 | NGIT_SYNC_RELAY_URL=wss://git.nostr.dev | 285 | NGIT_SYNC_BOOTSTRAP_RELAY_URL=wss://git.nostr.dev |
| 286 | 286 | ||
| 287 | # Local testing | 287 | # Local testing |
| 288 | NGIT_SYNC_RELAY_URL=ws://127.0.0.1:8081 | 288 | NGIT_SYNC_BOOTSTRAP_RELAY_URL=ws://127.0.0.1:8081 |
| 289 | ``` | 289 | ``` |
| 290 | 290 | ||
| 291 | **Notes:** | 291 | **Notes:** |
| 292 | - When set, enables proactive sync feature | 292 | - Bootstrap relay provides initial sync source on startup |
| 293 | - The relay will discover additional relays from repository announcements | 293 | - Additional relays are **automatically discovered** from repository announcements that list our service |
| 294 | - Even without a bootstrap relay, sync will discover relays from stored announcements | ||
| 294 | - Synced events go through the same validation as directly-submitted events | 295 | - Synced events go through the same validation as directly-submitted events |
| 295 | - Use WebSocket protocol (`ws://` or `wss://`) | 296 | - Use WebSocket protocol (`ws://` or `wss://`) |
| 296 | 297 | ||