From d08522a14889714d29c46d9f70b53151c31f32a7 Mon Sep 17 00:00:00 2001 From: Francisco Pombal Date: Tue, 31 Mar 2020 01:04:51 +0100 Subject: [PATCH] Alt WebUI: separate development from usage --- Developing-alternate-WebUIs-(WIP).md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 Developing-alternate-WebUIs-(WIP).md diff --git a/Developing-alternate-WebUIs-(WIP).md b/Developing-alternate-WebUIs-(WIP).md new file mode 100644 index 0000000..e5ddb8a --- /dev/null +++ b/Developing-alternate-WebUIs-(WIP).md @@ -0,0 +1,20 @@ +### **WIP** + +From qBittorrent v4.1.0 and on, the WebUI architecture was expanded to allow the use of alternate set of HTML files, allowing customization of the WebUI separated from the evolution of the core qBittorrent code. + +Also, this mechanism is controlled via configuration options (core UI preferences window or config file), and the WebUI files (html, css, js, ...) are external to the program so it's easier than ever to test and modify the WebUI's functionality, look and feel without need of rebuilding the executable. + +### Public and Private WebUI files separation +In order to increase security, a `public` (login process handling) and `private` (WebUI functionality) separation of files is implemented (see core WebUI files' segregation as ref: https://github.com/qbittorrent/qBittorrent/tree/master/src/webui/www) + +### First steps to an alternate WebUI: +Copy the files: +https://github.com/qbittorrent/qBittorrent/tree/master/src/webui/www to a `` +https://github.com/qbittorrent/qBittorrent/tree/master/src/icons to `/public/images` +https://github.com/qbittorrent/qBittorrent/tree/master/src/icons to `/private/images` + +Enable AltWebUI on the options and point the entry `WebUI\RootFolder` to ``, then launch qBittorrent. +Access the WebUI as always, modify the files at `` according to your needs and refresh the browser to see the changes reflected. + +### References: +* Main WebUI PR: https://github.com/qbittorrent/qBittorrent/pull/7610