Skip to content

AdGuardHome Sync AdGuardHome Sync

Description / nameInput element
Container Registry
Container Configuration Root Path
Timezone
User ID
Group ID
AdGuardHome Sync Host Port
AdGuardHome Sync /config Path

Build Status Last Commit OCI Pulls

Sync AdGuardHome configuration to replica instances.
Port 8080
Registry ghcr.io/daemonless/adguardhome-sync
Daemonless daemonless/adguardhome-sync
Source bakito/adguardhome-sync
Website github.com/bakito/adguardhome-sync

Version Tags

Tag Description Best For
latest Upstream Binary. Built from official release. Most users — recommended.

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions, including the security model for host vs. container privileges.

Deployment

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
services:
  adguardhome-sync:
    image: "ghcr.io/daemonless/adguardhome-sync:latest"
    container_name: adguardhome-sync
    environment:
      - PUID=1000  # User ID for the application process
      - PGID=1000  # Group ID for the application process
      - TZ=UTC  # Timezone for the container
      - CONFIG_FILE=  # Path to configuration file (default: /config/adguardhome-sync.yaml)
    volumes:
      - "/containers/adguardhome-sync:/config"
    ports:
      - "8080:8080"
    # always (not unless-stopped) so FreeBSD's podman rc.d auto-starts it at boot
    restart: always

Save as compose.yaml, then run podman-compose up -d.

Warning

Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the jail's IPv4 address or hostname assigned by the virtual network.

1
2
3
4
5
6
7
# .env

DIRECTOR_PROJECT=adguardhome-sync
PUID=1000
PGID=1000
TZ=UTC
CONFIG_FILE=

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  adguardhome-sync:
    name: adguardhome_sync
    options:
      - container: 'args:--pull'
      - expose: '8080:8080 proto:tcp'
    oci:
      user: root
      environment:
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
        - CONFIG_FILE: !ENV '${CONFIG_FILE}'
    volumes:
      - ADGUARDHOME_SYNC_CONFIG_PATH: /config
volumes:
  ADGUARDHOME_SYNC_CONFIG_PATH:
    device: '/containers/adguardhome-sync'

1
2
3
4
5
6
7
# Makejail

ARG tag=latest

OPTION container=boot
OPTION overwrite=force
OPTION from=ghcr.io/daemonless/adguardhome-sync:${tag}

Save the files above, then run appjail-director up.

Experimental

Bastille's OCI support is experimental. It requires buildah and shares the host network stack (inherit). Mount volumes with --volume HOST JAIL; without it, image-declared volumes are stored under ${bastille_volumesdir}/${jail}.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
services:
  adguardhome-sync:
    name: adguardhome-sync
    image: "ghcr.io/daemonless/adguardhome-sync:latest"
    network:
      - mode: host
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
      - CONFIG_FILE=
    volumes:
      - "/containers/adguardhome-sync:/config"

Save as bastille-compose.yml, then run bastille up.

Interactive Configuration

Parameters

Environment Variables

Variable Default Description
PUID 1000 User ID for the application process
PGID 1000 Group ID for the application process
TZ UTC Timezone for the container
CONFIG_FILE `` Path to configuration file (default: /config/adguardhome-sync.yaml)

Volumes

Path Description
/config Configuration directory

Ports

Port Protocol Description
8080 TCP Metrics/API

Implementation Details

  • Architectures: amd64
  • User: bsd (UID/GID set via PUID/PGID). Defaults to 1000:1000.
  • Base: Built on ghcr.io/daemonless/base (FreeBSD 15.1).

Need help? Join our Discord community.