diff --git a/Clients.md b/Clients.md index d3fa718..0202ee8 100644 --- a/Clients.md +++ b/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. 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 you applying different rules depending on the client. - * [Friendly Names](#friendlynames) - * [Persistent Clients](#newclient) + * [Friendly names](#friendlynames) + * [Persistent clients](#newclient) * [Identifying clients](#idclient) * [Settings](#clientsettings) - * [Per-Client Blocking](#perclientblocking) + * [Per-client blocking](#perclientblocking) -## Friendly Names +## Friendly names AdGuard Home tries to automatically collect some basic information about the device that's connecting to it. @@ -47,7 +47,7 @@ Since **v0.107.7** runtime clients sources can be disabled via the -## Persistent Clients +## Persistent clients 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 @@ -117,7 +117,7 @@ of upstream DNS servers to be used for this client. -## Per-Client Blocking +## Per-client blocking 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 diff --git a/Comparison.md b/Comparison.md index 811d662..55607ca 100644 --- a/Comparison.md +++ b/Comparison.md @@ -1,5 +1,5 @@ -## Comparing AdGuard Home to Other Solutions +## Comparing AdGuard Home to other solutions ### How is this different from public AdGuard DNS servers? diff --git a/Configuration.md b/Configuration.md index 731c6b3..be21d88 100644 --- a/Configuration.md +++ b/Configuration.md @@ -3,21 +3,21 @@ Most of these settings can be changed via the web-based admin interface. However, we decided to list them all here just in case. - * [Command-line Arguments](#command-line) - * [Configuring Upstreams](#upstreams) - * [Specifying Upstreams For Domains](#upstreams-for-domains) - * [Loading Upstreams From File](#upstreams-from-file) - * [Specifying Upstreams For Reverse DNS](#upstreams-for-rdns) - * [Private Addresses](#rdns-private) - * [Public Addresses](#rdns-public) - * [Client Look-Ups](#rdns-clients) - * [Configuration File](#configuration-file) - * [Reset Web Password](#password-reset) - * [Profiling With Pprof](#pprof) + * [Command-line arguments](#command-line) + * [Configuring upstreams](#upstreams) + * [Specifying upstreams for domains](#upstreams-for-domains) + * [Loading upstreams from file](#upstreams-from-file) + * [Specifying upstreams for reverse DNS](#upstreams-for-rdns) + * [Private addresses](#rdns-private) + * [Public addresses](#rdns-public) + * [Client lookups](#rdns-clients) + * [Configuration file](#configuration-file) + * [Reset web password](#password-reset) + * [Profiling with pprof](#pprof) -## Command-line Arguments +## Command-line arguments Here is a list of all available command-line arguments. @@ -62,7 +62,7 @@ functionality in the service as well. -## Configuring Upstreams +## Configuring upstreams 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 @@ -103,7 +103,7 @@ Examples: - ### Specifying Upstreams For Domains + ### Specifying upstreams for domains You can specify upstreams that will be used for specific domains using the 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 those are sent to `1.1.1.1:53`, but all other queries are sent to `8.8.8.8:53`. - ### Loading Upstreams From File + ### Loading upstreams from file 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 @@ -210,7 +210,7 @@ accept internationalized domain names (e.g. `пример.рф` or `例子.中 a workaround, convert them to Punycode (e.g. `xn--e1afmkfd.xn--p1ai` or `xn--fsqu00a.xn--fiqs8s` respectively). See [issue 2915][2915]. - ### Specifying Upstreams For Reverse DNS + ### Specifying upstreams for reverse DNS Using the domain-specific upstream notation, you can specify dedicated upstream DNS servers for reverse DNS (rDNS) requests. If you want **all** your `PTR` @@ -242,7 +242,7 @@ no effect. Read below for more details. - #### Private Addresses + #### Private addresses 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' @@ -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 will receive `NXDOMAIN` responses. - #### Public Addresses + #### Public addresses 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 @@ -282,7 +282,7 @@ this to the “Private reverse DNS servers” field: [/168.192.in-addr.arpa/]192.168.7.7 ``` - #### Client Look-Ups + #### Client lookups 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 @@ -305,7 +305,7 @@ hostname resolution” setting in the “Upstream DNS servers” section or via -## Configuration File +## Configuration file 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 -## Reset Web Password +## Reset web password 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: -## Profiling With Pprof +## Profiling with pprof 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, diff --git a/DHCP.md b/DHCP.md index b12d424..9fbf076 100644 --- a/DHCP.md +++ b/DHCP.md @@ -1,11 +1,11 @@ - # AdGuard Home - DHCP Server + # AdGuard Home - DHCP server * [Prerequisites](#prereq) - * [Default Options](#default) + * [Default options](#default) * [Configuration](#config) - * [The `dhcp.dhcpv4.options` Array Field](#config-4) - * [DHCPv6 Options](#config-6) - * [Automatic Hosts](#autohosts) + * [The `dhcp.dhcpv4.options` array field](#config-4) + * [DHCPv6 options](#config-6) + * [Automatic hosts](#autohosts) 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. -## Default Options +## Default options By default, AdGuard Home will set itself as the DNS server for the DHCP clients. The default lease time is 24 hours. @@ -36,7 +36,7 @@ below. - ### The `dhcp.dhcpv4.options` Array Field + ### The `dhcp.dhcpv4.options` array field 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 @@ -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). - ### DHCPv6 Options + ### DHCPv6 options 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. @@ -208,7 +208,7 @@ the clients to choose between SLAAC and DHCPv6. -## Automatic Hosts +## Automatic hosts 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, diff --git a/DNSCrypt.md b/DNSCrypt.md index fe3abdf..189a7ed 100644 --- a/DNSCrypt.md +++ b/DNSCrypt.md @@ -1,14 +1,14 @@ # AdGuard Home - DNSCrypt - * [Generating A Configuration File](#generate-config) - * [Generating A DNSCrypt Stamp](#generate-stamp) - * [Configuring Devices To Use DNSCrypt](#configure-devices) + * [Generating a Configuration file](#generate-config) + * [Generating a DNSCrypt stamp](#generate-stamp) + * [Configuring devices to use DNSCrypt](#configure-devices) **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 using the Web UI. This guide explains how to do this. -## Generating A Configuration File +## Generating a configuration file Here is how to generate a DNSCrypt configuration file and point AdGuard Home to it: @@ -112,7 +112,7 @@ it: -## Generating A DNSCrypt Stamp +## Generating a DNSCrypt stamp 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: -## Configuring Devices To Use DNSCrypt +## Configuring devices to use DNSCrypt * **All platforms:** [`dnscrypt-proxy`][prox] (reference implementation). DNSCrypt-Proxy is a command-line proxy for Linux, BSD, Windows, MacOS, diff --git a/Docker.md b/Docker.md index ddb7c99..e3fce7d 100644 --- a/Docker.md +++ b/Docker.md @@ -14,11 +14,11 @@

* [Introduction](#introduction) - * [Quick Start](#quickstart) - * [Update To A Newer Version](#update) - * [Running Development Builds](#unstable) - * [Additional Configuration](#configuration) - * [DHCP Server](#dhcp) + * [Quick start](#quickstart) + * [Update to a newer version](#update) + * [Running development builds](#unstable) + * [Additional configuration](#configuration) + * [DHCP server](#dhcp) * [`resolved`](#resolved-daemon) @@ -34,7 +34,7 @@ repository][agh]. -## Quick Start +## Quick start ### Pull the Docker image @@ -108,7 +108,7 @@ Port mappings you might need: -## Update To A Newer Version +## Update to a newer version 1. Pull the new version from Docker Hub: @@ -129,7 +129,7 @@ Port mappings you might need: -## Running Development Builds +## Running development builds 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` @@ -142,7 +142,7 @@ docker pull adguard/adguardhome:edge -## Additional Configuration +## Additional configuration 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 @@ -157,7 +157,7 @@ configurable parameters and their values is available on [this page][conf]. -## DHCP Server +## DHCP server If you want to use AdGuardHome's DHCP server, you should pass `--network host` argument when creating the container: diff --git a/Getting-Started.md b/Getting-Started.md index 203b4fa..d1150c7 100644 --- a/Getting-Started.md +++ b/Getting-Started.md @@ -1,19 +1,19 @@ # AdGuard Home - Getting Started * [Installation](#installation) - * [First Start](#first-time) - * [Running As A Service](#service) + * [First start](#first-time) + * [Running as a service](#service) * [Updating](#update) - * [Manual Update](#manual-update) - * [Configuring Devices](#configure-devices) - * [Running Without Superuser (Linux Only)](#running-without-superuser) + * [Manual update](#manual-update) + * [Configuring devices](#configure-devices) + * [Running without superuser (Linux only)](#running-without-superuser) * [Limitations](#limitations) ## Installation - ### Official Releases + ### Official releases 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 @@ -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 Snap Store package][snap]. @@ -75,7 +75,7 @@ Some other unofficial options include: -## First Start +## First start First of all, check your firewall settings. To install and use AdGuard Home, the following ports and protocols must be available: @@ -115,7 +115,7 @@ There you will go through the initial configuration wizard. -## Running As A Service +## Running as a service The next step would be to register AdGuard Home as a system service (aka daemon). To install AdGuard Home as a service, run: @@ -163,7 +163,7 @@ configuration file, so you can revert the changes, if necessary. - ### Manual Update + ### Manual 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: @@ -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 are disabled. Update the image instead. @@ -197,7 +197,7 @@ To update AdGuard Home package without the need to use Web API run: -## Configuring Devices +## Configuring devices ### Router @@ -288,13 +288,13 @@ and you won't need to configure each of them manually. -## Running Without Superuser (Linux Only) +## Running without superuser (Linux only) 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 (all platforms). - ### Granting The Necessary Capabilities + ### Granting the necessary capabilities Using this method requires the `setcap` utility. You may need to install it 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 privileges, stop AdGuard Home, open `AdGuardHome.yaml` in your editor, and find diff --git a/Home.md b/Home.md index acc3e55..ac1a34d 100644 --- a/Home.md +++ b/Home.md @@ -18,10 +18,10 @@ Welcome to the AdGuard Home wiki! ## Guides - * [Getting Started](Getting-Started) + * [Getting started](Getting-Started) * [FAQ](FAQ) - * [How to Write Hosts Blocklists](Hosts-Blocklists) - * [Comparing AdGuard Home to Other Solutions](Comparison) + * [How to write hosts blocklists](Hosts-Blocklists) + * [Comparing AdGuard Home to other solutions](Comparison) * Configuring AdGuard * [Configuration](Configuration) * [Configuring AdGuard Home Clients](Clients) @@ -32,7 +32,7 @@ Welcome to the AdGuard Home wiki! * [Docker](Docker) * [OpenWrt][owwiki] (on the OpenWrt Wiki) * [Raspberry Pi](Raspberry-Pi) - * [Virtual Private Server](VPS) - * [Verifying Releases](Verify-Releases) + * [Virtual private server](VPS) + * [Verifying releases](Verify-Releases) [owwiki]: https://openwrt.org/docs/guide-user/services/dns/adguard-home diff --git a/Hosts-Blocklists.md b/Hosts-Blocklists.md index bcc84d0..650cf42 100644 --- a/Hosts-Blocklists.md +++ b/Hosts-Blocklists.md @@ -1,11 +1,12 @@ - # AdGuard Home - How to Write Hosts Blocklists + # AdGuard Home - How to write hosts blocklists * [Introduction](#introduction) - * [Basic Examples](#rules-examples) - * [Adblock-Style Syntax](#adblock-style) - * [Special Characters](#special-characters) - * [Regular Expressions](#regular-expressions) - * [Rule Modifiers](#modifiers) + * [Basic examples](#rules-examples) + * [Adblock-style syntax](#adblock-style) + * [Special characters](#special-characters) + * [Regular expressions](#regular-expressions) + * [Comments](#comments) + * [Rule modifiers](#modifiers) * [`client`](#client) * [`denyallow`](#denyallow) * [`dnstype`](#dnstype) @@ -13,9 +14,9 @@ * [`important`](#important) * [`badfilter`](#badfilter) * [`ctag`](#ctag) - * [`/etc/hosts`-Style Syntax](#etc-hosts) - * [Domains-Only Syntax](#domains-only) - * [Hostlists Compiler](#hostlists-compiler) + * [`/etc/hosts`-style syntax](#etc-hosts) + * [Domains-only syntax](#domains-only) + * [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. --> -## Basic Examples +## Basic examples * `||example.org^`: block access to the `example.org` domain and all its subdomains, like `www.example.org`. @@ -93,7 +94,7 @@ work. --> -## Adblock-Style Syntax +## Adblock-style syntax This is a subset of the [traditional Adblock-style][adb] syntax which is used by browser ad blockers. @@ -114,7 +115,7 @@ modifiers = [modifier0, modifier1[, ...[, modifierN]]] - ### Special Characters + ### Special 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. @@ -134,7 +135,7 @@ modifiers = [modifier0, modifier1[, ...[, modifierN]]] - ### Regular Expressions + ### Regular expressions If you want even more flexibility in making rules, you can use [regular expressions][regexp] instead of the default simplified matching syntax. If you @@ -168,7 +169,7 @@ Example: - ### Rule Modifiers + ### Rule modifiers 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 @@ -606,7 +607,7 @@ The list of allowed tags: -## `/etc/hosts`-Style Syntax +## `/etc/hosts`-style syntax 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. -## Domains-Only Syntax +## Domains-only syntax A simple list of domain names, one name per line. @@ -655,7 +656,7 @@ consider it to be an [Adblock-style](#adblock-style) rule. -## Hostlists Compiler +## Hostlists compiler 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 diff --git a/Platforms.md b/Platforms.md index cf43f99..022b928 100644 --- a/Platforms.md +++ b/Platforms.md @@ -1,7 +1,7 @@ # AdGuard Home - Supported Platforms * [Changes](#changes) - * [Packaged Releases](#releases) + * [Packaged releases](#releases) * [Docker](#docker) * [Snapcraft](#snap) @@ -19,7 +19,7 @@ -## Packaged Releases +## Packaged releases The official AdGuard Home packaged releases are listed in the table below: diff --git a/Raspberry-Pi.md b/Raspberry-Pi.md index bce557d..baeea60 100644 --- a/Raspberry-Pi.md +++ b/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 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. -## Prepare Your Pi +## Prepare your Pi 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 @@ -84,7 +84,7 @@ Here are the other commands you might need to control the service: -## Check The Filtering +## Check the filtering 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) -## Configure Your Devices +## Configure your devices 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 diff --git a/VPS.md b/VPS.md index 2b5eb2f..52035d6 100644 --- a/VPS.md +++ b/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. @@ -57,4 +57,4 @@ Replace 1.2.3.4 with the IP address of your VPS. ## Configure your devices to use your AdGuard Home -Now, once you've established that AdGuard Home works on your VPS, you can use it on your machine by changing system DNS settings to use your VPS's public IP address. \ No newline at end of file +Now, once you've established that AdGuard Home works on your VPS, you can use it on your machine by changing system DNS settings to use your VPS's public IP address. diff --git a/Verify-Releases.md b/Verify-Releases.md index 47b90f4..14bc960 100644 --- a/Verify-Releases.md +++ b/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 can verify they are really created by us and no one else. Inside an archive diff --git a/__Sidebar.md b/__Sidebar.md index 18c27c0..f93f797 100644 --- a/__Sidebar.md +++ b/__Sidebar.md @@ -2,16 +2,16 @@ * [Getting Started](Getting-Started) * [FAQ](FAQ) - * [How to Write Hosts Blocklists](Hosts-Blocklists) - * [Comparing AdGuard Home to Other Solutions](Comparison) + * [How to write hosts blocklists](Hosts-Blocklists) + * [Comparing AdGuard Home to other solutions](Comparison) * Installation * [Supported platforms](Platforms) * [Docker](Docker) - * [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 Raspberry Pi](Raspberry-Pi) + * [How to install and run AdGuard Home on a virtual private server](VPS) * [Configuration](Configuration) - * [Configuring AdGuard Home Clients](Clients) - * [AdGuard Home as a DoH, DoT, or DoQ Server](Encryption) - * [AdGuard Home as a DNSCrypt Server](DNSCrypt) - * [AdGuard Home as a DHCP Server](DHCP) - * [Verifying Releases](Verify-Releases) + * [Configuring AdGuard Home clients](Clients) + * [AdGuard Home as a DoH, DoT, or DoQ server](Encryption) + * [AdGuard Home as a DNSCrypt server](DNSCrypt) + * [AdGuard Home as a DHCP server](DHCP) + * [Verifying releases](Verify-Releases)