Add environment variables to override admin panel interface settings

Co-authored-by: kaaax0815 <32197462+kaaax0815@users.noreply.github.com>

src/server/api/admin/interface/index.get.ts

@@ -1,8 +1,9 @@
 export default definePermissionEventHandler('admin', 'any', async () => {
   const wgInterface = await Database.interfaces.get();
+  const wgInterfaceWithOverrides = applyInterfaceOverrides(wgInterface);
 
   return {
-    ...wgInterface,
+    ...wgInterfaceWithOverrides,
     privateKey: undefined,
   };
 });

src/server/api/admin/interface/index.post.ts

@@ -8,7 +8,20 @@ export default definePermissionEventHandler(
       event,
       validateZod(InterfaceUpdateSchema, event)
     );
-    await Database.interfaces.update(data);
+
+    // Remove overridden fields from the update data
+    const updateData = { ...data };
+    if (WG_OVERRIDE_ENV.INTERFACE_PORT !== undefined) {
+      delete updateData.port;
+    }
+    if (WG_OVERRIDE_ENV.INTERFACE_DEVICE !== undefined) {
+      delete updateData.device;
+    }
+    if (WG_OVERRIDE_ENV.INTERFACE_MTU !== undefined) {
+      delete updateData.mtu;
+    }
+
+    await Database.interfaces.update(updateData);
     await WireGuard.saveConfig();
     return { success: true };
   }

src/server/utils/WireGuard.ts

@@ -14,8 +14,9 @@ class WireGuard {
    */
   async saveConfig() {
     const wgInterface = await Database.interfaces.get();
-    await this.#saveWireguardConfig(wgInterface);
-    await this.#syncWireguardConfig(wgInterface);
+    const wgInterfaceWithOverrides = applyInterfaceOverrides(wgInterface);
+    await this.#saveWireguardConfig(wgInterfaceWithOverrides);
+    await this.#syncWireguardConfig(wgInterfaceWithOverrides);
   }
 
   /**
@@ -151,6 +152,7 @@ class WireGuard {
 
   async getClientConfiguration({ clientId }: { clientId: ID }) {
     const wgInterface = await Database.interfaces.get();
+    const wgInterfaceWithOverrides = applyInterfaceOverrides(wgInterface);
     const userConfig = await Database.userConfigs.get();
 
     const client = await Database.clients.get(clientId);
@@ -159,9 +161,14 @@ class WireGuard {
       throw new Error('Client not found');
     }
 
-    return wg.generateClientConfig(wgInterface, userConfig, client, {
-      enableIpv6: !WG_ENV.DISABLE_IPV6,
-    });
+    return wg.generateClientConfig(
+      wgInterfaceWithOverrides,
+      userConfig,
+      client,
+      {
+        enableIpv6: !WG_ENV.DISABLE_IPV6,
+      }
+    );
   }
 
   async getClientQRCodeSVG({ clientId }: { clientId: ID }) {
@@ -217,25 +224,27 @@ class WireGuard {
       Database.interfaces.update(wgInterface);
     }
 
-    WG_DEBUG(`Starting Wireguard Interface ${wgInterface.name}...`);
-    await this.#saveWireguardConfig(wgInterface);
-    await wg.down(wgInterface.name).catch(() => {});
-    await wg.up(wgInterface.name).catch((err) => {
+    const wgInterfaceWithOverrides = applyInterfaceOverrides(wgInterface);
+
+    WG_DEBUG(`Starting Wireguard Interface ${wgInterfaceWithOverrides.name}...`);
+    await this.#saveWireguardConfig(wgInterfaceWithOverrides);
+    await wg.down(wgInterfaceWithOverrides.name).catch(() => {});
+    await wg.up(wgInterfaceWithOverrides.name).catch((err) => {
       if (
         err &&
         err.message &&
-        err.message.includes(`Cannot find device "${wgInterface.name}"`)
+        err.message.includes(`Cannot find device "${wgInterfaceWithOverrides.name}"`)
       ) {
         throw new Error(
-          `WireGuard exited with the error: Cannot find device "${wgInterface.name}"\nThis usually means that your host's kernel does not support WireGuard!`,
+          `WireGuard exited with the error: Cannot find device "${wgInterfaceWithOverrides.name}"\nThis usually means that your host's kernel does not support WireGuard!`,
           { cause: err.message }
         );
       }
 
       throw err;
     });
-    await this.#syncWireguardConfig(wgInterface);
-    WG_DEBUG(`Wireguard Interface ${wgInterface.name} started successfully.`);
+    await this.#syncWireguardConfig(wgInterfaceWithOverrides);
+    WG_DEBUG(`Wireguard Interface ${wgInterfaceWithOverrides.name} started successfully.`);
 
     WG_DEBUG('Starting Cron Job...');
     await this.startCronJob();

src/server/utils/config.ts

@@ -54,6 +54,19 @@ export const WG_INITIAL_ENV = {
     : undefined,
 };
 
+export const WG_OVERRIDE_ENV = {
+  /** Override the WireGuard interface port */
+  INTERFACE_PORT: process.env.OVERRIDE_INTERFACE_PORT
+    ? Number.parseInt(process.env.OVERRIDE_INTERFACE_PORT, 10)
+    : undefined,
+  /** Override the network device/interface */
+  INTERFACE_DEVICE: process.env.OVERRIDE_INTERFACE_DEVICE,
+  /** Override the MTU setting */
+  INTERFACE_MTU: process.env.OVERRIDE_INTERFACE_MTU
+    ? Number.parseInt(process.env.OVERRIDE_INTERFACE_MTU, 10)
+    : undefined,
+};
+
 function assertEnv<T extends string>(env: T) {
   const val = process.env[env];
 
@@ -63,3 +76,17 @@ function assertEnv<T extends string>(env: T) {
 
   return val;
 }
+
+/**
+ * Apply environment variable overrides to an interface object
+ */
+export function applyInterfaceOverrides<
+  T extends { port: number; device: string; mtu: number },
+>(wgInterface: T): T {
+  return {
+    ...wgInterface,
+    port: WG_OVERRIDE_ENV.INTERFACE_PORT ?? wgInterface.port,
+    device: WG_OVERRIDE_ENV.INTERFACE_DEVICE ?? wgInterface.device,
+    mtu: WG_OVERRIDE_ENV.INTERFACE_MTU ?? wgInterface.mtu,
+  };
+}