theis.gaedigk/wg-easy-ca-lose
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Deployed e93342e to development with MkDocs 1.6.1 and mike 2.1.3

Browse Source
This commit is contained in:
github-actions[bot]
2025-06-11 09:12:59 +00:00
parent 43fb3e389b
commit c324cb2222
37 changed files with 17490 additions and 1084 deletions
Download Patch File Download Diff File Expand all files Collapse all files
development/examples/tutorials/basic-installation/index.html
+340 -79
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.8">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
@@ -30,7 +30,7 @@
<link rel="stylesheet" href="../../../assets/stylesheets/main.8608ea7d.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/main.342714a4.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
@@ -153,11 +153,13 @@
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
@@ -189,6 +191,7 @@
</div>
</div>
</div>
<div class="md-header__source">
@@ -221,10 +224,12 @@
<li class="md-tabs__item">
<a href="../../.." class="md-tabs__link">
Home
@@ -238,10 +243,31 @@
<li class="md-tabs__item">
<a href="../../../faq/" class="md-tabs__link">
FAQ
</a>
</li>
<li class="md-tabs__item">
<a href="../../../getting-started/" class="md-tabs__link">
Getting Started
@@ -255,12 +281,14 @@
<li class="md-tabs__item">
<a href="../../../advanced/api/" class="md-tabs__link">
Advanced
</a>
@@ -273,12 +301,14 @@
<li class="md-tabs__item">
<a href="../../../contributing/general/" class="md-tabs__link">
Contributing
</a>
@@ -290,6 +320,7 @@
@@ -298,6 +329,7 @@
@@ -307,6 +339,7 @@
<a href="../adguard/" class="md-tabs__link">
Examples
</a>
@@ -318,6 +351,26 @@
<li class="md-tabs__item">
<a href="../../../guides/2fa/" class="md-tabs__link">
Guides
</a>
</li>
</ul>
</div>
</nav>
@@ -372,6 +425,7 @@
<a href="../../.." class="md-nav__link">
<span class="md-ellipsis">
Home
@@ -389,10 +443,33 @@
<li class="md-nav__item">
<a href="../../../faq/" class="md-nav__link">
<span class="md-ellipsis">
FAQ
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../getting-started/" class="md-nav__link">
<span class="md-ellipsis">
Getting Started
@@ -413,6 +490,7 @@
@@ -423,12 +501,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis">
Advanced
@@ -438,8 +517,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Advanced
</label>
@@ -455,6 +534,7 @@
<a href="../../../advanced/api/" class="md-nav__link">
<span class="md-ellipsis">
API
@@ -476,6 +556,7 @@
@@ -486,12 +567,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4_2" >
<label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
<label class="md-nav__link" for="__nav_4_2" id="__nav_4_2_label" tabindex="0">
<span class="md-ellipsis">
Config
@@ -501,8 +583,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_2">
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_2">
<span class="md-nav__icon md-icon"></span>
Config
</label>
@@ -518,6 +600,7 @@
<a href="../../../advanced/config/optional-config/" class="md-nav__link">
<span class="md-ellipsis">
Optional Configuration
@@ -540,6 +623,7 @@
<a href="../../../advanced/config/unattended-setup/" class="md-nav__link">
<span class="md-ellipsis">
Unattended Setup
@@ -569,6 +653,7 @@
@@ -579,12 +664,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_3" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4_3" >
<label class="md-nav__link" for="__nav_3_3" id="__nav_3_3_label" tabindex="0">
<label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
<span class="md-ellipsis">
Metrics
@@ -594,8 +680,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<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">
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_3">
<span class="md-nav__icon md-icon"></span>
Metrics
</label>
@@ -611,6 +697,7 @@
<a href="../../../advanced/metrics/prometheus/" class="md-nav__link">
<span class="md-ellipsis">
Prometheus
@@ -640,6 +727,7 @@
@@ -650,12 +738,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_4" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4_4" >
<label class="md-nav__link" for="__nav_3_4" id="__nav_3_4_label" tabindex="0">
<label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
<span class="md-ellipsis">
Migrate
@@ -665,8 +754,8 @@
<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">
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_4">
<span class="md-nav__icon md-icon"></span>
Migrate
</label>
@@ -682,6 +771,7 @@
<a href="../../../advanced/migrate/" class="md-nav__link">
<span class="md-ellipsis">
Migrate
@@ -704,6 +794,7 @@
<a href="../../../advanced/migrate/from-14-to-15/" class="md-nav__link">
<span class="md-ellipsis">
Migrate from v14 to v15
@@ -740,6 +831,7 @@
@@ -750,12 +842,13 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<span class="md-ellipsis">
Contributing
@@ -765,8 +858,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Contributing
</label>
@@ -782,6 +875,7 @@
<a href="../../../contributing/general/" class="md-nav__link">
<span class="md-ellipsis">
General Information
@@ -804,6 +898,7 @@
<a href="../../../contributing/issues-and-pull-requests/" class="md-nav__link">
<span class="md-ellipsis">
Issues and Pull Requests
@@ -834,6 +929,7 @@
@@ -845,12 +941,13 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
<span class="md-ellipsis">
Examples
@@ -860,8 +957,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_5">
<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
</label>
@@ -878,6 +975,7 @@
@@ -886,12 +984,13 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_1" checked>
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" checked>
<label class="md-nav__link" for="__nav_5_1" id="__nav_5_1_label" tabindex="0">
<label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
<span class="md-ellipsis">
Tutorials
@@ -901,8 +1000,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_1_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_5_1">
<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
</label>
@@ -918,6 +1017,7 @@
<a href="../adguard/" class="md-nav__link">
<span class="md-ellipsis">
AdGuard Home
@@ -940,6 +1040,7 @@
<a href="../auto-updates/" class="md-nav__link">
<span class="md-ellipsis">
Auto Updates
@@ -969,6 +1070,7 @@
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Basic Installation
@@ -981,6 +1083,7 @@
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Basic Installation
@@ -1045,15 +1148,6 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#access-the-web-ui" class="md-nav__link">
<span class="md-ellipsis">
Access the Web UI
</span>
</a>
</li>
<li class="md-nav__item">
@@ -1093,6 +1187,7 @@
<a href="../caddy/" class="md-nav__link">
<span class="md-ellipsis">
Caddy
@@ -1115,6 +1210,7 @@
<a href="../docker-run/" class="md-nav__link">
<span class="md-ellipsis">
Docker Run
@@ -1137,6 +1233,7 @@
<a href="../dockerless/" class="md-nav__link">
<span class="md-ellipsis">
Without Docker
@@ -1156,11 +1253,12 @@
<li class="md-nav__item">
<a href="../nginx/" class="md-nav__link">
<a href="../podman-nft/" class="md-nav__link">
<span class="md-ellipsis">
NGINX
Podman + nftables
</span>
@@ -1178,11 +1276,12 @@
<li class="md-nav__item">
<a href="../podman/" class="md-nav__link">
<a href="../reverse-proxyless/" class="md-nav__link">
<span class="md-ellipsis">
Podman
No Reverse Proxy
</span>
@@ -1203,6 +1302,7 @@
<a href="../traefik/" class="md-nav__link">
<span class="md-ellipsis">
Traefik
@@ -1230,6 +1330,171 @@
<li class="md-nav__item md-nav__item--nested">
<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="0">
<span class="md-ellipsis">
Guides
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<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
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../guides/2fa/" class="md-nav__link">
<span class="md-ellipsis">
2FA
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/admin/" class="md-nav__link">
<span class="md-ellipsis">
Admin Panel
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/cli/" class="md-nav__link">
<span class="md-ellipsis">
CLI
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/clients/" class="md-nav__link">
<span class="md-ellipsis">
Edit Client
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/setup/" class="md-nav__link">
<span class="md-ellipsis">
Setup
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
@@ -1297,15 +1562,6 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#access-the-web-ui" class="md-nav__link">
<span class="md-ellipsis">
Access the Web UI
</span>
</a>
</li>
<li class="md-nav__item">
@@ -1366,44 +1622,47 @@
<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>
<div class="highlight"><pre><span></span><code><span class="nv">DIR</span><span class="o">=</span>/docker/wg-easy
sudo<span class="w"> </span>mkdir<span class="w"> </span>-p<span class="w"> </span><span class="nv">$DIR</span>
<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>
<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
</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>
<div class="highlight"><pre><span></span><code><span class="w"> </span>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
</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>
<li>UDP 51820 (WireGuard)</li>
<li>TCP 51821 (Web UI)</li>
</ul>
<p>These ports can be changed, so if you change them you have to update your firewall rules accordingly.</p>
<h2 id="setup-reverse-proxy"><a class="toclink" href="#setup-reverse-proxy">Setup Reverse Proxy</a></h2>
<p>TODO</p>
<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>
<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>
<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
<div class="highlight"><pre><span></span><code><span class="nb">cd</span><span class="w"> </span>/etc/docker/containers/wg-easy
sudo<span class="w"> </span>docker-compose<span class="w"> </span>pull
sudo<span class="w"> </span>docker-compose<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>
@@ -1467,10 +1726,12 @@ sudo<span class="w"> </span>docker-compose<span class="w"> </span>-f<span class=
</div>
<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", "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>