Cutlery/gravity-sync
1
0
Fork 0
mirror of https://github.com/vmstan/gravity-sync.git synced 2025-08-05 08:39:48 -04:00
Code Issues Packages Projects Releases Wiki Activity

Updated System Requirements (markdown)

Michael Stanclift 2021-02-12 10:34:35 -06:00
parent 5709e77db5
commit 0aeea69e72
1 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
System-Requirements.md

@ -1,10 +1,10 @@
The main requirement is Gravity Sync requires two at least separate Pi-hole 5.0 instances. These Pi-hole should be already be deployed and verified to be functional, prior to the installation of Gravity Sync.
The main requirement is Gravity Sync requires at least two separate Pi-hole 5.x instances. These Pi-hole instances should be already be deployed and verified to be functional, prior to the installation of Gravity Sync.
- Only the Linux distributions that Pi-hole is [certified to run on](https://docs.pi-hole.net/main/prerequesites/#supported-operating-systems) are supported. ([More Here](https://github.com/vmstan/gravity-sync/wiki/Frequent-Questions#do-you-support-dietpi-unraid-lxd-something-else))
- You will need a user account with local administrator privileges on the host OS at each side. This can be a dedicated account or the system's `root` account.
- Only the Linux distributions that Pi-hole is [certified to run on](https://docs.pi-hole.net/main/prerequesites/#supported-operating-systems) are officially supported. ([More Here](https://github.com/vmstan/gravity-sync/wiki/Frequent-Questions#do-you-support-dietpi-unraid-lxd-something-else))
- You will need a user account with operating system level administrator privileges at each side. This can be a dedicated account with `sudo` ability, or the system's `root` account.
- If you're not using the `root` account, you can only install Gravity Sync in the user's `$HOME` directory.
- If you're not using the `root` account, make sure that the account is a member of either the `sudo` or `wheel` group on both the primary and secondary Pi-hole. Most of the pre-built images available for the Raspberry Pi already have this configured, as does Ubuntu.
- During installation, this non-root user will be given [passwordless sudo](https://linuxize.com/post/how-to-run-sudo-command-without-password/) permissions to the system.
- During installation, if a non-root user will be given [passwordless sudo](https://linuxize.com/post/how-to-run-sudo-command-without-password/) permissions to the system.
#### Docker Pi-hole
@ -19,7 +19,7 @@ The main requirement is Gravity Sync requires two at least separate Pi-hole 5.0
### Required Components
The installer will perform checks to make sure the required components to use Gravity Sync (such as OpenSSH, etc) are available on both the primary and secondary Pi-hole during installation. If they are missing you will have an opportunity to use whatever package manager is available on your system to correct the missing dependencies.
The installer will perform checks to make sure the required components to use Gravity Sync (such as OpenSSH, etc) are available on both the primary and secondary Pi-hole during installation.
- OpenSSH
- Rsync
@ -28,15 +28,15 @@ The installer will perform checks to make sure the required components to use Gr
- Sudo
- SQLite3
If any of these components are missing, you should use the package manager utility that is bundled with your distribution to install them.
If any of these components are missing, you will have an opportunity to use the package manager utility that is bundled with your Linux distribution to install them.
#### Debian/Raspbian/Ubuntu
#### Debian Based (Ubuntu, Raspbian)
```bash
apt update && apt install sqlite3 sudo git cronie rsync ssh
```
#### CentOS/Fedora
#### Redhat Based (CentOS/Fedora)
```
dnf install sqlite3 sudo git cronie rsync ssh
@ -44,9 +44,11 @@ dnf install sqlite3 sudo git cronie rsync ssh
### Pi-hole Architecture
You will want to designate one Pi-Hole as primary and at least one as secondary.
You will need to designate one Pi-Hole as primary and at least one as secondary.
- The primary Pi-hole is where you'll make most of your configuration changes through the Web UI, doing things such as; manual allow-listing, adding block-lists, device/group management, configuring custom/local network DNS, and changing other list settings.
- The secondary Pi-hole(s) are where you will install and configure Gravity Sync.
The primary Pi-hole will also be referred to in the interface as remote, while the secondary will be referred to as local. This is done to be as confusing as possible and make sure you read the documentation. (Just kidding)
See also: [Reference Architectures](https://github.com/vmstan/gravity-sync/wiki/Reference-Architectures)