nebula-sync

用于将Pi-hole v6.x配置同步到副本的工具。本项目非***Pi-hole项目的一部分，但通过Pi-hole实例提供的API执行同步操作。

核心功能与特性

• 全量同步：使用Pi-hole Teleporter进行完整配置同步
• 选择性同步：支持按功能模块进行选择性同步
• 定时任务调度：可通过Cron表达式设置定时同步计划

使用场景与适用范围

适用于部署了多个Pi-hole v6.x实例的环境，需要保持主节点与副本节点配置一致性的场景，如家庭网络、小型企业网络中多Pi-hole节点的配置统一管理。

使用方法与配置说明

Docker Compose（推荐）

yaml
---
services:
  nebula-sync:
    image: ghcr.io/lovelaze/nebula-sync:latest
    container_name: nebula-sync
    environment:
    - PRIMARY=[***]|password  # 主Pi-hole地址及密码
    - REPLICAS=[***]|password,[***]|password  # 副本Pi-hole列表
    - FULL_SYNC=true  # 启用全量同步
    - RUN_GRAVITY=true  # 同步后运行gravity
    - CRON=0 * * * *  # 每小时执行一次同步

Docker CLI

bash
docker run --rm \
  --name nebula-sync \
  -e PRIMARY="[***]|password" \  # 主Pi-hole配置
  -e REPLICAS="[***]|password" \  # 副本Pi-hole配置
  -e FULL_SYNC=true \  # 启用全量同步
  -e RUN_GRAVITY=true \  # 同步后运行gravity
  ghcr.io/lovelaze/nebula-sync:latest

配置参数说明

必选环境变量

注意：当FULL_SYNC=true时，系统将通过主Pi-hole的Teleporter功能执行完整的导入/导出操作，同步所有设置和配置。

可选环境变量

注意：以下可选设置仅在FULL_SYNC=false时生效，用于实现 granular control 的选择性同步：

免责声明

本项目为非社区维护项目，与Pi-hole项目无关联。虽已在多种环境中测试，但使用互联网上的任何软件均存在固有风险。详情请参阅许可证。

Pi-hole及Pi-hole徽标为Pi-hole LLC的注册商标。