Skip to content

README.md

Latest commit

 

History

History
112 lines (85 loc) · 2.85 KB

README.md

File metadata and controls

112 lines (85 loc) · 2.85 KB

AdGuardHome Sync

Build Status Last Commit

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

Version Tags

Tag Description Best For
latest Upstream Binary. Built from official release. Most users. Matches Linux Docker behavior.

Prerequisites

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions.

Deployment

Podman Compose

services:
  adguardhome-sync:
    image: ghcr.io/daemonless/adguardhome-sync:latest
    container_name: adguardhome-sync
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
    volumes:
      - "/path/to/containers/adguardhome-sync:/config"
    ports:
      - 8080:8080
    restart: unless-stopped

Podman CLI

podman run -d --name adguardhome-sync \
  -p 8080:8080 \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=UTC \
  -v /path/to/containers/adguardhome-sync:/config \
  ghcr.io/daemonless/adguardhome-sync:latest

Ansible

- name: Deploy adguardhome-sync
  containers.podman.podman_container:
    name: adguardhome-sync
    image: ghcr.io/daemonless/adguardhome-sync:latest
    state: started
    restart_policy: always
    env:
      PUID: "1000"
      PGID: "1000"
      TZ: "UTC"
    ports:
      - "8080:8080"
    volumes:
      - "/path/to/containers/adguardhome-sync:/config"

Access at: http://localhost:8080

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

Volumes

Path Description
/config Configuration directory

Ports

Port Protocol Description
8080 TCP Metrics/API

Architectures: amd64 User: bsd (UID/GID via PUID/PGID, defaults to 1000:1000) Base: FreeBSD 15.0

Need help? Join our Discord community.