From 7964837b2a1053c1ca89d25a19ee11c92ddf6280 Mon Sep 17 00:00:00 2001
From: Ainar Garipov <a.garipov@adguard.com>
Date: Mon, 26 Feb 2024 12:27:05 +0300
Subject: [PATCH] Pull request 195: depr-faq-start-vps
Squashed commit of the following:
commit 8df68b5aeb1ec97fa5ef007c4ec45e54b7f98474
Merge: 7efc4a7 447d8f1
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date: Mon Feb 26 12:26:25 2024 +0300
Merge branch 'master' into depr-faq-start-vps
commit 7efc4a7eee918a370e6824978e79044981ee9014
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date: Thu Feb 22 20:32:08 2024 +0300
all: depr some articles
---
FAQ.md | 113 +++++++++++++++++++++++++++++++++++++++++++--
Getting-Started.md | 69 ++++++++++++++++++++++++++-
VPS.md | 10 +++-
3 files changed, 186 insertions(+), 6 deletions(-)
diff --git a/FAQ.md b/FAQ.md
index 74f6a04..3f0e875 100644
--- a/FAQ.md
+++ b/FAQ.md
@@ -1,5 +1,12 @@
# AdGuard Home - FAQ
+ > [!WARNING]
+ > This article is outdated. See the [up-to-date version][kb-article] in our Knowledge Base.
+
+[kb-article]: https://adguard-dns.io/kb/adguard-home/faq/
+
+
+
* [Why AdGuard Home doesn't block ads?](#doesntblock)
* [Where can I inspect the logs?](#logs)
* [How to configure AdGuard Home to write verbose-level logs?](#verboselog)
@@ -18,6 +25,13 @@
## <a href="#doesntblock" id="doesntblock" name="doesntblock">Why AdGuard Home doesn't block ads?</a>
+ > [!WARNING]
+ > This section is outdated. See the [up-to-date version][kb-noblock] in our Knowledge Base.
+
+[kb-noblock]: https://adguard-dns.io/kb/adguard-home/faq/#doesntblock
+
+
+
Suppose that AdGuard Home must block `somebadsite.com` but for some reason it
doesn't. Let's try to resolve this issue.
@@ -75,6 +89,13 @@ misconfiguration. Please check and ensure that:
## <a href="#logs" id="logs" name="logs">Where can I inspect the logs?</a>
+ > [!WARNING]
+ > This section is outdated. See the [up-to-date version][kb-logs] in our Knowledge Base.
+
+[kb-logs]: https://adguard-dns.io/kb/adguard-home/faq/#logs
+
+
+
The default location of the plain-text logs (not to be confused with the query
logs) depends on the operating system and installation mode:
@@ -106,6 +127,13 @@ logs) depends on the operating system and installation mode:
## <a href="#verboselog" id="verboselog" name="verboselog">How to configure AdGuard Home to write verbose-level logs?</a>
+ > [!WARNING]
+ > This section is outdated. See the [up-to-date version][kb-verboselog] in our Knowledge Base.
+
+[kb-verboselog]: https://adguard-dns.io/kb/adguard-home/faq/#verboselog
+
+
+
To troubleshoot a complicated issue, the verbose-level logging is sometimes
required. Here's how to enable it:
@@ -138,6 +166,13 @@ anchor into this header. -->
## <a href="#customblock" id="customblock" name="customblock"><span id="pixelsrv" name="pixelsrv"/>How to show a custom block page?</a>
+ > [!WARNING]
+ > This section is outdated. See the [up-to-date version][kb-custom] in our Knowledge Base.
+
+[kb-custom]: https://adguard-dns.io/kb/adguard-home/faq/#customblock
+
+
+
### A note about HTTPS
Before doing any of this, please note that modern browsers are set up to use
@@ -215,6 +250,13 @@ edit the configuration file manually:
## <a href="#webaddr" id="webaddr" name="webaddr">How to change dashboard interface's address?</a>
+ > [!WARNING]
+ > This section is outdated. See the [up-to-date version][kb-web] in our Knowledge Base.
+
+[kb-web]: https://adguard-dns.io/kb/adguard-home/faq/#webaddr
+
+
+
1. Stop AdGuard Home:
```sh
@@ -226,7 +268,7 @@ edit the configuration file manually:
1. Set the `http.address` setting to a new network interface. For example:
* `0.0.0.0:0` to listen on all network interfaces.
-
+
* `0.0.0.0:8080` to listen on all network interfaces with port `8080`.
* `127.0.0.1:0` to listen on the local loopback interface only.
@@ -241,13 +283,22 @@ edit the configuration file manually:
## <a href="#defaultdns" id="defaultdns" name="defaultdns">How to set up AdGuard Home as default DNS server?</a>
-See the [“Configuring Devices” section](Getting-Started#configure-devices) on
-the “Getting Started” page.
+See the [“Configuring Devices” section][kb-dev] on the “Getting Started” page in
+the Knowledge Base.
+
+[kb-dev]: https://adguard-dns.io/kb/adguard-home/getting-started/#configure-devices
## <a href="#limitations" id="limitations" name="limitations">Are there any known limitations?</a>
+ > [!WARNING]
+ > This section is outdated. See the [up-to-date version][kb-lim] in our Knowledge Base.
+
+[kb-lim]: https://adguard-dns.io/kb/adguard-home/faq/#limitations
+
+
+
Here are some examples of what cannot be blocked by a DNS-level blocker:
* YouTube, Twitch ads.
@@ -271,6 +322,13 @@ enough or would require quite complicated configuration.
## <a href="#bindinuse" id="bindinuse" name="bindinuse">Why am I getting `bind: address already in use` error when trying to install on Ubuntu?</a>
+ > [!WARNING]
+ > This section is outdated. See the [up-to-date version][kb-inuse] in our Knowledge Base.
+
+[kb-inuse]: https://adguard-dns.io/kb/adguard-home/faq/#bindinuse
+
+
+
This happens because the port 53 on `localhost`, which is used for DNS, is
already taken by another program. Ubuntu comes with a local DNS called
`systemd-resolved`, which uses the address `127.0.0.53:53` and thus prevents
@@ -340,6 +398,13 @@ AdGuard Home should be able to bind to `127.0.0.1:53`.
## <a href="#reverseproxy" id="reverseproxy" name="reverseproxy">How to configure a reverse proxy server for AdGuard Home?</a>
+ > [!WARNING]
+ > This section is outdated. See the [up-to-date version][kb-proxy] in our Knowledge Base.
+
+[kb-proxy]: https://adguard-dns.io/kb/adguard-home/faq/#reverseproxy
+
+
+
If you're already running a web server and want to access the AdGuard Home
dashboard UI from a URL like `http://YOUR_SERVER/aghome/`, you can use this
configuration for your web server:
@@ -405,6 +470,13 @@ the real client IP address into account. See the [configuration][conf] and
## <a href="#fedora" id="fedora" name="fedora">How to fix `permission denied` errors on Fedora?</a>
+ > [!WARNING]
+ > This section is outdated. See the [up-to-date version][kb-fedora] in our Knowledge Base.
+
+[kb-fedora]: https://adguard-dns.io/kb/adguard-home/faq/#fedora
+
+
+
1. Move the `AdGuardHome` binary to `/usr/local/bin`.
1. As `root`, execute the following command to change the security context of
@@ -443,6 +515,13 @@ See [issue 765] and [issue 3281].
## <a href="#incompatfs" id="incompatfs" name="incompatfs">How to fix `incompatible file system` errors?</a>
+ > [!WARNING]
+ > This section is outdated. See the [up-to-date version][kb-fs] in our Knowledge Base.
+
+[kb-fs]: https://adguard-dns.io/kb/adguard-home/faq/#incompatfs
+
+
+
You should move your AdGuard Home installation or working directory to another
location. See the [limitations section](Getting-Started#limitations) on the
“Getting Started” page.
@@ -451,6 +530,13 @@ location. See the [limitations section](Getting-Started#limitations) on the
## <a href="#manual-update" id="manual-update" name="manual-update">How to update AdGuard Home manually?</a>
+ > [!WARNING]
+ > This section is outdated. See the [up-to-date version][kb-mupd] in our Knowledge Base.
+
+[kb-mupd]: https://adguard-dns.io/kb/adguard-home/faq/#manual-update
+
+
+
In case the button isn't shown or an automatic update has failed, you can
update manually. In the examples below, we'll use AdGuard Home releases for
Linux and Windows for AMD64 CPUs.
@@ -459,6 +545,13 @@ Linux and Windows for AMD64 CPUs.
### <a href="#manual-update-unix" id="manual-update-unix" name="manual-update-unix">Unix (Linux, macOS, BSD)</a>
+ > [!WARNING]
+ > This section is outdated. See the [up-to-date version][kb-mupdu] in our Knowledge Base.
+
+[kb-mupdu]: https://adguard-dns.io/kb/adguard-home/faq/#manual-update-unix
+
+
+
1. Download the new AdGuard Home package from the [releases page][releases].
If you want to perform this step from the command line:
@@ -542,6 +635,13 @@ Linux and Windows for AMD64 CPUs.
### <a href="#manual-update-win" id="manual-update-win" name="manual-update-win">Windows (Using PowerShell)</a>
+ > [!WARNING]
+ > This section is outdated. See the [up-to-date version][kb-mupdw] in our Knowledge Base.
+
+[kb-mupdw]: https://adguard-dns.io/kb/adguard-home/faq/#manual-update-win
+
+
+
In all examples below, the PowerShell must be run as Administrator.
1. Download the new AdGuard Home package from the [releases page][releases].
@@ -604,6 +704,13 @@ In all examples below, the PowerShell must be run as Administrator.
## <a href="#uninstall" id="uninstall" name="uninstall">How to uninstall AdGuard Home?</a>
+ > [!WARNING]
+ > This section is outdated. See the [up-to-date version][kb-bye] in our Knowledge Base.
+
+[kb-bye]: https://adguard-dns.io/kb/adguard-home/faq/#uninstall
+
+
+
The way to uninstall AdGuard Home depends on how you installed it.
**IMPORTANT:** After uninstalling AdGuard Home, don't forget to change your
diff --git a/Getting-Started.md b/Getting-Started.md
index d1150c7..f4a0b3f 100644
--- a/Getting-Started.md
+++ b/Getting-Started.md
@@ -1,5 +1,12 @@
# AdGuard Home - Getting Started
+ > [!WARNING]
+ > This article is outdated. See the [up-to-date version][kb-article] in our Knowledge Base.
+
+[kb-article]: https://adguard-dns.io/kb/adguard-home/getting-started/
+
+
+
* [Installation](#installation)
* [First start](#first-time)
* [Running as a service](#service)
@@ -13,11 +20,18 @@
## <a href="#installation" id="installation" name="installation">Installation</a>
+ > [!WARNING]
+ > This section is outdated. See the [up-to-date version][kb-install] in our Knowledge Base.
+
+[kb-install]: https://adguard-dns.io/kb/adguard-home/getting-started/#installation
+
+
+
### 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
-well as links to beta and edge (unstable) releases can be found on our
+well as links to beta and edge (unstable) releases can be found in our
“[Platforms][platforms]” page.
To install AdGuard Home as a service, unpack the archive, enter the
@@ -36,6 +50,8 @@ To install AdGuard Home as a service, unpack the archive, enter the
* Users of **macOS 10.15 Catalina** and newer should place the AdGuard Home
working directory inside the `/Applications` directory.
+[issue 3281]: https://github.com/AdguardTeam/AdGuardHome/issues/3281
+[issue 765]: https://github.com/AdguardTeam/AdGuardHome/issues/765#issuecomment-752262353
[platforms]: https://github.com/AdguardTeam/AdGuardHome/wiki/Platforms
[releases]: https://github.com/AdguardTeam/AdGuardHome/releases/latest
@@ -77,6 +93,13 @@ Some other unofficial options include:
## <a href="#first-time" id="first-time" name="first-time">First start</a>
+ > [!WARNING]
+ > This section is outdated. See the [up-to-date version][kb-first] in our Knowledge Base.
+
+[kb-first]: https://adguard-dns.io/kb/adguard-home/getting-started/#first-time
+
+
+
First of all, check your firewall settings. To install and use AdGuard Home,
the following ports and protocols must be available:
@@ -117,6 +140,13 @@ There you will go through the initial configuration wizard.
## <a href="#service" id="service" name="service">Running as a service</a>
+ > [!WARNING]
+ > This section is outdated. See the [up-to-date version][kb-svc] in our Knowledge Base.
+
+[kb-svc]: https://adguard-dns.io/kb/adguard-home/getting-started/#service
+
+
+
The next step would be to register AdGuard Home as a system service (aka
daemon). To install AdGuard Home as a service, run:
@@ -153,6 +183,13 @@ file](Configuration).
## <a href="#update" id="update" name="update">Updating</a>
+ > [!WARNING]
+ > This section is outdated. See the [up-to-date version][kb-upd] in our Knowledge Base.
+
+[kb-upd]: https://adguard-dns.io/kb/adguard-home/getting-started/#update
+
+
+
When a new version is released, AdGuard Home's UI shows a notification message
@@ -165,6 +202,13 @@ configuration file, so you can revert the changes, if necessary.
### <a href="#manual-update" id="manual-update" name="manual-update">Manual update</a>
+ > [!WARNING]
+ > This section is outdated. See the [up-to-date version][kb-mupd] in our Knowledge Base.
+
+[kb-mupd]: https://adguard-dns.io/kb/adguard-home/getting-started/#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:
@@ -176,7 +220,7 @@ manually. We have a [detailed guide on manual updates][mupd], but in short:
1. Restart AdGuard Home.
-[mupd]: https://github.com/AdguardTeam/AdGuardHome/wiki/FAQ#manual-update
+[mupd]: https://adguard-dns.io/kb/adguard-home/faq/#manual-update
@@ -199,6 +243,13 @@ 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>
+ > [!WARNING]
+ > This section is outdated. See the [up-to-date version][kb-dev] in our Knowledge Base.
+
+[kb-dev]: https://adguard-dns.io/kb/adguard-home/getting-started/#configure-devices
+
+
+
### Router
This setup will automatically cover all devices connected to your home router,
@@ -290,6 +341,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>
+ > [!WARNING]
+ > This section is outdated. See the [up-to-date version][kb-su] in our Knowledge Base.
+
+[kb-su]: https://adguard-dns.io/kb/adguard-home/getting-started/#running-without-superuser
+
+
+
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).
@@ -329,6 +387,13 @@ these two lines down and save.
## <a href="#limitations" id="limitations" name="limitations">Limitations</a>
+ > [!WARNING]
+ > This section is outdated. See the [up-to-date version][kb-lim] in our Knowledge Base.
+
+[kb-lim]: https://adguard-dns.io/kb/adguard-home/getting-started/#limitations
+
+
+
Some file systems don't support the `mmap(2)` system call that the statistics
system requires. See also [issue 1188].
diff --git a/VPS.md b/VPS.md
index f60a5cc..8e55f1a 100644
--- a/VPS.md
+++ b/VPS.md
@@ -1,6 +1,14 @@
# 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.
+ > [!WARNING]
+ > This article is outdated. See [*Getting started*][kb-start] and [*Running securely*][kb-sec] in our Knowledge Base.
+
+[kb-sec]: https://adguard-dns.io/kb/adguard-home/running-securely/
+[kb-start]: https://adguard-dns.io/kb/adguard-home/getting-started/
+
+
+
+To run AdGuard Home on a VPS, you need a server with Debian 8 or 9, x64 or x32.
>Among possible solutions are [Vultr](https://www.vultr.com/), [1&1](https://www.1and1.co.uk/dynamic-cloud-server#configure-server), [Cloudways](https://www.cloudways.com/), [HostGator](https://hostgator.com/), [Digital Ocean](https://www.digitalocean.com/), [Bytemark](https://www.bytemark.co.uk/cloud-hosting/) and many more. AdGuard is not affiliated with any of these or other VPS services.