mattwebbio/orbital-sync

Orbital Sync

Orbital Sync 通过内置的 "teleporter" 功能同步多个 Pi-hole 实例以实现高可用性 (HA)。具体而言，它通过主 Pi-hole 实例的管理界面执行 "备份"，然后通过从 Pi-hole 的管理界面将该备份 "恢复" 到任意数量的 "从" Pi-hole。因此，它支持 Pi-hole 的 "teleporter" 当前支持的所有同步内容。有关默认配置，请参阅 "配置"。

替代方案

我喜欢 https://github.com/vmstan/gravity-sync 并且使用了很长时间，但个人发现在某些环境（Docker、Unraid、Synology 等）中设置起来比较困难。Orbital Sync 的设计思路是减少对运行 Pi-hole 的服务器的依赖，而是像用户一样通过管理界面进行操作。

为何需要多个 Pi-hole 实例

您是否遇到过运行 Pi-hole 的服务器宕机的情况？或者需要对该服务器进行维护？这显然会对网络用户造成极大干扰。通过运行多个 Pi-hole 实例（副本）并为网络客户端提供次要/ tertiary 等 DNS 服务器，任何一个 Pi-hole 实例的故障都不会导致整个网络瘫痪。

开始使用

按照设置主 Pi-hole 的方式设置从 Pi-hole 实例。完成后，选择以下任一方式：

Docker

以下是运行此项目的 Docker Compose 示例文件。有关更多环境变量，请参阅 配置 部分。

yaml
version: '3'
services:
  orbital-sync:
    image: docker.xuanyuan.run/mattwebbio/orbital-sync:1
    environment:
      PRIMARY_HOST_BASE_URL: 'https://pihole1.example.com'
      PRIMARY_HOST_PASSWORD: 'your_password1'
      SECONDARY_HOSTS_1_BASE_URL: 'https://pihole2.example.com'
      SECONDARY_HOSTS_1_PASSWORD: 'your_password2'
      SECONDARY_HOSTS_2_BASE_URL: 'http://192.168.1.3'
      SECONDARY_HOSTS_2_PASSWORD: 'your_password3'
      SECONDARY_HOSTS_3_BASE_URL: 'http://server:8080'
      SECONDARY_HOSTS_3_PASSWORD: 'your_password4'
      SECONDARY_HOSTS_3_PATH: '/apps/pi-hole'
      INTERVAL_MINUTES: 60

Orbital Sync Docker 镜像发布在 DockerHub 和 GitHub 包仓库： https://hub.docker.com/r/mattwebbio/orbital-sync https://github.com/mattwebbio/orbital-sync/pkgs/container/orbital-sync

Node

与 Docker 类似，使用 Node 运行需要在运行 Orbital Sync 之前导出所有必需的环境变量。有关更多信息，请参阅 配置 部分。

shell
npm install -g orbital-sync
orbital-sync

要求

所有 Pi-hole 的管理 Web 界面必须可被运行此服务的容器/服务器访问。换句话说，它们必须在同一网络中。

建议使用 Docker 运行此服务。