mirrors/AdGuardHome
1
0
Fork 0
mirror of https://github.com/AdguardTeam/AdGuardHome.git synced 2024-11-22 04:55:33 +03:00
Code Issues Projects Releases Packages Wiki Activity

prettify configuration.md

Andrey Meshkov 2020-12-02 13:45:59 +03:00
parent 4a353f5db8
commit 4cd04b5f38
1 changed files with 158 additions and 152 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

310
Configuration.md

@ -2,18 +2,19 @@
Most of these settings can be changed via the web-based admin interface. However, we decided to list them all here just in case. 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) - [Command-line arguments](#command-line)
* [Configuring upstreams](#upstreams) - [Configuring upstreams](#upstreams)
* [Specifying upstreams for domains](#upstreams-for-domains) - [Specifying upstreams for domains](#upstreams-for-domains)
* [Loading the list of upstream servers from a file](#upstreams-from-file) - [Loading the list of upstream servers from a file](#upstreams-from-file)
* [Specifying upstreams for rDNS](#upstreams-for-rdns) - [Specifying upstreams for rDNS](#upstreams-for-rdns)
* [Configuring clients friendly names](#friendly-names) - [Configuring clients friendly names](#friendly-names)
* [Configuration file](#configuration-file) - [Configuration file](#configuration-file)
* [Reset Web Password](#password-reset) - [Reset Web Password](#password-reset)
* [Profiling with pprof](#pprof) - [Profiling with pprof](#pprof)
* [Additional DHCP options](#dhcp-options) - [Additional DHCP options](#dhcp-options)
<a id="command-line"></a> <a id="command-line"></a>
## Command-line arguments ## Command-line arguments
Here is a list of all available command-line arguments. Here is a list of all available command-line arguments.
@ -45,26 +46,29 @@ Please note, that the command-line arguments override settings from the configur
`./AdGuardHome -s reload` command does the following: `./AdGuardHome -s reload` command does the following:
* Re-read runtime clients from `/etc/hosts` file and `arp -a` output - Re-read runtime clients from `/etc/hosts` file and `arp -a` output
* Re-read SSL certificate file (if it has changed) - Re-read SSL certificate file (if it has changed)
Command-line arguments passed to `-s install` command will be then used by the service. For instance if you install AdGuardHome service using `sudo ./AdGuardHome -s install --no-check-update`, it will disable update check functionality in the service as well. Command-line arguments passed to `-s install` command will be then used by the service. For instance if you install AdGuardHome service using `sudo ./AdGuardHome -s install --no-check-update`, it will disable update check functionality in the service as well.
<a id="upstreams"></a> <a id="upstreams"></a>
## Configuring upstreams ## Configuring upstreams
AdGuard Home is basically a DNS proxy that sends your DNS queries to the upstream servers. You can specify multiple upstream servers in AdGuard Home settings, or you can even specify a DNS server that will be used to resolve specific domains. AdGuard Home is basically a DNS proxy that sends your DNS queries to the upstream servers. You can specify multiple upstream servers in AdGuard Home settings, or you can even specify a DNS server that will be used to resolve specific domains.
Examples: Examples:
* `1.1.1.1` - regular DNS (over UDP).
* `tls://1dot1dot1dot1.cloudflare-dns.com` – encrypted [DNS-over-TLS](https://en.wikipedia.org/wiki/DNS_over_TLS). - `1.1.1.1` - regular DNS (over UDP).
* `https://cloudflare-dns.com/dns-query` – encrypted [DNS-over-HTTPS](https://en.wikipedia.org/wiki/DNS_over_HTTPS). - `tls://1dot1dot1dot1.cloudflare-dns.com` – encrypted [DNS-over-TLS](https://en.wikipedia.org/wiki/DNS_over_TLS).
* `quic://dns-unfiltered.adguard.com:784` - experimental [DNS-over-QUIC](https://tools.ietf.org/html/draft-huitema-quic-dnsoquic) support. - `https://cloudflare-dns.com/dns-query` – encrypted [DNS-over-HTTPS](https://en.wikipedia.org/wiki/DNS_over_HTTPS).
* `tcp://1.1.1.1` – regular DNS (over TCP). - `quic://dns-unfiltered.adguard.com:784` - experimental [DNS-over-QUIC](https://tools.ietf.org/html/draft-huitema-quic-dnsoquic) support.
* `sdns://...` – you can use [DNS Stamps](https://dnscrypt.info/stamps/) for [DNSCrypt](https://dnscrypt.info/) or [DNS-over-HTTPS](https://en.wikipedia.org/wiki/DNS_over_HTTPS) resolvers. - `tcp://1.1.1.1` – regular DNS (over TCP).
* `[/example.local/]1.1.1.1` – you can specify DNS upstream for a specific domain(s). - `sdns://...` – you can use [DNS Stamps](https://dnscrypt.info/stamps/) for [DNSCrypt](https://dnscrypt.info/) or [DNS-over-HTTPS](https://en.wikipedia.org/wiki/DNS_over_HTTPS) resolvers.
- `[/example.local/]1.1.1.1` – you can specify DNS upstream for a specific domain(s).
<a id="upstreams-for-domains"></a> <a id="upstreams-for-domains"></a>
### Specifying upstreams for domains ### Specifying upstreams for domains
You can specify upstreams that will be used for a specific domain(s). We use the dnsmasq-like syntax (see `--server` description [here](http://www.thekelleys.org.uk/dnsmasq/docs/dnsmasq-man.html)). This feature is intended for private nameservers which deal with intranet domains. You can specify upstreams that will be used for a specific domain(s). We use the dnsmasq-like syntax (see `--server` description [here](http://www.thekelleys.org.uk/dnsmasq/docs/dnsmasq-man.html)). This feature is intended for private nameservers which deal with intranet domains.
@ -76,38 +80,39 @@ You can specify upstreams that will be used for a specific domain(s). We use the
If one or more domains are specified, that upstream (`upstreamString`) is used only for those domains. Usually, it is used for private nameservers. For instance, if you have a nameserver on your network which deals with `xxx.internal.local` at `192.168.0.1` then you can specify `[/internal.local/]192.168.0.1`, and AdGuard Home will send all queries to that nameserver. Everything else will be sent to the default upstreams (which are mandatory!). If one or more domains are specified, that upstream (`upstreamString`) is used only for those domains. Usually, it is used for private nameservers. For instance, if you have a nameserver on your network which deals with `xxx.internal.local` at `192.168.0.1` then you can specify `[/internal.local/]192.168.0.1`, and AdGuard Home will send all queries to that nameserver. Everything else will be sent to the default upstreams (which are mandatory!).
1. An empty domain specification, // has the special meaning of "unqualified names only" ie names without any dots in them. 1. An empty domain specification, // has the special meaning of "unqualified names only" ie names without any dots in them.
2. More specific domains take precedence over less specific domains, so: `[/host.com/]1.2.3.4` + `[/www.host.com/]2.3.4.5` will send queries for *.host.com to 1.2.3.4, except *.www.host.com, which will go to 2.3.4.5 2. More specific domains take precedence over less specific domains, so: `[/host.com/]1.2.3.4` + `[/www.host.com/]2.3.4.5` will send queries for _.host.com to 1.2.3.4, except _.www.host.com, which will go to 2.3.4.5
3. The special server address '#' means, "use the standard servers", so: `[/host.com/]1.2.3.4` + `[/www.host.com/]#` will send queries for *.host.com to 1.2.3.4, except *.www.host.com which will be forwarded as usual. 3. The special server address '#' means, "use the standard servers", so: `[/host.com/]1.2.3.4` + `[/www.host.com/]#` will send queries for _.host.com to 1.2.3.4, except _.www.host.com which will be forwarded as usual.
#### Examples #### Examples
* - ```
``` 8.8.8.8:53
8.8.8.8:53 [/local/]192.168.0.1:53
[/local/]192.168.0.1:53 ```
```
Sends queries for `*.local` domains to `192.168.0.1:53`. Other queries are sent to `8.8.8.8:53`.
* Sends queries for `*.local` domains to `192.168.0.1:53`. Other queries are sent to `8.8.8.8:53`.
```
8.8.8.8:53 - ```
[/host.com/]1.1.1.1:53 8.8.8.8:53
[/maps.host.com/]# [/host.com/]1.1.1.1:53
``` [/maps.host.com/]#
Sends queries for `*.host.com` to `1.1.1.1:53` except for `*.maps.host.com` which are sent to `8.8.8.8:53` (as long as other queries). ```
Sends queries for `*.host.com` to `1.1.1.1:53` except for `*.maps.host.com` which are sent to `8.8.8.8:53` (as long as other queries).
<a id="upstreams-from-file"></a> <a id="upstreams-from-file"></a>
### Loading the list of upstream servers from a file ### Loading the list of upstream servers from a file
Using specific upstreams for some domains is a common way to accelerate internet in China, for example see https://github.com/felixonmars/dnsmasq-china-list and many other dnsmasq lists. Using specific upstreams for some domains is a common way to accelerate internet in China, for example see https://github.com/felixonmars/dnsmasq-china-list and many other dnsmasq lists.
These lists can be easily converted to a list for AdGuard Home: These lists can be easily converted to a list for AdGuard Home:
* `server=/0-100.com/114.114.114.114` -> `[/0-100.com/]114.114.114.114` - `server=/0-100.com/114.114.114.114` -> `[/0-100.com/]114.114.114.114`
The problem with these lists is that they may be too large. In this case you may want to load them from a separate file instead of setting all upstreams in AdGuard settings. Just specify the path to a file with your list in the `upstream_dns_file` field of `AdGuardHome.yaml`. The problem with these lists is that they may be too large. In this case you may want to load them from a separate file instead of setting all upstreams in AdGuard settings. Just specify the path to a file with your list in the `upstream_dns_file` field of `AdGuardHome.yaml`.
<a id="upstreams-for-rdns"></a> <a id="upstreams-for-rdns"></a>
### Specifying upstreams for rDNS ### Specifying upstreams for rDNS
AdGuardHome automatically gets the names of connected devices using Reverse DNS lookup (rDNS). AdGuardHome automatically gets the names of connected devices using Reverse DNS lookup (rDNS).
@ -119,22 +124,22 @@ You can do it using the same syntax as for general upstream servers, for example
This rule instructs AdGuardHome to use `192.168.0.1` DNS server for all rDNS requests to resolve clients' IP addresses `192.168.0.0/16`. This rule instructs AdGuardHome to use `192.168.0.1` DNS server for all rDNS requests to resolve clients' IP addresses `192.168.0.0/16`.
<a id="friendly-names"></a> <a id="friendly-names"></a>
## Configuring clients friendly names ## Configuring clients friendly names
It may be useful to set up a friendly name for each IP address that clients use to connect to AdGuard Home. To do this, follow these steps: It may be useful to set up a friendly name for each IP address that clients use to connect to AdGuard Home. To do this, follow these steps:
1. Open `/etc/hosts` file in your text editor and add a name for each IP address, for example: 1. Open `/etc/hosts` file in your text editor and add a name for each IP address, for example:
192.168.0.2 Mom 192.168.0.2 Mom
192.168.0.3 Dad 192.168.0.3 Dad
192.168.0.4 Sister 192.168.0.4 Sister
192.168.0.5 Brother 192.168.0.5 Brother
Note that on Windows file path to "hosts" file is different: `c:\windows\system32\drivers\etc\hosts` Note that on Windows file path to "hosts" file is different: `c:\windows\system32\drivers\etc\hosts`
2. Restart AdGuard Home 2. Restart AdGuard Home
As a result you will see that the clients names are now shown: As a result you will see that the clients names are now shown:
@ -143,121 +148,122 @@ As a result you will see that the clients names are now shown:
In the future, we plan to add more configuration options in this area. In the future, we plan to add more configuration options in this area.
<a id="configuration-file"></a> <a id="configuration-file"></a>
## 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. 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.
Settings are stored in [YAML format](https://en.wikipedia.org/wiki/YAML), possible parameters that you can configure are listed below: Settings are stored in [YAML format](https://en.wikipedia.org/wiki/YAML), possible parameters that you can configure are listed below:
* `bind_host` — Web interface IP address to listen on. - `bind_host` — Web interface IP address to listen on.
* `bind_port` — Web interface IP port to listen on. - `bind_port` — Web interface IP port to listen on.
* `users` — Web users info - `users` — Web users info
* `name` — User name - `name` — User name
* `password` — BCrypt-encrypted password - `password` — BCrypt-encrypted password
* `http_proxy` — proxy URL for HTTP client (e.g. "http://user:password@server:port/"). Supports "http", "https" and "socks5" scheme. - `http_proxy` — proxy URL for HTTP client (e.g. "http://user:password@server:port/"). Supports "http", "https" and "socks5" scheme.
* `web_session_ttl` — Web session TTL (in hours) - a web user will stay signed in for this amount of time. - `web_session_ttl` — Web session TTL (in hours) - a web user will stay signed in for this amount of time.
* `rlimit_nofile` — Limit on the maximum number of open files for server process (Linux and macOS). Set to 0 to use the system default value. - `rlimit_nofile` — Limit on the maximum number of open files for server process (Linux and macOS). Set to 0 to use the system default value.
* `debug_pprof` — Enable pprof HTTP server listening on port 6060 for debugging. See section `Profiling with pprof`. - `debug_pprof` — Enable pprof HTTP server listening on port 6060 for debugging. See section `Profiling with pprof`.
* `dns` — DNS configuration section. - `dns` — DNS configuration section.
* **General settings** - **General settings**
* `bind_host` - DNS interface IP address to listen on. - `bind_host` - DNS interface IP address to listen on.
* `port` — DNS server port to listen on. - `port` — DNS server port to listen on.
* `statistics_interval` - time interval for statistics (in days) - `statistics_interval` - time interval for statistics (in days)
* **Protection settings** - **Protection settings**
* `protection_enabled` — Whether any kind of filtering and protection should be done, when off it works as a plain dns forwarder. - `protection_enabled` — Whether any kind of filtering and protection should be done, when off it works as a plain dns forwarder.
* `filtering_enabled` — Filtering of DNS requests based on filter lists. - `filtering_enabled` — Filtering of DNS requests based on filter lists.
* `blocking_mode` — Specifies how to block DNS requests. "nxdomain" (default): respond with NXDOMAIN status; "null_ip": respond with the unspecified IP address (0.0.0.0); or "custom_ip": reponsd with `blocking_ipv4` or `blocking_ipv6`. - `blocking_mode` — Specifies how to block DNS requests. "nxdomain" (default): respond with NXDOMAIN status; "null_ip": respond with the unspecified IP address (0.0.0.0); or "custom_ip": reponsd with `blocking_ipv4` or `blocking_ipv6`.
* `blocking_ipv4` - IP address to be returned for a blocked A request if `blocking_mode` is set to `custom_ip` - `blocking_ipv4` - IP address to be returned for a blocked A request if `blocking_mode` is set to `custom_ip`
* `blocking_ipv6` - IP address to be returned for a blocked AAAA request if `blocking_mode` is set to `custom_ip` - `blocking_ipv6` - IP address to be returned for a blocked AAAA request if `blocking_mode` is set to `custom_ip`
* `blocked_response_ttl` — For how many seconds the clients should cache a filtered response. Low values are useful on LAN if you change filters very often, high values are useful to increase performance and save traffic. - `blocked_response_ttl` — For how many seconds the clients should cache a filtered response. Low values are useful on LAN if you change filters very often, high values are useful to increase performance and save traffic.
* `parental_block_host` — IP (or domain name) which is used to respond to DNS requests blocked by parental control - `parental_block_host` — IP (or domain name) which is used to respond to DNS requests blocked by parental control
* `safebrowsing_block_host` — IP (or domain name) which is used to respond to DNS requests blocked by safe-browsing - `safebrowsing_block_host` — IP (or domain name) which is used to respond to DNS requests blocked by safe-browsing
* `parental_enabled` — Parental control-based DNS requests filtering. - `parental_enabled` — Parental control-based DNS requests filtering.
* `safesearch_enabled` — Enforcing "Safe search" option for search engines, when possible. - `safesearch_enabled` — Enforcing "Safe search" option for search engines, when possible.
* `safebrowsing_enabled` — Filtering of DNS requests based on safebrowsing. - `safebrowsing_enabled` — Filtering of DNS requests based on safebrowsing.
* **Query log settings** - **Query log settings**
* `querylog_enabled` — Query logging (also used to calculate top 50 clients, blocked domains and requested domains for statistical purposes). - `querylog_enabled` — Query logging (also used to calculate top 50 clients, blocked domains and requested domains for statistical purposes).
* `querylog_file_enabled` — Write query logs to a file. - `querylog_file_enabled` — Write query logs to a file.
* `querylog_interval` - Time interval for query log (in days) - `querylog_interval` - Time interval for query log (in days)
* `querylog_size_memory` - Number of entries kept in memory before they are flushed to disk - `querylog_size_memory` - Number of entries kept in memory before they are flushed to disk
* `anonymize_client_ip` - If true, anonymize clients' IP addresses in logs and stats - `anonymize_client_ip` - If true, anonymize clients' IP addresses in logs and stats
* **Anti-DNS amplification features** - **Anti-DNS amplification features**
* `ratelimit` — DDoS protection, specifies in how many packets per second a client should receive. Anything above that is silently dropped. To disable set 0, default is 20. Safe to disable if DNS server is not available from internet. - `ratelimit` — DDoS protection, specifies in how many packets per second a client should receive. Anything above that is silently dropped. To disable set 0, default is 20. Safe to disable if DNS server is not available from internet.
* `ratelimit_whitelist` — If you want exclude some IP addresses from ratelimiting but keep ratelimiting on for others, put them here. - `ratelimit_whitelist` — If you want exclude some IP addresses from ratelimiting but keep ratelimiting on for others, put them here.
* `refuse_any` — Another DDoS protection mechanism. Requests of type ANY are rarely needed, so refusing to serve them mitigates against attackers trying to use your DNS as a reflection. Safe to disable if DNS server is not available from internet. - `refuse_any` — Another DDoS protection mechanism. Requests of type ANY are rarely needed, so refusing to serve them mitigates against attackers trying to use your DNS as a reflection. Safe to disable if DNS server is not available from internet.
* **Upstream DNS servers settings** - **Upstream DNS servers settings**
* `upstream_dns` — List of upstream DNS servers. - `upstream_dns` — List of upstream DNS servers.
* `upstream_dns_file` — Path to a file with the list of upstream DNS servers. If it is configured, the value of `upstream_dns` is ignored. - `upstream_dns_file` — Path to a file with the list of upstream DNS servers. If it is configured, the value of `upstream_dns` is ignored.
* `bootstrap_dns` — List of DNS servers used for initial hostname resolution in case an upstream server name is a hostname. - `bootstrap_dns` — List of DNS servers used for initial hostname resolution in case an upstream server name is a hostname.
* `all_servers` — Enables parallel queries to all configured upstream servers to speed up resolving. If disabled, the queries are sent to each upstream server one-by-one and then sorted by RTT. - `all_servers` — Enables parallel queries to all configured upstream servers to speed up resolving. If disabled, the queries are sent to each upstream server one-by-one and then sorted by RTT.
* `fastest_addr` — Use Fastest Address algorithm. It finds an IP address with the lowest latency and returns this IP address in DNS response. - `fastest_addr` — Use Fastest Address algorithm. It finds an IP address with the lowest latency and returns this IP address in DNS response.
* **ECS settings** - **ECS settings**
* `edns_client_subnet` — Enable EDNS Client Subnet option. If enabled, AdGuard Home will be sending ECS extension to the upstream DNS servers. Please note, that this will be done for clients with public IP addresses only. - `edns_client_subnet` — Enable EDNS Client Subnet option. If enabled, AdGuard Home will be sending ECS extension to the upstream DNS servers. Please note, that this will be done for clients with public IP addresses only.
* **Access settings** - **Access settings**
* `allowed_clients` — IP addresses of allowed clients - `allowed_clients` — IP addresses of allowed clients
* `disallowed_clients` — IP addresses of clients that should be blocked - `disallowed_clients` — IP addresses of clients that should be blocked
* `blocked_hosts` — hosts that should be blocked - `blocked_hosts` — hosts that should be blocked
* **DNS cache settings** - **DNS cache settings**
* `cache_size` — DNS cache size (in bytes) - `cache_size` — DNS cache size (in bytes)
* `cache_ttl_min` — override TTL value (minimum) received from upstream server. This value can't larger than 3600 (1 hour). - `cache_ttl_min` — override TTL value (minimum) received from upstream server. This value can't larger than 3600 (1 hour).
* `cache_ttl_max` — override TTL value (maximum) received from upstream server - `cache_ttl_max` — override TTL value (maximum) received from upstream server
* **Other settings** - **Other settings**
* `bogus_nxdomain` - Transform responses with these IP addresses to NXDOMAIN - `bogus_nxdomain` - Transform responses with these IP addresses to NXDOMAIN
* `enable_dnssec` - Set DNSSEC flag in the outgoing DNS requests and check the result - `enable_dnssec` - Set DNSSEC flag in the outgoing DNS requests and check the result
* `aaaa_disabled` — Respond with an empty answer to all AAAA requests - `aaaa_disabled` — Respond with an empty answer to all AAAA requests
* `safebrowsing_cache_size` — Safe Browsing cache size (in bytes) - `safebrowsing_cache_size` — Safe Browsing cache size (in bytes)
* `safesearch_cache_size` — Safe Search cache size (in bytes) - `safesearch_cache_size` — Safe Search cache size (in bytes)
* `parental_cache_size` — Parental Control cache size (in bytes) - `parental_cache_size` — Parental Control cache size (in bytes)
* `cache_time` — Safe Browsing, Safe Search, Parental Control cache TTL - `cache_time` — Safe Browsing, Safe Search, Parental Control cache TTL
* `max_goroutines` — Max. number of parallel goroutines for processing incoming requests - `max_goroutines` — Max. number of parallel goroutines for processing incoming requests
* `ipset` — List of domain-ipset_name associations for adding IP addresses of the specified domain names to an ipset list. Syntax: `DOMAIN[,DOMAIN].../IPSET_NAME[,IPSET_NAME]...`. IPv4 addresses are added to an ipset list with `ipv4` family, IPv6 addresses - to `ipv6` ipset list. ipset list must exist. This setting is supported on Linux only. This feature is similar to `--ipset` in dnsmasq. - `ipset` — List of domain-ipset_name associations for adding IP addresses of the specified domain names to an ipset list. Syntax: `DOMAIN[,DOMAIN].../IPSET_NAME[,IPSET_NAME]...`. IPv4 addresses are added to an ipset list with `ipv4` family, IPv6 addresses - to `ipv6` ipset list. ipset list must exist. This setting is supported on Linux only. This feature is similar to `--ipset` in dnsmasq.
* `filters` — List of filters, each filter has the following values: - `filters` — List of filters, each filter has the following values:
* `enabled` — Current filter's status (enabled/disabled). - `enabled` — Current filter's status (enabled/disabled).
* `url` — URL pointing to the filter contents (filtering rules). - `url` — URL pointing to the filter contents (filtering rules).
* `name` — Name of the filter. If it's an adguard syntax filter it will get updated automatically, otherwise it stays unchanged. - `name` — Name of the filter. If it's an adguard syntax filter it will get updated automatically, otherwise it stays unchanged.
* `last_updated` — Time when the filter was last updated from server. - `last_updated` — Time when the filter was last updated from server.
* `ID` - filter ID (must be unique). - `ID` - filter ID (must be unique).
* `dhcp` - Built-in DHCP server configuration. - `dhcp` - Built-in DHCP server configuration.
* `enabled` - DHCP server status. - `enabled` - DHCP server status.
* `interface_name` - network interface name (eth0, en0 and so on). - `interface_name` - network interface name (eth0, en0 and so on).
* `dhcpv4` - DHCPv4 settings - `dhcpv4` - DHCPv4 settings
* `gateway_ip` - gateway IP address. - `gateway_ip` - gateway IP address.
* `subnet_mask` - subnet mask. - `subnet_mask` - subnet mask.
* `range_start` - start IP address of the controlled range. - `range_start` - start IP address of the controlled range.
* `range_end` - end IP address of the controlled range. - `range_end` - end IP address of the controlled range.
* `lease_duration` - lease duration in seconds. If 0, using default duration (24 hours). - `lease_duration` - lease duration in seconds. If 0, using default duration (24 hours).
* `options` - custom options with arbitrary hex data (`DEC_CODE hex HEX_DATA`) or IP address (`DEC_CODE ip IP_ADDR`) where DEC_CODE is a decimal DHCPv4 option code in range [1..255] - `options` - custom options with arbitrary hex data (`DEC_CODE hex HEX_DATA`) or IP address (`DEC_CODE ip IP_ADDR`) where DEC_CODE is a decimal DHCPv4 option code in range [1..255]
* `dhcpv6` - DHCPv6 settings - `dhcpv6` - DHCPv6 settings
* `range_start` - the first IP address to be assigned to a client - `range_start` - the first IP address to be assigned to a client
* `lease_duration` - lease TTL in seconds - `lease_duration` - lease TTL in seconds
* `ra_slaac_only` - send RA packets forcing the clients to use SLAAC - `ra_slaac_only` - send RA packets forcing the clients to use SLAAC
* `ra_allow_slaac` - send RA packets making the clients to choose between SLAAC and DHCPv6 - `ra_allow_slaac` - send RA packets making the clients to choose between SLAAC and DHCPv6
* `tls` - HTTPS/DOH/DOT settings. - `tls` - HTTPS/DOH/DOT settings.
* `enabled` - encryption (DOT/DOH/HTTPS) status. - `enabled` - encryption (DOT/DOH/HTTPS) status.
* `server_name` - the hostname of your HTTPS/TLS server. - `server_name` - the hostname of your HTTPS/TLS server.
* `force_https` - if true, forces HTTP->HTTPS redirect. - `force_https` - if true, forces HTTP->HTTPS redirect.
* `port_https` - HTTPS port. If 0, HTTPS will be disabled. - `port_https` - HTTPS port. If 0, HTTPS will be disabled.
* `port_dns_over_tls` - DNS-over-TLS port. If 0, DOT will be disabled. - `port_dns_over_tls` - DNS-over-TLS port. If 0, DOT will be disabled.
* `allow_unencrypted_doh` - Allow DOH queries via unencrypted HTTP (e.g. for reverse proxying) - `allow_unencrypted_doh` - Allow DOH queries via unencrypted HTTP (e.g. for reverse proxying)
* `certificate_chain` - PEM-encoded certificates chain. - `certificate_chain` - PEM-encoded certificates chain.
* `strict_sni_check` - Reject connection if the client uses server name (in SNI) that doesn't match the certificate - `strict_sni_check` - Reject connection if the client uses server name (in SNI) that doesn't match the certificate
* `private_key` - PEM-encoded private key. - `private_key` - PEM-encoded private key.
* `icmp_timeout_msec` - time (ms) to wait for ICMP reply to detect an IP conflict. If 0, the feature is disabled. - `icmp_timeout_msec` - time (ms) to wait for ICMP reply to detect an IP conflict. If 0, the feature is disabled.
* `user_rules` — User-specified filtering rules. - `user_rules` — User-specified filtering rules.
* **Log settings** - **Log settings**
* `log_file` — Path to the log file. If empty, writes to stdout, if `syslog` -- system log (or eventlog on Windows). - `log_file` — Path to the log file. If empty, writes to stdout, if `syslog` -- system log (or eventlog on Windows).
* `log_compress` — Compress determines if the rotated log files should be compressed using gzip (default: false) - `log_compress` — Compress determines if the rotated log files should be compressed using gzip (default: false)
* `log_localtime` — If the time used for formatting the timestamps in is the computer's local time (default: false [UTC]) - `log_localtime` — If the time used for formatting the timestamps in is the computer's local time (default: false [UTC])
* `log_max_backups` — Maximum number of old log files to retain (MaxAge may still cause them to get deleted) (default: 0, which retains all old log files) - `log_max_backups` — Maximum number of old log files to retain (MaxAge may still cause them to get deleted) (default: 0, which retains all old log files)
* `log_max_size` — Maximum size in megabytes of the log file before it gets rotated (default: 100 MB) - `log_max_size` — Maximum size in megabytes of the log file before it gets rotated (default: 100 MB)
* `log_max_age` — MaxAge is the maximum number of days to retain old log files (default: 3) - `log_max_age` — MaxAge is the maximum number of days to retain old log files (default: 3)
* `verbose` — Enable our disables debug verbose output (default: false) - `verbose` — Enable our disables debug verbose output (default: false)
Removing an entry from settings file will reset it to the default value. Deleting the file will reset all settings to the default values. Removing an entry from settings file will reset it to the default value. Deleting the file will reset all settings to the default values.
<a id="password-reset"></a> <a id="password-reset"></a>
## Reset Web Password ## Reset Web Password
AdGuard Home stores password as a BCrypt-encoded hash. AdGuard Home stores password as a BCrypt-encoded hash.
@ -272,11 +278,11 @@ Here's what you need to do to change the password:
Now you'll be able to log in to Web interface using your new password. Now you'll be able to log in to Web interface using your new password.
<a id="pprof"></a> <a id="pprof"></a>
## Profiling with pprof ## Profiling with pprof
To enable pprof, set `debug_pprof: true` in yaml configuration file and then restart AdGuardHome. Now you can get profiling information with your browser, e.g.: To enable pprof, set `debug_pprof: true` in yaml configuration file and then restart AdGuardHome. Now you can get profiling information with your browser, e.g.:
http://localhost:6060/debug/pprof/goroutine?debug=2 http://localhost:6060/debug/pprof/goroutine?debug=2
@ -292,8 +298,8 @@ or with `go tool pprof`:
For a list of supported profiles go to `http://localhost:6060/debug/pprof/`. For a list of supported profiles go to `http://localhost:6060/debug/pprof/`.
<a id="dhcp-options"></a> <a id="dhcp-options"></a>
## Additional DHCP options ## Additional DHCP options
There are several configuration parameters for DHCP that can't be set via AGH administrator dashboard. There are several configuration parameters for DHCP that can't be set via AGH administrator dashboard.