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

docs: Update README with info on new config option

Browse source
This commit is contained in:
Rostislav Raykov 2019-09-23 11:03:00 +02:00
parent 8cbad9d7f1
commit 44d2279271
1 changed files with 15 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -8,12 +8,26 @@ This is a simple CLI you can use to continuously update an A DNS record for a do
``` ```
-k, --key <auth-key> The auth key you need to generate in your Cloudflare profile -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) -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 -d, --domain <domain> The domain for which you want to report the current IP address
-e, --email <email> Your Cloudflare login email -e, --email <email> Your Cloudflare login email
-z, --zone <zone> The zone in which your domain is (usually that is your base domain name) -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 ## 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. 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.