Skip to content

Commit

Permalink
docs: Update README and examples
Browse files Browse the repository at this point in the history
  • Loading branch information
lovelaze committed Mar 5, 2025
1 parent 391315b commit d191a5a
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 1 deletion.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ services:
- PRIMARY=http://ph1.example.com|password
- REPLICAS=http://ph2.example.com|password,http://ph3.example.com|password
- FULL_SYNC=true
- RUN_GRAVITY=true
- CRON=0 * * * *
```
Expand All @@ -55,6 +56,7 @@ docker run --rm \
-e PRIMARY="http://ph1.example.com|password" \
-e REPLICAS="http://ph2.example.com|password" \
-e FULL_SYNC=true \
-e RUN_GRAVITY=true \
ghcr.io/lovelaze/nebula-sync:latest
```

Expand All @@ -80,6 +82,7 @@ The following environment variables can be specified:
| Name | Default | Example | Description |
|------------------------------------|---------|-----------------|----------------------------------------------------|
| `CRON` | n/a | `0 * * * *` | Specifies the cron schedule for synchronization |
| `RUN_GRAVITY` | false | true | Specifies whether to run gravity after syncing |
| `TZ` | n/a | `Europe/London` | Specifies the timezone for logs and cron |
| `CLIENT_SKIP_TLS_VERIFICATION` | false | true | Skips SSL certificate verification |

Expand Down
3 changes: 2 additions & 1 deletion examples/.env_full
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
PRIMARY=http://ph1.example.com|password
REPLICAS=http://ph2.example.com|password
FULL_SYNC=true
CRON=0 * * * *
RUN_GRAVITY=true
CRON=0 * * * *
1 change: 1 addition & 0 deletions examples/.env_manual
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
PRIMARY=http://ph1.example.com|password
REPLICAS=http://ph2.example.com|password
FULL_SYNC=false
RUN_GRAVITY=true
CRON=0 * * * *

SYNC_CONFIG_DNS=true
Expand Down

0 comments on commit d191a5a

Please sign in to comment.