From ad493e7944ab4b65feebf0d3826de7ac8be47948 Mon Sep 17 00:00:00 2001 From: Michael Stanclift Date: Wed, 21 Oct 2020 12:56:16 -0500 Subject: [PATCH] Created System Requirements (markdown) --- System-Requirements.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 System-Requirements.md diff --git a/System-Requirements.md b/System-Requirements.md new file mode 100644 index 0000000..15d4ae4 --- /dev/null +++ b/System-Requirements.md @@ -0,0 +1,6 @@ +- Pi-hole 5.0 (or higher) must already be installed on at least two systems, using any of the Linux distributions that Pi-hole is [certified to run on](https://docs.pi-hole.net/main/prerequesites/#supported-operating-systems). +- As of Gravity Sync 3.1, your Pi-hole installs can be a standard installation of Pi-hole or a Docker container deployment. In either case, Gravity Sync will run directly on the host OS, and not inside of a container image. +- If you are using containerized deployments of Pi-hole, only the [official Pi-hole Docker image](https://hub.docker.com/r/pihole/pihole) is supported. +- 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. If you're not the `root` account, you can only install in the user's `$HOME` directory. +- If you're using a non-root user, make sure that the account is a member of the `sudo` 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 user will be given passwordless sudo permissions to the system. +- The installer will perform checks to make sure the required components to use Gravity Sync such as OpenSSH `ssh`, `SQLite3`, and `rsync` (plus a few others) 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. These binaries are what do the heavy lifting between your Pi-hole nodes. \ No newline at end of file