Deployed 639fba5 to main with MkDocs 1.5.2 and mike 1.1.2

ThinkChaos · Aug 2, 2023 · 4045087 · 4045087
1 parent c4f2ecd
commit 4045087
Show file tree

Hide file tree

Showing 15 changed files with 90 additions and 88 deletions.
diff --git a/main/404.html b/main/404.html
@@ -13,15 +13,15 @@
 
 
       <link rel="icon" href="/assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.18">
+      <meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.1.21">
 
 
 
         <title>blocky</title>
 
 
 
-      <link rel="stylesheet" href="/assets/stylesheets/main.26e3688c.min.css">
+      <link rel="stylesheet" href="/assets/stylesheets/main.eebd395e.min.css">
 
 
         <link rel="stylesheet" href="/assets/stylesheets/palette.ecc896b0.min.css">

diff --git a/main/additional_information/index.html b/main/additional_information/index.html
@@ -15,15 +15,15 @@
 
 
       <link rel="icon" href="../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.18">
+      <meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.1.21">
 
 
 
         <title>Additional information - blocky</title>
 
 
 
-      <link rel="stylesheet" href="../assets/stylesheets/main.26e3688c.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.eebd395e.min.css">
 
 
         <link rel="stylesheet" href="../assets/stylesheets/palette.ecc896b0.min.css">

diff --git a/main/assets/stylesheets/main.26e3688c.min.css b/main/assets/stylesheets/main.26e3688c.min.css
diff --git a/main/assets/stylesheets/main.eebd395e.min.css b/main/assets/stylesheets/main.eebd395e.min.css
diff --git a/...ets/stylesheets/main.26e3688c.min.css.map → ...ets/stylesheets/main.eebd395e.min.css.map b/...ets/stylesheets/main.26e3688c.min.css.map → ...ets/stylesheets/main.eebd395e.min.css.map
diff --git a/main/config.yml b/main/config.yml
@@ -1,25 +1,25 @@
 # REVIEW: manual changelog entry
 
-upstream:
-  # these external DNS resolvers will be used. Blocky picks 2 random resolvers from the list for each query
-  # format for resolver: [net:]host:[port][/path]. net could be empty (default, shortcut for tcp+udp), tcp+udp, tcp, udp, tcp-tls or https (DoH). If port is empty, default port will be used (53 for udp and tcp, 853 for tcp-tls, 443 for https (Doh))
-  # this configuration is mandatory, please define at least one external DNS resolver
-  default:
-    # example for tcp+udp IPv4 server (https://digitalcourage.de/)
-    - 5.9.164.112
-    # Cloudflare
-    - 1.1.1.1
-    # example for DNS-over-TLS server (DoT)
-    - tcp-tls:fdns1.dismail.de:853
-    # example for DNS-over-HTTPS (DoH)
-    - https://dns.digitale-gesellschaft.ch/dns-query
-  # optional: use client name (with wildcard support: * - sequence of any characters, [0-9] - range)
-  # or single ip address / client subnet as CIDR notation
-  laptop*:
-    - 123.123.123.123
-
-# optional: timeout to query the upstream resolver. Default: 2s
-upstreamTimeout: 2s
+upstreams:
+  groups:
+    # these external DNS resolvers will be used. Blocky picks 2 random resolvers from the list for each query
+    # format for resolver: [net:]host:[port][/path]. net could be empty (default, shortcut for tcp+udp), tcp+udp, tcp, udp, tcp-tls or https (DoH). If port is empty, default port will be used (53 for udp and tcp, 853 for tcp-tls, 443 for https (Doh))
+    # this configuration is mandatory, please define at least one external DNS resolver
+    default:
+      # example for tcp+udp IPv4 server (https://digitalcourage.de/)
+      - 5.9.164.112
+      # Cloudflare
+      - 1.1.1.1
+      # example for DNS-over-TLS server (DoT)
+      - tcp-tls:fdns1.dismail.de:853
+      # example for DNS-over-HTTPS (DoH)
+      - https://dns.digitale-gesellschaft.ch/dns-query
+    # optional: use client name (with wildcard support: * - sequence of any characters, [0-9] - range)
+    # or single ip address / client subnet as CIDR notation
+    laptop*:
+      - 123.123.123.123
+  # optional: timeout to query the upstream resolver. Default: 2s
+  timeout: 2s
 
 # optional: If true, blocky will fail to start unless at least one upstream server per group is reachable. Default: false
 startVerifyUpstream: true

diff --git a/main/configuration/index.html b/main/configuration/index.html
@@ -17,15 +17,15 @@
         <link rel="next" href="../installation/">
 
       <link rel="icon" href="../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.18">
+      <meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.1.21">
 
 
 
         <title>Configuration - blocky</title>
 
 
 
-      <link rel="stylesheet" href="../assets/stylesheets/main.26e3688c.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.eebd395e.min.css">
 
 
         <link rel="stylesheet" href="../assets/stylesheets/palette.ecc896b0.min.css">
@@ -290,11 +290,11 @@
 </li>
 
         <li class="md-nav__item">
-  <a href="#upstream-configuration" class="md-nav__link">
-    Upstream configuration
+  <a href="#upstreams-configuration" class="md-nav__link">
+    Upstreams configuration
   </a>
 
-    <nav class="md-nav" aria-label="Upstream configuration">
+    <nav class="md-nav" aria-label="Upstreams configuration">
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
@@ -720,11 +720,11 @@
 </li>
 
         <li class="md-nav__item">
-  <a href="#upstream-configuration" class="md-nav__link">
-    Upstream configuration
+  <a href="#upstreams-configuration" class="md-nav__link">
+    Upstreams configuration
   </a>
 
-    <nav class="md-nav" aria-label="Upstream configuration">
+    <nav class="md-nav" aria-label="Upstreams configuration">
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
@@ -1044,26 +1044,26 @@ <h1 id="configuration">Configuration</h1>
 <summary>reference configuration file</summary>
 <div class="highlight"><pre><span></span><code><span class="c1"># REVIEW: manual changelog entry</span>
 
-<span class="nt">upstream</span><span class="p">:</span>
-<span class="w">  </span><span class="c1"># these external DNS resolvers will be used. Blocky picks 2 random resolvers from the list for each query</span>
-<span class="w">  </span><span class="c1"># format for resolver: [net:]host:[port][/path]. net could be empty (default, shortcut for tcp+udp), tcp+udp, tcp, udp, tcp-tls or https (DoH). If port is empty, default port will be used (53 for udp and tcp, 853 for tcp-tls, 443 for https (Doh))</span>
-<span class="w">  </span><span class="c1"># this configuration is mandatory, please define at least one external DNS resolver</span>
-<span class="w">  </span><span class="nt">default</span><span class="p">:</span>
-<span class="w">    </span><span class="c1"># example for tcp+udp IPv4 server (https://digitalcourage.de/)</span>
-<span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">5.9.164.112</span>
-<span class="w">    </span><span class="c1"># Cloudflare</span>
-<span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1.1.1.1</span>
-<span class="w">    </span><span class="c1"># example for DNS-over-TLS server (DoT)</span>
-<span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">tcp-tls:fdns1.dismail.de:853</span>
-<span class="w">    </span><span class="c1"># example for DNS-over-HTTPS (DoH)</span>
-<span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://dns.digitale-gesellschaft.ch/dns-query</span>
-<span class="w">  </span><span class="c1"># optional: use client name (with wildcard support: * - sequence of any characters, [0-9] - range)</span>
-<span class="w">  </span><span class="c1"># or single ip address / client subnet as CIDR notation</span>
-<span class="w">  </span><span class="nt">laptop*</span><span class="p">:</span>
-<span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">123.123.123.123</span>
-
-<span class="c1"># optional: timeout to query the upstream resolver. Default: 2s</span>
-<span class="nt">upstreamTimeout</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">2s</span>
+<span class="nt">upstreams</span><span class="p">:</span>
+<span class="w">  </span><span class="nt">groups</span><span class="p">:</span>
+<span class="w">    </span><span class="c1"># these external DNS resolvers will be used. Blocky picks 2 random resolvers from the list for each query</span>
+<span class="w">    </span><span class="c1"># format for resolver: [net:]host:[port][/path]. net could be empty (default, shortcut for tcp+udp), tcp+udp, tcp, udp, tcp-tls or https (DoH). If port is empty, default port will be used (53 for udp and tcp, 853 for tcp-tls, 443 for https (Doh))</span>
+<span class="w">    </span><span class="c1"># this configuration is mandatory, please define at least one external DNS resolver</span>
+<span class="w">    </span><span class="nt">default</span><span class="p">:</span>
+<span class="w">      </span><span class="c1"># example for tcp+udp IPv4 server (https://digitalcourage.de/)</span>
+<span class="w">      </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">5.9.164.112</span>
+<span class="w">      </span><span class="c1"># Cloudflare</span>
+<span class="w">      </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1.1.1.1</span>
+<span class="w">      </span><span class="c1"># example for DNS-over-TLS server (DoT)</span>
+<span class="w">      </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">tcp-tls:fdns1.dismail.de:853</span>
+<span class="w">      </span><span class="c1"># example for DNS-over-HTTPS (DoH)</span>
+<span class="w">      </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://dns.digitale-gesellschaft.ch/dns-query</span>
+<span class="w">    </span><span class="c1"># optional: use client name (with wildcard support: * - sequence of any characters, [0-9] - range)</span>
+<span class="w">    </span><span class="c1"># or single ip address / client subnet as CIDR notation</span>
+<span class="w">    </span><span class="nt">laptop*</span><span class="p">:</span>
+<span class="w">      </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">123.123.123.123</span>
+<span class="w">  </span><span class="c1"># optional: timeout to query the upstream resolver. Default: 2s</span>
+<span class="w">  </span><span class="nt">timeout</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">2s</span>
 
 <span class="c1"># optional: If true, blocky will fail to start unless at least one upstream server per group is reachable. Default: false</span>
 <span class="nt">startVerifyUpstream</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
@@ -1526,7 +1526,7 @@ <h2 id="logging-configuration">Logging configuration</h2>
 <span class="w">  </span><span class="nt">privacy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
 </code></pre></div>
 </div>
-<h2 id="upstream-configuration">Upstream configuration</h2>
+<h2 id="upstreams-configuration">Upstreams configuration</h2>
 <p>To resolve a <abbr title="Domain Name System">DNS</abbr> query, blocky needs external public or private <abbr title="Domain Name System">DNS</abbr> resolvers. Blocky supports <abbr title="Domain Name System">DNS</abbr> resolvers with
 following network protocols (net part of the resolver URL):</p>
 <ul>
@@ -1588,37 +1588,39 @@ <h2 id="upstream-configuration">Upstream configuration</h2>
 </div>
 <div class="admonition example">
 <p class="admonition-title">Example</p>
-<div class="highlight"><pre><span></span><code><span class="nt">upstream</span><span class="p">:</span>
-<span class="w">  </span><span class="nt">default</span><span class="p">:</span>
-<span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">5.9.164.112</span>
-<span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1.1.1.1</span>
-<span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">tcp-tls:fdns1.dismail.de:853</span>
-<span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://dns.digitale-gesellschaft.ch/dns-query</span>
-<span class="w">  </span><span class="nt">laptop*</span><span class="p">:</span>
-<span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">123.123.123.123</span>
-<span class="w">  </span><span class="nt">10.43.8.67/28</span><span class="p">:</span>
-<span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1.1.1.1</span>
-<span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">9.9.9.9</span>
+<div class="highlight"><pre><span></span><code><span class="nt">upstreams</span><span class="p">:</span>
+<span class="w">  </span><span class="nt">groups</span><span class="p">:</span>
+<span class="w">    </span><span class="nt">default</span><span class="p">:</span>
+<span class="w">      </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">5.9.164.112</span>
+<span class="w">      </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1.1.1.1</span>
+<span class="w">      </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">tcp-tls:fdns1.dismail.de:853</span>
+<span class="w">      </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://dns.digitale-gesellschaft.ch/dns-query</span>
+<span class="w">    </span><span class="nt">laptop*</span><span class="p">:</span>
+<span class="w">      </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">123.123.123.123</span>
+<span class="w">    </span><span class="nt">10.43.8.67/28</span><span class="p">:</span>
+<span class="w">      </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1.1.1.1</span>
+<span class="w">      </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">9.9.9.9</span>
 </code></pre></div>
 </div>
 <p>Use <code>123.123.123.123</code> as single upstream <abbr title="Domain Name System">DNS</abbr> resolver for client laptop-home,
 <code>1.1.1.1</code> and <code>9.9.9.9</code> for all clients in the sub-net <code>10.43.8.67/28</code> and 4 resolvers (default) for all others clients.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
-<p><strong> Blocky needs at least one upstream <abbr title="Domain Name System">DNS</abbr> server </strong></p>
+<p>** Blocky needs at least one upstream <abbr title="Domain Name System">DNS</abbr> server **</p>
 </div>
 <p>See <a href="../additional_information/#list-of-public-dns-servers">List of public <abbr title="Domain Name System">DNS</abbr> servers</a> if you need some ideas, which
 public free <abbr title="Domain Name System">DNS</abbr> server you could use.</p>
 <h3 id="upstream-lookup-timeout">Upstream lookup timeout</h3>
 <p>Blocky will wait 2 seconds (default value) for the response from the external upstream <abbr title="Domain Name System">DNS</abbr> server. You can change this
-value by setting the <code>upstreamTimeout</code> configuration parameter (in <strong><abbr title="Example: &quot;300ms&quot;, &quot;1.5h&quot; or &quot;2h45m&quot;. Valid time units are &quot;ns&quot;, &quot;us&quot;, &quot;ms&quot;, &quot;s&quot;, &quot;m&quot;, &quot;h&quot;.">duration format</abbr></strong>).</p>
+value by setting the <code>timeout</code> configuration parameter (in <strong><abbr title="Example: &quot;300ms&quot;, &quot;1.5h&quot; or &quot;2h45m&quot;. Valid time units are &quot;ns&quot;, &quot;us&quot;, &quot;ms&quot;, &quot;s&quot;, &quot;m&quot;, &quot;h&quot;.">duration format</abbr></strong>).</p>
 <div class="admonition example">
 <p class="admonition-title">Example</p>
-<div class="highlight"><pre><span></span><code><span class="nt">upstream</span><span class="p">:</span>
-<span class="w">  </span><span class="nt">default</span><span class="p">:</span>
-<span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">46.182.19.48</span>
-<span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">80.241.218.68</span>
-<span class="nt">upstreamTimeout</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">5s</span>
+<div class="highlight"><pre><span></span><code><span class="nt">upstreams</span><span class="p">:</span>
+<span class="w">  </span><span class="nt">timeout</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">5s</span>
+<span class="w">  </span><span class="nt">groups</span><span class="p">:</span>
+<span class="w">    </span><span class="nt">default</span><span class="p">:</span>
+<span class="w">      </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">46.182.19.48</span>
+<span class="w">      </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">80.241.218.68</span>
 </code></pre></div>
 </div>
 <h2 id="bootstrap-dns-configuration">Bootstrap <abbr title="Domain Name System">DNS</abbr> configuration</h2>
@@ -2440,8 +2442,8 @@ <h3 id="sources-loading">Sources Loading</h3>
 </code></pre></div>
 </div>
 <h4 id="refresh-reload">Refresh / Reload</h4>
-<p>To keep source contents up-to-date, blocky can periodically refresh and reparse them. Default period is <strong>
-4 hours</strong>. You can configure this by setting the <code>refreshPeriod</code> parameter to a value in <strong><abbr title="Example: &quot;300ms&quot;, &quot;1.5h&quot; or &quot;2h45m&quot;. Valid time units are &quot;ns&quot;, &quot;us&quot;, &quot;ms&quot;, &quot;s&quot;, &quot;m&quot;, &quot;h&quot;.">duration format</abbr></strong>.<br />
+<p>To keep source contents up-to-date, blocky can periodically refresh and reparse them. Default period is **
+4 hours<strong>. You can configure this by setting the <code>refreshPeriod</code> parameter to a value in </strong><abbr title="Example: &quot;300ms&quot;, &quot;1.5h&quot; or &quot;2h45m&quot;. Valid time units are &quot;ns&quot;, &quot;us&quot;, &quot;ms&quot;, &quot;s&quot;, &quot;m&quot;, &quot;h&quot;.">duration format</abbr>**.<br />
 A value of zero or less will disable this feature.</p>
 <div class="admonition example">
 <p class="admonition-title">Example</p>

diff --git a/main/includes/abbreviations/index.html b/main/includes/abbreviations/index.html
@@ -13,15 +13,15 @@
 
 
       <link rel="icon" href="../../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.18">
+      <meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.1.21">
 
 
 
         <title>Abbreviations - blocky</title>
 
 
 
-      <link rel="stylesheet" href="../../assets/stylesheets/main.26e3688c.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.eebd395e.min.css">
 
 
         <link rel="stylesheet" href="../../assets/stylesheets/palette.ecc896b0.min.css">

diff --git a/main/index.html b/main/index.html
@@ -15,15 +15,15 @@
         <link rel="next" href="configuration/">
 
       <link rel="icon" href="assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.18">
+      <meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.1.21">
 
 
 
         <title>blocky</title>
 
 
 
-      <link rel="stylesheet" href="assets/stylesheets/main.26e3688c.min.css">
+      <link rel="stylesheet" href="assets/stylesheets/main.eebd395e.min.css">
 
 
         <link rel="stylesheet" href="assets/stylesheets/palette.ecc896b0.min.css">