Compare commits
12 Commits
2.1
...
1824d9f139
| Author | SHA1 | Date | |
|---|---|---|---|
| 1824d9f139 | |||
| 50b4cf105f | |||
| 1e3b545a23 | |||
| 380509c966 | |||
| 71da487aa8 | |||
| 3be6eaee0c | |||
| 5c6c8ec4ea | |||
| c7297a512c | |||
| fddb406717 | |||
| 4ec190af47 | |||
| 57ce2d1ac3 | |||
| 1ffd374a4f |
@@ -55,6 +55,23 @@
|
|||||||
*.bat text eol=crlf
|
*.bat text eol=crlf
|
||||||
*.cmd text eol=crlf
|
*.cmd text eol=crlf
|
||||||
|
|
||||||
|
# web frontend stack -- force LF so SRI hashes are always correct
|
||||||
|
*.html text eol=lf
|
||||||
|
*.htm text eol=lf
|
||||||
|
*.css text eol=lf
|
||||||
|
*.min.css text eol=lf
|
||||||
|
*.js text eol=lf
|
||||||
|
*.min.js text eol=lf
|
||||||
|
*.php text eol=lf
|
||||||
|
|
||||||
|
# Visual Studio projects (Rider also)
|
||||||
|
*.cs diff=csharp
|
||||||
|
*.sln merge=union
|
||||||
|
*.csproj merge=union
|
||||||
|
*.vbproj merge=union
|
||||||
|
*.fsproj merge=union
|
||||||
|
*.dbproj merge=union
|
||||||
|
|
||||||
# Serialisation
|
# Serialisation
|
||||||
*.json text
|
*.json text
|
||||||
*.toml text
|
*.toml text
|
||||||
@@ -79,3 +96,5 @@
|
|||||||
.gitattributes export-ignore
|
.gitattributes export-ignore
|
||||||
.gitignore export-ignore
|
.gitignore export-ignore
|
||||||
.gitkeep export-ignore
|
.gitkeep export-ignore
|
||||||
|
.idea export-ignore
|
||||||
|
.vscode export-ignore
|
||||||
|
|||||||
+34
@@ -1 +1,35 @@
|
|||||||
|
#
|
||||||
|
# JetBrains exclusions
|
||||||
|
#
|
||||||
|
|
||||||
|
riderModule.iml
|
||||||
|
/_ReSharper.Caches/
|
||||||
|
|
||||||
|
# User-specific stuff
|
||||||
|
.idea/**/workspace.xml
|
||||||
|
.idea/**/tasks.xml
|
||||||
|
.idea/**/usage.statistics.xml
|
||||||
|
.idea/**/dictionaries
|
||||||
|
.idea/**/shelf
|
||||||
|
|
||||||
|
# Generated files
|
||||||
|
.idea/**/contentModel.xml
|
||||||
|
.idea/**/GitCommitMessageStorage.xml
|
||||||
|
|
||||||
|
# Sensitive or high-churn files
|
||||||
|
.idea/**/dataSources/
|
||||||
|
.idea/**/dataSources.ids
|
||||||
|
.idea/**/dataSources.local.xml
|
||||||
|
.idea/**/sqlDataSources.xml
|
||||||
|
.idea/**/dynamic.xml
|
||||||
|
.idea/**/uiDesigner.xml
|
||||||
|
.idea/**/dbnavigator.xml
|
||||||
|
|
||||||
|
# modules
|
||||||
|
.idea_modules/
|
||||||
|
|
||||||
|
# Editor-based Rest Client
|
||||||
|
.idea/httpRequests
|
||||||
|
|
||||||
|
# project-specific exclusions
|
||||||
*.log
|
*.log
|
||||||
|
|||||||
Generated
+6
@@ -0,0 +1,6 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<project version="4">
|
||||||
|
<component name="DeveloperToolsToolWindowSettingsV1" lastSelectedContentNodeId="base64-encoder-decoder" pluginVersion="9.0.0">
|
||||||
|
<developerToolsConfigurations />
|
||||||
|
</component>
|
||||||
|
</project>
|
||||||
Generated
+15
@@ -0,0 +1,15 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<project version="4">
|
||||||
|
<component name="GitToolBoxProjectSettings">
|
||||||
|
<option name="commitMessageIssueKeyValidationOverride">
|
||||||
|
<BoolValueOverride>
|
||||||
|
<option name="enabled" value="true" />
|
||||||
|
</BoolValueOverride>
|
||||||
|
</option>
|
||||||
|
<option name="commitMessageValidationEnabledOverride">
|
||||||
|
<BoolValueOverride>
|
||||||
|
<option name="enabled" value="true" />
|
||||||
|
</BoolValueOverride>
|
||||||
|
</option>
|
||||||
|
</component>
|
||||||
|
</project>
|
||||||
Generated
+8
@@ -0,0 +1,8 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<project version="4">
|
||||||
|
<component name="UserContentModel">
|
||||||
|
<attachedFolders />
|
||||||
|
<explicitIncludes />
|
||||||
|
<explicitExcludes />
|
||||||
|
</component>
|
||||||
|
</project>
|
||||||
Generated
+8
@@ -0,0 +1,8 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<project version="4">
|
||||||
|
<component name="com.itcodebox.notebooks.projectservice.ProjectUIState">
|
||||||
|
<option name="selectedNotebookId" value="1" />
|
||||||
|
<option name="selectedChapterId" value="1" />
|
||||||
|
<option name="selectedNoteId" value="1" />
|
||||||
|
</component>
|
||||||
|
</project>
|
||||||
Generated
+8
@@ -0,0 +1,8 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<project version="4">
|
||||||
|
<component name="RiderProjectSettingsUpdater">
|
||||||
|
<option name="singleClickDiffPreview" value="1" />
|
||||||
|
<option name="unhandledExceptionsIgnoreList" value="1" />
|
||||||
|
<option name="vcsConfiguration" value="3" />
|
||||||
|
</component>
|
||||||
|
</project>
|
||||||
Generated
+6
@@ -0,0 +1,6 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<project version="4">
|
||||||
|
<component name="VcsDirectoryMappings">
|
||||||
|
<mapping directory="" vcs="Git" />
|
||||||
|
</component>
|
||||||
|
</project>
|
||||||
@@ -7,7 +7,7 @@ Update your *existing* Cloudflare DNS records with your current (dynamic) IP add
|
|||||||
<!-- toc -->
|
<!-- toc -->
|
||||||
|
|
||||||
- [Prerequisites](#prerequisites)
|
- [Prerequisites](#prerequisites)
|
||||||
- [cfddns.sh](#cfddns%2346sh)
|
- [cfddns script](#cfddns-script)
|
||||||
* [Installation](#installation)
|
* [Installation](#installation)
|
||||||
* [Usage](#usage)
|
* [Usage](#usage)
|
||||||
+ [Parameters](#parameters)
|
+ [Parameters](#parameters)
|
||||||
@@ -15,10 +15,10 @@ Update your *existing* Cloudflare DNS records with your current (dynamic) IP add
|
|||||||
* [File structure](#file-structure)
|
* [File structure](#file-structure)
|
||||||
* [Bearer token](#bearer-token)
|
* [Bearer token](#bearer-token)
|
||||||
* [Zone ID](#zone-id)
|
* [Zone ID](#zone-id)
|
||||||
- [cfddns.service](#cfddnsservice)
|
- [cfddns systemd service unit](#cfddns-systemd-service-unit)
|
||||||
* [IP4 and/or IP6](#ip4-andor-ip6)
|
* [IP4 or IP6](#ip4-or-ip6)
|
||||||
+ [Examples](#examples)
|
+ [Examples](#examples)
|
||||||
- [cfddns.timer](#cfddnstimer)
|
- [cfddns systemd timer unit](#cfddns-systemd-timer-unit)
|
||||||
* [Activation](#activation)
|
* [Activation](#activation)
|
||||||
- [Logging](#logging)
|
- [Logging](#logging)
|
||||||
* [Using Logwatch to monitor this script](#using-logwatch-to-monitor-this-script)
|
* [Using Logwatch to monitor this script](#using-logwatch-to-monitor-this-script)
|
||||||
@@ -37,7 +37,7 @@ apt install -y curl jq
|
|||||||
|
|
||||||
While the script does *not* require root privileges, you will need sudo/root access to install the *systemd* service and timer.
|
While the script does *not* require root privileges, you will need sudo/root access to install the *systemd* service and timer.
|
||||||
|
|
||||||
## cfddns.sh
|
## cfddns script
|
||||||
|
|
||||||
### Installation
|
### Installation
|
||||||
|
|
||||||
@@ -56,7 +56,7 @@ I recommend putting this script in your */usr/local/bin* directory or somewhere
|
|||||||
sudo chmod +x /usr/local/bin/cfddns.sh
|
sudo chmod +x /usr/local/bin/cfddns.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
> Note: You can rename *cfddns.sh* to anything you want, the script will auto-update itself. However, you **must** manually update the systemd service file (*cfddns.service*) `ExecStart` line as [explained below](#cfddns.service).
|
> Note: You can rename *cfddns.sh* to anything you want, the script will auto-update itself. However, you **must** manually update the systemd service file (*cfddns.service*) `ExecStart` line as [explained below](#cfddns-script).
|
||||||
|
|
||||||
### Usage
|
### Usage
|
||||||
|
|
||||||
@@ -111,6 +111,13 @@ cfZoneId=83d564234134513245311b23412331dd
|
|||||||
|
|
||||||
You can save the file as anything you like and anywhere you’d like as long as you inform the script of its location using the `--credentials` parameter. By default, the script will look for a file named *cloudflare.credentials* in the same path as the script.
|
You can save the file as anything you like and anywhere you’d like as long as you inform the script of its location using the `--credentials` parameter. By default, the script will look for a file named *cloudflare.credentials* in the same path as the script.
|
||||||
|
|
||||||
|
Please remember that this file basically contains a password! As a result, it should be protected and access limited to the root account:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
chown root:root /path/to/cloudflare.credentials
|
||||||
|
chmod 600 /path/to/cloudflare.credentials
|
||||||
|
```
|
||||||
|
|
||||||
### Bearer token
|
### Bearer token
|
||||||
|
|
||||||
I chose to use an API bearer token instead of a username/password or Global API token for security reasons. Your username/password and Global API token provide unfettered access to your account so if anyone gets hold of them, they can do anything to your account. An API bearer token, by contrast, can only do what you authorize it to do and you can revoke it at any time. Therefore, I suggest making a bearer token that is based on the “Edit zone DNS” template and restricted to the specific domain/zone you wish to update. Cloudflare provides an [excellent article](https://support.cloudflare.com/hc/en-us/articles/200167836-Managing-API-Tokens-and-Keys) on how to generate this token.
|
I chose to use an API bearer token instead of a username/password or Global API token for security reasons. Your username/password and Global API token provide unfettered access to your account so if anyone gets hold of them, they can do anything to your account. An API bearer token, by contrast, can only do what you authorize it to do and you can revoke it at any time. Therefore, I suggest making a bearer token that is based on the “Edit zone DNS” template and restricted to the specific domain/zone you wish to update. Cloudflare provides an [excellent article](https://support.cloudflare.com/hc/en-us/articles/200167836-Managing-API-Tokens-and-Keys) on how to generate this token.
|
||||||
@@ -124,7 +131,7 @@ This is required by the Cloudflare API so it knows which zone you are editing an
|
|||||||
To get your Zone ID, log into your Cloudflare account and open the domain in question. On the overview page, scroll down a bit and look to the right. You will see your Zone ID listed there. Copy that string into your configuration file.
|
To get your Zone ID, log into your Cloudflare account and open the domain in question. On the overview page, scroll down a bit and look to the right. You will see your Zone ID listed there. Copy that string into your configuration file.
|
||||||
|
|
||||||
|
|
||||||
## cfddns.service
|
## cfddns systemd service unit
|
||||||
|
|
||||||
This file **must** be copied to your */etc/systemd/system* directory (or equivalent directory if you're not running Debian/Ubuntu). If you change the name of the cfddns.sh file, you must update the filename in the `ExecStart` line as shown below:
|
This file **must** be copied to your */etc/systemd/system* directory (or equivalent directory if you're not running Debian/Ubuntu). If you change the name of the cfddns.sh file, you must update the filename in the `ExecStart` line as shown below:
|
||||||
|
|
||||||
@@ -136,13 +143,7 @@ ExecStart=/full/path/to/your/renamed.file -parameter1 -parameter2 -parameter...
|
|||||||
...
|
...
|
||||||
````
|
````
|
||||||
|
|
||||||
Don’t forget to reload systemd after copying this file so it is recognized by the system! On most systems you can do this by running the following as root or via sudo:
|
### IP4 or IP6
|
||||||
|
|
||||||
```bash
|
|
||||||
systemctl daemon-reload
|
|
||||||
```
|
|
||||||
|
|
||||||
### IP4 and/or IP6
|
|
||||||
|
|
||||||
The cfddns.service file includes two *ExecStart* lines, one without a specified IP-protocol parameter (default IP4) and the other with the -6 (IP6) parameter. The service will run the cfddns.sh script in default (IP4) mode with specified parameters first and then will run the script again in IP6 mode with specified parameters.
|
The cfddns.service file includes two *ExecStart* lines, one without a specified IP-protocol parameter (default IP4) and the other with the -6 (IP6) parameter. The service will run the cfddns.sh script in default (IP4) mode with specified parameters first and then will run the script again in IP6 mode with specified parameters.
|
||||||
|
|
||||||
@@ -183,9 +184,9 @@ The cfddns.service file includes two *ExecStart* lines, one without a specified
|
|||||||
...
|
...
|
||||||
```
|
```
|
||||||
|
|
||||||
## cfddns.timer
|
## cfddns systemd timer unit
|
||||||
|
|
||||||
This is the timer file that tells your system how often to call the *cfddns.service* file which runs the *cfddns.sh* script. By default, the timer is set for 5 minutes after the system boots up (to allow for other processes to initialize even on slower systems like a RasPi) and is then run every 15 minutes thereafter. Remember when setting your timer that Cloudflare limits API calls to 1200 every 5 minutes.
|
Just like the service file unit, this file **must** be copied to your */etc/systemd/system* directory (or equivalent directory if you're not running Debian/Ubuntu). This timer file unit tells your system how often to call the *cfddns.service* file which runs the *cfddns.sh* script. By default, the timer is set for 5 minutes after the system boots up (to allow for other processes to initialize even on slower systems like a RasPi) and is then run every 15 minutes thereafter. Remember when setting your timer that Cloudflare limits API calls to 1200 every 5 minutes.
|
||||||
|
|
||||||
You can change the timer by modifying the relevant section of the *cfddns.timer* file:
|
You can change the timer by modifying the relevant section of the *cfddns.timer* file:
|
||||||
|
|
||||||
@@ -198,6 +199,12 @@ OnUnitActiveSec=15min
|
|||||||
*OnBootSec* is how long to wait after the system boots up before executing the *cfddns.service*. *OnUnitActiveSec* will then wait the specified time from that first (after boot) call or after the timer is explicitly started before calling *cfddns.service* again. I recommend setting OnUnitActiveSec to a low value (like 2 minutes) for testing then setting it to a more reasonable time (like 15
|
*OnBootSec* is how long to wait after the system boots up before executing the *cfddns.service*. *OnUnitActiveSec* will then wait the specified time from that first (after boot) call or after the timer is explicitly started before calling *cfddns.service* again. I recommend setting OnUnitActiveSec to a low value (like 2 minutes) for testing then setting it to a more reasonable time (like 15
|
||||||
minutes) after everything is working.
|
minutes) after everything is working.
|
||||||
|
|
||||||
|
After you’ve copied both the systemd unit and this timer unit, don’t forget to reload the systemd daemon so they are recognized by the system! On most systems you can do this by running the following as root or via sudo:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
systemctl daemon-reload
|
||||||
|
```
|
||||||
|
|
||||||
### Activation
|
### Activation
|
||||||
|
|
||||||
You can start the timer system immediately via *systemctl*
|
You can start the timer system immediately via *systemctl*
|
||||||
@@ -220,6 +227,8 @@ systemctl status cfddns.timer
|
|||||||
|
|
||||||
It is NOT necessary to enable/start the *cfddns.service*, only the timer needs to be active.
|
It is NOT necessary to enable/start the *cfddns.service*, only the timer needs to be active.
|
||||||
|
|
||||||
|
Also remember that if you make changes to settings like `OnUnitActiveSec` while testing or after testing is complete you *must* reload the systemd daemon! It will restart the appropriate units for you and your new settings will take effect immediately.
|
||||||
|
|
||||||
## Logging
|
## Logging
|
||||||
|
|
||||||
The script logs every major action it takes and provides details on any errors it encounters in the log file (see the [parameters section](#parameters) for details about setting log location and name). If errors are encountered, they are colour coded red and an explanation of the error code is provided.
|
The script logs every major action it takes and provides details on any errors it encounters in the log file (see the [parameters section](#parameters) for details about setting log location and name). If errors are encountered, they are colour coded red and an explanation of the error code is provided.
|
||||||
|
|||||||
@@ -3,11 +3,13 @@
|
|||||||
#
|
#
|
||||||
# update Cloudflare DNS records with current (dynamic) IP address
|
# update Cloudflare DNS records with current (dynamic) IP address
|
||||||
# Script by Asif Bacchus <asif@bacchus.cloud>
|
# Script by Asif Bacchus <asif@bacchus.cloud>
|
||||||
# Last modified: May 7, 2021
|
# Last modified: July 19, 2026
|
||||||
|
# Version 3.0
|
||||||
#
|
#
|
||||||
|
|
||||||
### text formatting presets using tput
|
### text formatting presets using tput
|
||||||
if command -v tput >/dev/null; then
|
if command -v tput >/dev/null; then
|
||||||
|
[ -z "$TERM" ] && export TERM=xterm
|
||||||
bold=$(tput bold)
|
bold=$(tput bold)
|
||||||
cyan=$(tput setaf 6)
|
cyan=$(tput setaf 6)
|
||||||
err=$(tput bold)$(tput setaf 1)
|
err=$(tput bold)$(tput setaf 1)
|
||||||
@@ -155,6 +157,10 @@ scriptHelp() {
|
|||||||
textBlock "Switch value. Output log to console (stdout) instead of a log file. Can be combined with --nc if desired."
|
textBlock "Switch value. Output log to console (stdout) instead of a log file. Can be combined with --nc if desired."
|
||||||
textBlockDefaults "(disabled: output to log file)"
|
textBlockDefaults "(disabled: output to log file)"
|
||||||
newline
|
newline
|
||||||
|
textBlockSwitches "--log-journal"
|
||||||
|
textBlock "Switch value. Output a structured log entry to your journaling system instead of a log file. Implies --nc."
|
||||||
|
textBlockDefaults "(disabled: output to log file)"
|
||||||
|
newline
|
||||||
textBlockSwitches "--no-log"
|
textBlockSwitches "--no-log"
|
||||||
textBlock "Switch value. Do not create a log (i.e. no console, no file). You will not have *any* output from the script if you choose this option, so you will not know if updates succeeded or failed."
|
textBlock "Switch value. Do not create a log (i.e. no console, no file). You will not have *any* output from the script if you choose this option, so you will not know if updates succeeded or failed."
|
||||||
textBlockDefaults "(disabled: output to log file)"
|
textBlockDefaults "(disabled: output to log file)"
|
||||||
@@ -251,6 +257,7 @@ writeLog() {
|
|||||||
scriptPath="$(CDPATH='' \cd -- "$(dirname -- "$0")" && pwd -P)"
|
scriptPath="$(CDPATH='' \cd -- "$(dirname -- "$0")" && pwd -P)"
|
||||||
scriptName="$(basename "$0")"
|
scriptName="$(basename "$0")"
|
||||||
logFile="$scriptPath/${scriptName%.*}.log"
|
logFile="$scriptPath/${scriptName%.*}.log"
|
||||||
|
logToJournal=0
|
||||||
accountFile="$scriptPath/cloudflare.credentials"
|
accountFile="$scriptPath/cloudflare.credentials"
|
||||||
colourizeLogFile=1
|
colourizeLogFile=1
|
||||||
dnsRecords=""
|
dnsRecords=""
|
||||||
@@ -290,6 +297,10 @@ while [ $# -gt 0 ]; do
|
|||||||
# log to the console instead of a file
|
# log to the console instead of a file
|
||||||
logFile="/dev/stdout"
|
logFile="/dev/stdout"
|
||||||
;;
|
;;
|
||||||
|
--log-journal)
|
||||||
|
# log to the journal system instead of a file
|
||||||
|
logToJournal=1
|
||||||
|
;;
|
||||||
--no-log)
|
--no-log)
|
||||||
# do not log anything
|
# do not log anything
|
||||||
logFile="/dev/null"
|
logFile="/dev/null"
|
||||||
@@ -362,6 +373,10 @@ fi
|
|||||||
if [ ! -f "$accountFile" ] || [ ! -s "$accountFile" ]; then
|
if [ ! -f "$accountFile" ] || [ ! -s "$accountFile" ]; then
|
||||||
badParam errMsg "Cannot find Cloudflare credentials file (${accountFile}). Exiting."
|
badParam errMsg "Cannot find Cloudflare credentials file (${accountFile}). Exiting."
|
||||||
fi
|
fi
|
||||||
|
if ! command -v logger >/dev/null 2>&1; then
|
||||||
|
printf "\n%sThis script requires 'logger' be installed to write entries to your journaling system. Exiting.%s\n\n" "$err" "$norm"
|
||||||
|
exit 2
|
||||||
|
fi
|
||||||
# turn off log file colourization if parameter is set
|
# turn off log file colourization if parameter is set
|
||||||
if [ "$colourizeLogFile" -eq 0 ]; then
|
if [ "$colourizeLogFile" -eq 0 ]; then
|
||||||
bold=""
|
bold=""
|
||||||
@@ -376,6 +391,7 @@ fi
|
|||||||
|
|
||||||
### initial log entries
|
### initial log entries
|
||||||
{
|
{
|
||||||
|
|
||||||
printf "%s[%s] -- Cloudflare DDNS update-script: starting --%s\n" "$ok" "$(stamp)" "$norm"
|
printf "%s[%s] -- Cloudflare DDNS update-script: starting --%s\n" "$ok" "$(stamp)" "$norm"
|
||||||
printf "Parameters:\n"
|
printf "Parameters:\n"
|
||||||
printf "script path: %s\n" "$scriptPath/$scriptName"
|
printf "script path: %s\n" "$scriptPath/$scriptName"
|
||||||
@@ -413,7 +429,9 @@ fi
|
|||||||
record="${dnsRecordsToUpdate%%${dnsSeparator}*}"
|
record="${dnsRecordsToUpdate%%${dnsSeparator}*}"
|
||||||
dnsRecordsToUpdate="${dnsRecordsToUpdate#*${dnsSeparator}}"
|
dnsRecordsToUpdate="${dnsRecordsToUpdate#*${dnsSeparator}}"
|
||||||
|
|
||||||
if [ -z "$record" ]; then continue; fi
|
if [ -z "$record" ]; then
|
||||||
|
continue
|
||||||
|
fi
|
||||||
printf "updating record: %s\n" "$record"
|
printf "updating record: %s\n" "$record"
|
||||||
done
|
done
|
||||||
|
|
||||||
@@ -424,13 +442,13 @@ fi
|
|||||||
writeLog process "Reading Cloudflare credentials"
|
writeLog process "Reading Cloudflare credentials"
|
||||||
case "$accountFile" in
|
case "$accountFile" in
|
||||||
/*)
|
/*)
|
||||||
# absolute path, use as-is
|
# absolute path, use as-is
|
||||||
# shellcheck source=./cloudflare.credentials
|
# shellcheck source=./cloudflare.credentials
|
||||||
. "$accountFile"
|
. "$accountFile"
|
||||||
;;
|
;;
|
||||||
*)
|
*)
|
||||||
# relative path, rewrite
|
# relative path, rewrite
|
||||||
# shellcheck source=./cloudflare.credentials
|
# shellcheck source=./cloudflare.credentials
|
||||||
. "./$accountFile"
|
. "./$accountFile"
|
||||||
;;
|
;;
|
||||||
esac
|
esac
|
||||||
@@ -457,13 +475,17 @@ while [ -n "$dnsRecordsToUpdate" ] && [ "$dnsRecordsToUpdate" != "$dnsSeparator"
|
|||||||
record="${dnsRecordsToUpdate%%${dnsSeparator}*}"
|
record="${dnsRecordsToUpdate%%${dnsSeparator}*}"
|
||||||
dnsRecordsToUpdate="${dnsRecordsToUpdate#*${dnsSeparator}}"
|
dnsRecordsToUpdate="${dnsRecordsToUpdate#*${dnsSeparator}}"
|
||||||
|
|
||||||
if [ -z "$record" ]; then continue; fi
|
if [ -z "$record" ]; then
|
||||||
|
continue
|
||||||
|
fi
|
||||||
writeLog process "Processing ${record}"
|
writeLog process "Processing ${record}"
|
||||||
|
|
||||||
# exit if curl/network error
|
# exit if curl/network error
|
||||||
if ! cfLookup="$(curl -s -X GET "https://api.cloudflare.com/client/v4/zones/${cfZoneId}/dns_records?name=${record}&type=${recordType}" \
|
if ! cfLookup="$(
|
||||||
|
curl -s -X GET "https://api.cloudflare.com/client/v4/zones/${cfZoneId}/dns_records?name=${record}&type=${recordType}" \
|
||||||
-H "Authorization: Bearer ${cfKey}" \
|
-H "Authorization: Bearer ${cfKey}" \
|
||||||
-H "Content-Type: application/json")"; then
|
-H "Content-Type: application/json"
|
||||||
|
)"; then
|
||||||
writeLog process-error
|
writeLog process-error
|
||||||
exitError 3
|
exitError 3
|
||||||
fi
|
fi
|
||||||
@@ -504,10 +526,12 @@ while [ -n "$dnsRecordsToUpdate" ] && [ "$dnsRecordsToUpdate" != "$dnsSeparator"
|
|||||||
updateJSON="$(jq -n --arg key0 content --arg value0 "${ipAddress}" '{($key0):$value0}')"
|
updateJSON="$(jq -n --arg key0 content --arg value0 "${ipAddress}" '{($key0):$value0}')"
|
||||||
|
|
||||||
# exit if curl/network error
|
# exit if curl/network error
|
||||||
if ! cfResult="$(curl -s -X PATCH "https://api.cloudflare.com/client/v4/zones/${cfZoneId}/dns_records/${objectId}" \
|
if ! cfResult="$(
|
||||||
|
curl -s -X PATCH "https://api.cloudflare.com/client/v4/zones/${cfZoneId}/dns_records/${objectId}" \
|
||||||
-H "Authorization: Bearer ${cfKey}" \
|
-H "Authorization: Bearer ${cfKey}" \
|
||||||
-H "Content-Type: application/json" \
|
-H "Content-Type: application/json" \
|
||||||
--data "${updateJSON}")"; then
|
--data "${updateJSON}"
|
||||||
|
)"; then
|
||||||
writeLog process-error
|
writeLog process-error
|
||||||
exitError 3
|
exitError 3
|
||||||
fi
|
fi
|
||||||
|
|||||||
+16
-8
@@ -15,17 +15,17 @@ If you need help getting logwatch installed and set-up, please [check out my blo
|
|||||||
|
|
||||||
<!-- toc -->
|
<!-- toc -->
|
||||||
|
|
||||||
- [LogFile Group file (/etc/logwatch/conf/logfiles/cfddns.conf)](#logfile-group-file-etclogwatchconflogfilescfddnsconf)
|
- [LogFile Group file](#logfile-group-file)
|
||||||
* [Log file location](#log-file-location)
|
* [Log file location](#log-file-location)
|
||||||
* [Archive location and name format](#archive-location-and-name-format)
|
* [Archive location and name format](#archive-location-and-name-format)
|
||||||
* [External script for timestamp processing](#external-script-for-timestamp-processing)
|
* [External script for timestamp processing](#external-script-for-timestamp-processing)
|
||||||
- [Service definition file (/etc/logwatch/conf/services/cfddns.conf)](#service-definition-file-etclogwatchconfservicescfddnsconf)
|
- [Service definition file](#service-definition-file)
|
||||||
* [LogFile Group file definition](#logfile-group-file-definition)
|
* [LogFile Group file definition](#logfile-group-file-definition)
|
||||||
* [Report title](#report-title)
|
* [Report title](#report-title)
|
||||||
* [Detail level](#detail-level)
|
* [Detail level](#detail-level)
|
||||||
- [Service script (/etc/logwatch/scripts/services/cfddns)](#service-script-etclogwatchscriptsservicescfddns)
|
- [Service script](#service-script)
|
||||||
* [Detail levels](#detail-levels)
|
* [Detail levels](#detail-levels)
|
||||||
- [Timestamp processing script (/etc/logwatch/scripts/shared/sqfullstampanywhere)](#timestamp-processing-script-etclogwatchscriptssharedsqfullstampanywhere)
|
- [Timestamp processing script](#timestamp-processing-script)
|
||||||
* [The time format specification](#the-time-format-specification)
|
* [The time format specification](#the-time-format-specification)
|
||||||
* [The search REGEX](#the-search-regex)
|
* [The search REGEX](#the-search-regex)
|
||||||
- [Testing](#testing)
|
- [Testing](#testing)
|
||||||
@@ -33,7 +33,9 @@ If you need help getting logwatch installed and set-up, please [check out my blo
|
|||||||
|
|
||||||
<!-- tocstop -->
|
<!-- tocstop -->
|
||||||
|
|
||||||
## LogFile Group file (/etc/logwatch/conf/logfiles/cfddns.conf)
|
## LogFile Group file
|
||||||
|
|
||||||
|
> This file is located within the repo at */etc/logwatch/conf/logfiles/cfddns.conf*
|
||||||
|
|
||||||
### Log file location
|
### Log file location
|
||||||
|
|
||||||
@@ -79,7 +81,9 @@ The script file is called with an asterisk (*\**) before the filename.
|
|||||||
|
|
||||||
If you change the name of this file, you will have to change this line. Remember that whatever you type here as a name is converted to all-lowercase so your filename should be all lowercase also.
|
If you change the name of this file, you will have to change this line. Remember that whatever you type here as a name is converted to all-lowercase so your filename should be all lowercase also.
|
||||||
|
|
||||||
## Service definition file (/etc/logwatch/conf/services/cfddns.conf)
|
## Service definition file
|
||||||
|
|
||||||
|
> This file is located within the repo at */etc/logwatch/conf/services/cfddns.conf*
|
||||||
|
|
||||||
### LogFile Group file definition
|
### LogFile Group file definition
|
||||||
|
|
||||||
@@ -119,7 +123,9 @@ Simply change it to the value you want enforced. For example, here I'm setting
|
|||||||
Detail = 5
|
Detail = 5
|
||||||
```
|
```
|
||||||
|
|
||||||
## Service script (/etc/logwatch/scripts/services/cfddns)
|
## Service script
|
||||||
|
|
||||||
|
> This file is located within the repo at */etc/logwatch/scripts/services/cfddns*
|
||||||
|
|
||||||
Logwatch calls any script with a name that **matches the service name**. You'll notice that I just named everything *cfddns* to keep things simple. You can change this to whatever you want. If you changed the service name to *"cloudflare*.conf", for example, you would have to rename this script file to "*cloudflare*" with no extension. Note: The script is a PERL file (note the
|
Logwatch calls any script with a name that **matches the service name**. You'll notice that I just named everything *cfddns* to keep things simple. You can change this to whatever you want. If you changed the service name to *"cloudflare*.conf", for example, you would have to rename this script file to "*cloudflare*" with no extension. Note: The script is a PERL file (note the
|
||||||
shebang) but it can be written in any language.
|
shebang) but it can be written in any language.
|
||||||
@@ -160,7 +166,9 @@ The script supports four (4) detail levels as follows:
|
|||||||
- **Use this detail level only when you need to see the entire log file and cannot otherwise access the log file.**
|
- **Use this detail level only when you need to see the entire log file and cannot otherwise access the log file.**
|
||||||
- Depending on how your logwatch treats this log dump, you may see gibberish control codes like *\e[0m;]*. If this is the case, run the script with the `--no-colour` or `--nc` option to remove ANSI colour formatting.
|
- Depending on how your logwatch treats this log dump, you may see gibberish control codes like *\e[0m;]*. If this is the case, run the script with the `--no-colour` or `--nc` option to remove ANSI colour formatting.
|
||||||
|
|
||||||
## Timestamp processing script (/etc/logwatch/scripts/shared/sqfullstampanywhere)
|
## Timestamp processing script
|
||||||
|
|
||||||
|
> This file is located within the repo at */etc/logwatch/scripts/shared/sqfullstampanywhere*
|
||||||
|
|
||||||
This is basically a modified version of the '*applyeurodate*' script that comes with Logwatch. It had to be modified to search within [square brackets] and to accept characters coming before the stamp (i.e. ANSI colour codes). If you change the '**stamp**' variable in the updater script to update the timestamp to your liking (which to totally fine!) then you'll probably have to update this file. There are two lines you need to modify to suit your new '**stamp**' variable.
|
This is basically a modified version of the '*applyeurodate*' script that comes with Logwatch. It had to be modified to search within [square brackets] and to accept characters coming before the stamp (i.e. ANSI colour codes). If you change the '**stamp**' variable in the updater script to update the timestamp to your liking (which to totally fine!) then you'll probably have to update this file. There are two lines you need to modify to suit your new '**stamp**' variable.
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,126 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
|
||||||
|
getTimeStamp() {
|
||||||
|
(date +%F" "%T)
|
||||||
|
}
|
||||||
|
|
||||||
|
# $1: message, $2: level, $3: operation, $4: code
|
||||||
|
writeJsonLog() {
|
||||||
|
PROGRAM_NAME="cfddns"
|
||||||
|
DEFAULT_CODE=99
|
||||||
|
DEFAULT_LEVEL="info"
|
||||||
|
DEFAULT_MESSAGE="An unspecified error has occurred"
|
||||||
|
DEFAULT_OPERATION="unspecified"
|
||||||
|
|
||||||
|
if [ -z "$1" ]; then
|
||||||
|
PROPS="$(
|
||||||
|
jq --null-input \
|
||||||
|
--arg level "err" \
|
||||||
|
--arg pName "$PROGRAM_NAME" \
|
||||||
|
--arg operation "$DEFAULT_OPERATION" \
|
||||||
|
--arg code "$DEFAULT_CODE" \
|
||||||
|
--arg message "$DEFAULT_MESSAGE" \
|
||||||
|
'{"level":$level, "programName":$pName, "operation":$operation, "code":$code, "message":$message}' \
|
||||||
|
)"
|
||||||
|
else
|
||||||
|
PROPS="$(
|
||||||
|
jq --null-input \
|
||||||
|
--arg level "${2:-$DEFAULT_LEVEL}" \
|
||||||
|
--arg pName "$PROGRAM_NAME" \
|
||||||
|
--arg operation "${3:-$DEFAULT_OPERATION}" \
|
||||||
|
--arg code "${4:-$DEFAULT_CODE}" \
|
||||||
|
--arg message "$1" \
|
||||||
|
'{"level":$level, "programName":$pName, "operation":$operation, "code":$code, "message":$message}' \
|
||||||
|
)"
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "$PROPS" | jq "."
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
# $1: message, $2: level, $3: operation, $4: code
|
||||||
|
writeJournalLog() {
|
||||||
|
PROGRAM_NAME="cfddns"
|
||||||
|
DEFAULT_CODE=99
|
||||||
|
DEFAULT_LEVEL="info"
|
||||||
|
DEFAULT_MESSAGE="An unspecified error has occurred"
|
||||||
|
DEFAULT_OPERATION="unspecified"
|
||||||
|
|
||||||
|
# translate error levels
|
||||||
|
if [ -z "$2" ]; then
|
||||||
|
LOG_LEVEL=1
|
||||||
|
else
|
||||||
|
case "$2" in
|
||||||
|
"emergency" | "emerg")
|
||||||
|
LOG_LEVEL=7
|
||||||
|
;;
|
||||||
|
"alert")
|
||||||
|
LOG_LEVEL=6
|
||||||
|
;;
|
||||||
|
"critical" | "crit")
|
||||||
|
LOG_LEVEL=5
|
||||||
|
;;
|
||||||
|
"error" | "err")
|
||||||
|
LOG_LEVEL=4
|
||||||
|
;;
|
||||||
|
"warning" | "warn")
|
||||||
|
LOG_LEVEL=3
|
||||||
|
;;
|
||||||
|
"notice")
|
||||||
|
LOG_LEVEL=2
|
||||||
|
;;
|
||||||
|
"info")
|
||||||
|
LOG_LEVEL=1
|
||||||
|
;;
|
||||||
|
"debug")
|
||||||
|
LOG_LEVEL=0
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
fi
|
||||||
|
|
||||||
|
# log the message
|
||||||
|
if [ -z "$1" ]; then
|
||||||
|
logger --journald <<end
|
||||||
|
MESSAGE_ID=$(systemd-id128 new)
|
||||||
|
SYSLOG_TIMESTAMP=$(getTimeStamp)
|
||||||
|
SYSLOG_FACILITY=3
|
||||||
|
SYSLOG_IDENTIFIER=${PROGRAM_NAME}
|
||||||
|
PRIORITY=4
|
||||||
|
ERRNO=${DEFAULT_CODE}
|
||||||
|
OPERATION=${DEFAULT_OPERATION}
|
||||||
|
MESSAGE=${DEFAULT_MESSAGE}
|
||||||
|
end
|
||||||
|
else
|
||||||
|
logger --journald <<end
|
||||||
|
MESSAGE_ID=$(systemd-id128 new)
|
||||||
|
SYSLOG_TIMESTAMP=$(getTimeStamp)
|
||||||
|
SYSLOG_FACILITY=3
|
||||||
|
SYSLOG_IDENTIFIER=${PROGRAM_NAME}
|
||||||
|
PRIORITY=${LOG_LEVEL}
|
||||||
|
ERRNO=${4:-$DEFAULT_CODE}
|
||||||
|
OPERATION=${3:-$DEFAULT_OPERATION}
|
||||||
|
MESSAGE=$1
|
||||||
|
end
|
||||||
|
fi
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if [ "$1" = "json" ]; then
|
||||||
|
writeJsonLog # this will generate a generic error message
|
||||||
|
writeJsonLog "This is a test message" # generate this message at the default level with the default code
|
||||||
|
writeJsonLog "This is a test message" "warning" # generate this message at the 'warning' level with the default code
|
||||||
|
writeJsonLog "This is a test message" "error" "testing" # generate this message at the 'error' level, part of a 'test' operation, and with the default code
|
||||||
|
writeJsonLog "This is a test message" "alert" "testing" 10 # generate this message at the 'alert' level with all parameters set
|
||||||
|
elif [ "$1" = "journal" ]; then
|
||||||
|
writeJournalLog # this will generate a generic error message
|
||||||
|
writeJournalLog "This is a test message" # generate this message at the default level with the default code
|
||||||
|
writeJournalLog "This is a test message" "warning" # generate this message at the 'warning' level with the default code
|
||||||
|
writeJournalLog "This is a test message" "error" "testing" # generate this message at the 'error' level as part of a 'test' operation, and with the default code
|
||||||
|
writeJournalLog "This is a test message" "alert" "testing" 10 # generate this message at the 'alert' level with all parameters set
|
||||||
|
else
|
||||||
|
printf "\nPlease specify either 'json' or 'journal' after the script name. Exiting.\n\n"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
exit 0
|
||||||
Reference in New Issue
Block a user