cloudflare-dns-updater/README.md

51 lines
1.7 KiB
Markdown
Raw Permalink Normal View History

2022-11-26 19:24:15 +00:00
# Cloudflare DNS Updater
## Using the application
2022-11-26 19:24:15 +00:00
The application necessarily requires a valid Cloudflare API Token.
Further the application must be located in the same network as the configured zones.
2022-11-26 19:24:15 +00:00
2023-12-29 01:21:12 +00:00
The actual configuration happens in three or more files located in `~/.config/cloudflare-dns-updater/`:
2023-12-28 23:38:27 +00:00
`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 `zones.d` contain settings for individual zones.
2022-11-26 19:24:15 +00:00
Example:
2022-11-26 19:24:15 +00:00
2023-12-28 23:38:27 +00:00
*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
2023-12-28 21:27:08 +00:00
```
*interfaces.toml*
```toml
host_address = "::edcb:a098:7654:3210"
2023-12-25 15:23:44 +00:00
2023-12-27 20:33:35 +00:00
[interfaces]
example-interface = "::0123:4567:890a:bcde" # static part of the IP, the rest will be dynamically generated using the host
```
2022-11-26 19:24:15 +00:00
*zones.d/example.org.toml*
```toml
email = "owner@example.org" # Email of User owning the Zone
2023-12-25 15:23:44 +00:00
zone = "example.org" # Zone Name
id = "01234567890abcdefghijklmnopqrstu" # Zone ID
2022-11-26 19:24:15 +00:00
[[entry]]
2023-12-27 20:33:35 +00:00
name = "example.org" # "@" Symbol is not currently supported
type = ["AAAA", "A"] # Options are: "A" (IPv4/A Record) and/or "AAAA" (IPv6/AAAA Record)
interface = "example-interface" # Only required on type values 6 and 10
```
2022-11-26 19:24:15 +00:00
## Debian Repository
2023-12-29 01:19:31 +00:00
Currently supported:
- Debian 12 'Bookworm'
Includes systemd system and user unit files
For more details see [the package registry](https://forgejo.neshweb.net/Neshura/-/packages/debian/cloudflare-dns-updater)