12 KiB
Executable File
title |
---|
adguardhome-sync |
linuxserver/adguardhome-sync
Adguardhome-sync is a tool to synchronize AdGuardHome config to replica instances.
Supported Architectures
We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling lscr.io/linuxserver/adguardhome-sync:latest
should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are:
Architecture | Available | Tag |
---|---|---|
x86-64 | ✅ | amd64-<version tag> |
arm64 | ✅ | arm64v8-<version tag> |
armhf | ❌ |
Version Tags
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag | Available | Description |
---|---|---|
latest | ✅ | Stable releases from GitHub |
Application Setup
Edit the adguardhome-sync.yaml with your AdGuardHome instance details, for more information check out AdGuardHome Sync.
Usage
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
docker-compose (recommended, click here for more info)
---
services:
adguardhome-sync:
image: lscr.io/linuxserver/adguardhome-sync:latest
container_name: adguardhome-sync
environment:
- PUID=1000
- PGID=1000
- TZ=Etc/UTC
- CONFIGFILE=/config/adguardhome-sync.yaml #optional
volumes:
- /path/to/appdata/config:/config
ports:
- 8080:8080
restart: unless-stopped
docker cli (click here for more info)
docker run -d \
--name=adguardhome-sync \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Etc/UTC \
-e CONFIGFILE=/config/adguardhome-sync.yaml `#optional` \
-p 8080:8080 \
-v /path/to/appdata/config:/config \
--restart unless-stopped \
lscr.io/linuxserver/adguardhome-sync:latest
Parameters
Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal>
respectively. For example, -p 8080:80
would expose port 80
from inside the container to be accessible from the host's IP on port 8080
outside the container.
Ports (-p
)
Parameter | Function |
---|---|
8080 |
Port for AdGuardHome Sync's web API. |
Environment Variables (-e
)
Env | Function |
---|---|
PUID=1000 |
for UserID - see below for explanation |
PGID=1000 |
for GroupID - see below for explanation |
TZ=Etc/UTC |
specify a timezone to use, see this list. |
CONFIGFILE=/config/adguardhome-sync.yaml |
Set a custom config file. |
Volume Mappings (-v
)
Volume | Function |
---|---|
/config |
Contains all relevant configuration files. |
Miscellaneous Options
Parameter | Function |
---|
Environment variables from files (Docker secrets)
You can set any environment variable from a file by using a special prepend FILE__
.
As an example:
-e FILE__MYVAR=/run/secrets/mysecretvariable
Will set the environment variable MYVAR
based on the contents of the /run/secrets/mysecretvariable
file.
Umask for running applications
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022
setting.
Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.
User / Group Identifiers
When using volumes (-v
flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID
and group PGID
.
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance PUID=1000
and PGID=1000
, to find yours use id your_user
as below:
id your_user
Example output:
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
Docker Mods
We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
Support Info
-
Shell access whilst the container is running:
docker exec -it adguardhome-sync /bin/bash
-
To monitor the logs of the container in realtime:
docker logs -f adguardhome-sync
-
Container version number:
docker inspect -f '{{ index .Config.Labels "build_version" }}' adguardhome-sync
-
Image version number:
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/adguardhome-sync:latest
Updating Info
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.
Below are the instructions for updating containers:
Via Docker Compose
-
Update images:
-
All images:
docker-compose pull
-
Single image:
docker-compose pull adguardhome-sync
-
-
Update containers:
-
All containers:
docker-compose up -d
-
Single container:
docker-compose up -d adguardhome-sync
-
-
You can also remove the old dangling images:
docker image prune
Via Docker Run
-
Update the image:
docker pull lscr.io/linuxserver/adguardhome-sync:latest
-
Stop the running container:
docker stop adguardhome-sync
-
Delete the container:
docker rm adguardhome-sync
-
Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your
/config
folder and settings will be preserved) -
You can also remove the old dangling images:
docker image prune
Image Update Notifications - Diun (Docker Image Update Notifier)
!!! tip
We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
Building locally
If you want to make local modifications to these images for development purposes or just to customize the logic:
git clone https://github.com/linuxserver/docker-adguardhome-sync.git
cd docker-adguardhome-sync
docker build \
--no-cache \
--pull \
-t lscr.io/linuxserver/adguardhome-sync:latest .
The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static
docker run --rm --privileged multiarch/qemu-user-static:register --reset
Once registered you can define the dockerfile to use with -f Dockerfile.aarch64
.
Versions
- 11.06.23: - Rebase to Alpine 3.18, deprecate armhf.
- 07.02.23: - Rebase to Alpine 3.17, update amd64 artifact name.
- 03.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 18.12.21: - Rebase to Alpine 3.15.
- 09.08.21: - Rebase to Alpine 3.14.
- 08.04.21: - Initial Release.