From 06b18d55d01b7e3ab0ae3d56eaf5eb651294f0ea Mon Sep 17 00:00:00 2001 From: tituspijean Date: Sun, 19 May 2024 10:36:27 +0200 Subject: [PATCH] Factorize apps instructions --- doc/APPS.md | 16 +++++++++++----- doc/APPS_fr.md | 14 +++++++++----- 2 files changed, 20 insertions(+), 10 deletions(-) diff --git a/doc/APPS.md b/doc/APPS.md index 31c38f9..e4d538c 100644 --- a/doc/APPS.md +++ b/doc/APPS.md @@ -1,11 +1,21 @@ # Apps documentation +## Preamble + +To use the DNS-over-HTTPS/TLS/QUIC functionality, you need to enable it from your app's YunoHost configuration panel. + +If you're reading this using the YunoHost interface, you should already be in the right page: just click on the [AdGuard Home configuration](#/apps/adguardhome/main) option at the top of this text, toggle on "Activate DNS over HTTP/TLS/QUIC?" then "Save". +Else, open The YunoHost Webadmin and follow this path: `Applications → AdGuard Home → AdGuard Home configuration`. + +From the command line interface: `yunohost app config set __APP__ main.options.dns_over_https -v 1` + ## Android ### Built-in Private DNS Android offers a Private DNS feature starting its version 9 and above. This Private DNS setting will only work for DNS-over-TLS with Adguard Home, since DNS-over-HTTPS is limited to a couple of hardcoded providers. +Make sure to have followed the instructions of the Preamble above. Android being available under various flavours depending on your phone manufacturer, the location of that setting can vary. It is generally along the lines of `Settings → Connections → More connection parameters → Private DNS`. @@ -50,11 +60,7 @@ You can easily configure this app: To use your AGH instance as the DNS server on your Apple device, you can generate an Apple 'Secure DNS profile'. **Note:** as a more tech-savvy alternative to this tutorial, you can use [Secure DNS profile creator](https://dns.notjakob.com/index.html). -To do so, you first need to activate the DNS over HTTP/TLS/QUIC functionality using the YunoHost Webadmin. -If you're reading this using the YunoHost interface, you should already be in the right page: just click the "AdGuard Home configuration" option at the top of this text, toggle on "Activate DNS over HTTP/TLS/QUIC?" then "Save". -Else, open The YunoHost Webadmin and follow this path: `Applications → AdGuard Home → AdGuard Home configuration` - -Now that it's done, go to the [Setup Guide](https://__DOMAIN____PATH__#guide) page of your AdGuard Home instance, click the "DNS Privacy" option and scroll to the bottom. +Make sure you have followed the instructions of the Preamble above, then go to the [Setup Guide](https://__DOMAIN____PATH__#guide) page of your AdGuard Home instance, click the "DNS Privacy" option and scroll to the bottom. - Hostname: keep it that way - HTTPS port: same, keep it that way diff --git a/doc/APPS_fr.md b/doc/APPS_fr.md index 5a494ce..88fab89 100644 --- a/doc/APPS_fr.md +++ b/doc/APPS_fr.md @@ -1,5 +1,13 @@ # Documentation des applications +## Préambule + +Pour utiliser la fonctionnalité DNS sur HTTP/TLS/QUIC, vous devez l'activer dans l'interface d'administration de YunoHost. +Si vous lisez ceci via l'interface web de YunoHost, vous devriez déjà être au bon endroit: cliquez simplement sur l'option [AdGuard Home configuration](#/apps/adguardhome/main) au dessus de ce texte, activez "Activate DNS over HTTP/TLS/QUIC?" puis cliquez sur "Save". +Sinon, ouvrez l'interface d'administration Web et suivez ce chemin : `Applications → AdGuard Home → AdGuard Home configuration` + +Depuis la ligne de commande: `yunohost app config set __APP__ main.options.dns_over_https -v 1` + ## Android ### DNS privé intégré @@ -50,11 +58,7 @@ Vous pouvez facilement configurer l'app : Afin d'utiliser votre instance AGH en tant que serveur DNS de votre appareil Apple, vous pouvez générer un "Profil DNS sécurisé". **Note :** en alternative pour utilisateurice expérimenté•e à ce tutoriel, vous pouvez également utiliser l'outil [Secure DNS profile creator](https://dns.notjakob.com/index.html). -Pour ce faire, vous devez au préalable activer la fonctionnalité DNS sur HTTP/TLS/QUIC en utilisant l'interface d'administration Web de YunoHost. -Si vous lisez ceci via l'interface YunoHost', vous devriez déjà être au bon endroit: cliquez simplement sur l'option "AdGuard Home configuration" au dessus de ce texte, activez "Activate DNS over HTTP/TLS/QUIC?" puis cliquez sur "Save". -Sinon, ouvrez l'interface d'administration Web et suivez ce chemin : `Applications → AdGuard Home → AdGuard Home configuration` - -Désormais, rendez-vous sur la page [Setup Guide](https://__DOMAIN____PATH__#guide) de votre instance AdGuard Home, cliquez sur "DNS privacy" et descendez tout en bas. +Assurez-vous d'avoir suivi les instructions du Préambule ci-dessus, puis rendez-vous sur la page [Setup Guide](https://__DOMAIN____PATH__#guide) de votre instance AdGuard Home, cliquez sur "DNS privacy" et descendez tout en bas. - Hostname : laisser comme tel - HTTPS port : laisser aussi comme tel