Cutlery/gravity-sync
1
0
Fork 0
mirror of https://github.com/vmstan/gravity-sync.git synced 2025-07-09 02:34:06 -04:00
Code Issues Packages Projects Releases Wiki Activity

Updated Manual Installs (markdown)

Michael Stanclift 2020-10-21 12:49:25 -05:00
parent ae99934768
commit d821328751
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Manual-Installs.md

@ -17,7 +17,7 @@ unzip v3.x.x.zip -d gravity-sync
cd gravity-sync
```
# Configuration
## Configuration
If you don't want to use the automated configuration utility at `./gravity-sync.sh config` you can setup your configuration manually as well.
@ -37,11 +37,11 @@ REMOTE_HOST='192.168.1.10'
REMOTE_USER='pi'
```
# SSH Configuration
## SSH Configuration
Gravity Sync uses SSH to run commands on the primary Pi-hole, and sync the two systems by performing file copies.
## Key-Pair Authentication
### Key-Pair Authentication
You'll need to generate an SSH key for your secondary Pi-hole user and copy it to your primary Pi-hole. This will allow you to connect to and copy the necessary files without needing a password each time. When generating the SSH key, accept all the defaults and do not put a passphrase on your key file.
@ -56,17 +56,17 @@ Substitute REMOTE_USER for the account on the primary Pi-hole with sudo permissi
Make sure to leave the `REMOTE_PASS` variable set to nothing in `gravity-sync.conf` if you want to use key-pair authentication.
## Password Authentication
### Password Authentication
This option has been removed from Gravity Sync as of version 3.1.
# Updates
## Updates
If you manually installed Gravity Sync via `.zip` or `.tar.gz` you will need to download and overwrite the `gravity-sync.sh` file with a newer version. If you've chosen this path, I won't lay out exactly what you'll need to do every time, but you should at least review the contents of the script bundle (specifically the example configuration file) to make sure there are no new additional files or required settings.
At the very least, I would recommend backing up your existing `gravity-sync` folder and then deploying a fresh copy each time you update, and then either creating a new .conf file or copying your old file over to the new folder.
# Automation
## 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.
@ -78,7 +78,7 @@ crontab -e
0 23 * * * /bin/bash /home/USER//gravity-sync/gravity-sync.sh backup >/dev/null 2>&1
```
## Automating Automation
### Automating Automation
To automate the deployment of automation option you can call it with 2 parameters: