diff --git a/README.md b/README.md index db7b52d..ea6ecac 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# CloudflareDDNS {ignore=true} +# CloudflareDDNS Update your CloudFlare DNS records with your current (dynamic) IP address via systemd timers and a bash script. @@ -7,24 +7,19 @@ # CloudflareDDNS {ignore=true} auto-update itself. However, you MUST update the systemd service file *(cfddns.service)* *ExecStart* line manually as explained below.** -## Contents {ignore=true} - - - +## Contents * [cfddns.sh](#cfddns46sh) - * [Installation:](#installation) - * [Usage:](#usage) + * [Installation:](#installation) + * [Usage:](#usage) * [cfddns.service](#cfddnsservice) - * [IP4 and/or IP6](#ip4-andor-ip6) - * [Examples](#examples) + * [IP4 and/or IP6](#ip4-andor-ip6) + * [Examples](#examples) * [cfddns.timer](#cfddnstimer) - * [Activation](#activation) + * [Activation](#activation) * [The log file](#the-log-file) * [Final thoughts](#final-thoughts) - - ## cfddns.sh #### Installation: @@ -71,9 +66,12 @@ #### Usage: You should be able to find this on the Overview page of your CloudFlare dashboard. Your completed file should look like (these are not real credentials): -> johndoe@example.com -> e7882db52804aca6fab22780e055b97056466 -> 492af8aa69f8c44baf043342c74319fd + +``` +johndoe@example.com +e7882db52804aca6fab22780e055b97056466 +492af8aa69f8c44baf043342c74319fd +``` Your global API-key is equivalent to your account password, so you should secure this file by changing the owner of the file to root @@ -172,8 +170,7 @@ #### Examples ```Ini [Service] Type=oneshot - ExecStart=/usr/local/bin/cfddns.sh -f /root/accountDetails.cloudflare - -r mail.example.com -l /var/log/cfddns.log + ExecStart=/usr/local/bin/cfddns.sh -f /root/accountDetails.cloudflare -r mail.example.com -l /var/log/cfddns.log ... ``` @@ -185,8 +182,7 @@ #### Examples ```Ini [Service] Type=oneshot - ExecStart=/usr/local/bin/cfddns.sh -6 -f /home/johndoe/account.details - -r git.example.com -r mail.example.com + ExecStart=/usr/local/bin/cfddns.sh -6 -f /home/johndoe/account.details -r git.example.com -r mail.example.com ... ``` @@ -199,10 +195,8 @@ #### Examples ```Ini [Service] Type=oneshot - ExecStart=/usr/local/bin/cfddns.sh -f /dir1/account.cf -r mail.example.com - -l /var/log/DDNS_IP4.log - ExecStart=/usr/local/bin/cfddns.sh -6 -f /dir2/cloudflare.details - -r mail.example.com -r git.example.com -l /var/log/DDNS_IP6.log + ExecStart=/usr/local/bin/cfddns.sh -f /dir1/account.cf -r mail.example.com -l /var/log/DDNS_IP4.log + ExecStart=/usr/local/bin/cfddns.sh -6 -f /dir2/cloudflare.details -r mail.example.com -r git.example.com -l /var/log/DDNS_IP6.log ... ```