Pihole Sync Receiver

Pihole Sync Receiver is the receiver-side Docker container of the Pi-hole Sync project, keeping a secondary Pi-hole in sync with a master Pi-hole on another…

  • Cloud
  • Network Services
  • Tools & Utilities
Pihole Sync Receiver is the receiver-side Docker container of the Pi-hole Sync project, keeping a secondary Pi-hole in sync with a master Pi-hole on another host. It automatically mirrors the master's Pi-hole and dnsmasq configuration to the local Pi-hole, so a redundant pair never drifts apart while you administer only one. It is aimed at self-hosters running two Dockerized Pi-holes as a failover pair who want a single point of configuration without granting the receiver container root access.

Platform availability

Available on 1 of 9 platforms

  • Unraid
  • TrueNAS (not listed)
  • Umbrel (not listed)
  • ZimaOS (not listed)
  • Proxmox (not listed)
  • Helm (not listed)
  • Mac (not listed)
  • Windows (not listed)
  • Linux (not listed)

Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.

30/100 Low

Maintained
0last commit 1343 days ago
Popular
3770 GitHub stars
Easy to install
351 install platform, install notes, Docker image
Light to run
95512 MB minimum RAM, runs on ARM

Availability: platform listings confirmed today, links checked 6 days ago

GitHub stars
70
Open issues
7
Last commit
2023-02-09
Activity
stale

Checked 6 days ago - source: GitHub (ShiromMakkad/docker-pihole-sync)

Resources & Compatibility

Minimum requirements: 512 MB RAM, 2 GB disk. ARM (e.g. Raspberry Pi) is supported.

Checked 17 days ago - source: Docker Hub image tags and published docs

First-install notes

  • Have your Pi-hole address and password Before starting, write down the URL of your Pi-hole admin page (for example, https://pi.hole/) and its admin password. The receiver uses these to sign in and sync, so wrong or missing details will stop it from working. source
  • Install the pihole6api helper package Make sure the pihole6api Python package is installed (it is the tool that lets the receiver talk to Pi-hole). If you are setting it up manually, run pip install pihole6api; without it, the receiver cannot connect. source
  • Run the sender on the master first This container is only the receiver half: deploy the matching docker-pihole-sync sender on the host running your master Pi-hole before starting the receiver, or it has nothing to sync from. source
  • Only needed to avoid root access The sender/receiver containers exist to solve permissions without root. If you are happy running the receiver with root access, or the receiving Pi-hole is not Dockerized, you can sync without this container. source

Fetched 9 days ago - each note links to its source

Alternatives

No alternatives collected yet.

Common questions

Do I need to run the receiver container if the second Pi-hole is not in Docker?

No. The sender and receiver containers are only needed to solve permissions issues without giving root access. If your receiving Pi-hole is not in Docker or you are comfortable with root access, you can skip the receiver container.

Which files and settings are synchronized between the Pi-hole instances?

It synchronizes the /etc/pihole/ and /etc/dnsmasq.d/ directories, excluding some client-independent directories. It also transfers lists and settings such as the password and upstream DNS settings.

Does the sync happen continuously after a change?

Yes. The container monitors the selected folder for changes and immediately updates the other Pi-hole, so changes can apply right away.

Can this sync more than two Pi-hole instances?

The project is described as synchronizing two Pi-holes, with one acting as master and one as slave. More Pi-hole support is mentioned as a future addition.

Answers sourced from github.com

Community

Collected 16 days ago - public community threads