You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

94 lines
5.4 KiB

  1. # DNS Over HTTPS Proxy (https-dns-proxy)
  2. A lean RFC8484-compatible (no JSON API support) DNS-over-HTTPS (DoH) proxy service which supports DoH servers ran by AdGuard, CleanBrowsing, Cloudflare, Google, ODVR (nic.cz) and Quad9. Based on [@aarond10](https://github.com/aarond10)'s [https-dns-proxy](https://github.com/aarond10/https_dns_proxy).
  3. ## Features
  4. - [RFC8484](https://tools.ietf.org/html/rfc8484)-compatible DoH Proxy.
  5. - Compact size.
  6. - Web UI (```luci-app-https-dns-proxy```) available.
  7. - (By default) automatically updates DNSMASQ settings to use DoH proxy when it's started and reverts to old DNSMASQ resolvers when DoH proxy is stopped.
  8. ## Screenshots (luci-app-https-dns-proxy)
  9. ![screenshot](https://cdn.jsdelivr.net/gh/stangri/openwrt_packages@master/screenshots/https-dns-proxy/screenshot01.png "https-dns-proxy screenshot")
  10. ## Requirements
  11. This proxy requires the following packages to be installed on your router: ```libc```, ```libcares```, ```libcurl```, ```libev```, ```ca-bundle```. They will be automatically installed when you're installing ```https-dns-proxy```.
  12. ## Unmet Dependencies
  13. If you are running a development (trunk/snapshot) build of OpenWrt/LEDE Project on your router and your build is outdated (meaning that packages of the same revision/commit hash are no longer available and when you try to satisfy the [requirements](#requirements) you get errors), please flash either current LEDE release image or current development/snapshot image.
  14. ## How To Install
  15. Install ```https-dns-proxy``` and ```luci-app-https-dns-proxy``` packages from Web UI or run the following in the command line:
  16. ```sh
  17. opkg update; opkg install https-dns-proxy luci-app-https-dns-proxy;
  18. ```
  19. ## Default Settings
  20. Default configuration has service enabled and starts the service with Google and Cloudflare DoH servers. In most configurations, you will keep the default ```DNSMASQ``` service installed to handle requests from devices in your local network and point ```DNSMASQ``` to use ```https-dns-proxy``` for name resolution.
  21. By default, the service will intelligently override existing ```DNSMASQ``` servers settings on start to use the DoH servers and restores original ```DNSMASQ``` servers on stop. See the [Configuration Settings](#configuration-settings) section below for more information and how to disable this behavior.
  22. ## Configuration Settings
  23. Configuration contains the (named) "main" config section where you can configure which ```DNSMASQ``` settings the service will automatically affect and the typed (unnamed) https-dns-proxy instance settings. The original config file is included below:
  24. ```text
  25. config main 'config'
  26. option update_dnsmasq_config '*'
  27. config https-dns-proxy
  28. option bootstrap_dns '8.8.8.8,8.8.4.4'
  29. option resolver_url 'https://dns.google/dns-query'
  30. option listen_addr '127.0.0.1'
  31. option listen_port '5053'
  32. option user 'nobody'
  33. option group 'nogroup'
  34. config https-dns-proxy
  35. option bootstrap_dns '1.1.1.1,1.0.0.1'
  36. option resolver_url 'https://cloudflare-dns.com/dns-query'
  37. option listen_addr '127.0.0.1'
  38. option listen_port '5054'
  39. option user 'nobody'
  40. option group 'nogroup'
  41. ```
  42. The ```update_dnsmasq_config``` option can be set to dash (set to ```'-'``` to not change ```DNSMASQ``` server settings on start/stop), can be set to ```'*'``` to affect all ```DNSMASQ``` instance server settings or have a space-separated list of ```DNSMASQ``` instances to affect (like ```'0 4 5'```). If this option is omitted, the default setting is ```'*'```.
  43. Starting with ```https-dns-proxy``` version ```2019-12-03-3``` and higher, when the service is set to update the DNSMASQ servers setting on start/stop, it does not override entries which contain either ```#``` or ```/```, so the entries like listed below will be kept in use:
  44. ```test
  45. list server '/onion/127.0.0.1#65453'
  46. list server '/openwrt.org/8.8.8.8'
  47. list server '/pool.ntp.org/8.8.8.8'
  48. list server '127.0.0.1#15353'
  49. list server '127.0.0.1#55353'
  50. list server '127.0.0.1#65353'
  51. ```
  52. The https-dns-proxy instance settings are:
  53. |Parameter|Type|Default|Description|
  54. | --- | --- | --- | --- |
  55. |bootstrap_dns|IP Address||The non-encrypted DNS servers to be used to resolve the DoH server name on start.|
  56. |listen_addr|IP Address|127.0.0.1|The local IP address to listen to requests.|
  57. |listen_port|port|5053 and up|If this setting is omitted, the service will start the first https-dns-proxy instance on port 5053, second on 5054 and so on.|
  58. |logfile|Full filepath||Full filepath to the file to log the instance events to.|
  59. |resolver_url|URL||The https URL to the RFC8484-compatible resolver.|
  60. |proxy_server|URL||Local proxy server to use when accessing resolvers.|
  61. |user|String|nobody|Local user to run instance under.|
  62. |group|String|nogroup|Local group to run instance under.|
  63. |use_http1|Boolean|0|If set to 1, use HTTP/1 on installations with broken/outdated ```curl``` package. Included for posterity reasons, you will most likely not ever need it on OpenWrt.|
  64. |verbosity|Integer|0|logging verbosity level. fatal = 0, error = 1, warning = 2, info = 3, debug = 4|
  65. |use_ipv6_resolvers_only|Boolean|0|If set to 1, Forces IPv6 DNS resolvers instead of IPv4|
  66. ## Thanks
  67. This OpenWrt package wouldn't have been possible without [@aarond10](https://github.com/aarond10)'s [https-dns-proxy](https://github.com/aarond10/https_dns_proxy) and his active participation in the OpenWrt package itself. Special thanks to [@jow-](https://github.com/jow-) for general package/luci guidance.