theis.gaedigk/wg-easy-ca-lose
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Deployed e93342e to development with MkDocs 1.6.1 and mike 2.1.3

Browse Source
This commit is contained in:
github-actions[bot]
2025-06-11 09:12:59 +00:00
parent 43fb3e389b
commit c324cb2222
37 changed files with 17490 additions and 1084 deletions
Download Patch File Download Diff File Expand all files Collapse all files
development/advanced/api/index.html
+500 -42
View File
@@ -22,7 +22,7 @@
<link rel="icon" href="../../assets/logo/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.8">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
@@ -30,7 +30,7 @@
<link rel="stylesheet" href="../../assets/stylesheets/main.8608ea7d.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/main.342714a4.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
@@ -77,6 +77,11 @@
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#authentication" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
@@ -148,11 +153,13 @@
<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.52 6.52 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 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<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.52 6.52 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 5"/></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">
@@ -184,6 +191,7 @@
</div>
</div>
</div>
<div class="md-header__source">
@@ -216,10 +224,12 @@
<li class="md-tabs__item">
<a href="../.." class="md-tabs__link">
Home
@@ -233,10 +243,31 @@
<li class="md-tabs__item">
<a href="../../faq/" class="md-tabs__link">
FAQ
</a>
</li>
<li class="md-tabs__item">
<a href="../../getting-started/" class="md-tabs__link">
Getting Started
@@ -249,6 +280,7 @@
@@ -258,6 +290,7 @@
<a href="./" class="md-tabs__link">
Advanced
</a>
@@ -270,12 +303,14 @@
<li class="md-tabs__item">
<a href="../../contributing/general/" class="md-tabs__link">
Contributing
</a>
@@ -288,18 +323,21 @@
<li class="md-tabs__item">
<a href="../../examples/tutorials/adguard/" class="md-tabs__link">
Examples
</a>
@@ -311,6 +349,26 @@
<li class="md-tabs__item">
<a href="../../guides/2fa/" class="md-tabs__link">
Guides
</a>
</li>
</ul>
</div>
</nav>
@@ -365,6 +423,7 @@
<a href="../.." class="md-nav__link">
<span class="md-ellipsis">
Home
@@ -382,10 +441,33 @@
<li class="md-nav__item">
<a href="../../faq/" class="md-nav__link">
<span class="md-ellipsis">
FAQ
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../getting-started/" class="md-nav__link">
<span class="md-ellipsis">
Getting Started
@@ -408,6 +490,7 @@
@@ -419,12 +502,13 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
<span class="md-ellipsis">
Advanced
@@ -434,8 +518,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Advanced
</label>
@@ -455,9 +539,23 @@
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
API
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
API
@@ -466,6 +564,71 @@
</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="#authentication" class="md-nav__link">
<span class="md-ellipsis">
Authentication
</span>
</a>
<nav class="md-nav" aria-label="Authentication">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#authentication-example" class="md-nav__link">
<span class="md-ellipsis">
Authentication Example
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#endpoints" class="md-nav__link">
<span class="md-ellipsis">
Endpoints
</span>
</a>
<nav class="md-nav" aria-label="Endpoints">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#endpoints-example" class="md-nav__link">
<span class="md-ellipsis">
Endpoints Example
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
@@ -480,6 +643,7 @@
@@ -490,12 +654,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4_2" >
<label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
<label class="md-nav__link" for="__nav_4_2" id="__nav_4_2_label" tabindex="0">
<span class="md-ellipsis">
Config
@@ -505,8 +670,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_2">
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_2">
<span class="md-nav__icon md-icon"></span>
Config
</label>
@@ -522,6 +687,7 @@
<a href="../config/optional-config/" class="md-nav__link">
<span class="md-ellipsis">
Optional Configuration
@@ -544,6 +710,7 @@
<a href="../config/unattended-setup/" class="md-nav__link">
<span class="md-ellipsis">
Unattended Setup
@@ -573,6 +740,7 @@
@@ -583,12 +751,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_3" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4_3" >
<label class="md-nav__link" for="__nav_3_3" id="__nav_3_3_label" tabindex="0">
<label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
<span class="md-ellipsis">
Metrics
@@ -598,8 +767,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_3">
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_3">
<span class="md-nav__icon md-icon"></span>
Metrics
</label>
@@ -615,6 +784,7 @@
<a href="../metrics/prometheus/" class="md-nav__link">
<span class="md-ellipsis">
Prometheus
@@ -644,6 +814,7 @@
@@ -654,12 +825,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_4" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4_4" >
<label class="md-nav__link" for="__nav_3_4" id="__nav_3_4_label" tabindex="0">
<label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
<span class="md-ellipsis">
Migrate
@@ -669,8 +841,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_4">
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_4">
<span class="md-nav__icon md-icon"></span>
Migrate
</label>
@@ -686,6 +858,7 @@
<a href="../migrate/" class="md-nav__link">
<span class="md-ellipsis">
Migrate
@@ -708,6 +881,7 @@
<a href="../migrate/from-14-to-15/" class="md-nav__link">
<span class="md-ellipsis">
Migrate from v14 to v15
@@ -744,6 +918,7 @@
@@ -754,12 +929,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<span class="md-ellipsis">
Contributing
@@ -769,8 +945,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Contributing
</label>
@@ -786,6 +962,7 @@
<a href="../../contributing/general/" class="md-nav__link">
<span class="md-ellipsis">
General Information
@@ -808,6 +985,7 @@
<a href="../../contributing/issues-and-pull-requests/" class="md-nav__link">
<span class="md-ellipsis">
Issues and Pull Requests
@@ -836,6 +1014,7 @@
@@ -846,12 +1025,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<span class="md-ellipsis">
Examples
@@ -861,8 +1041,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Examples
</label>
@@ -877,6 +1057,7 @@
@@ -887,12 +1068,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5_1" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
<label class="md-nav__link" for="__nav_5_1" id="__nav_5_1_label" tabindex="0">
<label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
<span class="md-ellipsis">
Tutorials
@@ -902,8 +1084,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5_1">
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6_1">
<span class="md-nav__icon md-icon"></span>
Tutorials
</label>
@@ -919,6 +1101,7 @@
<a href="../../examples/tutorials/adguard/" class="md-nav__link">
<span class="md-ellipsis">
AdGuard Home
@@ -941,6 +1124,7 @@
<a href="../../examples/tutorials/auto-updates/" class="md-nav__link">
<span class="md-ellipsis">
Auto Updates
@@ -963,6 +1147,7 @@
<a href="../../examples/tutorials/basic-installation/" class="md-nav__link">
<span class="md-ellipsis">
Basic Installation
@@ -985,6 +1170,7 @@
<a href="../../examples/tutorials/caddy/" class="md-nav__link">
<span class="md-ellipsis">
Caddy
@@ -1007,6 +1193,7 @@
<a href="../../examples/tutorials/docker-run/" class="md-nav__link">
<span class="md-ellipsis">
Docker Run
@@ -1029,6 +1216,7 @@
<a href="../../examples/tutorials/dockerless/" class="md-nav__link">
<span class="md-ellipsis">
Without Docker
@@ -1048,11 +1236,12 @@
<li class="md-nav__item">
<a href="../../examples/tutorials/nginx/" class="md-nav__link">
<a href="../../examples/tutorials/podman-nft/" class="md-nav__link">
<span class="md-ellipsis">
NGINX
Podman + nftables
</span>
@@ -1070,11 +1259,12 @@
<li class="md-nav__item">
<a href="../../examples/tutorials/podman/" class="md-nav__link">
<a href="../../examples/tutorials/reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis">
Podman
No Reverse Proxy
</span>
@@ -1095,6 +1285,7 @@
<a href="../../examples/tutorials/traefik/" class="md-nav__link">
<span class="md-ellipsis">
Traefik
@@ -1122,6 +1313,171 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
<span class="md-ellipsis">
Guides
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
Guides
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../guides/2fa/" class="md-nav__link">
<span class="md-ellipsis">
2FA
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../guides/admin/" class="md-nav__link">
<span class="md-ellipsis">
Admin Panel
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../guides/cli/" class="md-nav__link">
<span class="md-ellipsis">
CLI
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../guides/clients/" class="md-nav__link">
<span class="md-ellipsis">
Edit Client
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../guides/setup/" class="md-nav__link">
<span class="md-ellipsis">
Setup
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
@@ -1140,6 +1496,62 @@
<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="#authentication" class="md-nav__link">
<span class="md-ellipsis">
Authentication
</span>
</a>
<nav class="md-nav" aria-label="Authentication">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#authentication-example" class="md-nav__link">
<span class="md-ellipsis">
Authentication Example
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#endpoints" class="md-nav__link">
<span class="md-ellipsis">
Endpoints
</span>
</a>
<nav class="md-nav" aria-label="Endpoints">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#endpoints-example" class="md-nav__link">
<span class="md-ellipsis">
Endpoints Example
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
@@ -1172,7 +1584,51 @@
<h1>API</h1>
<p>TODO</p>
<div class="admonition warning">
<p class="admonition-title">Breaking Changes</p>
<p>This API is not yet stable and may change in the future. The API is currently in development and is subject to change without notice. The API is not yet documented, but we will add documentation as the API stabilizes.</p>
</div>
<p>You can use the API to interact with the application programmatically. The API is available at <code>/api</code> and supports both GET and POST requests. The API is designed to be simple and easy to use, with a focus on providing a consistent interface for all endpoints.</p>
<p>There is no documentation for the API yet, but this will be added as the underlying library supports it.</p>
<h2 id="authentication"><a class="toclink" href="#authentication">Authentication</a></h2>
<p>To use the API, you need to authenticate using Basic Authentication. The username and password are the same as the ones you use to log in to the web application.
If you use 2FA, the API will not work. You need to disable 2FA in the web application to use the API.</p>
<h3 id="authentication-example"><a class="toclink" href="#authentication-example">Authentication Example</a></h3>
<div class="highlight"><pre><span></span><code><span class="kn">import</span><span class="w"> </span><span class="nn">requests</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">requests.auth</span><span class="w"> </span><span class="kn">import</span> <span class="n">HTTPBasicAuth</span>
<span class="n">url</span> <span class="o">=</span> <span class="s2">&quot;https://example.com:51821/api/client&quot;</span>
<span class="n">response</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">auth</span><span class="o">=</span><span class="n">HTTPBasicAuth</span><span class="p">(</span><span class="s1">&#39;username&#39;</span><span class="p">,</span> <span class="s1">&#39;password&#39;</span><span class="p">))</span>
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">200</span><span class="p">:</span>
<span class="n">data</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
<span class="nb">print</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Error: </span><span class="si">{</span><span class="n">response</span><span class="o">.</span><span class="n">status_code</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
</code></pre></div>
<h2 id="endpoints"><a class="toclink" href="#endpoints">Endpoints</a></h2>
<p>The Endpoints are not yet documented. But as file-based routing is used, you can find the endpoints in the <code>src/server/api</code> folder. The method is defined in the file name.</p>
<h3 id="endpoints-example"><a class="toclink" href="#endpoints-example">Endpoints Example</a></h3>
<table>
<thead>
<tr>
<th>File Name</th>
<th>Endpoint</th>
<th>Method</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>src/server/api/client.get.ts</code></td>
<td><code>/api/client</code></td>
<td>GET</td>
</tr>
<tr>
<td><code>src/server/api/setup/2.post.ts</code></td>
<td><code>/api/setup/2</code></td>
<td>POST</td>
</tr>
</tbody>
</table>
@@ -1233,10 +1689,12 @@
</div>
<script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.top", "navigation.expand", "navigation.instant", "content.action.edit", "content.action.view", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.f8cc74c7.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"}, "version": {"provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.top", "navigation.expand", "navigation.instant", "content.action.edit", "content.action.view", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "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"}, "version": {"provider": "mike"}}</script>
<script src="../../assets/javascripts/bundle.c8b220af.min.js"></script>
<script src="../../assets/javascripts/bundle.13a4f30d.min.js"></script>
</body>
development/advanced/config/optional-config/index.html
+328 -42
View File
@@ -22,7 +22,7 @@
<link rel="icon" href="../../../assets/logo/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.8">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
@@ -30,7 +30,7 @@
<link rel="stylesheet" href="../../../assets/stylesheets/main.8608ea7d.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/main.342714a4.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
@@ -148,11 +148,13 @@
<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.52 6.52 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 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<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.52 6.52 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 5"/></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">
@@ -184,6 +186,7 @@
</div>
</div>
</div>
<div class="md-header__source">
@@ -216,10 +219,12 @@
<li class="md-tabs__item">
<a href="../../.." class="md-tabs__link">
Home
@@ -233,10 +238,31 @@
<li class="md-tabs__item">
<a href="../../../faq/" class="md-tabs__link">
FAQ
</a>
</li>
<li class="md-tabs__item">
<a href="../../../getting-started/" class="md-tabs__link">
Getting Started
@@ -249,6 +275,7 @@
@@ -258,6 +285,7 @@
<a href="../../api/" class="md-tabs__link">
Advanced
</a>
@@ -270,12 +298,14 @@
<li class="md-tabs__item">
<a href="../../../contributing/general/" class="md-tabs__link">
Contributing
</a>
@@ -288,18 +318,21 @@
<li class="md-tabs__item">
<a href="../../../examples/tutorials/adguard/" class="md-tabs__link">
Examples
</a>
@@ -311,6 +344,26 @@
<li class="md-tabs__item">
<a href="../../../guides/2fa/" class="md-tabs__link">
Guides
</a>
</li>
</ul>
</div>
</nav>
@@ -365,6 +418,7 @@
<a href="../../.." class="md-nav__link">
<span class="md-ellipsis">
Home
@@ -382,10 +436,33 @@
<li class="md-nav__item">
<a href="../../../faq/" class="md-nav__link">
<span class="md-ellipsis">
FAQ
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../getting-started/" class="md-nav__link">
<span class="md-ellipsis">
Getting Started
@@ -408,6 +485,7 @@
@@ -419,12 +497,13 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
<span class="md-ellipsis">
Advanced
@@ -434,8 +513,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Advanced
</label>
@@ -451,6 +530,7 @@
<a href="../../api/" class="md-nav__link">
<span class="md-ellipsis">
API
@@ -474,6 +554,7 @@
@@ -482,12 +563,13 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2" checked>
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_2" checked>
<label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
<label class="md-nav__link" for="__nav_4_2" id="__nav_4_2_label" tabindex="0">
<span class="md-ellipsis">
Config
@@ -497,8 +579,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3_2">
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4_2">
<span class="md-nav__icon md-icon"></span>
Config
</label>
@@ -521,6 +603,7 @@
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Optional Configuration
@@ -544,6 +627,7 @@
<a href="../unattended-setup/" class="md-nav__link">
<span class="md-ellipsis">
Unattended Setup
@@ -573,6 +657,7 @@
@@ -583,12 +668,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_3" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4_3" >
<label class="md-nav__link" for="__nav_3_3" id="__nav_3_3_label" tabindex="0">
<label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
<span class="md-ellipsis">
Metrics
@@ -598,8 +684,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_3">
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_3">
<span class="md-nav__icon md-icon"></span>
Metrics
</label>
@@ -615,6 +701,7 @@
<a href="../../metrics/prometheus/" class="md-nav__link">
<span class="md-ellipsis">
Prometheus
@@ -644,6 +731,7 @@
@@ -654,12 +742,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_4" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4_4" >
<label class="md-nav__link" for="__nav_3_4" id="__nav_3_4_label" tabindex="0">
<label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
<span class="md-ellipsis">
Migrate
@@ -669,8 +758,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_4">
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_4">
<span class="md-nav__icon md-icon"></span>
Migrate
</label>
@@ -686,6 +775,7 @@
<a href="../../migrate/" class="md-nav__link">
<span class="md-ellipsis">
Migrate
@@ -708,6 +798,7 @@
<a href="../../migrate/from-14-to-15/" class="md-nav__link">
<span class="md-ellipsis">
Migrate from v14 to v15
@@ -744,6 +835,7 @@
@@ -754,12 +846,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<span class="md-ellipsis">
Contributing
@@ -769,8 +862,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Contributing
</label>
@@ -786,6 +879,7 @@
<a href="../../../contributing/general/" class="md-nav__link">
<span class="md-ellipsis">
General Information
@@ -808,6 +902,7 @@
<a href="../../../contributing/issues-and-pull-requests/" class="md-nav__link">
<span class="md-ellipsis">
Issues and Pull Requests
@@ -836,6 +931,7 @@
@@ -846,12 +942,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<span class="md-ellipsis">
Examples
@@ -861,8 +958,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Examples
</label>
@@ -877,6 +974,7 @@
@@ -887,12 +985,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5_1" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
<label class="md-nav__link" for="__nav_5_1" id="__nav_5_1_label" tabindex="0">
<label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
<span class="md-ellipsis">
Tutorials
@@ -902,8 +1001,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5_1">
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6_1">
<span class="md-nav__icon md-icon"></span>
Tutorials
</label>
@@ -919,6 +1018,7 @@
<a href="../../../examples/tutorials/adguard/" class="md-nav__link">
<span class="md-ellipsis">
AdGuard Home
@@ -941,6 +1041,7 @@
<a href="../../../examples/tutorials/auto-updates/" class="md-nav__link">
<span class="md-ellipsis">
Auto Updates
@@ -963,6 +1064,7 @@
<a href="../../../examples/tutorials/basic-installation/" class="md-nav__link">
<span class="md-ellipsis">
Basic Installation
@@ -985,6 +1087,7 @@
<a href="../../../examples/tutorials/caddy/" class="md-nav__link">
<span class="md-ellipsis">
Caddy
@@ -1007,6 +1110,7 @@
<a href="../../../examples/tutorials/docker-run/" class="md-nav__link">
<span class="md-ellipsis">
Docker Run
@@ -1029,6 +1133,7 @@
<a href="../../../examples/tutorials/dockerless/" class="md-nav__link">
<span class="md-ellipsis">
Without Docker
@@ -1048,11 +1153,12 @@
<li class="md-nav__item">
<a href="../../../examples/tutorials/nginx/" class="md-nav__link">
<a href="../../../examples/tutorials/podman-nft/" class="md-nav__link">
<span class="md-ellipsis">
NGINX
Podman + nftables
</span>
@@ -1070,11 +1176,12 @@
<li class="md-nav__item">
<a href="../../../examples/tutorials/podman/" class="md-nav__link">
<a href="../../../examples/tutorials/reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis">
Podman
No Reverse Proxy
</span>
@@ -1095,6 +1202,7 @@
<a href="../../../examples/tutorials/traefik/" class="md-nav__link">
<span class="md-ellipsis">
Traefik
@@ -1122,6 +1230,171 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
<span class="md-ellipsis">
Guides
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
Guides
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../guides/2fa/" class="md-nav__link">
<span class="md-ellipsis">
2FA
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/admin/" class="md-nav__link">
<span class="md-ellipsis">
Admin Panel
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/cli/" class="md-nav__link">
<span class="md-ellipsis">
CLI
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/clients/" class="md-nav__link">
<span class="md-ellipsis">
Edit Client
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/setup/" class="md-nav__link">
<span class="md-ellipsis">
Setup
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
@@ -1172,7 +1445,7 @@
<h1>Optional Configuration</h1>
<p>TODO</p>
<p>You can set these environment variables to configure the container. They are not required, but can be useful in some cases.</p>
<table>
<thead>
<tr>
@@ -1201,8 +1474,19 @@
<td><code>true</code></td>
<td>If access over http is allowed</td>
</tr>
<tr>
<td><code>DISABLE_IPV6</code></td>
<td><code>false</code></td>
<td><code>true</code></td>
<td>If IPv6 support should be disabled</td>
</tr>
</tbody>
</table>
<div class="admonition note">
<p class="admonition-title">IPv6 Caveats</p>
<p>Disabling IPv6 will only disable the creation of the default IPv6 firewall rules. The clients will still get an IPv6 address assigned.</p>
<p>This option can be removed in the future, as more devices support IPv6.</p>
</div>
@@ -1263,10 +1547,12 @@
</div>
<script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.top", "navigation.expand", "navigation.instant", "content.action.edit", "content.action.view", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.f8cc74c7.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"}, "version": {"provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.top", "navigation.expand", "navigation.instant", "content.action.edit", "content.action.view", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "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"}, "version": {"provider": "mike"}}</script>
<script src="../../../assets/javascripts/bundle.c8b220af.min.js"></script>
<script src="../../../assets/javascripts/bundle.13a4f30d.min.js"></script>
</body>
development/advanced/config/unattended-setup/index.html
+318 -43
View File
@@ -22,7 +22,7 @@
<link rel="icon" href="../../../assets/logo/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.8">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
@@ -30,7 +30,7 @@
<link rel="stylesheet" href="../../../assets/stylesheets/main.8608ea7d.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/main.342714a4.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
@@ -148,11 +148,13 @@
<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.52 6.52 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 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<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.52 6.52 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 5"/></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">
@@ -184,6 +186,7 @@
</div>
</div>
</div>
<div class="md-header__source">
@@ -216,10 +219,12 @@
<li class="md-tabs__item">
<a href="../../.." class="md-tabs__link">
Home
@@ -233,10 +238,31 @@
<li class="md-tabs__item">
<a href="../../../faq/" class="md-tabs__link">
FAQ
</a>
</li>
<li class="md-tabs__item">
<a href="../../../getting-started/" class="md-tabs__link">
Getting Started
@@ -249,6 +275,7 @@
@@ -258,6 +285,7 @@
<a href="../../api/" class="md-tabs__link">
Advanced
</a>
@@ -270,12 +298,14 @@
<li class="md-tabs__item">
<a href="../../../contributing/general/" class="md-tabs__link">
Contributing
</a>
@@ -288,18 +318,21 @@
<li class="md-tabs__item">
<a href="../../../examples/tutorials/adguard/" class="md-tabs__link">
Examples
</a>
@@ -311,6 +344,26 @@
<li class="md-tabs__item">
<a href="../../../guides/2fa/" class="md-tabs__link">
Guides
</a>
</li>
</ul>
</div>
</nav>
@@ -365,6 +418,7 @@
<a href="../../.." class="md-nav__link">
<span class="md-ellipsis">
Home
@@ -382,10 +436,33 @@
<li class="md-nav__item">
<a href="../../../faq/" class="md-nav__link">
<span class="md-ellipsis">
FAQ
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../getting-started/" class="md-nav__link">
<span class="md-ellipsis">
Getting Started
@@ -408,6 +485,7 @@
@@ -419,12 +497,13 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
<span class="md-ellipsis">
Advanced
@@ -434,8 +513,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Advanced
</label>
@@ -451,6 +530,7 @@
<a href="../../api/" class="md-nav__link">
<span class="md-ellipsis">
API
@@ -474,6 +554,7 @@
@@ -482,12 +563,13 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2" checked>
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_2" checked>
<label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
<label class="md-nav__link" for="__nav_4_2" id="__nav_4_2_label" tabindex="0">
<span class="md-ellipsis">
Config
@@ -497,8 +579,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3_2">
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4_2">
<span class="md-nav__icon md-icon"></span>
Config
</label>
@@ -514,6 +596,7 @@
<a href="../optional-config/" class="md-nav__link">
<span class="md-ellipsis">
Optional Configuration
@@ -543,6 +626,7 @@
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Unattended Setup
@@ -573,6 +657,7 @@
@@ -583,12 +668,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_3" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4_3" >
<label class="md-nav__link" for="__nav_3_3" id="__nav_3_3_label" tabindex="0">
<label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
<span class="md-ellipsis">
Metrics
@@ -598,8 +684,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_3">
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_3">
<span class="md-nav__icon md-icon"></span>
Metrics
</label>
@@ -615,6 +701,7 @@
<a href="../../metrics/prometheus/" class="md-nav__link">
<span class="md-ellipsis">
Prometheus
@@ -644,6 +731,7 @@
@@ -654,12 +742,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_4" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4_4" >
<label class="md-nav__link" for="__nav_3_4" id="__nav_3_4_label" tabindex="0">
<label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
<span class="md-ellipsis">
Migrate
@@ -669,8 +758,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_4">
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_4">
<span class="md-nav__icon md-icon"></span>
Migrate
</label>
@@ -686,6 +775,7 @@
<a href="../../migrate/" class="md-nav__link">
<span class="md-ellipsis">
Migrate
@@ -708,6 +798,7 @@
<a href="../../migrate/from-14-to-15/" class="md-nav__link">
<span class="md-ellipsis">
Migrate from v14 to v15
@@ -744,6 +835,7 @@
@@ -754,12 +846,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<span class="md-ellipsis">
Contributing
@@ -769,8 +862,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Contributing
</label>
@@ -786,6 +879,7 @@
<a href="../../../contributing/general/" class="md-nav__link">
<span class="md-ellipsis">
General Information
@@ -808,6 +902,7 @@
<a href="../../../contributing/issues-and-pull-requests/" class="md-nav__link">
<span class="md-ellipsis">
Issues and Pull Requests
@@ -836,6 +931,7 @@
@@ -846,12 +942,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<span class="md-ellipsis">
Examples
@@ -861,8 +958,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Examples
</label>
@@ -877,6 +974,7 @@
@@ -887,12 +985,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5_1" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
<label class="md-nav__link" for="__nav_5_1" id="__nav_5_1_label" tabindex="0">
<label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
<span class="md-ellipsis">
Tutorials
@@ -902,8 +1001,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5_1">
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6_1">
<span class="md-nav__icon md-icon"></span>
Tutorials
</label>
@@ -919,6 +1018,7 @@
<a href="../../../examples/tutorials/adguard/" class="md-nav__link">
<span class="md-ellipsis">
AdGuard Home
@@ -941,6 +1041,7 @@
<a href="../../../examples/tutorials/auto-updates/" class="md-nav__link">
<span class="md-ellipsis">
Auto Updates
@@ -963,6 +1064,7 @@
<a href="../../../examples/tutorials/basic-installation/" class="md-nav__link">
<span class="md-ellipsis">
Basic Installation
@@ -985,6 +1087,7 @@
<a href="../../../examples/tutorials/caddy/" class="md-nav__link">
<span class="md-ellipsis">
Caddy
@@ -1007,6 +1110,7 @@
<a href="../../../examples/tutorials/docker-run/" class="md-nav__link">
<span class="md-ellipsis">
Docker Run
@@ -1029,6 +1133,7 @@
<a href="../../../examples/tutorials/dockerless/" class="md-nav__link">
<span class="md-ellipsis">
Without Docker
@@ -1048,11 +1153,12 @@
<li class="md-nav__item">
<a href="../../../examples/tutorials/nginx/" class="md-nav__link">
<a href="../../../examples/tutorials/podman-nft/" class="md-nav__link">
<span class="md-ellipsis">
NGINX
Podman + nftables
</span>
@@ -1070,11 +1176,12 @@
<li class="md-nav__item">
<a href="../../../examples/tutorials/podman/" class="md-nav__link">
<a href="../../../examples/tutorials/reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis">
Podman
No Reverse Proxy
</span>
@@ -1095,6 +1202,7 @@
<a href="../../../examples/tutorials/traefik/" class="md-nav__link">
<span class="md-ellipsis">
Traefik
@@ -1122,6 +1230,171 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
<span class="md-ellipsis">
Guides
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
Guides
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../guides/2fa/" class="md-nav__link">
<span class="md-ellipsis">
2FA
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/admin/" class="md-nav__link">
<span class="md-ellipsis">
Admin Panel
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/cli/" class="md-nav__link">
<span class="md-ellipsis">
CLI
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/clients/" class="md-nav__link">
<span class="md-ellipsis">
Edit Client
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/setup/" class="md-nav__link">
<span class="md-ellipsis">
Setup
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
@@ -1241,8 +1514,8 @@
</div>
<div class="admonition note">
<p class="admonition-title">Security</p>
<p>The initial username and password is not checked for complexity. Make sure to set a long enough username and a secure password. Otherwise, the user won't be able to log in.</p>
<p>Its recommended to remove the variables after the setup is done to prevent the password from being exposed.</p>
<p>The initial username and password is not checked for complexity. Make sure to set a long enough username and password. Otherwise, the user won't be able to log in.</p>
<p>It's recommended to remove the variables after the setup is done to prevent the password from being exposed.</p>
</div>
@@ -1304,10 +1577,12 @@
</div>
<script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.top", "navigation.expand", "navigation.instant", "content.action.edit", "content.action.view", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.f8cc74c7.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"}, "version": {"provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.top", "navigation.expand", "navigation.instant", "content.action.edit", "content.action.view", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "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"}, "version": {"provider": "mike"}}</script>
<script src="../../../assets/javascripts/bundle.c8b220af.min.js"></script>
<script src="../../../assets/javascripts/bundle.13a4f30d.min.js"></script>
</body>
development/advanced/metrics/prometheus/index.html
+439 -43
View File
@@ -22,7 +22,7 @@
<link rel="icon" href="../../../assets/logo/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.8">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
@@ -30,7 +30,7 @@
<link rel="stylesheet" href="../../../assets/stylesheets/main.8608ea7d.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/main.342714a4.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
@@ -77,6 +77,11 @@
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#enable-prometheus" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
@@ -148,11 +153,13 @@
<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.52 6.52 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 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<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.52 6.52 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 5"/></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">
@@ -184,6 +191,7 @@
</div>
</div>
</div>
<div class="md-header__source">
@@ -216,10 +224,12 @@
<li class="md-tabs__item">
<a href="../../.." class="md-tabs__link">
Home
@@ -233,10 +243,31 @@
<li class="md-tabs__item">
<a href="../../../faq/" class="md-tabs__link">
FAQ
</a>
</li>
<li class="md-tabs__item">
<a href="../../../getting-started/" class="md-tabs__link">
Getting Started
@@ -249,6 +280,7 @@
@@ -258,6 +290,7 @@
<a href="../../api/" class="md-tabs__link">
Advanced
</a>
@@ -270,12 +303,14 @@
<li class="md-tabs__item">
<a href="../../../contributing/general/" class="md-tabs__link">
Contributing
</a>
@@ -288,18 +323,21 @@
<li class="md-tabs__item">
<a href="../../../examples/tutorials/adguard/" class="md-tabs__link">
Examples
</a>
@@ -311,6 +349,26 @@
<li class="md-tabs__item">
<a href="../../../guides/2fa/" class="md-tabs__link">
Guides
</a>
</li>
</ul>
</div>
</nav>
@@ -365,6 +423,7 @@
<a href="../../.." class="md-nav__link">
<span class="md-ellipsis">
Home
@@ -382,10 +441,33 @@
<li class="md-nav__item">
<a href="../../../faq/" class="md-nav__link">
<span class="md-ellipsis">
FAQ
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../getting-started/" class="md-nav__link">
<span class="md-ellipsis">
Getting Started
@@ -408,6 +490,7 @@
@@ -419,12 +502,13 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
<span class="md-ellipsis">
Advanced
@@ -434,8 +518,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Advanced
</label>
@@ -451,6 +535,7 @@
<a href="../../api/" class="md-nav__link">
<span class="md-ellipsis">
API
@@ -472,6 +557,7 @@
@@ -482,12 +568,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4_2" >
<label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
<label class="md-nav__link" for="__nav_4_2" id="__nav_4_2_label" tabindex="0">
<span class="md-ellipsis">
Config
@@ -497,8 +584,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_2">
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_2">
<span class="md-nav__icon md-icon"></span>
Config
</label>
@@ -514,6 +601,7 @@
<a href="../../config/optional-config/" class="md-nav__link">
<span class="md-ellipsis">
Optional Configuration
@@ -536,6 +624,7 @@
<a href="../../config/unattended-setup/" class="md-nav__link">
<span class="md-ellipsis">
Unattended Setup
@@ -567,6 +656,7 @@
@@ -575,12 +665,13 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_3" checked>
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3" checked>
<label class="md-nav__link" for="__nav_3_3" id="__nav_3_3_label" tabindex="0">
<label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
<span class="md-ellipsis">
Metrics
@@ -590,8 +681,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_3_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3_3">
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4_3">
<span class="md-nav__icon md-icon"></span>
Metrics
</label>
@@ -611,9 +702,23 @@
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Prometheus
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Prometheus
@@ -622,6 +727,50 @@
</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="#enable-prometheus" class="md-nav__link">
<span class="md-ellipsis">
Enable Prometheus
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#configure-prometheus" class="md-nav__link">
<span class="md-ellipsis">
Configure Prometheus
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#grafana-dashboard" class="md-nav__link">
<span class="md-ellipsis">
Grafana Dashboard
</span>
</a>
</li>
</ul>
</nav>
</li>
@@ -644,6 +793,7 @@
@@ -654,12 +804,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_4" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4_4" >
<label class="md-nav__link" for="__nav_3_4" id="__nav_3_4_label" tabindex="0">
<label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
<span class="md-ellipsis">
Migrate
@@ -669,8 +820,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_4">
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_4">
<span class="md-nav__icon md-icon"></span>
Migrate
</label>
@@ -686,6 +837,7 @@
<a href="../../migrate/" class="md-nav__link">
<span class="md-ellipsis">
Migrate
@@ -708,6 +860,7 @@
<a href="../../migrate/from-14-to-15/" class="md-nav__link">
<span class="md-ellipsis">
Migrate from v14 to v15
@@ -744,6 +897,7 @@
@@ -754,12 +908,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<span class="md-ellipsis">
Contributing
@@ -769,8 +924,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Contributing
</label>
@@ -786,6 +941,7 @@
<a href="../../../contributing/general/" class="md-nav__link">
<span class="md-ellipsis">
General Information
@@ -808,6 +964,7 @@
<a href="../../../contributing/issues-and-pull-requests/" class="md-nav__link">
<span class="md-ellipsis">
Issues and Pull Requests
@@ -836,6 +993,7 @@
@@ -846,12 +1004,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<span class="md-ellipsis">
Examples
@@ -861,8 +1020,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Examples
</label>
@@ -877,6 +1036,7 @@
@@ -887,12 +1047,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5_1" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
<label class="md-nav__link" for="__nav_5_1" id="__nav_5_1_label" tabindex="0">
<label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
<span class="md-ellipsis">
Tutorials
@@ -902,8 +1063,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5_1">
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6_1">
<span class="md-nav__icon md-icon"></span>
Tutorials
</label>
@@ -919,6 +1080,7 @@
<a href="../../../examples/tutorials/adguard/" class="md-nav__link">
<span class="md-ellipsis">
AdGuard Home
@@ -941,6 +1103,7 @@
<a href="../../../examples/tutorials/auto-updates/" class="md-nav__link">
<span class="md-ellipsis">
Auto Updates
@@ -963,6 +1126,7 @@
<a href="../../../examples/tutorials/basic-installation/" class="md-nav__link">
<span class="md-ellipsis">
Basic Installation
@@ -985,6 +1149,7 @@
<a href="../../../examples/tutorials/caddy/" class="md-nav__link">
<span class="md-ellipsis">
Caddy
@@ -1007,6 +1172,7 @@
<a href="../../../examples/tutorials/docker-run/" class="md-nav__link">
<span class="md-ellipsis">
Docker Run
@@ -1029,6 +1195,7 @@
<a href="../../../examples/tutorials/dockerless/" class="md-nav__link">
<span class="md-ellipsis">
Without Docker
@@ -1048,11 +1215,12 @@
<li class="md-nav__item">
<a href="../../../examples/tutorials/nginx/" class="md-nav__link">
<a href="../../../examples/tutorials/podman-nft/" class="md-nav__link">
<span class="md-ellipsis">
NGINX
Podman + nftables
</span>
@@ -1070,11 +1238,12 @@
<li class="md-nav__item">
<a href="../../../examples/tutorials/podman/" class="md-nav__link">
<a href="../../../examples/tutorials/reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis">
Podman
No Reverse Proxy
</span>
@@ -1095,6 +1264,7 @@
<a href="../../../examples/tutorials/traefik/" class="md-nav__link">
<span class="md-ellipsis">
Traefik
@@ -1122,6 +1292,171 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
<span class="md-ellipsis">
Guides
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
Guides
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../guides/2fa/" class="md-nav__link">
<span class="md-ellipsis">
2FA
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/admin/" class="md-nav__link">
<span class="md-ellipsis">
Admin Panel
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/cli/" class="md-nav__link">
<span class="md-ellipsis">
CLI
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/clients/" class="md-nav__link">
<span class="md-ellipsis">
Edit Client
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/setup/" class="md-nav__link">
<span class="md-ellipsis">
Setup
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
@@ -1140,6 +1475,41 @@
<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="#enable-prometheus" class="md-nav__link">
<span class="md-ellipsis">
Enable Prometheus
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#configure-prometheus" class="md-nav__link">
<span class="md-ellipsis">
Configure Prometheus
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#grafana-dashboard" class="md-nav__link">
<span class="md-ellipsis">
Grafana Dashboard
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
@@ -1172,8 +1542,32 @@
<h1>Prometheus</h1>
<p>TODO</p>
<!-- TOOD: add to docs: Grafana dashboard [21733](https://grafana.com/grafana/dashboards/21733-wireguard/) -->
<p>To monitor the WireGuard server, you can use <a href="https://prometheus.io/">Prometheus</a> and <a href="https://grafana.com/">Grafana</a>. The container exposes a <code>/metrics/prometheus</code> endpoint that can be scraped by Prometheus.</p>
<h2 id="enable-prometheus"><a class="toclink" href="#enable-prometheus">Enable Prometheus</a></h2>
<p>To enable Prometheus metrics, go to Admin Panel &gt; General and enable Prometheus.</p>
<p>You can optionally set a Bearer Password for the metrics endpoints. This is useful if you want to expose the metrics endpoint to the internet.</p>
<h2 id="configure-prometheus"><a class="toclink" href="#configure-prometheus">Configure Prometheus</a></h2>
<p>You need to add a scrape config to your Prometheus configuration file. Here is an example:</p>
<div class="highlight"><pre><span></span><code><span class="nt">scrape_configs</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">job_name</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;wg-easy&#39;</span>
<span class="w"> </span><span class="nt">scrape_interval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">30s</span>
<span class="w"> </span><span class="nt">metrics_path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/metrics/prometheus</span>
<span class="w"> </span><span class="nt">static_configs</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">targets</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&#39;localhost:51821&#39;</span>
<span class="w"> </span><span class="nt">authorization</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">Bearer</span>
<span class="w"> </span><span class="nt">credentials</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;SuperSecurePassword&#39;</span>
</code></pre></div>
<h2 id="grafana-dashboard"><a class="toclink" href="#grafana-dashboard">Grafana Dashboard</a></h2>
<p>You can use the following Grafana dashboard to visualize the metrics:</p>
<p><a href="https://grafana.com/grafana/dashboards/21733-wireguard/"><img alt="Grafana Dashboard" src="https://grafana.com/api/dashboards/21733/images/16863/image" /></a></p>
<p><a href="https://grafana.com/grafana/dashboards/21733-wireguard/">21733</a></p>
<div class="admonition note">
<p class="admonition-title">Unofficial</p>
<p>The Grafana dashboard is not official and is not maintained by the <code>wg-easy</code> team. If you have any issues with the dashboard, please contact the author of the dashboard.
See <a href="https://github.com/wg-easy/wg-easy/pull/1299">#1299</a> for more information.</p>
</div>
@@ -1234,10 +1628,12 @@
</div>
<script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.top", "navigation.expand", "navigation.instant", "content.action.edit", "content.action.view", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.f8cc74c7.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"}, "version": {"provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.top", "navigation.expand", "navigation.instant", "content.action.edit", "content.action.view", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "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"}, "version": {"provider": "mike"}}</script>
<script src="../../../assets/javascripts/bundle.c8b220af.min.js"></script>
<script src="../../../assets/javascripts/bundle.13a4f30d.min.js"></script>
</body>
development/advanced/migrate/from-14-to-15/index.html
+319 -43
View File
@@ -22,7 +22,7 @@
<link rel="icon" href="../../../assets/logo/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.8">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
@@ -30,7 +30,7 @@
<link rel="stylesheet" href="../../../assets/stylesheets/main.8608ea7d.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/main.342714a4.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
@@ -153,11 +153,13 @@
<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.52 6.52 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 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<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.52 6.52 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 5"/></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">
@@ -189,6 +191,7 @@
</div>
</div>
</div>
<div class="md-header__source">
@@ -221,10 +224,12 @@
<li class="md-tabs__item">
<a href="../../.." class="md-tabs__link">
Home
@@ -238,10 +243,31 @@
<li class="md-tabs__item">
<a href="../../../faq/" class="md-tabs__link">
FAQ
</a>
</li>
<li class="md-tabs__item">
<a href="../../../getting-started/" class="md-tabs__link">
Getting Started
@@ -254,6 +280,7 @@
@@ -263,6 +290,7 @@
<a href="../../api/" class="md-tabs__link">
Advanced
</a>
@@ -275,12 +303,14 @@
<li class="md-tabs__item">
<a href="../../../contributing/general/" class="md-tabs__link">
Contributing
</a>
@@ -293,18 +323,21 @@
<li class="md-tabs__item">
<a href="../../../examples/tutorials/adguard/" class="md-tabs__link">
Examples
</a>
@@ -316,6 +349,26 @@
<li class="md-tabs__item">
<a href="../../../guides/2fa/" class="md-tabs__link">
Guides
</a>
</li>
</ul>
</div>
</nav>
@@ -370,6 +423,7 @@
<a href="../../.." class="md-nav__link">
<span class="md-ellipsis">
Home
@@ -387,10 +441,33 @@
<li class="md-nav__item">
<a href="../../../faq/" class="md-nav__link">
<span class="md-ellipsis">
FAQ
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../getting-started/" class="md-nav__link">
<span class="md-ellipsis">
Getting Started
@@ -413,6 +490,7 @@
@@ -424,12 +502,13 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
<span class="md-ellipsis">
Advanced
@@ -439,8 +518,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Advanced
</label>
@@ -456,6 +535,7 @@
<a href="../../api/" class="md-nav__link">
<span class="md-ellipsis">
API
@@ -477,6 +557,7 @@
@@ -487,12 +568,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4_2" >
<label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
<label class="md-nav__link" for="__nav_4_2" id="__nav_4_2_label" tabindex="0">
<span class="md-ellipsis">
Config
@@ -502,8 +584,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_2">
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_2">
<span class="md-nav__icon md-icon"></span>
Config
</label>
@@ -519,6 +601,7 @@
<a href="../../config/optional-config/" class="md-nav__link">
<span class="md-ellipsis">
Optional Configuration
@@ -541,6 +624,7 @@
<a href="../../config/unattended-setup/" class="md-nav__link">
<span class="md-ellipsis">
Unattended Setup
@@ -570,6 +654,7 @@
@@ -580,12 +665,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_3" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4_3" >
<label class="md-nav__link" for="__nav_3_3" id="__nav_3_3_label" tabindex="0">
<label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
<span class="md-ellipsis">
Metrics
@@ -595,8 +681,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_3">
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_3">
<span class="md-nav__icon md-icon"></span>
Metrics
</label>
@@ -612,6 +698,7 @@
<a href="../../metrics/prometheus/" class="md-nav__link">
<span class="md-ellipsis">
Prometheus
@@ -643,6 +730,7 @@
@@ -651,12 +739,13 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_4" checked>
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" checked>
<label class="md-nav__link" for="__nav_3_4" id="__nav_3_4_label" tabindex="0">
<label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
<span class="md-ellipsis">
Migrate
@@ -666,8 +755,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3_4">
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4_4">
<span class="md-nav__icon md-icon"></span>
Migrate
</label>
@@ -683,6 +772,7 @@
<a href="../" class="md-nav__link">
<span class="md-ellipsis">
Migrate
@@ -712,6 +802,7 @@
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Migrate from v14 to v15
@@ -724,6 +815,7 @@
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Migrate from v14 to v15
@@ -838,6 +930,7 @@
@@ -848,12 +941,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<span class="md-ellipsis">
Contributing
@@ -863,8 +957,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Contributing
</label>
@@ -880,6 +974,7 @@
<a href="../../../contributing/general/" class="md-nav__link">
<span class="md-ellipsis">
General Information
@@ -902,6 +997,7 @@
<a href="../../../contributing/issues-and-pull-requests/" class="md-nav__link">
<span class="md-ellipsis">
Issues and Pull Requests
@@ -930,6 +1026,7 @@
@@ -940,12 +1037,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<span class="md-ellipsis">
Examples
@@ -955,8 +1053,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Examples
</label>
@@ -971,6 +1069,7 @@
@@ -981,12 +1080,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5_1" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
<label class="md-nav__link" for="__nav_5_1" id="__nav_5_1_label" tabindex="0">
<label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
<span class="md-ellipsis">
Tutorials
@@ -996,8 +1096,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5_1">
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6_1">
<span class="md-nav__icon md-icon"></span>
Tutorials
</label>
@@ -1013,6 +1113,7 @@
<a href="../../../examples/tutorials/adguard/" class="md-nav__link">
<span class="md-ellipsis">
AdGuard Home
@@ -1035,6 +1136,7 @@
<a href="../../../examples/tutorials/auto-updates/" class="md-nav__link">
<span class="md-ellipsis">
Auto Updates
@@ -1057,6 +1159,7 @@
<a href="../../../examples/tutorials/basic-installation/" class="md-nav__link">
<span class="md-ellipsis">
Basic Installation
@@ -1079,6 +1182,7 @@
<a href="../../../examples/tutorials/caddy/" class="md-nav__link">
<span class="md-ellipsis">
Caddy
@@ -1101,6 +1205,7 @@
<a href="../../../examples/tutorials/docker-run/" class="md-nav__link">
<span class="md-ellipsis">
Docker Run
@@ -1123,6 +1228,7 @@
<a href="../../../examples/tutorials/dockerless/" class="md-nav__link">
<span class="md-ellipsis">
Without Docker
@@ -1142,11 +1248,12 @@
<li class="md-nav__item">
<a href="../../../examples/tutorials/nginx/" class="md-nav__link">
<a href="../../../examples/tutorials/podman-nft/" class="md-nav__link">
<span class="md-ellipsis">
NGINX
Podman + nftables
</span>
@@ -1164,11 +1271,12 @@
<li class="md-nav__item">
<a href="../../../examples/tutorials/podman/" class="md-nav__link">
<a href="../../../examples/tutorials/reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis">
Podman
No Reverse Proxy
</span>
@@ -1189,6 +1297,7 @@
<a href="../../../examples/tutorials/traefik/" class="md-nav__link">
<span class="md-ellipsis">
Traefik
@@ -1216,6 +1325,171 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
<span class="md-ellipsis">
Guides
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
Guides
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../guides/2fa/" class="md-nav__link">
<span class="md-ellipsis">
2FA
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/admin/" class="md-nav__link">
<span class="md-ellipsis">
Admin Panel
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/cli/" class="md-nav__link">
<span class="md-ellipsis">
CLI
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/clients/" class="md-nav__link">
<span class="md-ellipsis">
Edit Client
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/setup/" class="md-nav__link">
<span class="md-ellipsis">
Setup
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
@@ -1338,7 +1612,7 @@
<h2 id="changes"><a class="toclink" href="#changes">Changes</a></h2>
<ul>
<li>This is a complete rewrite of the <code>wg-easy</code> project. Therefore the configuration files and the way you interact with the project have changed.</li>
<li>If you use armv6 or armv7, you can't migrate to <code>v15</code> yet. We are working on it.</li>
<li>If you use armv6, you unfortunately won't be able to migrate to <code>v15</code>.</li>
<li>If you are connecting to the web ui via HTTP, you need to set the <code>INSECURE</code> environment variable to <code>true</code> in the new container.</li>
</ul>
<h2 id="migration"><a class="toclink" href="#migration">Migration</a></h2>
@@ -1359,7 +1633,7 @@
</code></pre></div>
<h3 id="start-new-container"><a class="toclink" href="#start-new-container">Start new container</a></h3>
<p>Follow the instructions in the <a href="../../../getting-started/">Getting Started</a> or <a href="../../../examples/tutorials/basic-installation/">Basic Installation</a> guide to start the new container.</p>
<p>In the setup wizard, select that you already already have a configuration file and upload the <code>wg0.json</code> file you downloaded in the backup step.</p>
<p>In the setup wizard, select that you already have a configuration file and upload the <code>wg0.json</code> file you downloaded in the backup step.</p>
<h3 id="done"><a class="toclink" href="#done">Done</a></h3>
<p>You have now successfully migrated to <code>v15</code> of <code>wg-easy</code>.</p>
@@ -1422,10 +1696,12 @@
</div>
<script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.top", "navigation.expand", "navigation.instant", "content.action.edit", "content.action.view", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.f8cc74c7.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"}, "version": {"provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.top", "navigation.expand", "navigation.instant", "content.action.edit", "content.action.view", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "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"}, "version": {"provider": "mike"}}</script>
<script src="../../../assets/javascripts/bundle.c8b220af.min.js"></script>
<script src="../../../assets/javascripts/bundle.13a4f30d.min.js"></script>
</body>
development/advanced/migrate/index.html
+316 -41
View File
@@ -22,7 +22,7 @@
<link rel="icon" href="../../assets/logo/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.8">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
@@ -30,7 +30,7 @@
<link rel="stylesheet" href="../../assets/stylesheets/main.8608ea7d.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/main.342714a4.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
@@ -148,11 +148,13 @@
<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.52 6.52 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 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<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.52 6.52 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 5"/></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">
@@ -184,6 +186,7 @@
</div>
</div>
</div>
<div class="md-header__source">
@@ -216,10 +219,12 @@
<li class="md-tabs__item">
<a href="../.." class="md-tabs__link">
Home
@@ -233,10 +238,31 @@
<li class="md-tabs__item">
<a href="../../faq/" class="md-tabs__link">
FAQ
</a>
</li>
<li class="md-tabs__item">
<a href="../../getting-started/" class="md-tabs__link">
Getting Started
@@ -249,6 +275,7 @@
@@ -258,6 +285,7 @@
<a href="../api/" class="md-tabs__link">
Advanced
</a>
@@ -270,12 +298,14 @@
<li class="md-tabs__item">
<a href="../../contributing/general/" class="md-tabs__link">
Contributing
</a>
@@ -288,18 +318,21 @@
<li class="md-tabs__item">
<a href="../../examples/tutorials/adguard/" class="md-tabs__link">
Examples
</a>
@@ -311,6 +344,26 @@
<li class="md-tabs__item">
<a href="../../guides/2fa/" class="md-tabs__link">
Guides
</a>
</li>
</ul>
</div>
</nav>
@@ -365,6 +418,7 @@
<a href="../.." class="md-nav__link">
<span class="md-ellipsis">
Home
@@ -382,10 +436,33 @@
<li class="md-nav__item">
<a href="../../faq/" class="md-nav__link">
<span class="md-ellipsis">
FAQ
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../getting-started/" class="md-nav__link">
<span class="md-ellipsis">
Getting Started
@@ -408,6 +485,7 @@
@@ -419,12 +497,13 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
<span class="md-ellipsis">
Advanced
@@ -434,8 +513,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Advanced
</label>
@@ -451,6 +530,7 @@
<a href="../api/" class="md-nav__link">
<span class="md-ellipsis">
API
@@ -472,6 +552,7 @@
@@ -482,12 +563,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4_2" >
<label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
<label class="md-nav__link" for="__nav_4_2" id="__nav_4_2_label" tabindex="0">
<span class="md-ellipsis">
Config
@@ -497,8 +579,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_2">
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_2">
<span class="md-nav__icon md-icon"></span>
Config
</label>
@@ -514,6 +596,7 @@
<a href="../config/optional-config/" class="md-nav__link">
<span class="md-ellipsis">
Optional Configuration
@@ -536,6 +619,7 @@
<a href="../config/unattended-setup/" class="md-nav__link">
<span class="md-ellipsis">
Unattended Setup
@@ -565,6 +649,7 @@
@@ -575,12 +660,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_3" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4_3" >
<label class="md-nav__link" for="__nav_3_3" id="__nav_3_3_label" tabindex="0">
<label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
<span class="md-ellipsis">
Metrics
@@ -590,8 +676,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_3">
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_3">
<span class="md-nav__icon md-icon"></span>
Metrics
</label>
@@ -607,6 +693,7 @@
<a href="../metrics/prometheus/" class="md-nav__link">
<span class="md-ellipsis">
Prometheus
@@ -638,6 +725,7 @@
@@ -646,12 +734,13 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_4" checked>
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" checked>
<label class="md-nav__link" for="__nav_3_4" id="__nav_3_4_label" tabindex="0">
<label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
<span class="md-ellipsis">
Migrate
@@ -661,8 +750,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3_4">
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4_4">
<span class="md-nav__icon md-icon"></span>
Migrate
</label>
@@ -685,6 +774,7 @@
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Migrate
@@ -708,6 +798,7 @@
<a href="from-14-to-15/" class="md-nav__link">
<span class="md-ellipsis">
Migrate from v14 to v15
@@ -744,6 +835,7 @@
@@ -754,12 +846,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<span class="md-ellipsis">
Contributing
@@ -769,8 +862,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Contributing
</label>
@@ -786,6 +879,7 @@
<a href="../../contributing/general/" class="md-nav__link">
<span class="md-ellipsis">
General Information
@@ -808,6 +902,7 @@
<a href="../../contributing/issues-and-pull-requests/" class="md-nav__link">
<span class="md-ellipsis">
Issues and Pull Requests
@@ -836,6 +931,7 @@
@@ -846,12 +942,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<span class="md-ellipsis">
Examples
@@ -861,8 +958,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Examples
</label>
@@ -877,6 +974,7 @@
@@ -887,12 +985,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5_1" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
<label class="md-nav__link" for="__nav_5_1" id="__nav_5_1_label" tabindex="0">
<label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
<span class="md-ellipsis">
Tutorials
@@ -902,8 +1001,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5_1">
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6_1">
<span class="md-nav__icon md-icon"></span>
Tutorials
</label>
@@ -919,6 +1018,7 @@
<a href="../../examples/tutorials/adguard/" class="md-nav__link">
<span class="md-ellipsis">
AdGuard Home
@@ -941,6 +1041,7 @@
<a href="../../examples/tutorials/auto-updates/" class="md-nav__link">
<span class="md-ellipsis">
Auto Updates
@@ -963,6 +1064,7 @@
<a href="../../examples/tutorials/basic-installation/" class="md-nav__link">
<span class="md-ellipsis">
Basic Installation
@@ -985,6 +1087,7 @@
<a href="../../examples/tutorials/caddy/" class="md-nav__link">
<span class="md-ellipsis">
Caddy
@@ -1007,6 +1110,7 @@
<a href="../../examples/tutorials/docker-run/" class="md-nav__link">
<span class="md-ellipsis">
Docker Run
@@ -1029,6 +1133,7 @@
<a href="../../examples/tutorials/dockerless/" class="md-nav__link">
<span class="md-ellipsis">
Without Docker
@@ -1048,11 +1153,12 @@
<li class="md-nav__item">
<a href="../../examples/tutorials/nginx/" class="md-nav__link">
<a href="../../examples/tutorials/podman-nft/" class="md-nav__link">
<span class="md-ellipsis">
NGINX
Podman + nftables
</span>
@@ -1070,11 +1176,12 @@
<li class="md-nav__item">
<a href="../../examples/tutorials/podman/" class="md-nav__link">
<a href="../../examples/tutorials/reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis">
Podman
No Reverse Proxy
</span>
@@ -1095,6 +1202,7 @@
<a href="../../examples/tutorials/traefik/" class="md-nav__link">
<span class="md-ellipsis">
Traefik
@@ -1122,6 +1230,171 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
<span class="md-ellipsis">
Guides
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
Guides
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../guides/2fa/" class="md-nav__link">
<span class="md-ellipsis">
2FA
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../guides/admin/" class="md-nav__link">
<span class="md-ellipsis">
Admin Panel
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../guides/cli/" class="md-nav__link">
<span class="md-ellipsis">
CLI
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../guides/clients/" class="md-nav__link">
<span class="md-ellipsis">
Edit Client
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../guides/setup/" class="md-nav__link">
<span class="md-ellipsis">
Setup
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
@@ -1236,10 +1509,12 @@
</div>
<script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.top", "navigation.expand", "navigation.instant", "content.action.edit", "content.action.view", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.f8cc74c7.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"}, "version": {"provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.top", "navigation.expand", "navigation.instant", "content.action.edit", "content.action.view", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "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"}, "version": {"provider": "mike"}}</script>
<script src="../../assets/javascripts/bundle.c8b220af.min.js"></script>
<script src="../../assets/javascripts/bundle.13a4f30d.min.js"></script>
</body>