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

This commit is contained in:
github-actions[bot]
2025-05-28 10:02:23 +00:00
parent 27b1237340
commit fc3f24ee46
35 changed files with 2097 additions and 1402 deletions
+146 -31
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>
<li class="md-nav__item">
<a href="../account/" class="md-nav__link">
<span class="md-ellipsis">
Edit Account
</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="#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>
</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>
+33 -33
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>
@@ -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,37 +1297,6 @@
<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">
Edit Account
</span>
</a>
</li>
<li class="md-nav__item">
@@ -1323,20 +1320,109 @@
<li class="md-nav__item">
<a href="../clients/" 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">
Edit Client
CLI
</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="#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>
</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>
+256 -32
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,6 +1353,19 @@
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Edit Client
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
@@ -1337,29 +1378,95 @@
</a>
</li>
<li class="md-nav__item">
<a href="../login/" class="md-nav__link">
<span class="md-ellipsis">
Login
</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>
File diff suppressed because it is too large Load Diff
+175 -33
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,29 +1364,6 @@
<li class="md-nav__item">
<a href="../login/" class="md-nav__link">
<span class="md-ellipsis">
Login
</span>
</a>
</li>
@@ -1369,6 +1374,19 @@
<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">
@@ -1381,6 +1399,65 @@
</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="#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>
</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>