asif/CloudflareDDNS
1
0
Fork 0
Code Issues Pull Requests Releases 4 Activity

docs(script): Update embedded script examples

Browse Source 
Proofreading. Add examples of using new log backends and formats.
This commit is contained in:
Asif Bacchus
2026-07-25 01:28:47 -06:00
parent 8540fe16b2
commit 9ed3d1adc1
1 changed files with 17 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cfddns.sh
+17 -8
View File
@@ -219,22 +219,31 @@ scriptExamples() {
textBlock "${magenta}--- usage examples ---${norm}" textBlock "${magenta}--- usage examples ---${norm}"
newline newline
textBlockSwitches "${scriptName} -r myserver.mydomain.net" textBlockSwitches "${scriptName} -r myserver.mydomain.net"
textBlock "Update Cloudflare DNS records for myserver.mydomain.net with the auto-detected public IP4 address. Credentials will be expected in the default location and the log will be written in the default location also." textBlock "Update Cloudflare DNS records for 'myserver.mydomain.net' with the auto-detected public IP4 address. Credentials will be expected in the default location. The log will be written to the default location in the default JSON format."
newline newline
textBlockSwitches "${scriptName} -r myserver.mydomain.net -6" textBlockSwitches "${scriptName} -r myserver.mydomain.net -6"
textBlock "Same as above, but update AAAA host records with the auto-detected public IP6 address." textBlock "Same as above, but update AAAA host records with the auto-detected public IP6 address."
newline newline
textBlockSwitches "${scriptName} -r myserver.mydomain.net,myserver2.mydomain.net -l /var/log/cfddns.log --nc" textBlockSwitches "${scriptName} -r myserver.mydomain.net --fmt-syslog"
textBlock "Update DNS entries for both listed hosts using auto-detected IP4 address. Write a non-coloured log to '/var/log/cfddns.log'." textBlock "Same as the first example, but the log file will be written in plain-text format instead of JSON."
newline
textBlockSwitches "${scriptName} -r myserver.mydomain.net --log-console --fmt-syslog"
textBlock "Same as the first example, but the log will be written to the console (stdout) in plain-text instead of a log file."
newline
textBlockSwitches "${scriptName} -r myserver.mydomain.net --log-journal"
textBlock "Same as the first example, but the log will be written to the journal (journald) instead of a log file. A tag of 'CFDDNS' is automatically applied to make filtering easier."
newline
textBlockSwitches "${scriptName} -r myserver.mydomain.net,myserver2.mydomain.net -l /var/log/cfddns.log"
textBlock "Update DNS entries for both listed hosts using the auto-detected IP4 address. Write the log file to the specified location."
newline newline
textBlockSwitches "${scriptName} -r myserver.mydomain.net,myserver2.mydomain.net -l /var/log/cfddns.log --ip6 --ip fd21:7a62:2737:9c3a::a151" textBlockSwitches "${scriptName} -r myserver.mydomain.net,myserver2.mydomain.net -l /var/log/cfddns.log --ip6 --ip fd21:7a62:2737:9c3a::a151"
textBlock "Update DNS AAAA entries for listed hosts using the *specified* IP address. Write a colourful log to the location specified." textBlock "Update DNS AAAA entries for listed hosts using the *specified* IP address. Write the log to the location specified."
newline newline
textBlockSwitches "${scriptName} -r myserver.mydomain.net -c /root/cloudflare.creds -l /var/log/cfddns.log --ip 1.2.3.4" textBlockSwitches "${scriptName} -r myserver.mydomain.net --ip 1.2.3.4 -c /root/cloudflare.creds -l /var/log/cfddns.log --fmt-syslog"
textBlock "Update DNS A entry for listed hostname with the provided IP address. Read cloudflare credentials file from specified location, save log in specified location." textBlock "Update DNS A entry for 'myserver.mydomain.net' with the *specified* IP address. Read the Cloudflare credentials file from the specified location. Save a plain-text (syslog-style) log in the specified location."
newline newline
textBlockSwitches "${scriptName} -r myserver.mydomain.net -c /root/cloudflare.creds -l /var/log/cfddns.log -6 -i fd21:7a62:2737:9c3a::a151" textBlockSwitches "${scriptName} -r myserver.mydomain.net -6 -i fd21:7a62:2737:9c3a::a151 -c /root/cloudflare.creds -l /var/log/cfddns.log --fmt-syslog"
textBlock "Exact same as above, but change the AAAA record. This is how you run the script once for IP4 and again for IP6." textBlock "Exact same as above, but change the AAAA record. This is an example of how you run the script once for IP4 and again for IP6."
exit 0 exit 0
} }