Skip to content

docs: correct default PERIOD to 10m to match code #1148

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
buddhaCode wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: correct default PERIOD to 10m to match code #1148

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,7 @@ Note that:
| Environment variable | Default | Description |
| --- | --- | --- |
| `CONFIG` | | One line JSON object containing the entire config (takes precedence over config.json file) if specified |
| `PERIOD` | `5m` | Default period of IP address check, following [this format](https://golang.org/pkg/time/#ParseDuration) |
| `PERIOD` | `10m` | Default period of IP address check, following [this format](https://golang.org/pkg/time/#ParseDuration) |
| `PUBLICIP_FETCHERS` | `all` | Comma separated fetcher types to obtain the public IP address from `http` and `dns` |
| `PUBLICIP_HTTP_PROVIDERS` | `all` | Comma separated providers to obtain the public IP address (ipv4 or ipv6). See the [Public IP section](#public-ip) |
| `PUBLICIPV4_HTTP_PROVIDERS` | `all` | Comma separated providers to obtain the public IPv4 address only. See the [Public IP section](#public-ip) |
Expand Down Expand Up @@ -366,7 +366,7 @@ If you have a host firewall in place, this container needs the following ports:

## Architecture

At program start and every period (5 minutes by default):
At program start and every period (10 minutes by default):

1. Fetch your public IP address
1. For each record:
Expand All @@ -383,7 +383,7 @@ At program start and every period (5 minutes by default):

For Cloudflare records with the `proxied` option, the following is done.

At program start and every period (5 minutes by default), for each record:
At program start and every period (10 minutes by default), for each record:

1. Fetch your public IP address
1. For each record:
Expand Down