From f8c1469c926ff6e0149c369c895e387249fc9795 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Fri, 7 Mar 2025 08:45:20 +0000 Subject: [PATCH] Deployed e5fb6ff to development with MkDocs 1.6.1 and mike 2.1.3 --- development/404.html | 5 +-- development/advanced/api/index.html | 5 +-- .../config/optional-config/index.html | 5 +-- .../advanced/migrate/from-14-to-15/index.html | 13 +++++--- development/contributing/general/index.html | 5 +-- .../issues-and-pull-requests/index.html | 5 +-- .../tutorials/basic-installation/index.html | 5 +-- .../examples/tutorials/dockerless/index.html | 5 +-- .../examples/tutorials/podman/index.html | 5 +-- development/getting-started/index.html | 5 +-- development/index.html | 29 +++++++++++++++--- development/search/search_index.json | 2 +- development/sitemap.xml | 20 ++++++------ development/sitemap.xml.gz | Bin 333 -> 333 bytes 14 files changed, 72 insertions(+), 37 deletions(-) diff --git a/development/404.html b/development/404.html index 271a6ea4..8da7b1f5 100644 --- a/development/404.html +++ b/development/404.html @@ -9,7 +9,7 @@ - + @@ -908,7 +908,8 @@
-

© Wireguard Easy Organization
This project is licensed under the GNU Affero General Public License v3.0 or later.

+

© Wireguard Easy
This project is licensed under AGPL-3.0-only.
This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Jason A. Donenfeld, ZX2C4 or Edge Security
"WireGuard" and the "WireGuard" logo are registered trademarks of Jason A. Donenfeld

+
diff --git a/development/advanced/api/index.html b/development/advanced/api/index.html index 79a748a8..961b3607 100644 --- a/development/advanced/api/index.html +++ b/development/advanced/api/index.html @@ -9,7 +9,7 @@ - + @@ -964,7 +964,8 @@
-

© Wireguard Easy Organization
This project is licensed under the GNU Affero General Public License v3.0 or later.

+

© Wireguard Easy
This project is licensed under AGPL-3.0-only.
This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Jason A. Donenfeld, ZX2C4 or Edge Security
"WireGuard" and the "WireGuard" logo are registered trademarks of Jason A. Donenfeld

+
diff --git a/development/advanced/config/optional-config/index.html b/development/advanced/config/optional-config/index.html index cdc42684..3462ab99 100644 --- a/development/advanced/config/optional-config/index.html +++ b/development/advanced/config/optional-config/index.html @@ -9,7 +9,7 @@ - + @@ -964,7 +964,8 @@
-

© Wireguard Easy Organization
This project is licensed under the GNU Affero General Public License v3.0 or later.

+

© Wireguard Easy
This project is licensed under AGPL-3.0-only.
This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Jason A. Donenfeld, ZX2C4 or Edge Security
"WireGuard" and the "WireGuard" logo are registered trademarks of Jason A. Donenfeld

+
diff --git a/development/advanced/migrate/from-14-to-15/index.html b/development/advanced/migrate/from-14-to-15/index.html index 5775a747..bbbecb3d 100644 --- a/development/advanced/migrate/from-14-to-15/index.html +++ b/development/advanced/migrate/from-14-to-15/index.html @@ -9,7 +9,7 @@ - + @@ -1089,7 +1089,11 @@

This guide will help you migrate from v14 to version v15 of wg-easy.

Changes

-

This is a complete rewrite of the wg-easy project. Therefore the configuration files and the way you interact with the project have changed.

+
    +
  • This is a complete rewrite of the wg-easy project. Therefore the configuration files and the way you interact with the project have changed.
    • +
  • If you use armv6 or armv7, you can't migrate to v15 yet. We are working on it.
    • +
  • If you are connecting to the web ui via HTTP, you need to set the INSECURE environment variable to true in the new container.
    • +

Migration

Backup

Before you start the migration, make sure to backup your existing configuration files.

@@ -1107,7 +1111,7 @@ 
docker-compose down

Start new container

-

Follow the instructions in the Getting Started or Basic Installation guide to start the new container.

+

Follow the instructions in the Getting Started or Basic Installation guide to start the new container.

In the setup wizard, select that you already already have a configuration file and upload the wg0.json file you downloaded in the backup step.

Done

You have now successfully migrated to v15 of wg-easy.

@@ -1149,7 +1153,8 @@
-

© Wireguard Easy Organization
This project is licensed under the GNU Affero General Public License v3.0 or later.

+

© Wireguard Easy
This project is licensed under AGPL-3.0-only.
This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Jason A. Donenfeld, ZX2C4 or Edge Security
"WireGuard" and the "WireGuard" logo are registered trademarks of Jason A. Donenfeld

+
diff --git a/development/contributing/general/index.html b/development/contributing/general/index.html index 4f51f104..d8836c5e 100644 --- a/development/contributing/general/index.html +++ b/development/contributing/general/index.html @@ -9,7 +9,7 @@ - + @@ -1054,7 +1054,8 @@
-

© Wireguard Easy Organization
This project is licensed under the GNU Affero General Public License v3.0 or later.

+

© Wireguard Easy
This project is licensed under AGPL-3.0-only.
This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Jason A. Donenfeld, ZX2C4 or Edge Security
"WireGuard" and the "WireGuard" logo are registered trademarks of Jason A. Donenfeld

+
diff --git a/development/contributing/issues-and-pull-requests/index.html b/development/contributing/issues-and-pull-requests/index.html index e318d4d3..c4c0671a 100644 --- a/development/contributing/issues-and-pull-requests/index.html +++ b/development/contributing/issues-and-pull-requests/index.html @@ -9,7 +9,7 @@ - + @@ -1134,7 +1134,8 @@
-

© Wireguard Easy Organization
This project is licensed under the GNU Affero General Public License v3.0 or later.

+

© Wireguard Easy
This project is licensed under AGPL-3.0-only.
This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Jason A. Donenfeld, ZX2C4 or Edge Security
"WireGuard" and the "WireGuard" logo are registered trademarks of Jason A. Donenfeld

+
diff --git a/development/examples/tutorials/basic-installation/index.html b/development/examples/tutorials/basic-installation/index.html index 702bbda3..50e67866 100644 --- a/development/examples/tutorials/basic-installation/index.html +++ b/development/examples/tutorials/basic-installation/index.html @@ -9,7 +9,7 @@ - + @@ -1155,7 +1155,8 @@ sudo mkdir -p
-

© Wireguard Easy Organization
This project is licensed under the GNU Affero General Public License v3.0 or later.

+

© Wireguard Easy
This project is licensed under AGPL-3.0-only.
This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Jason A. Donenfeld, ZX2C4 or Edge Security
"WireGuard" and the "WireGuard" logo are registered trademarks of Jason A. Donenfeld

+
diff --git a/development/examples/tutorials/dockerless/index.html b/development/examples/tutorials/dockerless/index.html index cb0ffe6d..3299410a 100644 --- a/development/examples/tutorials/dockerless/index.html +++ b/development/examples/tutorials/dockerless/index.html @@ -9,7 +9,7 @@ - + @@ -966,7 +966,8 @@
-

© Wireguard Easy Organization
This project is licensed under the GNU Affero General Public License v3.0 or later.

+

© Wireguard Easy
This project is licensed under AGPL-3.0-only.
This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Jason A. Donenfeld, ZX2C4 or Edge Security
"WireGuard" and the "WireGuard" logo are registered trademarks of Jason A. Donenfeld

+
diff --git a/development/examples/tutorials/podman/index.html b/development/examples/tutorials/podman/index.html index fb1604f4..61eb0026 100644 --- a/development/examples/tutorials/podman/index.html +++ b/development/examples/tutorials/podman/index.html @@ -9,7 +9,7 @@ - + @@ -1162,7 +1162,8 @@ TODO: fix accept web ui port
-

© Wireguard Easy Organization
This project is licensed under the GNU Affero General Public License v3.0 or later.

+

© Wireguard Easy
This project is licensed under AGPL-3.0-only.
This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Jason A. Donenfeld, ZX2C4 or Edge Security
"WireGuard" and the "WireGuard" logo are registered trademarks of Jason A. Donenfeld

+
diff --git a/development/getting-started/index.html b/development/getting-started/index.html index 4cb6cba0..86949221 100644 --- a/development/getting-started/index.html +++ b/development/getting-started/index.html @@ -9,7 +9,7 @@ - + @@ -1242,7 +1242,8 @@ If you're using podman, make sure to read the related
-

© Wireguard Easy Organization
This project is licensed under the GNU Affero General Public License v3.0 or later.

+

© Wireguard Easy
This project is licensed under AGPL-3.0-only.
This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Jason A. Donenfeld, ZX2C4 or Edge Security
"WireGuard" and the "WireGuard" logo are registered trademarks of Jason A. Donenfeld

+
diff --git a/development/index.html b/development/index.html index e6539081..32778727 100644 --- a/development/index.html +++ b/development/index.html @@ -9,7 +9,7 @@ - + @@ -449,6 +449,15 @@ + + +
  • + + + Migration + + +
    • @@ -1015,6 +1024,15 @@ + + +
  • + + + Migration + + +
    • @@ -1059,16 +1077,18 @@

    Welcome to the Documentation for wg-easy

     This Documentation is Versioned

    -

    Make sure 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 :latest image tag - the most recent stable release.

    +

    Make sure 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 :latest image tag - the most recent stable release.

    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.

    About

    wg-easy is the easiest way to run WireGuard VPN + Web-based Admin UI.

    Contents

    Getting Started

    -

    If you're new to wg-easy, make sure to read the Usage chapter first. If you want to look at examples for Docker Run and Compose, we have an Examples page.

    +

    If you're new to wg-easy, make sure to read the Getting Started chapter first. If you want to look at examples for Docker Run and Compose, we have an Examples page.

    Contributing

    We are always happy to welcome new contributors. For guidelines and entrypoints please have a look at the Contributing section.

    +

    Migration

    +

    If you are migrating from an older version of wg-easy, please read the Migration chapter.

    @@ -1109,7 +1129,8 @@
    -

    © Wireguard Easy Organization
    This project is licensed under the GNU Affero General Public License v3.0 or later.

    +

    © Wireguard Easy
    This project is licensed under AGPL-3.0-only.
    This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Jason A. Donenfeld, ZX2C4 or Edge Security
    "WireGuard" and the "WireGuard" logo are registered trademarks of Jason A. Donenfeld

    +
    diff --git a/development/search/search_index.json b/development/search/search_index.json index b37f60e6..54fb4e73 100644 --- a/development/search/search_index.json +++ b/development/search/search_index.json @@ -1 +1 @@ -{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Welcome to the Documentation for wg-easy","text":"

    \u00a0This Documentation is Versioned

    Make sure 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 :latest image tag - the most recent stable release.

    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.

    "},{"location":"#about","title":"About","text":"

    wg-easy is the easiest way to run WireGuard VPN + Web-based Admin UI.

    "},{"location":"#contents","title":"Contents","text":""},{"location":"#getting-started","title":"Getting Started","text":"

    If you're new to wg-easy, make sure to read the Usage chapter first. If you want to look at examples for Docker Run and Compose, we have an Examples page.

    "},{"location":"#contributing","title":"Contributing","text":"

    We are always happy to welcome new contributors. For guidelines and entrypoints please have a look at the Contributing section.

    "},{"location":"getting-started/","title":"Getting Started","text":"

    This page explains how to get started with wg-easy. The guide uses Docker Compose as a reference. In our examples, we mount the named volume etc_wireguard to /etc/wireguard inside the container.

    "},{"location":"getting-started/#preliminary-steps","title":"Preliminary Steps","text":"

    Before you can get started with deploying your own VPN, there are some requirements to be met:

    1. You need to have a host that you can manage
    2. You need to have a domain name or a public IP address
    3. You need a supported architecture (x86_64, arm64)
    "},{"location":"getting-started/#host-setup","title":"Host Setup","text":"

    There are a few requirements for a suitable host system:

    1. You need to have a container runtime installed

    About the Container Runtime

    On the host, you need to have a suitable container runtime (like Docker or Podman) installed. We assume Docker Compose is installed. We have aligned file names and configuration conventions with the latest Docker Compose specification. If you're using podman, make sure to read the related documentation.

    "},{"location":"getting-started/#deploying-the-actual-image","title":"Deploying the Actual Image","text":""},{"location":"getting-started/#tagging-convention","title":"Tagging Convention","text":"

    To understand which tags you should use, read this section carefully. Our CI will automatically build, test and push new images to the following container registry:

    1. GitHub Container Registry (ghcr.io/wg-easy/wg-easy)

    All workflows are using the tagging convention listed below. It is subsequently applied to all images.

    Event Image Tags cron on master nightly push a tag (v1.2.3) 1.2.3, 1.2, 1, latest

    When publishing a tag we follow the Semantic Versioning specification. The latest tag is always pointing to the latest stable release. If you want to avoid breaking changes, use the major version tag (e.g. 15).

    "},{"location":"getting-started/#get-all-files","title":"Get All Files","text":"

    Issue the following command to acquire the necessary file:

    wget \"https://raw.githubusercontent.com/wg-easy/wg-easy/master/docker-compose.yml\"\n
    "},{"location":"getting-started/#start-the-container","title":"Start the Container","text":"

    To start the container, issue the following command:

    sudo docker compose up -d\n
    "},{"location":"getting-started/#configuration-steps","title":"Configuration Steps","text":"

    Now follow the setup process in your web browser

    "},{"location":"getting-started/#stopping-the-container","title":"Stopping the Container","text":"

    To stop the container, issue the following command:

    sudo docker compose down\n

    Using the Correct Commands For Stopping and Starting wg-easy

    Use sudo docker compose up / down, not sudo docker compose start / stop. Otherwise, the container is not properly destroyed and you may experience problems during startup because of inconsistent state.

    That's it! It really is that easy.

    If you need more help you can read the Basic Installation Tutorial.

    "},{"location":"advanced/api/","title":"API","text":"

    TODO

    "},{"location":"advanced/config/optional-config/","title":"Optional Configuration","text":"

    TODO

    "},{"location":"advanced/migrate/from-14-to-15/","title":"Migrate from v14 to v15","text":"

    This guide will help you migrate from v14 to version v15 of wg-easy.

    "},{"location":"advanced/migrate/from-14-to-15/#changes","title":"Changes","text":"

    This is a complete rewrite of the wg-easy project. Therefore the configuration files and the way you interact with the project have changed.

    "},{"location":"advanced/migrate/from-14-to-15/#migration","title":"Migration","text":""},{"location":"advanced/migrate/from-14-to-15/#backup","title":"Backup","text":"

    Before you start the migration, make sure to backup your existing configuration files.

    Go into the Web Ui and click the Backup button, this should download a wg0.json file.

    Or download the wg0.json file from your container volume to your pc.

    You will need this file for the migration

    "},{"location":"advanced/migrate/from-14-to-15/#remove-old-container","title":"Remove old container","text":"
    1. Stop the running container

    If you are using docker run

    docker stop wg-easy\n

    If you are using docker-compose

    docker-compose down\n
    "},{"location":"advanced/migrate/from-14-to-15/#start-new-container","title":"Start new container","text":"

    Follow the instructions in the Getting Started or Basic Installation guide to start the new container.

    In the setup wizard, select that you already already have a configuration file and upload the wg0.json file you downloaded in the backup step.

    "},{"location":"advanced/migrate/from-14-to-15/#done","title":"Done","text":"

    You have now successfully migrated to v15 of wg-easy.

    "},{"location":"contributing/general/","title":"General Information","text":""},{"location":"contributing/general/#coding-style","title":"Coding Style","text":"

    When refactoring, writing or altering files, adhere to these rules:

    1. Adjust your style of coding to the style that is already present! Even if you do not like it, this is due to consistency. There was a lot of work involved in making all files consistent.
    2. Use pnpm lint to check your scripts! Your contributions are checked by GitHub Actions too, so you will need to do this.
    3. Use the provided .vscode/settings.json file.
    "},{"location":"contributing/general/#documentation","title":"Documentation","text":"

    Make sure to select nightly in the dropdown menu at the top. Navigate to the page you would like to edit and click the edit button in the top right. This allows you to make changes and create a pull-request.

    Alternatively you can make the changes locally. For that you'll need to have Docker installed. Run

    pnpm docs:serve\n

    This serves the documentation on your local machine on port 8080. Each change will be hot-reloaded onto the page you view, just edit, save and look at the result.

    "},{"location":"contributing/issues-and-pull-requests/","title":"Issues and Pull Requests","text":"

    This project is Open Source. That means that you can contribute on enhancements, bug fixing or improving the documentation.

    "},{"location":"contributing/issues-and-pull-requests/#opening-an-issue","title":"Opening an Issue","text":"

    Attention

    Before opening an issue, read the README carefully, study the docs for your version (maybe latest) and your search engine you trust. The issue tracker is not meant to be used for unrelated questions!

    When opening an issue, please provide details use case to let the community reproduce your problem.

    Attention

    Use the issue templates to provide the necessary information. Issues which do not use these templates are not worked on and closed.

    By raising issues, I agree to these terms and I understand, that the rules set for the issue tracker will help both maintainers as well as everyone to find a solution.

    Maintainers take the time to improve on this project and help by solving issues together. It is therefore expected from others to make an effort and comply with the rules.

    "},{"location":"contributing/issues-and-pull-requests/#filing-a-bug-report","title":"Filing a Bug Report","text":"

    Thank you for participating in this project and reporting a bug. wg-easy is a community-driven project, and each contribution counts!

    Maintainers and moderators are volunteers. We greatly appreciate reports that take the time to provide detailed information via the template, enabling us to help you in the best and quickest way. Ignoring the template provided may seem easier, but discourages receiving any support (via assignment of the label meta/no template - no support).

    Markdown formatting can be used in almost all text fields (unless stated otherwise in the description).

    Be as precise as possible, and if in doubt, it's best to add more information that too few.

    When an option is marked with \"not officially supported\" / \"unsupported\", then support is dependent on availability from specific maintainers.

    "},{"location":"contributing/issues-and-pull-requests/#pull-requests","title":"Pull Requests","text":"

    Motivation

    You want to add a feature? Feel free to start creating an issue explaining what you want to do and how you're thinking doing it. Other users may have the same need and collaboration may lead to better results.

    "},{"location":"contributing/issues-and-pull-requests/#submit-a-pull-request","title":"Submit a Pull-Request","text":"

    The development workflow is the following:

    1. Fork the project
    2. Write the code that is needed :D
    3. Document your improvements if necessary
    4. Commit (and sign your commit), push and create a pull-request to merge into master. Please use the pull-request template to provide a minimum of contextual information and make sure to meet the requirements of the checklist.

    Pull requests are automatically tested against the CI and will be reviewed when tests pass. When your changes are validated, your branch is merged. CI builds the new :nightly image every night and your changes will be includes in the next version release.

    "},{"location":"examples/tutorials/basic-installation/","title":"Basic Installation","text":""},{"location":"examples/tutorials/basic-installation/#requirements","title":"Requirements","text":"
    1. You need to have a host that you can manage
    2. You need to have a domain name or a public IP address
    3. You need a supported architecture (x86_64, arm64)
    4. You need curl installed on your host
    "},{"location":"examples/tutorials/basic-installation/#install-docker","title":"Install Docker","text":"

    Follow the Docs here: https://docs.docker.com/engine/install/ and install Docker on your host.

    "},{"location":"examples/tutorials/basic-installation/#install-wg-easy","title":"Install wg-easy","text":"
    1. Create a directory for the configuration files (you can choose any directory you like):
    DIR=/docker/wg-easy\nsudo mkdir -p $DIR\n
    1. Download docker compose file
    sudo curl -o $URL/docker-compose.yml https://raw.githubusercontent.com/wg-easy/wg-easy/master/docker-compose.yml\n
    1. Start wg-easy
     sudo docker-compose -f $DIR/docker-compose.yml up -d\n
    "},{"location":"examples/tutorials/basic-installation/#setup-firewall","title":"Setup Firewall","text":"

    If you are using a firewall, you need to open the following ports:

    • UDP 51820 (WireGuard)
    • TCP 51821 (Web UI)

    These ports can be changed, so if you change them you have to update your firewall rules accordingly.

    "},{"location":"examples/tutorials/basic-installation/#setup-reverse-proxy","title":"Setup Reverse Proxy","text":"

    TODO

    "},{"location":"examples/tutorials/basic-installation/#access-the-web-ui","title":"Access the Web UI","text":"

    Open your browser and navigate to https://<your-domain>:51821 or https://<your-ip>:51821.

    Follow the instructions to set up your WireGuard VPN.

    "},{"location":"examples/tutorials/dockerless/","title":"Without Docker","text":"

    TODO

    "},{"location":"examples/tutorials/podman/","title":"Podman","text":"

    This guide will show you how to run wg-easy with rootful Podman and nftables.

    "},{"location":"examples/tutorials/podman/#requirements","title":"Requirements","text":"
    1. Podman installed with version 4.4 or higher
    "},{"location":"examples/tutorials/podman/#configuration","title":"Configuration","text":"

    Create a Folder for the configuration files:

    sudo mkdir -p /etc/containers/systemd/wg-easy\nsudo mkdir -p /etc/containers/volumes/wg-easy\n

    Create a file /etc/containers/systemd/wg-easy/wg-easy.container with the following content:

    [Container]\nContainerName=wg-easy\nImage=ghcr.io/wg-easy/wg-easy:latest\n\nVolume=/etc/containers/volumes/wg-easy:/etc/wireguard:Z\nNetwork=wg-easy.network\nPublishPort=51820:51820/udp\nPublishPort=51821:51821/tcp\n\nAddCapability=NET_ADMIN\nAddCapability=SYS_MODULE\nAddCapability=NET_RAW\nSysctl=net.ipv4.ip_forward=1\nSysctl=net.ipv4.conf.all.src_valid_mark=1\nSysctl=net.ipv6.conf.all.disable_ipv6=0\nSysctl=net.ipv6.conf.all.forwarding=1\nSysctl=net.ipv6.conf.default.forwarding=1\n\n[Install]\n# this is used to start the container on boot\nWantedBy=default.target\n

    Create a file /etc/containers/systemd/wg-easy/wg-easy.network with the following content:

    [Network]\nNetworkName=wg-easy\nIPv6=true\n
    "},{"location":"examples/tutorials/podman/#load-kernel-modules","title":"Load Kernel Modules","text":"

    You will need to load the following kernel modules

    wireguard\nnft_masq\n

    Create a file /etc/modules-load.d/wg-easy.conf with the following content:

    wireguard\nnft_masq\n
    "},{"location":"examples/tutorials/podman/#start-the-container","title":"Start the Container","text":"
    sudo systemctl daemon-reload\nsudo systemctl start wg-easy\n
    "},{"location":"examples/tutorials/podman/#edit-hooks","title":"Edit Hooks","text":"

    In the Admin Panel of your WireGuard server, go to the Hooks tab and add the following hook:

    1. PostUp
    apk add nftables; nft add table inet wg_table; nft add chain inet wg_table postrouting { type nat hook postrouting priority 100 \\; }; nft add rule inet wg_table postrouting ip saddr {{ipv4Cidr}} oifname {{device}} masquerade; nft add rule inet wg_table postrouting ip6 saddr {{ipv6Cidr}} oifname {{device}} masquerade; nft add chain inet wg_table input { type filter hook input priority 0 \\; policy drop \\; }; nft add rule inet wg_table input udp dport {{port}} accept; nft add chain inet wg_table forward { type filter hook forward priority 0 \\; policy drop \\; }; nft add rule inet wg_table forward iifname \"wg0\" accept; nft add rule inet wg_table forward oifname \"wg0\" accept;\n
    1. PostDown
    nft delete table inet wg_table\n
    "}]} \ No newline at end of file +{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Welcome to the Documentation for wg-easy","text":"

    \u00a0This Documentation is Versioned

    Make sure 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 :latest image tag - the most recent stable release.

    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.

    "},{"location":"#about","title":"About","text":"

    wg-easy is the easiest way to run WireGuard VPN + Web-based Admin UI.

    "},{"location":"#contents","title":"Contents","text":""},{"location":"#getting-started","title":"Getting Started","text":"

    If you're new to wg-easy, make sure to read the Getting Started chapter first. If you want to look at examples for Docker Run and Compose, we have an Examples page.

    "},{"location":"#contributing","title":"Contributing","text":"

    We are always happy to welcome new contributors. For guidelines and entrypoints please have a look at the Contributing section.

    "},{"location":"#migration","title":"Migration","text":"

    If you are migrating from an older version of wg-easy, please read the Migration chapter.

    "},{"location":"getting-started/","title":"Getting Started","text":"

    This page explains how to get started with wg-easy. The guide uses Docker Compose as a reference. In our examples, we mount the named volume etc_wireguard to /etc/wireguard inside the container.

    "},{"location":"getting-started/#preliminary-steps","title":"Preliminary Steps","text":"

    Before you can get started with deploying your own VPN, there are some requirements to be met:

    1. You need to have a host that you can manage
    2. You need to have a domain name or a public IP address
    3. You need a supported architecture (x86_64, arm64)
    "},{"location":"getting-started/#host-setup","title":"Host Setup","text":"

    There are a few requirements for a suitable host system:

    1. You need to have a container runtime installed

    About the Container Runtime

    On the host, you need to have a suitable container runtime (like Docker or Podman) installed. We assume Docker Compose is installed. We have aligned file names and configuration conventions with the latest Docker Compose specification. If you're using podman, make sure to read the related documentation.

    "},{"location":"getting-started/#deploying-the-actual-image","title":"Deploying the Actual Image","text":""},{"location":"getting-started/#tagging-convention","title":"Tagging Convention","text":"

    To understand which tags you should use, read this section carefully. Our CI will automatically build, test and push new images to the following container registry:

    1. GitHub Container Registry (ghcr.io/wg-easy/wg-easy)

    All workflows are using the tagging convention listed below. It is subsequently applied to all images.

    Event Image Tags cron on master nightly push a tag (v1.2.3) 1.2.3, 1.2, 1, latest

    When publishing a tag we follow the Semantic Versioning specification. The latest tag is always pointing to the latest stable release. If you want to avoid breaking changes, use the major version tag (e.g. 15).

    "},{"location":"getting-started/#get-all-files","title":"Get All Files","text":"

    Issue the following command to acquire the necessary file:

    wget \"https://raw.githubusercontent.com/wg-easy/wg-easy/master/docker-compose.yml\"\n
    "},{"location":"getting-started/#start-the-container","title":"Start the Container","text":"

    To start the container, issue the following command:

    sudo docker compose up -d\n
    "},{"location":"getting-started/#configuration-steps","title":"Configuration Steps","text":"

    Now follow the setup process in your web browser

    "},{"location":"getting-started/#stopping-the-container","title":"Stopping the Container","text":"

    To stop the container, issue the following command:

    sudo docker compose down\n

    Using the Correct Commands For Stopping and Starting wg-easy

    Use sudo docker compose up / down, not sudo docker compose start / stop. Otherwise, the container is not properly destroyed and you may experience problems during startup because of inconsistent state.

    That's it! It really is that easy.

    If you need more help you can read the Basic Installation Tutorial.

    "},{"location":"advanced/api/","title":"API","text":"

    TODO

    "},{"location":"advanced/config/optional-config/","title":"Optional Configuration","text":"

    TODO

    "},{"location":"advanced/migrate/from-14-to-15/","title":"Migrate from v14 to v15","text":"

    This guide will help you migrate from v14 to version v15 of wg-easy.

    "},{"location":"advanced/migrate/from-14-to-15/#changes","title":"Changes","text":"
    • This is a complete rewrite of the wg-easy project. Therefore the configuration files and the way you interact with the project have changed.
    • If you use armv6 or armv7, you can't migrate to v15 yet. We are working on it.
    • If you are connecting to the web ui via HTTP, you need to set the INSECURE environment variable to true in the new container.
    "},{"location":"advanced/migrate/from-14-to-15/#migration","title":"Migration","text":""},{"location":"advanced/migrate/from-14-to-15/#backup","title":"Backup","text":"

    Before you start the migration, make sure to backup your existing configuration files.

    Go into the Web Ui and click the Backup button, this should download a wg0.json file.

    Or download the wg0.json file from your container volume to your pc.

    You will need this file for the migration

    "},{"location":"advanced/migrate/from-14-to-15/#remove-old-container","title":"Remove old container","text":"
    1. Stop the running container

    If you are using docker run

    docker stop wg-easy\n

    If you are using docker-compose

    docker-compose down\n
    "},{"location":"advanced/migrate/from-14-to-15/#start-new-container","title":"Start new container","text":"

    Follow the instructions in the Getting Started or Basic Installation guide to start the new container.

    In the setup wizard, select that you already already have a configuration file and upload the wg0.json file you downloaded in the backup step.

    "},{"location":"advanced/migrate/from-14-to-15/#done","title":"Done","text":"

    You have now successfully migrated to v15 of wg-easy.

    "},{"location":"contributing/general/","title":"General Information","text":""},{"location":"contributing/general/#coding-style","title":"Coding Style","text":"

    When refactoring, writing or altering files, adhere to these rules:

    1. Adjust your style of coding to the style that is already present! Even if you do not like it, this is due to consistency. There was a lot of work involved in making all files consistent.
    2. Use pnpm lint to check your scripts! Your contributions are checked by GitHub Actions too, so you will need to do this.
    3. Use the provided .vscode/settings.json file.
    "},{"location":"contributing/general/#documentation","title":"Documentation","text":"

    Make sure to select nightly in the dropdown menu at the top. Navigate to the page you would like to edit and click the edit button in the top right. This allows you to make changes and create a pull-request.

    Alternatively you can make the changes locally. For that you'll need to have Docker installed. Run

    pnpm docs:serve\n

    This serves the documentation on your local machine on port 8080. Each change will be hot-reloaded onto the page you view, just edit, save and look at the result.

    "},{"location":"contributing/issues-and-pull-requests/","title":"Issues and Pull Requests","text":"

    This project is Open Source. That means that you can contribute on enhancements, bug fixing or improving the documentation.

    "},{"location":"contributing/issues-and-pull-requests/#opening-an-issue","title":"Opening an Issue","text":"

    Attention

    Before opening an issue, read the README carefully, study the docs for your version (maybe latest) and your search engine you trust. The issue tracker is not meant to be used for unrelated questions!

    When opening an issue, please provide details use case to let the community reproduce your problem.

    Attention

    Use the issue templates to provide the necessary information. Issues which do not use these templates are not worked on and closed.

    By raising issues, I agree to these terms and I understand, that the rules set for the issue tracker will help both maintainers as well as everyone to find a solution.

    Maintainers take the time to improve on this project and help by solving issues together. It is therefore expected from others to make an effort and comply with the rules.

    "},{"location":"contributing/issues-and-pull-requests/#filing-a-bug-report","title":"Filing a Bug Report","text":"

    Thank you for participating in this project and reporting a bug. wg-easy is a community-driven project, and each contribution counts!

    Maintainers and moderators are volunteers. We greatly appreciate reports that take the time to provide detailed information via the template, enabling us to help you in the best and quickest way. Ignoring the template provided may seem easier, but discourages receiving any support (via assignment of the label meta/no template - no support).

    Markdown formatting can be used in almost all text fields (unless stated otherwise in the description).

    Be as precise as possible, and if in doubt, it's best to add more information that too few.

    When an option is marked with \"not officially supported\" / \"unsupported\", then support is dependent on availability from specific maintainers.

    "},{"location":"contributing/issues-and-pull-requests/#pull-requests","title":"Pull Requests","text":"

    Motivation

    You want to add a feature? Feel free to start creating an issue explaining what you want to do and how you're thinking doing it. Other users may have the same need and collaboration may lead to better results.

    "},{"location":"contributing/issues-and-pull-requests/#submit-a-pull-request","title":"Submit a Pull-Request","text":"

    The development workflow is the following:

    1. Fork the project
    2. Write the code that is needed :D
    3. Document your improvements if necessary
    4. Commit (and sign your commit), push and create a pull-request to merge into master. Please use the pull-request template to provide a minimum of contextual information and make sure to meet the requirements of the checklist.

    Pull requests are automatically tested against the CI and will be reviewed when tests pass. When your changes are validated, your branch is merged. CI builds the new :nightly image every night and your changes will be includes in the next version release.

    "},{"location":"examples/tutorials/basic-installation/","title":"Basic Installation","text":""},{"location":"examples/tutorials/basic-installation/#requirements","title":"Requirements","text":"
    1. You need to have a host that you can manage
    2. You need to have a domain name or a public IP address
    3. You need a supported architecture (x86_64, arm64)
    4. You need curl installed on your host
    "},{"location":"examples/tutorials/basic-installation/#install-docker","title":"Install Docker","text":"

    Follow the Docs here: https://docs.docker.com/engine/install/ and install Docker on your host.

    "},{"location":"examples/tutorials/basic-installation/#install-wg-easy","title":"Install wg-easy","text":"
    1. Create a directory for the configuration files (you can choose any directory you like):
    DIR=/docker/wg-easy\nsudo mkdir -p $DIR\n
    1. Download docker compose file
    sudo curl -o $URL/docker-compose.yml https://raw.githubusercontent.com/wg-easy/wg-easy/master/docker-compose.yml\n
    1. Start wg-easy
     sudo docker-compose -f $DIR/docker-compose.yml up -d\n
    "},{"location":"examples/tutorials/basic-installation/#setup-firewall","title":"Setup Firewall","text":"

    If you are using a firewall, you need to open the following ports:

    • UDP 51820 (WireGuard)
    • TCP 51821 (Web UI)

    These ports can be changed, so if you change them you have to update your firewall rules accordingly.

    "},{"location":"examples/tutorials/basic-installation/#setup-reverse-proxy","title":"Setup Reverse Proxy","text":"

    TODO

    "},{"location":"examples/tutorials/basic-installation/#access-the-web-ui","title":"Access the Web UI","text":"

    Open your browser and navigate to https://<your-domain>:51821 or https://<your-ip>:51821.

    Follow the instructions to set up your WireGuard VPN.

    "},{"location":"examples/tutorials/dockerless/","title":"Without Docker","text":"

    TODO

    "},{"location":"examples/tutorials/podman/","title":"Podman","text":"

    This guide will show you how to run wg-easy with rootful Podman and nftables.

    "},{"location":"examples/tutorials/podman/#requirements","title":"Requirements","text":"
    1. Podman installed with version 4.4 or higher
    "},{"location":"examples/tutorials/podman/#configuration","title":"Configuration","text":"

    Create a Folder for the configuration files:

    sudo mkdir -p /etc/containers/systemd/wg-easy\nsudo mkdir -p /etc/containers/volumes/wg-easy\n

    Create a file /etc/containers/systemd/wg-easy/wg-easy.container with the following content:

    [Container]\nContainerName=wg-easy\nImage=ghcr.io/wg-easy/wg-easy:latest\n\nVolume=/etc/containers/volumes/wg-easy:/etc/wireguard:Z\nNetwork=wg-easy.network\nPublishPort=51820:51820/udp\nPublishPort=51821:51821/tcp\n\nAddCapability=NET_ADMIN\nAddCapability=SYS_MODULE\nAddCapability=NET_RAW\nSysctl=net.ipv4.ip_forward=1\nSysctl=net.ipv4.conf.all.src_valid_mark=1\nSysctl=net.ipv6.conf.all.disable_ipv6=0\nSysctl=net.ipv6.conf.all.forwarding=1\nSysctl=net.ipv6.conf.default.forwarding=1\n\n[Install]\n# this is used to start the container on boot\nWantedBy=default.target\n

    Create a file /etc/containers/systemd/wg-easy/wg-easy.network with the following content:

    [Network]\nNetworkName=wg-easy\nIPv6=true\n
    "},{"location":"examples/tutorials/podman/#load-kernel-modules","title":"Load Kernel Modules","text":"

    You will need to load the following kernel modules

    wireguard\nnft_masq\n

    Create a file /etc/modules-load.d/wg-easy.conf with the following content:

    wireguard\nnft_masq\n
    "},{"location":"examples/tutorials/podman/#start-the-container","title":"Start the Container","text":"
    sudo systemctl daemon-reload\nsudo systemctl start wg-easy\n
    "},{"location":"examples/tutorials/podman/#edit-hooks","title":"Edit Hooks","text":"

    In the Admin Panel of your WireGuard server, go to the Hooks tab and add the following hook:

    1. PostUp
    apk add nftables; nft add table inet wg_table; nft add chain inet wg_table postrouting { type nat hook postrouting priority 100 \\; }; nft add rule inet wg_table postrouting ip saddr {{ipv4Cidr}} oifname {{device}} masquerade; nft add rule inet wg_table postrouting ip6 saddr {{ipv6Cidr}} oifname {{device}} masquerade; nft add chain inet wg_table input { type filter hook input priority 0 \\; policy drop \\; }; nft add rule inet wg_table input udp dport {{port}} accept; nft add chain inet wg_table forward { type filter hook forward priority 0 \\; policy drop \\; }; nft add rule inet wg_table forward iifname \"wg0\" accept; nft add rule inet wg_table forward oifname \"wg0\" accept;\n
    1. PostDown
    nft delete table inet wg_table\n
    "}]} \ No newline at end of file diff --git a/development/sitemap.xml b/development/sitemap.xml index 05cc78fa..5e14f0a1 100644 --- a/development/sitemap.xml +++ b/development/sitemap.xml @@ -2,42 +2,42 @@ https://wg-easy.github.io/wg-easy/development/ - 2025-03-05 + 2025-03-07 https://wg-easy.github.io/wg-easy/development/getting-started/ - 2025-03-05 + 2025-03-07 https://wg-easy.github.io/wg-easy/development/advanced/api/ - 2025-03-05 + 2025-03-07 https://wg-easy.github.io/wg-easy/development/advanced/config/optional-config/ - 2025-03-05 + 2025-03-07 https://wg-easy.github.io/wg-easy/development/advanced/migrate/from-14-to-15/ - 2025-03-05 + 2025-03-07 https://wg-easy.github.io/wg-easy/development/contributing/general/ - 2025-03-05 + 2025-03-07 https://wg-easy.github.io/wg-easy/development/contributing/issues-and-pull-requests/ - 2025-03-05 + 2025-03-07 https://wg-easy.github.io/wg-easy/development/examples/tutorials/basic-installation/ - 2025-03-05 + 2025-03-07 https://wg-easy.github.io/wg-easy/development/examples/tutorials/dockerless/ - 2025-03-05 + 2025-03-07 https://wg-easy.github.io/wg-easy/development/examples/tutorials/podman/ - 2025-03-05 + 2025-03-07 \ No newline at end of file diff --git a/development/sitemap.xml.gz b/development/sitemap.xml.gz index bf46b174996bd8a4ca6ef8a417f2274996fe3f52..293c4c696f857f166ba9f12deca2ec8e54251d1e 100644 GIT binary patch literal 333 zcmV-T0kZxdiwFn+H_B%M|8r?{Wo=<_E_iKh0L@j)Zo)7Syz>=N?v4{$)Q3X2^$Xe$ zSnS1E^{d_u(7&$(wCbG$@x|WJdUiA#%l+o$U3I`rHimWGHEmsCP*K}p*7e8xn|Q7_ z!=fLvBjl=GI~hV#B3y~eJMy@LD@Dh^{}YQng}kZ^Xgqx!^A=p zjS&d+-5AUJaogDVi%5+JbTN4hEPFZK`A-4FKI&oFE?1&`5baZGxnh@@@^9$v;|($w zPXsY!MtyHNpbrpK(E-WMMvIDJXN`=BOPIikYdsfv-kJ=Ia+jkQ-J{?ry4Aha6^}UE z?Kp+2ge+hNH!Dq+Xhaeav`C|KBI8%7neHtTPvDb7l00(E797bfkX6El@b`;n3qG{_2<3PqmyRJXp-_&!x z=^wf=dq$~BbL4fs7fG*LACJd|onU~(4P~o&*q4I!71V9>Quhy4SrftKbY7jOp`TcI zqOl5rzZ>ghKW-aGzlb(?Ku;-P6y53R&VLGE31s?ZyIiUEQMIema>Xt)_21Cj$6FLB zo+uW`g67_Gz#JeBMF%7|8!ZFHowJ&flrVu;*Lp7Ug0mR}^)6FTizg+d7OQ)!D;`O9 z+i?n430cGpepZ?s^N6e<8kI)xRmQJU3*TELo**QTtYs9+4m|5Eup5+%<&Am|QwV1$ f($MgUxnOg2Fp&vxgKOuld=&i;NywC=SOx$9)~lPr