ADGUARD-SYNC

Run adguard-sync rootless and distroless.

INTRODUCTION 📢

Synchronize AdGuard Home config to replicas

SYNOPSIS 📖

What can I do with this? If you want to run 11notes/adguard high-available you need something to synchronize the settings between the two or more instances. adguardhome-sync solves this issue by copying all settings from a master to infinite slaves. This image provides this functionality to you, rootless and distroless.

UNIQUE VALUE PROPOSITION 💶

Why should I run this image and not the other image(s) that already exist? Good question! Because ...

Important

• ... this image runs rootless as 1000:1000
• ... this image has no shell since it is distroless
• ... this image is auto updated to the latest version via CI/CD
• ... this image has a health check¹
• ... this image runs read-only
• ... this image is automatically scanned for CVEs before and after publishing
• ... this image is created via a secure and pinned CI/CD process
• ... this image is very small

If you value security, simplicity and optimizations to the extreme, then this image might be for you.

COMPARISON 🏁

Below you find a comparison between this image and the most used or original one.

image	11notes/adguard-sync:0.7.7	linuxserver/adguardhome-sync
image size on disk	8.14MB	46.2MB
process UID/GID	1000/1000	0/0
distroless?	✅	❌
rootless?	✅	❌

DEFAULT CONFIG 📑

cron: "*/15 * * * *"
runOnStart: true
continueOnError: false

origin:
  url: http://adguard-master:3000
  username: admin
  password: adguard

replicas:
  - url: http://adguard-slave:3000
    username: admin
    password: adguard

api:
  port: 3000
  username: admin
  password: adguard
  darkMode: true
  metrics:
    enabled: true
    scrapeInterval: 10s
    queryLogLimit: 10000

features:
  generalSettings: true
  queryLogConfig: true
  statsConfig: true
  clientSettings: true
  services: true
  filters: true
  dhcp:
    serverConfig: true
    staticLeases: true
  dns:
    serverConfig: true
    accessLists: true
    rewrites: true

VOLUMES 📁

• /adguard-sync/etc - Directory of the configuration file

COMPOSE ✂️

name: "adguard-sync"
services:
  adguard-sync:
    depends_on:
      adguard-master:
        condition: "service_healthy"
        restart: true
      adguard-slave:
        condition: "service_healthy"
        restart: true
    image: "11notes/adguard-sync:0.7.7"
    read_only: true
    environment:
      TZ: "Europe/Zurich"
    volumes:
      - "etc:/adguard/etc"
    ports:
      - "3000:3000/tcp"
    networks:
      frontend:
    restart: "always"

  adguard-master:
    image: "11notes/adguard:0.107.63"
    environment:
      TZ: "Europe/Zurich"
    ports:
      - "1053:53/udp"
      - "1053:53/tcp"
      - "3001:3000/tcp"
    networks:
      frontend:
    restart: "always"

  adguard-slave:
    image: "11notes/adguard:0.107.63"
    environment:
      TZ: "Europe/Zurich"
    ports:
      - "2053:53/udp"
      - "2053:53/tcp"
      - "3002:3000/tcp"
    networks:
      frontend:
    restart: "always"

volumes:
  etc:

networks:
  frontend:

DEFAULT SETTINGS 🗃️

Parameter	Value	Description
user	docker	user name
uid	1000	user identifier
gid	1000	group identifier
home	/adguard-sync	home directory of user docker
API login	admin // adguard	login using default config

ENVIRONMENT 📝

Parameter	Value	Default
TZ	Time Zone
DEBUG	Will activate debug option for container image and app (if available)

MAIN TAGS 🏷️

These are the main tags for the image. There is also a tag for each commit and its shorthand sha256 value.

• 0.7.7

There is no latest tag, what am I supposed to do about updates?

It is of my opinion that the :latest tag is dangerous. Many times, I’ve introduced breaking changes to my images. This would have messed up everything for some people. If you don’t want to change the tag to the latest semver, simply use the short versions of semver. Instead of using :0.7.7 you can use :0 or :0.7. Since on each new version these tags are updated to the latest version of the software, using them is identical to using :latest but at least fixed to a major or minor version.

If you still insist on having the bleeding edge release of this app, simply use the :rolling tag, but be warned! You will get the latest version of the app instantly, regardless of breaking changes or security issues or what so ever. You do this at your own risk!

REGISTRIES ☁️

docker pull 11notes/adguard-sync:0.7.7
docker pull ghcr.io/11notes/adguard-sync:0.7.7
docker pull quay.io/11notes/adguard-sync:0.7.7

SOURCE 💾

• 11notes/adguard-sync

PARENT IMAGE 🏛️

Important

This image is not based on another image but uses scratch as the starting layer. The image consists of the following distroless layers that were added:

• 11notes/distroless - contains users, timezones and Root CA certificates
• 11notes/distroless:curl - app to execute HTTP or UNIX requests

BUILT WITH 🧰

• adguardhome-sync

GENERAL TIPS 📌

Tip

• Use a reverse proxy like Traefik, Nginx, HAproxy to terminate TLS and to protect your endpoints
• Use Let’s Encrypt DNS-01 challenge to obtain valid SSL certificates for your services

CAUTION ⚠️

Caution

• This image comes with a default configuration with a default password for the admin account. Please set your own password or provide your own configuration

ElevenNotes™️

This image is provided to you at your own risk. Always make backups before updating an image to a different version. Check the releases for breaking changes. If you have any problems with using this image simply raise an issue, thanks. If you have a question or inputs please create a new discussion instead of an issue. You can find all my other repositories on github.

created 14.07.2025, 09:19:13 (CET)

Footnotes

1. There is a PR to include this custom health check into the upstream branch, till then there is custom code being used ↩