cloudflare-ddns-service/README.md

# CloudFlare DDNS update tool

![](https://github.com/zbrox/cloudflare-ddns/workflows/Build/badge.svg)

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

```
    -t, --token <api-token>     The API token 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
    -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
api_token = "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 token

We need to authenticate ourselves in front of the Cloudflare API. To do so we need to an API token to pass along with every request. You can generate an API token to use specifically with this application on Cloudflare in `My profile > API Tokens > Create Token`.
docs: Add a short and not very good README 2019-09-17 23:51:33 +00:00			`# CloudFlare DDNS update tool`

docs: Add GH actions build badge to README 2019-09-18 00:23:07 +00:00			`![](https://github.com/zbrox/cloudflare-ddns/workflows/Build/badge.svg)`

docs: Add a short and not very good README 2019-09-17 23:51:33 +00:00			`This is a simple CLI you can use to continuously update an A DNS record for a domain using CloudFlare's free DDNS service.`

docs: Update README with CLI arguments 2019-09-18 08:15:11 +00:00			`## Options`

			```
docs: Update readme with 0.3.0 API changes 2020-04-21 08:03:17 +00:00			`-t, --token <api-token> The API token you need to generate in your Cloudflare profile`
docs: Update README with info on new config option 2019-09-23 09:03:00 +00:00			`-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`
docs: Update README with CLI arguments 2019-09-18 08:15:11 +00:00			`-d, --domain <domain> The domain for which you want to report the current IP address`
			`-z, --zone <zone> The zone in which your domain is (usually that is your base domain name)`
docs: Update README with Cloudflare setup info 2019-09-18 08:25:48 +00:00			```

docs: Update README with info on new config option 2019-09-23 09:03:00 +00:00			`### 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
docs: Update readme with 0.3.0 API changes 2020-04-21 08:03:17 +00:00			`api_token = "secretkey"`
docs: Update README with info on new config option 2019-09-23 09:03:00 +00:00			`domain = "example.example.com"`
			`zone = "example.com"`
			```

docs: Update README with Cloudflare setup info 2019-09-18 08:25:48 +00:00			`## 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.

docs: Update readme with 0.3.0 API changes 2020-04-21 08:03:17 +00:00			`### API token`
docs: Update README with Cloudflare setup info 2019-09-18 08:25:48 +00:00
docs: Update readme with 0.3.0 API changes 2020-04-21 08:03:17 +00:00			We need to authenticate ourselves in front of the Cloudflare API. To do so we need to an API token to pass along with every request. You can generate an API token to use specifically with this application on Cloudflare in `My profile > API Tokens > Create Token`.