From 0a33b1f7df3576d99ef9644618d300ac652a5a8c Mon Sep 17 00:00:00 2001 From: Vadim Babadzhanyan Date: Fri, 16 Aug 2024 18:39:24 +0300 Subject: [PATCH] Supports displaying short links, for easy downloading on TVs and Android TVs --- README.md | 2 ++ docker-compose.yml | 3 ++- src/config.js | 1 + src/lib/Server.js | 17 +++++++++++++++++ src/lib/WireGuard.js | 2 ++ src/www/index.html | 7 +++++-- src/www/js/api.js | 7 +++++++ src/www/js/app.js | 9 +++++++++ 8 files changed, 45 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index be8a32c..67f5ecb 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,7 @@ You have found the easiest way to install & manage WireGuard on any Linux host! * Automatic Light / Dark Mode * Multilanguage Support * UI_TRAFFIC_STATS (default off) +* UI_SHOW_LINKS (default off) ## Requirements @@ -120,6 +121,7 @@ These options can be configured by setting environment variables using `-e KEY=" | `LANG` | `en` | `de` | Web UI language (Supports: en, ua, ru, tr, no, pl, fr, de, ca, es, ko, vi, nl, is, pt, chs, cht, it, th, hi). | | `UI_TRAFFIC_STATS` | `false` | `true` | Enable detailed RX / TX client stats in Web UI | | `UI_CHART_TYPE` | `0` | `1` | UI_CHART_TYPE=0 # Charts disabled, UI_CHART_TYPE=1 # Line chart, UI_CHART_TYPE=2 # Area chart, UI_CHART_TYPE=3 # Bar chart | +| `UI_SHOW_LINKS` | `false` | `true` | Enable display of a short download link in Web UI | > If you change `WG_PORT`, make sure to also change the exposed port. diff --git a/docker-compose.yml b/docker-compose.yml index dd450ed..dd135fd 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -27,6 +27,7 @@ services: # - WG_POST_DOWN=echo "Post Down" > /etc/wireguard/post-down.txt # - UI_TRAFFIC_STATS=true # - UI_CHART_TYPE=0 # (0 Charts disabled, 1 # Line chart, 2 # Area chart, 3 # Bar chart) + # - UI_SHOW_LINKS=true image: ghcr.io/wg-easy/wg-easy container_name: wg-easy @@ -39,7 +40,7 @@ services: cap_add: - NET_ADMIN - SYS_MODULE - # - NET_RAW # ⚠️ Uncomment if using Podman + # - NET_RAW # ⚠️ Uncomment if using Podman sysctls: - net.ipv4.ip_forward=1 - net.ipv4.conf.all.src_valid_mark=1 diff --git a/src/config.js b/src/config.js index 9785053..9335bfb 100644 --- a/src/config.js +++ b/src/config.js @@ -37,3 +37,4 @@ iptables -D FORWARD -o wg0 -j ACCEPT; module.exports.LANG = process.env.LANG || 'en'; module.exports.UI_TRAFFIC_STATS = process.env.UI_TRAFFIC_STATS || 'false'; module.exports.UI_CHART_TYPE = process.env.UI_CHART_TYPE || 0; +module.exports.UI_SHOW_LINKS = process.env.UI_SHOW_LINKS || 'false'; diff --git a/src/lib/Server.js b/src/lib/Server.js index 7f06da5..d46d29e 100644 --- a/src/lib/Server.js +++ b/src/lib/Server.js @@ -32,6 +32,7 @@ const { LANG, UI_TRAFFIC_STATS, UI_CHART_TYPE, + UI_SHOW_LINKS, } = require('../config'); const requiresPassword = !!PASSWORD_HASH; @@ -92,6 +93,11 @@ module.exports = class Server { return `"${UI_CHART_TYPE}"`; })) + .get('/api/ui-show-links', defineEventHandler((event) => { + setHeader(event, 'Content-Type', 'application/json'); + return `${UI_SHOW_LINKS}`; + })) + // Authentication .get('/api/session', defineEventHandler((event) => { const authenticated = requiresPassword @@ -103,6 +109,17 @@ module.exports = class Server { authenticated, }; })) + .get('/:clientHash', defineEventHandler(async (event) => { + const clientHash = getRouterParam(event, 'clientHash'); + const clients = await WireGuard.getClients(); + const client = clients.find((client) => client.hash === clientHash); + if (!client) return; + const clientId = client.id; + const config = await WireGuard.getClientConfiguration({ clientId }); + setHeader(event, 'Content-Disposition', `attachment; filename="${clientHash}.conf"`); + setHeader(event, 'Content-Type', 'text/plain'); + return config; + })) .post('/api/session', defineEventHandler(async (event) => { const { password } = await readBody(event); diff --git a/src/lib/WireGuard.js b/src/lib/WireGuard.js index adf6ca9..83f25f1 100644 --- a/src/lib/WireGuard.js +++ b/src/lib/WireGuard.js @@ -5,6 +5,7 @@ const path = require('path'); const debug = require('debug')('WireGuard'); const crypto = require('node:crypto'); const QRCode = require('qrcode'); +const CRC32 = require("crc-32"); const Util = require('./Util'); const ServerError = require('./ServerError'); @@ -147,6 +148,7 @@ ${client.preSharedKey ? `PresharedKey = ${client.preSharedKey}\n` : '' createdAt: new Date(client.createdAt), updatedAt: new Date(client.updatedAt), allowedIPs: client.allowedIPs, + hash: Math.abs(CRC32.str(clientId)).toString(16), downloadableConfig: 'privateKey' in client, persistentKeepalive: null, latestHandshakeAt: null, diff --git a/src/www/index.html b/src/www/index.html index 236a8f3..ff75584 100644 --- a/src/www/index.html +++ b/src/www/index.html @@ -43,7 +43,7 @@ - @@ -225,7 +225,7 @@ {{client.transferTxCurrent | bytes}}/s - + · @@ -242,6 +242,9 @@ {{!uiTrafficStats ? " · " : ""}}{{new Date(client.latestHandshakeAt) | timeago}} +
+ {{document.location.protocol}}//{{document.location.host}}/{{client.hash}} +
diff --git a/src/www/js/api.js b/src/www/js/api.js index 9006f5a..0e70c7a 100644 --- a/src/www/js/api.js +++ b/src/www/js/api.js @@ -57,6 +57,13 @@ class API { }); } + async getUIShowLinks() { + return this.call({ + method: 'get', + path: '/ui-show-links', + }); + } + async getSession() { return this.call({ method: 'get', diff --git a/src/www/js/app.js b/src/www/js/app.js index 61bb7c0..fc15366 100644 --- a/src/www/js/app.js +++ b/src/www/js/app.js @@ -71,6 +71,7 @@ new Vue({ uiTrafficStats: false, uiChartType: 0, + uiShowLinks: false, uiShowCharts: localStorage.getItem('uiShowCharts') === '1', uiTheme: localStorage.theme || 'auto', prefersDarkScheme: window.matchMedia('(prefers-color-scheme: dark)'), @@ -384,6 +385,14 @@ new Vue({ this.uiChartType = 0; }); + this.api.getUIShowLinks() + .then((res) => { + this.uiShowLinks = res; + }) + .catch(() => { + this.uiShowLinks = false; + }); + Promise.resolve().then(async () => { const lang = await this.api.getLang(); if (lang !== localStorage.getItem('lang') && i18n.availableLocales.includes(lang)) {