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
+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>