Synchronize Pi-hole v6.x configuration to replicas.

This project is not a part of the official Pi-hole project, but uses the api provided by Pi-hole instances to perform the synchronization actions.

• Full sync: Use Pi-hole Teleporter for full synchronization.
• Manual sync: Selective feature synchronization.
• Cron schedule: Run on chron schedule.

Download binary from the latest release or build from source:

go install github.com/lovelaze/nebula-sync@latest

Run binary:

# run
nebula-sync run

# read envs from file
nebula-sync run --env-file .env

---
services:
  nebula-sync:
    image: ghcr.io/lovelaze/nebula-sync:latest
    container_name: nebula-sync
    environment:
    - PRIMARY=https://ph1.example.com|password
    - REPLICAS=https://ph2.example.com|password,https://ph3.example.com|password
    - FULL_SYNC=true
    - CRON=0 * * * *

docker run --rm \
  --name nebula-sync \
  -e PRIMARY="https://ph1.example.com|password" \
  -e REPLICAS="https://ph2.example.com|password" \
  -e FULL_SYNC=true \
  ghcr.io/lovelaze/nebula-sync:latest

Env and docker-compose examples can be found here

The following environment variables can be specified:

Note: When FULL_SYNC=true, the system will perform a full Teleporter import/export from the primary Pi-hole to the replicas. This will synchronize all settings and configurations.

Note: The following optional settings apply only if FULL_SYNC=false. They allow for granular control of synchronization if a full sync is not wanted.

This project is an unofficial, community-maintained project and is not affiliated with the official Pi-hole project. It aims to add sync/replication features not available in the core Pi-hole product but operates independently of Pi-hole LLC. Although tested across various environments, using any software from the Internet involves inherent risks. See the license for more details.

Pi-hole and the Pi-hole logo are registered trademarks of Pi-hole LLC.