Skip to content

Docker

Jump to bottom
Andrey Meshkov edited this page Jun 10, 2020 · 21 revisions

AdGuard Home - Docker

 

AdGuard Home

Privacy protection center for you and your devices

Free and open source, powerful network-wide ads & trackers blocking DNS server.


  1. Introduction
  2. Quick Start
  3. How to update to a newer version
  4. Running dev builds
  5. Supported tags / architectures
  6. Additional configuration
  7. Running DHCP server
  8. Running on a system with 'resolved' daemon

Introduction

AdGuard Home is a network-wide software for blocking ads & tracking. After you set it up, it'll cover ALL your home devices, and you don't need any client-side software for that. You can learn more about it in our official Github repository.

Quick Start

1. Pull the Docker image

This command will pull the latest stable version:

docker pull adguard/adguardhome

2. Create directories for persistent configuration and data

The image exposes two volumes for data/configuration persistence. You should create a data directory on a suitable volume on your host system, e.g. /my/own/workdir, and a config directory on a suitable volume on your host system, e.g. /my/own/confdir.

3. Create and run the container

Use the following command to create a new container and run AdGuard Home:

docker run --name adguardhome -v /my/own/workdir:/opt/adguardhome/work -v /my/own/confdir:/opt/adguardhome/conf -p 53:53/tcp -p 53:53/udp -p 67:67/udp -p 68:68/tcp -p 68:68/udp -p 80:80/tcp -p 443:443/tcp -p 853:853/tcp -p 3000:3000/tcp -d adguard/adguardhome

Don't forget to use your own data and config directories!

Now you can open the browser and navigate to http://127.0.0.1:3000/ to control your AdGuard Home service.

4. Control the container

  • Start: docker start adguardhome
  • Stop: docker stop adguardhome
  • Remove: docker rm adguardhome

How to update to a newer version

  1. Pull the new version from Docker Hub

    docker pull adguard/adguardhome

  2. Stop and remove currently running container (assuming the container is named adguardhome):

    docker stop adguardhome
docker rm adguardhome

  3. Create and start the container using the new image:

    docker run --name adguardhome -v /my/own/workdir:/opt/adguardhome/work -v /my/own/confdir:/opt/adguardhome/conf -p 53:53/tcp -p 53:53/udp -p 67:67/udp -p 68:68/tcp -p 68:68/udp -p 80:80/tcp -p 443:443/tcp -p 853:853/tcp -p 3000:3000/tcp -d adguard/adguardhome

Running dev builds

If you want to be on the bleeding edge, you might want to run the image from the edge tag. It is automatically synced with the repository master branch.

In order to use it, simply replace adguard/adguardhome with adguard/adguardhome:edge in every command from the quick start.

docker pull adguard/adguardhome:edge

Supported tags / architectures

adguard/adguardhome image is built for different architectures and supports the following tags:

  • latest - latest stable build from the last tagged release.
  • edge - latest build from the repository master branch, may be unstable.
  • $version - specific release e.g. v0.92.

Tags for different architectures

  • ARM64 - 64bit ARM build
    • arm64-latest
    • arm64-edge
  • ARMHF - 32bit ARM build
    • armhf-latest
    • armhf-edge
  • i386 - x86 build
    • i386-latest
    • i386-edge
  • AMD64 - x86_64 build default
    • latest
    • edge

Additional configuration

Upon the first execution, a file named AdGuardHome.yaml will be created, with default values written in it. You can modify the file while your AdGuard Home container is not running. Otherwise, any changes to the file will be lost because the running program will overwrite them.

Settings are stored in YAML format, possible parameters that you can configure are listed on this page.

Running DHCP server

If you want to use AdGuardHome's DHCP server, you should pass --network host argument when creating the container:

docker run --name adguardhome --network host -v /my/own/workdir:/opt/adguardhome/work -v /my/own/confdir:/opt/adguardhome/conf -d adguard/adguardhome

This option instructs docker to use the host's network rather than docker-bridged network. Note that port mapping with -p is not necessary now.

A note from Docker Documentation:

The host networking driver only works on Linux hosts, and is not supported on Docker Desktop for Mac, Docker Desktop for Windows, or Docker EE for Windows Server.

Running on a system with 'resolved' daemon

If you try to run AdGuardHome on a system where resolved daemon is working, docker will fail to bind on port 53, because resolved daemon is listening on 127.0.0.53:53.

Here's how you can disable DNSStubListener on your machine.

Deactivate DNSStubListener and update DNS server address. Create a new file: /etc/systemd/resolved.conf.d/adguardhome.conf (create a /etc/systemd/resolved.conf.d directory if necessary):

[Resolve]
DNS=127.0.0.1
DNSStubListener=no

Specifying "127.0.0.1" as DNS server address is necessary because otherwise the nameserver will be "127.0.0.53" which doesn't work without DNSStubListener.

Activate another resolv.conf file:

mv /etc/resolv.conf /etc/resolv.conf.backup
ln -s /run/systemd/resolve/resolv.conf /etc/resolv.conf

Stop DNSStubListener:

systemctl reload-or-restart systemd-resolved

Guides

Clone this wiki locally