Compare commits

...

2 Commits

Author SHA1 Message Date
Bernd Storath f4d3608da7 Fix: Various (#1711)
* fix docs

* fix migration
2025-03-06 08:15:18 +01:00
Bernd Storath 84ee8c35f0 fix labels, date field, enable 2025-03-05 15:38:09 +01:00
10 changed files with 57 additions and 33 deletions
-2
View File
@@ -2,8 +2,6 @@
name: 🐛 Bug Report name: 🐛 Bug Report
description: Create a report to help us improve description: Create a report to help us improve
title: "[Bug]: " title: "[Bug]: "
labels:
- "type: bug"
type: Bug type: Bug
body: body:
@@ -6,7 +6,9 @@ This guide will help you migrate from `v14` to version `v15` of `wg-easy`.
## Changes ## 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 ## Migration
@@ -38,10 +40,13 @@ docker-compose down
### Start new container ### 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. 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 ### Done
You have now successfully migrated to `v15` of `wg-easy`. You have now successfully migrated to `v15` of `wg-easy`.
+9 -3
View File
@@ -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. 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 ## About
@@ -23,9 +23,9 @@ This documentation provides you not only with the basic setup and configuration
### Getting Started ### 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 [docs-examples]: ./examples/tutorials/basic-installation.md
### Contributing ### 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]. 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 [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
+8 -2
View File
@@ -1,7 +1,13 @@
site_name: "wg-easy" site_name: "wg-easy"
site_description: "The easiest way to run WireGuard VPN + Web-based Admin UI." site_description: "The easiest way to run WireGuard VPN + Web-based Admin UI."
site_author: "wg-easy (Github Organization)" site_author: "WireGuard Easy"
copyright: '<p>&copy <a href="https://github.com/wg-easy"><em>Wireguard Easy Organization</em></a><br/><span>This project is licensed under the GNU Affero General Public License v3.0 or later.</span></p>' copyright: >
<p>
&copy <a href="https://github.com/wg-easy"><em>Wireguard Easy</em></a><br/>
<span>This project is licensed under AGPL-3.0-only.</span><br/>
<span>This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Jason A. Donenfeld, ZX2C4 or Edge Security</span><br/>
<span>"WireGuard" and the "WireGuard" logo are registered trademarks of Jason A. Donenfeld</span>
</p>
repo_url: https://github.com/wg-easy/wg-easy repo_url: https://github.com/wg-easy/wg-easy
repo_name: wg-easy repo_name: wg-easy
+28 -9
View File
@@ -7,19 +7,38 @@
<IconsInfo class="size-4" /> <IconsInfo class="size-4" />
</BaseTooltip> </BaseTooltip>
</div> </div>
<BaseInput :id="id" v-model="data" :name="id" type="date" /> <BaseInput
:id="id"
:model-value="formattedDate"
:name="id"
type="date"
max="9999-12-31"
@update:model-value="updateDate"
/>
</template> </template>
<script lang="ts" setup> <script lang="ts" setup>
defineProps<{ id: string; label: string; description?: string }>(); defineProps<{ id: string; label: string; description?: string }>();
const data = defineModel<string | null>({ const data = defineModel<string | null>();
set(value) {
const temp = value?.trim() ?? null; const date = ref(data);
if (temp === '') {
return null; const formattedDate = computed(() => {
} return date.value ? date.value.split('T')[0] : '';
return temp;
},
}); });
const updateDate = (value: unknown) => {
if (typeof value !== 'string' && value !== null) {
return;
}
const temp = value?.trim() ?? null;
if (temp === '' || temp === null) {
date.value = null;
} else {
date.value = new Date(temp).toISOString();
}
};
</script> </script>
@@ -12,7 +12,7 @@ export default definePermissionEventHandler(
const client = await Database.clients.get(clientId); const client = await Database.clients.get(clientId);
checkPermissions(client); checkPermissions(client);
await Database.clients.toggle(clientId, false); await Database.clients.toggle(clientId, true);
await WireGuard.saveConfig(); await WireGuard.saveConfig();
return { success: true }; return { success: true };
} }
+2 -2
View File
@@ -18,8 +18,8 @@ export default defineSetupEventHandler('migrate', async ({ event }) => {
clients: z.record( clients: z.record(
z.string(), z.string(),
z.object({ z.object({
// not used // not used, breaks compatibility with older versions
id: z.string(), id: z.string().optional(),
name: z.string(), name: z.string(),
address: z.string(), address: z.string(),
privateKey: z.string(), privateKey: z.string(),
@@ -75,15 +75,6 @@ export class ClientService {
const publicKey = await wg.getPublicKey(privateKey); const publicKey = await wg.getPublicKey(privateKey);
const preSharedKey = await wg.generatePreSharedKey(); const preSharedKey = await wg.generatePreSharedKey();
let parsedExpiresAt = expiresAt;
if (parsedExpiresAt) {
const expiresAtDate = new Date(parsedExpiresAt);
expiresAtDate.setHours(23);
expiresAtDate.setMinutes(59);
expiresAtDate.setSeconds(59);
parsedExpiresAt = expiresAtDate.toISOString();
}
return this.#db.transaction(async (tx) => { return this.#db.transaction(async (tx) => {
const clients = await tx.query.client.findMany().execute(); const clients = await tx.query.client.findMany().execute();
const clientInterface = await tx.query.wgInterface const clientInterface = await tx.query.wgInterface
@@ -117,7 +108,7 @@ export class ClientService {
name, name,
// TODO: properly assign user id // TODO: properly assign user id
userId: 1, userId: 1,
expiresAt: parsedExpiresAt, expiresAt,
privateKey, privateKey,
publicKey, publicKey,
preSharedKey, preSharedKey,
@@ -22,6 +22,7 @@ const name = z
.min(1, t('zod.client.name')) .min(1, t('zod.client.name'))
.pipe(safeStringRefine); .pipe(safeStringRefine);
// TODO?: validate iso string
const expiresAt = z const expiresAt = z
.string({ message: t('zod.client.expiresAt') }) .string({ message: t('zod.client.expiresAt') })
.min(1, t('zod.client.expiresAt')) .min(1, t('zod.client.expiresAt'))
-2
View File
@@ -16,5 +16,3 @@ export const WG_ENV = {
/** UI is hosted on HTTP instead of HTTPS */ /** UI is hosted on HTTP instead of HTTPS */
INSECURE: process.env.INSECURE === 'true', INSECURE: process.env.INSECURE === 'true',
}; };
console.log(WG_ENV);