dyndnsd/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

```
    -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)
    -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)
```

## 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`.
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`

			```
			`-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)`
			`-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)`
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.

			`### 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`.