blocky/installation/index.html

873 lines
34 KiB
HTML

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="blocky Documentation">
<link rel="prev" href="../configuration/">
<link rel="next" href="../prometheus_grafana/">
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.1">
<title>Installation - blocky</title>
<link rel="stylesheet" href="../assets/stylesheets/main.402914a4.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.a0c5b2b5.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="teal">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#installation" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href=".." title="blocky" class="md-header__button md-logo" aria-label="blocky" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
blocky
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Installation
</span>
</div>
</div>
</div>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://github.com/0xERR0R/blocky" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
GitHub
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href=".." title="blocky" class="md-nav__button md-logo" aria-label="blocky" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
</a>
blocky
</label>
<div class="md-nav__source">
<a href="https://github.com/0xERR0R/blocky" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
GitHub
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href=".." class="md-nav__link">
Welcome
</a>
</li>
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
Configuration
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
Installation
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
Installation
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#prepare-your-configuration" class="md-nav__link">
Prepare your configuration
</a>
</li>
<li class="md-nav__item">
<a href="#run-as-standalone-binary" class="md-nav__link">
Run as standalone binary
</a>
</li>
<li class="md-nav__item">
<a href="#run-with-docker" class="md-nav__link">
Run with docker
</a>
<nav class="md-nav" aria-label="Run with docker">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#alternative-registry" class="md-nav__link">
Alternative registry
</a>
</li>
<li class="md-nav__item">
<a href="#parameters" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#docker-from-command-line" class="md-nav__link">
Docker from command line
</a>
</li>
<li class="md-nav__item">
<a href="#run-with-docker-compose" class="md-nav__link">
Run with docker-compose
</a>
</li>
<li class="md-nav__item">
<a href="#advanced-setup" class="md-nav__link">
Advanced setup
</a>
<nav class="md-nav" aria-label="Advanced setup">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#multiple-configuration-files" class="md-nav__link">
Multiple configuration files
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#other-installation-types" class="md-nav__link">
Other installation types
</a>
<nav class="md-nav" aria-label="Other installation types">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#web-ui" class="md-nav__link">
Web UI
</a>
</li>
<li class="md-nav__item">
<a href="#run-with-helm-chart-on-kubernetes" class="md-nav__link">
Run with helm chart on Kubernetes
</a>
</li>
<li class="md-nav__item">
<a href="#run-as-an-app-for-truenas-scale" class="md-nav__link">
Run as an App for TrueNAS SCALE
</a>
</li>
<li class="md-nav__item">
<a href="#aur-package-for-arch-linux" class="md-nav__link">
AUR package for Arch Linux
</a>
</li>
<li class="md-nav__item">
<a href="#package-for-alpine-linux" class="md-nav__link">
Package for Alpine Linux
</a>
</li>
<li class="md-nav__item">
<a href="#installation-script-for-centosfedora" class="md-nav__link">
Installation script for CentOS/Fedora
</a>
</li>
<li class="md-nav__item">
<a href="#package-for-freebsd" class="md-nav__link">
Package for FreeBSD
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../prometheus_grafana/" class="md-nav__link">
Prometheus / Grafana
</a>
</li>
<li class="md-nav__item">
<a href="../interfaces/" class="md-nav__link">
Interfaces
</a>
</li>
<li class="md-nav__item">
<a href="../network_configuration/" class="md-nav__link">
Network configuration
</a>
</li>
<li class="md-nav__item">
<a href="../additional_information/" class="md-nav__link">
Additional information
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#prepare-your-configuration" class="md-nav__link">
Prepare your configuration
</a>
</li>
<li class="md-nav__item">
<a href="#run-as-standalone-binary" class="md-nav__link">
Run as standalone binary
</a>
</li>
<li class="md-nav__item">
<a href="#run-with-docker" class="md-nav__link">
Run with docker
</a>
<nav class="md-nav" aria-label="Run with docker">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#alternative-registry" class="md-nav__link">
Alternative registry
</a>
</li>
<li class="md-nav__item">
<a href="#parameters" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#docker-from-command-line" class="md-nav__link">
Docker from command line
</a>
</li>
<li class="md-nav__item">
<a href="#run-with-docker-compose" class="md-nav__link">
Run with docker-compose
</a>
</li>
<li class="md-nav__item">
<a href="#advanced-setup" class="md-nav__link">
Advanced setup
</a>
<nav class="md-nav" aria-label="Advanced setup">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#multiple-configuration-files" class="md-nav__link">
Multiple configuration files
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#other-installation-types" class="md-nav__link">
Other installation types
</a>
<nav class="md-nav" aria-label="Other installation types">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#web-ui" class="md-nav__link">
Web UI
</a>
</li>
<li class="md-nav__item">
<a href="#run-with-helm-chart-on-kubernetes" class="md-nav__link">
Run with helm chart on Kubernetes
</a>
</li>
<li class="md-nav__item">
<a href="#run-as-an-app-for-truenas-scale" class="md-nav__link">
Run as an App for TrueNAS SCALE
</a>
</li>
<li class="md-nav__item">
<a href="#aur-package-for-arch-linux" class="md-nav__link">
AUR package for Arch Linux
</a>
</li>
<li class="md-nav__item">
<a href="#package-for-alpine-linux" class="md-nav__link">
Package for Alpine Linux
</a>
</li>
<li class="md-nav__item">
<a href="#installation-script-for-centosfedora" class="md-nav__link">
Installation script for CentOS/Fedora
</a>
</li>
<li class="md-nav__item">
<a href="#package-for-freebsd" class="md-nav__link">
Package for FreeBSD
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="installation">Installation</h1>
<p>You can choose one of the following installation options:</p>
<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>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>
<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="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="nt">blocking</span><span class="p">:</span>
<span class="w"> </span><span class="nt">blackLists</span><span class="p">:</span>
<span class="w"> </span><span class="nt">ads</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">https://raw.githubusercontent.com/StevenBlack/hosts/master/hosts</span>
<span class="w"> </span><span class="nt">clientGroupsBlock</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">ads</span>
<span class="nt">port</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">53</span>
<span class="nt">httpPort</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">4000</span>
</code></pre></div>
<h2 id="run-as-standalone-binary">Run as standalone binary</h2>
<p>Download the binary file from <a href="https://github.com/0xERR0R/blocky/releases">GitHub</a> for your architecture and
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>
</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>
<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>
<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
</code></pre></div>
<h3 id="run-with-docker-compose">Run with docker-compose</h3>
<p>Create following <code>docker-compose.yml</code> file</p>
<div class="highlight"><pre><span></span><code><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;2.1&quot;</span>
<span class="nt">services</span><span class="p">:</span>
<span class="w"> </span><span class="nt">blocky</span><span class="p">:</span>
<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">spx01/blocky</span>
<span class="w"> </span><span class="nt">container_name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">blocky</span>
<span class="w"> </span><span class="nt">restart</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">unless-stopped</span>
<span class="w"> </span><span class="c1"># Optional the instance hostname for logging purpose</span>
<span class="w"> </span><span class="nt">hostname</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">blocky-hostname</span>
<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="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="c1"># Optional to synchronize the log timestamp with host</span>
<span class="w"> </span><span class="nt">volumes</span><span class="p">:</span>
<span class="w"> </span><span class="c1"># Optional to synchronize the log timestamp with host</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/localtime:/etc/localtime:ro</span>
<span class="w"> </span><span class="c1"># config file</span>
<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
</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
whitelists directories are mounted as volume. You can create own black or whitelists in these directories and define the
path like '/app/whitelists/whitelist.txt' in the config file.</p>
<div class="admonition example">
<p class="admonition-title">Example</p>
</div>
<div class="highlight"><pre><span></span><code><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;2.1&quot;</span>
<span class="nt">services</span><span class="p">:</span>
<span class="w"> </span><span class="nt">blocky</span><span class="p">:</span>
<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">spx01/blocky</span>
<span class="w"> </span><span class="nt">container_name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">blocky</span>
<span class="w"> </span><span class="nt">restart</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">unless-stopped</span>
<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="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>
<span class="w"> </span><span class="c1"># config file</span>
<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>
<span class="w"> </span><span class="c1"># write query logs in this volume</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">queryLogs:/logs</span>
<span class="w"> </span><span class="c1"># put your custom white and blacklists in these directories</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">./blacklists:/app/blacklists/</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">./whitelists:/app/whitelists/</span>
<span class="nt">volumes</span><span class="p">:</span>
<span class="w"> </span><span class="nt">queryLogs</span><span class="p">:</span>
<span class="w"> </span><span class="nt">driver</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">local</span>
<span class="w"> </span><span class="nt">driver_opts</span><span class="p">:</span>
<span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">cifs</span>
<span class="w"> </span><span class="nt">o</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">username=USER,password=PASSWORD,rw</span>
<span class="w"> </span><span class="nt">device</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">//NAS_HOSTNAME/blocky</span><span class="w"> </span>
</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="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>
</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>
</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>
<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>
<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>
<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>
<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>
</article>
</div>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
<div class="md-social">
<a href="https://github.com/0xERR0R/blocky" target="_blank" rel="noopener" title="github.com" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg>
</a>
<a href="https://hub.docker.com/r/spx01/blocky" target="_blank" rel="noopener" title="hub.docker.com" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M349.9 236.3h-66.1v-59.4h66.1v59.4zm0-204.3h-66.1v60.7h66.1V32zm78.2 144.8H362v59.4h66.1v-59.4zm-156.3-72.1h-66.1v60.1h66.1v-60.1zm78.1 0h-66.1v60.1h66.1v-60.1zm276.8 100c-14.4-9.7-47.6-13.2-73.1-8.4-3.3-24-16.7-44.9-41.1-63.7l-14-9.3-9.3 14c-18.4 27.8-23.4 73.6-3.7 103.8-8.7 4.7-25.8 11.1-48.4 10.7H2.4c-8.7 50.8 5.8 116.8 44 162.1 37.1 43.9 92.7 66.2 165.4 66.2 157.4 0 273.9-72.5 328.4-204.2 21.4.4 67.6.1 91.3-45.2 1.5-2.5 6.6-13.2 8.5-17.1l-13.3-8.9zm-511.1-27.9h-66v59.4h66.1v-59.4zm78.1 0h-66.1v59.4h66.1v-59.4zm78.1 0h-66.1v59.4h66.1v-59.4zm-78.1-72.1h-66.1v60.1h66.1v-60.1z"/></svg>
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "..", "features": [], "search": "../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
<script src="../assets/javascripts/bundle.b78d2936.min.js"></script>
</body>
</html>