Pull request #1572: 4640-imp-upstream-doc

Updates #4640.

Squashed commit of the following:

commit 764b024e7a5a5f6ea2b18b5e13fdc4fa38c49af2
Merge: 7bace870 6856a803
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Fri Aug 19 17:17:44 2022 +0300

    Merge branch 'master' into 4640-imp-upstream-doc

commit 7bace870102633a2b8323c5f448ed38b65f4b482
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Thu Aug 18 19:49:07 2022 +0300

    all: imp upstream examples
This commit is contained in:
Ainar Garipov 2022-08-19 17:36:51 +03:00
parent 6856a80380
commit 1afd73ad0b
6 changed files with 113 additions and 115 deletions

View File

@ -22,6 +22,10 @@ and this project adheres to
### Deprecated ### Deprecated
- Ports 784 and 8853 for DNS-over-QUIC in Docker images. Users who still serve
DoQ on these ports are encouraged to move to the standard port 853. These
ports will be removed from the `EXPOSE` section of our `Dockerfile` in a
future release.
- Go 1.18 support. v0.109.0 will require at least Go 1.19 to build. - Go 1.18 support. v0.109.0 will require at least Go 1.19 to build.
[#2993]: https://github.com/AdguardTeam/AdGuardHome/issues/2993 [#2993]: https://github.com/AdguardTeam/AdGuardHome/issues/2993
@ -48,7 +52,7 @@ See also the [v0.107.11 GitHub milestone][ms-v0.107.11].
### Changed ### Changed
- DNS-over-QUIC connections now use keepalive. - DNS-over-QUIC connections now use keptalive.
### Fixed ### Fixed

View File

@ -211,12 +211,14 @@
"example_comment_hash": "# Also a comment.", "example_comment_hash": "# Also a comment.",
"example_regex_meaning": "block access to domains matching the specified regular expression.", "example_regex_meaning": "block access to domains matching the specified regular expression.",
"example_upstream_regular": "regular DNS (over UDP);", "example_upstream_regular": "regular DNS (over UDP);",
"example_upstream_regular_port": "regular DNS (over UDP, with port);",
"example_upstream_udp": "regular DNS (over UDP, hostname);", "example_upstream_udp": "regular DNS (over UDP, hostname);",
"example_upstream_dot": "encrypted <0>DNS-over-TLS</0>;", "example_upstream_dot": "encrypted <0>DNS-over-TLS</0>;",
"example_upstream_doh": "encrypted <0>DNS-over-HTTPS</0>;", "example_upstream_doh": "encrypted <0>DNS-over-HTTPS</0>;",
"example_upstream_doq": "encrypted <0>DNS-over-QUIC</0>;", "example_upstream_doq": "encrypted <0>DNS-over-QUIC</0>;",
"example_upstream_sdns": "<0>DNS Stamps</0> for <1>DNSCrypt</1> or <2>DNS-over-HTTPS</2> resolvers;", "example_upstream_sdns": "<0>DNS Stamps</0> for <1>DNSCrypt</1> or <2>DNS-over-HTTPS</2> resolvers;",
"example_upstream_tcp": "regular DNS (over TCP);", "example_upstream_tcp": "regular DNS (over TCP);",
"example_upstream_tcp_port": "regular DNS (over TCP, with port);",
"example_upstream_tcp_hostname": "regular DNS (over TCP, hostname);", "example_upstream_tcp_hostname": "regular DNS (over TCP, hostname);",
"all_lists_up_to_date_toast": "All lists are already up-to-date", "all_lists_up_to_date_toast": "All lists are already up-to-date",
"updated_upstream_dns_toast": "Upstream servers successfully saved", "updated_upstream_dns_toast": "Upstream servers successfully saved",

View File

@ -8,133 +8,123 @@ const Examples = (props) => (
<Trans>examples_title</Trans>: <Trans>examples_title</Trans>:
<ol className="leading-loose"> <ol className="leading-loose">
<li> <li>
<code>94.140.14.140</code>: {props.t('example_upstream_regular')} <code>94.140.14.140</code>, <code>2a10:50c0::1:ff</code>: {props.t('example_upstream_regular')}
</li>
<li>
<code>94.140.14.140:53</code>, <code>[2a10:50c0::1:ff]:53</code>: {props.t('example_upstream_regular_port')}
</li> </li>
<li> <li>
<code>udp://unfiltered.adguard-dns.com</code>: <Trans>example_upstream_udp</Trans> <code>udp://unfiltered.adguard-dns.com</code>: <Trans>example_upstream_udp</Trans>
</li> </li>
<li> <li>
<code>tcp://94.140.14.140</code>: <Trans>example_upstream_tcp</Trans> <code>tcp://94.140.14.140</code>, <code>tcp://[2a10:50c0::1:ff]</code>: <Trans>example_upstream_tcp</Trans>
</li>
<li>
<code>tcp://94.140.14.140:53</code>, <code>tcp://[2a10:50c0::1:ff]:53</code>: <Trans>example_upstream_tcp_port</Trans>
</li> </li>
<li> <li>
<code>tcp://unfiltered.adguard-dns.com</code>: <Trans>example_upstream_tcp_hostname</Trans> <code>tcp://unfiltered.adguard-dns.com</code>: <Trans>example_upstream_tcp_hostname</Trans>
</li> </li>
<li> <li>
<code>tls://unfiltered.adguard-dns.com</code>: <code>tls://unfiltered.adguard-dns.com</code>: <Trans
<span> components={[
<Trans <a
components={[ href="https://en.wikipedia.org/wiki/DNS_over_TLS"
<a target="_blank"
href="https://en.wikipedia.org/wiki/DNS_over_TLS" rel="noopener noreferrer"
target="_blank" key="0"
rel="noopener noreferrer" >
key="0" DNS-over-TLS
> </a>,
DNS-over-TLS ]}
</a>, >
]} example_upstream_dot
> </Trans>
example_upstream_dot
</Trans>
</span>
</li> </li>
<li> <li>
<code>https://unfiltered.adguard-dns.com/dns-query</code>: <code>https://unfiltered.adguard-dns.com/dns-query</code>: <Trans
<span> components={[
<Trans <a
components={[ href="https://en.wikipedia.org/wiki/DNS_over_HTTPS"
<a target="_blank"
href="https://en.wikipedia.org/wiki/DNS_over_HTTPS" rel="noopener noreferrer"
target="_blank" key="0"
rel="noopener noreferrer" >
key="0" DNS-over-HTTPS
> </a>,
DNS-over-HTTPS ]}
</a>, >
]} example_upstream_doh
> </Trans>
example_upstream_doh
</Trans>
</span>
</li> </li>
<li> <li>
<code>quic://unfiltered.adguard-dns.com:784</code>: <code>quic://unfiltered.adguard-dns.com</code>: <Trans
<span> components={[
<Trans <a
components={[ href="https://datatracker.ietf.org/doc/html/rfc9250"
<a target="_blank"
href="https://datatracker.ietf.org/doc/html/rfc9250" rel="noopener noreferrer"
target="_blank" key="0"
rel="noopener noreferrer" >
key="0" DNS-over-QUIC
> </a>,
DNS-over-QUIC ]}
</a>, >
]} example_upstream_doq
> </Trans>
example_upstream_doq
</Trans>
</span>
</li> </li>
<li> <li>
<code>sdns://...</code>: <code>sdns://...</code>: <Trans
<span> components={[
<Trans <a
components={[ href="https://dnscrypt.info/stamps/"
<a target="_blank"
href="https://dnscrypt.info/stamps/" rel="noopener noreferrer"
target="_blank" key="0"
rel="noopener noreferrer" >
key="0" DNS Stamps
> </a>,
DNS Stamps <a
</a>, href="https://dnscrypt.info/"
<a target="_blank"
href="https://dnscrypt.info/" rel="noopener noreferrer"
target="_blank" key="1"
rel="noopener noreferrer" >
key="1" DNSCrypt
> </a>,
DNSCrypt <a
</a>, href="https://en.wikipedia.org/wiki/DNS_over_HTTPS"
<a target="_blank"
href="https://en.wikipedia.org/wiki/DNS_over_HTTPS" rel="noopener noreferrer"
target="_blank" key="2"
rel="noopener noreferrer" >
key="2" DNS-over-HTTPS
> </a>,
DNS-over-HTTPS ]}
</a>, >
]} example_upstream_sdns
> </Trans>
example_upstream_sdns
</Trans>
</span>
</li> </li>
<li> <li>
<code>[/example.local/]94.140.14.140</code>: <code>[/example.local/]94.140.14.140</code>: <Trans
<span> components={[
<Trans <a
components={[ href="https://github.com/AdguardTeam/AdGuardHome/wiki/Configuration#upstreams-for-domains"
<a target="_blank"
href="https://github.com/AdguardTeam/AdGuardHome/wiki/Configuration#upstreams-for-domains" rel="noopener noreferrer"
target="_blank" key="0"
rel="noopener noreferrer" >
key="0" Link
> </a>,
Link ]}
</a>, >
]} example_upstream_reserved
> </Trans>
example_upstream_reserved
</Trans>
</span>
</li> </li>
<li> <li>
<code>{COMMENT_LINE_DEFAULT_TOKEN} comment</code>: <code>{COMMENT_LINE_DEFAULT_TOKEN} comment</code>: <Trans>
<span> example_upstream_comment
<Trans>example_upstream_comment</Trans> </Trans>
</span>
</li> </li>
</ol> </ol>
</div> </div>

View File

@ -81,7 +81,7 @@ export const STANDARD_DNS_PORT = 53;
export const STANDARD_WEB_PORT = 80; export const STANDARD_WEB_PORT = 80;
export const STANDARD_HTTPS_PORT = 443; export const STANDARD_HTTPS_PORT = 443;
export const DNS_OVER_TLS_PORT = 853; export const DNS_OVER_TLS_PORT = 853;
export const DNS_OVER_QUIC_PORT = 784; export const DNS_OVER_QUIC_PORT = 853;
export const MAX_PORT = 65535; export const MAX_PORT = 65535;
export const EMPTY_DATE = '0001-01-01T00:00:00Z'; export const EMPTY_DATE = '0001-01-01T00:00:00Z';

View File

@ -4405,7 +4405,7 @@
Validatable TLS settings. Validatable TLS settings.
'example': 'example':
'certificate_path': '/etc/ssl/example.com.cert' 'certificate_path': '/etc/ssl/example.com.cert'
'port_dns_over_quic': 784 'port_dns_over_quic': 853
'port_dns_over_tls': 853 'port_dns_over_tls': 853
'port_https': 443 'port_https': 443
'private_key_path': '/etc/ssl/example.com.key' 'private_key_path': '/etc/ssl/example.com.key'
@ -4427,7 +4427,7 @@
sent. sent.
'type': 'string' 'type': 'string'
'port_dns_over_quic': 'port_dns_over_quic':
'default': 784 'default': 853
'description': > 'description': >
The DNS-over-QUIC port. If `0`, DNS-over-QUIC is disabled. The DNS-over-QUIC port. If `0`, DNS-over-QUIC is disabled.
'format': 'int64' 'format': 'int64'
@ -4865,7 +4865,7 @@
'example': 'example':
'certificate_path': '/etc/ssl/example.com.cert' 'certificate_path': '/etc/ssl/example.com.cert'
'enabled': true 'enabled': true
'port_dns_over_quic': 784 'port_dns_over_quic': 853
'port_dns_over_tls': 853 'port_dns_over_tls': 853
'port_https': 443 'port_https': 443
'private_key_path': '/etc/ssl/example.com.key' 'private_key_path': '/etc/ssl/example.com.key'
@ -4907,7 +4907,7 @@
DNS-over-TLS and other protocols. DNS-over-TLS and other protocols.
'type': 'boolean' 'type': 'boolean'
'port_dns_over_quic': 'port_dns_over_quic':
'default': 784 'default': 853
'description': > 'description': >
The DNS-over-QUIC port. If `0`, DNS-over-QUIC is disabled. The DNS-over-QUIC port. If `0`, DNS-over-QUIC is disabled.
'format': 'int64' 'format': 'int64'
@ -5002,8 +5002,7 @@
* `https://unfiltered.adguard-dns.com/dns-query`: encrypted * `https://unfiltered.adguard-dns.com/dns-query`: encrypted
DNS-over-HTTPS. DNS-over-HTTPS.
* `quic://unfiltered.adguard-dns.com:784`: encrypted DNS-over-QUIC * `quic://unfiltered.adguard-dns.com`: encrypted DNS-over-QUIC.
(experimental).
* `tcp://94.140.14.140`: plain DNS-over-TCP. * `tcp://94.140.14.140`: plain DNS-over-TCP.

View File

@ -48,6 +48,9 @@ RUN setcap 'cap_net_bind_service=+eip' /opt/adguardhome/AdGuardHome
# 5443 : TCP, UDP : DNSCrypt (alt) # 5443 : TCP, UDP : DNSCrypt (alt)
# 6060 : TCP : HTTP (pprof) # 6060 : TCP : HTTP (pprof)
# 8853 : UDP : DNS-over-QUIC (experimental) # 8853 : UDP : DNS-over-QUIC (experimental)
#
# TODO(a.garipov): Remove the old, non-standard 784 and 8853 ports for
# DNS-over-QUIC in a future release.
EXPOSE 53/tcp 53/udp 67/udp 68/udp 80/tcp 443/tcp 443/udp 784/udp\ EXPOSE 53/tcp 53/udp 67/udp 68/udp 80/tcp 443/tcp 443/udp 784/udp\
853/tcp 853/udp 3000/tcp 3000/udp 3001/tcp 3001/udp 5443/tcp\ 853/tcp 853/udp 3000/tcp 3000/udp 3001/tcp 3001/udp 5443/tcp\
5443/udp 6060/tcp 8853/udp 5443/udp 6060/tcp 8853/udp