Setup Orbital Sync

Does not Support v6

Orbital Sync does not support Pi-hole v6 as of 2025-02-02. I have it set to auto-update, so when v6 support arrives, it will begin keeping my two Pi-hole instances in sync.

Overview

Orbital Sync synchronizes multiple Pi-hole instances for high availability (HA) using the built-in "teleporter". In other words, it performs a "backup" in the Pi-hole admin interface of your primary Pi-hole instance, and then "restores" that backup to any number of "secondary" Pi-holes also via their admin interface. As a result, it supports the synchronization of anything currently supported by Pi-hole's "teleporter".

Important Docker Files

`.env` file

.env

NAME=orbital-sync
DOMAIN=
PIHOLE1=
PIHOLE2=
PIHOLE1_PASS=
PIHOLE2_PASS=

`docker-compose.yml` file

docker-compose.yml

services:
  orbital-sync:
    image: mattwebbio/orbital-sync
    container_name: ${NAME}
    networks:
      - main
    environment:
      PRIMARY_HOST_BASE_URL: 'https://${PIHOLE1}.${DOMAIN}'
      PRIMARY_HOST_PASSWORD: '${PIHOLE1_PASS}'
      SECONDARY_HOSTS_1_BASE_URL: 'https://${PIHOLE2}.${DOMAIN}'
      SECONDARY_HOSTS_1_PASSWORD: '${PIHOLE2_PASS}'
      INTERVAL_MINUTES: 60
    labels:
      com.centurylinklabs.watchtower.enable: true
networks:
  main:
    external: true

Start the Container

docker compose up -d