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 System Requirements (markdown)

Michael Stanclift 2020-10-22 09:17:48 -05:00
parent ac9236751f
commit fa62967e29
1 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
System-Requirements.md

@ -1,8 +1,16 @@
- 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). The main requirement is Gravity Sync requires two at least separate Pi-hole 5.0 instances and these Pi-hole should be already be deployed and verified to be functional, prior to the installation of Gravity Sync.
- 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. - 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. If you're not the `root` account, you can only install in the user's `$HOME` directory. - 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 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. - 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.
#### Docker Pi-hole Installs
- As of Gravity Sync 3.1, your Pi-hole installs can be a Docker container deployment.
- Gravity Sync will run directly on the host OS, and not inside of the container image.
- Only the [official Pi-hole Docker image](https://hub.docker.com/r/pihole/pihole) is supported.
### Required Components ### Required Components