Manual install instructions

README.md

@@ -4,7 +4,7 @@ For more information visit [https://vmstan.com/gravity-sync/](https://vmstan.com
 
 The scripts assumes you have one "master" Pihole as the primary place you make all your configuration changes, such as whitelist, blacklist, group management, and blocklist settings. After the script executes it will copy the gravity.db from the master to any secondary nodes you configure it to run on.
 
-### Prereqs
+## Prereqs
 
 - This script is designed to work with Pihole 5.0 GA
 - This script has been tested with Ubuntu 20.04 and Rasbian
@@ -16,7 +16,13 @@ ssh-keygen -t rsa
 ssh-copy-id -i ~/.ssh/id_rsa.pub USERNAME@PRIMARYPI
 ```
 
-### Installation
+## Installation
+
+### Option 1
+
+The main purpose of this script is my own personal use, but if you find it helpful then I encourage you to use it and if you'd like provide feedback or contribute. This option is more bleeding edge in that you'll download and run whatever the latest version of the script is on GitHub.
+
+If this is too aggressive for you, proceed to option 2.
 
 From your *secondary* Pi, login via SSH and copy the gravity-sync.sh script to your user. In this example we will use git to keep the latest copy of the script on your server.
 
@@ -26,9 +32,25 @@ git clone https://github.com/vmstan/gravity-sync.git
 cd gravity-sync
 ```
 
+### Option 2
+
+Download the latest release from [https://github.com/vmstan/gravity-sync/releases](https://github.com/vmstan/gravity-sync/releases) and exact the files to your server.
+
+Example:
+
+```
+cd ~
+wget https://github.com/vmstan/gravity-sync/archive/v1.1.2.zip
+unzip v1.1.2.zip
+mv ~/gravity-sync-1.1.2 ~/gravity-sync
+cd gravity-sync
+```
+
+**MAKE SURE YOU REPLACE THE ZIP VERSIONS WITH THE LATEST ONE**
+
 Please note the script **must** be run from a folder in your user home directory (ex: /home/pi/gravity-sync) -- I wouldn't suggest changing the folder name.
 
-### Configuration
+## Configuration
 
 After you clone the base configuration, you will need to create a configuration file called `gravity-sync.conf` in the same folder as the script.
 
@@ -53,7 +75,7 @@ Now test the script. I suggest making a subtle change to a whitelist/blacklist o
 
 You will now have overwritten your running gravity.db on the secondary Pihole after creating a copy (gravity.db.backup) in the /etc/pihole directory. The script will also keep a copy of the last sync'd gravity.db from the master, in the gravity-sync folder (gravity.db.last) should you need it. Lastly, a file called gravity-sync.log will be created in the sync folder, with the date the script was last executed appended to the bottom.
 
-### Failover
+## Failover
 
 There is an option in the script to push from the secondary Pihole back to the primary. This would be useful in a situation where your primary is down for an extended period of time, and you have list changes you want to force back to the primary when it comes online.
 
@@ -63,11 +85,11 @@ There is an option in the script to push from the secondary Pihole back to the p
 
 Please note that the "push" option does not make any backups of anything. There is a warning about potental data loss before executing this function. This function purposefuly asks for user interaction to avoid being accidentally automated.
 
-### Updates
+## Updates
 
 If you do a `git pull` while in the `gravity-sync` directory you should be able to levegage git to update to the latest copy of the script. Your changes to the .conf file, logs and backups should be uneffected by this.
 
-### Automation
+## Automation
 
 I've automated by synchronization using Crontab. If you'd like to keep this a manual process then ignore this section. By default my script will run at the top and bottom of every hour (1:00 PM, 1:30 PM, 2:00 PM, etc) but you can dial this back if you feel this is too aggressive.