Alternate WebUI usage

WolfganP edited this page Feb 22, 2018 · 5 revisions

## 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)

Config entries

  • WebUI\AlternativeUIEnabled=<true>/<false>
  • WebUI\RootFolder=<path>

First steps to an alternate WebUI:

Copy the files on https://github.com/qbittorrent/qBittorrent/tree/master/src/webui/www to a <new folder>, enable AltWebUI on the options and point the entry WebUI\RootFolder to <new folder>, then launch qBittorrent. Access the WebUI as always, modify the files at <new folder> according to your needs and refresh the browser to see the changes reflected.

References:

Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.