Skip to content

Alternate WebUI usage

WolfganP edited this page Feb 22, 2018 · 10 revisions

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

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.

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)

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:

General

Troubleshooting

External programs

Search plugins

Themes

Translation


WebUI

WebUI API

State Version
Current qBittorrent ≥ v4.1
Previous qBittorrent v3.2.0 - v4.0.x
Obsolete qBittorrent < v3.2.0

WebAPI clients

Alternate WebUI

Reverse proxy setup for WebUI access

WebUI HTTPS configuration


Linux


Development

Compilation

Common information for CMake

*BSD, Linux

macOS

Windows

Obsolete compilation guides

Clone this wiki locally