# ![AdGuardHome Sync](<https://daemonless.io/images/logos/adguardhome-sync.svg>) AdGuardHome Sync

[![Build Status](<https://img.shields.io/github/actions/workflow/status/daemonless/adguardhome-sync/build.yaml?style=flat-square&amp;label=Build&amp;color=green>)](<https://github.com/daemonless/adguardhome-sync/actions>) [![Last Commit](<https://img.shields.io/github/last-commit/daemonless/adguardhome-sync?style=flat-square&amp;label=Last+Commit&amp;color=blue>)](<https://github.com/daemonless/adguardhome-sync/commits>) [![OCI Pulls](<https://img.shields.io/docker/pulls/daemonless/adguardhome-sync?style=flat-square&amp;label=OCI+Pulls&amp;color=blue>)](<https://hub.docker.com/r/daemonless/adguardhome-sync>)

Sync AdGuardHome configuration to replica instances.

|  |  |
| --- | --- |
| **Port** | `8080` |
| **Registry** | [`ghcr.io/daemonless/adguardhome-sync`](<https://github.com/daemonless/adguardhome-sync/pkgs/container/adguardhome-sync>) |
| **Daemonless** | [daemonless/adguardhome-sync](<https://github.com/daemonless/adguardhome-sync>) |
| **Source** | [bakito/adguardhome-sync](<https://github.com/bakito/adguardhome-sync>) |
| **Website** | [github.com/bakito/adguardhome-sync](<https://github.com/bakito/adguardhome-sync>) |

## Prerequisites

Before deploying, ensure your host environment is ready. See the [Quick Start Guide](<https://daemonless.io/guides/quick-start/index.md>) for host setup instructions, including the security model for host vs. container privileges.

## Deployment

**Customize Paths, UID & Ports**

Install and manage **AdGuardHome Sync** on FreeBSD with [fjord](<https://fjord.daemonless.io>):

```
fjord install adguardhome-sync
```

Or open the **App Store** in the fjord web UI and install **AdGuardHome Sync** from the wizard. New to fjord? See the [Install Guide](<https://fjord.daemonless.io/install/>).

```
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
      - ORIGIN_URL=  # The AdGuard Home to copy from (e.g. http://192.168.1.2:3000)
      - ORIGIN_USERNAME=  # Its admin user
      - ORIGIN_PASSWORD=<ORIGIN_PASSWORD>  # Its admin password
      - REPLICA1_URL=  # The AdGuard Home to copy to (more: REPLICA2_URL, ...)
      - REPLICA1_USERNAME=  # Its admin user
      - REPLICA1_PASSWORD=<REPLICA1_PASSWORD>  # Its admin password
      - CRON=*/10 * * * *  # When to sync, cron syntax (empty: only at start)
    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.

```
# .env

DIRECTOR_PROJECT=adguardhome-sync
PUID=1000
PGID=1000
TZ=UTC
ORIGIN_URL=
ORIGIN_USERNAME=
ORIGIN_PASSWORD=<ORIGIN_PASSWORD>
REPLICA1_URL=
REPLICA1_USERNAME=
REPLICA1_PASSWORD=<REPLICA1_PASSWORD>
CRON=*/10 * * * *
```

```
# 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}'
        - ORIGIN_URL: !ENV '${ORIGIN_URL}'
        - ORIGIN_USERNAME: !ENV '${ORIGIN_USERNAME}'
        - ORIGIN_PASSWORD: !ENV '${ORIGIN_PASSWORD}'
        - REPLICA1_URL: !ENV '${REPLICA1_URL}'
        - REPLICA1_USERNAME: !ENV '${REPLICA1_USERNAME}'
        - REPLICA1_PASSWORD: !ENV '${REPLICA1_PASSWORD}'
        - CRON: !ENV '${CRON}'
    volumes:
      - adguardhome-sync: /config
volumes:
  adguardhome-sync:
    device: '/containers/adguardhome-sync'
```

```
# 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`.

> [!WARNING]
>
> **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}`.

```
services:
  adguardhome-sync:
    name: adguardhome-sync
    image: "ghcr.io/daemonless/adguardhome-sync:latest"
    network:
      - mode: host
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
      - ORIGIN_URL=
      - ORIGIN_USERNAME=
      - ORIGIN_PASSWORD=<ORIGIN_PASSWORD>
      - REPLICA1_URL=
      - REPLICA1_USERNAME=
      - REPLICA1_PASSWORD=<REPLICA1_PASSWORD>
      - CRON=*/10 * * * *
    volumes:
      - "/containers/adguardhome-sync:/config"
```

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

## 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 |
| `ORIGIN_URL` | \`\` | The AdGuard Home to copy from (e.g. [http://192.168.1.2:3000](<http://192.168.1.2:3000>)) |
| `ORIGIN_USERNAME` | \`\` | Its admin user |
| `ORIGIN_PASSWORD` | `<ORIGIN_PASSWORD>` | Its admin password |
| `REPLICA1_URL` | \`\` | The AdGuard Home to copy to (more: REPLICA2\_URL, ...) |
| `REPLICA1_USERNAME` | \`\` | Its admin user |
| `REPLICA1_PASSWORD` | `<REPLICA1_PASSWORD>` | Its admin password |
| `CRON` | `*/10 * * * *` | When to sync, cron syntax (empty: only at start) |

### Volumes

| Path | Description |
| --- | --- |
| `/config` | Configuration directory; an adguardhome-sync.yaml here works instead of the variables |

### Ports

| Port | Protocol | Description |
| --- | --- | --- |
| `8080` | TCP | Metrics/API |

## Version Tags

| Tag | Description | Best For |
| :--- | :--- | :--- |
| `latest` | **Upstream Binary**. Built from official release. | Most users — recommended. |

> [!NOTE]
>
> **Implementation Details**
>
> - **Architectures:** amd64
> - **User:** `bsd` (UID/GID set via [PUID/PGID](<https://daemonless.io/guides/permissions/index.md>)). Defaults to `1000:1000`.
> - **Base:** Built on `ghcr.io/daemonless/base` (FreeBSD 15).

---

Need help? Join our [Discord](<https://discord.gg/Kb9tkhecZT>) community.
