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

better docs

Browse source
This commit is contained in:
OniriCorpe 2023-12-27 20:09:25 +01:00
parent 95f8a53d87
commit 7e74ca5827
2 changed files with 12 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
doc/ADMIN.md
View file

@ -8,10 +8,13 @@ This setting is **disabled** by default.
You need to know that 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 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)!
To use AdGuard Home in your domestic network, you don't need to activate this. To use AdGuard Home in your home network, you don't need to activate this setting.
You simply have to use your local IP adress (like `192.168.0.1` or so) as DNS IP for your IT hardware at home. You simply have to use the private IP adress of your server (like `192.168.0.1` or so) as DNS IP for your IT hardware at home.
The right IP to use are shown in the "Setup Guide" page of your AdGuard Home instance.
Warning: you should not have public IPs of the config file if the port 53 is not exposed on Internet (else: AGH crashes) If you would expose the port 53 on Internet, you'll be able to use the public IP of your server (the same as in your domain name DNS settings) on any device outside your home network.
**Warning:** you should not have public IPs of the config file if the port 53 is **not exposed** on Internet (else: AGH crashes)
They should be automatically removed when upgrading this package or when modifiying this port 53 exposure setting, but it's in the docs just in case. They should be automatically removed when upgrading this package or when modifiying this port 53 exposure setting, but it's in the docs just in case.
You can remove them in your config file `/var/www/adguardhome/AdGuardHome.yaml` in the `dns: bind_hosts:` section. You can remove them in your config file `/var/www/adguardhome/AdGuardHome.yaml` in the `dns: bind_hosts:` section.
Any IP that doesn't start with the folowing are public ones: Any IP that doesn't start with the folowing are public ones:
@ -20,13 +23,13 @@ Any IP that doesn't start with the folowing are public ones:
- `169.` - `169.`
- `172.` - `172.`
- `192.168.` - `192.168.`
- `fcxx:` (where the `x` can be any hexadecimal character)
- `fdxx:` (where the `x` can be any hexadecimal character) - `fdxx:` (where the `x` can be any hexadecimal character)
- `fe80:` - `fe80:`
So, any other IP should be a public one. So, any other IP should be a public one.
Restart AdGuard Home after applying the needed edits: Restart AdGuard Home after applying the needed edits: `yunohost service restart adguardhome`
`yunohost service restart adguardhome`
## Enable DNS over HTTP and DNS over QUIC? ## Enable DNS over HTTP and DNS over QUIC?
@ -35,7 +38,7 @@ This setting is **disabled** by default.
You need to know that anyone who knows your AdGuard Home domain-name 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 anyone who knows your AdGuard Home domain-name 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)!
It's really important to use the configuration panel to deactivate this setting, and **NOT** the built-in setting in the AdGuardHome interface. It's really important to use the configuration panel to deactivate this setting, and **NOT** the built-in setting in the AdGuardHome interface.
This is because YunoHost needs to perform actions such as automatically opening or closing the server's ports, which cannot be done without going through the configuration panel. This is because YunoHost needs to perform actions such as automatically opening or closing the server's ports and refresh the IP to provide to AdGuard Home, which cannot be done without going through the configuration panel.
If you host your machine at home, for using DoH or DoQ, you have to open the following ports on your router: If you host your machine at home, for using DoH or DoQ, you have to open the following ports on your router:

3
doc/PRE_UPGRADE.d/0.107.43~ynh4
View file

@ -7,6 +7,9 @@ Applications → AdGuard Home → AdGuard Home configuration
- Expose port 53 to the Internet? - Expose port 53 to the Internet?
- Enable DNS-over-HTTPS/QUIC? - Enable DNS-over-HTTPS/QUIC?
It's really important to use the configuration panel to activate or deactivate the DNS-over-HTTPS/QUIC setting, and **NOT** the built-in setting in the AdGuardHome interface.
This is because YunoHost needs to perform actions such as automatically opening or closing the server's ports and refresh the IP to provide to AdGuard Home, which cannot be done without going through the configuration panel.
This update is at risk of crashing AdGuard Home, so: This update is at risk of crashing AdGuard Home, so:
If any trouble or question, please refer to [the package's admin docs](https://github.com/YunoHost-Apps/adguardhome_ynh/blob/master/doc/ADMIN.md)! ^w^ If any trouble or question, please refer to [the package's admin docs](https://github.com/YunoHost-Apps/adguardhome_ynh/blob/master/doc/ADMIN.md)! ^w^
If needed and a similar issue does not already exist, please [open an issue on the GitHub's package page](https://github.com/YunoHost-Apps/adguardhome_ynh/issues)! If needed and a similar issue does not already exist, please [open an issue on the GitHub's package page](https://github.com/YunoHost-Apps/adguardhome_ynh/issues)!