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 Installing (markdown)

Michael Stanclift 2020-10-22 22:58:24 -05:00
parent 86b41bb7eb
commit 271cd8dd67
1 changed files with 9 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
Installing.md

@ -1,38 +1,30 @@
Please make sure you've read over the [System Requirements](https://github.com/vmstan/gravity-sync/wiki/System-Requirements) prior to beginning your installation. Please make sure you've read over the [System Requirements](https://github.com/vmstan/gravity-sync/wiki/System-Requirements) prior to beginning your installation. The online install script reference below is designed to make installing Gravity Sync as simple as possible. The script code is a simple bash script, just like Gravity Sync, and is [available for review](https://github.com/vmstan/gravity-sync/blob/master/prep/gs-install.sh) if you have concerns about piping to bash, as shown below. You can also perform a [manual install](https://github.com/vmstan/gravity-sync/wiki/Under-The-Covers).
### Primary Pi-Hole ### Primary Pi-Hole
Minimal preperation is required on your primary Pi-hole, the installer will mostly check that all dependencies have been met for use. Limited preparation is required on your primary Pi-hole, the installer will mostly check that all dependencies as laid out in the[System Requirements](https://github.com/vmstan/gravity-sync/wiki/System-Requirements) have been met. It will also add a passwordless sudo configuration file for the current user, if it is required. The installer will then exit, and direct you to proceed to the secondary Pi-hole.
Login to your _primary_ Pi-hole, and run the following command: Login to your _primary_ Pi-hole via SSH, and run the following command:
```bash ```bash
export GS_INSTALL=primary && curl -sSL https://gravity.vmstan.com | bash export GS_INSTALL=primary && curl -sSL https://gravity.vmstan.com | bash
``` ```
This will verify you have everything necessary to use Gravity Sync. It will also add a passwordless sudo configuration file for the current user. The installer will then exit, and direct you to proceed to the secondary Pi-hole.
After you have completed this step, log out of the _primary_ Pi-hole.
### Secondary Pi-Hole ### Secondary Pi-Hole
From this point forward, all operations will take place on your secondary Pi-hole. From this point forward, all operations will take place on your secondary Pi-hole. Just like on the primary, the installer will verify you have everything necessary to use Gravity Sync, but once the requirements have been met, the installer will then use Git to make a copy of the Gravity Sync executables on your system, and direct you to proceed to Configuration step below. Once this has completed, you will now have a folder called `gravity-sync` in your install directory. Everything Gravity Sync runs from there.
Login to your _secondary_ Pi-hole, and run the following command: Login to your _secondary_ Pi-hole via SSH, and run the following command:
```bash ```bash
export GS_INSTALL=secondary && curl -sSL https://gravity.vmstan.com | bash export GS_INSTALL=secondary && curl -sSL https://gravity.vmstan.com | bash
``` ```
This will verify you have everything necessary to use Gravity Sync. The installer will then use Git to make a copy of the Gravity Sync executables in the folder the installer was executed in, and direct you to proceed to Configuration step below. Once this has completed, you will now have a folder called `gravity-sync` in your installed directory. Everything Gravity Sync runs from there. # Configuration
Proceed to the Configuration section. After you install Gravity Sync to your _secondary Pi-hole_, you will need to create a configuration file. This process will run automatically by the installer.
## Configuration The configuration utility will guide you through the process of:
After you install Gravity Sync to your _secondary Pi-hole_ you will need to create a configuration file. This will run automatically by the installer.
This will guide you through the process of:
- Specifying the IP or DNS name of your primary Pi-hole. - Specifying the IP or DNS name of your primary Pi-hole.
- Specifying the SSH username to connect to your primary Pi-hole. - Specifying the SSH username to connect to your primary Pi-hole.
@ -40,7 +32,7 @@ This will guide you through the process of:
The configuration will be saved as `gravity-sync.conf` in the same folder as the script. If you need to make adjustments to your settings in the future, you can edit this file or run the configuration tool to generate a new one. The configuration will be saved as `gravity-sync.conf` in the same folder as the script. If you need to make adjustments to your settings in the future, you can edit this file or run the configuration tool to generate a new one.
If you are deploying Gravity Sync to a system using Docker containers, the script should detect this and prompt for additional configuration. You can also choose to perform an advanced installation when prompted. If you are deploying Gravity Sync to a system using Docker containers, Gravity Sync should detect this and prompt for additional configuration. You can also choose to perform an advanced installation, when prompted.
After you're pleased with your configuration, proceed to the Execution phase. After you're pleased with your configuration, proceed to the Execution phase.