Nebula-Sync

Nebula-Sync is a tool that synchronizes Pi-hole v6.x configuration between a primary instance and its replicas using the Pi-hole API.

  • Backup
  • Network Services
  • Tools & Utilities
Nebula-Sync is a tool that synchronizes Pi-hole v6.x configuration between a primary instance and its replicas using the Pi-hole API. It supports full synchronization via Pi-hole Teleporter, selective feature copying, and automated cron-scheduled runs. Nebula-Sync is not part of the official Pi-hole project and requires Pi-hole v6 or later, which is still under active development. Available as a Docker container or Linux and macOS binaries, it is ideal for homelabbers running multiple Pi-hole instances who need consistent configuration across them.

Platform availability

Available on 1 of 10 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)
  • Any server (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.

49/100 Fair

Maintained
72last commit 32 days ago
Popular
641,662 GitHub stars
Easy to install
351 install platform, install notes, Docker image
Light to run
No data
Security check
07 serious findings, 4 minor, CI, tests

Based on 4 of 5 factors.

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

GitHub stars
1,662
Open issues
53
Last commit
2026-10-20
Latest release
v0.11.3
License
MIT
Activity
rising

Checked 10 days ago - source: GitHub (lovelaze/nebula-sync)

Resources & Compatibility

ARM (e.g. Raspberry Pi) is supported.

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

First-install notes

  • Point Nebula at your certificate files Set the pki section to the real paths for your CA (the trusted root certificate), host certificate, and host key before starting Nebula. If these paths are missing or wrong, Nebula can't verify who the other devices are, so it won't join the network. source
  • Set lighthouse DNS and reachability settings If you run a lighthouse, fill in its DNS listener (usually port 53), advertised address (the public address clients should use), and allowed IP ranges so other devices can find it and talk to it. Without these, clients may be able to start but won't discover or reach the lighthouse over the internet or your network. source
  • Start with the right config file Run Nebula with the -config flag pointing to the configuration file you prepared, and look for a message that the Nebula interface is active. If the path is wrong or the config is incomplete, the service may start and then immediately fail to connect. source
  • Prerequisites Requires Pi-hole v6.x or later. Pi-hole v6 is still under active development and some features may change. source

Fetched 38 days ago - each note links to its source

Alternatives

No alternatives collected yet.

Common questions

Is nebula-sync an official Pi-hole project?

No. It is not part of the official Pi-hole project, but it uses the API provided by Pi-hole instances to perform synchronization actions.

What should I change if nebula-sync causes nightly database outages?

A reported cause was the gravity sync/update. Setting RUN_GRAVITY to false stopped the outages.

Can I self-host it with Docker?

Yes. The self-host directory page provides a Docker install guide for nebula-sync.

Where can I ask setup or code questions for the project?

The project has GitHub Discussions for discussing code, asking questions, and collaborating with the developer community.

Answers sourced from discourse.pi-hole.net, github.com, github.com, selfhost.directory

Community

Collected 48 days ago - public community threads