mirrors/AdGuardHome
1
0
Fork 0
mirror of https://github.com/AdguardTeam/AdGuardHome.git synced 2024-11-28 01:42:26 +03:00
Code Issues Projects Releases Packages Wiki Activity

Pull request: fix-headers 

Merge in DNS/adguard-home-wiki from fix-headers to master

Squashed commit of the following:

commit af93ce5d12e09a1ec7681c441cd86ecda41aa233
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Tue Nov 15 17:34:17 2022 +0300

    all: fix header case
Ainar Garipov 2022-11-16 14:58:46 +03:00
parent 36d39a12b7
commit 2a3c9d9377
14 changed files with 111 additions and 110 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
Clients.md

@ -1,19 +1,19 @@
# AdGuard Home - Configuring Clients # AdGuard Home - Configuring clients
AdGuard Home allows flexible configuration for devices that are connected to it. AdGuard Home allows flexible configuration for devices that are connected to it.
On a basic level, you may just want to be able to distinguish them and see On a basic level, you may just want to be able to distinguish them and see
friendly names instead of naked IP addresses. Additionally, AdGuard Home allows friendly names instead of naked IP addresses. Additionally, AdGuard Home allows
you applying different rules depending on the client. you applying different rules depending on the client.
* [Friendly Names](#friendlynames) * [Friendly names](#friendlynames)
* [Persistent Clients](#newclient) * [Persistent clients](#newclient)
* [Identifying clients](#idclient) * [Identifying clients](#idclient)
* [Settings](#clientsettings) * [Settings](#clientsettings)
* [Per-Client Blocking](#perclientblocking) * [Per-client blocking](#perclientblocking)
## <a href="#friendlynames" id="friendlynames" name="friendlynames">Friendly Names</a> ## <a href="#friendlynames" id="friendlynames" name="friendlynames">Friendly names</a>
AdGuard Home tries to automatically collect some basic information about the AdGuard Home tries to automatically collect some basic information about the
device that's connecting to it. device that's connecting to it.
@ -47,7 +47,7 @@ Since **v0.107.7** runtime clients sources can be disabled via the
## <a href="#newclient" id="newclient" name="newclient">Persistent Clients</a> ## <a href="#newclient" id="newclient" name="newclient">Persistent clients</a>
If you want more than just to see the client names, you may want to configure If you want more than just to see the client names, you may want to configure
each client manually. If that's the case, head to the “Settings → Clients each client manually. If that's the case, head to the “Settings → Clients
@ -117,7 +117,7 @@ of upstream DNS servers to be used for this client.
## <a href="#perclientblocking" id="perclientblocking" name="perclientblocking">Per-Client Blocking</a> ## <a href="#perclientblocking" id="perclientblocking" name="perclientblocking">Per-client blocking</a>
There are two ways of how you can configure blocking on the per-client basis. There are two ways of how you can configure blocking on the per-client basis.
Both of them are based on using AdGuard blocklist rules syntax for the rules Both of them are based on using AdGuard blocklist rules syntax for the rules

2
Comparison.md

@ -1,5 +1,5 @@
<a id="comparison"></a> <a id="comparison"></a>
## Comparing AdGuard Home to Other Solutions ## Comparing AdGuard Home to other solutions
<a id="comparison-adguard-dns"></a> <a id="comparison-adguard-dns"></a>
### How is this different from public AdGuard DNS servers? ### How is this different from public AdGuard DNS servers?

44
Configuration.md

@ -3,21 +3,21 @@
Most of these settings can be changed via the web-based admin interface. Most of these settings can be changed via the web-based admin interface.
However, we decided to list them all here just in case. However, we decided to list them all here just in case.
* [Command-line Arguments](#command-line) * [Command-line arguments](#command-line)
* [Configuring Upstreams](#upstreams) * [Configuring upstreams](#upstreams)
* [Specifying Upstreams For Domains](#upstreams-for-domains) * [Specifying upstreams for domains](#upstreams-for-domains)
* [Loading Upstreams From File](#upstreams-from-file) * [Loading upstreams from file](#upstreams-from-file)
* [Specifying Upstreams For Reverse DNS](#upstreams-for-rdns) * [Specifying upstreams for reverse DNS](#upstreams-for-rdns)
* [Private Addresses](#rdns-private) * [Private addresses](#rdns-private)
* [Public Addresses](#rdns-public) * [Public addresses](#rdns-public)
* [Client Look-Ups](#rdns-clients) * [Client lookups](#rdns-clients)
* [Configuration File](#configuration-file) * [Configuration file](#configuration-file)
* [Reset Web Password](#password-reset) * [Reset web password](#password-reset)
* [Profiling With Pprof](#pprof) * [Profiling with pprof](#pprof)
## <a href="#command-line" id="command-line" name="command-line">Command-line Arguments</a> ## <a href="#command-line" id="command-line" name="command-line">Command-line arguments</a>
Here is a list of all available command-line arguments. Here is a list of all available command-line arguments.
@ -62,7 +62,7 @@ functionality in the service as well.
## <a href="#upstreams" id="upstreams" name="upstreams">Configuring Upstreams</a> ## <a href="#upstreams" id="upstreams" name="upstreams">Configuring upstreams</a>
AdGuard Home is basically a DNS proxy that sends your DNS queries to upstream AdGuard Home is basically a DNS proxy that sends your DNS queries to upstream
servers. Multiple upstream servers for all or selected domain names can be servers. Multiple upstream servers for all or selected domain names can be
@ -103,7 +103,7 @@ Examples:
### <a href="#upstreams-for-domains" id="upstreams-for-domains" name="upstreams-for-domains">Specifying Upstreams For Domains</a> ### <a href="#upstreams-for-domains" id="upstreams-for-domains" name="upstreams-for-domains">Specifying upstreams for domains</a>
You can specify upstreams that will be used for specific domains using the You can specify upstreams that will be used for specific domains using the
dnsmasq-like syntax (see the documentation for the option `--server` dnsmasq-like syntax (see the documentation for the option `--server`
@ -188,7 +188,7 @@ but `host.com` will be forwarded to default upstreams.
sends queries for `*.host.com` to `2.2.2.2:53` except for `host.com` queries sends queries for `*.host.com` to `2.2.2.2:53` except for `host.com` queries
those are sent to `1.1.1.1:53`, but all other queries are sent to `8.8.8.8:53`. those are sent to `1.1.1.1:53`, but all other queries are sent to `8.8.8.8:53`.
### <a href="#upstreams-from-file" id="upstreams-from-file" name="upstreams-from-file">Loading Upstreams From File</a> ### <a href="#upstreams-from-file" id="upstreams-from-file" name="upstreams-from-file">Loading upstreams from file</a>
Using specific upstreams for some domains is a common way to accelerate internet Using specific upstreams for some domains is a common way to accelerate internet
in China. For an example, see https://github.com/felixonmars/dnsmasq-china-list in China. For an example, see https://github.com/felixonmars/dnsmasq-china-list
@ -210,7 +210,7 @@ accept internationalized domain names (e.g. `пример.рф` or `例子.中
a workaround, convert them to Punycode (e.g. `xn--e1afmkfd.xn--p1ai` or a workaround, convert them to Punycode (e.g. `xn--e1afmkfd.xn--p1ai` or
`xn--fsqu00a.xn--fiqs8s` respectively). See [issue 2915][2915]. `xn--fsqu00a.xn--fiqs8s` respectively). See [issue 2915][2915].
### <a href="#upstreams-for-rdns" id="upstreams-for-rdns" name="upstreams-for-rdns">Specifying Upstreams For Reverse DNS</a> ### <a href="#upstreams-for-rdns" id="upstreams-for-rdns" name="upstreams-for-rdns">Specifying upstreams for reverse DNS</a>
Using the domain-specific upstream notation, you can specify dedicated upstream Using the domain-specific upstream notation, you can specify dedicated upstream
DNS servers for reverse DNS (rDNS) requests. If you want **all** your `PTR` DNS servers for reverse DNS (rDNS) requests. If you want **all** your `PTR`
@ -242,7 +242,7 @@ no effect.
Read below for more details. Read below for more details.
#### <a href="#rdns-private" id="rdns-private" name="rdns-private">Private Addresses</a> #### <a href="#rdns-private" id="rdns-private" name="rdns-private">Private addresses</a>
Since **v0.106.0** all the addresses from [private IP ranges][private-ip] are Since **v0.106.0** all the addresses from [private IP ranges][private-ip] are
only resolved via appropriate local resolvers to avoid leaks of clients' only resolved via appropriate local resolvers to avoid leaks of clients'
@ -261,7 +261,7 @@ configuration file. If it is disabled, the unknown addresses from locally
served networks won't be resolved at all, and clients performing these queries served networks won't be resolved at all, and clients performing these queries
will receive `NXDOMAIN` responses. will receive `NXDOMAIN` responses.
#### <a href="#rdns-public" id="rdns-public" name="rdns-public">Public Addresses</a> #### <a href="#rdns-public" id="rdns-public" name="rdns-public">Public addresses</a>
If you want AdGuard Home to use another DNS server for a specific IP address If you want AdGuard Home to use another DNS server for a specific IP address
range, you can do it using the same syntax as for general upstream servers. For range, you can do it using the same syntax as for general upstream servers. For
@ -282,7 +282,7 @@ this to the “Private reverse DNS servers” field:
[/168.192.in-addr.arpa/]192.168.7.7 [/168.192.in-addr.arpa/]192.168.7.7
``` ```
#### <a href="#rdns-clients" id="rdns-clients" name="rdns-clients">Client Look-Ups</a> #### <a href="#rdns-clients" id="rdns-clients" name="rdns-clients">Client lookups</a>
AdGuard Home automatically gets the names of connected devices using reverse DNS AdGuard Home automatically gets the names of connected devices using reverse DNS
lookup (rDNS). It sends `PTR` requests with the IP addresses of clients to lookup (rDNS). It sends `PTR` requests with the IP addresses of clients to
@ -305,7 +305,7 @@ hostname resolution” setting in the “Upstream DNS servers” section or via
## <a href="#configuration-file" id="configuration-file" name="configuration-file">Configuration File</a> ## <a href="#configuration-file" id="configuration-file" name="configuration-file">Configuration file</a>
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 service is not running. Otherwise, any changes to the file will be lost because the running program will overwrite them. 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 service is not running. Otherwise, any changes to the file will be lost because the running program will overwrite them.
@ -594,7 +594,7 @@ Removing an entry from settings file will reset it to the default value. Deletin
## <a href="#password-reset" id="password-reset" name="password-reset">Reset Web Password</a> ## <a href="#password-reset" id="password-reset" name="password-reset">Reset web password</a>
Please follow these steps to create a new password for your user account: Please follow these steps to create a new password for your user account:
@ -656,7 +656,7 @@ Please follow these steps to create a new password for your user account:
## <a href="#pprof" id="pprof" name="pprof">Profiling With Pprof</a> ## <a href="#pprof" id="pprof" name="pprof">Profiling with pprof</a>
To enable pprof, set `debug_pprof: true` in yaml configuration file and then To enable pprof, set `debug_pprof: true` in yaml configuration file and then
restart AdGuard Home. Now you can get profiling information with your browser, restart AdGuard Home. Now you can get profiling information with your browser,

18
DHCP.md

@ -1,11 +1,11 @@
# AdGuard Home - DHCP Server # AdGuard Home - DHCP server
* [Prerequisites](#prereq) * [Prerequisites](#prereq)
* [Default Options](#default) * [Default options](#default)
* [Configuration](#config) * [Configuration](#config)
* [The `dhcp.dhcpv4.options` Array Field](#config-4) * [The `dhcp.dhcpv4.options` array field](#config-4)
* [DHCPv6 Options](#config-6) * [DHCPv6 options](#config-6)
* [Automatic Hosts](#autohosts) * [Automatic hosts](#autohosts)
AdGuard Home can be used as a DHCP server. This page describes how to do that. AdGuard Home can be used as a DHCP server. This page describes how to do that.
@ -20,7 +20,7 @@ AdGuard Home can be used as a DHCP server. This page describes how to do that.
## <a id="default" href="#default">Default Options</a> ## <a id="default" href="#default">Default options</a>
By default, AdGuard Home will set itself as the DNS server for the DHCP clients. By default, AdGuard Home will set itself as the DNS server for the DHCP clients.
The default lease time is 24 hours. The default lease time is 24 hours.
@ -36,7 +36,7 @@ below.
### <a id="config-4" href="#config-4">The `dhcp.dhcpv4.options` Array Field</a> ### <a id="config-4" href="#config-4">The `dhcp.dhcpv4.options` array field</a>
The `options` field is used to explicitly specify the values for DHCP options The `options` field is used to explicitly specify the values for DHCP options
and modify the response. In accordance with *Section 4.3.1* of [RFC and modify the response. In accordance with *Section 4.3.1* of [RFC
@ -193,7 +193,7 @@ client implementations among the many existing. In accordance with [RFC
if requested by client within the option `55` (Parameter Request List). if requested by client within the option `55` (Parameter Request List).
### <a id="config-6" href="#config-6">DHCPv6 Options</a> ### <a id="config-6" href="#config-6">DHCPv6 options</a>
The option `dhcp.dhcpv6.ra_slaac_only`, if `true`, sends RA packets forcing the The option `dhcp.dhcpv6.ra_slaac_only`, if `true`, sends RA packets forcing the
clients to use SLAAC. The DHCPv6 server won't be started in this case. clients to use SLAAC. The DHCPv6 server won't be started in this case.
@ -208,7 +208,7 @@ the clients to choose between SLAAC and DHCPv6.
## <a id="autohosts" href="#autohosts">Automatic Hosts</a> ## <a id="autohosts" href="#autohosts">Automatic hosts</a>
Machines in the network can be reached more easily using the hostnames they send Machines in the network can be reached more easily using the hostnames they send
in the DHCP requests with a configurable top-level domain (TLD). By default, in the DHCP requests with a configurable top-level domain (TLD). By default,

12
DNSCrypt.md

@ -1,14 +1,14 @@
# AdGuard Home - DNSCrypt # AdGuard Home - DNSCrypt
* [Generating A Configuration File](#generate-config) * [Generating a Configuration file](#generate-config)
* [Generating A DNSCrypt Stamp](#generate-stamp) * [Generating a DNSCrypt stamp](#generate-stamp)
* [Configuring Devices To Use DNSCrypt](#configure-devices) * [Configuring devices to use DNSCrypt](#configure-devices)
**Since v0.105.0**, AdGuard Home is able to work as a DNSCrypt server. However, **Since v0.105.0**, AdGuard Home is able to work as a DNSCrypt server. However,
this feature is only available via configuration file, you cannot set it up this feature is only available via configuration file, you cannot set it up
using the Web UI. This guide explains how to do this. using the Web UI. This guide explains how to do this.
## <a href="#generate-config" id="#generate-config" name="generate-config">Generating A Configuration File</a> ## <a href="#generate-config" id="#generate-config" name="generate-config">Generating a configuration file</a>
Here is how to generate a DNSCrypt configuration file and point AdGuard Home to Here is how to generate a DNSCrypt configuration file and point AdGuard Home to
it: it:
@ -112,7 +112,7 @@ it:
## <a href="#generate-stamp" id="generate-stamp" name="generate-stamp">Generating A DNSCrypt Stamp</a> ## <a href="#generate-stamp" id="generate-stamp" name="generate-stamp">Generating a DNSCrypt stamp</a>
Here is how to generate a DNSCrypt stamp and check your installation: Here is how to generate a DNSCrypt stamp and check your installation:
@ -150,7 +150,7 @@ Here is how to generate a DNSCrypt stamp and check your installation:
## <a href="#configure-devices" id="configure-devices" name="configure-devices">Configuring Devices To Use DNSCrypt</a> ## <a href="#configure-devices" id="configure-devices" name="configure-devices">Configuring devices to use DNSCrypt</a>
* **All platforms:** [`dnscrypt-proxy`][prox] (reference implementation). * **All platforms:** [`dnscrypt-proxy`][prox] (reference implementation).
DNSCrypt-Proxy is a command-line proxy for Linux, BSD, Windows, MacOS, DNSCrypt-Proxy is a command-line proxy for Linux, BSD, Windows, MacOS,

20
Docker.md

@ -14,11 +14,11 @@
</p> </p>
* [Introduction](#introduction) * [Introduction](#introduction)
* [Quick Start](#quickstart) * [Quick start](#quickstart)
* [Update To A Newer Version](#update) * [Update to a newer version](#update)
* [Running Development Builds](#unstable) * [Running development builds](#unstable)
* [Additional Configuration](#configuration) * [Additional configuration](#configuration)
* [DHCP Server](#dhcp) * [DHCP server](#dhcp)
* [`resolved`](#resolved-daemon) * [`resolved`](#resolved-daemon)
@ -34,7 +34,7 @@ repository][agh].
## <a href="#quickstart" id="quickstart" name="quickstart">Quick Start</a> ## <a href="#quickstart" id="quickstart" name="quickstart">Quick start</a>
### Pull the Docker image ### Pull the Docker image
@ -108,7 +108,7 @@ Port mappings you might need:
## <a href="#update" id="update" name="update">Update To A Newer Version</a> ## <a href="#update" id="update" name="update">Update to a newer version</a>
1. Pull the new version from Docker Hub: 1. Pull the new version from Docker Hub:
@ -129,7 +129,7 @@ Port mappings you might need:
## <a href="#unstable" id="unstable" name="unstable">Running Development Builds</a> ## <a href="#unstable" id="unstable" name="unstable">Running development builds</a>
If you want to be on the bleeding edge, you might want to run the image from the If you want to be on the bleeding edge, you might want to run the image from the
`edge` or `beta` tags. In order to use it, simply replace `adguard/adguardhome` `edge` or `beta` tags. In order to use it, simply replace `adguard/adguardhome`
@ -142,7 +142,7 @@ docker pull adguard/adguardhome:edge
## <a href="#configuration" id="configuration" name="configuration">Additional Configuration</a> ## <a href="#configuration" id="configuration" name="configuration">Additional configuration</a>
Upon the first run, a file with the default values named `AdGuardHome.yaml` is Upon the first run, a file with the default values named `AdGuardHome.yaml` is
created. You can modify the file while your AdGuard Home container is not created. You can modify the file while your AdGuard Home container is not
@ -157,7 +157,7 @@ configurable parameters and their values is available on [this page][conf].
## <a href="#dhcp" id="dhcp" name="dhcp">DHCP Server</a> ## <a href="#dhcp" id="dhcp" name="dhcp">DHCP server</a>
If you want to use AdGuardHome's DHCP server, you should pass `--network host` If you want to use AdGuardHome's DHCP server, you should pass `--network host`
argument when creating the container: argument when creating the container:

30
Getting-Started.md

@ -1,19 +1,19 @@
# AdGuard Home - Getting Started # AdGuard Home - Getting Started
* [Installation](#installation) * [Installation](#installation)
* [First Start](#first-time) * [First start](#first-time)
* [Running As A Service](#service) * [Running as a service](#service)
* [Updating](#update) * [Updating](#update)
* [Manual Update](#manual-update) * [Manual update](#manual-update)
* [Configuring Devices](#configure-devices) * [Configuring devices](#configure-devices)
* [Running Without Superuser (Linux Only)](#running-without-superuser) * [Running without superuser (Linux only)](#running-without-superuser)
* [Limitations](#limitations) * [Limitations](#limitations)
## <a href="#installation" id="installation" name="installation">Installation</a> ## <a href="#installation" id="installation" name="installation">Installation</a>
### Official Releases ### Official releases
Download the archive with the binary file for your operating system from the Download the archive with the binary file for your operating system from the
[latest stable release page][releases]. The full list of supported platforms as [latest stable release page][releases]. The full list of supported platforms as
@ -41,7 +41,7 @@ To install AdGuard Home as a service, unpack the archive, enter the
### Docker And Snap ### Docker and Snap
We also provide an [official AdGuard Home docker image][docker] and an [official We also provide an [official AdGuard Home docker image][docker] and an [official
Snap Store package][snap]. Snap Store package][snap].
@ -75,7 +75,7 @@ Some other unofficial options include:
## <a href="#first-time" id="first-time" name="first-time">First Start</a> ## <a href="#first-time" id="first-time" name="first-time">First start</a>
First of all, check your firewall settings. To install and use AdGuard Home, First of all, check your firewall settings. To install and use AdGuard Home,
the following ports and protocols must be available: the following ports and protocols must be available:
@ -115,7 +115,7 @@ There you will go through the initial configuration wizard.
## <a href="#service" id="service" name="service">Running As A Service</a> ## <a href="#service" id="service" name="service">Running as a service</a>
The next step would be to register AdGuard Home as a system service (aka The next step would be to register AdGuard Home as a system service (aka
daemon). To install AdGuard Home as a service, run: daemon). To install AdGuard Home as a service, run:
@ -163,7 +163,7 @@ configuration file, so you can revert the changes, if necessary.
### <a href="#manual-update" id="manual-update" name="manual-update">Manual Update</a> ### <a href="#manual-update" id="manual-update" name="manual-update">Manual update</a>
In case the button isn't shown or an automatic update has failed, you can update In case the button isn't shown or an automatic update has failed, you can update
manually. We have a [detailed guide on manual updates][mupd], but in short: manually. We have a [detailed guide on manual updates][mupd], but in short:
@ -180,7 +180,7 @@ manually. We have a [detailed guide on manual updates][mupd], but in short:
### Docker, Home Assistant, And Snapcraft Updates ### Docker, Home Assistant, and Snapcraft updates
Auto-updates for Docker, Hass.io / Home Assistant, and Snapcraft installations Auto-updates for Docker, Hass.io / Home Assistant, and Snapcraft installations
are disabled. Update the image instead. are disabled. Update the image instead.
@ -197,7 +197,7 @@ To update AdGuard Home package without the need to use Web API run:
## <a href="#configure-devices" id="configure-devices" name="configure-devices">Configuring Devices</a> ## <a href="#configure-devices" id="configure-devices" name="configure-devices">Configuring devices</a>
### Router ### Router
@ -288,13 +288,13 @@ and you won't need to configure each of them manually.
## <a href="#running-without-superuser" id="running-without-superuser" name="running-without-superuser">Running Without Superuser (Linux Only)</a> ## <a href="#running-without-superuser" id="running-without-superuser" name="running-without-superuser">Running without superuser (Linux only)</a>
You can run AdGuard Home without superuser privileges, but you need to either You can run AdGuard Home without superuser privileges, but you need to either
grant the binary a capability (on Linux) or instruct it to use a different port grant the binary a capability (on Linux) or instruct it to use a different port
(all platforms). (all platforms).
### Granting The Necessary Capabilities ### Granting the necessary capabilities
Using this method requires the `setcap` utility. You may need to install it Using this method requires the `setcap` utility. You may need to install it
using your Linux distribution's package manager. using your Linux distribution's package manager.
@ -310,7 +310,7 @@ Then run `./AdGuardHome` as an unprivileged user.
### Changing The DNS Listen Port ### Changing the DNS listen port
To configure AdGuard Home to listen on a port that does not require superuser To configure AdGuard Home to listen on a port that does not require superuser
privileges, stop AdGuard Home, open `AdGuardHome.yaml` in your editor, and find privileges, stop AdGuard Home, open `AdGuardHome.yaml` in your editor, and find

10
Home.md

@ -18,10 +18,10 @@ Welcome to the AdGuard Home wiki!
## Guides ## Guides
* [Getting Started](Getting-Started) * [Getting started](Getting-Started)
* [FAQ](FAQ) * [FAQ](FAQ)
* [How to Write Hosts Blocklists](Hosts-Blocklists) * [How to write hosts blocklists](Hosts-Blocklists)
* [Comparing AdGuard Home to Other Solutions](Comparison) * [Comparing AdGuard Home to other solutions](Comparison)
* Configuring AdGuard * Configuring AdGuard
* [Configuration](Configuration) * [Configuration](Configuration)
* [Configuring AdGuard Home Clients](Clients) * [Configuring AdGuard Home Clients](Clients)
@ -32,7 +32,7 @@ Welcome to the AdGuard Home wiki!
* [Docker](Docker) * [Docker](Docker)
* [OpenWrt][owwiki] (on the OpenWrt Wiki) * [OpenWrt][owwiki] (on the OpenWrt Wiki)
* [Raspberry Pi](Raspberry-Pi) * [Raspberry Pi](Raspberry-Pi)
* [Virtual Private Server](VPS) * [Virtual private server](VPS)
* [Verifying Releases](Verify-Releases) * [Verifying releases](Verify-Releases)
[owwiki]: https://openwrt.org/docs/guide-user/services/dns/adguard-home [owwiki]: https://openwrt.org/docs/guide-user/services/dns/adguard-home

35
Hosts-Blocklists.md

@ -1,11 +1,12 @@
# AdGuard Home - How to Write Hosts Blocklists # AdGuard Home - How to write hosts blocklists
* [Introduction](#introduction) * [Introduction](#introduction)
* [Basic Examples](#rules-examples) * [Basic examples](#rules-examples)
* [Adblock-Style Syntax](#adblock-style) * [Adblock-style syntax](#adblock-style)
* [Special Characters](#special-characters) * [Special characters](#special-characters)
* [Regular Expressions](#regular-expressions) * [Regular expressions](#regular-expressions)
* [Rule Modifiers](#modifiers) * [Comments](#comments)
* [Rule modifiers](#modifiers)
* [`client`](#client) * [`client`](#client)
* [`denyallow`](#denyallow) * [`denyallow`](#denyallow)
* [`dnstype`](#dnstype) * [`dnstype`](#dnstype)
@ -13,9 +14,9 @@
* [`important`](#important) * [`important`](#important)
* [`badfilter`](#badfilter) * [`badfilter`](#badfilter)
* [`ctag`](#ctag) * [`ctag`](#ctag)
* [`/etc/hosts`-Style Syntax](#etc-hosts) * [`/etc/hosts`-style syntax](#etc-hosts)
* [Domains-Only Syntax](#domains-only) * [Domains-only syntax](#domains-only)
* [Hostlists Compiler](#hostlists-compiler) * [Hostlists compiler](#hostlists-compiler)
@ -61,7 +62,7 @@ the ID from the table of contents didn't match. Add it here so that old links
work. --> work. -->
<a id="-rules-examples" name="-rules-examples"></a> <a id="-rules-examples" name="-rules-examples"></a>
## <a href="#rules-examples" id="rules-examples" name="rules-examples">Basic Examples</a> ## <a href="#rules-examples" id="rules-examples" name="rules-examples">Basic examples</a>
* `||example.org^`: block access to the `example.org` domain and all its * `||example.org^`: block access to the `example.org` domain and all its
subdomains, like `www.example.org`. subdomains, like `www.example.org`.
@ -93,7 +94,7 @@ work. -->
## <a href="#adblock-style" id="adblock-style" name="adblock-style">Adblock-Style Syntax</a> ## <a href="#adblock-style" id="adblock-style" name="adblock-style">Adblock-style syntax</a>
This is a subset of the [traditional Adblock-style][adb] syntax which is used by This is a subset of the [traditional Adblock-style][adb] syntax which is used by
browser ad blockers. browser ad blockers.
@ -114,7 +115,7 @@ modifiers = [modifier0, modifier1[, ...[, modifierN]]]
### <a href="#special-characters" id="special-characters" name="special-characters">Special Characters</a> ### <a href="#special-characters" id="special-characters" name="special-characters">Special characters</a>
* `*`: the wildcard character. It is used to represent any set of characters. * `*`: the wildcard character. It is used to represent any set of characters.
This can also be an empty string or a string of any length. This can also be an empty string or a string of any length.
@ -134,7 +135,7 @@ modifiers = [modifier0, modifier1[, ...[, modifierN]]]
### <a href="#regular-expressions" id="regular-expressions" name="regular-expressions">Regular Expressions</a> ### <a href="#regular-expressions" id="regular-expressions" name="regular-expressions">Regular expressions</a>
If you want even more flexibility in making rules, you can use [regular If you want even more flexibility in making rules, you can use [regular
expressions][regexp] instead of the default simplified matching syntax. If you expressions][regexp] instead of the default simplified matching syntax. If you
@ -168,7 +169,7 @@ Example:
### <a href="#modifiers" id="modifiers" name="modifiers">Rule Modifiers</a> ### <a href="#modifiers" id="modifiers" name="modifiers">Rule modifiers</a>
You can change the behavior of a rule by adding modifiers. Modifiers must be You can change the behavior of a rule by adding modifiers. Modifiers must be
located at the end of the rule after the `$` character and be separated by located at the end of the rule after the `$` character and be separated by
@ -606,7 +607,7 @@ The list of allowed tags:
## <a href="#etc-hosts" id="etc-hosts" name="etc-hosts">`/etc/hosts`-Style Syntax</a> ## <a href="#etc-hosts" id="etc-hosts" name="etc-hosts">`/etc/hosts`-style syntax</a>
For each host a single line should be present with the following information: For each host a single line should be present with the following information:
@ -637,7 +638,7 @@ The IP addresses are used to respond to the DNS queries for these domains.
## <a href="#domains-only" id="domains-only" name="domains-only">Domains-Only Syntax</a> ## <a href="#domains-only" id="domains-only" name="domains-only">Domains-only syntax</a>
A simple list of domain names, one name per line. A simple list of domain names, one name per line.
@ -655,7 +656,7 @@ consider it to be an [Adblock-style](#adblock-style) rule.
## <a href="#hostlists-compiler" id="hostlists-compiler" name="hostlists-compiler">Hostlists Compiler</a> ## <a href="#hostlists-compiler" id="hostlists-compiler" name="hostlists-compiler">Hostlists compiler</a>
If you are maintaining a blocklist and use different sources in it, [Hostlists If you are maintaining a blocklist and use different sources in it, [Hostlists
compiler][hlc] may be useful to you. It is a simple tool that makes it easier compiler][hlc] may be useful to you. It is a simple tool that makes it easier

4
Platforms.md

@ -1,7 +1,7 @@
# AdGuard Home - Supported Platforms # AdGuard Home - Supported Platforms
* [Changes](#changes) * [Changes](#changes)
* [Packaged Releases](#releases) * [Packaged releases](#releases)
* [Docker](#docker) * [Docker](#docker)
* [Snapcraft](#snap) * [Snapcraft](#snap)
@ -19,7 +19,7 @@
## <a href="#releases" id="releases" name="releases">Packaged Releases</a> ## <a href="#releases" id="releases" name="releases">Packaged releases</a>
The official AdGuard Home packaged releases are listed in the table below: The official AdGuard Home packaged releases are listed in the table below:

8
Raspberry-Pi.md

@ -1,4 +1,4 @@
# How To Install And Run AdGuard Home On A Raspberry Pi # How to install and run AdGuard Home on a Raspberry Pi
You can install AdGuard Home on your [Raspberry Pi][pi] and use it to filter ads You can install AdGuard Home on your [Raspberry Pi][pi] and use it to filter ads
and save traffic. Once it is installed, you can use your AdGuard Home on any and save traffic. Once it is installed, you can use your AdGuard Home on any
@ -13,7 +13,7 @@ machine connected to the same local network.
## <a href="#prepare" id="prepare" name="prepare">Prepare Your Pi</a> ## <a href="#prepare" id="prepare" name="prepare">Prepare your Pi</a>
You'll need a Raspberry Pi with network access and [SSH enabled][ssh]. Connect You'll need a Raspberry Pi with network access and [SSH enabled][ssh]. Connect
it to a display and a keyboard, boot it, and write down the IP address that has it to a display and a keyboard, boot it, and write down the IP address that has
@ -84,7 +84,7 @@ Here are the other commands you might need to control the service:
## <a href="#check" id="check" name="check">Check The Filtering</a> ## <a href="#check" id="check" name="check">Check the filtering</a>
You can verify that it's working properly by running this on your Pi: You can verify that it's working properly by running this on your Pi:
@ -105,7 +105,7 @@ Host doubleclick.net not found: 3(NXDOMAIN)
## <a href="#devices" id="devices" name="devices">Configure Your Devices</a> ## <a href="#devices" id="devices" name="devices">Configure your devices</a>
Once it is confirmed that AdGuard Home works on our Raspberry Pi, you can use it Once it is confirmed that AdGuard Home works on our Raspberry Pi, you can use it
on other computers in your network by changing their system DNS settings to use on other computers in your network by changing their system DNS settings to use

2
VPS.md

@ -1,4 +1,4 @@
# How to Install and Run AdGuard Home on a Virtual Private Server # How to install and run AdGuard Home on a virtual private server (VPS)
To run AdGuard Home on a VPS, you need a server with Debian 8 or 9, x64 or x32. To run AdGuard Home on a VPS, you need a server with Debian 8 or 9, x64 or x32.

2
Verify-Releases.md

@ -1,4 +1,4 @@
# Verifying AdGuard Home Releases # Verifying AdGuard Home releases
Since AdGuard Home v0.103.4 we sign the executable files we build so that you Since AdGuard Home v0.103.4 we sign the executable files we build so that you
can verify they are really created by us and no one else. Inside an archive can verify they are really created by us and no one else. Inside an archive

18
__Sidebar.md

@ -2,16 +2,16 @@
* [Getting Started](Getting-Started) * [Getting Started](Getting-Started)
* [FAQ](FAQ) * [FAQ](FAQ)
* [How to Write Hosts Blocklists](Hosts-Blocklists) * [How to write hosts blocklists](Hosts-Blocklists)
* [Comparing AdGuard Home to Other Solutions](Comparison) * [Comparing AdGuard Home to other solutions](Comparison)
* Installation * Installation
* [Supported platforms](Platforms) * [Supported platforms](Platforms)
* [Docker](Docker) * [Docker](Docker)
* [How to Install and Run AdGuard Home on a Raspberry Pi](Raspberry-Pi) * [How to install and run AdGuard Home on a Raspberry Pi](Raspberry-Pi)
* [How to Install and Run AdGuard Home on a Virtual Private Server](VPS) * [How to install and run AdGuard Home on a virtual private server](VPS)
* [Configuration](Configuration) * [Configuration](Configuration)
* [Configuring AdGuard Home Clients](Clients) * [Configuring AdGuard Home clients](Clients)
* [AdGuard Home as a DoH, DoT, or DoQ Server](Encryption) * [AdGuard Home as a DoH, DoT, or DoQ server](Encryption)
* [AdGuard Home as a DNSCrypt Server](DNSCrypt) * [AdGuard Home as a DNSCrypt server](DNSCrypt)
* [AdGuard Home as a DHCP Server](DHCP) * [AdGuard Home as a DHCP server](DHCP)
* [Verifying Releases](Verify-Releases) * [Verifying releases](Verify-Releases)