From c8d14936505e8e9a9c99a7884b73acd25d44b126 Mon Sep 17 00:00:00 2001 From: Rostislav Raykov Date: Wed, 18 Sep 2019 10:25:48 +0200 Subject: [PATCH] docs: Update README with Cloudflare setup info --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4f13c3e..83e9f05 100644 --- a/README.md +++ b/README.md @@ -12,4 +12,16 @@ This is a simple CLI you can use to continuously update an A DNS record for a do -d, --domain The domain for which you want to report the current IP address -e, --email Your Cloudflare login email -z, --zone The zone in which your domain is (usually that is your base domain name) -``` \ No newline at end of file +``` + +## 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`. \ No newline at end of file