a
/
badguardhome
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

readme -- Update config field descriptions and clarify about coredns.

This commit is contained in:
Eugene Bujak 2018-12-06 17:17:42 +03:00
parent 15f3c82238
commit 217124cb3b
1 changed files with 26 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
README.md
View File

@ -104,25 +104,32 @@ Upon the first execution, a file named `AdGuardHome.yaml` will be created, with
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.
* `auth_name` — Web interface optional authorization username * `auth_name` — Web interface optional authorization username.
* `auth_pass` — Web interface optional authorization password * `auth_pass` — Web interface optional authorization password.
* `dns` — DNS configuration section * `dns` — DNS configuration section.
* `port` — DNS server port to listen on * `port` — DNS server port to listen on.
* `filtering_enabled` — Filtering of DNS requests based on filter lists * `protection_enabled` — Whether any kind of filtering and protection should be done, when off it works as a plain dns forwarder.
* `safebrowsing_enabled` — Filtering of DNS requests based on safebrowsing * `filtering_enabled` — Filtering of DNS requests based on filter lists.
* `safesearch_enabled` — Enforcing "Safe search" option for search engines, when possible * `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_enabled` — Parental control-based DNS requests filtering * `querylog_enabled` — Query logging (also used to calculate top 50 clients, blocked domains and requested domains for statistical purposes).
* `parental_sensitivity` — Age group for parental control-based filtering, must be either 3, 10, 13 or 17 * `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.
* `querylog_enabled` — Query logging (also used to calculate top 50 clients, blocked domains and requested domains for statistic purposes) * `ratelimit_whitelist` — If you want exclude some IP addresses from ratelimiting but keep ratelimiting on for others, put them here.
* `bootstrap_dns` — DNS server used for initial hostname resolution in case if upstream server name is a hostname * `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` — List of upstream DNS servers * `bootstrap_dns` — DNS server used for initial hostname resolution in case if upstream server name is a hostname.
* `parental_sensitivity` — Age group for parental control-based filtering, must be either 3, 10, 13 or 17 if enabled.
* `parental_enabled` — Parental control-based DNS requests filtering.
* `safesearch_enabled` — Enforcing "Safe search" option for search engines, when possible.
* `safebrowsing_enabled` — Filtering of DNS requests based on safebrowsing.
* `upstream_dns` — List of upstream DNS servers.
* `filters` — List of filters, each filter has the following values: * `filters` — List of filters, each filter has the following values:
* `ID` - filter ID (must be unique) * `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).
* `enabled` — Current filter's status (enabled/disabled) * `name` — Name of the filter. If it's an adguard syntax filter it will get updated automatically, otherwise it stays unchanged.
* `user_rules` — User-specified filtering rules * `last_updated` — Time when the filter was last updated from server.
* `ID` - filter ID (must be unique).
* `user_rules` — User-specified filtering rules.
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.
@ -208,6 +215,6 @@ This software wouldn't have been possible without:
* And many more node.js packages. * And many more node.js packages.
* [whotracks.me data](https://github.com/cliqz-oss/whotracks.me) * [whotracks.me data](https://github.com/cliqz-oss/whotracks.me)
You might have seen that coredns was mentioned here before — we've stopped using it in AdGuardHome. While we still use it on our servers, it seemed like an overkill and it impeded with Home features that we wanted to implement. You might have seen that [CoreDNS](https://coredns.io) was mentioned here before — we've stopped using it in AdGuardHome. While we still use it on our servers for [AdGuard DNS](https://adguard.com/adguard-dns/overview.html) service, it seemed like an overkill for Home as it impeded with Home features that we plan to implement.
For a full list of all node.js packages in use, please take a look at [client/package.json](https://github.com/AdguardTeam/AdGuardHome/blob/master/client/package.json) file. For a full list of all node.js packages in use, please take a look at [client/package.json](https://github.com/AdguardTeam/AdGuardHome/blob/master/client/package.json) file.