AdGuard Home 同步工具(adguardhome-sync)安装与配置教程

1. 项目目录结构及介绍

在克隆或下载bakito/adguardhome-sync项目后，您将看到以下基本目录结构：

.
├── Dockerfile        # Docker镜像构建文件
├── README.md         # 项目说明文档
├── adguardhome-sync   # 二进制可执行文件
└── samples           # 示例配置文件和脚本
    ├── config.yaml   # 样例配置文件
    └── run.sh        # 样例运行脚本

• Dockerfile: 用于构建Docker镜像的文件。
• README.md: 包含项目详细信息和使用说明的Markdown文档。
• adguardhome-sync: 同步AdGuard Home配置的主程序。
• samples: 存放示例配置文件和启动脚本的目录。

2. 项目启动文件介绍

Docker容器部署

推荐使用Docker Compose来启动服务，样例docker-compose.yml文件位于samples目录中。这个文件定义了AdGuard Home同步服务的配置，包括：

services:
  adguardhome-sync:
    image: ghcr.io/bakito/adguardhome-sync
    container_name: adguardhome-sync
    command: run --config /config/adguardhome-sync.yaml
    volumes:
      - /path/to/appdata/config/adguardhome-sync.yaml:/config/adguardhome-sync.yaml
    ports:
      - 8080:8080
    restart: unless-stopped
    env_file: 
      - .env

这里，command指定了启动命令，volumes挂载了本地的配置文件到容器内，ports暴露了监控Web界面的端口，restart策略确保了服务异常时自动重启，而.env文件用于传递环境变量。

直接运行二进制文件

如果您不打算使用Docker，可以在本地运行adguardhome-sync二进制文件。首先设置必要的环境变量，然后运行该程序。一个简单的示例是：

LOG_LEVEL=info ORIGIN_URL=https://your-origin-adguardhome:3000 \
adguardhome-sync run --config /path/to/config.yaml

3. 项目配置文件介绍

配置文件默认为YAML格式，例如samples/config.yaml。以下是关键配置项的解释：

origin:
  url: https://your-origin-adguardhome:3000       # 主AdGuard Home实例的URL
  username: your_username                         # 主AdGuard Home的用户名（如果需要认证）
  password: your_password                         # 主AdGuard Home的密码（如果需要认证）
replicas:
  - url: https://your-replica1-adguardhome:3000   # 复制品AdGuard Home实例的URL
    username: your_replica_username              # 复制品AdGuard Home的用户名（如果需要认证）
    password: your_replica_password              # 复制品AdGuard Home的密码（如果需要认证）

features:
  dhcp: false                                     # 是否启用DHCP功能
  dhcp_server_config: false                       # 是否同步DHCP服务器配置
  dhcp_static_leases: false                       # 是否同步DHCP静态租约

根据您的实际环境调整这些参数，并确保所有URL指向有效的AdGuard Home实例。如果您的AdGuard Home实例启用了身份验证，记得提供用户名和密码。

总结，adguardhome-sync是一款方便的工具，用于保持多台AdGuard Home实例之间的配置同步。通过理解上述目录结构、启动文件以及配置文件，您现在应该能够顺利地安装并配置该项目了。