fixed headings so TOC links work
This commit is contained in:
Asif Bacchus
parent
1ffd374a4f
commit
57ce2d1ac3
16
README.md
16
README.md
|
|
@ -7,7 +7,7 @@ Update your *existing* Cloudflare DNS records with your current (dynamic) IP add
|
|||
<!-- toc -->
|
||||
|
||||
- [Prerequisites](#prerequisites)
|
||||
- [cfddns.sh](#cfddns%2346sh)
|
||||
- [cfddns script](#cfddns-script)
|
||||
* [Installation](#installation)
|
||||
* [Usage](#usage)
|
||||
+ [Parameters](#parameters)
|
||||
|
|
@ -15,10 +15,10 @@ Update your *existing* Cloudflare DNS records with your current (dynamic) IP add
|
|||
* [File structure](#file-structure)
|
||||
* [Bearer token](#bearer-token)
|
||||
* [Zone ID](#zone-id)
|
||||
- [cfddns.service](#cfddnsservice)
|
||||
* [IP4 and/or IP6](#ip4-andor-ip6)
|
||||
- [cfddns systemd service unit](#cfddns-systemd-service-unit)
|
||||
* [IP4 or IP6](#ip4-or-ip6)
|
||||
+ [Examples](#examples)
|
||||
- [cfddns.timer](#cfddnstimer)
|
||||
- [cfddns systemd timer unit](#cfddns-systemd-timer-unit)
|
||||
* [Activation](#activation)
|
||||
- [Logging](#logging)
|
||||
* [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.
|
||||
|
||||
## cfddns.sh
|
||||
## cfddns script
|
||||
|
||||
### Installation
|
||||
|
||||
|
|
@ -124,7 +124,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.
|
||||
|
||||
|
||||
## 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:
|
||||
|
||||
|
|
@ -142,7 +142,7 @@ Don’t forget to reload systemd after copying this file so it is recognized by
|
|||
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.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 @@ 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.
|
||||
|
||||
|
|
|
|||
|
|
@ -15,17 +15,17 @@ If you need help getting logwatch installed and set-up, please [check out my blo
|
|||
|
||||
<!-- 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)
|
||||
* [Archive location and name format](#archive-location-and-name-format)
|
||||
* [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)
|
||||
* [Report title](#report-title)
|
||||
* [Detail level](#detail-level)
|
||||
- [Service script (/etc/logwatch/scripts/services/cfddns)](#service-script-etclogwatchscriptsservicescfddns)
|
||||
- [Service script](#service-script)
|
||||
* [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 search REGEX](#the-search-regex)
|
||||
- [Testing](#testing)
|
||||
|
|
@ -33,7 +33,9 @@ If you need help getting logwatch installed and set-up, please [check out my blo
|
|||
|
||||
<!-- 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
|
||||
|
||||
|
|
@ -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.
|
||||
|
||||
## 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
|
||||
|
||||
|
|
@ -119,7 +123,9 @@ Simply change it to the value you want enforced. For example, here I'm setting
|
|||
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
|
||||
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.**
|
||||
- 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.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue