mirror
/
wg-easy
mirror of https://github.com/wg-easy/wg-easy
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Deployed 10f4217 to Pre-release with MkDocs 1.6.1 and mike 2.1.3

gh-pages
github-actions[bot] 1 year ago
parent
27b1237340
commit
fc3f24ee46
35 changed files with 1844 additions and 1149 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 62
      Pre-release/404.html
  2. 66
      Pre-release/advanced/api/index.html
  3. 62
      Pre-release/advanced/config/optional-config/index.html
  4. 62
      Pre-release/advanced/config/unattended-setup/index.html
  5. 80
      Pre-release/advanced/metrics/prometheus/index.html
  6. 66
      Pre-release/advanced/migrate/from-14-to-15/index.html
  7. 62
      Pre-release/advanced/migrate/index.html
  8. 8
      Pre-release/assets/javascripts/bundle.13a4f30d.min.js
  9. 4
      Pre-release/assets/javascripts/bundle.13a4f30d.min.js.map
  10. 4
      Pre-release/assets/javascripts/workers/search.d50fe291.min.js
  11. 2
      Pre-release/assets/javascripts/workers/search.d50fe291.min.js.map
  12. 2
      Pre-release/assets/stylesheets/main.342714a4.min.css
  13. 2
      Pre-release/assets/stylesheets/main.342714a4.min.css.map
  14. 64
      Pre-release/contributing/general/index.html
  15. 64
      Pre-release/contributing/issues-and-pull-requests/index.html
  16. 62
      Pre-release/examples/tutorials/adguard/index.html
  17. 76
      Pre-release/examples/tutorials/auto-updates/index.html
  18. 83
      Pre-release/examples/tutorials/basic-installation/index.html
  19. 62
      Pre-release/examples/tutorials/caddy/index.html
  20. 62
      Pre-release/examples/tutorials/docker-run/index.html
  21. 62
      Pre-release/examples/tutorials/dockerless/index.html
  22. 76
      Pre-release/examples/tutorials/podman-nft/index.html
  23. 305
      Pre-release/examples/tutorials/reverse-proxyless/index.html
  24. 210
      Pre-release/examples/tutorials/traefik/index.html
  25. 124
      Pre-release/faq/index.html
  26. 167
      Pre-release/getting-started/index.html
  27. 165
      Pre-release/guides/2fa/index.html
  28. 66
      Pre-release/guides/admin/index.html
  29. 253
      Pre-release/guides/cli/index.html
  30. 280
      Pre-release/guides/clients/index.html
  31. 206
      Pre-release/guides/setup/index.html
  32. 62
      Pre-release/index.html
  33. 2
      Pre-release/search/search_index.json
  34. 60
      Pre-release/sitemap.xml
  35. BIN
      Pre-release/sitemap.xml.gz

62
Pre-release/404.html
View File

@ -16,7 +16,7 @@
<link rel="icon" href="/wg-easy/Pre-release/assets/logo/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
@ -24,7 +24,7 @@
<link rel="stylesheet" href="/wg-easy/Pre-release/assets/stylesheets/main.4af4bdda.min.css">
<link rel="stylesheet" href="/wg-easy/Pre-release/assets/stylesheets/main.342714a4.min.css">
<link rel="stylesheet" href="/wg-easy/Pre-release/assets/stylesheets/palette.06af60db.min.css">
@ -1156,6 +1156,29 @@
<li class="md-nav__item">
<a href="/wg-easy/Pre-release/examples/tutorials/reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis">
No Reverse Proxy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="/wg-easy/Pre-release/examples/tutorials/traefik/" class="md-nav__link">
@ -1260,29 +1283,6 @@
<li class="md-nav__item">
<a href="/wg-easy/Pre-release/guides/account/" class="md-nav__link">
<span class="md-ellipsis">
Edit Account
</span>
</a>
</li>
<li class="md-nav__item">
<a href="/wg-easy/Pre-release/guides/admin/" class="md-nav__link">
@ -1307,12 +1307,12 @@
<li class="md-nav__item">
<a href="/wg-easy/Pre-release/guides/clients/" class="md-nav__link">
<a href="/wg-easy/Pre-release/guides/cli/" class="md-nav__link">
<span class="md-ellipsis">
Edit Client
CLI
</span>
@ -1330,12 +1330,12 @@
<li class="md-nav__item">
<a href="/wg-easy/Pre-release/guides/login/" class="md-nav__link">
<a href="/wg-easy/Pre-release/guides/clients/" class="md-nav__link">
<span class="md-ellipsis">
Login
Edit Client
</span>
@ -1452,10 +1452,10 @@
<script id="__config" type="application/json">{"base": "/wg-easy/Pre-release", "features": ["navigation.tabs", "navigation.top", "navigation.expand", "navigation.instant", "content.action.edit", "content.action.view", "content.code.annotate"], "search": "/wg-easy/Pre-release/assets/javascripts/workers/search.f8cc74c7.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 id="__config" type="application/json">{"base": "/wg-easy/Pre-release", "features": ["navigation.tabs", "navigation.top", "navigation.expand", "navigation.instant", "content.action.edit", "content.action.view", "content.code.annotate"], "search": "/wg-easy/Pre-release/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/Pre-release/assets/javascripts/bundle.c8b220af.min.js"></script>
<script src="/wg-easy/Pre-release/assets/javascripts/bundle.13a4f30d.min.js"></script>
</body>

66
Pre-release/advanced/api/index.html
View File

@ -22,7 +22,7 @@
<link rel="icon" href="../../assets/logo/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
@ -30,7 +30,7 @@
<link rel="stylesheet" href="../../assets/stylesheets/main.4af4bdda.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/main.342714a4.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
@ -1258,6 +1258,29 @@
<li class="md-nav__item">
<a href="../../examples/tutorials/reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis">
No Reverse Proxy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../examples/tutorials/traefik/" class="md-nav__link">
@ -1362,29 +1385,6 @@
<li class="md-nav__item">
<a href="../../guides/account/" class="md-nav__link">
<span class="md-ellipsis">
Edit Account
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../guides/admin/" class="md-nav__link">
@ -1409,12 +1409,12 @@
<li class="md-nav__item">
<a href="../../guides/clients/" class="md-nav__link">
<a href="../../guides/cli/" class="md-nav__link">
<span class="md-ellipsis">
Edit Client
CLI
</span>
@ -1432,12 +1432,12 @@
<li class="md-nav__item">
<a href="../../guides/login/" class="md-nav__link">
<a href="../../guides/clients/" class="md-nav__link">
<span class="md-ellipsis">
Login
Edit Client
</span>
@ -1584,6 +1584,10 @@
<h1>API</h1>
<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>
@ -1687,10 +1691,10 @@ If you use 2FA, the API will not work. You need to disable 2FA in the web applic
<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", "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 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>

62
Pre-release/advanced/config/optional-config/index.html
View File

@ -22,7 +22,7 @@
<link rel="icon" href="../../../assets/logo/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
@ -30,7 +30,7 @@
<link rel="stylesheet" href="../../../assets/stylesheets/main.4af4bdda.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/main.342714a4.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
@ -1175,6 +1175,29 @@
<li class="md-nav__item">
<a href="../../../examples/tutorials/reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis">
No Reverse Proxy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../examples/tutorials/traefik/" class="md-nav__link">
@ -1279,29 +1302,6 @@
<li class="md-nav__item">
<a href="../../../guides/account/" class="md-nav__link">
<span class="md-ellipsis">
Edit Account
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/admin/" class="md-nav__link">
@ -1326,12 +1326,12 @@
<li class="md-nav__item">
<a href="../../../guides/clients/" class="md-nav__link">
<a href="../../../guides/cli/" class="md-nav__link">
<span class="md-ellipsis">
Edit Client
CLI
</span>
@ -1349,12 +1349,12 @@
<li class="md-nav__item">
<a href="../../../guides/login/" class="md-nav__link">
<a href="../../../guides/clients/" class="md-nav__link">
<span class="md-ellipsis">
Login
Edit Client
</span>
@ -1538,10 +1538,10 @@
<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", "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 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>

62
Pre-release/advanced/config/unattended-setup/index.html
View File

@ -22,7 +22,7 @@
<link rel="icon" href="../../../assets/logo/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
@ -30,7 +30,7 @@
<link rel="stylesheet" href="../../../assets/stylesheets/main.4af4bdda.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/main.342714a4.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
@ -1175,6 +1175,29 @@
<li class="md-nav__item">
<a href="../../../examples/tutorials/reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis">
No Reverse Proxy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../examples/tutorials/traefik/" class="md-nav__link">
@ -1279,29 +1302,6 @@
<li class="md-nav__item">
<a href="../../../guides/account/" class="md-nav__link">
<span class="md-ellipsis">
Edit Account
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/admin/" class="md-nav__link">
@ -1326,12 +1326,12 @@
<li class="md-nav__item">
<a href="../../../guides/clients/" class="md-nav__link">
<a href="../../../guides/cli/" class="md-nav__link">
<span class="md-ellipsis">
Edit Client
CLI
</span>
@ -1349,12 +1349,12 @@
<li class="md-nav__item">
<a href="../../../guides/login/" class="md-nav__link">
<a href="../../../guides/clients/" class="md-nav__link">
<span class="md-ellipsis">
Login
Edit Client
</span>
@ -1579,10 +1579,10 @@
<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", "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 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>

80
Pre-release/advanced/metrics/prometheus/index.html
View File

@ -22,7 +22,7 @@
<link rel="icon" href="../../../assets/logo/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
@ -30,7 +30,7 @@
<link rel="stylesheet" href="../../../assets/stylesheets/main.4af4bdda.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/main.342714a4.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
@ -1237,6 +1237,29 @@
<li class="md-nav__item">
<a href="../../../examples/tutorials/reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis">
No Reverse Proxy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../examples/tutorials/traefik/" class="md-nav__link">
@ -1341,29 +1364,6 @@
<li class="md-nav__item">
<a href="../../../guides/account/" class="md-nav__link">
<span class="md-ellipsis">
Edit Account
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/admin/" class="md-nav__link">
@ -1388,12 +1388,12 @@
<li class="md-nav__item">
<a href="../../../guides/clients/" class="md-nav__link">
<a href="../../../guides/cli/" class="md-nav__link">
<span class="md-ellipsis">
Edit Client
CLI
</span>
@ -1411,12 +1411,12 @@
<li class="md-nav__item">
<a href="../../../guides/login/" class="md-nav__link">
<a href="../../../guides/clients/" class="md-nav__link">
<span class="md-ellipsis">
Login
Edit Client
</span>
@ -1549,15 +1549,15 @@
<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">&quot;wg-easy&quot;</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">&quot;localhost:51821&quot;</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">&quot;SuperSecurePassword&quot;</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>
@ -1630,10 +1630,10 @@ See <a href="https://github.com/wg-easy/wg-easy/pull/1299">#1299</a> for more in
<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", "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 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>

66
Pre-release/advanced/migrate/from-14-to-15/index.html
View File

@ -22,7 +22,7 @@
<link rel="icon" href="../../../assets/logo/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
@ -30,7 +30,7 @@
<link rel="stylesheet" href="../../../assets/stylesheets/main.4af4bdda.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/main.342714a4.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
@ -1270,6 +1270,29 @@
<li class="md-nav__item">
<a href="../../../examples/tutorials/reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis">
No Reverse Proxy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../examples/tutorials/traefik/" class="md-nav__link">
@ -1374,29 +1397,6 @@
<li class="md-nav__item">
<a href="../../../guides/account/" class="md-nav__link">
<span class="md-ellipsis">
Edit Account
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/admin/" class="md-nav__link">
@ -1421,12 +1421,12 @@
<li class="md-nav__item">
<a href="../../../guides/clients/" class="md-nav__link">
<a href="../../../guides/cli/" class="md-nav__link">
<span class="md-ellipsis">
Edit Client
CLI
</span>
@ -1444,12 +1444,12 @@
<li class="md-nav__item">
<a href="../../../guides/login/" class="md-nav__link">
<a href="../../../guides/clients/" class="md-nav__link">
<span class="md-ellipsis">
Login
Edit Client
</span>
@ -1612,7 +1612,7 @@
<h2 id="changes"><a class="toclink" href="#changes">Changes</a></h2>
<ul>
<li>This is a complete rewrite of the <code>wg-easy</code> project. Therefore the configuration files and the way you interact with the project have changed.</li>
<li>If you use armv6 or armv7, you can't migrate to <code>v15</code> yet. We are working on it.</li>
<li>If you use armv6, you unfortunately won't be able to migrate to <code>v15</code>.</li>
<li>If you are connecting to the web ui via HTTP, you need to set the <code>INSECURE</code> environment variable to <code>true</code> in the new container.</li>
</ul>
<h2 id="migration"><a class="toclink" href="#migration">Migration</a></h2>
@ -1633,7 +1633,7 @@
</code></pre></div>
<h3 id="start-new-container"><a class="toclink" href="#start-new-container">Start new container</a></h3>
<p>Follow the instructions in the <a href="../../../getting-started/">Getting Started</a> or <a href="../../../examples/tutorials/basic-installation/">Basic Installation</a> guide to start the new container.</p>
<p>In the setup wizard, select that you already already have a configuration file and upload the <code>wg0.json</code> file you downloaded in the backup step.</p>
<p>In the setup wizard, select that you already have a configuration file and upload the <code>wg0.json</code> file you downloaded in the backup step.</p>
<h3 id="done"><a class="toclink" href="#done">Done</a></h3>
<p>You have now successfully migrated to <code>v15</code> of <code>wg-easy</code>.</p>
@ -1698,10 +1698,10 @@
<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", "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 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>

62
Pre-release/advanced/migrate/index.html
View File

@ -22,7 +22,7 @@
<link rel="icon" href="../../assets/logo/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
@ -30,7 +30,7 @@
<link rel="stylesheet" href="../../assets/stylesheets/main.4af4bdda.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/main.342714a4.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
@ -1175,6 +1175,29 @@
<li class="md-nav__item">
<a href="../../examples/tutorials/reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis">
No Reverse Proxy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../examples/tutorials/traefik/" class="md-nav__link">
@ -1279,29 +1302,6 @@
<li class="md-nav__item">
<a href="../../guides/account/" class="md-nav__link">
<span class="md-ellipsis">
Edit Account
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../guides/admin/" class="md-nav__link">
@ -1326,12 +1326,12 @@
<li class="md-nav__item">
<a href="../../guides/clients/" class="md-nav__link">
<a href="../../guides/cli/" class="md-nav__link">
<span class="md-ellipsis">
Edit Client
CLI
</span>
@ -1349,12 +1349,12 @@
<li class="md-nav__item">
<a href="../../guides/login/" class="md-nav__link">
<a href="../../guides/clients/" class="md-nav__link">
<span class="md-ellipsis">
Login
Edit Client
</span>
@ -1511,10 +1511,10 @@
<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", "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 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>

8
Pre-release/assets/javascripts/bundle.c8b220af.min.js → Pre-release/assets/javascripts/bundle.13a4f30d.min.js
View File

File diff suppressed because one or more lines are too long

4
Pre-release/assets/javascripts/bundle.c8b220af.min.js.map → Pre-release/assets/javascripts/bundle.13a4f30d.min.js.map
View File

File diff suppressed because one or more lines are too long

4
Pre-release/assets/javascripts/workers/search.f8cc74c7.min.js → Pre-release/assets/javascripts/workers/search.d50fe291.min.js
View File

File diff suppressed because one or more lines are too long

2
Pre-release/assets/javascripts/workers/search.f8cc74c7.min.js.map → Pre-release/assets/javascripts/workers/search.d50fe291.min.js.map
View File

File diff suppressed because one or more lines are too long

2
Pre-release/assets/stylesheets/main.4af4bdda.min.css → Pre-release/assets/stylesheets/main.342714a4.min.css
View File

File diff suppressed because one or more lines are too long

2
Pre-release/assets/stylesheets/main.4af4bdda.min.css.map → Pre-release/assets/stylesheets/main.342714a4.min.css.map
View File

File diff suppressed because one or more lines are too long

64
Pre-release/contributing/general/index.html
View File

@ -22,7 +22,7 @@
<link rel="icon" href="../../assets/logo/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
@ -30,7 +30,7 @@
<link rel="stylesheet" href="../../assets/stylesheets/main.4af4bdda.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/main.342714a4.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
@ -1228,6 +1228,29 @@
<li class="md-nav__item">
<a href="../../examples/tutorials/reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis">
No Reverse Proxy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../examples/tutorials/traefik/" class="md-nav__link">
@ -1332,29 +1355,6 @@
<li class="md-nav__item">
<a href="../../guides/account/" class="md-nav__link">
<span class="md-ellipsis">
Edit Account
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../guides/admin/" class="md-nav__link">
@ -1379,12 +1379,12 @@
<li class="md-nav__item">
<a href="../../guides/clients/" class="md-nav__link">
<a href="../../guides/cli/" class="md-nav__link">
<span class="md-ellipsis">
Edit Client
CLI
</span>
@ -1402,12 +1402,12 @@
<li class="md-nav__item">
<a href="../../guides/login/" class="md-nav__link">
<a href="../../guides/clients/" class="md-nav__link">
<span class="md-ellipsis">
Login
Edit Client
</span>
@ -1532,7 +1532,7 @@
<li><strong>Use the provided <code>.vscode/settings.json</code></strong> file.</li>
</ol>
<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>
<div class="highlight"><pre><span></span><code>pnpm<span class="w"> </span>docs:serve
</code></pre></div>
@ -1599,10 +1599,10 @@
<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", "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 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>

64
Pre-release/contributing/issues-and-pull-requests/index.html
View File

@ -22,7 +22,7 @@
<link rel="icon" href="../../assets/logo/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
@ -30,7 +30,7 @@
<link rel="stylesheet" href="../../assets/stylesheets/main.4af4bdda.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/main.342714a4.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
@ -1258,6 +1258,29 @@
<li class="md-nav__item">
<a href="../../examples/tutorials/reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis">
No Reverse Proxy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../examples/tutorials/traefik/" class="md-nav__link">
@ -1362,29 +1385,6 @@
<li class="md-nav__item">
<a href="../../guides/account/" class="md-nav__link">
<span class="md-ellipsis">
Edit Account
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../guides/admin/" class="md-nav__link">
@ -1409,12 +1409,12 @@
<li class="md-nav__item">
<a href="../../guides/clients/" class="md-nav__link">
<a href="../../guides/cli/" class="md-nav__link">
<span class="md-ellipsis">
Edit Client
CLI
</span>
@ -1432,12 +1432,12 @@
<li class="md-nav__item">
<a href="../../guides/login/" class="md-nav__link">
<a href="../../guides/clients/" class="md-nav__link">
<span class="md-ellipsis">
Login
Edit Client
</span>
@ -1616,7 +1616,7 @@
<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>
</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>
@ -1679,10 +1679,10 @@
<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", "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 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>

62
Pre-release/examples/tutorials/adguard/index.html
View File

@ -22,7 +22,7 @@
<link rel="icon" href="../../../assets/logo/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
@ -30,7 +30,7 @@
<link rel="stylesheet" href="../../../assets/stylesheets/main.4af4bdda.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/main.342714a4.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
@ -1177,6 +1177,29 @@
<li class="md-nav__item">
<a href="../reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis">
No Reverse Proxy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../traefik/" class="md-nav__link">
@ -1281,29 +1304,6 @@
<li class="md-nav__item">
<a href="../../../guides/account/" class="md-nav__link">
<span class="md-ellipsis">
Edit Account
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/admin/" class="md-nav__link">
@ -1328,12 +1328,12 @@
<li class="md-nav__item">
<a href="../../../guides/clients/" class="md-nav__link">
<a href="../../../guides/cli/" class="md-nav__link">
<span class="md-ellipsis">
Edit Client
CLI
</span>
@ -1351,12 +1351,12 @@
<li class="md-nav__item">
<a href="../../../guides/login/" class="md-nav__link">
<a href="../../../guides/clients/" class="md-nav__link">
<span class="md-ellipsis">
Login
Edit Client
</span>
@ -1512,10 +1512,10 @@
<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", "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 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>

76
Pre-release/examples/tutorials/auto-updates/index.html
View File

@ -22,7 +22,7 @@
<link rel="icon" href="../../../assets/logo/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
@ -30,7 +30,7 @@
<link rel="stylesheet" href="../../../assets/stylesheets/main.4af4bdda.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/main.342714a4.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
@ -1254,6 +1254,29 @@
<li class="md-nav__item">
<a href="../reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis">
No Reverse Proxy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../traefik/" class="md-nav__link">
@ -1358,29 +1381,6 @@
<li class="md-nav__item">
<a href="../../../guides/account/" class="md-nav__link">
<span class="md-ellipsis">
Edit Account
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/admin/" class="md-nav__link">
@ -1405,12 +1405,12 @@
<li class="md-nav__item">
<a href="../../../guides/clients/" class="md-nav__link">
<a href="../../../guides/cli/" class="md-nav__link">
<span class="md-ellipsis">
Edit Client
CLI
</span>
@ -1428,12 +1428,12 @@
<li class="md-nav__item">
<a href="../../../guides/login/" class="md-nav__link">
<a href="../../../guides/clients/" class="md-nav__link">
<span class="md-ellipsis">
Login
Edit Client
</span>
@ -1583,13 +1583,13 @@ sudo<span class="w"> </span>docker<span class="w"> </span>compose<span class="w"
<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>
<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
@ -1681,10 +1681,10 @@ sudo<span class="w"> </span>docker<span class="w"> </span>pull<span class="w"> <
<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", "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 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>

83
Pre-release/examples/tutorials/basic-installation/index.html
View File

@ -22,7 +22,7 @@
<link rel="icon" href="../../../assets/logo/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
@ -30,7 +30,7 @@
<link rel="stylesheet" href="../../../assets/stylesheets/main.4af4bdda.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/main.342714a4.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
@ -1275,6 +1275,29 @@
<li class="md-nav__item">
<a href="../reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis">
No Reverse Proxy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../traefik/" class="md-nav__link">
@ -1379,29 +1402,6 @@
<li class="md-nav__item">
<a href="../../../guides/account/" class="md-nav__link">
<span class="md-ellipsis">
Edit Account
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/admin/" class="md-nav__link">
@ -1426,12 +1426,12 @@
<li class="md-nav__item">
<a href="../../../guides/clients/" class="md-nav__link">
<a href="../../../guides/cli/" class="md-nav__link">
<span class="md-ellipsis">
Edit Client
CLI
</span>
@ -1449,12 +1449,12 @@
<li class="md-nav__item">
<a href="../../../guides/login/" class="md-nav__link">
<a href="../../../guides/clients/" class="md-nav__link">
<span class="md-ellipsis">
Login
Edit Client
</span>
@ -1622,28 +1622,30 @@
<ol>
<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 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>
</ol>
<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>
<h2 id="install-wg-easy"><a class="toclink" href="#install-wg-easy">Install <code>wg-easy</code></a></h2>
<ol>
<li>Create a directory for the configuration files (you can choose any directory you like):</li>
</ol>
<li>
<p>Create a directory for the configuration files (you can choose any directory you like):</p>
<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
</code></pre></div>
<ol>
<li>Download docker compose file</li>
</ol>
</li>
<li>
<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>/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>
<ol>
<li>Start <code>wg-easy</code></li>
</ol>
</li>
<li>
<p>Start <code>wg-easy</code></p>
<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>
</li>
</ol>
<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>
<ul>
@ -1654,6 +1656,7 @@
<ul>
<li>To setup traefik follow the instructions here: <a href="../traefik/">Traefik</a></li>
<li>To setup caddy follow the instructions here: <a href="../caddy/">Caddy</a></li>
<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>
<p>To update <code>wg-easy</code> to the latest version, run:</p>
@ -1725,10 +1728,10 @@ sudo<span class="w"> </span>docker-compose<span class="w"> </span>up<span class=
<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", "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 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>

62
Pre-release/examples/tutorials/caddy/index.html
View File

@ -22,7 +22,7 @@
<link rel="icon" href="../../../assets/logo/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
@ -30,7 +30,7 @@
<link rel="stylesheet" href="../../../assets/stylesheets/main.4af4bdda.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/main.342714a4.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
@ -1177,6 +1177,29 @@
<li class="md-nav__item">
<a href="../reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis">
No Reverse Proxy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../traefik/" class="md-nav__link">
@ -1281,29 +1304,6 @@
<li class="md-nav__item">
<a href="../../../guides/account/" class="md-nav__link">
<span class="md-ellipsis">
Edit Account
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/admin/" class="md-nav__link">
@ -1328,12 +1328,12 @@
<li class="md-nav__item">
<a href="../../../guides/clients/" class="md-nav__link">
<a href="../../../guides/cli/" class="md-nav__link">
<span class="md-ellipsis">
Edit Client
CLI
</span>
@ -1351,12 +1351,12 @@
<li class="md-nav__item">
<a href="../../../guides/login/" class="md-nav__link">
<a href="../../../guides/clients/" class="md-nav__link">
<span class="md-ellipsis">
Login
Edit Client
</span>
@ -1512,10 +1512,10 @@
<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", "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 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>

62
Pre-release/examples/tutorials/docker-run/index.html
View File

@ -22,7 +22,7 @@
<link rel="icon" href="../../../assets/logo/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
@ -30,7 +30,7 @@
<link rel="stylesheet" href="../../../assets/stylesheets/main.4af4bdda.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/main.342714a4.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
@ -1177,6 +1177,29 @@
<li class="md-nav__item">
<a href="../reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis">
No Reverse Proxy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../traefik/" class="md-nav__link">
@ -1281,29 +1304,6 @@
<li class="md-nav__item">
<a href="../../../guides/account/" class="md-nav__link">
<span class="md-ellipsis">
Edit Account
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/admin/" class="md-nav__link">
@ -1328,12 +1328,12 @@
<li class="md-nav__item">
<a href="../../../guides/clients/" class="md-nav__link">
<a href="../../../guides/cli/" class="md-nav__link">
<span class="md-ellipsis">
Edit Client
CLI
</span>
@ -1351,12 +1351,12 @@
<li class="md-nav__item">
<a href="../../../guides/login/" class="md-nav__link">
<a href="../../../guides/clients/" class="md-nav__link">
<span class="md-ellipsis">
Login
Edit Client
</span>
@ -1540,10 +1540,10 @@
<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", "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 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>

62
Pre-release/examples/tutorials/dockerless/index.html
View File

@ -22,7 +22,7 @@
<link rel="icon" href="../../../assets/logo/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
@ -30,7 +30,7 @@
<link rel="stylesheet" href="../../../assets/stylesheets/main.4af4bdda.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/main.342714a4.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
@ -1177,6 +1177,29 @@
<li class="md-nav__item">
<a href="../reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis">
No Reverse Proxy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../traefik/" class="md-nav__link">
@ -1281,29 +1304,6 @@
<li class="md-nav__item">
<a href="../../../guides/account/" class="md-nav__link">
<span class="md-ellipsis">
Edit Account
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/admin/" class="md-nav__link">
@ -1328,12 +1328,12 @@
<li class="md-nav__item">
<a href="../../../guides/clients/" class="md-nav__link">
<a href="../../../guides/cli/" class="md-nav__link">
<span class="md-ellipsis">
Edit Client
CLI
</span>
@ -1351,12 +1351,12 @@
<li class="md-nav__item">
<a href="../../../guides/login/" class="md-nav__link">
<a href="../../../guides/clients/" class="md-nav__link">
<span class="md-ellipsis">
Login
Edit Client
</span>
@ -1511,10 +1511,10 @@
<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", "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 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>

76
Pre-release/examples/tutorials/podman-nft/index.html
View File

File diff suppressed because one or more lines are too long

305
Pre-release/guides/login/index.html → Pre-release/examples/tutorials/reverse-proxyless/index.html
View File

@ -12,28 +12,28 @@
<meta name="author" content="WireGuard Easy">
<link rel="canonical" href="https://wg-easy.github.io/wg-easy/Pre-release/guides/login/">
<link rel="canonical" href="https://wg-easy.github.io/wg-easy/Pre-release/examples/tutorials/reverse-proxyless/">
<link rel="prev" href="../clients/">
<link rel="prev" href="../podman-nft/">
<link rel="next" href="../setup/">
<link rel="next" href="../traefik/">
<link rel="icon" href="../../assets/logo/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
<link rel="icon" href="../../../assets/logo/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
<title>Login - wg-easy</title>
<title>No Reverse Proxy - wg-easy</title>
<link rel="stylesheet" href="../../assets/stylesheets/main.4af4bdda.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">
@ -52,7 +52,7 @@
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@ -77,6 +77,11 @@
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#setup" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
@ -91,9 +96,9 @@
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../.." title="wg-easy" class="md-header__button md-logo" aria-label="wg-easy" data-md-component="logo">
<a href="../../.." title="wg-easy" class="md-header__button md-logo" aria-label="wg-easy" data-md-component="logo">
<img src="../../assets/logo/logo.png" alt="logo">
<img src="../../../assets/logo/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@ -110,7 +115,7 @@
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Login
No Reverse Proxy
</span>
</div>
@ -221,7 +226,7 @@
<li class="md-tabs__item">
<a href="../.." class="md-tabs__link">
<a href="../../.." class="md-tabs__link">
@ -240,7 +245,7 @@
<li class="md-tabs__item">
<a href="../../faq/" class="md-tabs__link">
<a href="../../../faq/" class="md-tabs__link">
@ -259,7 +264,7 @@
<li class="md-tabs__item">
<a href="../../getting-started/" class="md-tabs__link">
<a href="../../../getting-started/" class="md-tabs__link">
@ -280,7 +285,7 @@
<li class="md-tabs__item">
<a href="../../advanced/api/" class="md-tabs__link">
<a href="../../../advanced/api/" class="md-tabs__link">
@ -300,7 +305,7 @@
<li class="md-tabs__item">
<a href="../../contributing/general/" class="md-tabs__link">
<a href="../../../contributing/general/" class="md-tabs__link">
@ -316,6 +321,8 @@
@ -323,11 +330,13 @@
<li class="md-tabs__item">
<a href="../../examples/tutorials/adguard/" class="md-tabs__link">
<li class="md-tabs__item md-tabs__item--active">
<a href="../adguard/" class="md-tabs__link">
@ -346,13 +355,11 @@
<li class="md-tabs__item md-tabs__item--active">
<a href="../2fa/" class="md-tabs__link">
<li class="md-tabs__item">
<a href="../../../guides/2fa/" class="md-tabs__link">
@ -386,9 +393,9 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../.." title="wg-easy" class="md-nav__button md-logo" aria-label="wg-easy" data-md-component="logo">
<a href="../../.." title="wg-easy" class="md-nav__button md-logo" aria-label="wg-easy" data-md-component="logo">
<img src="../../assets/logo/logo.png" alt="logo">
<img src="../../../assets/logo/logo.png" alt="logo">
</a>
wg-easy
@ -415,7 +422,7 @@
<li class="md-nav__item">
<a href="../.." class="md-nav__link">
<a href="../../.." class="md-nav__link">
@ -437,7 +444,7 @@
<li class="md-nav__item">
<a href="../../faq/" class="md-nav__link">
<a href="../../../faq/" class="md-nav__link">
@ -459,7 +466,7 @@
<li class="md-nav__item">
<a href="../../getting-started/" class="md-nav__link">
<a href="../../../getting-started/" class="md-nav__link">
@ -524,7 +531,7 @@
<li class="md-nav__item">
<a href="../../advanced/api/" class="md-nav__link">
<a href="../../../advanced/api/" class="md-nav__link">
@ -590,7 +597,7 @@
<li class="md-nav__item">
<a href="../../advanced/config/optional-config/" class="md-nav__link">
<a href="../../../advanced/config/optional-config/" class="md-nav__link">
@ -613,7 +620,7 @@
<li class="md-nav__item">
<a href="../../advanced/config/unattended-setup/" class="md-nav__link">
<a href="../../../advanced/config/unattended-setup/" class="md-nav__link">
@ -687,7 +694,7 @@
<li class="md-nav__item">
<a href="../../advanced/metrics/prometheus/" class="md-nav__link">
<a href="../../../advanced/metrics/prometheus/" class="md-nav__link">
@ -761,7 +768,7 @@
<li class="md-nav__item">
<a href="../../advanced/migrate/" class="md-nav__link">
<a href="../../../advanced/migrate/" class="md-nav__link">
@ -784,7 +791,7 @@
<li class="md-nav__item">
<a href="../../advanced/migrate/from-14-to-15/" class="md-nav__link">
<a href="../../../advanced/migrate/from-14-to-15/" class="md-nav__link">
@ -865,7 +872,7 @@
<li class="md-nav__item">
<a href="../../contributing/general/" class="md-nav__link">
<a href="../../../contributing/general/" class="md-nav__link">
@ -888,7 +895,7 @@
<li class="md-nav__item">
<a href="../../contributing/issues-and-pull-requests/" class="md-nav__link">
<a href="../../../contributing/issues-and-pull-requests/" class="md-nav__link">
@ -915,6 +922,8 @@
@ -922,19 +931,20 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
@ -947,7 +957,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Examples
@ -958,6 +968,8 @@
@ -968,13 +980,11 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" checked>
<label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
@ -990,7 +1000,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_6_1">
<span class="md-nav__icon md-icon"></span>
Tutorials
@ -1004,7 +1014,7 @@
<li class="md-nav__item">
<a href="../../examples/tutorials/adguard/" class="md-nav__link">
<a href="../adguard/" class="md-nav__link">
@ -1027,7 +1037,7 @@
<li class="md-nav__item">
<a href="../../examples/tutorials/auto-updates/" class="md-nav__link">
<a href="../auto-updates/" class="md-nav__link">
@ -1050,7 +1060,7 @@
<li class="md-nav__item">
<a href="../../examples/tutorials/basic-installation/" class="md-nav__link">
<a href="../basic-installation/" class="md-nav__link">
@ -1073,7 +1083,7 @@
<li class="md-nav__item">
<a href="../../examples/tutorials/caddy/" class="md-nav__link">
<a href="../caddy/" class="md-nav__link">
@ -1096,7 +1106,7 @@
<li class="md-nav__item">
<a href="../../examples/tutorials/docker-run/" class="md-nav__link">
<a href="../docker-run/" class="md-nav__link">
@ -1119,7 +1129,7 @@
<li class="md-nav__item">
<a href="../../examples/tutorials/dockerless/" class="md-nav__link">
<a href="../dockerless/" class="md-nav__link">
@ -1142,7 +1152,7 @@
<li class="md-nav__item">
<a href="../../examples/tutorials/podman-nft/" class="md-nav__link">
<a href="../podman-nft/" class="md-nav__link">
@ -1162,10 +1172,80 @@
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<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">
<span class="md-ellipsis">
No Reverse Proxy
</span>
</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 class="md-nav__item">
<a href="../../examples/tutorials/traefik/" class="md-nav__link">
<a href="../traefik/" class="md-nav__link">
@ -1200,8 +1280,6 @@
@ -1209,20 +1287,19 @@
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" checked>
<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="">
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
@ -1235,7 +1312,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="true">
<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
@ -1249,7 +1326,7 @@
<li class="md-nav__item">
<a href="../2fa/" class="md-nav__link">
<a href="../../../guides/2fa/" class="md-nav__link">
@ -1272,12 +1349,12 @@
<li class="md-nav__item">
<a href="../account/" class="md-nav__link">
<a href="../../../guides/admin/" class="md-nav__link">
<span class="md-ellipsis">
Edit Account
Admin Panel
</span>
@ -1295,12 +1372,12 @@
<li class="md-nav__item">
<a href="../admin/" class="md-nav__link">
<a href="../../../guides/cli/" class="md-nav__link">
<span class="md-ellipsis">
Admin Panel
CLI
</span>
@ -1318,7 +1395,7 @@
<li class="md-nav__item">
<a href="../clients/" class="md-nav__link">
<a href="../../../guides/clients/" class="md-nav__link">
@ -1338,41 +1415,10 @@
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Login
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../setup/" class="md-nav__link">
<a href="../../../guides/setup/" class="md-nav__link">
@ -1413,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>
</div>
</div>
@ -1427,7 +1490,7 @@
<a href="https://github.com/wg-easy/wg-easy/edit/master/docs/content/guides/login.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>
</a>
@ -1436,16 +1499,42 @@
<a href="https://github.com/wg-easy/wg-easy/raw/master/docs/content/guides/login.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>
</a>
<h1>Login</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>
@ -1508,10 +1597,10 @@
<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", "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 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>

210
Pre-release/examples/tutorials/traefik/index.html
View File

@ -15,14 +15,14 @@
<link rel="canonical" href="https://wg-easy.github.io/wg-easy/Pre-release/examples/tutorials/traefik/">
<link rel="prev" href="../podman-nft/">
<link rel="prev" href="../reverse-proxyless/">
<link rel="next" href="../../../guides/2fa/">
<link rel="icon" href="../../../assets/logo/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
@ -30,7 +30,7 @@
<link rel="stylesheet" href="../../../assets/stylesheets/main.4af4bdda.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/main.342714a4.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
@ -1172,6 +1172,29 @@
<li class="md-nav__item">
<a href="../reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis">
No Reverse Proxy
</span>
</a>
</li>
@ -1397,29 +1420,6 @@
<li class="md-nav__item">
<a href="../../../guides/account/" class="md-nav__link">
<span class="md-ellipsis">
Edit Account
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/admin/" class="md-nav__link">
@ -1444,12 +1444,12 @@
<li class="md-nav__item">
<a href="../../../guides/clients/" class="md-nav__link">
<a href="../../../guides/cli/" class="md-nav__link">
<span class="md-ellipsis">
Edit Client
CLI
</span>
@ -1467,12 +1467,12 @@
<li class="md-nav__item">
<a href="../../../guides/login/" class="md-nav__link">
<a href="../../../guides/clients/" class="md-nav__link">
<span class="md-ellipsis">
Login
Edit Client
</span>
@ -1663,101 +1663,101 @@
<h2 id="create-docker-compose-file"><a class="toclink" href="#create-docker-compose-file">Create docker compose file</a></h2>
<p>File: <code>/etc/docker/containers/traefik/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">traefik</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">traefik:3.3</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">traefik</span>
<span class="w"> </span><span class="nt">restart</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">unless-stopped</span>
<span class="w"> </span><span class="nt">ports</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&quot;80:80&quot;</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&quot;443:443/tcp&quot;</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&quot;443:443/udp&quot;</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="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/docker/volumes/traefik/traefik.yml:/traefik.yml:ro</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/docker/volumes/traefik/traefik_dynamic.yml:/traefik_dynamic.yml:ro</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/docker/volumes/traefik/acme.json:/acme.json</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">traefik</span>
<span class="w"> </span><span class="nt">traefik</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">traefik:3.3</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">traefik</span>
<span class="w"> </span><span class="nt">restart</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">unless-stopped</span>
<span class="w"> </span><span class="nt">ports</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&#39;80:80&#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">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="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/docker/volumes/traefik/traefik.yml:/traefik.yml:ro</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/docker/volumes/traefik/traefik_dynamic.yml:/traefik_dynamic.yml:ro</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/docker/volumes/traefik/acme.json:/acme.json</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">traefik</span>
<span class="nt">networks</span><span class="p">:</span>
<span class="w"> </span><span class="nt">traefik</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="nt">traefik</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>
</code></pre></div>
<h2 id="create-traefikyml"><a class="toclink" href="#create-traefikyml">Create traefik.yml</a></h2>
<p>File: <code>/etc/docker/volumes/traefik/traefik.yml</code></p>
<div class="highlight"><pre><span></span><code><span class="nt">log</span><span class="p">:</span>
<span class="w"> </span><span class="nt">level</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">INFO</span>
<span class="w"> </span><span class="nt">level</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">INFO</span>
<span class="nt">entryPoints</span><span class="p">:</span>
<span class="w"> </span><span class="nt">web</span><span class="p">:</span>
<span class="w"> </span><span class="nt">address</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;:80/tcp&quot;</span>
<span class="w"> </span><span class="nt">http</span><span class="p">:</span>
<span class="w"> </span><span class="nt">redirections</span><span class="p">:</span>
<span class="w"> </span><span class="nt">entryPoint</span><span class="p">:</span>
<span class="w"> </span><span class="nt">to</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">websecure</span>
<span class="w"> </span><span class="nt">scheme</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https</span>
<span class="w"> </span><span class="nt">websecure</span><span class="p">:</span>
<span class="w"> </span><span class="nt">address</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;:443/tcp&quot;</span>
<span class="w"> </span><span class="nt">http</span><span class="p">:</span>
<span class="w"> </span><span class="nt">middlewares</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">compress@file</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">hsts@file</span>
<span class="w"> </span><span class="nt">tls</span><span class="p">:</span>
<span class="w"> </span><span class="nt">certResolver</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">letsencrypt</span>
<span class="w"> </span><span class="nt">http3</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{}</span>
<span class="w"> </span><span class="nt">web</span><span class="p">:</span>
<span class="w"> </span><span class="nt">address</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;:80/tcp&#39;</span>
<span class="w"> </span><span class="nt">http</span><span class="p">:</span>
<span class="w"> </span><span class="nt">redirections</span><span class="p">:</span>
<span class="w"> </span><span class="nt">entryPoint</span><span class="p">:</span>
<span class="w"> </span><span class="nt">to</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">websecure</span>
<span class="w"> </span><span class="nt">scheme</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https</span>
<span class="w"> </span><span class="nt">websecure</span><span class="p">:</span>
<span class="w"> </span><span class="nt">address</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;:443/tcp&#39;</span>
<span class="w"> </span><span class="nt">http</span><span class="p">:</span>
<span class="w"> </span><span class="nt">middlewares</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">compress@file</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">hsts@file</span>
<span class="w"> </span><span class="nt">tls</span><span class="p">:</span>
<span class="w"> </span><span class="nt">certResolver</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">letsencrypt</span>
<span class="w"> </span><span class="nt">http3</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{}</span>
<span class="nt">api</span><span class="p">:</span>
<span class="w"> </span><span class="nt">dashboard</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="nt">dashboard</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
<span class="nt">certificatesResolvers</span><span class="p">:</span>
<span class="w"> </span><span class="nt">letsencrypt</span><span class="p">:</span>
<span class="w"> </span><span class="nt">acme</span><span class="p">:</span>
<span class="w"> </span><span class="nt">email</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">[email protected]$</span>
<span class="w"> </span><span class="nt">storage</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">acme.json</span>
<span class="w"> </span><span class="nt">httpChallenge</span><span class="p">:</span>
<span class="w"> </span><span class="nt">entryPoint</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">web</span>
<span class="w"> </span><span class="nt">letsencrypt</span><span class="p">:</span>
<span class="w"> </span><span class="nt">acme</span><span class="p">:</span>
<span class="w"> </span><span class="nt">email</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">[email protected]$</span>
<span class="w"> </span><span class="nt">storage</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">acme.json</span>
<span class="w"> </span><span class="nt">httpChallenge</span><span class="p">:</span>
<span class="w"> </span><span class="nt">entryPoint</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">web</span>
<span class="nt">providers</span><span class="p">:</span>
<span class="w"> </span><span class="nt">docker</span><span class="p">:</span>
<span class="w"> </span><span class="nt">watch</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="nt">network</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">traefik</span>
<span class="w"> </span><span class="nt">exposedByDefault</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
<span class="w"> </span><span class="nt">file</span><span class="p">:</span>
<span class="w"> </span><span class="nt">filename</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">traefik_dynamic.yml</span>
<span class="w"> </span><span class="nt">docker</span><span class="p">:</span>
<span class="w"> </span><span class="nt">watch</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="nt">network</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">traefik</span>
<span class="w"> </span><span class="nt">exposedByDefault</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
<span class="w"> </span><span class="nt">file</span><span class="p">:</span>
<span class="w"> </span><span class="nt">filename</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">traefik_dynamic.yml</span>
<span class="nt">serversTransport</span><span class="p">:</span>
<span class="w"> </span><span class="nt">insecureSkipVerify</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="nt">insecureSkipVerify</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
</code></pre></div>
<h2 id="create-traefik_dynamicyml"><a class="toclink" href="#create-traefik_dynamicyml">Create traefik_dynamic.yml</a></h2>
<p>File: <code>/etc/docker/volumes/traefik/traefik_dynamic.yml</code></p>
<div class="highlight"><pre><span></span><code><span class="nt">http</span><span class="p">:</span>
<span class="w"> </span><span class="nt">middlewares</span><span class="p">:</span>
<span class="w"> </span><span class="nt">services</span><span class="p">:</span>
<span class="w"> </span><span class="nt">basicAuth</span><span class="p">:</span>
<span class="w"> </span><span class="nt">users</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&quot;$username$:$password$&quot;</span>
<span class="w"> </span><span class="nt">compress</span><span class="p">:</span>
<span class="w"> </span><span class="nt">compress</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{}</span>
<span class="w"> </span><span class="nt">hsts</span><span class="p">:</span>
<span class="w"> </span><span class="nt">headers</span><span class="p">:</span>
<span class="w"> </span><span class="nt">stsSeconds</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">2592000</span>
<span class="w"> </span><span class="nt">routers</span><span class="p">:</span>
<span class="w"> </span><span class="nt">api</span><span class="p">:</span>
<span class="w"> </span><span class="nt">rule</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Host(`traefik.$example.com$`)</span>
<span class="w"> </span><span class="nt">entrypoints</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">websecure</span>
<span class="w"> </span><span class="nt">middlewares</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">services</span>
<span class="w"> </span><span class="nt">service</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">api@internal</span>
<span class="w"> </span><span class="nt">middlewares</span><span class="p">:</span>
<span class="w"> </span><span class="nt">services</span><span class="p">:</span>
<span class="w"> </span><span class="nt">basicAuth</span><span class="p">:</span>
<span class="w"> </span><span class="nt">users</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&#39;$username$:$password$&#39;</span>
<span class="w"> </span><span class="nt">compress</span><span class="p">:</span>
<span class="w"> </span><span class="nt">compress</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{}</span>
<span class="w"> </span><span class="nt">hsts</span><span class="p">:</span>
<span class="w"> </span><span class="nt">headers</span><span class="p">:</span>
<span class="w"> </span><span class="nt">stsSeconds</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">2592000</span>
<span class="w"> </span><span class="nt">routers</span><span class="p">:</span>
<span class="w"> </span><span class="nt">api</span><span class="p">:</span>
<span class="w"> </span><span class="nt">rule</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Host(`traefik.$example.com$`)</span>
<span class="w"> </span><span class="nt">entrypoints</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">websecure</span>
<span class="w"> </span><span class="nt">middlewares</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">services</span>
<span class="w"> </span><span class="nt">service</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">api@internal</span>
<span class="nt">tls</span><span class="p">:</span>
<span class="w"> </span><span class="nt">options</span><span class="p">:</span>
<span class="w"> </span><span class="nt">default</span><span class="p">:</span>
<span class="w"> </span><span class="nt">cipherSuites</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">TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256</span>
<span class="w"> </span><span class="nt">sniStrict</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="nt">options</span><span class="p">:</span>
<span class="w"> </span><span class="nt">default</span><span class="p">:</span>
<span class="w"> </span><span class="nt">cipherSuites</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">TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256</span>
<span class="w"> </span><span class="nt">sniStrict</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
</code></pre></div>
<h2 id="create-acmejson"><a class="toclink" href="#create-acmejson">Create acme.json</a></h2>
<div class="highlight"><pre><span></span><code>sudo<span class="w"> </span>touch<span class="w"> </span>/etc/docker/volumes/traefik/acme.json
@ -1860,10 +1860,10 @@ sudo<span class="w"> </span>docker-compose<span class="w"> </span>up<span class=
<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", "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 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>

124
Pre-release/faq/index.html
View File

@ -22,7 +22,7 @@
<link rel="icon" href="../assets/logo/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
@ -30,7 +30,7 @@
<link rel="stylesheet" href="../assets/stylesheets/main.4af4bdda.min.css">
<link rel="stylesheet" href="../assets/stylesheets/main.342714a4.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
@ -1254,6 +1254,29 @@
<li class="md-nav__item">
<a href="../examples/tutorials/reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis">
No Reverse Proxy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../examples/tutorials/traefik/" class="md-nav__link">
@ -1358,29 +1381,6 @@
<li class="md-nav__item">
<a href="../guides/account/" class="md-nav__link">
<span class="md-ellipsis">
Edit Account
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../guides/admin/" class="md-nav__link">
@ -1405,12 +1405,12 @@
<li class="md-nav__item">
<a href="../guides/clients/" class="md-nav__link">
<a href="../guides/cli/" class="md-nav__link">
<span class="md-ellipsis">
Edit Client
CLI
</span>
@ -1428,12 +1428,12 @@
<li class="md-nav__item">
<a href="../guides/login/" class="md-nav__link">
<a href="../guides/clients/" class="md-nav__link">
<span class="md-ellipsis">
Login
Edit Client
</span>
@ -1586,67 +1586,77 @@
<p>This error indicates that the WireGuard interface <code>wg0</code> does not exist. This can happen if the WireGuard kernel module is not loaded or if the interface was not created properly.</p>
<p>To resolve this issue, you can try the following steps:</p>
<ol>
<li><strong>Load the WireGuard kernel module</strong>: If the WireGuard kernel module is not loaded, you can load it manually by running:</li>
</ol>
<div class="highlight"><pre><span></span><code><span class="w"> </span>sudo<span class="w"> </span>modprobe<span class="w"> </span>wireguard
<li>
<p><strong>Load the WireGuard kernel module</strong>: If the WireGuard kernel module is not loaded, you can load it manually by running:</p>
<div class="highlight"><pre><span></span><code>sudo<span class="w"> </span>modprobe<span class="w"> </span>wireguard
</code></pre></div>
<ol>
<li><strong>Load the WireGuard kernel module on boot</strong>: If you want to ensure that the WireGuard kernel module is loaded automatically on boot, you can add it to the <code>/etc/modules</code> file:</li>
</ol>
</li>
<li>
<p><strong>Load the WireGuard kernel module on boot</strong>: If you want to ensure that the WireGuard kernel module is loaded automatically on boot, you can add it to the <code>/etc/modules</code> file:</p>
<div class="highlight"><pre><span></span><code><span class="nb">echo</span><span class="w"> </span><span class="s2">&quot;wireguard&quot;</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>sudo<span class="w"> </span>tee<span class="w"> </span>-a<span class="w"> </span>/etc/modules
</code></pre></div>
</li>
</ol>
<h2 id="cant-initialize-iptables-table-nat-table-does-not-exist-do-you-need-to-insmod"><a class="toclink" href="#cant-initialize-iptables-table-nat-table-does-not-exist-do-you-need-to-insmod">can't initialize iptables table `nat': Table does not exist (do you need to insmod?)</a></h2>
<p>This error indicates that the <code>nat</code> table in <code>iptables</code> does not exist. This can happen if the <code>iptables</code> kernel module is not loaded or if the <code>nat</code> table is not supported by your kernel.</p>
<p>To resolve this issue, you can try the following steps:</p>
<ol>
<li><strong>Load the <code>nat</code> kernel module</strong>: If the <code>nat</code> kernel module is not loaded, you can load it manually by running:</li>
</ol>
<li>
<p><strong>Load the <code>nat</code> kernel module</strong>: If the <code>nat</code> kernel module is not loaded, you can load it manually by running:</p>
<div class="highlight"><pre><span></span><code>sudo<span class="w"> </span>modprobe<span class="w"> </span>iptable_nat
</code></pre></div>
<ol>
<li><strong>Load the <code>nat</code> kernel module on boot</strong>: If you want to ensure that the <code>nat</code> kernel module is loaded automatically on boot, you can add it to the <code>/etc/modules</code> file:</li>
</ol>
</li>
<li>
<p><strong>Load the <code>nat</code> kernel module on boot</strong>: If you want to ensure that the <code>nat</code> kernel module is loaded automatically on boot, you can add it to the <code>/etc/modules</code> file:</p>
<div class="highlight"><pre><span></span><code><span class="w"> </span><span class="nb">echo</span><span class="w"> </span><span class="s2">&quot;iptable_nat&quot;</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>sudo<span class="w"> </span>tee<span class="w"> </span>-a<span class="w"> </span>/etc/modules
</code></pre></div>
</li>
</ol>
<h2 id="cant-initialize-ip6tables-table-nat-table-does-not-exist-do-you-need-to-insmod"><a class="toclink" href="#cant-initialize-ip6tables-table-nat-table-does-not-exist-do-you-need-to-insmod">can't initialize ip6tables table `nat': Table does not exist (do you need to insmod?)</a></h2>
<p>This error indicates that the <code>nat</code> table in <code>ip6tables</code> does not exist. This can happen if the <code>ip6tables</code> kernel module is not loaded or if the <code>nat</code> table is not supported by your kernel.</p>
<p>To resolve this issue, you can try the following steps:</p>
<ol>
<li><strong>Load the <code>nat</code> kernel module</strong>: If the <code>nat</code> kernel module is not loaded, you can load it manually by running:</li>
</ol>
<li>
<p><strong>Load the <code>nat</code> kernel module</strong>: If the <code>nat</code> kernel module is not loaded, you can load it manually by running:</p>
<div class="highlight"><pre><span></span><code>sudo<span class="w"> </span>modprobe<span class="w"> </span>ip6table_nat
</code></pre></div>
<ol>
<li><strong>Load the <code>nat</code> kernel module on boot</strong>: If you want to ensure that the <code>nat</code> kernel module is loaded automatically on boot, you can add it to the <code>/etc/modules</code> file:</li>
</ol>
</li>
<li>
<p><strong>Load the <code>nat</code> kernel module on boot</strong>: If you want to ensure that the <code>nat</code> kernel module is loaded automatically on boot, you can add it to the <code>/etc/modules</code> file:</p>
<div class="highlight"><pre><span></span><code><span class="w"> </span><span class="nb">echo</span><span class="w"> </span><span class="s2">&quot;ip6table_nat&quot;</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>sudo<span class="w"> </span>tee<span class="w"> </span>-a<span class="w"> </span>/etc/modules
</code></pre></div>
</li>
</ol>
<h2 id="cant-initialize-iptables-table-filter-permission-denied"><a class="toclink" href="#cant-initialize-iptables-table-filter-permission-denied">can't initialize iptables table `filter': Permission denied</a></h2>
<p>This error indicates that the <code>filter</code> table in <code>iptables</code> cannot be initialized due to permission issues. This can happen if you are not running the command with sufficient privileges.</p>
<p>To resolve this issue, you can try the following steps:</p>
<ol>
<li><strong>Load the <code>filter</code> kernel module</strong>: If the <code>filter</code> kernel module is not loaded, you can load it manually by running:</li>
</ol>
<li>
<p><strong>Load the <code>filter</code> kernel module</strong>: If the <code>filter</code> kernel module is not loaded, you can load it manually by running:</p>
<div class="highlight"><pre><span></span><code>sudo<span class="w"> </span>modprobe<span class="w"> </span>iptable_filter
</code></pre></div>
<ol>
<li><strong>Load the <code>filter</code> kernel module on boot</strong>: If you want to ensure that the <code>filter</code> kernel module is loaded automatically on boot, you can add it to the <code>/etc/modules</code> file:</li>
</ol>
</li>
<li>
<p><strong>Load the <code>filter</code> kernel module on boot</strong>: If you want to ensure that the <code>filter</code> kernel module is loaded automatically on boot, you can add it to the <code>/etc/modules</code> file:</p>
<div class="highlight"><pre><span></span><code><span class="nb">echo</span><span class="w"> </span><span class="s2">&quot;iptable_filter&quot;</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>sudo<span class="w"> </span>tee<span class="w"> </span>-a<span class="w"> </span>/etc/modules
</code></pre></div>
</li>
</ol>
<h2 id="cant-initialize-ip6tables-table-filter-permission-denied"><a class="toclink" href="#cant-initialize-ip6tables-table-filter-permission-denied">can't initialize ip6tables table `filter': Permission denied</a></h2>
<p>This error indicates that the <code>filter</code> table in <code>ip6tables</code> cannot be initialized due to permission issues. This can happen if you are not running the command with sufficient privileges.</p>
<p>To resolve this issue, you can try the following steps:</p>
<ol>
<li><strong>Load the <code>filter</code> kernel module</strong>: If the <code>filter</code> kernel module is not loaded, you can load it manually by running:</li>
</ol>
<li>
<p><strong>Load the <code>filter</code> kernel module</strong>: If the <code>filter</code> kernel module is not loaded, you can load it manually by running:</p>
<div class="highlight"><pre><span></span><code>sudo<span class="w"> </span>modprobe<span class="w"> </span>ip6table_filter
</code></pre></div>
<ol>
<li><strong>Load the <code>filter</code> kernel module on boot</strong>: If you want to ensure that the <code>filter</code> kernel module is loaded automatically on boot, you can add it to the <code>/etc/modules</code> file:</li>
</ol>
</li>
<li>
<p><strong>Load the <code>filter</code> kernel module on boot</strong>: If you want to ensure that the <code>filter</code> kernel module is loaded automatically on boot, you can add it to the <code>/etc/modules</code> file:</p>
<div class="highlight"><pre><span></span><code><span class="w"> </span><span class="nb">echo</span><span class="w"> </span><span class="s2">&quot;ip6table_filter&quot;</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>sudo<span class="w"> </span>tee<span class="w"> </span>-a<span class="w"> </span>/etc/modules
</code></pre></div>
</li>
</ol>
@ -1711,10 +1721,10 @@
<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", "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 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>

167
Pre-release/getting-started/index.html
View File

@ -22,7 +22,7 @@
<link rel="icon" href="../assets/logo/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
@ -30,7 +30,7 @@
<link rel="stylesheet" href="../assets/stylesheets/main.4af4bdda.min.css">
<link rel="stylesheet" href="../assets/stylesheets/main.342714a4.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
@ -555,36 +555,9 @@
</li>
<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">
Stopping the Container
Follow tutorials
</span>
</a>
@ -1293,6 +1266,29 @@
<li class="md-nav__item">
<a href="../examples/tutorials/reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis">
No Reverse Proxy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../examples/tutorials/traefik/" class="md-nav__link">
@ -1397,29 +1393,6 @@
<li class="md-nav__item">
<a href="../guides/account/" class="md-nav__link">
<span class="md-ellipsis">
Edit Account
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../guides/admin/" class="md-nav__link">
@ -1444,12 +1417,12 @@
<li class="md-nav__item">
<a href="../guides/clients/" class="md-nav__link">
<a href="../guides/cli/" class="md-nav__link">
<span class="md-ellipsis">
Edit Client
CLI
</span>
@ -1467,12 +1440,12 @@
<li class="md-nav__item">
<a href="../guides/login/" class="md-nav__link">
<a href="../guides/clients/" class="md-nav__link">
<span class="md-ellipsis">
Login
Edit Client
</span>
@ -1583,36 +1556,9 @@
</li>
<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">
Stopping the Container
Follow tutorials
</span>
</a>
@ -1665,7 +1611,7 @@
<ol>
<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 a supported architecture (x86_64, arm64)</li>
<li>You need a supported architecture (x86_64, arm64, armv7)</li>
</ol>
<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>
@ -1698,13 +1644,13 @@ If you're using podman, make sure to read the related <a href="../examples/tutor
<td><code>15</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</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>stable as possible get bug fixes quickly when needed, see Releases for more information.</td>
<td>points to latest release, can include breaking changes</td>
</tr>
<tr>
<td><code>15.0</code></td>
@ -1716,43 +1662,36 @@ If you're using podman, make sure to read the related <a href="../examples/tutor
<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, don't use this as this will not get updated</td>
<td>specific release, no updates</td>
</tr>
<tr>
<td><code>nightly</code></td>
<td><a href="https://github.com/wg-easy/wg-easy/tree/master"><code>master</code></a></td>
<td><code>ghcr.io/wg-easy/wg-easy:nightly</code></td>
<td>mostly unstable gets frequent package and code updates, deployed against <a href="https://github.com/wg-easy/wg-easy/tree/master"><code>master</code></a>.</td>
<td><code>edge</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 before landing into <a href="https://github.com/wg-easy/wg-easy/tree/master"><code>master</code></a>.</td>
<td>used for development, testing code from PRs</td>
</tr>
</tbody>
</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>
<h3 id="get-all-files"><a class="toclink" href="#get-all-files">Get All Files</a></h3>
<p>Issue the following command to acquire the necessary file:</p>
<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>
</code></pre></div>
<h3 id="start-the-container"><a class="toclink" href="#start-the-container">Start the Container</a></h3>
<p>To start 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>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>
<h3 id="follow-tutorials"><a class="toclink" href="#follow-tutorials">Follow tutorials</a></h3>
<ul>
<li><a href="../examples/tutorials/basic-installation/">Basic Installation with Docker Compose (Recommended)</a></li>
<li><a href="../examples/tutorials/docker-run/">Simple Installation with Docker Run</a></li>
<li><a href="../examples/tutorials/podman-nft/">Advanced Installation with Podman</a></li>
</ul>
<div class="admonition danger">
<p class="admonition-title">Using the Correct Commands For Stopping and Starting <code>wg-easy</code></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>
</div>
<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>
@ -1817,10 +1756,10 @@ If you're using podman, make sure to read the related <a href="../examples/tutor
<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", "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 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>

165
Pre-release/guides/2fa/index.html
View File

@ -18,11 +18,11 @@
<link rel="prev" href="../../examples/tutorials/traefik/">
<link rel="next" href="../account/">
<link rel="next" href="../admin/">
<link rel="icon" href="../../assets/logo/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
@ -30,7 +30,7 @@
<link rel="stylesheet" href="../../assets/stylesheets/main.4af4bdda.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/main.342714a4.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
@ -77,6 +77,11 @@
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#enable-totp" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
@ -1164,6 +1169,29 @@
<li class="md-nav__item">
<a href="../../examples/tutorials/reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis">
No Reverse Proxy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../examples/tutorials/traefik/" class="md-nav__link">
@ -1256,6 +1284,19 @@
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
2FA
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
@ -1268,29 +1309,50 @@
</a>
</li>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<li class="md-nav__item">
<a href="../account/" class="md-nav__link">
<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-totp" class="md-nav__link">
<span class="md-ellipsis">
Enable TOTP
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#configure-totp" class="md-nav__link">
<span class="md-ellipsis">
Configure TOTP
</span>
</a>
<span class="md-ellipsis">
Edit Account
</span>
</li>
<li class="md-nav__item">
<a href="#disable-totp" class="md-nav__link">
<span class="md-ellipsis">
Disable TOTP
</span>
</a>
</a>
</li>
</ul>
</nav>
</li>
@ -1326,12 +1388,12 @@
<li class="md-nav__item">
<a href="../clients/" class="md-nav__link">
<a href="../cli/" class="md-nav__link">
<span class="md-ellipsis">
Edit Client
CLI
</span>
@ -1349,12 +1411,12 @@
<li class="md-nav__item">
<a href="../login/" class="md-nav__link">
<a href="../clients/" class="md-nav__link">
<span class="md-ellipsis">
Login
Edit Client
</span>
@ -1413,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-totp" class="md-nav__link">
<span class="md-ellipsis">
Enable TOTP
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#configure-totp" class="md-nav__link">
<span class="md-ellipsis">
Configure TOTP
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#disable-totp" class="md-nav__link">
<span class="md-ellipsis">
Disable TOTP
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
@ -1445,7 +1542,25 @@
<h1>2FA</h1>
<p>TODO</p>
<p>The user can enable 2FA from the Account page. The Account page is accessible from the dropdown menu in the top right corner of the application.</p>
<h2 id="enable-totp"><a class="toclink" href="#enable-totp">Enable TOTP</a></h2>
<ul>
<li><strong>Enable Two Factor Authentication</strong>: Enable TOTP for the user.</li>
</ul>
<h2 id="configure-totp"><a class="toclink" href="#configure-totp">Configure TOTP</a></h2>
<p>A QR code will be displayed. Scan the QR code with your TOTP application (e.g., Google Authenticator, Authy, etc.) to add the account.</p>
<p>To verify that the TOTP key is working, the user must enter the TOTP code generated by the TOTP application.</p>
<ul>
<li><strong>TOTP Key</strong>: The TOTP key for the user. This key is used to generate the TOTP code.</li>
<li><strong>TOTP Code</strong>: The current TOTP code for the user. This code is used to verify the TOTP key.</li>
<li><strong>Enable Two Factor Authentication</strong>: Enable TOTP for the user.</li>
</ul>
<h2 id="disable-totp"><a class="toclink" href="#disable-totp">Disable TOTP</a></h2>
<p>To disable TOTP, the user must enter the current password.</p>
<ul>
<li><strong>Current Password</strong>: The current password of the user.</li>
<li><strong>Disable Two Factor Authentication</strong>: Disable TOTP for the user.</li>
</ul>
@ -1508,10 +1623,10 @@
<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", "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 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>

66
Pre-release/guides/admin/index.html
View File

@ -15,14 +15,14 @@
<link rel="canonical" href="https://wg-easy.github.io/wg-easy/Pre-release/guides/admin/">
<link rel="prev" href="../account/">
<link rel="prev" href="../2fa/">
<link rel="next" href="../clients/">
<link rel="next" href="../cli/">
<link rel="icon" href="../../assets/logo/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
@ -30,7 +30,7 @@
<link rel="stylesheet" href="../../assets/stylesheets/main.4af4bdda.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/main.342714a4.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
@ -1164,6 +1164,29 @@
<li class="md-nav__item">
<a href="../../examples/tutorials/reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis">
No Reverse Proxy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../examples/tutorials/traefik/" class="md-nav__link">
@ -1269,29 +1292,6 @@
<li class="md-nav__item">
<a href="../account/" class="md-nav__link">
<span class="md-ellipsis">
Edit Account
</span>
</a>
</li>
@ -1326,12 +1326,12 @@
<li class="md-nav__item">
<a href="../clients/" class="md-nav__link">
<a href="../cli/" class="md-nav__link">
<span class="md-ellipsis">
Edit Client
CLI
</span>
@ -1349,12 +1349,12 @@
<li class="md-nav__item">
<a href="../login/" class="md-nav__link">
<a href="../clients/" class="md-nav__link">
<span class="md-ellipsis">
Login
Edit Client
</span>
@ -1508,10 +1508,10 @@
<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", "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 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>

253
Pre-release/guides/account/index.html → Pre-release/guides/cli/index.html
View File

@ -12,25 +12,25 @@
<meta name="author" content="WireGuard Easy">
<link rel="canonical" href="https://wg-easy.github.io/wg-easy/Pre-release/guides/account/">
<link rel="canonical" href="https://wg-easy.github.io/wg-easy/Pre-release/guides/cli/">
<link rel="prev" href="../2fa/">
<link rel="prev" href="../admin/">
<link rel="next" href="../admin/">
<link rel="next" href="../clients/">
<link rel="icon" href="../../assets/logo/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
<title>Edit Account - wg-easy</title>
<title>CLI - wg-easy</title>
<link rel="stylesheet" href="../../assets/stylesheets/main.4af4bdda.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/main.342714a4.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
@ -77,6 +77,11 @@
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#docker-compose" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
@ -110,7 +115,7 @@
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Edit Account
CLI
</span>
</div>
@ -1164,6 +1169,29 @@
<li class="md-nav__item">
<a href="../../examples/tutorials/reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis">
No Reverse Proxy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../examples/tutorials/traefik/" class="md-nav__link">
@ -1269,28 +1297,20 @@
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<a href="./" class="md-nav__link md-nav__link--active">
<li class="md-nav__item">
<a href="../admin/" class="md-nav__link">
<span class="md-ellipsis">
Edit Account
Admin Panel
</span>
</a>
</li>
@ -1300,43 +1320,109 @@
<li class="md-nav__item">
<a href="../admin/" class="md-nav__link">
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
CLI
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Admin Panel
CLI
</span>
</a>
</li>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<li class="md-nav__item">
<a href="../clients/" class="md-nav__link">
<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="#docker-compose" class="md-nav__link">
<span class="md-ellipsis">
Docker Compose
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docker-run" class="md-nav__link">
<span class="md-ellipsis">
Docker Run
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#reset-password" class="md-nav__link">
<span class="md-ellipsis">
Reset Password
</span>
</a>
<nav class="md-nav" aria-label="Reset Password">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#by-prompt" class="md-nav__link">
<span class="md-ellipsis">
By Prompt
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#by-argument" class="md-nav__link">
<span class="md-ellipsis">
By Argument
</span>
</a>
<span class="md-ellipsis">
Edit Client
</span>
</li>
</ul>
</nav>
</a>
</li>
</ul>
</nav>
</li>
@ -1349,12 +1435,12 @@
<li class="md-nav__item">
<a href="../login/" class="md-nav__link">
<a href="../clients/" class="md-nav__link">
<span class="md-ellipsis">
Login
Edit Client
</span>
@ -1413,6 +1499,65 @@
<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="#docker-compose" class="md-nav__link">
<span class="md-ellipsis">
Docker Compose
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docker-run" class="md-nav__link">
<span class="md-ellipsis">
Docker Run
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#reset-password" class="md-nav__link">
<span class="md-ellipsis">
Reset Password
</span>
</a>
<nav class="md-nav" aria-label="Reset Password">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#by-prompt" class="md-nav__link">
<span class="md-ellipsis">
By Prompt
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#by-argument" class="md-nav__link">
<span class="md-ellipsis">
By Argument
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
@ -1427,7 +1572,7 @@
<a href="https://github.com/wg-easy/wg-easy/edit/master/docs/content/guides/account.md" title="Edit this page" class="md-content__button md-icon">
<a href="https://github.com/wg-easy/wg-easy/edit/master/docs/content/guides/cli.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>
</a>
@ -1436,16 +1581,38 @@
<a href="https://github.com/wg-easy/wg-easy/raw/master/docs/content/guides/account.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/guides/cli.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>
</a>
<h1>Edit Account</h1>
<h1>CLI</h1>
<p>TODO</p>
<p>If you want to use the CLI, you can run it with</p>
<h3 id="docker-compose"><a class="toclink" href="#docker-compose">Docker Compose</a></h3>
<div class="highlight"><pre><span></span><code><span class="nb">cd</span><span class="w"> </span>/etc/docker/containers/wg-easy
docker<span class="w"> </span>compose<span class="w"> </span><span class="nb">exec</span><span class="w"> </span>-it<span class="w"> </span>wg-easy<span class="w"> </span>cli
</code></pre></div>
<h3 id="docker-run"><a class="toclink" href="#docker-run">Docker Run</a></h3>
<div class="highlight"><pre><span></span><code>docker<span class="w"> </span>run<span class="w"> </span>--rm<span class="w"> </span>-it<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>-v<span class="w"> </span>~/.wg-easy:/etc/wireguard<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>ghcr.io/wg-easy/wg-easy:15<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>cli
</code></pre></div>
<h3 id="reset-password"><a class="toclink" href="#reset-password">Reset Password</a></h3>
<p>If you want to reset the password for the admin user, you can run the following command:</p>
<h4 id="by-prompt"><a class="toclink" href="#by-prompt">By Prompt</a></h4>
<div class="highlight"><pre><span></span><code><span class="nb">cd</span><span class="w"> </span>/etc/docker/containers/wg-easy
docker<span class="w"> </span>compose<span class="w"> </span><span class="nb">exec</span><span class="w"> </span>-it<span class="w"> </span>wg-easy<span class="w"> </span>cli<span class="w"> </span>db:admin:reset
</code></pre></div>
<p>You are asked to provide the new password</p>
<h4 id="by-argument"><a class="toclink" href="#by-argument">By Argument</a></h4>
<div class="highlight"><pre><span></span><code><span class="nb">cd</span><span class="w"> </span>/etc/docker/containers/wg-easy
docker<span class="w"> </span>compose<span class="w"> </span><span class="nb">exec</span><span class="w"> </span>-it<span class="w"> </span>wg-easy<span class="w"> </span>cli<span class="w"> </span>db:admin:reset<span class="w"> </span>--password<span class="w"> </span>&lt;new_password&gt;
</code></pre></div>
<p>This will reset the password for the admin user to the new password you provided. If you include special characters in the password, make sure to escape them properly.</p>
@ -1508,10 +1675,10 @@
<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", "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 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>

280
Pre-release/guides/clients/index.html
View File

@ -15,14 +15,14 @@
<link rel="canonical" href="https://wg-easy.github.io/wg-easy/Pre-release/guides/clients/">
<link rel="prev" href="../admin/">
<link rel="prev" href="../cli/">
<link rel="next" href="../login/">
<link rel="next" href="../setup/">
<link rel="icon" href="../../assets/logo/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
@ -30,7 +30,7 @@
<link rel="stylesheet" href="../../assets/stylesheets/main.4af4bdda.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/main.342714a4.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
@ -77,6 +77,11 @@
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#general" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
@ -1164,6 +1169,29 @@
<li class="md-nav__item">
<a href="../../examples/tutorials/reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis">
No Reverse Proxy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../examples/tutorials/traefik/" class="md-nav__link">
@ -1272,12 +1300,12 @@
<li class="md-nav__item">
<a href="../account/" class="md-nav__link">
<a href="../admin/" class="md-nav__link">
<span class="md-ellipsis">
Edit Account
Admin Panel
</span>
@ -1295,12 +1323,12 @@
<li class="md-nav__item">
<a href="../admin/" class="md-nav__link">
<a href="../cli/" class="md-nav__link">
<span class="md-ellipsis">
Admin Panel
CLI
</span>
@ -1325,8 +1353,8 @@
<a href="./" class="md-nav__link md-nav__link--active">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
@ -1335,31 +1363,110 @@
</span>
</a>
<span class="md-nav__icon md-icon"></span>
</label>
</li>
<li class="md-nav__item">
<a href="../login/" class="md-nav__link">
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Login
Edit Client
</span>
</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="#general" class="md-nav__link">
<span class="md-ellipsis">
General
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#address" class="md-nav__link">
<span class="md-ellipsis">
Address
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#allowed-ips" class="md-nav__link">
<span class="md-ellipsis">
Allowed IPs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#server-allowed-ips" class="md-nav__link">
<span class="md-ellipsis">
Server Allowed IPs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#dns" class="md-nav__link">
<span class="md-ellipsis">
DNS
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#advanced" class="md-nav__link">
<span class="md-ellipsis">
Advanced
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#hooks" class="md-nav__link">
<span class="md-ellipsis">
Hooks
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#actions" class="md-nav__link">
<span class="md-ellipsis">
Actions
</span>
</a>
</li>
</ul>
</nav>
</li>
@ -1413,6 +1520,86 @@
<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="#general" class="md-nav__link">
<span class="md-ellipsis">
General
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#address" class="md-nav__link">
<span class="md-ellipsis">
Address
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#allowed-ips" class="md-nav__link">
<span class="md-ellipsis">
Allowed IPs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#server-allowed-ips" class="md-nav__link">
<span class="md-ellipsis">
Server Allowed IPs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#dns" class="md-nav__link">
<span class="md-ellipsis">
DNS
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#advanced" class="md-nav__link">
<span class="md-ellipsis">
Advanced
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#hooks" class="md-nav__link">
<span class="md-ellipsis">
Hooks
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#actions" class="md-nav__link">
<span class="md-ellipsis">
Actions
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
@ -1445,7 +1632,44 @@
<h1>Edit Client</h1>
<p>TODO</p>
<h2 id="general"><a class="toclink" href="#general">General</a></h2>
<ul>
<li><strong>Name</strong>: The name of the client.</li>
<li><strong>Enabled</strong>: Whether the client can connect to the VPN.</li>
<li><strong>Expire Date</strong>: The date the client will be disabled.</li>
</ul>
<h2 id="address"><a class="toclink" href="#address">Address</a></h2>
<ul>
<li><strong>IPv4</strong>: The IPv4 address of the client.</li>
<li><strong>IPv6</strong>: The IPv6 address of the client.</li>
</ul>
<h2 id="allowed-ips"><a class="toclink" href="#allowed-ips">Allowed IPs</a></h2>
<p>Which IPs will be routed through the VPN.</p>
<p>This will not prevent the user from modifying it locally and accessing IP ranges that they should not be able to access.</p>
<p>Use firewall rules to prevent access to IP ranges that the user should not be able to access.</p>
<h2 id="server-allowed-ips"><a class="toclink" href="#server-allowed-ips">Server Allowed IPs</a></h2>
<p>Which IPs will be routed to the client.</p>
<h2 id="dns"><a class="toclink" href="#dns">DNS</a></h2>
<p>The DNS server that the client will use.</p>
<h2 id="advanced"><a class="toclink" href="#advanced">Advanced</a></h2>
<ul>
<li><strong>MTU</strong>: The maximum transmission unit for the client.</li>
<li><strong>Persistent Keepalive</strong>: The interval for sending keepalive packets to the server.</li>
</ul>
<h2 id="hooks"><a class="toclink" href="#hooks">Hooks</a></h2>
<p>This can only be used for clients that use <code>wg-quick</code>. Setting this will throw a error when importing the config on other clients.</p>
<ul>
<li><strong>PreUp</strong>: Commands to run before the interface is brought up.</li>
<li><strong>PostUp</strong>: Commands to run after the interface is brought up.</li>
<li><strong>PreDown</strong>: Commands to run before the interface is brought down.</li>
<li><strong>PostDown</strong>: Commands to run after the interface is brought down.</li>
</ul>
<h2 id="actions"><a class="toclink" href="#actions">Actions</a></h2>
<ul>
<li><strong>Save</strong>: Save the changes made in the form.</li>
<li><strong>Revert</strong>: Revert the changes made in the form.</li>
<li><strong>Delete</strong>: Delete the client.</li>
</ul>
@ -1508,10 +1732,10 @@
<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", "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 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>

206
Pre-release/guides/setup/index.html
View File

@ -15,12 +15,12 @@
<link rel="canonical" href="https://wg-easy.github.io/wg-easy/Pre-release/guides/setup/">
<link rel="prev" href="../login/">
<link rel="prev" href="../clients/">
<link rel="icon" href="../../assets/logo/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
@ -28,7 +28,7 @@
<link rel="stylesheet" href="../../assets/stylesheets/main.4af4bdda.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/main.342714a4.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
@ -75,6 +75,11 @@
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#user-setup" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
@ -1162,6 +1167,29 @@
<li class="md-nav__item">
<a href="../../examples/tutorials/reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis">
No Reverse Proxy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../examples/tutorials/traefik/" class="md-nav__link">
@ -1270,12 +1298,12 @@
<li class="md-nav__item">
<a href="../account/" class="md-nav__link">
<a href="../admin/" class="md-nav__link">
<span class="md-ellipsis">
Edit Account
Admin Panel
</span>
@ -1293,12 +1321,12 @@
<li class="md-nav__item">
<a href="../admin/" class="md-nav__link">
<a href="../cli/" class="md-nav__link">
<span class="md-ellipsis">
Admin Panel
CLI
</span>
@ -1336,50 +1364,99 @@
<li class="md-nav__item">
<a href="../login/" class="md-nav__link">
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Setup
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Login
Setup
</span>
</a>
</li>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<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="#user-setup" class="md-nav__link">
<span class="md-ellipsis">
User Setup
</span>
</a>
</li>
<a href="./" class="md-nav__link md-nav__link--active">
<li class="md-nav__item">
<a href="#existing-setup" class="md-nav__link">
<span class="md-ellipsis">
Existing Setup
</span>
</a>
<nav class="md-nav" aria-label="Existing Setup">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#no-host-setup" class="md-nav__link">
<span class="md-ellipsis">
No - Host Setup
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#yes-migration" class="md-nav__link">
<span class="md-ellipsis">
Yes - Migration
</span>
</a>
<span class="md-ellipsis">
Setup
</span>
</li>
</ul>
</nav>
</a>
</li>
</ul>
</nav>
</li>
@ -1411,6 +1488,56 @@
<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="#user-setup" class="md-nav__link">
<span class="md-ellipsis">
User Setup
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#existing-setup" class="md-nav__link">
<span class="md-ellipsis">
Existing Setup
</span>
</a>
<nav class="md-nav" aria-label="Existing Setup">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#no-host-setup" class="md-nav__link">
<span class="md-ellipsis">
No - Host Setup
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#yes-migration" class="md-nav__link">
<span class="md-ellipsis">
Yes - Migration
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
@ -1443,7 +1570,22 @@
<h1>Setup</h1>
<p>TODO</p>
<h2 id="user-setup"><a class="toclink" href="#user-setup">User Setup</a></h2>
<ul>
<li><strong>Username</strong>: The username of the user.</li>
<li><strong>Password</strong>: The password of the user.</li>
<li><strong>Confirm Password</strong>: The password of the user.</li>
</ul>
<h2 id="existing-setup"><a class="toclink" href="#existing-setup">Existing Setup</a></h2>
<p>If you have the config from the previous version, you can import it by clicking "Yes". This currently expects a config from v14.</p>
<p>If this is the first time you are using this, you can click "No" to create a new config.</p>
<h3 id="no-host-setup"><a class="toclink" href="#no-host-setup">No - Host Setup</a></h3>
<ul>
<li><strong>Host</strong>: The host of the server. The clients will connect to this address. This can be a domain name or an IP address. Make sure to wrap it in brackets if it is an IPv6 address. For example: <code>[::1]</code> or <code>[2001:db8::1]</code>.</li>
<li><strong>Port</strong>: The port of the server. The clients will connect to this port. The server will listen on this port.</li>
</ul>
<h3 id="yes-migration"><a class="toclink" href="#yes-migration">Yes - Migration</a></h3>
<p>Select the <code>wg0.json</code> file from the previous version. Read <a href="../../advanced/migrate/from-14-to-15/">Migrate from v14 to v15</a> for more information.</p>
@ -1506,10 +1648,10 @@
<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", "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 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>

62
Pre-release/index.html
View File

@ -20,7 +20,7 @@
<link rel="icon" href="assets/logo/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
@ -28,7 +28,7 @@
<link rel="stylesheet" href="assets/stylesheets/main.4af4bdda.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.342714a4.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@ -1262,6 +1262,29 @@
<li class="md-nav__item">
<a href="examples/tutorials/reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis">
No Reverse Proxy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="examples/tutorials/traefik/" class="md-nav__link">
@ -1366,29 +1389,6 @@
<li class="md-nav__item">
<a href="guides/account/" class="md-nav__link">
<span class="md-ellipsis">
Edit Account
</span>
</a>
</li>
<li class="md-nav__item">
<a href="guides/admin/" class="md-nav__link">
@ -1413,12 +1413,12 @@
<li class="md-nav__item">
<a href="guides/clients/" class="md-nav__link">
<a href="guides/cli/" class="md-nav__link">
<span class="md-ellipsis">
Edit Client
CLI
</span>
@ -1436,12 +1436,12 @@
<li class="md-nav__item">
<a href="guides/login/" class="md-nav__link">
<a href="guides/clients/" class="md-nav__link">
<span class="md-ellipsis">
Login
Edit Client
</span>
@ -1674,10 +1674,10 @@
<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", "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 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>

2
Pre-release/search/search_index.json
View File

File diff suppressed because one or more lines are too long

60
Pre-release/sitemap.xml
View File

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

BIN
Pre-release/sitemap.xml.gz
View File

Binary file not shown.
Write Preview
Loading…
Cancel
Save