41 lines
2.2 KiB
Markdown
41 lines
2.2 KiB
Markdown
# CloudFlare DDNS update tool
|
|
|
|
|
|
|
|
This is a simple CLI you can use to continuously update an A DNS record for a domain using CloudFlare's free DDNS service.
|
|
|
|
## Options
|
|
|
|
```
|
|
-k, --key <auth-key> The auth key you need to generate in your Cloudflare profile
|
|
-c, --cache <cache> Cache file for previously reported IP address (if skipped the IP will be reported on every
|
|
execution)
|
|
-f, --config <config> Your TOML config file containing all the required options (email, auth_key, zone, domain)
|
|
which you can use instead of passing the arguments to the command line
|
|
-d, --domain <domain> The domain for which you want to report the current IP address
|
|
-e, --email <email> Your Cloudflare login email
|
|
-z, --zone <zone> The zone in which your domain is (usually that is your base domain name)
|
|
```
|
|
|
|
### Config
|
|
|
|
You Can pass a path to a configuration file (`-f` or `--config`) instead of each option as a command line argument. The configuration should be a [TOML](https://github.com/toml-lang/toml) file and hold the same options. Here's a sample:
|
|
|
|
```TOML
|
|
email = "example@example.com"
|
|
auth_key = "secretkey"
|
|
domain = "example.example.com"
|
|
zone = "example.com"
|
|
```
|
|
|
|
## Cloudflare Setup
|
|
|
|
You need to do some preparatory work in Cloudflare. Firstly this assumes you're using Cloudflare already to manage the DNS records for your domain.
|
|
|
|
### Initial DNS setup
|
|
|
|
You need to add a type `A` DNS record for your domain. The `Name` field you should fill in with the name of the subdomain. If you don't want to use a subdomain just type `@` then the base domain will be used. Then change the `Proxy status` field to be not `Proxied` but `DNS only`. This will allow you to input `0.0.0.0` in the `IPv4 Address` field. Then click the save button. You might need to wait sometime before the DNS record propagates.
|
|
|
|
### API key
|
|
|
|
We need to authenticate ourselves in front of the Cloudflare API. To do so we need to an auth key to pass along as a password together with our login email. You can find the global API key in `My profile > API Tokens`. |