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

fixed headings so TOC links work

Browse Source
This commit is contained in:
Asif Bacchus 2021-05-10 03:09:30 -06:00
parent 1ffd374a4f
commit 57ce2d1ac3
2 changed files with 24 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -7,7 +7,7 @@ ## Contents <!-- omit in toc -->
<!-- toc --> <!-- toc -->
- [Prerequisites](#prerequisites) - [Prerequisites](#prerequisites)
- [cfddns&#46;sh](#cfddns%2346sh) - [cfddns script](#cfddns-script)
* [Installation](#installation) * [Installation](#installation)
* [Usage](#usage) * [Usage](#usage)
+ [Parameters](#parameters) + [Parameters](#parameters)
@ -15,10 +15,10 @@ ## Contents <!-- omit in toc -->
* [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 @@ ## Prerequisites
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&#46;sh ## cfddns script
### Installation ### Installation
@ -124,7 +124,7 @@ ### Zone ID
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&#46;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&#46;sh file, you must update the filename in the `ExecStart` line as shown below:
@ -142,7 +142,7 @@ ## cfddns.service
systemctl daemon-reload systemctl daemon-reload
``` ```
### IP4 and/or IP6 ### IP4 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&#46;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&#46;sh script in default (IP4) mode with specified parameters first and then will run the script again in IP6 mode with specified parameters.
@ -183,7 +183,7 @@ # update IP6 addresses
... ...
``` ```
## 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&#46;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. This is the timer file that tells your system how often to call the *cfddns.service* file which runs the *cfddns&#46;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.

24
etc/logwatch/README.md
View File

@ -15,17 +15,17 @@ ## Contents <!-- omit in toc -->
<!-- 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 @@ ## Contents <!-- omit in toc -->
<!-- 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 @@ ### External script for timestamp processing
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 @@ # Remember the levels are: 0, 1-4, 5, 6+
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 @@ ### Detail levels
- **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.