<p>To be able to connect to wg-easy if AmneziaWG is enabled, you must have an AmneziaWG-compatible client. Currently, only WG Tunnel and Amnezia VPN supports AmneziaWG 1.5/2.0! AmneziaWG clients require building from source code.</p>
<p>To be able to connect to wg-easy if AmneziaWG is enabled, you must have an AmneziaWG-compatible client. Where an AmneziaWG app is available for your platform, it is recommended to use it rather than Amnezia VPN.</p>
<p>Android:</p>
<ul>
<li><ahref="https://play.google.com/store/apps/details?id=org.amnezia.vpn">Amnezia VPN</a> - Amnezia VPN Official Client</li>
<li><ahref="https://play.google.com/store/apps/details?id=org.amnezia.awg">AmneziaWG</a> - AmneziaWG Official Client</li>
<li><ahref="https://play.google.com/store/apps/details?id=com.zaneschepke.wireguardautotunnel">WG Tunnel</a> - Third Party Client</li>
<li><ahref="https://play.google.com/store/apps/details?id=org.amnezia.vpn">Amnezia VPN</a> - Amnezia VPN Official Client</li>
</ul>
<p>iOS and macOS:</p>
<ul>
<li><ahref="https://apps.apple.com/us/app/amneziavpn/id1600529900">Amnezia VPN</a> - Amnezia VPN Official Client</li>
<li><ahref="https://apps.apple.com/us/app/amneziawg/id6478942365">AmneziaWG</a> - AmneziaWG Official Client</li>
<li><ahref="https://apps.apple.com/us/app/amneziavpn/id1600529900">Amnezia VPN</a> - Amnezia VPN Official Client</li>
</ul>
<p>Windows:</p>
<ul>
<li><ahref="https://github.com/amnezia-vpn/amneziawg-windows-client/releases">AmneziaWG</a> - AmneziaWG Official Client (Requires building from source code)</li>
<li><ahref="https://amnezia.org/downloads">Amnezia VPN</a> - Amnezia VPN Official Client</li>
<li><ahref="https://github.com/amnezia-vpn/amneziawg-windows-client/releases">AmneziaWG</a> - AmneziaWG Official Client</li>
<td>used for development, testing code from PRs</td>
</tr>
<tr>
<td><code>latest</code></td>
<td>latest tag</td>
<td><code>ghcr.io/wg-easy/wg-easy:latest</code> or <code>ghcr.io/wg-easy/wg-easy</code></td>
<td>points to the v14 release, should be avoided</td>
</tr>
</tbody>
</table>
<!-- ref: major version (check links too) -->
<p>When publishing a tag we follow the <ahref="https://semver.org/">Semantic Versioning</a> specification. The <code>latest</code> tag is always pointing to the latest stable release. If you want to avoid breaking changes, use the major version tag (e.g. <code>15</code>).</p>
<p>When publishing a tag we follow the <ahref="https://semver.org/">Semantic Versioning</a> specification. Pin to the latest major version to avoid breaking changes (e.g.<code>15</code>), avoid using the<code>latest</code> tag.</p>
<h1id="welcome-to-the-documentation-for-wg-easy"><aclass="toclink"href="#welcome-to-the-documentation-for-wg-easy">Welcome to the Documentation for <code>wg-easy</code></a></h1>
<divclass="admonition info">
<pclass="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 - <ahref="getting-started/#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 <ahref="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 <code>wg-easy</code> but also with advanced configuration, elaborate usage scenarios, detailed examples, hints and more.</p>
github-actions[bot]
4 months ago