linuxserver/adguardhome-sync

镜像概述和主要用途

linuxserver/adguardhome-sync是由LinuxServer.io团队维护的Docker镜像，用于运行Adguardhome-sync工具。该工具的主要功能是将AdGuardHome的配置同步到多个副本实例，确保所有AdGuardHome实例的配置保持一致。镜像特点包括定期应用更新、简单的用户映射（PGID、PUID）、基于s6 overlay的自定义基础镜像，以及每周基础操作系统更新和安全更新。

核心功能和特性

• 配置同步：将主AdGuardHome实例的配置同步到一个或多个副本实例
• 多架构支持：兼容x86-64和arm64v8架构
• 灵活配置：通过配置文件自定义同步参数和实例信息
• Web API：提供Web API接口，默认监听8080端口
• 安全可靠：支持只读容器文件系统和非root用户运行
• 易于维护：支持用户ID和组ID映射，避免权限问题

支持的架构

该镜像利用Docker manifest实现多平台支持，拉取lscr.io/linuxserver/adguardhome-sync:latest即可自动获取适合当前架构的镜像，也可通过标签指定特定架构：

应用设置

需编辑adguardhome-sync.yaml配置文件，填入AdGuardHome实例详情（主实例和副本实例的地址、认证信息等）。详细配置说明可参考AdGuardHome Sync***文档。

只读操作

该镜像支持以只读容器文件系统方式运行，详情请参阅LinuxServer.io只读文档。

非Root操作

该镜像支持以非root用户身份运行，详情请参阅LinuxServer.io非root文档。

使用方法

Docker Compose（推荐）

yaml
---
services:
  adguardhome-sync:
    image: lscr.io/linuxserver/adguardhome-sync:latest
    container_name: adguardhome-sync
    environment:
      - PUID=1000               # 用户ID
      - PGID=1000               # 组ID
      - TZ=Etc/UTC              # 时区
      - CONFIGFILE=/config/adguardhome-sync.yaml # 自定义配置文件路径（可选）
    volumes:
      - /path/to/adguardhome-sync/config:/config  # 配置文件目录
    ports:
      - 8080:8080               # Web API端口
    restart: unless-stopped

Docker CLI

bash
docker run -d \
  --name=adguardhome-sync \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e CONFIGFILE=/config/adguardhome-sync.yaml `# 可选：自定义配置文件路径` \
  -p 8080:8080 \
  -v /path/to/adguardhome-sync/config:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/adguardhome-sync:latest

参数说明

容器运行时通过参数进行配置，格式为<外部>:<内部>：

环境变量文件（Docker Secrets）

可通过FILE__前缀从文件中设置环境变量，例如：

bash
-e FILE__MYVAR=/run/secrets/mysecretvariable

这会将MYVAR环境变量的值设置为/run/secrets/mysecretvariable文件的内容。

Umask设置

可通过-e UMASK=022覆盖默认umask设置，用于调整容器内服务的文件权限。umask通过减法调整权限，而非直接设置权限，详情请参考umask说明。

用户/组标识符

使用卷（-v参数）时，主机与容器可能出现权限问题。通过指定PUID（用户ID）和PGID（组ID），确保主机卷目录与容器内用户权限一致。使用以下命令获取当前用户的PUID和PGID：

bash
id your_user

示例输出：

text
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker Mods

LinuxServer.io提供多种Docker Mods以扩展容器功能。上述徽章链接可查看适用于此镜像的Mods及通用Mods。

支持信息

• 容器内Shell访问：

  bash
  docker exec -it adguardhome-sync /bin/bash
  

• 实时日志监控：

  bash
  docker logs -f adguardhome-sync
  

• 容器版本号：

  bash
  docker inspect -f '{{ index .Config.Labels "build_version" }}' adguardhome-sync
  

• 镜像版本号：

  bash
  docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/adguardhome-sync:latest
  

更新信息

大部分镜像为静态版本，需更新镜像并重建容器以更新应用。更新步骤如下：

通过Docker Compose

• 更新镜像：

  • 所有镜像：

    bash
    docker-compose pull
    

  • 单个镜像：

    bash
    docker-compose pull adguardhome-sync
    

• 更新容器：

  • 所有容器：

    bash
    docker-compose up -d
    

  • 单个容器：

    bash
    docker-compose up -d adguardhome-sync
    

• 清理旧镜像：

  bash
  docker image prune
  

通过Docker Run

• 更新镜像：

  bash
  docker pull lscr.io/linuxserver/adguardhome-sync:latest
  

• 停止运行中的容器：

  bash
  docker stop adguardhome-sync
  

• 删除容器：

  bash
  docker rm adguardhome-sync
  

• 使用相同参数重建容器（配置文件通过卷映射时会保留）

• 清理旧镜像：

  bash
  docker image prune
  

镜像更新通知 - Diun（Docker Image Update Notifier）

[!TIP] 推荐使用Diun接收更新通知。不建议使用自动更新容器的工具。

本地构建

如需本地修改或自定义镜像：

bash
git clone [***]
cd docker-adguardhome-sync
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/adguardhome-sync:latest .

可使用lscr.io/linuxserver/qemu-static在x86_64硬件上构建ARM变体，反之亦然：

bash
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset

注册后，可使用-f Dockerfile.aarch64指定架构对应的Dockerfile。

版本历史

• 05.07.25： - 重新基于Alpine 3.22构建。
• 17.12.24： - 重新基于Alpine 3.21构建。
• 24.05.24： - 重新基于Alpine 3.20构建。
• 31.01.24： - 重新基于Alpine 3.19构建。
• 11.06.23： - 重新基于Alpine 3.18构建，移除armhf支持。
• 07.02.23： - 重新基于Alpine 3.17构建，更新amd64工件名称。
• 03.10.22： - 重新基于Alpine 3.16构建，迁移至s6v3。
• 18.12.21： - 重新基于Alpine 3.15构建。
• 09.08.21： - 重新基于Alpine 3.14构建。
• 08.04.21： - 初始发布。