Deployed 9fc6eba to Pre-release with MkDocs 1.6.1 and mike 2.1.3

This commit is contained in:
github-actions[bot]
2025-03-07 11:12:41 +00:00
parent f8c1469c92
commit fb9908760e
22 changed files with 12574 additions and 36 deletions
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
@@ -15,10 +15,10 @@
<link rel="canonical" href="https://wg-easy.github.io/wg-easy/Pre-release/examples/tutorials/basic-installation/">
<link rel="prev" href="../../../contributing/issues-and-pull-requests/">
<link rel="prev" href="../auto-updates/">
<link rel="next" href="../dockerless/">
<link rel="next" href="../caddy/">
<link rel="icon" href="../../../assets/logo/favicon.png">
@@ -304,7 +304,7 @@
<li class="md-tabs__item md-tabs__item--active">
<a href="./" class="md-tabs__link">
<a href="../adguard/" class="md-tabs__link">
Examples
@@ -564,7 +564,7 @@
<span class="md-ellipsis">
Migrate
Metrics
</span>
@@ -574,6 +574,77 @@
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_3">
<span class="md-nav__icon md-icon"></span>
Metrics
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../advanced/metrics/prometheus/" class="md-nav__link">
<span class="md-ellipsis">
Prometheus
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_4" >
<label class="md-nav__link" for="__nav_3_4" id="__nav_3_4_label" tabindex="0">
<span class="md-ellipsis">
Migrate
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_4">
<span class="md-nav__icon md-icon"></span>
Migrate
</label>
@@ -585,6 +656,28 @@
<li class="md-nav__item">
<a href="../../../advanced/migrate/" class="md-nav__link">
<span class="md-ellipsis">
Migrate
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../advanced/migrate/from-14-to-15/" class="md-nav__link">
@@ -797,6 +890,50 @@
<li class="md-nav__item">
<a href="../adguard/" class="md-nav__link">
<span class="md-ellipsis">
AdGuard Home
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../auto-updates/" class="md-nav__link">
<span class="md-ellipsis">
Auto Updates
</span>
</a>
</li>
@@ -895,6 +1032,24 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#update-wg-easy" class="md-nav__link">
<span class="md-ellipsis">
Update wg-easy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#auto-update" class="md-nav__link">
<span class="md-ellipsis">
Auto Update
</span>
</a>
</li>
</ul>
@@ -912,6 +1067,50 @@
<li class="md-nav__item">
<a href="../caddy/" class="md-nav__link">
<span class="md-ellipsis">
Caddy
</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="../dockerless/" class="md-nav__link">
@@ -934,6 +1133,28 @@
<li class="md-nav__item">
<a href="../nginx/" class="md-nav__link">
<span class="md-ellipsis">
NGINX
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../podman/" class="md-nav__link">
@@ -950,6 +1171,28 @@
<li class="md-nav__item">
<a href="../traefik/" class="md-nav__link">
<span class="md-ellipsis">
Traefik
</span>
</a>
</li>
</ul>
</nav>
@@ -1041,6 +1284,24 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#update-wg-easy" class="md-nav__link">
<span class="md-ellipsis">
Update wg-easy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#auto-update" class="md-nav__link">
<span class="md-ellipsis">
Auto Update
</span>
</a>
</li>
</ul>
@@ -1098,7 +1359,7 @@ sudo<span class="w"> </span>mkdir<span class="w"> </span>-p<span class="w"> </sp
<ol>
<li>Download docker compose file</li>
</ol>
<div class="highlight"><pre><span></span><code>sudo<span class="w"> </span>curl<span class="w"> </span>-o<span class="w"> </span><span class="nv">$URL</span>/docker-compose.yml<span class="w"> </span>https://raw.githubusercontent.com/wg-easy/wg-easy/master/docker-compose.yml
<div class="highlight"><pre><span></span><code>sudo<span class="w"> </span>curl<span class="w"> </span>-o<span class="w"> </span><span class="nv">$DIR</span>/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>
@@ -1117,6 +1378,13 @@ sudo<span class="w"> </span>mkdir<span class="w"> </span>-p<span class="w"> </sp
<h2 id="access-the-web-ui"><a class="toclink" href="#access-the-web-ui">Access the Web UI</a></h2>
<p>Open your browser and navigate to <code>https://&lt;your-domain&gt;:51821</code> or <code>https://&lt;your-ip&gt;:51821</code>.</p>
<p>Follow the instructions to set up your WireGuard VPN.</p>
<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>
<div class="highlight"><pre><span></span><code>sudo<span class="w"> </span>docker-compose<span class="w"> </span>-f<span class="w"> </span><span class="nv">$DIR</span>/docker-compose.yml<span class="w"> </span>pull
sudo<span class="w"> </span>docker-compose<span class="w"> </span>-f<span class="w"> </span><span class="nv">$DIR</span>/docker-compose.yml<span class="w"> </span>up<span class="w"> </span>-d
</code></pre></div>
<h2 id="auto-update"><a class="toclink" href="#auto-update">Auto Update</a></h2>
<p>If you want to enable auto-updates, follow the instructions here: <a href="../auto-updates/">Auto Updates</a></p>
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
@@ -15,10 +15,10 @@
<link rel="canonical" href="https://wg-easy.github.io/wg-easy/Pre-release/examples/tutorials/dockerless/">
<link rel="prev" href="../basic-installation/">
<link rel="prev" href="../docker-run/">
<link rel="next" href="../podman/">
<link rel="next" href="../nginx/">
<link rel="icon" href="../../../assets/logo/favicon.png">
@@ -299,7 +299,7 @@
<li class="md-tabs__item md-tabs__item--active">
<a href="../basic-installation/" class="md-tabs__link">
<a href="../adguard/" class="md-tabs__link">
Examples
@@ -559,7 +559,7 @@
<span class="md-ellipsis">
Migrate
Metrics
</span>
@@ -569,6 +569,77 @@
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_3">
<span class="md-nav__icon md-icon"></span>
Metrics
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../advanced/metrics/prometheus/" class="md-nav__link">
<span class="md-ellipsis">
Prometheus
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_4" >
<label class="md-nav__link" for="__nav_3_4" id="__nav_3_4_label" tabindex="0">
<span class="md-ellipsis">
Migrate
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_4">
<span class="md-nav__icon md-icon"></span>
Migrate
</label>
@@ -580,6 +651,28 @@
<li class="md-nav__item">
<a href="../../../advanced/migrate/" class="md-nav__link">
<span class="md-ellipsis">
Migrate
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../advanced/migrate/from-14-to-15/" class="md-nav__link">
@@ -794,6 +887,50 @@
<li class="md-nav__item">
<a href="../adguard/" class="md-nav__link">
<span class="md-ellipsis">
AdGuard Home
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../auto-updates/" class="md-nav__link">
<span class="md-ellipsis">
Auto Updates
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../basic-installation/" class="md-nav__link">
@@ -814,6 +951,50 @@
<li class="md-nav__item">
<a href="../caddy/" class="md-nav__link">
<span class="md-ellipsis">
Caddy
</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>
@@ -846,6 +1027,28 @@
<li class="md-nav__item">
<a href="../nginx/" class="md-nav__link">
<span class="md-ellipsis">
NGINX
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../podman/" class="md-nav__link">
@@ -862,6 +1065,28 @@
<li class="md-nav__item">
<a href="../traefik/" class="md-nav__link">
<span class="md-ellipsis">
Traefik
</span>
</a>
</li>
</ul>
</nav>
File diff suppressed because it is too large Load Diff
@@ -15,9 +15,11 @@
<link rel="canonical" href="https://wg-easy.github.io/wg-easy/Pre-release/examples/tutorials/podman/">
<link rel="prev" href="../dockerless/">
<link rel="prev" href="../nginx/">
<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.7">
@@ -302,7 +304,7 @@
<li class="md-tabs__item md-tabs__item--active">
<a href="../basic-installation/" class="md-tabs__link">
<a href="../adguard/" class="md-tabs__link">
Examples
@@ -562,7 +564,7 @@
<span class="md-ellipsis">
Migrate
Metrics
</span>
@@ -572,6 +574,77 @@
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_3">
<span class="md-nav__icon md-icon"></span>
Metrics
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../advanced/metrics/prometheus/" class="md-nav__link">
<span class="md-ellipsis">
Prometheus
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_4" >
<label class="md-nav__link" for="__nav_3_4" id="__nav_3_4_label" tabindex="0">
<span class="md-ellipsis">
Migrate
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_4">
<span class="md-nav__icon md-icon"></span>
Migrate
</label>
@@ -583,6 +656,28 @@
<li class="md-nav__item">
<a href="../../../advanced/migrate/" class="md-nav__link">
<span class="md-ellipsis">
Migrate
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../advanced/migrate/from-14-to-15/" class="md-nav__link">
@@ -797,6 +892,50 @@
<li class="md-nav__item">
<a href="../adguard/" class="md-nav__link">
<span class="md-ellipsis">
AdGuard Home
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../auto-updates/" class="md-nav__link">
<span class="md-ellipsis">
Auto Updates
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../basic-installation/" class="md-nav__link">
@@ -819,6 +958,50 @@
<li class="md-nav__item">
<a href="../caddy/" class="md-nav__link">
<span class="md-ellipsis">
Caddy
</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="../dockerless/" class="md-nav__link">
@@ -839,6 +1022,28 @@
<li class="md-nav__item">
<a href="../nginx/" class="md-nav__link">
<span class="md-ellipsis">
NGINX
</span>
</a>
</li>
@@ -928,6 +1133,15 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#restart-the-container" class="md-nav__link">
<span class="md-ellipsis">
Restart the Container
</span>
</a>
</li>
</ul>
@@ -939,6 +1153,28 @@
<li class="md-nav__item">
<a href="../traefik/" class="md-nav__link">
<span class="md-ellipsis">
Traefik
</span>
</a>
</li>
</ul>
</nav>
@@ -1021,6 +1257,15 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#restart-the-container" class="md-nav__link">
<span class="md-ellipsis">
Restart the Container
</span>
</a>
</li>
</ul>
@@ -1068,15 +1313,22 @@
sudo<span class="w"> </span>mkdir<span class="w"> </span>-p<span class="w"> </span>/etc/containers/volumes/wg-easy
</code></pre></div>
<p>Create a file <code>/etc/containers/systemd/wg-easy/wg-easy.container</code> with the following content:</p>
<!-- ref: major version -->
<div class="highlight"><pre><span></span><code><span class="k">[Container]</span>
<span class="na">ContainerName</span><span class="o">=</span><span class="s">wg-easy</span>
<span class="na">Image</span><span class="o">=</span><span class="s">ghcr.io/wg-easy/wg-easy:latest</span>
<span class="na">Image</span><span class="o">=</span><span class="s">ghcr.io/wg-easy/wg-easy:15</span>
<span class="na">AutoUpdate</span><span class="o">=</span><span class="s">registry</span>
<span class="na">Volume</span><span class="o">=</span><span class="s">/etc/containers/volumes/wg-easy:/etc/wireguard:Z</span>
<span class="na">Network</span><span class="o">=</span><span class="s">wg-easy.network</span>
<span class="na">PublishPort</span><span class="o">=</span><span class="s">51820:51820/udp</span>
<span class="na">PublishPort</span><span class="o">=</span><span class="s">51821:51821/tcp</span>
<span class="c1"># this is used to allow access over HTTP</span>
<span class="c1"># remove this when using a reverse proxy</span>
<span class="na">Environment</span><span class="o">=</span><span class="s">INSECURE=true</span>
<span class="na">AddCapability</span><span class="o">=</span><span class="s">NET_ADMIN</span>
<span class="na">AddCapability</span><span class="o">=</span><span class="s">SYS_MODULE</span>
<span class="na">AddCapability</span><span class="o">=</span><span class="s">NET_RAW</span>
@@ -1120,6 +1372,11 @@ sudo<span class="w"> </span>systemctl<span class="w"> </span>start<span class="w
</ol>
<div class="highlight"><pre><span></span><code>nft<span class="w"> </span>delete<span class="w"> </span>table<span class="w"> </span>inet<span class="w"> </span>wg_table
</code></pre></div>
<p>If you don't have iptables loaded on your server, you could see many errors in the logs or in the UI. You can ignore them.</p>
<h2 id="restart-the-container"><a class="toclink" href="#restart-the-container">Restart the Container</a></h2>
<p>Restart the container to apply the new hooks:</p>
<div class="highlight"><pre><span></span><code>sudo<span class="w"> </span>systemctl<span class="w"> </span>restart<span class="w"> </span>wg-easy
</code></pre></div>
<!--
TODO: improve docs after better nftables support
TODO: fix accept web ui port
File diff suppressed because it is too large Load Diff