jcgruenhage/cloudflare-ddns-service
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

docs: Update README with Cloudflare setup info

Browse source
This commit is contained in:
Rostislav Raykov 2019-09-18 10:25:48 +02:00
parent 5c19f6e387
commit c8d1493650
1 changed files with 13 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -12,4 +12,16 @@ This is a simple CLI you can use to continuously update an A DNS record for a do
-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`.