Browse Source

Deployed e93342e to development with MkDocs 1.6.1 and mike 2.1.3

gh-pages
github-actions[bot] 2 weeks ago
parent
commit
c324cb2222
  1. 357
      development/404.html
  2. 542
      development/advanced/api/index.html
  3. 370
      development/advanced/config/optional-config/index.html
  4. 361
      development/advanced/config/unattended-setup/index.html
  5. 482
      development/advanced/metrics/prometheus/index.html
  6. 362
      development/advanced/migrate/from-14-to-15/index.html
  7. 357
      development/advanced/migrate/index.html
  8. 8
      development/assets/javascripts/bundle.13a4f30d.min.js
  9. 4
      development/assets/javascripts/bundle.13a4f30d.min.js.map
  10. 4
      development/assets/javascripts/workers/search.d50fe291.min.js
  11. 2
      development/assets/javascripts/workers/search.d50fe291.min.js.map
  12. 1
      development/assets/stylesheets/main.342714a4.min.css
  13. 2
      development/assets/stylesheets/main.342714a4.min.css.map
  14. 1
      development/assets/stylesheets/main.8608ea7d.min.css
  15. 16
      development/changelog.json
  16. 360
      development/contributing/general/index.html
  17. 364
      development/contributing/issues-and-pull-requests/index.html
  18. 361
      development/examples/tutorials/adguard/index.html
  19. 421
      development/examples/tutorials/auto-updates/index.html
  20. 419
      development/examples/tutorials/basic-installation/index.html
  21. 517
      development/examples/tutorials/caddy/index.html
  22. 368
      development/examples/tutorials/docker-run/index.html
  23. 362
      development/examples/tutorials/dockerless/index.html
  24. 432
      development/examples/tutorials/podman-nft/index.html
  25. 470
      development/examples/tutorials/reverse-proxyless/index.html
  26. 713
      development/examples/tutorials/traefik/index.html
  27. 1731
      development/faq/index.html
  28. 495
      development/getting-started/index.html
  29. 1633
      development/guides/2fa/index.html
  30. 1518
      development/guides/admin/index.html
  31. 1685
      development/guides/cli/index.html
  32. 1742
      development/guides/clients/index.html
  33. 1658
      development/guides/setup/index.html
  34. 362
      development/index.html
  35. 2
      development/search/search_index.json
  36. 66
      development/sitemap.xml
  37. BIN
      development/sitemap.xml.gz

357
development/404.html

@ -16,7 +16,7 @@
<link rel="icon" href="/wg-easy/development/assets/logo/favicon.png"> <link rel="icon" href="/wg-easy/development/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">
@ -24,7 +24,7 @@
<link rel="stylesheet" href="/wg-easy/development/assets/stylesheets/main.8608ea7d.min.css"> <link rel="stylesheet" href="/wg-easy/development/assets/stylesheets/main.342714a4.min.css">
<link rel="stylesheet" href="/wg-easy/development/assets/stylesheets/palette.06af60db.min.css"> <link rel="stylesheet" href="/wg-easy/development/assets/stylesheets/palette.06af60db.min.css">
@ -142,11 +142,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 class="md-header__button md-icon" for="__search">
</label>
<div class="md-search" data-md-component="search" role="dialog"> <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> <label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search"> <div class="md-search__inner" role="search">
<form class="md-search__form" name="search"> <form class="md-search__form" name="search">
@ -178,6 +180,7 @@
</div> </div>
</div> </div>
</div> </div>
<div class="md-header__source"> <div class="md-header__source">
@ -210,10 +213,12 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="/wg-easy/development/." class="md-tabs__link"> <a href="/wg-easy/development/." class="md-tabs__link">
Home Home
@ -227,10 +232,31 @@
<li class="md-tabs__item">
<a href="/wg-easy/development/faq/" class="md-tabs__link">
FAQ
</a>
</li>
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="/wg-easy/development/getting-started/" class="md-tabs__link"> <a href="/wg-easy/development/getting-started/" class="md-tabs__link">
Getting Started Getting Started
@ -244,12 +270,14 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="/wg-easy/development/advanced/api/" class="md-tabs__link"> <a href="/wg-easy/development/advanced/api/" class="md-tabs__link">
Advanced Advanced
</a> </a>
@ -262,12 +290,14 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="/wg-easy/development/contributing/general/" class="md-tabs__link"> <a href="/wg-easy/development/contributing/general/" class="md-tabs__link">
Contributing Contributing
</a> </a>
@ -280,18 +310,21 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="/wg-easy/development/examples/tutorials/adguard/" class="md-tabs__link"> <a href="/wg-easy/development/examples/tutorials/adguard/" class="md-tabs__link">
Examples Examples
</a> </a>
@ -303,6 +336,26 @@
<li class="md-tabs__item">
<a href="/wg-easy/development/guides/2fa/" class="md-tabs__link">
Guides
</a>
</li>
</ul> </ul>
</div> </div>
</nav> </nav>
@ -357,6 +410,7 @@
<a href="/wg-easy/development/." class="md-nav__link"> <a href="/wg-easy/development/." class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Home Home
@ -374,10 +428,33 @@
<li class="md-nav__item">
<a href="/wg-easy/development/faq/" class="md-nav__link">
<span class="md-ellipsis">
FAQ
</span>
</a>
</li>
<li class="md-nav__item"> <li class="md-nav__item">
<a href="/wg-easy/development/getting-started/" class="md-nav__link"> <a href="/wg-easy/development/getting-started/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Getting Started Getting Started
@ -398,6 +475,7 @@
@ -408,12 +486,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" > <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0"> <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis"> <span class="md-ellipsis">
Advanced Advanced
@ -423,8 +502,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3"> <label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Advanced Advanced
</label> </label>
@ -440,6 +519,7 @@
<a href="/wg-easy/development/advanced/api/" class="md-nav__link"> <a href="/wg-easy/development/advanced/api/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
API API
@ -461,6 +541,7 @@
@ -471,12 +552,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"> <span class="md-ellipsis">
Config Config
@ -486,8 +568,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_2"> <label class="md-nav__title" for="__nav_4_2">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Config Config
</label> </label>
@ -503,6 +585,7 @@
<a href="/wg-easy/development/advanced/config/optional-config/" class="md-nav__link"> <a href="/wg-easy/development/advanced/config/optional-config/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Optional Configuration Optional Configuration
@ -525,6 +608,7 @@
<a href="/wg-easy/development/advanced/config/unattended-setup/" class="md-nav__link"> <a href="/wg-easy/development/advanced/config/unattended-setup/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Unattended Setup Unattended Setup
@ -554,6 +638,7 @@
@ -564,12 +649,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"> <span class="md-ellipsis">
Metrics Metrics
@ -579,8 +665,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_3_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_3"> <label class="md-nav__title" for="__nav_4_3">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Metrics Metrics
</label> </label>
@ -596,6 +682,7 @@
<a href="/wg-easy/development/advanced/metrics/prometheus/" class="md-nav__link"> <a href="/wg-easy/development/advanced/metrics/prometheus/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Prometheus Prometheus
@ -625,6 +712,7 @@
@ -635,12 +723,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"> <span class="md-ellipsis">
Migrate Migrate
@ -650,8 +739,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_4"> <label class="md-nav__title" for="__nav_4_4">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Migrate Migrate
</label> </label>
@ -667,6 +756,7 @@
<a href="/wg-easy/development/advanced/migrate/" class="md-nav__link"> <a href="/wg-easy/development/advanced/migrate/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate Migrate
@ -689,6 +779,7 @@
<a href="/wg-easy/development/advanced/migrate/from-14-to-15/" class="md-nav__link"> <a href="/wg-easy/development/advanced/migrate/from-14-to-15/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate from v14 to v15 Migrate from v14 to v15
@ -725,6 +816,7 @@
@ -735,12 +827,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"> <span class="md-ellipsis">
Contributing Contributing
@ -750,8 +843,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4"> <label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Contributing Contributing
</label> </label>
@ -767,6 +860,7 @@
<a href="/wg-easy/development/contributing/general/" class="md-nav__link"> <a href="/wg-easy/development/contributing/general/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
General Information General Information
@ -789,6 +883,7 @@
<a href="/wg-easy/development/contributing/issues-and-pull-requests/" class="md-nav__link"> <a href="/wg-easy/development/contributing/issues-and-pull-requests/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Issues and Pull Requests Issues and Pull Requests
@ -817,6 +912,7 @@
@ -827,12 +923,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"> <span class="md-ellipsis">
Examples Examples
@ -842,8 +939,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5"> <label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Examples Examples
</label> </label>
@ -858,6 +955,7 @@
@ -868,12 +966,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"> <span class="md-ellipsis">
Tutorials Tutorials
@ -883,8 +982,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_1_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5_1"> <label class="md-nav__title" for="__nav_6_1">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Tutorials Tutorials
</label> </label>
@ -900,6 +999,7 @@
<a href="/wg-easy/development/examples/tutorials/adguard/" class="md-nav__link"> <a href="/wg-easy/development/examples/tutorials/adguard/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
AdGuard Home AdGuard Home
@ -922,6 +1022,7 @@
<a href="/wg-easy/development/examples/tutorials/auto-updates/" class="md-nav__link"> <a href="/wg-easy/development/examples/tutorials/auto-updates/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Auto Updates Auto Updates
@ -944,6 +1045,7 @@
<a href="/wg-easy/development/examples/tutorials/basic-installation/" class="md-nav__link"> <a href="/wg-easy/development/examples/tutorials/basic-installation/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Basic Installation Basic Installation
@ -966,6 +1068,7 @@
<a href="/wg-easy/development/examples/tutorials/caddy/" class="md-nav__link"> <a href="/wg-easy/development/examples/tutorials/caddy/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Caddy Caddy
@ -988,6 +1091,7 @@
<a href="/wg-easy/development/examples/tutorials/docker-run/" class="md-nav__link"> <a href="/wg-easy/development/examples/tutorials/docker-run/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Docker Run Docker Run
@ -1010,6 +1114,7 @@
<a href="/wg-easy/development/examples/tutorials/dockerless/" class="md-nav__link"> <a href="/wg-easy/development/examples/tutorials/dockerless/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Without Docker Without Docker
@ -1029,11 +1134,12 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="/wg-easy/development/examples/tutorials/nginx/" class="md-nav__link"> <a href="/wg-easy/development/examples/tutorials/podman-nft/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
NGINX Podman + nftables
</span> </span>
@ -1051,11 +1157,12 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="/wg-easy/development/examples/tutorials/podman/" class="md-nav__link"> <a href="/wg-easy/development/examples/tutorials/reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Podman No Reverse Proxy
</span> </span>
@ -1076,6 +1183,7 @@
<a href="/wg-easy/development/examples/tutorials/traefik/" class="md-nav__link"> <a href="/wg-easy/development/examples/tutorials/traefik/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Traefik Traefik
@ -1103,6 +1211,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="/wg-easy/development/guides/2fa/" class="md-nav__link">
<span class="md-ellipsis">
2FA
</span>
</a>
</li>
<li class="md-nav__item">
<a href="/wg-easy/development/guides/admin/" class="md-nav__link">
<span class="md-ellipsis">
Admin Panel
</span>
</a>
</li>
<li class="md-nav__item">
<a href="/wg-easy/development/guides/cli/" class="md-nav__link">
<span class="md-ellipsis">
CLI
</span>
</a>
</li>
<li class="md-nav__item">
<a href="/wg-easy/development/guides/clients/" class="md-nav__link">
<span class="md-ellipsis">
Edit Client
</span>
</a>
</li>
<li class="md-nav__item">
<a href="/wg-easy/development/guides/setup/" class="md-nav__link">
<span class="md-ellipsis">
Setup
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul> </ul>
</nav> </nav>
</div> </div>
@ -1177,10 +1450,12 @@
</div> </div>
<script id="__config" type="application/json">{"base": "/wg-easy/development", "features": ["navigation.tabs", "navigation.top", "navigation.expand", "navigation.instant", "content.action.edit", "content.action.view", "content.code.annotate"], "search": "/wg-easy/development/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": "/wg-easy/development", "features": ["navigation.tabs", "navigation.top", "navigation.expand", "navigation.instant", "content.action.edit", "content.action.view", "content.code.annotate"], "search": "/wg-easy/development/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="/wg-easy/development/assets/javascripts/bundle.c8b220af.min.js"></script> <script src="/wg-easy/development/assets/javascripts/bundle.13a4f30d.min.js"></script>
</body> </body>

542
development/advanced/api/index.html

@ -22,7 +22,7 @@
<link rel="icon" href="../../assets/logo/favicon.png"> <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"> <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
@ -77,6 +77,11 @@
<label class="md-overlay" for="__drawer"></label> <label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip"> <div data-md-component="skip">
<a href="#authentication" class="md-skip">
Skip to content
</a>
</div> </div>
<div data-md-component="announce"> <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 class="md-header__button md-icon" for="__search">
</label>
<div class="md-search" data-md-component="search" role="dialog"> <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> <label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search"> <div class="md-search__inner" role="search">
<form class="md-search__form" name="search"> <form class="md-search__form" name="search">
@ -184,6 +191,7 @@
</div> </div>
</div> </div>
</div> </div>
<div class="md-header__source"> <div class="md-header__source">
@ -216,10 +224,12 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../.." class="md-tabs__link"> <a href="../.." class="md-tabs__link">
Home 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"> <li class="md-tabs__item">
<a href="../../getting-started/" class="md-tabs__link"> <a href="../../getting-started/" class="md-tabs__link">
Getting Started Getting Started
@ -249,6 +280,7 @@
@ -258,6 +290,7 @@
<a href="./" class="md-tabs__link"> <a href="./" class="md-tabs__link">
Advanced Advanced
</a> </a>
@ -270,12 +303,14 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../contributing/general/" class="md-tabs__link"> <a href="../../contributing/general/" class="md-tabs__link">
Contributing Contributing
</a> </a>
@ -288,18 +323,21 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../examples/tutorials/adguard/" class="md-tabs__link"> <a href="../../examples/tutorials/adguard/" class="md-tabs__link">
Examples Examples
</a> </a>
@ -311,6 +349,26 @@
<li class="md-tabs__item">
<a href="../../guides/2fa/" class="md-tabs__link">
Guides
</a>
</li>
</ul> </ul>
</div> </div>
</nav> </nav>
@ -365,6 +423,7 @@
<a href="../.." class="md-nav__link"> <a href="../.." class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Home 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"> <li class="md-nav__item">
<a href="../../getting-started/" class="md-nav__link"> <a href="../../getting-started/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Getting Started 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"> <span class="md-ellipsis">
Advanced Advanced
@ -434,8 +518,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3"> <label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Advanced Advanced
</label> </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"> <a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis"> <span class="md-ellipsis">
API API
@ -466,6 +564,71 @@
</a> </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> </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"> <span class="md-ellipsis">
Config Config
@ -505,8 +670,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_2"> <label class="md-nav__title" for="__nav_4_2">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Config Config
</label> </label>
@ -522,6 +687,7 @@
<a href="../config/optional-config/" class="md-nav__link"> <a href="../config/optional-config/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Optional Configuration Optional Configuration
@ -544,6 +710,7 @@
<a href="../config/unattended-setup/" class="md-nav__link"> <a href="../config/unattended-setup/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Unattended Setup 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"> <span class="md-ellipsis">
Metrics Metrics
@ -598,8 +767,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_3_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_3"> <label class="md-nav__title" for="__nav_4_3">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Metrics Metrics
</label> </label>
@ -615,6 +784,7 @@
<a href="../metrics/prometheus/" class="md-nav__link"> <a href="../metrics/prometheus/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Prometheus 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"> <span class="md-ellipsis">
Migrate Migrate
@ -669,8 +841,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_4"> <label class="md-nav__title" for="__nav_4_4">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Migrate Migrate
</label> </label>
@ -686,6 +858,7 @@
<a href="../migrate/" class="md-nav__link"> <a href="../migrate/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate Migrate
@ -708,6 +881,7 @@
<a href="../migrate/from-14-to-15/" class="md-nav__link"> <a href="../migrate/from-14-to-15/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate from v14 to v15 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"> <span class="md-ellipsis">
Contributing Contributing
@ -769,8 +945,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4"> <label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Contributing Contributing
</label> </label>
@ -786,6 +962,7 @@
<a href="../../contributing/general/" class="md-nav__link"> <a href="../../contributing/general/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
General Information General Information
@ -808,6 +985,7 @@
<a href="../../contributing/issues-and-pull-requests/" class="md-nav__link"> <a href="../../contributing/issues-and-pull-requests/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Issues and Pull Requests 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"> <span class="md-ellipsis">
Examples Examples
@ -861,8 +1041,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5"> <label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Examples Examples
</label> </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"> <span class="md-ellipsis">
Tutorials Tutorials
@ -902,8 +1084,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_1_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5_1"> <label class="md-nav__title" for="__nav_6_1">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Tutorials Tutorials
</label> </label>
@ -919,6 +1101,7 @@
<a href="../../examples/tutorials/adguard/" class="md-nav__link"> <a href="../../examples/tutorials/adguard/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
AdGuard Home AdGuard Home
@ -941,6 +1124,7 @@
<a href="../../examples/tutorials/auto-updates/" class="md-nav__link"> <a href="../../examples/tutorials/auto-updates/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Auto Updates Auto Updates
@ -963,6 +1147,7 @@
<a href="../../examples/tutorials/basic-installation/" class="md-nav__link"> <a href="../../examples/tutorials/basic-installation/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Basic Installation Basic Installation
@ -985,6 +1170,7 @@
<a href="../../examples/tutorials/caddy/" class="md-nav__link"> <a href="../../examples/tutorials/caddy/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Caddy Caddy
@ -1007,6 +1193,7 @@
<a href="../../examples/tutorials/docker-run/" class="md-nav__link"> <a href="../../examples/tutorials/docker-run/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Docker Run Docker Run
@ -1029,6 +1216,7 @@
<a href="../../examples/tutorials/dockerless/" class="md-nav__link"> <a href="../../examples/tutorials/dockerless/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Without Docker Without Docker
@ -1048,11 +1236,12 @@
<li class="md-nav__item"> <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"> <span class="md-ellipsis">
NGINX Podman + nftables
</span> </span>
@ -1070,11 +1259,12 @@
<li class="md-nav__item"> <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"> <span class="md-ellipsis">
Podman No Reverse Proxy
</span> </span>
@ -1095,6 +1285,7 @@
<a href="../../examples/tutorials/traefik/" class="md-nav__link"> <a href="../../examples/tutorials/traefik/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Traefik 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> </ul>
</nav> </nav>
</div> </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> </nav>
</div> </div>
</div> </div>
@ -1172,7 +1584,51 @@
<h1>API</h1> <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> </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> </body>

370
development/advanced/config/optional-config/index.html

@ -22,7 +22,7 @@
<link rel="icon" href="../../../assets/logo/favicon.png"> <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"> <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 class="md-header__button md-icon" for="__search">
</label>
<div class="md-search" data-md-component="search" role="dialog"> <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> <label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search"> <div class="md-search__inner" role="search">
<form class="md-search__form" name="search"> <form class="md-search__form" name="search">
@ -184,6 +186,7 @@
</div> </div>
</div> </div>
</div> </div>
<div class="md-header__source"> <div class="md-header__source">
@ -216,10 +219,12 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../.." class="md-tabs__link"> <a href="../../.." class="md-tabs__link">
Home 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"> <li class="md-tabs__item">
<a href="../../../getting-started/" class="md-tabs__link"> <a href="../../../getting-started/" class="md-tabs__link">
Getting Started Getting Started
@ -249,6 +275,7 @@
@ -258,6 +285,7 @@
<a href="../../api/" class="md-tabs__link"> <a href="../../api/" class="md-tabs__link">
Advanced Advanced
</a> </a>
@ -270,12 +298,14 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../../contributing/general/" class="md-tabs__link"> <a href="../../../contributing/general/" class="md-tabs__link">
Contributing Contributing
</a> </a>
@ -288,18 +318,21 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../../examples/tutorials/adguard/" class="md-tabs__link"> <a href="../../../examples/tutorials/adguard/" class="md-tabs__link">
Examples Examples
</a> </a>
@ -311,6 +344,26 @@
<li class="md-tabs__item">
<a href="../../../guides/2fa/" class="md-tabs__link">
Guides
</a>
</li>
</ul> </ul>
</div> </div>
</nav> </nav>
@ -365,6 +418,7 @@
<a href="../../.." class="md-nav__link"> <a href="../../.." class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Home 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"> <li class="md-nav__item">
<a href="../../../getting-started/" class="md-nav__link"> <a href="../../../getting-started/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Getting Started 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"> <span class="md-ellipsis">
Advanced Advanced
@ -434,8 +513,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3"> <label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Advanced Advanced
</label> </label>
@ -451,6 +530,7 @@
<a href="../../api/" class="md-nav__link"> <a href="../../api/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
API 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"> <span class="md-ellipsis">
Config Config
@ -497,8 +579,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="true"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3_2"> <label class="md-nav__title" for="__nav_4_2">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Config Config
</label> </label>
@ -521,6 +603,7 @@
<a href="./" class="md-nav__link md-nav__link--active"> <a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis"> <span class="md-ellipsis">
Optional Configuration Optional Configuration
@ -544,6 +627,7 @@
<a href="../unattended-setup/" class="md-nav__link"> <a href="../unattended-setup/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Unattended Setup 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"> <span class="md-ellipsis">
Metrics Metrics
@ -598,8 +684,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_3_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_3"> <label class="md-nav__title" for="__nav_4_3">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Metrics Metrics
</label> </label>
@ -615,6 +701,7 @@
<a href="../../metrics/prometheus/" class="md-nav__link"> <a href="../../metrics/prometheus/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Prometheus 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"> <span class="md-ellipsis">
Migrate Migrate
@ -669,8 +758,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_4"> <label class="md-nav__title" for="__nav_4_4">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Migrate Migrate
</label> </label>
@ -686,6 +775,7 @@
<a href="../../migrate/" class="md-nav__link"> <a href="../../migrate/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate Migrate
@ -708,6 +798,7 @@
<a href="../../migrate/from-14-to-15/" class="md-nav__link"> <a href="../../migrate/from-14-to-15/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate from v14 to v15 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"> <span class="md-ellipsis">
Contributing Contributing
@ -769,8 +862,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4"> <label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Contributing Contributing
</label> </label>
@ -786,6 +879,7 @@
<a href="../../../contributing/general/" class="md-nav__link"> <a href="../../../contributing/general/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
General Information General Information
@ -808,6 +902,7 @@
<a href="../../../contributing/issues-and-pull-requests/" class="md-nav__link"> <a href="../../../contributing/issues-and-pull-requests/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Issues and Pull Requests 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"> <span class="md-ellipsis">
Examples Examples
@ -861,8 +958,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5"> <label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Examples Examples
</label> </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"> <span class="md-ellipsis">
Tutorials Tutorials
@ -902,8 +1001,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_1_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5_1"> <label class="md-nav__title" for="__nav_6_1">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Tutorials Tutorials
</label> </label>
@ -919,6 +1018,7 @@
<a href="../../../examples/tutorials/adguard/" class="md-nav__link"> <a href="../../../examples/tutorials/adguard/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
AdGuard Home AdGuard Home
@ -941,6 +1041,7 @@
<a href="../../../examples/tutorials/auto-updates/" class="md-nav__link"> <a href="../../../examples/tutorials/auto-updates/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Auto Updates Auto Updates
@ -963,6 +1064,7 @@
<a href="../../../examples/tutorials/basic-installation/" class="md-nav__link"> <a href="../../../examples/tutorials/basic-installation/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Basic Installation Basic Installation
@ -985,6 +1087,7 @@
<a href="../../../examples/tutorials/caddy/" class="md-nav__link"> <a href="../../../examples/tutorials/caddy/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Caddy Caddy
@ -1007,6 +1110,7 @@
<a href="../../../examples/tutorials/docker-run/" class="md-nav__link"> <a href="../../../examples/tutorials/docker-run/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Docker Run Docker Run
@ -1029,6 +1133,7 @@
<a href="../../../examples/tutorials/dockerless/" class="md-nav__link"> <a href="../../../examples/tutorials/dockerless/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Without Docker Without Docker
@ -1048,11 +1153,12 @@
<li class="md-nav__item"> <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"> <span class="md-ellipsis">
NGINX Podman + nftables
</span> </span>
@ -1070,11 +1176,12 @@
<li class="md-nav__item"> <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"> <span class="md-ellipsis">
Podman No Reverse Proxy
</span> </span>
@ -1095,6 +1202,7 @@
<a href="../../../examples/tutorials/traefik/" class="md-nav__link"> <a href="../../../examples/tutorials/traefik/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Traefik 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> </ul>
</nav> </nav>
</div> </div>
@ -1172,7 +1445,7 @@
<h1>Optional Configuration</h1> <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> <table>
<thead> <thead>
<tr> <tr>
@ -1201,8 +1474,19 @@
<td><code>true</code></td> <td><code>true</code></td>
<td>If access over http is allowed</td> <td>If access over http is allowed</td>
</tr> </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> </tbody>
</table> </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> </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> </body>

361
development/advanced/config/unattended-setup/index.html

@ -22,7 +22,7 @@
<link rel="icon" href="../../../assets/logo/favicon.png"> <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"> <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 class="md-header__button md-icon" for="__search">
</label>
<div class="md-search" data-md-component="search" role="dialog"> <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> <label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search"> <div class="md-search__inner" role="search">
<form class="md-search__form" name="search"> <form class="md-search__form" name="search">
@ -184,6 +186,7 @@
</div> </div>
</div> </div>
</div> </div>
<div class="md-header__source"> <div class="md-header__source">
@ -216,10 +219,12 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../.." class="md-tabs__link"> <a href="../../.." class="md-tabs__link">
Home 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"> <li class="md-tabs__item">
<a href="../../../getting-started/" class="md-tabs__link"> <a href="../../../getting-started/" class="md-tabs__link">
Getting Started Getting Started
@ -249,6 +275,7 @@
@ -258,6 +285,7 @@
<a href="../../api/" class="md-tabs__link"> <a href="../../api/" class="md-tabs__link">
Advanced Advanced
</a> </a>
@ -270,12 +298,14 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../../contributing/general/" class="md-tabs__link"> <a href="../../../contributing/general/" class="md-tabs__link">
Contributing Contributing
</a> </a>
@ -288,18 +318,21 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../../examples/tutorials/adguard/" class="md-tabs__link"> <a href="../../../examples/tutorials/adguard/" class="md-tabs__link">
Examples Examples
</a> </a>
@ -311,6 +344,26 @@
<li class="md-tabs__item">
<a href="../../../guides/2fa/" class="md-tabs__link">
Guides
</a>
</li>
</ul> </ul>
</div> </div>
</nav> </nav>
@ -365,6 +418,7 @@
<a href="../../.." class="md-nav__link"> <a href="../../.." class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Home 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"> <li class="md-nav__item">
<a href="../../../getting-started/" class="md-nav__link"> <a href="../../../getting-started/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Getting Started 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"> <span class="md-ellipsis">
Advanced Advanced
@ -434,8 +513,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3"> <label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Advanced Advanced
</label> </label>
@ -451,6 +530,7 @@
<a href="../../api/" class="md-nav__link"> <a href="../../api/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
API 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"> <span class="md-ellipsis">
Config Config
@ -497,8 +579,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="true"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3_2"> <label class="md-nav__title" for="__nav_4_2">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Config Config
</label> </label>
@ -514,6 +596,7 @@
<a href="../optional-config/" class="md-nav__link"> <a href="../optional-config/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Optional Configuration Optional Configuration
@ -543,6 +626,7 @@
<a href="./" class="md-nav__link md-nav__link--active"> <a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis"> <span class="md-ellipsis">
Unattended Setup 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"> <span class="md-ellipsis">
Metrics Metrics
@ -598,8 +684,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_3_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_3"> <label class="md-nav__title" for="__nav_4_3">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Metrics Metrics
</label> </label>
@ -615,6 +701,7 @@
<a href="../../metrics/prometheus/" class="md-nav__link"> <a href="../../metrics/prometheus/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Prometheus 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"> <span class="md-ellipsis">
Migrate Migrate
@ -669,8 +758,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_4"> <label class="md-nav__title" for="__nav_4_4">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Migrate Migrate
</label> </label>
@ -686,6 +775,7 @@
<a href="../../migrate/" class="md-nav__link"> <a href="../../migrate/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate Migrate
@ -708,6 +798,7 @@
<a href="../../migrate/from-14-to-15/" class="md-nav__link"> <a href="../../migrate/from-14-to-15/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate from v14 to v15 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"> <span class="md-ellipsis">
Contributing Contributing
@ -769,8 +862,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4"> <label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Contributing Contributing
</label> </label>
@ -786,6 +879,7 @@
<a href="../../../contributing/general/" class="md-nav__link"> <a href="../../../contributing/general/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
General Information General Information
@ -808,6 +902,7 @@
<a href="../../../contributing/issues-and-pull-requests/" class="md-nav__link"> <a href="../../../contributing/issues-and-pull-requests/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Issues and Pull Requests 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"> <span class="md-ellipsis">
Examples Examples
@ -861,8 +958,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5"> <label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Examples Examples
</label> </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"> <span class="md-ellipsis">
Tutorials Tutorials
@ -902,8 +1001,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_1_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5_1"> <label class="md-nav__title" for="__nav_6_1">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Tutorials Tutorials
</label> </label>
@ -919,6 +1018,7 @@
<a href="../../../examples/tutorials/adguard/" class="md-nav__link"> <a href="../../../examples/tutorials/adguard/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
AdGuard Home AdGuard Home
@ -941,6 +1041,7 @@
<a href="../../../examples/tutorials/auto-updates/" class="md-nav__link"> <a href="../../../examples/tutorials/auto-updates/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Auto Updates Auto Updates
@ -963,6 +1064,7 @@
<a href="../../../examples/tutorials/basic-installation/" class="md-nav__link"> <a href="../../../examples/tutorials/basic-installation/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Basic Installation Basic Installation
@ -985,6 +1087,7 @@
<a href="../../../examples/tutorials/caddy/" class="md-nav__link"> <a href="../../../examples/tutorials/caddy/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Caddy Caddy
@ -1007,6 +1110,7 @@
<a href="../../../examples/tutorials/docker-run/" class="md-nav__link"> <a href="../../../examples/tutorials/docker-run/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Docker Run Docker Run
@ -1029,6 +1133,7 @@
<a href="../../../examples/tutorials/dockerless/" class="md-nav__link"> <a href="../../../examples/tutorials/dockerless/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Without Docker Without Docker
@ -1048,11 +1153,12 @@
<li class="md-nav__item"> <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"> <span class="md-ellipsis">
NGINX Podman + nftables
</span> </span>
@ -1070,11 +1176,12 @@
<li class="md-nav__item"> <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"> <span class="md-ellipsis">
Podman No Reverse Proxy
</span> </span>
@ -1095,6 +1202,7 @@
<a href="../../../examples/tutorials/traefik/" class="md-nav__link"> <a href="../../../examples/tutorials/traefik/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Traefik 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> </ul>
</nav> </nav>
</div> </div>
@ -1241,8 +1514,8 @@
</div> </div>
<div class="admonition note"> <div class="admonition note">
<p class="admonition-title">Security</p> <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>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>Its recommended to remove the variables after the setup is done to prevent the password from being exposed.</p> <p>It's recommended to remove the variables after the setup is done to prevent the password from being exposed.</p>
</div> </div>
@ -1304,10 +1577,12 @@
</div> </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> </body>

482
development/advanced/metrics/prometheus/index.html

@ -22,7 +22,7 @@
<link rel="icon" href="../../../assets/logo/favicon.png"> <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"> <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
@ -77,6 +77,11 @@
<label class="md-overlay" for="__drawer"></label> <label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip"> <div data-md-component="skip">
<a href="#enable-prometheus" class="md-skip">
Skip to content
</a>
</div> </div>
<div data-md-component="announce"> <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 class="md-header__button md-icon" for="__search">
</label>
<div class="md-search" data-md-component="search" role="dialog"> <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> <label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search"> <div class="md-search__inner" role="search">
<form class="md-search__form" name="search"> <form class="md-search__form" name="search">
@ -184,6 +191,7 @@
</div> </div>
</div> </div>
</div> </div>
<div class="md-header__source"> <div class="md-header__source">
@ -216,10 +224,12 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../.." class="md-tabs__link"> <a href="../../.." class="md-tabs__link">
Home 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"> <li class="md-tabs__item">
<a href="../../../getting-started/" class="md-tabs__link"> <a href="../../../getting-started/" class="md-tabs__link">
Getting Started Getting Started
@ -249,6 +280,7 @@
@ -258,6 +290,7 @@
<a href="../../api/" class="md-tabs__link"> <a href="../../api/" class="md-tabs__link">
Advanced Advanced
</a> </a>
@ -270,12 +303,14 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../../contributing/general/" class="md-tabs__link"> <a href="../../../contributing/general/" class="md-tabs__link">
Contributing Contributing
</a> </a>
@ -288,18 +323,21 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../../examples/tutorials/adguard/" class="md-tabs__link"> <a href="../../../examples/tutorials/adguard/" class="md-tabs__link">
Examples Examples
</a> </a>
@ -311,6 +349,26 @@
<li class="md-tabs__item">
<a href="../../../guides/2fa/" class="md-tabs__link">
Guides
</a>
</li>
</ul> </ul>
</div> </div>
</nav> </nav>
@ -365,6 +423,7 @@
<a href="../../.." class="md-nav__link"> <a href="../../.." class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Home 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"> <li class="md-nav__item">
<a href="../../../getting-started/" class="md-nav__link"> <a href="../../../getting-started/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Getting Started 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"> <span class="md-ellipsis">
Advanced Advanced
@ -434,8 +518,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3"> <label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Advanced Advanced
</label> </label>
@ -451,6 +535,7 @@
<a href="../../api/" class="md-nav__link"> <a href="../../api/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
API 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"> <span class="md-ellipsis">
Config Config
@ -497,8 +584,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_2"> <label class="md-nav__title" for="__nav_4_2">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Config Config
</label> </label>
@ -514,6 +601,7 @@
<a href="../../config/optional-config/" class="md-nav__link"> <a href="../../config/optional-config/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Optional Configuration Optional Configuration
@ -536,6 +624,7 @@
<a href="../../config/unattended-setup/" class="md-nav__link"> <a href="../../config/unattended-setup/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Unattended Setup 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"> <span class="md-ellipsis">
Metrics Metrics
@ -590,8 +681,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_3_label" aria-expanded="true"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3_3"> <label class="md-nav__title" for="__nav_4_3">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Metrics Metrics
</label> </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"> <a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis"> <span class="md-ellipsis">
Prometheus Prometheus
@ -622,6 +727,50 @@
</a> </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> </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"> <span class="md-ellipsis">
Migrate Migrate
@ -669,8 +820,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_4"> <label class="md-nav__title" for="__nav_4_4">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Migrate Migrate
</label> </label>
@ -686,6 +837,7 @@
<a href="../../migrate/" class="md-nav__link"> <a href="../../migrate/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate Migrate
@ -708,6 +860,7 @@
<a href="../../migrate/from-14-to-15/" class="md-nav__link"> <a href="../../migrate/from-14-to-15/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate from v14 to v15 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"> <span class="md-ellipsis">
Contributing Contributing
@ -769,8 +924,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4"> <label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Contributing Contributing
</label> </label>
@ -786,6 +941,7 @@
<a href="../../../contributing/general/" class="md-nav__link"> <a href="../../../contributing/general/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
General Information General Information
@ -808,6 +964,7 @@
<a href="../../../contributing/issues-and-pull-requests/" class="md-nav__link"> <a href="../../../contributing/issues-and-pull-requests/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Issues and Pull Requests 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"> <span class="md-ellipsis">
Examples Examples
@ -861,8 +1020,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5"> <label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Examples Examples
</label> </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"> <span class="md-ellipsis">
Tutorials Tutorials
@ -902,8 +1063,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_1_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5_1"> <label class="md-nav__title" for="__nav_6_1">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Tutorials Tutorials
</label> </label>
@ -919,6 +1080,7 @@
<a href="../../../examples/tutorials/adguard/" class="md-nav__link"> <a href="../../../examples/tutorials/adguard/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
AdGuard Home AdGuard Home
@ -941,6 +1103,7 @@
<a href="../../../examples/tutorials/auto-updates/" class="md-nav__link"> <a href="../../../examples/tutorials/auto-updates/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Auto Updates Auto Updates
@ -963,6 +1126,7 @@
<a href="../../../examples/tutorials/basic-installation/" class="md-nav__link"> <a href="../../../examples/tutorials/basic-installation/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Basic Installation Basic Installation
@ -985,6 +1149,7 @@
<a href="../../../examples/tutorials/caddy/" class="md-nav__link"> <a href="../../../examples/tutorials/caddy/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Caddy Caddy
@ -1007,6 +1172,7 @@
<a href="../../../examples/tutorials/docker-run/" class="md-nav__link"> <a href="../../../examples/tutorials/docker-run/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Docker Run Docker Run
@ -1029,6 +1195,7 @@
<a href="../../../examples/tutorials/dockerless/" class="md-nav__link"> <a href="../../../examples/tutorials/dockerless/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Without Docker Without Docker
@ -1048,11 +1215,12 @@
<li class="md-nav__item"> <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"> <span class="md-ellipsis">
NGINX Podman + nftables
</span> </span>
@ -1070,11 +1238,12 @@
<li class="md-nav__item"> <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"> <span class="md-ellipsis">
Podman No Reverse Proxy
</span> </span>
@ -1095,6 +1264,7 @@
<a href="../../../examples/tutorials/traefik/" class="md-nav__link"> <a href="../../../examples/tutorials/traefik/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Traefik 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> </ul>
</nav> </nav>
</div> </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> </nav>
</div> </div>
</div> </div>
@ -1172,8 +1542,32 @@
<h1>Prometheus</h1> <h1>Prometheus</h1>
<p>TODO</p> <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>
<!-- TOOD: add to docs: Grafana dashboard [21733](https://grafana.com/grafana/dashboards/21733-wireguard/) --> <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> </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> </body>

362
development/advanced/migrate/from-14-to-15/index.html

@ -22,7 +22,7 @@
<link rel="icon" href="../../../assets/logo/favicon.png"> <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"> <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 class="md-header__button md-icon" for="__search">
</label>
<div class="md-search" data-md-component="search" role="dialog"> <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> <label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search"> <div class="md-search__inner" role="search">
<form class="md-search__form" name="search"> <form class="md-search__form" name="search">
@ -189,6 +191,7 @@
</div> </div>
</div> </div>
</div> </div>
<div class="md-header__source"> <div class="md-header__source">
@ -221,10 +224,12 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../.." class="md-tabs__link"> <a href="../../.." class="md-tabs__link">
Home 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"> <li class="md-tabs__item">
<a href="../../../getting-started/" class="md-tabs__link"> <a href="../../../getting-started/" class="md-tabs__link">
Getting Started Getting Started
@ -254,6 +280,7 @@
@ -263,6 +290,7 @@
<a href="../../api/" class="md-tabs__link"> <a href="../../api/" class="md-tabs__link">
Advanced Advanced
</a> </a>
@ -275,12 +303,14 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../../contributing/general/" class="md-tabs__link"> <a href="../../../contributing/general/" class="md-tabs__link">
Contributing Contributing
</a> </a>
@ -293,18 +323,21 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../../examples/tutorials/adguard/" class="md-tabs__link"> <a href="../../../examples/tutorials/adguard/" class="md-tabs__link">
Examples Examples
</a> </a>
@ -316,6 +349,26 @@
<li class="md-tabs__item">
<a href="../../../guides/2fa/" class="md-tabs__link">
Guides
</a>
</li>
</ul> </ul>
</div> </div>
</nav> </nav>
@ -370,6 +423,7 @@
<a href="../../.." class="md-nav__link"> <a href="../../.." class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Home 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"> <li class="md-nav__item">
<a href="../../../getting-started/" class="md-nav__link"> <a href="../../../getting-started/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Getting Started 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"> <span class="md-ellipsis">
Advanced Advanced
@ -439,8 +518,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3"> <label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Advanced Advanced
</label> </label>
@ -456,6 +535,7 @@
<a href="../../api/" class="md-nav__link"> <a href="../../api/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
API 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"> <span class="md-ellipsis">
Config Config
@ -502,8 +584,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_2"> <label class="md-nav__title" for="__nav_4_2">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Config Config
</label> </label>
@ -519,6 +601,7 @@
<a href="../../config/optional-config/" class="md-nav__link"> <a href="../../config/optional-config/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Optional Configuration Optional Configuration
@ -541,6 +624,7 @@
<a href="../../config/unattended-setup/" class="md-nav__link"> <a href="../../config/unattended-setup/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Unattended Setup 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"> <span class="md-ellipsis">
Metrics Metrics
@ -595,8 +681,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_3_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_3"> <label class="md-nav__title" for="__nav_4_3">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Metrics Metrics
</label> </label>
@ -612,6 +698,7 @@
<a href="../../metrics/prometheus/" class="md-nav__link"> <a href="../../metrics/prometheus/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Prometheus 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"> <span class="md-ellipsis">
Migrate Migrate
@ -666,8 +755,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="true"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3_4"> <label class="md-nav__title" for="__nav_4_4">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Migrate Migrate
</label> </label>
@ -683,6 +772,7 @@
<a href="../" class="md-nav__link"> <a href="../" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate Migrate
@ -712,6 +802,7 @@
<label class="md-nav__link md-nav__link--active" for="__toc"> <label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate from v14 to v15 Migrate from v14 to v15
@ -724,6 +815,7 @@
<a href="./" class="md-nav__link md-nav__link--active"> <a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate from v14 to v15 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"> <span class="md-ellipsis">
Contributing Contributing
@ -863,8 +957,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4"> <label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Contributing Contributing
</label> </label>
@ -880,6 +974,7 @@
<a href="../../../contributing/general/" class="md-nav__link"> <a href="../../../contributing/general/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
General Information General Information
@ -902,6 +997,7 @@
<a href="../../../contributing/issues-and-pull-requests/" class="md-nav__link"> <a href="../../../contributing/issues-and-pull-requests/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Issues and Pull Requests 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"> <span class="md-ellipsis">
Examples Examples
@ -955,8 +1053,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5"> <label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Examples Examples
</label> </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"> <span class="md-ellipsis">
Tutorials Tutorials
@ -996,8 +1096,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_1_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5_1"> <label class="md-nav__title" for="__nav_6_1">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Tutorials Tutorials
</label> </label>
@ -1013,6 +1113,7 @@
<a href="../../../examples/tutorials/adguard/" class="md-nav__link"> <a href="../../../examples/tutorials/adguard/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
AdGuard Home AdGuard Home
@ -1035,6 +1136,7 @@
<a href="../../../examples/tutorials/auto-updates/" class="md-nav__link"> <a href="../../../examples/tutorials/auto-updates/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Auto Updates Auto Updates
@ -1057,6 +1159,7 @@
<a href="../../../examples/tutorials/basic-installation/" class="md-nav__link"> <a href="../../../examples/tutorials/basic-installation/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Basic Installation Basic Installation
@ -1079,6 +1182,7 @@
<a href="../../../examples/tutorials/caddy/" class="md-nav__link"> <a href="../../../examples/tutorials/caddy/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Caddy Caddy
@ -1101,6 +1205,7 @@
<a href="../../../examples/tutorials/docker-run/" class="md-nav__link"> <a href="../../../examples/tutorials/docker-run/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Docker Run Docker Run
@ -1123,6 +1228,7 @@
<a href="../../../examples/tutorials/dockerless/" class="md-nav__link"> <a href="../../../examples/tutorials/dockerless/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Without Docker Without Docker
@ -1142,11 +1248,12 @@
<li class="md-nav__item"> <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"> <span class="md-ellipsis">
NGINX Podman + nftables
</span> </span>
@ -1164,11 +1271,12 @@
<li class="md-nav__item"> <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"> <span class="md-ellipsis">
Podman No Reverse Proxy
</span> </span>
@ -1189,6 +1297,7 @@
<a href="../../../examples/tutorials/traefik/" class="md-nav__link"> <a href="../../../examples/tutorials/traefik/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Traefik 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> </ul>
</nav> </nav>
</div> </div>
@ -1338,7 +1612,7 @@
<h2 id="changes"><a class="toclink" href="#changes">Changes</a></h2> <h2 id="changes"><a class="toclink" href="#changes">Changes</a></h2>
<ul> <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>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> <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> </ul>
<h2 id="migration"><a class="toclink" href="#migration">Migration</a></h2> <h2 id="migration"><a class="toclink" href="#migration">Migration</a></h2>
@ -1359,7 +1633,7 @@
</code></pre></div> </code></pre></div>
<h3 id="start-new-container"><a class="toclink" href="#start-new-container">Start new container</a></h3> <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>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> <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> <p>You have now successfully migrated to <code>v15</code> of <code>wg-easy</code>.</p>
@ -1422,10 +1696,12 @@
</div> </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> </body>

357
development/advanced/migrate/index.html

@ -22,7 +22,7 @@
<link rel="icon" href="../../assets/logo/favicon.png"> <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"> <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 class="md-header__button md-icon" for="__search">
</label>
<div class="md-search" data-md-component="search" role="dialog"> <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> <label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search"> <div class="md-search__inner" role="search">
<form class="md-search__form" name="search"> <form class="md-search__form" name="search">
@ -184,6 +186,7 @@
</div> </div>
</div> </div>
</div> </div>
<div class="md-header__source"> <div class="md-header__source">
@ -216,10 +219,12 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../.." class="md-tabs__link"> <a href="../.." class="md-tabs__link">
Home 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"> <li class="md-tabs__item">
<a href="../../getting-started/" class="md-tabs__link"> <a href="../../getting-started/" class="md-tabs__link">
Getting Started Getting Started
@ -249,6 +275,7 @@
@ -258,6 +285,7 @@
<a href="../api/" class="md-tabs__link"> <a href="../api/" class="md-tabs__link">
Advanced Advanced
</a> </a>
@ -270,12 +298,14 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../contributing/general/" class="md-tabs__link"> <a href="../../contributing/general/" class="md-tabs__link">
Contributing Contributing
</a> </a>
@ -288,18 +318,21 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../examples/tutorials/adguard/" class="md-tabs__link"> <a href="../../examples/tutorials/adguard/" class="md-tabs__link">
Examples Examples
</a> </a>
@ -311,6 +344,26 @@
<li class="md-tabs__item">
<a href="../../guides/2fa/" class="md-tabs__link">
Guides
</a>
</li>
</ul> </ul>
</div> </div>
</nav> </nav>
@ -365,6 +418,7 @@
<a href="../.." class="md-nav__link"> <a href="../.." class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Home 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"> <li class="md-nav__item">
<a href="../../getting-started/" class="md-nav__link"> <a href="../../getting-started/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Getting Started 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"> <span class="md-ellipsis">
Advanced Advanced
@ -434,8 +513,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3"> <label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Advanced Advanced
</label> </label>
@ -451,6 +530,7 @@
<a href="../api/" class="md-nav__link"> <a href="../api/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
API 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"> <span class="md-ellipsis">
Config Config
@ -497,8 +579,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_2"> <label class="md-nav__title" for="__nav_4_2">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Config Config
</label> </label>
@ -514,6 +596,7 @@
<a href="../config/optional-config/" class="md-nav__link"> <a href="../config/optional-config/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Optional Configuration Optional Configuration
@ -536,6 +619,7 @@
<a href="../config/unattended-setup/" class="md-nav__link"> <a href="../config/unattended-setup/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Unattended Setup 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"> <span class="md-ellipsis">
Metrics Metrics
@ -590,8 +676,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_3_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_3"> <label class="md-nav__title" for="__nav_4_3">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Metrics Metrics
</label> </label>
@ -607,6 +693,7 @@
<a href="../metrics/prometheus/" class="md-nav__link"> <a href="../metrics/prometheus/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Prometheus 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"> <span class="md-ellipsis">
Migrate Migrate
@ -661,8 +750,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="true"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3_4"> <label class="md-nav__title" for="__nav_4_4">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Migrate Migrate
</label> </label>
@ -685,6 +774,7 @@
<a href="./" class="md-nav__link md-nav__link--active"> <a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate Migrate
@ -708,6 +798,7 @@
<a href="from-14-to-15/" class="md-nav__link"> <a href="from-14-to-15/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate from v14 to v15 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"> <span class="md-ellipsis">
Contributing Contributing
@ -769,8 +862,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4"> <label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Contributing Contributing
</label> </label>
@ -786,6 +879,7 @@
<a href="../../contributing/general/" class="md-nav__link"> <a href="../../contributing/general/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
General Information General Information
@ -808,6 +902,7 @@
<a href="../../contributing/issues-and-pull-requests/" class="md-nav__link"> <a href="../../contributing/issues-and-pull-requests/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Issues and Pull Requests 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"> <span class="md-ellipsis">
Examples Examples
@ -861,8 +958,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5"> <label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Examples Examples
</label> </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"> <span class="md-ellipsis">
Tutorials Tutorials
@ -902,8 +1001,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_1_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5_1"> <label class="md-nav__title" for="__nav_6_1">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Tutorials Tutorials
</label> </label>
@ -919,6 +1018,7 @@
<a href="../../examples/tutorials/adguard/" class="md-nav__link"> <a href="../../examples/tutorials/adguard/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
AdGuard Home AdGuard Home
@ -941,6 +1041,7 @@
<a href="../../examples/tutorials/auto-updates/" class="md-nav__link"> <a href="../../examples/tutorials/auto-updates/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Auto Updates Auto Updates
@ -963,6 +1064,7 @@
<a href="../../examples/tutorials/basic-installation/" class="md-nav__link"> <a href="../../examples/tutorials/basic-installation/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Basic Installation Basic Installation
@ -985,6 +1087,7 @@
<a href="../../examples/tutorials/caddy/" class="md-nav__link"> <a href="../../examples/tutorials/caddy/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Caddy Caddy
@ -1007,6 +1110,7 @@
<a href="../../examples/tutorials/docker-run/" class="md-nav__link"> <a href="../../examples/tutorials/docker-run/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Docker Run Docker Run
@ -1029,6 +1133,7 @@
<a href="../../examples/tutorials/dockerless/" class="md-nav__link"> <a href="../../examples/tutorials/dockerless/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Without Docker Without Docker
@ -1048,11 +1153,12 @@
<li class="md-nav__item"> <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"> <span class="md-ellipsis">
NGINX Podman + nftables
</span> </span>
@ -1070,11 +1176,12 @@
<li class="md-nav__item"> <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"> <span class="md-ellipsis">
Podman No Reverse Proxy
</span> </span>
@ -1095,6 +1202,7 @@
<a href="../../examples/tutorials/traefik/" class="md-nav__link"> <a href="../../examples/tutorials/traefik/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Traefik 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> </ul>
</nav> </nav>
</div> </div>
@ -1236,10 +1509,12 @@
</div> </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> </body>

8
development/assets/javascripts/bundle.c8b220af.min.js → development/assets/javascripts/bundle.13a4f30d.min.js

File diff suppressed because one or more lines are too long

4
development/assets/javascripts/bundle.c8b220af.min.js.map → development/assets/javascripts/bundle.13a4f30d.min.js.map

File diff suppressed because one or more lines are too long

4
development/assets/javascripts/workers/search.f8cc74c7.min.js → development/assets/javascripts/workers/search.d50fe291.min.js

File diff suppressed because one or more lines are too long

2
development/assets/javascripts/workers/search.f8cc74c7.min.js.map → development/assets/javascripts/workers/search.d50fe291.min.js.map

File diff suppressed because one or more lines are too long

1
development/assets/stylesheets/main.342714a4.min.css

File diff suppressed because one or more lines are too long

2
development/assets/stylesheets/main.8608ea7d.min.css.map → development/assets/stylesheets/main.342714a4.min.css.map

File diff suppressed because one or more lines are too long

1
development/assets/stylesheets/main.8608ea7d.min.css

File diff suppressed because one or more lines are too long

16
development/changelog.json

@ -1,16 +0,0 @@
{
"1": "Initial version. Enjoy!",
"2": "You can now rename a client & update the address. Enjoy!",
"3": "Many improvements and small changes. Enjoy!",
"4": "Now with pretty charts for client's network speed. Enjoy!",
"5": "Many small improvements & feature requests. Enjoy!",
"6": "Many small performance improvements & bug fixes. Enjoy!",
"7": "Improved the look & performance of the upload/download chart.",
"8": "Updated to Node.js v18.",
"9": "Fixed issue running on devices with older kernels.",
"10": "Added sessionless HTTP API auth & automatic dark mode.",
"11": "Multilanguage Support & various bugfixes.",
"12": "UI_TRAFFIC_STATS, Import json configurations with no PreShared-Key, allow clients with no privateKey & more.",
"13": "New framework (h3), UI_CHART_TYPE, some bugfixes & more.",
"14": "Home Assistent support, PASSWORD_HASH (inc. Helper), translation updates bugfixes & more."
}

360
development/contributing/general/index.html

@ -22,7 +22,7 @@
<link rel="icon" href="../../assets/logo/favicon.png"> <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"> <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 class="md-header__button md-icon" for="__search">
</label>
<div class="md-search" data-md-component="search" role="dialog"> <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> <label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search"> <div class="md-search__inner" role="search">
<form class="md-search__form" name="search"> <form class="md-search__form" name="search">
@ -189,6 +191,7 @@
</div> </div>
</div> </div>
</div> </div>
<div class="md-header__source"> <div class="md-header__source">
@ -221,10 +224,12 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../.." class="md-tabs__link"> <a href="../.." class="md-tabs__link">
Home 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"> <li class="md-tabs__item">
<a href="../../getting-started/" class="md-tabs__link"> <a href="../../getting-started/" class="md-tabs__link">
Getting Started Getting Started
@ -255,12 +281,14 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../advanced/api/" class="md-tabs__link"> <a href="../../advanced/api/" class="md-tabs__link">
Advanced Advanced
</a> </a>
@ -272,6 +300,7 @@
@ -281,6 +310,7 @@
<a href="./" class="md-tabs__link"> <a href="./" class="md-tabs__link">
Contributing Contributing
</a> </a>
@ -293,18 +323,21 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../examples/tutorials/adguard/" class="md-tabs__link"> <a href="../../examples/tutorials/adguard/" class="md-tabs__link">
Examples Examples
</a> </a>
@ -316,6 +349,26 @@
<li class="md-tabs__item">
<a href="../../guides/2fa/" class="md-tabs__link">
Guides
</a>
</li>
</ul> </ul>
</div> </div>
</nav> </nav>
@ -370,6 +423,7 @@
<a href="../.." class="md-nav__link"> <a href="../.." class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Home 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"> <li class="md-nav__item">
<a href="../../getting-started/" class="md-nav__link"> <a href="../../getting-started/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Getting Started Getting Started
@ -411,6 +488,7 @@
@ -421,12 +499,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" > <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0"> <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis"> <span class="md-ellipsis">
Advanced Advanced
@ -436,8 +515,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3"> <label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Advanced Advanced
</label> </label>
@ -453,6 +532,7 @@
<a href="../../advanced/api/" class="md-nav__link"> <a href="../../advanced/api/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
API API
@ -474,6 +554,7 @@
@ -484,12 +565,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"> <span class="md-ellipsis">
Config Config
@ -499,8 +581,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_2"> <label class="md-nav__title" for="__nav_4_2">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Config Config
</label> </label>
@ -516,6 +598,7 @@
<a href="../../advanced/config/optional-config/" class="md-nav__link"> <a href="../../advanced/config/optional-config/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Optional Configuration Optional Configuration
@ -538,6 +621,7 @@
<a href="../../advanced/config/unattended-setup/" class="md-nav__link"> <a href="../../advanced/config/unattended-setup/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Unattended Setup Unattended Setup
@ -567,6 +651,7 @@
@ -577,12 +662,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"> <span class="md-ellipsis">
Metrics Metrics
@ -592,8 +678,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_3_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_3"> <label class="md-nav__title" for="__nav_4_3">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Metrics Metrics
</label> </label>
@ -609,6 +695,7 @@
<a href="../../advanced/metrics/prometheus/" class="md-nav__link"> <a href="../../advanced/metrics/prometheus/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Prometheus Prometheus
@ -638,6 +725,7 @@
@ -648,12 +736,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"> <span class="md-ellipsis">
Migrate Migrate
@ -663,8 +752,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_4"> <label class="md-nav__title" for="__nav_4_4">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Migrate Migrate
</label> </label>
@ -680,6 +769,7 @@
<a href="../../advanced/migrate/" class="md-nav__link"> <a href="../../advanced/migrate/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate Migrate
@ -702,6 +792,7 @@
<a href="../../advanced/migrate/from-14-to-15/" class="md-nav__link"> <a href="../../advanced/migrate/from-14-to-15/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate from v14 to v15 Migrate from v14 to v15
@ -740,6 +831,7 @@
@ -751,12 +843,13 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex=""> <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
<span class="md-ellipsis"> <span class="md-ellipsis">
Contributing Contributing
@ -766,8 +859,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4"> <label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Contributing Contributing
</label> </label>
@ -790,6 +883,7 @@
<label class="md-nav__link md-nav__link--active" for="__toc"> <label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis"> <span class="md-ellipsis">
General Information General Information
@ -802,6 +896,7 @@
<a href="./" class="md-nav__link md-nav__link--active"> <a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis"> <span class="md-ellipsis">
General Information General Information
@ -860,6 +955,7 @@
<a href="../issues-and-pull-requests/" class="md-nav__link"> <a href="../issues-and-pull-requests/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Issues and Pull Requests Issues and Pull Requests
@ -888,6 +984,7 @@
@ -898,12 +995,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"> <span class="md-ellipsis">
Examples Examples
@ -913,8 +1011,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5"> <label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Examples Examples
</label> </label>
@ -929,6 +1027,7 @@
@ -939,12 +1038,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"> <span class="md-ellipsis">
Tutorials Tutorials
@ -954,8 +1054,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_1_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5_1"> <label class="md-nav__title" for="__nav_6_1">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Tutorials Tutorials
</label> </label>
@ -971,6 +1071,7 @@
<a href="../../examples/tutorials/adguard/" class="md-nav__link"> <a href="../../examples/tutorials/adguard/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
AdGuard Home AdGuard Home
@ -993,6 +1094,7 @@
<a href="../../examples/tutorials/auto-updates/" class="md-nav__link"> <a href="../../examples/tutorials/auto-updates/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Auto Updates Auto Updates
@ -1015,6 +1117,7 @@
<a href="../../examples/tutorials/basic-installation/" class="md-nav__link"> <a href="../../examples/tutorials/basic-installation/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Basic Installation Basic Installation
@ -1037,6 +1140,7 @@
<a href="../../examples/tutorials/caddy/" class="md-nav__link"> <a href="../../examples/tutorials/caddy/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Caddy Caddy
@ -1059,6 +1163,7 @@
<a href="../../examples/tutorials/docker-run/" class="md-nav__link"> <a href="../../examples/tutorials/docker-run/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Docker Run Docker Run
@ -1081,6 +1186,7 @@
<a href="../../examples/tutorials/dockerless/" class="md-nav__link"> <a href="../../examples/tutorials/dockerless/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Without Docker Without Docker
@ -1100,11 +1206,12 @@
<li class="md-nav__item"> <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"> <span class="md-ellipsis">
NGINX Podman + nftables
</span> </span>
@ -1122,11 +1229,12 @@
<li class="md-nav__item"> <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"> <span class="md-ellipsis">
Podman No Reverse Proxy
</span> </span>
@ -1147,6 +1255,7 @@
<a href="../../examples/tutorials/traefik/" class="md-nav__link"> <a href="../../examples/tutorials/traefik/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Traefik Traefik
@ -1174,6 +1283,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> </ul>
</nav> </nav>
</div> </div>
@ -1258,7 +1532,7 @@
<li><strong>Use the provided <code>.vscode/settings.json</code></strong> file.</li> <li><strong>Use the provided <code>.vscode/settings.json</code></strong> file.</li>
</ol> </ol>
<h2 id="documentation"><a class="toclink" href="#documentation">Documentation</a></h2> <h2 id="documentation"><a class="toclink" href="#documentation">Documentation</a></h2>
<p>Make sure to select <code>nightly</code> in the dropdown menu at the top. Navigate to the page you would like to edit and click the edit button in the top right. This allows you to make changes and create a pull-request.</p> <p>Make sure to select <code>edge</code> in the dropdown menu at the top. Navigate to the page you would like to edit and click the edit button in the top right. This allows you to make changes and create a pull-request.</p>
<p>Alternatively you can make the changes locally. For that you'll need to have Docker installed. Run</p> <p>Alternatively you can make the changes locally. For that you'll need to have Docker installed. Run</p>
<div class="highlight"><pre><span></span><code>pnpm<span class="w"> </span>docs:serve <div class="highlight"><pre><span></span><code>pnpm<span class="w"> </span>docs:serve
</code></pre></div> </code></pre></div>
@ -1323,10 +1597,12 @@
</div> </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> </body>

364
development/contributing/issues-and-pull-requests/index.html

@ -22,7 +22,7 @@
<link rel="icon" href="../../assets/logo/favicon.png"> <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"> <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 class="md-header__button md-icon" for="__search">
</label>
<div class="md-search" data-md-component="search" role="dialog"> <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> <label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search"> <div class="md-search__inner" role="search">
<form class="md-search__form" name="search"> <form class="md-search__form" name="search">
@ -189,6 +191,7 @@
</div> </div>
</div> </div>
</div> </div>
<div class="md-header__source"> <div class="md-header__source">
@ -221,10 +224,12 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../.." class="md-tabs__link"> <a href="../.." class="md-tabs__link">
Home 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"> <li class="md-tabs__item">
<a href="../../getting-started/" class="md-tabs__link"> <a href="../../getting-started/" class="md-tabs__link">
Getting Started Getting Started
@ -255,12 +281,14 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../advanced/api/" class="md-tabs__link"> <a href="../../advanced/api/" class="md-tabs__link">
Advanced Advanced
</a> </a>
@ -272,6 +300,7 @@
@ -281,6 +310,7 @@
<a href="../general/" class="md-tabs__link"> <a href="../general/" class="md-tabs__link">
Contributing Contributing
</a> </a>
@ -293,18 +323,21 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../examples/tutorials/adguard/" class="md-tabs__link"> <a href="../../examples/tutorials/adguard/" class="md-tabs__link">
Examples Examples
</a> </a>
@ -316,6 +349,26 @@
<li class="md-tabs__item">
<a href="../../guides/2fa/" class="md-tabs__link">
Guides
</a>
</li>
</ul> </ul>
</div> </div>
</nav> </nav>
@ -370,6 +423,7 @@
<a href="../.." class="md-nav__link"> <a href="../.." class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Home 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"> <li class="md-nav__item">
<a href="../../getting-started/" class="md-nav__link"> <a href="../../getting-started/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Getting Started Getting Started
@ -411,6 +488,7 @@
@ -421,12 +499,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" > <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0"> <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis"> <span class="md-ellipsis">
Advanced Advanced
@ -436,8 +515,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3"> <label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Advanced Advanced
</label> </label>
@ -453,6 +532,7 @@
<a href="../../advanced/api/" class="md-nav__link"> <a href="../../advanced/api/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
API API
@ -474,6 +554,7 @@
@ -484,12 +565,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"> <span class="md-ellipsis">
Config Config
@ -499,8 +581,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_2"> <label class="md-nav__title" for="__nav_4_2">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Config Config
</label> </label>
@ -516,6 +598,7 @@
<a href="../../advanced/config/optional-config/" class="md-nav__link"> <a href="../../advanced/config/optional-config/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Optional Configuration Optional Configuration
@ -538,6 +621,7 @@
<a href="../../advanced/config/unattended-setup/" class="md-nav__link"> <a href="../../advanced/config/unattended-setup/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Unattended Setup Unattended Setup
@ -567,6 +651,7 @@
@ -577,12 +662,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"> <span class="md-ellipsis">
Metrics Metrics
@ -592,8 +678,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_3_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_3"> <label class="md-nav__title" for="__nav_4_3">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Metrics Metrics
</label> </label>
@ -609,6 +695,7 @@
<a href="../../advanced/metrics/prometheus/" class="md-nav__link"> <a href="../../advanced/metrics/prometheus/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Prometheus Prometheus
@ -638,6 +725,7 @@
@ -648,12 +736,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"> <span class="md-ellipsis">
Migrate Migrate
@ -663,8 +752,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_4"> <label class="md-nav__title" for="__nav_4_4">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Migrate Migrate
</label> </label>
@ -680,6 +769,7 @@
<a href="../../advanced/migrate/" class="md-nav__link"> <a href="../../advanced/migrate/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate Migrate
@ -702,6 +792,7 @@
<a href="../../advanced/migrate/from-14-to-15/" class="md-nav__link"> <a href="../../advanced/migrate/from-14-to-15/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate from v14 to v15 Migrate from v14 to v15
@ -740,6 +831,7 @@
@ -751,12 +843,13 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex=""> <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
<span class="md-ellipsis"> <span class="md-ellipsis">
Contributing Contributing
@ -766,8 +859,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4"> <label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Contributing Contributing
</label> </label>
@ -783,6 +876,7 @@
<a href="../general/" class="md-nav__link"> <a href="../general/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
General Information General Information
@ -812,6 +906,7 @@
<label class="md-nav__link md-nav__link--active" for="__toc"> <label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis"> <span class="md-ellipsis">
Issues and Pull Requests Issues and Pull Requests
@ -824,6 +919,7 @@
<a href="./" class="md-nav__link md-nav__link--active"> <a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis"> <span class="md-ellipsis">
Issues and Pull Requests Issues and Pull Requests
@ -918,6 +1014,7 @@
@ -928,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"> <span class="md-ellipsis">
Examples Examples
@ -943,8 +1041,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5"> <label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Examples Examples
</label> </label>
@ -959,6 +1057,7 @@
@ -969,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"> <span class="md-ellipsis">
Tutorials Tutorials
@ -984,8 +1084,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_1_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5_1"> <label class="md-nav__title" for="__nav_6_1">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Tutorials Tutorials
</label> </label>
@ -1001,6 +1101,7 @@
<a href="../../examples/tutorials/adguard/" class="md-nav__link"> <a href="../../examples/tutorials/adguard/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
AdGuard Home AdGuard Home
@ -1023,6 +1124,7 @@
<a href="../../examples/tutorials/auto-updates/" class="md-nav__link"> <a href="../../examples/tutorials/auto-updates/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Auto Updates Auto Updates
@ -1045,6 +1147,7 @@
<a href="../../examples/tutorials/basic-installation/" class="md-nav__link"> <a href="../../examples/tutorials/basic-installation/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Basic Installation Basic Installation
@ -1067,6 +1170,7 @@
<a href="../../examples/tutorials/caddy/" class="md-nav__link"> <a href="../../examples/tutorials/caddy/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Caddy Caddy
@ -1089,6 +1193,7 @@
<a href="../../examples/tutorials/docker-run/" class="md-nav__link"> <a href="../../examples/tutorials/docker-run/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Docker Run Docker Run
@ -1111,6 +1216,7 @@
<a href="../../examples/tutorials/dockerless/" class="md-nav__link"> <a href="../../examples/tutorials/dockerless/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Without Docker Without Docker
@ -1130,11 +1236,12 @@
<li class="md-nav__item"> <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"> <span class="md-ellipsis">
NGINX Podman + nftables
</span> </span>
@ -1152,11 +1259,12 @@
<li class="md-nav__item"> <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"> <span class="md-ellipsis">
Podman No Reverse Proxy
</span> </span>
@ -1177,6 +1285,7 @@
<a href="../../examples/tutorials/traefik/" class="md-nav__link"> <a href="../../examples/tutorials/traefik/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Traefik Traefik
@ -1204,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> </ul>
</nav> </nav>
</div> </div>
@ -1324,8 +1598,8 @@
<p>By raising issues, I agree to these terms and I understand, that the rules set for the issue tracker will help both maintainers as well as everyone to find a solution.</p> <p>By raising issues, I agree to these terms and I understand, that the rules set for the issue tracker will help both maintainers as well as everyone to find a solution.</p>
<p>Maintainers take the time to improve on this project and help by solving issues together. It is therefore expected from others to make an effort and <strong>comply with the rules</strong>.</p> <p>Maintainers take the time to improve on this project and help by solving issues together. It is therefore expected from others to make an effort and <strong>comply with the rules</strong>.</p>
<h3 id="filing-a-bug-report"><a class="toclink" href="#filing-a-bug-report">Filing a Bug Report</a></h3> <h3 id="filing-a-bug-report"><a class="toclink" href="#filing-a-bug-report">Filing a Bug Report</a></h3>
<p>Thank you for participating in this project and reporting a bug. wg-easy is a community-driven project, and each contribution counts!</p> <p>Thank you for participating in this project and reporting a bug. <code>wg-easy</code> is a community-driven project, and each contribution counts!</p>
<p>Maintainers and moderators are volunteers. We greatly appreciate reports that take the time to provide detailed information via the template, enabling us to help you in the best and quickest way. Ignoring the template provided may seem easier, but discourages receiving any support (<em>via assignment of the label <code>meta/no template - no support</code></em>).</p> <p>Maintainers and moderators are volunteers. We greatly appreciate reports that take the time to provide detailed information via the template, enabling us to help you in the best and quickest way. Ignoring the template provided may seem easier, but discourages receiving any support.</p>
<p>Markdown formatting can be used in almost all text fields (<em>unless stated otherwise in the description</em>).</p> <p>Markdown formatting can be used in almost all text fields (<em>unless stated otherwise in the description</em>).</p>
<p>Be as precise as possible, and if in doubt, it's best to add more information that too few.</p> <p>Be as precise as possible, and if in doubt, it's best to add more information that too few.</p>
<p>When an option is marked with "not officially supported" / "unsupported", then support is dependent on availability from specific maintainers.</p> <p>When an option is marked with "not officially supported" / "unsupported", then support is dependent on availability from specific maintainers.</p>
@ -1342,7 +1616,7 @@
<li>Document your improvements if necessary</li> <li>Document your improvements if necessary</li>
<li><a href="https://help.github.com/articles/closing-issues-via-commit-messages/">Commit</a> (and <a href="https://docs.github.com/en/github/authenticating-to-github/generating-a-new-gpg-key">sign your commit</a>), push and create a pull-request to merge into <code>master</code>. Please <strong>use the pull-request template</strong> to provide a minimum of contextual information and make sure to meet the requirements of the checklist.</li> <li><a href="https://help.github.com/articles/closing-issues-via-commit-messages/">Commit</a> (and <a href="https://docs.github.com/en/github/authenticating-to-github/generating-a-new-gpg-key">sign your commit</a>), push and create a pull-request to merge into <code>master</code>. Please <strong>use the pull-request template</strong> to provide a minimum of contextual information and make sure to meet the requirements of the checklist.</li>
</ol> </ol>
<p>Pull requests are automatically tested against the CI and will be reviewed when tests pass. When your changes are validated, your branch is merged. CI builds the new <code>:nightly</code> image every night and your changes will be includes in the next version release.</p> <p>Pull requests are automatically tested against the CI and will be reviewed when tests pass. When your changes are validated, your branch is merged. CI builds the new <code>:edge</code> image on every push to the <code>master</code> branch and your changes will be included in the next version release.</p>
@ -1403,10 +1677,12 @@
</div> </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> </body>

361
development/examples/tutorials/adguard/index.html

@ -22,7 +22,7 @@
<link rel="icon" href="../../../assets/logo/favicon.png"> <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"> <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 class="md-header__button md-icon" for="__search">
</label>
<div class="md-search" data-md-component="search" role="dialog"> <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> <label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search"> <div class="md-search__inner" role="search">
<form class="md-search__form" name="search"> <form class="md-search__form" name="search">
@ -184,6 +186,7 @@
</div> </div>
</div> </div>
</div> </div>
<div class="md-header__source"> <div class="md-header__source">
@ -216,10 +219,12 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../.." class="md-tabs__link"> <a href="../../.." class="md-tabs__link">
Home 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"> <li class="md-tabs__item">
<a href="../../../getting-started/" class="md-tabs__link"> <a href="../../../getting-started/" class="md-tabs__link">
Getting Started Getting Started
@ -250,12 +276,14 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../../advanced/api/" class="md-tabs__link"> <a href="../../../advanced/api/" class="md-tabs__link">
Advanced Advanced
</a> </a>
@ -268,12 +296,14 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../../contributing/general/" class="md-tabs__link"> <a href="../../../contributing/general/" class="md-tabs__link">
Contributing Contributing
</a> </a>
@ -285,6 +315,7 @@
@ -293,6 +324,7 @@
@ -302,6 +334,7 @@
<a href="./" class="md-tabs__link"> <a href="./" class="md-tabs__link">
Examples Examples
</a> </a>
@ -313,6 +346,26 @@
<li class="md-tabs__item">
<a href="../../../guides/2fa/" class="md-tabs__link">
Guides
</a>
</li>
</ul> </ul>
</div> </div>
</nav> </nav>
@ -367,6 +420,7 @@
<a href="../../.." class="md-nav__link"> <a href="../../.." class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Home Home
@ -384,10 +438,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"> <li class="md-nav__item">
<a href="../../../getting-started/" class="md-nav__link"> <a href="../../../getting-started/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Getting Started Getting Started
@ -408,6 +485,7 @@
@ -418,12 +496,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" > <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0"> <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis"> <span class="md-ellipsis">
Advanced Advanced
@ -433,8 +512,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3"> <label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Advanced Advanced
</label> </label>
@ -450,6 +529,7 @@
<a href="../../../advanced/api/" class="md-nav__link"> <a href="../../../advanced/api/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
API API
@ -471,6 +551,7 @@
@ -481,12 +562,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"> <span class="md-ellipsis">
Config Config
@ -496,8 +578,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_2"> <label class="md-nav__title" for="__nav_4_2">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Config Config
</label> </label>
@ -513,6 +595,7 @@
<a href="../../../advanced/config/optional-config/" class="md-nav__link"> <a href="../../../advanced/config/optional-config/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Optional Configuration Optional Configuration
@ -535,6 +618,7 @@
<a href="../../../advanced/config/unattended-setup/" class="md-nav__link"> <a href="../../../advanced/config/unattended-setup/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Unattended Setup Unattended Setup
@ -564,6 +648,7 @@
@ -574,12 +659,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"> <span class="md-ellipsis">
Metrics Metrics
@ -589,8 +675,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_3_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_3"> <label class="md-nav__title" for="__nav_4_3">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Metrics Metrics
</label> </label>
@ -606,6 +692,7 @@
<a href="../../../advanced/metrics/prometheus/" class="md-nav__link"> <a href="../../../advanced/metrics/prometheus/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Prometheus Prometheus
@ -635,6 +722,7 @@
@ -645,12 +733,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"> <span class="md-ellipsis">
Migrate Migrate
@ -660,8 +749,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_4"> <label class="md-nav__title" for="__nav_4_4">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Migrate Migrate
</label> </label>
@ -677,6 +766,7 @@
<a href="../../../advanced/migrate/" class="md-nav__link"> <a href="../../../advanced/migrate/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate Migrate
@ -699,6 +789,7 @@
<a href="../../../advanced/migrate/from-14-to-15/" class="md-nav__link"> <a href="../../../advanced/migrate/from-14-to-15/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate from v14 to v15 Migrate from v14 to v15
@ -735,6 +826,7 @@
@ -745,12 +837,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"> <span class="md-ellipsis">
Contributing Contributing
@ -760,8 +853,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4"> <label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Contributing Contributing
</label> </label>
@ -777,6 +870,7 @@
<a href="../../../contributing/general/" class="md-nav__link"> <a href="../../../contributing/general/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
General Information General Information
@ -799,6 +893,7 @@
<a href="../../../contributing/issues-and-pull-requests/" class="md-nav__link"> <a href="../../../contributing/issues-and-pull-requests/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Issues and Pull Requests Issues and Pull Requests
@ -829,6 +924,7 @@
@ -840,12 +936,13 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex=""> <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
<span class="md-ellipsis"> <span class="md-ellipsis">
Examples Examples
@ -855,8 +952,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_5"> <label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Examples Examples
</label> </label>
@ -873,6 +970,7 @@
@ -881,12 +979,13 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_1" checked> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" checked>
<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"> <span class="md-ellipsis">
Tutorials Tutorials
@ -896,8 +995,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_1_label" aria-expanded="true"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_5_1"> <label class="md-nav__title" for="__nav_6_1">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Tutorials Tutorials
</label> </label>
@ -920,6 +1019,7 @@
<a href="./" class="md-nav__link md-nav__link--active"> <a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis"> <span class="md-ellipsis">
AdGuard Home AdGuard Home
@ -943,6 +1043,7 @@
<a href="../auto-updates/" class="md-nav__link"> <a href="../auto-updates/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Auto Updates Auto Updates
@ -965,6 +1066,7 @@
<a href="../basic-installation/" class="md-nav__link"> <a href="../basic-installation/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Basic Installation Basic Installation
@ -987,6 +1089,7 @@
<a href="../caddy/" class="md-nav__link"> <a href="../caddy/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Caddy Caddy
@ -1009,6 +1112,7 @@
<a href="../docker-run/" class="md-nav__link"> <a href="../docker-run/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Docker Run Docker Run
@ -1031,6 +1135,7 @@
<a href="../dockerless/" class="md-nav__link"> <a href="../dockerless/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Without Docker Without Docker
@ -1050,11 +1155,12 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="../nginx/" class="md-nav__link"> <a href="../podman-nft/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
NGINX Podman + nftables
</span> </span>
@ -1072,11 +1178,12 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="../podman/" class="md-nav__link"> <a href="../reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Podman No Reverse Proxy
</span> </span>
@ -1097,6 +1204,7 @@
<a href="../traefik/" class="md-nav__link"> <a href="../traefik/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Traefik Traefik
@ -1124,6 +1232,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> </ul>
</nav> </nav>
</div> </div>
@ -1174,7 +1447,9 @@
<h1>AdGuard Home</h1> <h1>AdGuard Home</h1>
<p>TODO</p> <p>It seems like the Docs on how to setup AdGuard Home are not available yet.</p>
<p>Feel free to create a PR and add them here.</p>
<!-- TODO -->
@ -1235,10 +1510,12 @@
</div> </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> </body>

421
development/examples/tutorials/auto-updates/index.html

@ -22,7 +22,7 @@
<link rel="icon" href="../../../assets/logo/favicon.png"> <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"> <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 class="md-header__button md-icon" for="__search">
</label>
<div class="md-search" data-md-component="search" role="dialog"> <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> <label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search"> <div class="md-search__inner" role="search">
<form class="md-search__form" name="search"> <form class="md-search__form" name="search">
@ -189,6 +191,7 @@
</div> </div>
</div> </div>
</div> </div>
<div class="md-header__source"> <div class="md-header__source">
@ -221,10 +224,12 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../.." class="md-tabs__link"> <a href="../../.." class="md-tabs__link">
Home 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"> <li class="md-tabs__item">
<a href="../../../getting-started/" class="md-tabs__link"> <a href="../../../getting-started/" class="md-tabs__link">
Getting Started Getting Started
@ -255,12 +281,14 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../../advanced/api/" class="md-tabs__link"> <a href="../../../advanced/api/" class="md-tabs__link">
Advanced Advanced
</a> </a>
@ -273,12 +301,14 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../../contributing/general/" class="md-tabs__link"> <a href="../../../contributing/general/" class="md-tabs__link">
Contributing Contributing
</a> </a>
@ -290,6 +320,7 @@
@ -298,6 +329,7 @@
@ -307,6 +339,7 @@
<a href="../adguard/" class="md-tabs__link"> <a href="../adguard/" class="md-tabs__link">
Examples Examples
</a> </a>
@ -318,6 +351,26 @@
<li class="md-tabs__item">
<a href="../../../guides/2fa/" class="md-tabs__link">
Guides
</a>
</li>
</ul> </ul>
</div> </div>
</nav> </nav>
@ -372,6 +425,7 @@
<a href="../../.." class="md-nav__link"> <a href="../../.." class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Home Home
@ -389,10 +443,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"> <li class="md-nav__item">
<a href="../../../getting-started/" class="md-nav__link"> <a href="../../../getting-started/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Getting Started Getting Started
@ -413,6 +490,7 @@
@ -423,12 +501,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" > <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0"> <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis"> <span class="md-ellipsis">
Advanced Advanced
@ -438,8 +517,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3"> <label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Advanced Advanced
</label> </label>
@ -455,6 +534,7 @@
<a href="../../../advanced/api/" class="md-nav__link"> <a href="../../../advanced/api/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
API API
@ -476,6 +556,7 @@
@ -486,12 +567,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"> <span class="md-ellipsis">
Config Config
@ -501,8 +583,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_2"> <label class="md-nav__title" for="__nav_4_2">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Config Config
</label> </label>
@ -518,6 +600,7 @@
<a href="../../../advanced/config/optional-config/" class="md-nav__link"> <a href="../../../advanced/config/optional-config/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Optional Configuration Optional Configuration
@ -540,6 +623,7 @@
<a href="../../../advanced/config/unattended-setup/" class="md-nav__link"> <a href="../../../advanced/config/unattended-setup/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Unattended Setup Unattended Setup
@ -569,6 +653,7 @@
@ -579,12 +664,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"> <span class="md-ellipsis">
Metrics Metrics
@ -594,8 +680,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_3_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_3"> <label class="md-nav__title" for="__nav_4_3">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Metrics Metrics
</label> </label>
@ -611,6 +697,7 @@
<a href="../../../advanced/metrics/prometheus/" class="md-nav__link"> <a href="../../../advanced/metrics/prometheus/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Prometheus Prometheus
@ -640,6 +727,7 @@
@ -650,12 +738,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"> <span class="md-ellipsis">
Migrate Migrate
@ -665,8 +754,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_4"> <label class="md-nav__title" for="__nav_4_4">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Migrate Migrate
</label> </label>
@ -682,6 +771,7 @@
<a href="../../../advanced/migrate/" class="md-nav__link"> <a href="../../../advanced/migrate/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate Migrate
@ -704,6 +794,7 @@
<a href="../../../advanced/migrate/from-14-to-15/" class="md-nav__link"> <a href="../../../advanced/migrate/from-14-to-15/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate from v14 to v15 Migrate from v14 to v15
@ -740,6 +831,7 @@
@ -750,12 +842,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"> <span class="md-ellipsis">
Contributing Contributing
@ -765,8 +858,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4"> <label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Contributing Contributing
</label> </label>
@ -782,6 +875,7 @@
<a href="../../../contributing/general/" class="md-nav__link"> <a href="../../../contributing/general/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
General Information General Information
@ -804,6 +898,7 @@
<a href="../../../contributing/issues-and-pull-requests/" class="md-nav__link"> <a href="../../../contributing/issues-and-pull-requests/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Issues and Pull Requests Issues and Pull Requests
@ -834,6 +929,7 @@
@ -845,12 +941,13 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex=""> <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
<span class="md-ellipsis"> <span class="md-ellipsis">
Examples Examples
@ -860,8 +957,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_5"> <label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Examples Examples
</label> </label>
@ -878,6 +975,7 @@
@ -886,12 +984,13 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_1" checked> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" checked>
<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"> <span class="md-ellipsis">
Tutorials Tutorials
@ -901,8 +1000,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_1_label" aria-expanded="true"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_5_1"> <label class="md-nav__title" for="__nav_6_1">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Tutorials Tutorials
</label> </label>
@ -918,6 +1017,7 @@
<a href="../adguard/" class="md-nav__link"> <a href="../adguard/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
AdGuard Home AdGuard Home
@ -947,6 +1047,7 @@
<label class="md-nav__link md-nav__link--active" for="__toc"> <label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis"> <span class="md-ellipsis">
Auto Updates Auto Updates
@ -959,6 +1060,7 @@
<a href="./" class="md-nav__link md-nav__link--active"> <a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis"> <span class="md-ellipsis">
Auto Updates Auto Updates
@ -987,6 +1089,21 @@
</span> </span>
</a> </a>
<nav class="md-nav" aria-label="Docker Compose">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#watchtower" class="md-nav__link">
<span class="md-ellipsis">
Watchtower
</span>
</a>
</li>
</ul>
</nav>
</li> </li>
<li class="md-nav__item"> <li class="md-nav__item">
@ -1026,6 +1143,7 @@
<a href="../basic-installation/" class="md-nav__link"> <a href="../basic-installation/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Basic Installation Basic Installation
@ -1048,6 +1166,7 @@
<a href="../caddy/" class="md-nav__link"> <a href="../caddy/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Caddy Caddy
@ -1070,6 +1189,7 @@
<a href="../docker-run/" class="md-nav__link"> <a href="../docker-run/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Docker Run Docker Run
@ -1092,6 +1212,7 @@
<a href="../dockerless/" class="md-nav__link"> <a href="../dockerless/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Without Docker Without Docker
@ -1111,11 +1232,12 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="../nginx/" class="md-nav__link"> <a href="../podman-nft/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
NGINX Podman + nftables
</span> </span>
@ -1133,11 +1255,12 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="../podman/" class="md-nav__link"> <a href="../reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Podman No Reverse Proxy
</span> </span>
@ -1158,6 +1281,7 @@
<a href="../traefik/" class="md-nav__link"> <a href="../traefik/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Traefik Traefik
@ -1185,6 +1309,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> </ul>
</nav> </nav>
</div> </div>
@ -1216,6 +1505,21 @@
</span> </span>
</a> </a>
<nav class="md-nav" aria-label="Docker Compose">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#watchtower" class="md-nav__link">
<span class="md-ellipsis">
Watchtower
</span>
</a>
</li>
</ul>
</nav>
</li> </li>
<li class="md-nav__item"> <li class="md-nav__item">
@ -1272,10 +1576,39 @@
<h2 id="docker-compose"><a class="toclink" href="#docker-compose">Docker Compose</a></h2> <h2 id="docker-compose"><a class="toclink" href="#docker-compose">Docker Compose</a></h2>
<p>With Docker Compose <code>wg-easy</code> can be updated with a single command:</p> <p>With Docker Compose <code>wg-easy</code> can be updated with a single command:</p>
<p>Replace <code>$DIR</code> with the directory where your <code>docker-compose.yml</code> is located.</p> <div class="highlight"><pre><span></span><code><span class="nb">cd</span><span class="w"> </span>/etc/docker/containers/wg-easy
<div class="highlight"><pre><span></span><code><span class="nb">cd</span><span class="w"> </span><span class="nv">$DIR</span>
sudo<span class="w"> </span>docker<span class="w"> </span>compose<span class="w"> </span>up<span class="w"> </span>-d<span class="w"> </span>--pull<span class="w"> </span>always sudo<span class="w"> </span>docker<span class="w"> </span>compose<span class="w"> </span>up<span class="w"> </span>-d<span class="w"> </span>--pull<span class="w"> </span>always
</code></pre></div> </code></pre></div>
<h3 id="watchtower"><a class="toclink" href="#watchtower">Watchtower</a></h3>
<p>If you want the updates to be fully automatic you can install Watchtower. This will check for updates every day at 4:00 AM and update the container if a new version is available.</p>
<p>File: <code>/etc/docker/containers/watchtower/docker-compose.yml</code></p>
<div class="highlight"><pre><span></span><code><span class="nt">services</span><span class="p">:</span>
<span class="w"> </span><span class="nt">watchtower</span><span class="p">:</span>
<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">containrrr/watchtower:latest</span>
<span class="w"> </span><span class="nt">volumes</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/var/run/docker.sock:/var/run/docker.sock</span>
<span class="w"> </span><span class="nt">env_file</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">watchtower.env</span>
<span class="w"> </span><span class="nt">restart</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">unless-stopped</span>
</code></pre></div>
<p>File: <code>/etc/docker/containers/watchtower/watchtower.env</code></p>
<div class="highlight"><pre><span></span><code>WATCHTOWER_CLEANUP=true
WATCHTOWER_SCHEDULE=0 0 4 * * *
TZ=Europe/Berlin
# Email
# WATCHTOWER_NOTIFICATIONS_LEVEL=info
# WATCHTOWER_NOTIFICATIONS=email
# [email protected]
# [email protected]
# WATCHTOWER_NOTIFICATION_EMAIL_SERVER=smtp.example.com
# [email protected]
# WATCHTOWER_NOTIFICATION_EMAIL_SERVER_PASSWORD=&quot;SuperSecurePassword&quot;
# WATCHTOWER_NOTIFICATION_EMAIL_SERVER_PORT=587
</code></pre></div>
<div class="highlight"><pre><span></span><code><span class="nb">cd</span><span class="w"> </span>/etc/docker/containers/watchtower
sudo<span class="w"> </span>docker<span class="w"> </span>compose<span class="w"> </span>up<span class="w"> </span>-d
</code></pre></div>
<h2 id="docker-run"><a class="toclink" href="#docker-run">Docker Run</a></h2> <h2 id="docker-run"><a class="toclink" href="#docker-run">Docker Run</a></h2>
<div class="highlight"><pre><span></span><code>sudo<span class="w"> </span>docker<span class="w"> </span>stop<span class="w"> </span>wg-easy <div class="highlight"><pre><span></span><code>sudo<span class="w"> </span>docker<span class="w"> </span>stop<span class="w"> </span>wg-easy
sudo<span class="w"> </span>docker<span class="w"> </span>rm<span class="w"> </span>wg-easy sudo<span class="w"> </span>docker<span class="w"> </span>rm<span class="w"> </span>wg-easy
@ -1346,10 +1679,12 @@ sudo<span class="w"> </span>docker<span class="w"> </span>pull<span class="w"> <
</div> </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> </body>

419
development/examples/tutorials/basic-installation/index.html

@ -22,7 +22,7 @@
<link rel="icon" href="../../../assets/logo/favicon.png"> <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"> <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 class="md-header__button md-icon" for="__search">
</label>
<div class="md-search" data-md-component="search" role="dialog"> <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> <label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search"> <div class="md-search__inner" role="search">
<form class="md-search__form" name="search"> <form class="md-search__form" name="search">
@ -189,6 +191,7 @@
</div> </div>
</div> </div>
</div> </div>
<div class="md-header__source"> <div class="md-header__source">
@ -221,10 +224,12 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../.." class="md-tabs__link"> <a href="../../.." class="md-tabs__link">
Home 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"> <li class="md-tabs__item">
<a href="../../../getting-started/" class="md-tabs__link"> <a href="../../../getting-started/" class="md-tabs__link">
Getting Started Getting Started
@ -255,12 +281,14 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../../advanced/api/" class="md-tabs__link"> <a href="../../../advanced/api/" class="md-tabs__link">
Advanced Advanced
</a> </a>
@ -273,12 +301,14 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../../contributing/general/" class="md-tabs__link"> <a href="../../../contributing/general/" class="md-tabs__link">
Contributing Contributing
</a> </a>
@ -290,6 +320,7 @@
@ -298,6 +329,7 @@
@ -307,6 +339,7 @@
<a href="../adguard/" class="md-tabs__link"> <a href="../adguard/" class="md-tabs__link">
Examples Examples
</a> </a>
@ -318,6 +351,26 @@
<li class="md-tabs__item">
<a href="../../../guides/2fa/" class="md-tabs__link">
Guides
</a>
</li>
</ul> </ul>
</div> </div>
</nav> </nav>
@ -372,6 +425,7 @@
<a href="../../.." class="md-nav__link"> <a href="../../.." class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Home Home
@ -389,10 +443,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"> <li class="md-nav__item">
<a href="../../../getting-started/" class="md-nav__link"> <a href="../../../getting-started/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Getting Started Getting Started
@ -413,6 +490,7 @@
@ -423,12 +501,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" > <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0"> <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis"> <span class="md-ellipsis">
Advanced Advanced
@ -438,8 +517,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3"> <label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Advanced Advanced
</label> </label>
@ -455,6 +534,7 @@
<a href="../../../advanced/api/" class="md-nav__link"> <a href="../../../advanced/api/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
API API
@ -476,6 +556,7 @@
@ -486,12 +567,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"> <span class="md-ellipsis">
Config Config
@ -501,8 +583,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_2"> <label class="md-nav__title" for="__nav_4_2">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Config Config
</label> </label>
@ -518,6 +600,7 @@
<a href="../../../advanced/config/optional-config/" class="md-nav__link"> <a href="../../../advanced/config/optional-config/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Optional Configuration Optional Configuration
@ -540,6 +623,7 @@
<a href="../../../advanced/config/unattended-setup/" class="md-nav__link"> <a href="../../../advanced/config/unattended-setup/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Unattended Setup Unattended Setup
@ -569,6 +653,7 @@
@ -579,12 +664,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"> <span class="md-ellipsis">
Metrics Metrics
@ -594,8 +680,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_3_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_3"> <label class="md-nav__title" for="__nav_4_3">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Metrics Metrics
</label> </label>
@ -611,6 +697,7 @@
<a href="../../../advanced/metrics/prometheus/" class="md-nav__link"> <a href="../../../advanced/metrics/prometheus/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Prometheus Prometheus
@ -640,6 +727,7 @@
@ -650,12 +738,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"> <span class="md-ellipsis">
Migrate Migrate
@ -665,8 +754,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_4"> <label class="md-nav__title" for="__nav_4_4">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Migrate Migrate
</label> </label>
@ -682,6 +771,7 @@
<a href="../../../advanced/migrate/" class="md-nav__link"> <a href="../../../advanced/migrate/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate Migrate
@ -704,6 +794,7 @@
<a href="../../../advanced/migrate/from-14-to-15/" class="md-nav__link"> <a href="../../../advanced/migrate/from-14-to-15/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate from v14 to v15 Migrate from v14 to v15
@ -740,6 +831,7 @@
@ -750,12 +842,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"> <span class="md-ellipsis">
Contributing Contributing
@ -765,8 +858,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4"> <label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Contributing Contributing
</label> </label>
@ -782,6 +875,7 @@
<a href="../../../contributing/general/" class="md-nav__link"> <a href="../../../contributing/general/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
General Information General Information
@ -804,6 +898,7 @@
<a href="../../../contributing/issues-and-pull-requests/" class="md-nav__link"> <a href="../../../contributing/issues-and-pull-requests/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Issues and Pull Requests Issues and Pull Requests
@ -834,6 +929,7 @@
@ -845,12 +941,13 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex=""> <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
<span class="md-ellipsis"> <span class="md-ellipsis">
Examples Examples
@ -860,8 +957,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_5"> <label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Examples Examples
</label> </label>
@ -878,6 +975,7 @@
@ -886,12 +984,13 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_1" checked> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" checked>
<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"> <span class="md-ellipsis">
Tutorials Tutorials
@ -901,8 +1000,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_1_label" aria-expanded="true"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_5_1"> <label class="md-nav__title" for="__nav_6_1">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Tutorials Tutorials
</label> </label>
@ -918,6 +1017,7 @@
<a href="../adguard/" class="md-nav__link"> <a href="../adguard/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
AdGuard Home AdGuard Home
@ -940,6 +1040,7 @@
<a href="../auto-updates/" class="md-nav__link"> <a href="../auto-updates/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Auto Updates Auto Updates
@ -969,6 +1070,7 @@
<label class="md-nav__link md-nav__link--active" for="__toc"> <label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis"> <span class="md-ellipsis">
Basic Installation Basic Installation
@ -981,6 +1083,7 @@
<a href="./" class="md-nav__link md-nav__link--active"> <a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis"> <span class="md-ellipsis">
Basic Installation Basic Installation
@ -1045,15 +1148,6 @@
</span> </span>
</a> </a>
</li>
<li class="md-nav__item">
<a href="#access-the-web-ui" class="md-nav__link">
<span class="md-ellipsis">
Access the Web UI
</span>
</a>
</li> </li>
<li class="md-nav__item"> <li class="md-nav__item">
@ -1093,6 +1187,7 @@
<a href="../caddy/" class="md-nav__link"> <a href="../caddy/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Caddy Caddy
@ -1115,6 +1210,7 @@
<a href="../docker-run/" class="md-nav__link"> <a href="../docker-run/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Docker Run Docker Run
@ -1137,6 +1233,7 @@
<a href="../dockerless/" class="md-nav__link"> <a href="../dockerless/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Without Docker Without Docker
@ -1156,11 +1253,12 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="../nginx/" class="md-nav__link"> <a href="../podman-nft/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
NGINX Podman + nftables
</span> </span>
@ -1178,11 +1276,12 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="../podman/" class="md-nav__link"> <a href="../reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Podman No Reverse Proxy
</span> </span>
@ -1203,6 +1302,7 @@
<a href="../traefik/" class="md-nav__link"> <a href="../traefik/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Traefik Traefik
@ -1230,6 +1330,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> </ul>
</nav> </nav>
</div> </div>
@ -1297,15 +1562,6 @@
</span> </span>
</a> </a>
</li>
<li class="md-nav__item">
<a href="#access-the-web-ui" class="md-nav__link">
<span class="md-ellipsis">
Access the Web UI
</span>
</a>
</li> </li>
<li class="md-nav__item"> <li class="md-nav__item">
@ -1366,44 +1622,47 @@
<ol> <ol>
<li>You need to have a host that you can manage</li> <li>You need to have a host that you can manage</li>
<li>You need to have a domain name or a public IP address</li> <li>You need to have a domain name or a public IP address</li>
<li>You need a supported architecture (x86_64, arm64)</li> <li>You need a supported architecture (x86_64, arm64, armv7)</li>
<li>You need curl installed on your host</li> <li>You need curl installed on your host</li>
</ol> </ol>
<h2 id="install-docker"><a class="toclink" href="#install-docker">Install Docker</a></h2> <h2 id="install-docker"><a class="toclink" href="#install-docker">Install Docker</a></h2>
<p>Follow the Docs here: <a href="https://docs.docker.com/engine/install/">https://docs.docker.com/engine/install/</a> and install Docker on your host.</p> <p>Follow the Docs here: <a href="https://docs.docker.com/engine/install/">https://docs.docker.com/engine/install/</a> and install Docker on your host.</p>
<h2 id="install-wg-easy"><a class="toclink" href="#install-wg-easy">Install <code>wg-easy</code></a></h2> <h2 id="install-wg-easy"><a class="toclink" href="#install-wg-easy">Install <code>wg-easy</code></a></h2>
<ol> <ol>
<li>Create a directory for the configuration files (you can choose any directory you like):</li> <li>
</ol> <p>Create a directory for the configuration files (you can choose any directory you like):</p>
<div class="highlight"><pre><span></span><code><span class="nv">DIR</span><span class="o">=</span>/docker/wg-easy <div class="highlight"><pre><span></span><code>sudo<span class="w"> </span>mkdir<span class="w"> </span>-p<span class="w"> </span>/etc/docker/containers/wg-easy
sudo<span class="w"> </span>mkdir<span class="w"> </span>-p<span class="w"> </span><span class="nv">$DIR</span>
</code></pre></div> </code></pre></div>
<ol> </li>
<li>Download docker compose file</li> <li>
</ol> <p>Download docker compose file</p>
<div class="highlight"><pre><span></span><code>sudo<span class="w"> </span>curl<span class="w"> </span>-o<span class="w"> </span><span class="nv">$DIR</span>/docker-compose.yml<span class="w"> </span>https://raw.githubusercontent.com/wg-easy/wg-easy/master/docker-compose.yml <div class="highlight"><pre><span></span><code>sudo<span class="w"> </span>curl<span class="w"> </span>-o<span class="w"> </span>/etc/docker/containers/wg-easy/docker-compose.yml<span class="w"> </span>https://raw.githubusercontent.com/wg-easy/wg-easy/master/docker-compose.yml
</code></pre></div> </code></pre></div>
<ol> </li>
<li>Start <code>wg-easy</code></li> <li>
</ol> <p>Start <code>wg-easy</code></p>
<div class="highlight"><pre><span></span><code><span class="w"> </span>sudo<span class="w"> </span>docker-compose<span class="w"> </span>-f<span class="w"> </span><span class="nv">$DIR</span>/docker-compose.yml<span class="w"> </span>up<span class="w"> </span>-d <div class="highlight"><pre><span></span><code><span class="w"> </span><span class="nb">cd</span><span class="w"> </span>/etc/docker/containers/wg-easy
<span class="w"> </span>sudo<span class="w"> </span>docker-compose<span class="w"> </span>up<span class="w"> </span>-d
</code></pre></div> </code></pre></div>
</li>
</ol>
<h2 id="setup-firewall"><a class="toclink" href="#setup-firewall">Setup Firewall</a></h2> <h2 id="setup-firewall"><a class="toclink" href="#setup-firewall">Setup Firewall</a></h2>
<p>If you are using a firewall, you need to open the following ports:</p> <p>If you are using a firewall, you need to open the following ports:</p>
<ul> <ul>
<li>UDP 51820 (WireGuard)</li> <li>UDP 51820 (WireGuard)</li>
<li>TCP 51821 (Web UI)</li>
</ul> </ul>
<p>These ports can be changed, so if you change them you have to update your firewall rules accordingly.</p> <p>These ports can be changed, so if you change them you have to update your firewall rules accordingly.</p>
<h2 id="setup-reverse-proxy"><a class="toclink" href="#setup-reverse-proxy">Setup Reverse Proxy</a></h2> <h2 id="setup-reverse-proxy"><a class="toclink" href="#setup-reverse-proxy">Setup Reverse Proxy</a></h2>
<p>TODO</p> <ul>
<h2 id="access-the-web-ui"><a class="toclink" href="#access-the-web-ui">Access the Web UI</a></h2> <li>To setup traefik follow the instructions here: <a href="../traefik/">Traefik</a></li>
<p>Open your browser and navigate to <code>https://&lt;your-domain&gt;:51821</code> or <code>https://&lt;your-ip&gt;:51821</code>.</p> <li>To setup caddy follow the instructions here: <a href="../caddy/">Caddy</a></li>
<p>Follow the instructions to set up your WireGuard VPN.</p> <li>If you do not want to use a reverse proxy follow the instructions here: <a href="../reverse-proxyless/">No Reverse Proxy</a></li>
</ul>
<h2 id="update-wg-easy"><a class="toclink" href="#update-wg-easy">Update <code>wg-easy</code></a></h2> <h2 id="update-wg-easy"><a class="toclink" href="#update-wg-easy">Update <code>wg-easy</code></a></h2>
<p>To update <code>wg-easy</code> to the latest version, run:</p> <p>To update <code>wg-easy</code> to the latest version, run:</p>
<div class="highlight"><pre><span></span><code>sudo<span class="w"> </span>docker-compose<span class="w"> </span>-f<span class="w"> </span><span class="nv">$DIR</span>/docker-compose.yml<span class="w"> </span>pull <div class="highlight"><pre><span></span><code><span class="nb">cd</span><span class="w"> </span>/etc/docker/containers/wg-easy
sudo<span class="w"> </span>docker-compose<span class="w"> </span>-f<span class="w"> </span><span class="nv">$DIR</span>/docker-compose.yml<span class="w"> </span>up<span class="w"> </span>-d sudo<span class="w"> </span>docker-compose<span class="w"> </span>pull
sudo<span class="w"> </span>docker-compose<span class="w"> </span>up<span class="w"> </span>-d
</code></pre></div> </code></pre></div>
<h2 id="auto-update"><a class="toclink" href="#auto-update">Auto Update</a></h2> <h2 id="auto-update"><a class="toclink" href="#auto-update">Auto Update</a></h2>
<p>If you want to enable auto-updates, follow the instructions here: <a href="../auto-updates/">Auto Updates</a></p> <p>If you want to enable auto-updates, follow the instructions here: <a href="../auto-updates/">Auto Updates</a></p>
@ -1467,10 +1726,12 @@ sudo<span class="w"> </span>docker-compose<span class="w"> </span>-f<span class=
</div> </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> </body>

517
development/examples/tutorials/caddy/index.html

@ -22,7 +22,7 @@
<link rel="icon" href="../../../assets/logo/favicon.png"> <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"> <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
@ -77,6 +77,11 @@
<label class="md-overlay" for="__drawer"></label> <label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip"> <div data-md-component="skip">
<a href="#create-a-docker-composition-for-caddy" class="md-skip">
Skip to content
</a>
</div> </div>
<div data-md-component="announce"> <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 class="md-header__button md-icon" for="__search">
</label>
<div class="md-search" data-md-component="search" role="dialog"> <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> <label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search"> <div class="md-search__inner" role="search">
<form class="md-search__form" name="search"> <form class="md-search__form" name="search">
@ -184,6 +191,7 @@
</div> </div>
</div> </div>
</div> </div>
<div class="md-header__source"> <div class="md-header__source">
@ -216,10 +224,12 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../.." class="md-tabs__link"> <a href="../../.." class="md-tabs__link">
Home 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"> <li class="md-tabs__item">
<a href="../../../getting-started/" class="md-tabs__link"> <a href="../../../getting-started/" class="md-tabs__link">
Getting Started Getting Started
@ -250,12 +281,14 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../../advanced/api/" class="md-tabs__link"> <a href="../../../advanced/api/" class="md-tabs__link">
Advanced Advanced
</a> </a>
@ -268,12 +301,14 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../../contributing/general/" class="md-tabs__link"> <a href="../../../contributing/general/" class="md-tabs__link">
Contributing Contributing
</a> </a>
@ -285,6 +320,7 @@
@ -293,6 +329,7 @@
@ -302,6 +339,7 @@
<a href="../adguard/" class="md-tabs__link"> <a href="../adguard/" class="md-tabs__link">
Examples Examples
</a> </a>
@ -313,6 +351,26 @@
<li class="md-tabs__item">
<a href="../../../guides/2fa/" class="md-tabs__link">
Guides
</a>
</li>
</ul> </ul>
</div> </div>
</nav> </nav>
@ -367,6 +425,7 @@
<a href="../../.." class="md-nav__link"> <a href="../../.." class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Home Home
@ -384,10 +443,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"> <li class="md-nav__item">
<a href="../../../getting-started/" class="md-nav__link"> <a href="../../../getting-started/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Getting Started Getting Started
@ -408,6 +490,7 @@
@ -418,12 +501,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" > <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0"> <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis"> <span class="md-ellipsis">
Advanced Advanced
@ -433,8 +517,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3"> <label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Advanced Advanced
</label> </label>
@ -450,6 +534,7 @@
<a href="../../../advanced/api/" class="md-nav__link"> <a href="../../../advanced/api/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
API API
@ -471,6 +556,7 @@
@ -481,12 +567,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"> <span class="md-ellipsis">
Config Config
@ -496,8 +583,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_2"> <label class="md-nav__title" for="__nav_4_2">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Config Config
</label> </label>
@ -513,6 +600,7 @@
<a href="../../../advanced/config/optional-config/" class="md-nav__link"> <a href="../../../advanced/config/optional-config/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Optional Configuration Optional Configuration
@ -535,6 +623,7 @@
<a href="../../../advanced/config/unattended-setup/" class="md-nav__link"> <a href="../../../advanced/config/unattended-setup/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Unattended Setup Unattended Setup
@ -564,6 +653,7 @@
@ -574,12 +664,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"> <span class="md-ellipsis">
Metrics Metrics
@ -589,8 +680,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_3_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_3"> <label class="md-nav__title" for="__nav_4_3">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Metrics Metrics
</label> </label>
@ -606,6 +697,7 @@
<a href="../../../advanced/metrics/prometheus/" class="md-nav__link"> <a href="../../../advanced/metrics/prometheus/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Prometheus Prometheus
@ -635,6 +727,7 @@
@ -645,12 +738,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"> <span class="md-ellipsis">
Migrate Migrate
@ -660,8 +754,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_4"> <label class="md-nav__title" for="__nav_4_4">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Migrate Migrate
</label> </label>
@ -677,6 +771,7 @@
<a href="../../../advanced/migrate/" class="md-nav__link"> <a href="../../../advanced/migrate/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate Migrate
@ -699,6 +794,7 @@
<a href="../../../advanced/migrate/from-14-to-15/" class="md-nav__link"> <a href="../../../advanced/migrate/from-14-to-15/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate from v14 to v15 Migrate from v14 to v15
@ -735,6 +831,7 @@
@ -745,12 +842,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"> <span class="md-ellipsis">
Contributing Contributing
@ -760,8 +858,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4"> <label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Contributing Contributing
</label> </label>
@ -777,6 +875,7 @@
<a href="../../../contributing/general/" class="md-nav__link"> <a href="../../../contributing/general/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
General Information General Information
@ -799,6 +898,7 @@
<a href="../../../contributing/issues-and-pull-requests/" class="md-nav__link"> <a href="../../../contributing/issues-and-pull-requests/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Issues and Pull Requests Issues and Pull Requests
@ -829,6 +929,7 @@
@ -840,12 +941,13 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex=""> <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
<span class="md-ellipsis"> <span class="md-ellipsis">
Examples Examples
@ -855,8 +957,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_5"> <label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Examples Examples
</label> </label>
@ -873,6 +975,7 @@
@ -881,12 +984,13 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_1" checked> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" checked>
<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"> <span class="md-ellipsis">
Tutorials Tutorials
@ -896,8 +1000,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_1_label" aria-expanded="true"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_5_1"> <label class="md-nav__title" for="__nav_6_1">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Tutorials Tutorials
</label> </label>
@ -913,6 +1017,7 @@
<a href="../adguard/" class="md-nav__link"> <a href="../adguard/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
AdGuard Home AdGuard Home
@ -935,6 +1040,7 @@
<a href="../auto-updates/" class="md-nav__link"> <a href="../auto-updates/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Auto Updates Auto Updates
@ -957,6 +1063,7 @@
<a href="../basic-installation/" class="md-nav__link"> <a href="../basic-installation/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Basic Installation Basic Installation
@ -983,9 +1090,23 @@
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Caddy
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active"> <a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis"> <span class="md-ellipsis">
Caddy Caddy
@ -994,6 +1115,41 @@
</a> </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="#create-a-docker-composition-for-caddy" class="md-nav__link">
<span class="md-ellipsis">
Create a docker composition for caddy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#adapt-the-docker-composition-of-wg-easy" class="md-nav__link">
<span class="md-ellipsis">
Adapt the docker composition of wg-easy
</span>
</a>
</li>
</ul>
</nav>
</li> </li>
@ -1009,6 +1165,7 @@
<a href="../docker-run/" class="md-nav__link"> <a href="../docker-run/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Docker Run Docker Run
@ -1031,6 +1188,7 @@
<a href="../dockerless/" class="md-nav__link"> <a href="../dockerless/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Without Docker Without Docker
@ -1050,11 +1208,12 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="../nginx/" class="md-nav__link"> <a href="../podman-nft/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
NGINX Podman + nftables
</span> </span>
@ -1072,11 +1231,12 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="../podman/" class="md-nav__link"> <a href="../reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Podman No Reverse Proxy
</span> </span>
@ -1097,6 +1257,7 @@
<a href="../traefik/" class="md-nav__link"> <a href="../traefik/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Traefik Traefik
@ -1124,6 +1285,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> </ul>
</nav> </nav>
</div> </div>
@ -1142,6 +1468,32 @@
<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="#create-a-docker-composition-for-caddy" class="md-nav__link">
<span class="md-ellipsis">
Create a docker composition for caddy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#adapt-the-docker-composition-of-wg-easy" class="md-nav__link">
<span class="md-ellipsis">
Adapt the docker composition of wg-easy
</span>
</a>
</li>
</ul>
</nav> </nav>
</div> </div>
</div> </div>
@ -1174,7 +1526,86 @@
<h1>Caddy</h1> <h1>Caddy</h1>
<p>TODO</p> <div class="admonition note">
<p class="admonition-title">Opinionated</p>
<p>This guide is opinionated. If you use other conventions or folder layouts, feel free to change the commands and paths.</p>
</div>
<p>We're using <a href="https://caddyserver.com/">Caddy</a> here as reserve proxy to serve <code>wg-easy</code> on <a href="https://wg-easy.example.com">https://wg-easy.example.com</a> via TLS.</p>
<h2 id="create-a-docker-composition-for-caddy"><a class="toclink" href="#create-a-docker-composition-for-caddy">Create a docker composition for <code>caddy</code></a></h2>
<div class="highlight"><pre><span></span><code>.
├── compose.yml
└── Caddyfile
1 directory, 2 files
</code></pre></div>
<div class="highlight"><pre><span></span><code><span class="c1"># compose.yml</span>
<span class="nt">services</span><span class="p">:</span>
<span class="w"> </span><span class="nt">caddy</span><span class="p">:</span>
<span class="w"> </span><span class="nt">container_name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">caddy</span>
<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">caddy:2.10.0-alpine</span>
<span class="w"> </span><span class="c1"># publish everything you deem necessary</span>
<span class="w"> </span><span class="nt">ports</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&#39;80:80/tcp&#39;</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&#39;443:443/tcp&#39;</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&#39;443:443/udp&#39;</span>
<span class="w"> </span><span class="nt">networks</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">caddy</span>
<span class="w"> </span><span class="nt">restart</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">unless-stopped</span>
<span class="w"> </span><span class="nt">volumes</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&#39;./Caddyfile:/etc/caddy/Caddyfile:ro&#39;</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">config:/config</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">data:/data</span>
<span class="nt">networks</span><span class="p">:</span>
<span class="w"> </span><span class="nt">caddy</span><span class="p">:</span>
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">caddy</span>
<span class="nt">volumes</span><span class="p">:</span>
<span class="w"> </span><span class="nt">config</span><span class="p">:</span>
<span class="w"> </span><span class="nt">data</span><span class="p">:</span>
</code></pre></div>
<div class="highlight"><pre><span></span><code># Caddyfile
{
# setup your email address
email [email protected]
}
wg-easy.example.com {
# since the container will share the network with wg-easy
# we can use the proper container name
reverse_proxy wg-easy:80
tls internal
}
</code></pre></div>
<p>...and start it with:</p>
<div class="highlight"><pre><span></span><code>sudo<span class="w"> </span>docker-compose<span class="w"> </span>up<span class="w"> </span>-d
</code></pre></div>
<h2 id="adapt-the-docker-composition-of-wg-easy"><a class="toclink" href="#adapt-the-docker-composition-of-wg-easy">Adapt the docker composition of <code>wg-easy</code></a></h2>
<div class="highlight"><pre><span></span><code><span class="nt">services</span><span class="p">:</span>
<span class="w"> </span><span class="nt">wg-easy</span><span class="p">:</span>
<span class="w"> </span><span class="c1"># sync container name and port according to Caddyfile</span>
<span class="w"> </span><span class="nt">container_name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">wg-easy</span>
<span class="w"> </span><span class="nt">environment</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PORT=80</span>
<span class="w"> </span><span class="c1"># no need to publish the HTTP server anymore</span>
<span class="w"> </span><span class="nt">ports</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&quot;51820:51820/udp&quot;</span>
<span class="w"> </span><span class="c1"># add to caddy network</span>
<span class="w"> </span><span class="nt">networks</span><span class="p">:</span>
<span class="w"> </span><span class="nt">caddy</span><span class="p">:</span>
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
<span class="nt">networks</span><span class="p">:</span>
<span class="w"> </span><span class="nt">caddy</span><span class="p">:</span>
<span class="w"> </span><span class="nt">external</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
</code></pre></div>
<p>...and restart it with:</p>
<div class="highlight"><pre><span></span><code>sudo<span class="w"> </span>docker-compose<span class="w"> </span>up<span class="w"> </span>-d
</code></pre></div>
<p>You can now access <code>wg-easy</code> at <a href="https://wg-easy.example.com">https://wg-easy.example.com</a> and start the setup.</p>
@ -1235,10 +1666,12 @@
</div> </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> </body>

368
development/examples/tutorials/docker-run/index.html

@ -22,7 +22,7 @@
<link rel="icon" href="../../../assets/logo/favicon.png"> <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"> <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 class="md-header__button md-icon" for="__search">
</label>
<div class="md-search" data-md-component="search" role="dialog"> <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> <label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search"> <div class="md-search__inner" role="search">
<form class="md-search__form" name="search"> <form class="md-search__form" name="search">
@ -184,6 +186,7 @@
</div> </div>
</div> </div>
</div> </div>
<div class="md-header__source"> <div class="md-header__source">
@ -216,10 +219,12 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../.." class="md-tabs__link"> <a href="../../.." class="md-tabs__link">
Home 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"> <li class="md-tabs__item">
<a href="../../../getting-started/" class="md-tabs__link"> <a href="../../../getting-started/" class="md-tabs__link">
Getting Started Getting Started
@ -250,12 +276,14 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../../advanced/api/" class="md-tabs__link"> <a href="../../../advanced/api/" class="md-tabs__link">
Advanced Advanced
</a> </a>
@ -268,12 +296,14 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../../contributing/general/" class="md-tabs__link"> <a href="../../../contributing/general/" class="md-tabs__link">
Contributing Contributing
</a> </a>
@ -285,6 +315,7 @@
@ -293,6 +324,7 @@
@ -302,6 +334,7 @@
<a href="../adguard/" class="md-tabs__link"> <a href="../adguard/" class="md-tabs__link">
Examples Examples
</a> </a>
@ -313,6 +346,26 @@
<li class="md-tabs__item">
<a href="../../../guides/2fa/" class="md-tabs__link">
Guides
</a>
</li>
</ul> </ul>
</div> </div>
</nav> </nav>
@ -367,6 +420,7 @@
<a href="../../.." class="md-nav__link"> <a href="../../.." class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Home Home
@ -384,10 +438,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"> <li class="md-nav__item">
<a href="../../../getting-started/" class="md-nav__link"> <a href="../../../getting-started/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Getting Started Getting Started
@ -408,6 +485,7 @@
@ -418,12 +496,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" > <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0"> <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis"> <span class="md-ellipsis">
Advanced Advanced
@ -433,8 +512,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3"> <label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Advanced Advanced
</label> </label>
@ -450,6 +529,7 @@
<a href="../../../advanced/api/" class="md-nav__link"> <a href="../../../advanced/api/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
API API
@ -471,6 +551,7 @@
@ -481,12 +562,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"> <span class="md-ellipsis">
Config Config
@ -496,8 +578,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_2"> <label class="md-nav__title" for="__nav_4_2">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Config Config
</label> </label>
@ -513,6 +595,7 @@
<a href="../../../advanced/config/optional-config/" class="md-nav__link"> <a href="../../../advanced/config/optional-config/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Optional Configuration Optional Configuration
@ -535,6 +618,7 @@
<a href="../../../advanced/config/unattended-setup/" class="md-nav__link"> <a href="../../../advanced/config/unattended-setup/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Unattended Setup Unattended Setup
@ -564,6 +648,7 @@
@ -574,12 +659,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"> <span class="md-ellipsis">
Metrics Metrics
@ -589,8 +675,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_3_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_3"> <label class="md-nav__title" for="__nav_4_3">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Metrics Metrics
</label> </label>
@ -606,6 +692,7 @@
<a href="../../../advanced/metrics/prometheus/" class="md-nav__link"> <a href="../../../advanced/metrics/prometheus/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Prometheus Prometheus
@ -635,6 +722,7 @@
@ -645,12 +733,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"> <span class="md-ellipsis">
Migrate Migrate
@ -660,8 +749,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_4"> <label class="md-nav__title" for="__nav_4_4">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Migrate Migrate
</label> </label>
@ -677,6 +766,7 @@
<a href="../../../advanced/migrate/" class="md-nav__link"> <a href="../../../advanced/migrate/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate Migrate
@ -699,6 +789,7 @@
<a href="../../../advanced/migrate/from-14-to-15/" class="md-nav__link"> <a href="../../../advanced/migrate/from-14-to-15/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate from v14 to v15 Migrate from v14 to v15
@ -735,6 +826,7 @@
@ -745,12 +837,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"> <span class="md-ellipsis">
Contributing Contributing
@ -760,8 +853,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4"> <label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Contributing Contributing
</label> </label>
@ -777,6 +870,7 @@
<a href="../../../contributing/general/" class="md-nav__link"> <a href="../../../contributing/general/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
General Information General Information
@ -799,6 +893,7 @@
<a href="../../../contributing/issues-and-pull-requests/" class="md-nav__link"> <a href="../../../contributing/issues-and-pull-requests/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Issues and Pull Requests Issues and Pull Requests
@ -829,6 +924,7 @@
@ -840,12 +936,13 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex=""> <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
<span class="md-ellipsis"> <span class="md-ellipsis">
Examples Examples
@ -855,8 +952,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_5"> <label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Examples Examples
</label> </label>
@ -873,6 +970,7 @@
@ -881,12 +979,13 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_1" checked> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" checked>
<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"> <span class="md-ellipsis">
Tutorials Tutorials
@ -896,8 +995,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_1_label" aria-expanded="true"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_5_1"> <label class="md-nav__title" for="__nav_6_1">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Tutorials Tutorials
</label> </label>
@ -913,6 +1012,7 @@
<a href="../adguard/" class="md-nav__link"> <a href="../adguard/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
AdGuard Home AdGuard Home
@ -935,6 +1035,7 @@
<a href="../auto-updates/" class="md-nav__link"> <a href="../auto-updates/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Auto Updates Auto Updates
@ -957,6 +1058,7 @@
<a href="../basic-installation/" class="md-nav__link"> <a href="../basic-installation/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Basic Installation Basic Installation
@ -979,6 +1081,7 @@
<a href="../caddy/" class="md-nav__link"> <a href="../caddy/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Caddy Caddy
@ -1008,6 +1111,7 @@
<a href="./" class="md-nav__link md-nav__link--active"> <a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis"> <span class="md-ellipsis">
Docker Run Docker Run
@ -1031,6 +1135,7 @@
<a href="../dockerless/" class="md-nav__link"> <a href="../dockerless/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Without Docker Without Docker
@ -1050,11 +1155,12 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="../nginx/" class="md-nav__link"> <a href="../podman-nft/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
NGINX Podman + nftables
</span> </span>
@ -1072,11 +1178,12 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="../podman/" class="md-nav__link"> <a href="../reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Podman No Reverse Proxy
</span> </span>
@ -1097,6 +1204,7 @@
<a href="../traefik/" class="md-nav__link"> <a href="../traefik/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Traefik Traefik
@ -1124,6 +1232,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> </ul>
</nav> </nav>
</div> </div>
@ -1175,7 +1448,7 @@
<h1>Docker Run</h1> <h1>Docker Run</h1>
<p>To setup the IPv6 Network, simply run once:</p> <p>To setup the IPv6 Network, simply run once:</p>
<div class="highlight"><pre><span></span><code><span class="w"> </span>docker<span class="w"> </span>network<span class="w"> </span>create<span class="w"> </span><span class="se">\</span> <div class="highlight"><pre><span></span><code>docker<span class="w"> </span>network<span class="w"> </span>create<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>-d<span class="w"> </span>bridge<span class="w"> </span>--ipv6<span class="w"> </span><span class="se">\</span> <span class="w"> </span>-d<span class="w"> </span>bridge<span class="w"> </span>--ipv6<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>-d<span class="w"> </span>default<span class="w"> </span><span class="se">\</span> <span class="w"> </span>-d<span class="w"> </span>default<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>--subnet<span class="w"> </span><span class="m">10</span>.42.42.0/24<span class="w"> </span><span class="se">\</span> <span class="w"> </span>--subnet<span class="w"> </span><span class="m">10</span>.42.42.0/24<span class="w"> </span><span class="se">\</span>
@ -1183,8 +1456,8 @@
</code></pre></div> </code></pre></div>
<!-- ref: major version --> <!-- ref: major version -->
<p>To automatically install &amp; run ``wg-easy, simply run:</p> <p>To automatically install &amp; run <code>wg-easy</code>, simply run:</p>
<div class="highlight"><pre><span></span><code><span class="w"> </span>docker<span class="w"> </span>run<span class="w"> </span>-d<span class="w"> </span><span class="se">\</span> <div class="highlight"><pre><span></span><code>docker<span class="w"> </span>run<span class="w"> </span>-d<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>--net<span class="w"> </span>wg<span class="w"> </span><span class="se">\</span> <span class="w"> </span>--net<span class="w"> </span>wg<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>-e<span class="w"> </span><span class="nv">INSECURE</span><span class="o">=</span><span class="nb">true</span><span class="w"> </span><span class="se">\</span> <span class="w"> </span>-e<span class="w"> </span><span class="nv">INSECURE</span><span class="o">=</span><span class="nb">true</span><span class="w"> </span><span class="se">\</span>
<span class="w"> </span>--name<span class="w"> </span>wg-easy<span class="w"> </span><span class="se">\</span> <span class="w"> </span>--name<span class="w"> </span>wg-easy<span class="w"> </span><span class="se">\</span>
@ -1204,10 +1477,7 @@
<span class="w"> </span>--restart<span class="w"> </span>unless-stopped<span class="w"> </span><span class="se">\</span> <span class="w"> </span>--restart<span class="w"> </span>unless-stopped<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>ghcr.io/wg-easy/wg-easy:15 <span class="w"> </span>ghcr.io/wg-easy/wg-easy:15
</code></pre></div> </code></pre></div>
<p>The Web UI will now be available on <code>http://0.0.0.0:51821</code>.</p> <p>The Web UI will now be available at <a href="http://0.0.0.0:51821">http://0.0.0.0:51821</a>.</p>
<blockquote>
<p>💡 Your configuration files will be saved in <code>~/.wg-easy</code></p>
</blockquote>
@ -1268,10 +1538,12 @@
</div> </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> </body>

362
development/examples/tutorials/dockerless/index.html

@ -18,11 +18,11 @@
<link rel="prev" href="../docker-run/"> <link rel="prev" href="../docker-run/">
<link rel="next" href="../nginx/"> <link rel="next" href="../podman-nft/">
<link rel="icon" href="../../../assets/logo/favicon.png"> <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"> <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 class="md-header__button md-icon" for="__search">
</label>
<div class="md-search" data-md-component="search" role="dialog"> <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> <label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search"> <div class="md-search__inner" role="search">
<form class="md-search__form" name="search"> <form class="md-search__form" name="search">
@ -184,6 +186,7 @@
</div> </div>
</div> </div>
</div> </div>
<div class="md-header__source"> <div class="md-header__source">
@ -216,10 +219,12 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../.." class="md-tabs__link"> <a href="../../.." class="md-tabs__link">
Home 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"> <li class="md-tabs__item">
<a href="../../../getting-started/" class="md-tabs__link"> <a href="../../../getting-started/" class="md-tabs__link">
Getting Started Getting Started
@ -250,12 +276,14 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../../advanced/api/" class="md-tabs__link"> <a href="../../../advanced/api/" class="md-tabs__link">
Advanced Advanced
</a> </a>
@ -268,12 +296,14 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../../contributing/general/" class="md-tabs__link"> <a href="../../../contributing/general/" class="md-tabs__link">
Contributing Contributing
</a> </a>
@ -285,6 +315,7 @@
@ -293,6 +324,7 @@
@ -302,6 +334,7 @@
<a href="../adguard/" class="md-tabs__link"> <a href="../adguard/" class="md-tabs__link">
Examples Examples
</a> </a>
@ -313,6 +346,26 @@
<li class="md-tabs__item">
<a href="../../../guides/2fa/" class="md-tabs__link">
Guides
</a>
</li>
</ul> </ul>
</div> </div>
</nav> </nav>
@ -367,6 +420,7 @@
<a href="../../.." class="md-nav__link"> <a href="../../.." class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Home Home
@ -384,10 +438,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"> <li class="md-nav__item">
<a href="../../../getting-started/" class="md-nav__link"> <a href="../../../getting-started/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Getting Started Getting Started
@ -408,6 +485,7 @@
@ -418,12 +496,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" > <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0"> <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis"> <span class="md-ellipsis">
Advanced Advanced
@ -433,8 +512,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3"> <label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Advanced Advanced
</label> </label>
@ -450,6 +529,7 @@
<a href="../../../advanced/api/" class="md-nav__link"> <a href="../../../advanced/api/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
API API
@ -471,6 +551,7 @@
@ -481,12 +562,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"> <span class="md-ellipsis">
Config Config
@ -496,8 +578,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_2"> <label class="md-nav__title" for="__nav_4_2">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Config Config
</label> </label>
@ -513,6 +595,7 @@
<a href="../../../advanced/config/optional-config/" class="md-nav__link"> <a href="../../../advanced/config/optional-config/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Optional Configuration Optional Configuration
@ -535,6 +618,7 @@
<a href="../../../advanced/config/unattended-setup/" class="md-nav__link"> <a href="../../../advanced/config/unattended-setup/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Unattended Setup Unattended Setup
@ -564,6 +648,7 @@
@ -574,12 +659,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"> <span class="md-ellipsis">
Metrics Metrics
@ -589,8 +675,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_3_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_3"> <label class="md-nav__title" for="__nav_4_3">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Metrics Metrics
</label> </label>
@ -606,6 +692,7 @@
<a href="../../../advanced/metrics/prometheus/" class="md-nav__link"> <a href="../../../advanced/metrics/prometheus/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Prometheus Prometheus
@ -635,6 +722,7 @@
@ -645,12 +733,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"> <span class="md-ellipsis">
Migrate Migrate
@ -660,8 +749,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_4"> <label class="md-nav__title" for="__nav_4_4">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Migrate Migrate
</label> </label>
@ -677,6 +766,7 @@
<a href="../../../advanced/migrate/" class="md-nav__link"> <a href="../../../advanced/migrate/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate Migrate
@ -699,6 +789,7 @@
<a href="../../../advanced/migrate/from-14-to-15/" class="md-nav__link"> <a href="../../../advanced/migrate/from-14-to-15/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate from v14 to v15 Migrate from v14 to v15
@ -735,6 +826,7 @@
@ -745,12 +837,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"> <span class="md-ellipsis">
Contributing Contributing
@ -760,8 +853,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4"> <label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Contributing Contributing
</label> </label>
@ -777,6 +870,7 @@
<a href="../../../contributing/general/" class="md-nav__link"> <a href="../../../contributing/general/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
General Information General Information
@ -799,6 +893,7 @@
<a href="../../../contributing/issues-and-pull-requests/" class="md-nav__link"> <a href="../../../contributing/issues-and-pull-requests/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Issues and Pull Requests Issues and Pull Requests
@ -829,6 +924,7 @@
@ -840,12 +936,13 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex=""> <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
<span class="md-ellipsis"> <span class="md-ellipsis">
Examples Examples
@ -855,8 +952,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_5"> <label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Examples Examples
</label> </label>
@ -873,6 +970,7 @@
@ -881,12 +979,13 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_1" checked> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" checked>
<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"> <span class="md-ellipsis">
Tutorials Tutorials
@ -896,8 +995,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_1_label" aria-expanded="true"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_5_1"> <label class="md-nav__title" for="__nav_6_1">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Tutorials Tutorials
</label> </label>
@ -913,6 +1012,7 @@
<a href="../adguard/" class="md-nav__link"> <a href="../adguard/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
AdGuard Home AdGuard Home
@ -935,6 +1035,7 @@
<a href="../auto-updates/" class="md-nav__link"> <a href="../auto-updates/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Auto Updates Auto Updates
@ -957,6 +1058,7 @@
<a href="../basic-installation/" class="md-nav__link"> <a href="../basic-installation/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Basic Installation Basic Installation
@ -979,6 +1081,7 @@
<a href="../caddy/" class="md-nav__link"> <a href="../caddy/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Caddy Caddy
@ -1001,6 +1104,7 @@
<a href="../docker-run/" class="md-nav__link"> <a href="../docker-run/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Docker Run Docker Run
@ -1030,6 +1134,7 @@
<a href="./" class="md-nav__link md-nav__link--active"> <a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis"> <span class="md-ellipsis">
Without Docker Without Docker
@ -1050,11 +1155,12 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="../nginx/" class="md-nav__link"> <a href="../podman-nft/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
NGINX Podman + nftables
</span> </span>
@ -1072,11 +1178,12 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="../podman/" class="md-nav__link"> <a href="../reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Podman No Reverse Proxy
</span> </span>
@ -1097,6 +1204,7 @@
<a href="../traefik/" class="md-nav__link"> <a href="../traefik/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Traefik Traefik
@ -1124,6 +1232,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> </ul>
</nav> </nav>
</div> </div>
@ -1174,7 +1447,8 @@
<h1>Without Docker</h1> <h1>Without Docker</h1>
<p>TODO</p> <p>This is currently not yet supported.</p>
<!-- TODO -->
@ -1235,10 +1509,12 @@
</div> </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> </body>

432
development/examples/tutorials/podman/index.html → development/examples/tutorials/podman-nft/index.html

File diff suppressed because one or more lines are too long

470
development/examples/tutorials/nginx/index.html → development/examples/tutorials/reverse-proxyless/index.html

@ -12,25 +12,25 @@
<meta name="author" content="WireGuard Easy"> <meta name="author" content="WireGuard Easy">
<link rel="canonical" href="https://wg-easy.github.io/wg-easy/development/examples/tutorials/nginx/"> <link rel="canonical" href="https://wg-easy.github.io/wg-easy/development/examples/tutorials/reverse-proxyless/">
<link rel="prev" href="../dockerless/"> <link rel="prev" href="../podman-nft/">
<link rel="next" href="../podman/"> <link rel="next" href="../traefik/">
<link rel="icon" href="../../../assets/logo/favicon.png"> <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">
<title>NGINX - wg-easy</title> <title>No Reverse Proxy - wg-easy</title>
<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"> <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
@ -77,6 +77,11 @@
<label class="md-overlay" for="__drawer"></label> <label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip"> <div data-md-component="skip">
<a href="#setup" class="md-skip">
Skip to content
</a>
</div> </div>
<div data-md-component="announce"> <div data-md-component="announce">
@ -110,7 +115,7 @@
<div class="md-header__topic" data-md-component="header-topic"> <div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis"> <span class="md-ellipsis">
NGINX No Reverse Proxy
</span> </span>
</div> </div>
@ -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 class="md-header__button md-icon" for="__search">
</label>
<div class="md-search" data-md-component="search" role="dialog"> <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> <label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search"> <div class="md-search__inner" role="search">
<form class="md-search__form" name="search"> <form class="md-search__form" name="search">
@ -184,6 +191,7 @@
</div> </div>
</div> </div>
</div> </div>
<div class="md-header__source"> <div class="md-header__source">
@ -216,10 +224,12 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../.." class="md-tabs__link"> <a href="../../.." class="md-tabs__link">
Home 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"> <li class="md-tabs__item">
<a href="../../../getting-started/" class="md-tabs__link"> <a href="../../../getting-started/" class="md-tabs__link">
Getting Started Getting Started
@ -250,12 +281,14 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../../advanced/api/" class="md-tabs__link"> <a href="../../../advanced/api/" class="md-tabs__link">
Advanced Advanced
</a> </a>
@ -268,12 +301,14 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../../../contributing/general/" class="md-tabs__link"> <a href="../../../contributing/general/" class="md-tabs__link">
Contributing Contributing
</a> </a>
@ -285,6 +320,7 @@
@ -293,6 +329,7 @@
@ -302,6 +339,7 @@
<a href="../adguard/" class="md-tabs__link"> <a href="../adguard/" class="md-tabs__link">
Examples Examples
</a> </a>
@ -313,6 +351,26 @@
<li class="md-tabs__item">
<a href="../../../guides/2fa/" class="md-tabs__link">
Guides
</a>
</li>
</ul> </ul>
</div> </div>
</nav> </nav>
@ -367,6 +425,7 @@
<a href="../../.." class="md-nav__link"> <a href="../../.." class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Home Home
@ -384,10 +443,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"> <li class="md-nav__item">
<a href="../../../getting-started/" class="md-nav__link"> <a href="../../../getting-started/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Getting Started Getting Started
@ -408,6 +490,7 @@
@ -418,12 +501,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" > <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0"> <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis"> <span class="md-ellipsis">
Advanced Advanced
@ -433,8 +517,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3"> <label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Advanced Advanced
</label> </label>
@ -450,6 +534,7 @@
<a href="../../../advanced/api/" class="md-nav__link"> <a href="../../../advanced/api/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
API API
@ -471,6 +556,7 @@
@ -481,12 +567,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"> <span class="md-ellipsis">
Config Config
@ -496,8 +583,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_2"> <label class="md-nav__title" for="__nav_4_2">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Config Config
</label> </label>
@ -513,6 +600,7 @@
<a href="../../../advanced/config/optional-config/" class="md-nav__link"> <a href="../../../advanced/config/optional-config/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Optional Configuration Optional Configuration
@ -535,6 +623,7 @@
<a href="../../../advanced/config/unattended-setup/" class="md-nav__link"> <a href="../../../advanced/config/unattended-setup/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Unattended Setup Unattended Setup
@ -564,6 +653,7 @@
@ -574,12 +664,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"> <span class="md-ellipsis">
Metrics Metrics
@ -589,8 +680,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_3_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_3"> <label class="md-nav__title" for="__nav_4_3">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Metrics Metrics
</label> </label>
@ -606,6 +697,7 @@
<a href="../../../advanced/metrics/prometheus/" class="md-nav__link"> <a href="../../../advanced/metrics/prometheus/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Prometheus Prometheus
@ -635,6 +727,7 @@
@ -645,12 +738,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"> <span class="md-ellipsis">
Migrate Migrate
@ -660,8 +754,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_4"> <label class="md-nav__title" for="__nav_4_4">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Migrate Migrate
</label> </label>
@ -677,6 +771,7 @@
<a href="../../../advanced/migrate/" class="md-nav__link"> <a href="../../../advanced/migrate/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate Migrate
@ -699,6 +794,7 @@
<a href="../../../advanced/migrate/from-14-to-15/" class="md-nav__link"> <a href="../../../advanced/migrate/from-14-to-15/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate from v14 to v15 Migrate from v14 to v15
@ -735,6 +831,7 @@
@ -745,12 +842,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"> <span class="md-ellipsis">
Contributing Contributing
@ -760,8 +858,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4"> <label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Contributing Contributing
</label> </label>
@ -777,6 +875,7 @@
<a href="../../../contributing/general/" class="md-nav__link"> <a href="../../../contributing/general/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
General Information General Information
@ -799,6 +898,7 @@
<a href="../../../contributing/issues-and-pull-requests/" class="md-nav__link"> <a href="../../../contributing/issues-and-pull-requests/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Issues and Pull Requests Issues and Pull Requests
@ -829,6 +929,7 @@
@ -840,12 +941,13 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex=""> <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
<span class="md-ellipsis"> <span class="md-ellipsis">
Examples Examples
@ -855,8 +957,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_5"> <label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Examples Examples
</label> </label>
@ -873,6 +975,7 @@
@ -881,12 +984,13 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_1" checked> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" checked>
<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"> <span class="md-ellipsis">
Tutorials Tutorials
@ -896,8 +1000,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_1_label" aria-expanded="true"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_5_1"> <label class="md-nav__title" for="__nav_6_1">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Tutorials Tutorials
</label> </label>
@ -913,6 +1017,7 @@
<a href="../adguard/" class="md-nav__link"> <a href="../adguard/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
AdGuard Home AdGuard Home
@ -935,6 +1040,7 @@
<a href="../auto-updates/" class="md-nav__link"> <a href="../auto-updates/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Auto Updates Auto Updates
@ -957,6 +1063,7 @@
<a href="../basic-installation/" class="md-nav__link"> <a href="../basic-installation/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Basic Installation Basic Installation
@ -979,6 +1086,7 @@
<a href="../caddy/" class="md-nav__link"> <a href="../caddy/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Caddy Caddy
@ -1001,6 +1109,7 @@
<a href="../docker-run/" class="md-nav__link"> <a href="../docker-run/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Docker Run Docker Run
@ -1023,6 +1132,7 @@
<a href="../dockerless/" class="md-nav__link"> <a href="../dockerless/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Without Docker Without Docker
@ -1039,6 +1149,29 @@
<li class="md-nav__item">
<a href="../podman-nft/" class="md-nav__link">
<span class="md-ellipsis">
Podman + nftables
</span>
</a>
</li>
@ -1049,17 +1182,57 @@
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
No Reverse Proxy
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active"> <a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis"> <span class="md-ellipsis">
NGINX No Reverse Proxy
</span> </span>
</a> </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="#setup" class="md-nav__link">
<span class="md-ellipsis">
Setup
</span>
</a>
</li>
</ul>
</nav>
</li> </li>
@ -1072,11 +1245,12 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="../podman/" class="md-nav__link"> <a href="../traefik/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Podman Traefik
</span> </span>
@ -1087,6 +1261,64 @@
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<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>
@ -1094,11 +1326,12 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="../traefik/" class="md-nav__link"> <a href="../../../guides/2fa/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Traefik 2FA
</span> </span>
@ -1109,9 +1342,93 @@
</ul>
</nav>
<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> </li>
@ -1142,6 +1459,23 @@
<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="#setup" class="md-nav__link">
<span class="md-ellipsis">
Setup
</span>
</a>
</li>
</ul>
</nav> </nav>
</div> </div>
</div> </div>
@ -1156,7 +1490,7 @@
<a href="https://github.com/wg-easy/wg-easy/edit/master/docs/content/examples/tutorials/nginx.md" title="Edit this page" class="md-content__button md-icon"> <a href="https://github.com/wg-easy/wg-easy/edit/master/docs/content/examples/tutorials/reverse-proxyless.md" title="Edit this page" class="md-content__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M10 20H6V4h7v5h5v3.1l2-2V8l-6-6H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h4zm10.2-7c.1 0 .3.1.4.2l1.3 1.3c.2.2.2.6 0 .8l-1 1-2.1-2.1 1-1c.1-.1.2-.2.4-.2m0 3.9L14.1 23H12v-2.1l6.1-6.1z"/></svg> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M10 20H6V4h7v5h5v3.1l2-2V8l-6-6H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h4zm10.2-7c.1 0 .3.1.4.2l1.3 1.3c.2.2.2.6 0 .8l-1 1-2.1-2.1 1-1c.1-.1.2-.2.4-.2m0 3.9L14.1 23H12v-2.1l6.1-6.1z"/></svg>
</a> </a>
@ -1165,16 +1499,42 @@
<a href="https://github.com/wg-easy/wg-easy/raw/master/docs/content/examples/tutorials/nginx.md" title="View source of this page" class="md-content__button md-icon"> <a href="https://github.com/wg-easy/wg-easy/raw/master/docs/content/examples/tutorials/reverse-proxyless.md" title="View source of this page" class="md-content__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 18c.56 0 1 .44 1 1s-.44 1-1 1-1-.44-1-1 .44-1 1-1m0-3c-2.73 0-5.06 1.66-6 4 .94 2.34 3.27 4 6 4s5.06-1.66 6-4c-.94-2.34-3.27-4-6-4m0 6.5a2.5 2.5 0 0 1-2.5-2.5 2.5 2.5 0 0 1 2.5-2.5 2.5 2.5 0 0 1 2.5 2.5 2.5 2.5 0 0 1-2.5 2.5M9.27 20H6V4h7v5h5v4.07c.7.08 1.36.25 2 .49V8l-6-6H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h4.5a8.2 8.2 0 0 1-1.23-2"/></svg> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 18c.56 0 1 .44 1 1s-.44 1-1 1-1-.44-1-1 .44-1 1-1m0-3c-2.73 0-5.06 1.66-6 4 .94 2.34 3.27 4 6 4s5.06-1.66 6-4c-.94-2.34-3.27-4-6-4m0 6.5a2.5 2.5 0 0 1-2.5-2.5 2.5 2.5 0 0 1 2.5-2.5 2.5 2.5 0 0 1 2.5 2.5 2.5 2.5 0 0 1-2.5 2.5M9.27 20H6V4h7v5h5v4.07c.7.08 1.36.25 2 .49V8l-6-6H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h4.5a8.2 8.2 0 0 1-1.23-2"/></svg>
</a> </a>
<h1>NGINX</h1> <h1>No Reverse Proxy</h1>
<p>TODO</p> <div class="admonition warning">
<p class="admonition-title">Insecure</p>
<p>This is insecure. You should use a reverse proxy to secure the connection.</p>
<p>Only use this method if you know what you are doing.</p>
</div>
<p>If you only allow access to the web UI from your local network, you can skip the reverse proxy setup. This is not recommended, but it is possible.</p>
<h2 id="setup"><a class="toclink" href="#setup">Setup</a></h2>
<ul>
<li>
<p>Edit the <code>docker-compose.yml</code> file and uncomment <code>environment</code> and <code>INSECURE</code></p>
</li>
<li>
<p>Set <code>INSECURE</code> to <code>true</code> to allow access to the web UI over a non-secure connection.</p>
</li>
<li>
<p>The <code>docker-compose.yml</code> file should look something like this:</p>
<div class="highlight"><pre><span></span><code><span class="nt">environment</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">INSECURE=true</span>
</code></pre></div>
</li>
<li>
<p>Save the file and restart <code>wg-easy</code>.</p>
</li>
<li>
<p>Make sure that the Web UI is not accessible from outside your local network.</p>
</li>
</ul>
@ -1235,10 +1595,12 @@
</div> </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> </body>

713
development/examples/tutorials/traefik/index.html

File diff suppressed because it is too large

1731
development/faq/index.html

File diff suppressed because it is too large

495
development/getting-started/index.html

@ -15,14 +15,14 @@
<link rel="canonical" href="https://wg-easy.github.io/wg-easy/development/getting-started/"> <link rel="canonical" href="https://wg-easy.github.io/wg-easy/development/getting-started/">
<link rel="prev" href=".."> <link rel="prev" href="../faq/">
<link rel="next" href="../advanced/api/"> <link rel="next" href="../advanced/api/">
<link rel="icon" href="../assets/logo/favicon.png"> <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"> <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 class="md-header__button md-icon" for="__search">
</label>
<div class="md-search" data-md-component="search" role="dialog"> <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> <label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search"> <div class="md-search__inner" role="search">
<form class="md-search__form" name="search"> <form class="md-search__form" name="search">
@ -189,6 +191,7 @@
</div> </div>
</div> </div>
</div> </div>
<div class="md-header__source"> <div class="md-header__source">
@ -221,10 +224,12 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href=".." class="md-tabs__link"> <a href=".." class="md-tabs__link">
Home Home
@ -237,6 +242,26 @@
<li class="md-tabs__item">
<a href="../faq/" class="md-tabs__link">
FAQ
</a>
</li>
@ -244,6 +269,7 @@
<a href="./" class="md-tabs__link"> <a href="./" class="md-tabs__link">
Getting Started Getting Started
@ -257,12 +283,14 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../advanced/api/" class="md-tabs__link"> <a href="../advanced/api/" class="md-tabs__link">
Advanced Advanced
</a> </a>
@ -275,12 +303,14 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../contributing/general/" class="md-tabs__link"> <a href="../contributing/general/" class="md-tabs__link">
Contributing Contributing
</a> </a>
@ -293,18 +323,21 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="../examples/tutorials/adguard/" class="md-tabs__link"> <a href="../examples/tutorials/adguard/" class="md-tabs__link">
Examples Examples
</a> </a>
@ -316,6 +349,26 @@
<li class="md-tabs__item">
<a href="../guides/2fa/" class="md-tabs__link">
Guides
</a>
</li>
</ul> </ul>
</div> </div>
</nav> </nav>
@ -372,6 +425,7 @@
<a href=".." class="md-nav__link"> <a href=".." class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Home Home
@ -387,6 +441,28 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<span class="md-ellipsis">
FAQ
</span>
</a>
</li>
@ -400,6 +476,7 @@
<label class="md-nav__link md-nav__link--active" for="__toc"> <label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis"> <span class="md-ellipsis">
Getting Started Getting Started
@ -412,6 +489,7 @@
<a href="./" class="md-nav__link md-nav__link--active"> <a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis"> <span class="md-ellipsis">
Getting Started Getting Started
@ -477,36 +555,9 @@
</li> </li>
<li class="md-nav__item"> <li class="md-nav__item">
<a href="#get-all-files" class="md-nav__link"> <a href="#follow-tutorials" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Get All Files Follow tutorials
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#start-the-container" class="md-nav__link">
<span class="md-ellipsis">
Start the Container
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#configuration-steps" class="md-nav__link">
<span class="md-ellipsis">
Configuration Steps
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#stopping-the-container" class="md-nav__link">
<span class="md-ellipsis">
Stopping the Container
</span> </span>
</a> </a>
@ -534,6 +585,7 @@
@ -544,12 +596,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" > <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0"> <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis"> <span class="md-ellipsis">
Advanced Advanced
@ -559,8 +612,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3"> <label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Advanced Advanced
</label> </label>
@ -576,6 +629,7 @@
<a href="../advanced/api/" class="md-nav__link"> <a href="../advanced/api/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
API API
@ -597,6 +651,7 @@
@ -607,12 +662,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"> <span class="md-ellipsis">
Config Config
@ -622,8 +678,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_2"> <label class="md-nav__title" for="__nav_4_2">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Config Config
</label> </label>
@ -639,6 +695,7 @@
<a href="../advanced/config/optional-config/" class="md-nav__link"> <a href="../advanced/config/optional-config/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Optional Configuration Optional Configuration
@ -661,6 +718,7 @@
<a href="../advanced/config/unattended-setup/" class="md-nav__link"> <a href="../advanced/config/unattended-setup/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Unattended Setup Unattended Setup
@ -690,6 +748,7 @@
@ -700,12 +759,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"> <span class="md-ellipsis">
Metrics Metrics
@ -715,8 +775,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_3_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_3"> <label class="md-nav__title" for="__nav_4_3">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Metrics Metrics
</label> </label>
@ -732,6 +792,7 @@
<a href="../advanced/metrics/prometheus/" class="md-nav__link"> <a href="../advanced/metrics/prometheus/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Prometheus Prometheus
@ -761,6 +822,7 @@
@ -771,12 +833,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"> <span class="md-ellipsis">
Migrate Migrate
@ -786,8 +849,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_4"> <label class="md-nav__title" for="__nav_4_4">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Migrate Migrate
</label> </label>
@ -803,6 +866,7 @@
<a href="../advanced/migrate/" class="md-nav__link"> <a href="../advanced/migrate/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate Migrate
@ -825,6 +889,7 @@
<a href="../advanced/migrate/from-14-to-15/" class="md-nav__link"> <a href="../advanced/migrate/from-14-to-15/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate from v14 to v15 Migrate from v14 to v15
@ -861,6 +926,7 @@
@ -871,12 +937,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"> <span class="md-ellipsis">
Contributing Contributing
@ -886,8 +953,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4"> <label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Contributing Contributing
</label> </label>
@ -903,6 +970,7 @@
<a href="../contributing/general/" class="md-nav__link"> <a href="../contributing/general/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
General Information General Information
@ -925,6 +993,7 @@
<a href="../contributing/issues-and-pull-requests/" class="md-nav__link"> <a href="../contributing/issues-and-pull-requests/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Issues and Pull Requests Issues and Pull Requests
@ -953,6 +1022,7 @@
@ -963,12 +1033,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"> <span class="md-ellipsis">
Examples Examples
@ -978,8 +1049,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5"> <label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Examples Examples
</label> </label>
@ -994,6 +1065,7 @@
@ -1004,12 +1076,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"> <span class="md-ellipsis">
Tutorials Tutorials
@ -1019,8 +1092,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_1_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5_1"> <label class="md-nav__title" for="__nav_6_1">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Tutorials Tutorials
</label> </label>
@ -1036,6 +1109,7 @@
<a href="../examples/tutorials/adguard/" class="md-nav__link"> <a href="../examples/tutorials/adguard/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
AdGuard Home AdGuard Home
@ -1058,6 +1132,7 @@
<a href="../examples/tutorials/auto-updates/" class="md-nav__link"> <a href="../examples/tutorials/auto-updates/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Auto Updates Auto Updates
@ -1080,6 +1155,7 @@
<a href="../examples/tutorials/basic-installation/" class="md-nav__link"> <a href="../examples/tutorials/basic-installation/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Basic Installation Basic Installation
@ -1102,6 +1178,7 @@
<a href="../examples/tutorials/caddy/" class="md-nav__link"> <a href="../examples/tutorials/caddy/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Caddy Caddy
@ -1124,6 +1201,7 @@
<a href="../examples/tutorials/docker-run/" class="md-nav__link"> <a href="../examples/tutorials/docker-run/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Docker Run Docker Run
@ -1146,6 +1224,7 @@
<a href="../examples/tutorials/dockerless/" class="md-nav__link"> <a href="../examples/tutorials/dockerless/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Without Docker Without Docker
@ -1165,11 +1244,12 @@
<li class="md-nav__item"> <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"> <span class="md-ellipsis">
NGINX Podman + nftables
</span> </span>
@ -1187,11 +1267,12 @@
<li class="md-nav__item"> <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"> <span class="md-ellipsis">
Podman No Reverse Proxy
</span> </span>
@ -1212,6 +1293,7 @@
<a href="../examples/tutorials/traefik/" class="md-nav__link"> <a href="../examples/tutorials/traefik/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Traefik Traefik
@ -1239,6 +1321,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> </ul>
</nav> </nav>
</div> </div>
@ -1309,36 +1556,9 @@
</li> </li>
<li class="md-nav__item"> <li class="md-nav__item">
<a href="#get-all-files" class="md-nav__link"> <a href="#follow-tutorials" class="md-nav__link">
<span class="md-ellipsis">
Get All Files
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#start-the-container" class="md-nav__link">
<span class="md-ellipsis">
Start the Container
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#configuration-steps" class="md-nav__link">
<span class="md-ellipsis">
Configuration Steps
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#stopping-the-container" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Stopping the Container Follow tutorials
</span> </span>
</a> </a>
@ -1385,13 +1605,13 @@
<h1>Getting Started</h1> <h1>Getting Started</h1>
<p>This page explains how to get started with wg-easy. The guide uses Docker Compose as a reference. In our examples, we mount the named volume <code>etc_wireguard</code> to <code>/etc/wireguard</code> inside the container.</p> <p>This page explains how to get started with <code>wg-easy</code>. The guide uses Docker Compose as a reference. In our examples, we mount the named volume <code>etc_wireguard</code> to <code>/etc/wireguard</code> inside the container.</p>
<h2 id="preliminary-steps"><a class="toclink" href="#preliminary-steps">Preliminary Steps</a></h2> <h2 id="preliminary-steps"><a class="toclink" href="#preliminary-steps">Preliminary Steps</a></h2>
<p>Before you can get started with deploying your own VPN, there are some requirements to be met:</p> <p>Before you can get started with deploying your own VPN, there are some requirements to be met:</p>
<ol> <ol>
<li>You need to have a host that you can manage</li> <li>You need to have a host that you can manage</li>
<li>You need to have a domain name or a public IP address</li> <li>You need to have a domain name or a public IP address</li>
<li>You need a supported architecture (x86_64, arm64)</li> <li>You need a supported architecture (x86_64, arm64, armv7)</li>
</ol> </ol>
<h3 id="host-setup"><a class="toclink" href="#host-setup">Host Setup</a></h3> <h3 id="host-setup"><a class="toclink" href="#host-setup">Host Setup</a></h3>
<p>There are a few requirements for a suitable host system:</p> <p>There are a few requirements for a suitable host system:</p>
@ -1401,7 +1621,7 @@
<div class="admonition note"> <div class="admonition note">
<p class="admonition-title">About the Container Runtime</p> <p class="admonition-title">About the Container Runtime</p>
<p>On the host, you need to have a suitable container runtime (like <em>Docker</em> or <em>Podman</em>) installed. We assume <a href="https://docs.docker.com/compose/"><em>Docker Compose</em></a> is <a href="https://docs.docker.com/compose/install/">installed</a>. We have aligned file names and configuration conventions with the latest <a href="https://docs.docker.com/compose/compose-file/">Docker Compose specification</a>. <p>On the host, you need to have a suitable container runtime (like <em>Docker</em> or <em>Podman</em>) installed. We assume <a href="https://docs.docker.com/compose/"><em>Docker Compose</em></a> is <a href="https://docs.docker.com/compose/install/">installed</a>. We have aligned file names and configuration conventions with the latest <a href="https://docs.docker.com/compose/compose-file/">Docker Compose specification</a>.
If you're using podman, make sure to read the related <a href="../examples/tutorials/podman/">documentation</a>.</p> If you're using podman, make sure to read the related <a href="../examples/tutorials/podman-nft/">documentation</a>.</p>
</div> </div>
<h2 id="deploying-the-actual-image"><a class="toclink" href="#deploying-the-actual-image">Deploying the Actual Image</a></h2> <h2 id="deploying-the-actual-image"><a class="toclink" href="#deploying-the-actual-image">Deploying the Actual Image</a></h2>
<h3 id="tagging-convention"><a class="toclink" href="#tagging-convention">Tagging Convention</a></h3> <h3 id="tagging-convention"><a class="toclink" href="#tagging-convention">Tagging Convention</a></h3>
@ -1413,42 +1633,65 @@ If you're using podman, make sure to read the related <a href="../examples/tutor
<table> <table>
<thead> <thead>
<tr> <tr>
<th>Event</th> <th>tag</th>
<th>Image Tags</th> <th>Type</th>
<th>Example</th>
<th>Description</th>
</tr> </tr>
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td><code>cron</code> on <code>master</code></td> <td><code>15</code></td>
<td><code>nightly</code></td> <td>latest minor for that major tag</td>
<td><code>ghcr.io/wg-easy/wg-easy:15</code></td>
<td>latest features for specific major versions, no breaking changes, recommended</td>
</tr>
<tr>
<td><code>latest</code></td>
<td>latest tag</td>
<td><code>ghcr.io/wg-easy/wg-easy:latest</code> or <code>ghcr.io/wg-easy/wg-easy</code></td>
<td>points to latest release, can include breaking changes</td>
</tr>
<tr>
<td><code>15.0</code></td>
<td>latest patch for that minor tag</td>
<td><code>ghcr.io/wg-easy/wg-easy:15.0</code></td>
<td>latest patches for specific minor version</td>
</tr>
<tr>
<td><code>15.0.0</code></td>
<td>specific tag</td>
<td><code>ghcr.io/wg-easy/wg-easy:15.0.0</code></td>
<td>specific release, no updates</td>
</tr> </tr>
<tr> <tr>
<td><code>push</code> a tag (<code>v1.2.3</code>)</td> <td><code>edge</code></td>
<td><code>1.2.3</code>, <code>1.2</code>, <code>1</code>, <code>latest</code></td> <td>push to <code>master</code></td>
<td><code>ghcr.io/wg-easy/wg-easy:edge</code></td>
<td>mostly unstable, gets frequent package and code updates</td>
</tr>
<tr>
<td><code>development</code></td>
<td>pull requests</td>
<td><code>ghcr.io/wg-easy/wg-easy:development</code></td>
<td>used for development, testing code from PRs</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
<!-- ref: major version -->
<p>When publishing a tag we follow the <a href="https://semver.org/">Semantic Versioning</a> specification. The <code>latest</code> tag is always pointing to the latest stable release. If you want to avoid breaking changes, use the major version tag (e.g. <code>15</code>).</p> <p>When publishing a tag we follow the <a href="https://semver.org/">Semantic Versioning</a> specification. The <code>latest</code> tag is always pointing to the latest stable release. If you want to avoid breaking changes, use the major version tag (e.g. <code>15</code>).</p>
<h3 id="get-all-files"><a class="toclink" href="#get-all-files">Get All Files</a></h3> <h3 id="follow-tutorials"><a class="toclink" href="#follow-tutorials">Follow tutorials</a></h3>
<p>Issue the following command to acquire the necessary file:</p> <ul>
<div class="highlight"><pre><span></span><code>wget<span class="w"> </span><span class="s2">&quot;https://raw.githubusercontent.com/wg-easy/wg-easy/master/docker-compose.yml&quot;</span> <li><a href="../examples/tutorials/basic-installation/">Basic Installation with Docker Compose (Recommended)</a></li>
</code></pre></div> <li><a href="../examples/tutorials/docker-run/">Simple Installation with Docker Run</a></li>
<h3 id="start-the-container"><a class="toclink" href="#start-the-container">Start the Container</a></h3> <li><a href="../examples/tutorials/podman-nft/">Advanced Installation with Podman</a></li>
<p>To start the container, issue the following command:</p> </ul>
<div class="highlight"><pre><span></span><code>sudo<span class="w"> </span>docker<span class="w"> </span>compose<span class="w"> </span>up<span class="w"> </span>-d
</code></pre></div>
<h3 id="configuration-steps"><a class="toclink" href="#configuration-steps">Configuration Steps</a></h3>
<p>Now follow the setup process in your web browser</p>
<h3 id="stopping-the-container"><a class="toclink" href="#stopping-the-container">Stopping the Container</a></h3>
<p>To stop the container, issue the following command:</p>
<div class="highlight"><pre><span></span><code>sudo<span class="w"> </span>docker<span class="w"> </span>compose<span class="w"> </span>down
</code></pre></div>
<div class="admonition danger"> <div class="admonition danger">
<p class="admonition-title">Using the Correct Commands For Stopping and Starting wg-easy</p> <p class="admonition-title">Use the Correct Commands For Stopping and Starting <code>wg-easy</code></p>
<p><strong>Use <code>sudo docker compose up / down</code>, not <code>sudo docker compose start / stop</code></strong>. Otherwise, the container is not properly destroyed and you may experience problems during startup because of inconsistent state.</p> <p><strong>Use <code>sudo docker compose up / down</code>, not <code>sudo docker compose start / stop</code></strong>. Otherwise, the container is not properly destroyed and you may experience problems during startup because of inconsistent state.</p>
</div> </div>
<p><strong>That's it! It really is that easy</strong>.</p> <p><strong>That's it! It really is that easy</strong>.</p>
<p>If you need more help you can read the <a href="../examples/tutorials/basic-installation/">Basic Installation Tutorial</a>.</p>
@ -1511,10 +1754,12 @@ If you're using podman, make sure to read the related <a href="../examples/tutor
</div> </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> </body>

1633
development/guides/2fa/index.html

File diff suppressed because it is too large

1518
development/guides/admin/index.html

File diff suppressed because it is too large

1685
development/guides/cli/index.html

File diff suppressed because it is too large

1742
development/guides/clients/index.html

File diff suppressed because it is too large

1658
development/guides/setup/index.html

File diff suppressed because it is too large

362
development/index.html

@ -16,11 +16,11 @@
<link rel="next" href="getting-started/"> <link rel="next" href="faq/">
<link rel="icon" href="assets/logo/favicon.png"> <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">
@ -28,7 +28,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"> <link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@ -151,11 +151,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 class="md-header__button md-icon" for="__search">
</label>
<div class="md-search" data-md-component="search" role="dialog"> <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> <label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search"> <div class="md-search__inner" role="search">
<form class="md-search__form" name="search"> <form class="md-search__form" name="search">
@ -187,6 +189,7 @@
</div> </div>
</div> </div>
</div> </div>
<div class="md-header__source"> <div class="md-header__source">
@ -218,6 +221,7 @@
@ -225,6 +229,7 @@
<a href="." class="md-tabs__link"> <a href="." class="md-tabs__link">
Home 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"> <li class="md-tabs__item">
<a href="getting-started/" class="md-tabs__link"> <a href="getting-started/" class="md-tabs__link">
Getting Started Getting Started
@ -255,12 +281,14 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="advanced/api/" class="md-tabs__link"> <a href="advanced/api/" class="md-tabs__link">
Advanced Advanced
</a> </a>
@ -273,12 +301,14 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="contributing/general/" class="md-tabs__link"> <a href="contributing/general/" class="md-tabs__link">
Contributing Contributing
</a> </a>
@ -291,18 +321,21 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="examples/tutorials/adguard/" class="md-tabs__link"> <a href="examples/tutorials/adguard/" class="md-tabs__link">
Examples Examples
</a> </a>
@ -314,6 +347,26 @@
<li class="md-tabs__item">
<a href="guides/2fa/" class="md-tabs__link">
Guides
</a>
</li>
</ul> </ul>
</div> </div>
</nav> </nav>
@ -379,6 +432,7 @@
<label class="md-nav__link md-nav__link--active" for="__toc"> <label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis"> <span class="md-ellipsis">
Home Home
@ -391,6 +445,7 @@
<a href="." class="md-nav__link md-nav__link--active"> <a href="." class="md-nav__link md-nav__link--active">
<span class="md-ellipsis"> <span class="md-ellipsis">
Home Home
@ -479,10 +534,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"> <li class="md-nav__item">
<a href="getting-started/" class="md-nav__link"> <a href="getting-started/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Getting Started Getting Started
@ -503,6 +581,7 @@
@ -513,12 +592,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" > <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0"> <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis"> <span class="md-ellipsis">
Advanced Advanced
@ -528,8 +608,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3"> <label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Advanced Advanced
</label> </label>
@ -545,6 +625,7 @@
<a href="advanced/api/" class="md-nav__link"> <a href="advanced/api/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
API API
@ -566,6 +647,7 @@
@ -576,12 +658,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"> <span class="md-ellipsis">
Config Config
@ -591,8 +674,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_2"> <label class="md-nav__title" for="__nav_4_2">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Config Config
</label> </label>
@ -608,6 +691,7 @@
<a href="advanced/config/optional-config/" class="md-nav__link"> <a href="advanced/config/optional-config/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Optional Configuration Optional Configuration
@ -630,6 +714,7 @@
<a href="advanced/config/unattended-setup/" class="md-nav__link"> <a href="advanced/config/unattended-setup/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Unattended Setup Unattended Setup
@ -659,6 +744,7 @@
@ -669,12 +755,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"> <span class="md-ellipsis">
Metrics Metrics
@ -684,8 +771,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_3_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_3"> <label class="md-nav__title" for="__nav_4_3">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Metrics Metrics
</label> </label>
@ -701,6 +788,7 @@
<a href="advanced/metrics/prometheus/" class="md-nav__link"> <a href="advanced/metrics/prometheus/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Prometheus Prometheus
@ -730,6 +818,7 @@
@ -740,12 +829,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"> <span class="md-ellipsis">
Migrate Migrate
@ -755,8 +845,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_4"> <label class="md-nav__title" for="__nav_4_4">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Migrate Migrate
</label> </label>
@ -772,6 +862,7 @@
<a href="advanced/migrate/" class="md-nav__link"> <a href="advanced/migrate/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate Migrate
@ -794,6 +885,7 @@
<a href="advanced/migrate/from-14-to-15/" class="md-nav__link"> <a href="advanced/migrate/from-14-to-15/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Migrate from v14 to v15 Migrate from v14 to v15
@ -830,6 +922,7 @@
@ -840,12 +933,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"> <span class="md-ellipsis">
Contributing Contributing
@ -855,8 +949,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4"> <label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Contributing Contributing
</label> </label>
@ -872,6 +966,7 @@
<a href="contributing/general/" class="md-nav__link"> <a href="contributing/general/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
General Information General Information
@ -894,6 +989,7 @@
<a href="contributing/issues-and-pull-requests/" class="md-nav__link"> <a href="contributing/issues-and-pull-requests/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Issues and Pull Requests Issues and Pull Requests
@ -922,6 +1018,7 @@
@ -932,12 +1029,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"> <span class="md-ellipsis">
Examples Examples
@ -947,8 +1045,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false"> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5"> <label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Examples Examples
</label> </label>
@ -963,6 +1061,7 @@
@ -973,12 +1072,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"> <span class="md-ellipsis">
Tutorials Tutorials
@ -988,8 +1088,8 @@
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
</label> </label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_1_label" aria-expanded="false"> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5_1"> <label class="md-nav__title" for="__nav_6_1">
<span class="md-nav__icon md-icon"></span> <span class="md-nav__icon md-icon"></span>
Tutorials Tutorials
</label> </label>
@ -1005,6 +1105,7 @@
<a href="examples/tutorials/adguard/" class="md-nav__link"> <a href="examples/tutorials/adguard/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
AdGuard Home AdGuard Home
@ -1027,6 +1128,7 @@
<a href="examples/tutorials/auto-updates/" class="md-nav__link"> <a href="examples/tutorials/auto-updates/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Auto Updates Auto Updates
@ -1049,6 +1151,7 @@
<a href="examples/tutorials/basic-installation/" class="md-nav__link"> <a href="examples/tutorials/basic-installation/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Basic Installation Basic Installation
@ -1071,6 +1174,7 @@
<a href="examples/tutorials/caddy/" class="md-nav__link"> <a href="examples/tutorials/caddy/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Caddy Caddy
@ -1093,6 +1197,7 @@
<a href="examples/tutorials/docker-run/" class="md-nav__link"> <a href="examples/tutorials/docker-run/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Docker Run Docker Run
@ -1115,6 +1220,7 @@
<a href="examples/tutorials/dockerless/" class="md-nav__link"> <a href="examples/tutorials/dockerless/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Without Docker Without Docker
@ -1134,11 +1240,12 @@
<li class="md-nav__item"> <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"> <span class="md-ellipsis">
NGINX Podman + nftables
</span> </span>
@ -1156,11 +1263,12 @@
<li class="md-nav__item"> <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"> <span class="md-ellipsis">
Podman No Reverse Proxy
</span> </span>
@ -1181,6 +1289,7 @@
<a href="examples/tutorials/traefik/" class="md-nav__link"> <a href="examples/tutorials/traefik/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
Traefik Traefik
@ -1208,6 +1317,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> </ul>
</nav> </nav>
</div> </div>
@ -1326,7 +1600,7 @@
<p class="admonition-title"> This Documentation is Versioned</p> <p class="admonition-title"> This Documentation is Versioned</p>
<p><strong>Make sure</strong> to select the correct version of this documentation! It should match the version of the image you are using. The default version corresponds to the <code>:latest</code> image tag - <a href="getting-started/#tagging-convention">the most recent stable release</a>.</p> <p><strong>Make sure</strong> to select the correct version of this documentation! It should match the version of the image you are using. The default version corresponds to the <code>:latest</code> image tag - <a href="getting-started/#tagging-convention">the most recent stable release</a>.</p>
</div> </div>
<p>This documentation provides you not only with the basic setup and configuration of wg-easy but also with advanced configuration, elaborate usage scenarios, detailed examples, hints and more.</p> <p>This documentation provides you not only with the basic setup and configuration of <code>wg-easy</code> but also with advanced configuration, elaborate usage scenarios, detailed examples, hints and more.</p>
<h2 id="about"><a class="toclink" href="#about">About</a></h2> <h2 id="about"><a class="toclink" href="#about">About</a></h2>
<p><code>wg-easy</code> is the easiest way to run WireGuard VPN + Web-based Admin UI.</p> <p><code>wg-easy</code> is the easiest way to run WireGuard VPN + Web-based Admin UI.</p>
<h2 id="contents"><a class="toclink" href="#contents">Contents</a></h2> <h2 id="contents"><a class="toclink" href="#contents">Contents</a></h2>
@ -1398,10 +1672,12 @@
</div> </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> </body>

2
development/search/search_index.json

File diff suppressed because one or more lines are too long

66
development/sitemap.xml

@ -2,78 +2,102 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"> <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url> <url>
<loc>https://wg-easy.github.io/wg-easy/development/</loc> <loc>https://wg-easy.github.io/wg-easy/development/</loc>
<lastmod>2025-03-14</lastmod> <lastmod>2025-06-11</lastmod>
</url>
<url>
<loc>https://wg-easy.github.io/wg-easy/development/faq/</loc>
<lastmod>2025-06-11</lastmod>
</url> </url>
<url> <url>
<loc>https://wg-easy.github.io/wg-easy/development/getting-started/</loc> <loc>https://wg-easy.github.io/wg-easy/development/getting-started/</loc>
<lastmod>2025-03-14</lastmod> <lastmod>2025-06-11</lastmod>
</url> </url>
<url> <url>
<loc>https://wg-easy.github.io/wg-easy/development/advanced/api/</loc> <loc>https://wg-easy.github.io/wg-easy/development/advanced/api/</loc>
<lastmod>2025-03-14</lastmod> <lastmod>2025-06-11</lastmod>
</url> </url>
<url> <url>
<loc>https://wg-easy.github.io/wg-easy/development/advanced/config/optional-config/</loc> <loc>https://wg-easy.github.io/wg-easy/development/advanced/config/optional-config/</loc>
<lastmod>2025-03-14</lastmod> <lastmod>2025-06-11</lastmod>
</url> </url>
<url> <url>
<loc>https://wg-easy.github.io/wg-easy/development/advanced/config/unattended-setup/</loc> <loc>https://wg-easy.github.io/wg-easy/development/advanced/config/unattended-setup/</loc>
<lastmod>2025-03-14</lastmod> <lastmod>2025-06-11</lastmod>
</url> </url>
<url> <url>
<loc>https://wg-easy.github.io/wg-easy/development/advanced/metrics/prometheus/</loc> <loc>https://wg-easy.github.io/wg-easy/development/advanced/metrics/prometheus/</loc>
<lastmod>2025-03-14</lastmod> <lastmod>2025-06-11</lastmod>
</url> </url>
<url> <url>
<loc>https://wg-easy.github.io/wg-easy/development/advanced/migrate/</loc> <loc>https://wg-easy.github.io/wg-easy/development/advanced/migrate/</loc>
<lastmod>2025-03-14</lastmod> <lastmod>2025-06-11</lastmod>
</url> </url>
<url> <url>
<loc>https://wg-easy.github.io/wg-easy/development/advanced/migrate/from-14-to-15/</loc> <loc>https://wg-easy.github.io/wg-easy/development/advanced/migrate/from-14-to-15/</loc>
<lastmod>2025-03-14</lastmod> <lastmod>2025-06-11</lastmod>
</url> </url>
<url> <url>
<loc>https://wg-easy.github.io/wg-easy/development/contributing/general/</loc> <loc>https://wg-easy.github.io/wg-easy/development/contributing/general/</loc>
<lastmod>2025-03-14</lastmod> <lastmod>2025-06-11</lastmod>
</url> </url>
<url> <url>
<loc>https://wg-easy.github.io/wg-easy/development/contributing/issues-and-pull-requests/</loc> <loc>https://wg-easy.github.io/wg-easy/development/contributing/issues-and-pull-requests/</loc>
<lastmod>2025-03-14</lastmod> <lastmod>2025-06-11</lastmod>
</url> </url>
<url> <url>
<loc>https://wg-easy.github.io/wg-easy/development/examples/tutorials/adguard/</loc> <loc>https://wg-easy.github.io/wg-easy/development/examples/tutorials/adguard/</loc>
<lastmod>2025-03-14</lastmod> <lastmod>2025-06-11</lastmod>
</url> </url>
<url> <url>
<loc>https://wg-easy.github.io/wg-easy/development/examples/tutorials/auto-updates/</loc> <loc>https://wg-easy.github.io/wg-easy/development/examples/tutorials/auto-updates/</loc>
<lastmod>2025-03-14</lastmod> <lastmod>2025-06-11</lastmod>
</url> </url>
<url> <url>
<loc>https://wg-easy.github.io/wg-easy/development/examples/tutorials/basic-installation/</loc> <loc>https://wg-easy.github.io/wg-easy/development/examples/tutorials/basic-installation/</loc>
<lastmod>2025-03-14</lastmod> <lastmod>2025-06-11</lastmod>
</url> </url>
<url> <url>
<loc>https://wg-easy.github.io/wg-easy/development/examples/tutorials/caddy/</loc> <loc>https://wg-easy.github.io/wg-easy/development/examples/tutorials/caddy/</loc>
<lastmod>2025-03-14</lastmod> <lastmod>2025-06-11</lastmod>
</url> </url>
<url> <url>
<loc>https://wg-easy.github.io/wg-easy/development/examples/tutorials/docker-run/</loc> <loc>https://wg-easy.github.io/wg-easy/development/examples/tutorials/docker-run/</loc>
<lastmod>2025-03-14</lastmod> <lastmod>2025-06-11</lastmod>
</url> </url>
<url> <url>
<loc>https://wg-easy.github.io/wg-easy/development/examples/tutorials/dockerless/</loc> <loc>https://wg-easy.github.io/wg-easy/development/examples/tutorials/dockerless/</loc>
<lastmod>2025-03-14</lastmod> <lastmod>2025-06-11</lastmod>
</url> </url>
<url> <url>
<loc>https://wg-easy.github.io/wg-easy/development/examples/tutorials/nginx/</loc> <loc>https://wg-easy.github.io/wg-easy/development/examples/tutorials/podman-nft/</loc>
<lastmod>2025-03-14</lastmod> <lastmod>2025-06-11</lastmod>
</url> </url>
<url> <url>
<loc>https://wg-easy.github.io/wg-easy/development/examples/tutorials/podman/</loc> <loc>https://wg-easy.github.io/wg-easy/development/examples/tutorials/reverse-proxyless/</loc>
<lastmod>2025-03-14</lastmod> <lastmod>2025-06-11</lastmod>
</url> </url>
<url> <url>
<loc>https://wg-easy.github.io/wg-easy/development/examples/tutorials/traefik/</loc> <loc>https://wg-easy.github.io/wg-easy/development/examples/tutorials/traefik/</loc>
<lastmod>2025-03-14</lastmod> <lastmod>2025-06-11</lastmod>
</url>
<url>
<loc>https://wg-easy.github.io/wg-easy/development/guides/2fa/</loc>
<lastmod>2025-06-11</lastmod>
</url>
<url>
<loc>https://wg-easy.github.io/wg-easy/development/guides/admin/</loc>
<lastmod>2025-06-11</lastmod>
</url>
<url>
<loc>https://wg-easy.github.io/wg-easy/development/guides/cli/</loc>
<lastmod>2025-06-11</lastmod>
</url>
<url>
<loc>https://wg-easy.github.io/wg-easy/development/guides/clients/</loc>
<lastmod>2025-06-11</lastmod>
</url>
<url>
<loc>https://wg-easy.github.io/wg-easy/development/guides/setup/</loc>
<lastmod>2025-06-11</lastmod>
</url> </url>
</urlset> </urlset>

BIN
development/sitemap.xml.gz

Binary file not shown.
Loading…
Cancel
Save