Überblick
What is AdGuard DNS Client?
A cross-platform lightweight DNS client for AdGuard DNS. It operates as a DNS server that forwards DNS requests to the corresponding upstream resolvers.
Quick start
AdGuard DNS Client is still in the Beta stage. It may be unstable.
Supported operating systems:
- Linux
- macOS
- Windows
Supported CPU architectures:
- 64-bit ARM
- AMD64
- i386
Getting started
Unix-like operating systems
Download and unpack the
.tar.gz
or.zip
archive from the releases page.cautionOn macOS, it's crucial that globally installed daemons are owned by
root
(see thelaunchd
documentation), so theAdGuardDNSClient
executable must be placed in the/Applications/
directory or its subdirectory.Install it as a service by running:
./AdGuardDNSClient -s install -v
Edit the configuration file
config.yaml
.Start the service:
./AdGuardDNSClient -s start -v
To check that it works, use any DNS checking utility. For example, using nslookup
:
nslookup -debug 'www.example.com' '127.0.0.1'
Windows
Just download and install using the MSI installer from the releases page.
To check that it works, use any DNS checking utility. For example, using nslookup.exe
:
nslookup -debug "www.example.com" "127.0.0.1"
Command-line options
Each option overrides the corresponding value provided by the configuration file and the environment.
Help
Option -h
makes AdGuard DNS Client print out a help message to standard output and exit with a success status-code.
Service
Option -s <value>
specifies the OS service action. Possible values are:
install
: installs AdGuard DNS Client as a servicerestart
: restarts the running AdGuard DNS Client servicestart
: starts the installed AdGuard DNS Client servicestatus
: shows the status of the installed AdGuard DNS Client servicestop
: stops the running AdGuard DNS Clientuninstall
: uninstalls AdGuard DNS Client service
Verbose
Option -v
enables the verbose log output.
Version
Option --version
makes AdGuard DNS Client print out the version of the AdGuardDNSClient
executable to standard output and exit with a success status-code.
Configuration
File
The YAML configuration file is described in its own article, and there is also a sample configuration file config.dist.yaml
. Some configuration parameters can also be overridden using the environment.
Exit codes
There are a few different exit codes that may appear under different error conditions:
0
: Successfully finished and exited, no errors.1
: Internal error, most likely a misconfiguration.2
: Bad command-line argument or value.