diff --git a/Alternate-WebUI-usage.md b/Alternate-WebUI-usage.md index d561580..2477155 100644 --- a/Alternate-WebUI-usage.md +++ b/Alternate-WebUI-usage.md @@ -1,20 +1,20 @@ # ## **WIP** -From qBittorrent v4.0.5 and on, the webUI architecture was expanded to allow the use of alternate set of files, allowing customization of the webUI separated from the evolution of the core qBittorrent code. +From qBittorrent v4.0.5 and on, the WebUI architecture was expanded to allow the use of alternate set of files, allowing customization of the WebUI separated from the evolution of the core qBittorrent code. -Also, this mechanism is controlled via configuration options (via the core UI or config file), and the webUI files (html, css, js, ...) are external to the program so it's easier than ever to test and mofify the webUI functionality, look and feel without need of rebuilding the project. +Also, this mechanism is controlled via configuration options (via the core UI 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 functionality, look and feel without need of rebuilding the project. ### Public and Private webUI files separation -In order to increase security, a `public` (login process handling) and `private` (webUI functionality) separation of the files is implemented (see core webUI files' segregation as ref: https://github.com/qbittorrent/qBittorrent/tree/master/src/webui/www) +In order to increase security, a `public` (login process handling) and `private` (WebUI functionality) separation of the files is implemented (see core WebUI files' segregation as ref: https://github.com/qbittorrent/qBittorrent/tree/master/src/webui/www) ### Config entries * WebUI\AlternativeUIEnabled=`/` * WebUI\RootFolder `` -### First steps to an alternate webUI: -Copy the files on https://github.com/qbittorrent/qBittorrent/tree/master/src/webui/www to a ``, 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. +### First steps to an alternate WebUI: +Copy the files on https://github.com/qbittorrent/qBittorrent/tree/master/src/webui/www to a ``, 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 +* Main WebUI PR: https://github.com/qbittorrent/qBittorrent/pull/7610