From 8ef4e496e43a956180b0fc73adb1321d21bcde39 Mon Sep 17 00:00:00 2001 From: Michael Stanclift Date: Mon, 4 Jan 2021 14:15:22 -0600 Subject: [PATCH] Updated Hidden Figures (markdown) --- Hidden-Figures.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/Hidden-Figures.md b/Hidden-Figures.md index 4ea3129..f3a67fb 100644 --- a/Hidden-Figures.md +++ b/Hidden-Figures.md @@ -14,6 +14,13 @@ These variables allow you to change the location of the Pi-hole settings folder - Default setting in Gravity Sync is `/etc/pihole`. - These variables can be set via `./gravity-sync.sh config` function and required if a Docker install is selected. +### `DNSMAQ_DIR` and `RNSMAQ_DIR` + +These variables allow you to change the location of the DNSMASQ settings folder on both the local and remote hosts. This is required for Docker installations of Pi-hole. This directory location should be from the root of the file system and be configured **without** a trailing slash. + +- Default setting in Gravity Sync is `/etc/dnsmaq.d`. +- These variables can be set via `./gravity-sync.sh config` function and required if a Docker install is selected. + ### `PIHOLE_BIN` and `RIHOLE_BIN` These variables allow you to change the location of the Pi-hole binary folder on both the local and remote hosts. Unless you've done a custom Pi-hole installation, this setting is unlikely to require changes. This directory location should be from the root of the file system and be configured **without** a trailing slash. @@ -57,6 +64,15 @@ Starting in v1.7.0, Gravity Sync manages the `custom.list` file that contains th - Default setting in Gravity Sync is `0`, change to `1` to exempt `custom.list` from replication. - This variable can be set via `./gravity-sync.sh config` function. +### INCLUDE_CNAME + +Starting in v2.3.0, Gravity Sync manages the `05-pihole-custom-cname.conf` file that contains the "Local DNS CNAME Record" function within the Pi-hole interface. This is not enabled by default, as the file is only created if you use the feature, and since it was only added in Pi-hole 5.3, existing installations that are upgraded will not automatically enable this sync. + +You cannot enable `INCLUDE_CNAME` if you've also enabled `SKIP_CUSTOM` as the CNAME function is dependent on Local DNS records. You can, however, only replicate the Local DNS Records if you do not intend to leverage CNAME records. + +- Default setting in Gravity Sync is `0`, change to `1` to include `05-pihole-custom-cname.conf` in replication. +- This variable can be set via `./gravity-sync.sh config` function. + ### `DATE_OUTPUT` _This feature has not been implemented, but the intent is to provide the ability to add timestamped output to each status indicator in the script output (ex: [2020-05-28 19:46:54] [EXEC] \$MESSAGE)._