From f4d3608da7287cbdbdcb4fd55e56448f63159c2e Mon Sep 17 00:00:00 2001 From: Bernd Storath <32197462+kaaax0815@users.noreply.github.com> Date: Thu, 6 Mar 2025 08:15:18 +0100 Subject: [PATCH] Fix: Various (#1711) * fix docs * fix migration --- docs/content/advanced/migrate/from-14-to-15.md | 9 +++++++-- docs/content/index.md | 12 +++++++++--- docs/mkdocs.yml | 10 ++++++++-- src/server/api/setup/migrate.post.ts | 4 ++-- 4 files changed, 26 insertions(+), 9 deletions(-) diff --git a/docs/content/advanced/migrate/from-14-to-15.md b/docs/content/advanced/migrate/from-14-to-15.md index b471fa18..da9a0481 100644 --- a/docs/content/advanced/migrate/from-14-to-15.md +++ b/docs/content/advanced/migrate/from-14-to-15.md @@ -6,7 +6,9 @@ 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 @@ -38,10 +40,13 @@ docker-compose down ### Start new container -Follow the instructions in the [Getting Started](../../usage.md) or [Basic Installation](../../examples/tutorials/basic-installation.md) guide to start the new container. +Follow the instructions in the [Getting Started][docs-getting-started] or [Basic Installation][docs-examples] 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. +[docs-getting-started]: ../../getting-started.md +[docs-examples]: ../../examples/tutorials/basic-installation.md + ### Done You have now successfully migrated to `v15` of `wg-easy`. diff --git a/docs/content/index.md b/docs/content/index.md index 6d51bdf2..92532129 100644 --- a/docs/content/index.md +++ b/docs/content/index.md @@ -13,7 +13,7 @@ hide: 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. -[docs-tagging]: ./usage.md#tagging-convention +[docs-tagging]: ./getting-started.md#tagging-convention ## About @@ -23,9 +23,9 @@ This documentation provides you not only with the basic setup and configuration ### Getting Started -If you're new to wg-easy, make sure to read the [_Usage_ chapter][docs-usage] first. If you want to look at examples for Docker Run and Compose, we have an [_Examples_ page][docs-examples]. +If you're new to wg-easy, make sure to read the [_Getting Started_ chapter][docs-getting-started] first. If you want to look at examples for Docker Run and Compose, we have an [_Examples_ page][docs-examples]. -[docs-usage]: ./usage.md +[docs-getting-started]: ./getting-started.md [docs-examples]: ./examples/tutorials/basic-installation.md ### Contributing @@ -33,3 +33,9 @@ If you're new to wg-easy, make sure to read the [_Usage_ chapter][docs-usage] fi We are always happy to welcome new contributors. For guidelines and entrypoints please have a look at the [Contributing section][docs-contributing]. [docs-contributing]: ./contributing/issues-and-pull-requests.md + +### Migration + +If you are migrating from an older version of `wg-easy`, please read the [_Migration_ chapter][docs-migration]. + +[docs-migration]: ./advanced/migrate/from-14-to-15.md diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 2e0f888c..1050003e 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -1,7 +1,13 @@ site_name: "wg-easy" site_description: "The easiest way to run WireGuard VPN + Web-based Admin UI." -site_author: "wg-easy (Github Organization)" -copyright: '
© 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
+