Neshura/cloudflare-dns-updater
Neshura/cloudflare-dns-updater
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases 37 Packages Activity Actions

Updated Readme

Browse source
This commit is contained in:
Neshura 2023-12-29 00:38:27 +01:00
parent 1c0bb64572
commit ee2b492851
Signed by: Neshura
GPG key ID: B6983AAA6B9A7A6C
1 changed files with 7 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -7,23 +7,18 @@
The application necessarily requires a valid Cloudflare API Token.
Further the application must be located in the same network as the configured zones.
| Environment Variable | Required | Usage |
|:--------------------:|:--------:|:----------------------------------:|
| CF_API_TOKEN | x | Cloudflare API Token |
| STATUS_POST_URL | | Post Endpoint for a Uptime Monitor |
*Note: Variables can be stored in a .env file*
The actual configuration happens in two or more files:
The actual configuration happens in three or more files:
`config.toml` contains general configuration parameters for the application
`interfaces.toml` contains all IPv6 interfaces available/used by the zone config files.
`.toml` files in `zone.d` contain settings for individual zones.
Example:
*.env*
```text
CF_API_TOKEN=0123456789abcdef0123456789abcdef01234
CHECK_INTERVAL_SECONDS=30 // Defaults to 60 if missing
UPTIME_URL=https://example.org/uptime/id12 // Entirely optional
*config.toml*
```toml
cf_api_token = "0123456789abcdef0123456789abcdef01234" # Cloudflare API Token
check_interval_seconds = 30 # Defaults to 60 if missing
uptime_url = "https://example.org/uptime/id12" # Post Endpoint for a Uptime Monitor
```
*interfaces.toml*