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 e5fb6ff to development with MkDocs 1.6.1 and mike 2.1.3

gh-pages
github-actions[bot] 4 weeks ago
parent
dfdca44938
commit
f8c1469c92
14 changed files with 72 additions and 37 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. 5
      development/404.html
  2. 5
      development/advanced/api/index.html
  3. 5
      development/advanced/config/optional-config/index.html
  4. 13
      development/advanced/migrate/from-14-to-15/index.html
  5. 5
      development/contributing/general/index.html
  6. 5
      development/contributing/issues-and-pull-requests/index.html
  7. 5
      development/examples/tutorials/basic-installation/index.html
  8. 5
      development/examples/tutorials/dockerless/index.html
  9. 5
      development/examples/tutorials/podman/index.html
  10. 5
      development/getting-started/index.html
  11. 29
      development/index.html
  12. 2
      development/search/search_index.json
  13. 20
      development/sitemap.xml
  14. BIN
      development/sitemap.xml.gz

5
development/404.html
View File

@ -9,7 +9,7 @@
<meta name="description" content="The easiest way to run WireGuard VPN + Web-based Admin UI.">
<meta name="author" content="wg-easy (Github Organization)">
<meta name="author" content="WireGuard Easy">
@ -908,7 +908,8 @@
<div class="md-copyright">
<div class="md-copyright__highlight">
<p>&copy <a href="https://github.com/wg-easy"><em>Wireguard Easy Organization</em></a><br/><span>This project is licensed under the GNU Affero General Public License v3.0 or later.</span></p>
<p> &copy <a href="https://github.com/wg-easy"><em>Wireguard Easy</em></a><br/> <span>This project is licensed under AGPL-3.0-only.</span><br/> <span>This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Jason A. Donenfeld, ZX2C4 or Edge Security</span><br/> <span>"WireGuard" and the "WireGuard" logo are registered trademarks of Jason A. Donenfeld</span> </p>
</div>

5
development/advanced/api/index.html
View File

@ -9,7 +9,7 @@
<meta name="description" content="The easiest way to run WireGuard VPN + Web-based Admin UI.">
<meta name="author" content="wg-easy (Github Organization)">
<meta name="author" content="WireGuard Easy">
<link rel="canonical" href="https://wg-easy.github.io/wg-easy/development/advanced/api/">
@ -964,7 +964,8 @@
<div class="md-copyright">
<div class="md-copyright__highlight">
<p>&copy <a href="https://github.com/wg-easy"><em>Wireguard Easy Organization</em></a><br/><span>This project is licensed under the GNU Affero General Public License v3.0 or later.</span></p>
<p> &copy <a href="https://github.com/wg-easy"><em>Wireguard Easy</em></a><br/> <span>This project is licensed under AGPL-3.0-only.</span><br/> <span>This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Jason A. Donenfeld, ZX2C4 or Edge Security</span><br/> <span>"WireGuard" and the "WireGuard" logo are registered trademarks of Jason A. Donenfeld</span> </p>
</div>

5
development/advanced/config/optional-config/index.html
View File

@ -9,7 +9,7 @@
<meta name="description" content="The easiest way to run WireGuard VPN + Web-based Admin UI.">
<meta name="author" content="wg-easy (Github Organization)">
<meta name="author" content="WireGuard Easy">
<link rel="canonical" href="https://wg-easy.github.io/wg-easy/development/advanced/config/optional-config/">
@ -964,7 +964,8 @@
<div class="md-copyright">
<div class="md-copyright__highlight">
<p>&copy <a href="https://github.com/wg-easy"><em>Wireguard Easy Organization</em></a><br/><span>This project is licensed under the GNU Affero General Public License v3.0 or later.</span></p>
<p> &copy <a href="https://github.com/wg-easy"><em>Wireguard Easy</em></a><br/> <span>This project is licensed under AGPL-3.0-only.</span><br/> <span>This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Jason A. Donenfeld, ZX2C4 or Edge Security</span><br/> <span>"WireGuard" and the "WireGuard" logo are registered trademarks of Jason A. Donenfeld</span> </p>
</div>

13
development/advanced/migrate/from-14-to-15/index.html
View File

@ -9,7 +9,7 @@
<meta name="description" content="The easiest way to run WireGuard VPN + Web-based Admin UI.">
<meta name="author" content="wg-easy (Github Organization)">
<meta name="author" content="WireGuard Easy">
<link rel="canonical" href="https://wg-easy.github.io/wg-easy/development/advanced/migrate/from-14-to-15/">
@ -1089,7 +1089,11 @@
<p>This guide will help you migrate from <code>v14</code> to version <code>v15</code> of <code>wg-easy</code>.</p>
<h2 id="changes"><a class="toclink" href="#changes">Changes</a></h2>
<p>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.</p>
<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 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>
<h3 id="backup"><a class="toclink" href="#backup">Backup</a></h3>
<p>Before you start the migration, make sure to backup your existing configuration files.</p>
@ -1107,7 +1111,7 @@
<div class="highlight"><pre><span></span><code>docker-compose<span class="w"> </span>down
</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="../../usage.md">Getting Started</a> or <a href="../../../examples/tutorials/basic-installation/">Basic Installation</a> guide to start the new container.</p>
<p>Follow the instructions in the <a href="../../../getting-started/">Getting Started</a> or <a href="../../../examples/tutorials/basic-installation/">Basic Installation</a> guide to start the new container.</p>
<p>In the setup wizard, select that you already already have a configuration file and upload the <code>wg0.json</code> file you downloaded in the backup step.</p>
<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>
@ -1149,7 +1153,8 @@
<div class="md-copyright">
<div class="md-copyright__highlight">
<p>&copy <a href="https://github.com/wg-easy"><em>Wireguard Easy Organization</em></a><br/><span>This project is licensed under the GNU Affero General Public License v3.0 or later.</span></p>
<p> &copy <a href="https://github.com/wg-easy"><em>Wireguard Easy</em></a><br/> <span>This project is licensed under AGPL-3.0-only.</span><br/> <span>This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Jason A. Donenfeld, ZX2C4 or Edge Security</span><br/> <span>"WireGuard" and the "WireGuard" logo are registered trademarks of Jason A. Donenfeld</span> </p>
</div>

5
development/contributing/general/index.html
View File

@ -9,7 +9,7 @@
<meta name="description" content="The easiest way to run WireGuard VPN + Web-based Admin UI.">
<meta name="author" content="wg-easy (Github Organization)">
<meta name="author" content="WireGuard Easy">
<link rel="canonical" href="https://wg-easy.github.io/wg-easy/development/contributing/general/">
@ -1054,7 +1054,8 @@
<div class="md-copyright">
<div class="md-copyright__highlight">
<p>&copy <a href="https://github.com/wg-easy"><em>Wireguard Easy Organization</em></a><br/><span>This project is licensed under the GNU Affero General Public License v3.0 or later.</span></p>
<p> &copy <a href="https://github.com/wg-easy"><em>Wireguard Easy</em></a><br/> <span>This project is licensed under AGPL-3.0-only.</span><br/> <span>This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Jason A. Donenfeld, ZX2C4 or Edge Security</span><br/> <span>"WireGuard" and the "WireGuard" logo are registered trademarks of Jason A. Donenfeld</span> </p>
</div>

5
development/contributing/issues-and-pull-requests/index.html
View File

@ -9,7 +9,7 @@
<meta name="description" content="The easiest way to run WireGuard VPN + Web-based Admin UI.">
<meta name="author" content="wg-easy (Github Organization)">
<meta name="author" content="WireGuard Easy">
<link rel="canonical" href="https://wg-easy.github.io/wg-easy/development/contributing/issues-and-pull-requests/">
@ -1134,7 +1134,8 @@
<div class="md-copyright">
<div class="md-copyright__highlight">
<p>&copy <a href="https://github.com/wg-easy"><em>Wireguard Easy Organization</em></a><br/><span>This project is licensed under the GNU Affero General Public License v3.0 or later.</span></p>
<p> &copy <a href="https://github.com/wg-easy"><em>Wireguard Easy</em></a><br/> <span>This project is licensed under AGPL-3.0-only.</span><br/> <span>This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Jason A. Donenfeld, ZX2C4 or Edge Security</span><br/> <span>"WireGuard" and the "WireGuard" logo are registered trademarks of Jason A. Donenfeld</span> </p>
</div>

5
development/examples/tutorials/basic-installation/index.html
View File

@ -9,7 +9,7 @@
<meta name="description" content="The easiest way to run WireGuard VPN + Web-based Admin UI.">
<meta name="author" content="wg-easy (Github Organization)">
<meta name="author" content="WireGuard Easy">
<link rel="canonical" href="https://wg-easy.github.io/wg-easy/development/examples/tutorials/basic-installation/">
@ -1155,7 +1155,8 @@ sudo<span class="w"> </span>mkdir<span class="w"> </span>-p<span class="w"> </sp
<div class="md-copyright">
<div class="md-copyright__highlight">
<p>&copy <a href="https://github.com/wg-easy"><em>Wireguard Easy Organization</em></a><br/><span>This project is licensed under the GNU Affero General Public License v3.0 or later.</span></p>
<p> &copy <a href="https://github.com/wg-easy"><em>Wireguard Easy</em></a><br/> <span>This project is licensed under AGPL-3.0-only.</span><br/> <span>This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Jason A. Donenfeld, ZX2C4 or Edge Security</span><br/> <span>"WireGuard" and the "WireGuard" logo are registered trademarks of Jason A. Donenfeld</span> </p>
</div>

5
development/examples/tutorials/dockerless/index.html
View File

@ -9,7 +9,7 @@
<meta name="description" content="The easiest way to run WireGuard VPN + Web-based Admin UI.">
<meta name="author" content="wg-easy (Github Organization)">
<meta name="author" content="WireGuard Easy">
<link rel="canonical" href="https://wg-easy.github.io/wg-easy/development/examples/tutorials/dockerless/">
@ -966,7 +966,8 @@
<div class="md-copyright">
<div class="md-copyright__highlight">
<p>&copy <a href="https://github.com/wg-easy"><em>Wireguard Easy Organization</em></a><br/><span>This project is licensed under the GNU Affero General Public License v3.0 or later.</span></p>
<p> &copy <a href="https://github.com/wg-easy"><em>Wireguard Easy</em></a><br/> <span>This project is licensed under AGPL-3.0-only.</span><br/> <span>This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Jason A. Donenfeld, ZX2C4 or Edge Security</span><br/> <span>"WireGuard" and the "WireGuard" logo are registered trademarks of Jason A. Donenfeld</span> </p>
</div>

5
development/examples/tutorials/podman/index.html
View File

@ -9,7 +9,7 @@
<meta name="description" content="The easiest way to run WireGuard VPN + Web-based Admin UI.">
<meta name="author" content="wg-easy (Github Organization)">
<meta name="author" content="WireGuard Easy">
<link rel="canonical" href="https://wg-easy.github.io/wg-easy/development/examples/tutorials/podman/">
@ -1162,7 +1162,8 @@ TODO: fix accept web ui port
<div class="md-copyright">
<div class="md-copyright__highlight">
<p>&copy <a href="https://github.com/wg-easy"><em>Wireguard Easy Organization</em></a><br/><span>This project is licensed under the GNU Affero General Public License v3.0 or later.</span></p>
<p> &copy <a href="https://github.com/wg-easy"><em>Wireguard Easy</em></a><br/> <span>This project is licensed under AGPL-3.0-only.</span><br/> <span>This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Jason A. Donenfeld, ZX2C4 or Edge Security</span><br/> <span>"WireGuard" and the "WireGuard" logo are registered trademarks of Jason A. Donenfeld</span> </p>
</div>

5
development/getting-started/index.html
View File

@ -9,7 +9,7 @@
<meta name="description" content="The easiest way to run WireGuard VPN + Web-based Admin UI.">
<meta name="author" content="wg-easy (Github Organization)">
<meta name="author" content="WireGuard Easy">
<link rel="canonical" href="https://wg-easy.github.io/wg-easy/development/getting-started/">
@ -1242,7 +1242,8 @@ If you're using podman, make sure to read the related <a href="../examples/tutor
<div class="md-copyright">
<div class="md-copyright__highlight">
<p>&copy <a href="https://github.com/wg-easy"><em>Wireguard Easy Organization</em></a><br/><span>This project is licensed under the GNU Affero General Public License v3.0 or later.</span></p>
<p> &copy <a href="https://github.com/wg-easy"><em>Wireguard Easy</em></a><br/> <span>This project is licensed under AGPL-3.0-only.</span><br/> <span>This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Jason A. Donenfeld, ZX2C4 or Edge Security</span><br/> <span>"WireGuard" and the "WireGuard" logo are registered trademarks of Jason A. Donenfeld</span> </p>
</div>

29
development/index.html
View File

@ -9,7 +9,7 @@
<meta name="description" content="The easiest way to run WireGuard VPN + Web-based Admin UI.">
<meta name="author" content="wg-easy (Github Organization)">
<meta name="author" content="WireGuard Easy">
<link rel="canonical" href="https://wg-easy.github.io/wg-easy/development/">
@ -449,6 +449,15 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#migration" class="md-nav__link">
<span class="md-ellipsis">
Migration
</span>
</a>
</li>
</ul>
@ -1015,6 +1024,15 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#migration" class="md-nav__link">
<span class="md-ellipsis">
Migration
</span>
</a>
</li>
</ul>
@ -1059,16 +1077,18 @@
<h1 id="welcome-to-the-documentation-for-wg-easy"><a class="toclink" href="#welcome-to-the-documentation-for-wg-easy">Welcome to the Documentation for <code>wg-easy</code></a></h1>
<div class="admonition info">
<p class="admonition-title"> This Documentation is Versioned</p>
<p><strong>Make sure</strong> to select the correct version of this documentation! It should match the version of the image you are using. The default version corresponds to the <code>:latest</code> image tag - <a href="./usage.md#tagging-convention">the most recent stable release</a>.</p>
<p><strong>Make sure</strong> to select the correct version of this documentation! It should match the version of the image you are using. The default version corresponds to the <code>:latest</code> image tag - <a href="getting-started/#tagging-convention">the most recent stable release</a>.</p>
</div>
<p>This documentation provides you not only with the basic setup and configuration of wg-easy but also with advanced configuration, elaborate usage scenarios, detailed examples, hints and more.</p>
<h2 id="about"><a class="toclink" href="#about">About</a></h2>
<p><code>wg-easy</code> is the easiest way to run WireGuard VPN + Web-based Admin UI.</p>
<h2 id="contents"><a class="toclink" href="#contents">Contents</a></h2>
<h3 id="getting-started"><a class="toclink" href="#getting-started">Getting Started</a></h3>
<p>If you're new to wg-easy, make sure to read the <a href="./usage.md"><em>Usage</em> chapter</a> first. If you want to look at examples for Docker Run and Compose, we have an <a href="examples/tutorials/basic-installation/"><em>Examples</em> page</a>.</p>
<p>If you're new to wg-easy, make sure to read the <a href="getting-started/"><em>Getting Started</em> chapter</a> first. If you want to look at examples for Docker Run and Compose, we have an <a href="examples/tutorials/basic-installation/"><em>Examples</em> page</a>.</p>
<h3 id="contributing"><a class="toclink" href="#contributing">Contributing</a></h3>
<p>We are always happy to welcome new contributors. For guidelines and entrypoints please have a look at the <a href="contributing/issues-and-pull-requests/">Contributing section</a>.</p>
<h3 id="migration"><a class="toclink" href="#migration">Migration</a></h3>
<p>If you are migrating from an older version of <code>wg-easy</code>, please read the <a href="advanced/migrate/from-14-to-15/"><em>Migration</em> chapter</a>.</p>
@ -1109,7 +1129,8 @@
<div class="md-copyright">
<div class="md-copyright__highlight">
<p>&copy <a href="https://github.com/wg-easy"><em>Wireguard Easy Organization</em></a><br/><span>This project is licensed under the GNU Affero General Public License v3.0 or later.</span></p>
<p> &copy <a href="https://github.com/wg-easy"><em>Wireguard Easy</em></a><br/> <span>This project is licensed under AGPL-3.0-only.</span><br/> <span>This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Jason A. Donenfeld, ZX2C4 or Edge Security</span><br/> <span>"WireGuard" and the "WireGuard" logo are registered trademarks of Jason A. Donenfeld</span> </p>
</div>

2
development/search/search_index.json
View File

File diff suppressed because one or more lines are too long

20
development/sitemap.xml
View File

@ -2,42 +2,42 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://wg-easy.github.io/wg-easy/development/</loc>
<lastmod>2025-03-05</lastmod>
<lastmod>2025-03-07</lastmod>
</url>
<url>
<loc>https://wg-easy.github.io/wg-easy/development/getting-started/</loc>
<lastmod>2025-03-05</lastmod>
<lastmod>2025-03-07</lastmod>
</url>
<url>
<loc>https://wg-easy.github.io/wg-easy/development/advanced/api/</loc>
<lastmod>2025-03-05</lastmod>
<lastmod>2025-03-07</lastmod>
</url>
<url>
<loc>https://wg-easy.github.io/wg-easy/development/advanced/config/optional-config/</loc>
<lastmod>2025-03-05</lastmod>
<lastmod>2025-03-07</lastmod>
</url>
<url>
<loc>https://wg-easy.github.io/wg-easy/development/advanced/migrate/from-14-to-15/</loc>
<lastmod>2025-03-05</lastmod>
<lastmod>2025-03-07</lastmod>
</url>
<url>
<loc>https://wg-easy.github.io/wg-easy/development/contributing/general/</loc>
<lastmod>2025-03-05</lastmod>
<lastmod>2025-03-07</lastmod>
</url>
<url>
<loc>https://wg-easy.github.io/wg-easy/development/contributing/issues-and-pull-requests/</loc>
<lastmod>2025-03-05</lastmod>
<lastmod>2025-03-07</lastmod>
</url>
<url>
<loc>https://wg-easy.github.io/wg-easy/development/examples/tutorials/basic-installation/</loc>
<lastmod>2025-03-05</lastmod>
<lastmod>2025-03-07</lastmod>
</url>
<url>
<loc>https://wg-easy.github.io/wg-easy/development/examples/tutorials/dockerless/</loc>
<lastmod>2025-03-05</lastmod>
<lastmod>2025-03-07</lastmod>
</url>
<url>
<loc>https://wg-easy.github.io/wg-easy/development/examples/tutorials/podman/</loc>
<lastmod>2025-03-05</lastmod>
<lastmod>2025-03-07</lastmod>
</url>
</urlset>

BIN
development/sitemap.xml.gz
View File

Binary file not shown.
Write Preview
Loading…
Cancel
Save