From 9a8e49f07c8d644d4fd6efa28a53627104fb6e0a Mon Sep 17 00:00:00 2001 From: Michael Stanclift Date: Thu, 16 Jul 2020 13:15:38 -0500 Subject: [PATCH] Post PR cleanup --- ADVANCED.md | 25 ++++++++++++++----------- CHANGELOG.md | 2 ++ gravity-sync.sh | 2 ++ 3 files changed, 18 insertions(+), 11 deletions(-) diff --git a/ADVANCED.md b/ADVANCED.md index e6d9374..ca4a138 100644 --- a/ADVANCED.md +++ b/ADVANCED.md @@ -170,7 +170,7 @@ The `./gravity-sync.sh config` function will attempt to ping the remote host to Default setting in Gravity Sync is 0, change to 1 to skip this network test. #### `ROOT_CHECK_AVOID=''` -The `./gravity-sync.sh` check that it's deployed with it's own user, but for container deployment it's a nuisance, to install a user and gave it passwordless sudo power, witch result with the same security risk as running as root. +At execution, Gravity Sync will check that it's deployed with it's own user (not running as root), but for a container deployment this is not necessary. Default setting in Gravity Sync is 0, change to 1 to skip this root user test. @@ -217,16 +217,6 @@ If your code is still not updating after this, reinstallation is suggested rathe ## Automation There are many automation methods available to run scripts on a regular basis of a Linux system. The one built into all of them is cron, but if you'd like to utilize something different then the principles are still the same. -To automate the deployment of automation option, you can call it with 2 parameters: -first interval in minutes to run sync [0-30], -then the hour to run backup [0-24] -Note: 0 will disable the cron entry. - -for example: -gravity-sync.sh automate 15 23 - -will sync every 15 minutes and backup at 23:00. - If you prefer to still use cron but modify your settings by hand, using the entry below will cause the entry to run at the top and bottom of every hour (1:00 PM, 1:30 PM, 2:00 PM, etc) but you are free to dial this back or be more agressive if you feel the need. ```bash @@ -235,6 +225,19 @@ crontab -e 0 23 * * * /bin/bash /home/USER//gravity-sync/gravity-sync.sh backup >/dev/null 2>&1 ``` +### Automating Automation + +To automate the deployment of automation option you can call it with 2 parameters: +- First interval in minutes to run sync [0-30], +- Second the hour to run backup [0-24] + +(0 will disable the cron entry) + +For example: +`./gravity-sync.sh automate 15 23` + +Will configure automation of the sync function every 15 minutes and of a backup at 23:00. + ## Reference Architectures The designation of primary and secondary is purely at your discretion. The doesn't matter if you're using an HA process like keepalived to present a single DNS IP address to clients, or handing out two DNS resolvers via DHCP. Generally it is expected that the two (or more) Pi-hole(s) will be at the same phyiscal location, or at least on the same internal networks. It should also be possible to to replicate to a secondary Pi-hole across networks, either over a VPN or open-Internet, with the approprate firewall/NAT configuration. diff --git a/CHANGELOG.md b/CHANGELOG.md index 2c1ec65..26ab0b3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -36,6 +36,8 @@ Skipping a few digits because what does it really matter? #### 2.1.6 - Adds prompts during `./gravity-sync.sh configure` to allow custom SSH port and enable PING avoidance. +- Adds `ROOT_CHECK_AVOID` variable to advanced configuration options, to help facilitate running Gravity Sync with container installations of Pi-hole. (PR [#64](https://github.com/vmstan/gravity-sync/pull/64)) +- Adds ## 2.0 ### The Smart Release diff --git a/gravity-sync.sh b/gravity-sync.sh index 18d1c4c..1d5f0e1 100755 --- a/gravity-sync.sh +++ b/gravity-sync.sh @@ -1976,7 +1976,9 @@ function root_check { MESSAGE="Evaluating Arguments" echo_stat + import_gs + if [ "${ROOT_CHECK_AVOID}" != "1" ] then root_check