YunoHost-Apps/adguardhome_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/adguardhome_ynh.git synced 2024-09-03 18:06:23 +02:00
Code Issues Activity Actions

minor docs improvements

Browse source
This commit is contained in:
OniriCorpe 2024-05-16 13:32:06 +02:00
parent df1363c0c1
commit 839beb96a0
2 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc/ADMIN.md
View file

@ -14,12 +14,12 @@ When disabled:
When enabled: When enabled:
- YunoHost **will** check if the port 53 is accessible on Internet and warns you if not - YunoHost **will** check if the port 53 is accessible on Internet and warns you if not
- You need to **manually open port 53** of your router if you self-host at home! - ⚠️ You need to **manually open port 53** of your router if you self-host at home!
- Public IP adresses **will** be added to the AdGuard Home configuration, so AGH will be able to bind to them - Server's public IP adresses **will** be added to the AdGuard Home configuration, so AGH will be able to bind to them
You need to know that if you expose your DNS server to Internet, anyone who knows your server's IP can make a DNS request to it. It *may be used* to perform [amplification attacks](https://en.wikipedia.org/wiki/Denial-of-service_attack#Amplification)! You need to know that if you expose your DNS server to Internet, anyone who knows your server's IP can make a DNS request to it. It *may be used* to perform [amplification attacks](https://en.wikipedia.org/wiki/Denial-of-service_attack#Amplification)!
This risk is greatly minimized by the rate limiting setting, which is set to 20 requests per second per client by default: This risk is greatly minimized by the rate limiting setting, which is set to 20 requests per second per client by default:
Settings → DNS settings → DNS server configuration → Rate limit `Settings → DNS settings → DNS server configuration → Rate limit`
You can completely or almost completely reduce the risk of unauthorized use with the help of the [Allowlist section](#allowlist) further down in this documentation. You can completely or almost completely reduce the risk of unauthorized use with the help of the [Allowlist section](#allowlist) further down in this documentation.

8
doc/APPS.md
View file

@ -2,7 +2,7 @@
## Android ## Android
To be completed by someone who uses an Android app To be completed by someone who uses an Android app, feel free to contribute!
## Apple devices ## Apple devices
@ -11,7 +11,7 @@ To be completed by someone who uses an Android app
[AdGuard Home Remote](https://apps.apple.com/app/id1543143740) by [RocketScience IT](https://rocketscience-it.nl/) is compatible with Mac, iPhone, iPad and Watch. [AdGuard Home Remote](https://apps.apple.com/app/id1543143740) by [RocketScience IT](https://rocketscience-it.nl/) is compatible with Mac, iPhone, iPad and Watch.
It is free with an in-app purchase of 6€ or US$5 to unlock some features. No ads, no tracking. It is free with an in-app purchase of 6€ or US$5 to unlock some features. No ads, no tracking.
This app is for monitoring or configuring your AGH instance, not to use your AGH as a DNS server on your Apple device. This app is for monitoring or configuring your AGH instance, not to use your AGH as a DNS server on your Apple device. See the section bellow for that!
You can easilly configure this app: You can easilly configure this app:
@ -27,7 +27,7 @@ You can easilly configure this app:
### Secure DNS profile ### Secure DNS profile
To use your AGH instance as the DNS server on your Apple device, you can generate an Apple 'Secure DNS profile'. 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). **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 functionnality using the YunoHost Webadmin. To do so, you first need to activate the DNS over HTTP/TLS/QUIC functionnality using the YunoHost Webadmin.
If you're reading this 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". If you're reading this 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".
@ -52,4 +52,4 @@ Finaly, open the system settings, click on the "Downloaded profile" message and
Your device should now use your AdGuard Home instance as its DNS server. Congrats! Your device should now use your AdGuard Home instance as its DNS server. Congrats!
Note: Installed DNS profiles can be managed in the Settings under "General" then "VPN and Device Management". **Note:** Installed DNS profiles can be managed in the Settings under "General" then "VPN and Device Management".