Deployed f5bd69c to main with MkDocs 1.5.3 and mike 2.0.0

This commit is contained in:
github-actions[bot] 2024-03-18 16:45:24 +00:00
parent dbddf9418d
commit e6b3f4828b
3 changed files with 237 additions and 177 deletions

View File

@ -417,6 +417,102 @@
<nav class="md-nav" aria-label="Other installation types">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#arch-linux-via-aur" class="md-nav__link">
<span class="md-ellipsis">
Arch Linux via AUR
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#alpine-linux" class="md-nav__link">
<span class="md-ellipsis">
Alpine Linux
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#centosdebianfedora-install-script" class="md-nav__link">
<span class="md-ellipsis">
CentOS/Debian/Fedora install script
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#freebsd" class="md-nav__link">
<span class="md-ellipsis">
FreeBSD
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#gentoo" class="md-nav__link">
<span class="md-ellipsis">
Gentoo
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#nixos" class="md-nav__link">
<span class="md-ellipsis">
NixOS
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#macos-via-homebrew" class="md-nav__link">
<span class="md-ellipsis">
macOS via Homebrew
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#truenas-scale-via-truecharts" class="md-nav__link">
<span class="md-ellipsis">
TrueNAS SCALE via TrueCharts
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#companion-projects" class="md-nav__link">
<span class="md-ellipsis">
Companion projects
</span>
</a>
<nav class="md-nav" aria-label="Companion projects">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#lists-updater" class="md-nav__link">
<span class="md-ellipsis">
Lists updater
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#web-ui" class="md-nav__link">
<span class="md-ellipsis">
@ -424,78 +520,6 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#run-with-helm-chart-on-kubernetes" class="md-nav__link">
<span class="md-ellipsis">
Run with helm chart on Kubernetes
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#run-as-an-app-for-truenas-scale" class="md-nav__link">
<span class="md-ellipsis">
Run as an App for TrueNAS SCALE
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#aur-package-for-arch-linux" class="md-nav__link">
<span class="md-ellipsis">
AUR package for Arch Linux
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#package-for-alpine-linux" class="md-nav__link">
<span class="md-ellipsis">
Package for Alpine Linux
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#installation-script-for-centosfedora" class="md-nav__link">
<span class="md-ellipsis">
Installation script for CentOS/Fedora
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#package-for-freebsd" class="md-nav__link">
<span class="md-ellipsis">
Package for FreeBSD
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#package-for-gentoo" class="md-nav__link">
<span class="md-ellipsis">
Package for Gentoo
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#homebrew-package-for-macos" class="md-nav__link">
<span class="md-ellipsis">
Homebrew package for MacOS
</span>
</a>
</li>
</ul>
@ -720,6 +744,102 @@
<nav class="md-nav" aria-label="Other installation types">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#arch-linux-via-aur" class="md-nav__link">
<span class="md-ellipsis">
Arch Linux via AUR
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#alpine-linux" class="md-nav__link">
<span class="md-ellipsis">
Alpine Linux
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#centosdebianfedora-install-script" class="md-nav__link">
<span class="md-ellipsis">
CentOS/Debian/Fedora install script
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#freebsd" class="md-nav__link">
<span class="md-ellipsis">
FreeBSD
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#gentoo" class="md-nav__link">
<span class="md-ellipsis">
Gentoo
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#nixos" class="md-nav__link">
<span class="md-ellipsis">
NixOS
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#macos-via-homebrew" class="md-nav__link">
<span class="md-ellipsis">
macOS via Homebrew
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#truenas-scale-via-truecharts" class="md-nav__link">
<span class="md-ellipsis">
TrueNAS SCALE via TrueCharts
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#companion-projects" class="md-nav__link">
<span class="md-ellipsis">
Companion projects
</span>
</a>
<nav class="md-nav" aria-label="Companion projects">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#lists-updater" class="md-nav__link">
<span class="md-ellipsis">
Lists updater
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#web-ui" class="md-nav__link">
<span class="md-ellipsis">
@ -727,78 +847,6 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#run-with-helm-chart-on-kubernetes" class="md-nav__link">
<span class="md-ellipsis">
Run with helm chart on Kubernetes
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#run-as-an-app-for-truenas-scale" class="md-nav__link">
<span class="md-ellipsis">
Run as an App for TrueNAS SCALE
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#aur-package-for-arch-linux" class="md-nav__link">
<span class="md-ellipsis">
AUR package for Arch Linux
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#package-for-alpine-linux" class="md-nav__link">
<span class="md-ellipsis">
Package for Alpine Linux
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#installation-script-for-centosfedora" class="md-nav__link">
<span class="md-ellipsis">
Installation script for CentOS/Fedora
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#package-for-freebsd" class="md-nav__link">
<span class="md-ellipsis">
Package for FreeBSD
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#package-for-gentoo" class="md-nav__link">
<span class="md-ellipsis">
Package for Gentoo
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#homebrew-package-for-macos" class="md-nav__link">
<span class="md-ellipsis">
Homebrew package for MacOS
</span>
</a>
</li>
</ul>
@ -829,11 +877,10 @@
<ul>
<li>Run as standalone binary</li>
<li>Run as docker container</li>
<li>Kubernetes with helm chart</li>
</ul>
<h2 id="prepare-your-configuration">Prepare your configuration</h2>
<p>Blocky supports single or multiple <abbr title="YAML Ain't Markup Language">YAML</abbr> files as configuration. Create new <code>config.yaml</code> with your configuration (
see <a href="../configuration/">Configuration</a> for more details and all configuration options).</p>
<p>Blocky supports single or multiple <abbr title="YAML Ain't Markup Language">YAML</abbr> files as configuration. Create new <code>config.yml</code> with your configuration
(see <a href="../configuration/">Configuration</a> for more details and all configuration options).</p>
<p>Simple configuration file, which enables only basic features:</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>
@ -857,19 +904,18 @@ see <a href="../configuration/">Configuration</a> for more details and all confi
run <code>./blocky --config config.yml</code>.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Please be aware, if you want to use port 53 or 953 on Linux you should add CAP_NET_BIND_SERVICE capability
to the binary or run with root privileges (running as root is not recommended).</p>
<p>Please be aware, if you want to use port 53 or 953 on Linux you should add <code>CAP_NET_BIND_SERVICE</code> capability
to the binary with <code>setcap 'cap_net_bind_service=+ep' ./blocky</code>, or run as root (not recommended).</p>
</div>
<h2 id="run-with-docker">Run with docker</h2>
<h3 id="alternative-registry">Alternative registry</h3>
<p>Blocky docker images are deployed to DockerHub (<code>spx01/blocky</code>) and GitHub Container Registry (<code>ghcr.io/0xerr0r/blocky</code>)
.</p>
<p>Blocky docker images are deployed to DockerHub (<code>spx01/blocky</code>) and GitHub Container Registry (<code>ghcr.io/0xerr0r/blocky</code>).</p>
<h3 id="parameters">Parameters</h3>
<p>You can define the location of the config file in the container with environment variable "BLOCKY_CONFIG_FILE".
Default value is "/app/config.yml".</p>
<p>You can define the location of the config file in the container with environment variable <code>BLOCKY_CONFIG_FILE</code>.
Default value is <code>/app/config.yml</code>.</p>
<h3 id="docker-from-command-line">Docker from command line</h3>
<p>Execute following command from the command line:</p>
<div class="highlight"><pre><span></span><code>docker run --name blocky -v /path/to/config.yml:/app/config.yml -p 4000:4000 -p 53:53/udp spx01/blocky
<div class="highlight"><pre><span></span><code>docker<span class="w"> </span>run<span class="w"> </span>--name<span class="w"> </span>blocky<span class="w"> </span>-v<span class="w"> </span>/path/to/config.yml:/app/config.yml<span class="w"> </span>-p<span class="w"> </span><span class="m">4000</span>:4000<span class="w"> </span>-p<span class="w"> </span><span class="m">53</span>:53/udp<span class="w"> </span>spx01/blocky
</code></pre></div>
<h3 id="run-with-docker-compose">Run with docker-compose</h3>
<p>Create following <code>docker-compose.yml</code> file</p>
@ -894,7 +940,7 @@ Default value is "/app/config.yml".</p>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">./config.yml:/app/config.yml</span>
</code></pre></div>
<p>and start docker container with</p>
<div class="highlight"><pre><span></span><code>docker-compose up -d
<div class="highlight"><pre><span></span><code>docker-compose<span class="w"> </span>up<span class="w"> </span>-d
</code></pre></div>
<h3 id="advanced-setup">Advanced setup</h3>
<p>Following example shows, how to run blocky in a docker container and store query logs on a <abbr title="Server Message Block Protocol (Windows Network File System)">SAMBA</abbr> share. Local black and
@ -912,7 +958,7 @@ path like '/app/whitelists/whitelist.txt' in the config file.</p>
<span class="w"> </span><span class="nt">ports</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&quot;53:53/tcp&quot;</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&quot;53:53/udp&quot;</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&quot;4000:4000/tcp&quot;</span><span class="w"> </span><span class="c1"># Prometheus stats (if enabled).</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&quot;4000:4000/tcp&quot;</span><span class="w"> </span><span class="c1"># Prometheus stats (if enabled)</span>
<span class="w"> </span><span class="nt">environment</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">TZ=Europe/Berlin</span>
<span class="w"> </span><span class="nt">volumes</span><span class="p">:</span>
@ -934,38 +980,52 @@ path like '/app/whitelists/whitelist.txt' in the config file.</p>
</code></pre></div>
<h4 id="multiple-configuration-files">Multiple configuration files</h4>
<p>For complex setups, splitting the configuration between multiple <abbr title="YAML Ain't Markup Language">YAML</abbr> files might be desired. In this case, folder containing <abbr title="YAML Ain't Markup Language">YAML</abbr> files is passed on startup, Blocky will join all the files.</p>
<p><code>./blocky --config ./config/</code></p>
<div class="highlight"><pre><span></span><code>./blocky<span class="w"> </span>--config<span class="w"> </span>./config/
</code></pre></div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Blocky simply joins the multiple <abbr title="YAML Ain't Markup Language">YAML</abbr> files. If a directive (e.g. <code>upstream</code>) is repeated in multiple files, the configuration will not load and start will fail.</p>
<p>Blocky simply joins the multiple <abbr title="YAML Ain't Markup Language">YAML</abbr> files. If an option (e.g. <code>upstream</code>) is present in multiple files, the configuration will not load and start will fail.</p>
</div>
<h2 id="other-installation-types">Other installation types</h2>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>These projects are maintained by other people.</p>
<p>These projects are not associated with Blocky devs and are listed here for convenience.</p>
</div>
<h3 id="web-ui">Web UI</h3>
<p><a href="https://github.com/Mozart409/blocky-frontend">Blocky Frontend</a> provides a Web UI to control blocky. See linked project for installation instructions.</p>
<h3 id="run-with-helm-chart-on-kubernetes">Run with helm chart on Kubernetes</h3>
<p>See <a href="https://github.com/truecharts/charts/tree/master/charts/enterprise/blocky">this repo</a>,
the <a href="https://truecharts.org/docs/charts/enterprise/blocky/">documentation</a>
and <a href="https://truecharts.org/docs/charts/enterprise/blocky/installation-notes">the configuration instructions</a> for details about running blocky via helm in kubernetes.</p>
<h3 id="run-as-an-app-for-truenas-scale">Run as an App for TrueNAS SCALE</h3>
<p>You can find the App in the TrueCharts <a href="https://truecharts.org/docs/manual/SCALE%20Apps/Adding-TrueCharts">App Catalog</a>
or read the <a href="https://truecharts.org/docs/charts/enterprise/blocky/">documentation</a>
and <a href="https://truecharts.org/docs/charts/enterprise/blocky/installation-notes"> configuration instructions</a> for details about running blocky as a native TrueNAS SCALE App.</p>
<h3 id="aur-package-for-arch-linux">AUR package for Arch Linux</h3>
<h3 id="arch-linux-via-aur">Arch Linux via AUR</h3>
<p>See <a href="https://aur.archlinux.org/packages/blocky/">https://aur.archlinux.org/packages/blocky/</a></p>
<h3 id="package-for-alpine-linux">Package for Alpine Linux</h3>
<h3 id="alpine-linux">Alpine Linux</h3>
<p>See <a href="https://pkgs.alpinelinux.org/package/edge/testing/x86/blocky">https://pkgs.alpinelinux.org/package/edge/testing/x86/blocky</a></p>
<h3 id="installation-script-for-centosfedora">Installation script for CentOS/Fedora</h3>
<h3 id="centosdebianfedora-install-script">CentOS/Debian/Fedora install script</h3>
<p>See <a href="https://github.com/m0zgen/blocky-installer">https://github.com/m0zgen/blocky-installer</a></p>
<h3 id="package-for-freebsd">Package for FreeBSD</h3>
<h3 id="freebsd">FreeBSD</h3>
<p>See <a href="https://www.freebsd.org/cgi/ports.cgi?query=blocky&amp;stype=all">https://www.freebsd.org/cgi/ports.cgi?query=blocky&amp;stype=all</a></p>
<h3 id="package-for-gentoo">Package for Gentoo</h3>
<p>See <a href="https://wiki.gentoo.org/wiki/Project:GURU/Information_for_End_Users">Gentoo wiki page</a> to enable GURU repository then run <code>emerge net-dns/blocky</code></p>
<h3 id="homebrew-package-for-macos">Homebrew package for MacOS</h3>
<h3 id="gentoo">Gentoo</h3>
<p>See the <a href="https://wiki.gentoo.org/wiki/Project:GURU/Information_for_End_Users">Gentoo Wiki</a> to enable the GURU repository, then run <code>emerge net-dns/blocky</code>.</p>
<h3 id="nixos">NixOS</h3>
<p>As <code>pkgs.blocky</code> and a module:</p>
<div class="highlight"><pre><span></span><code>services<span class="o">.</span><span class="ss">blocky</span> <span class="o">=</span> <span class="p">{</span>
<span class="ss">enable</span> <span class="o">=</span> <span class="no">true</span><span class="p">;</span>
<span class="ss">settings</span> <span class="o">=</span> <span class="p">{</span>
<span class="c1"># anything from config.yml</span>
<span class="p">};</span>
<span class="p">};</span>
</code></pre></div>
<h3 id="macos-via-homebrew">macOS via Homebrew</h3>
<p>See <a href="https://formulae.brew.sh/formula/blocky">https://formulae.brew.sh/formula/blocky</a></p>
<h3 id="truenas-scale-via-truecharts">TrueNAS SCALE via TrueCharts</h3>
<p>See <a href="https://truecharts.org/charts/enterprise/blocky/">https://truecharts.org/charts/enterprise/blocky/</a><br />
(TrueCharts is not an official TrueNAS project)</p>
<h2 id="companion-projects">Companion projects</h2>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>These projects are not associated with Blocky devs and are listed here for convenience.</p>
</div>
<h3 id="lists-updater">Lists updater</h3>
<p><a href="https://github.com/shizunge/blocky-lists-updater">Blocky lists updater</a> updates list related configuration without restarting blocky <abbr title="Domain Name System">DNS</abbr>.</p>
<h3 id="web-ui">Web UI</h3>
<p><a href="https://github.com/Mozart409/blocky-frontend">Blocky Frontend</a> provides a Web UI to control blocky.
See linked project for installation instructions.</p>

File diff suppressed because one or more lines are too long

Binary file not shown.