mirrors/qBittorrent
1
0
Fork 0
mirror of https://github.com/qbittorrent/qBittorrent.git synced 2024-10-22 02:36:15 +03:00
Code Issues Projects Releases Packages Wiki Activity

Add separate page about alternate webui usage

Francisco Pombal 2020-03-31 01:20:08 +01:00
parent 6c36691287
commit 8f94599386
1 changed files with 13 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
Alternate-WebUI-usage.md

@ -1,25 +1,19 @@
### **WIP** # Introduction
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. From qBittorrent v4.1.0 and on, the WebUI architecture was expanded to allow the use of alternate sets of WebUI sources, allowing customization of the WebUI and usage of community developed alternatives.
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. # Procedure
### Public and Private WebUI files separation First you need to download a compatible WebUI. You can find a list of unofficial community-developed WebUIs at [List of unofficial alternate WebUIs](https://github.com/qbittorrent/qBittorrent/wiki/List-of-known-alternate-WebUIs).
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 1. Under `Tools->Preferences->WebUI` enable `Use alternative WebUI`.
* WebUI\AlternativeUIEnabled=`<true>/<false>` 2. Chose a location that points to a WebUI-compatible folder location.
* WebUI\RootFolder=`<path>` 3. Restart qBittorrent or refresh your browser for changes to take effect.
### First steps to an alternate WebUI: You can also change these settings via the config file. The relevant entries are:
Copy the files:
https://github.com/qbittorrent/qBittorrent/tree/master/src/webui/www to a `<new folder>`
https://github.com/qbittorrent/qBittorrent/tree/master/src/icons to `<new folder>/public/images`
https://github.com/qbittorrent/qBittorrent/tree/master/src/icons to `<new folder>/private/images`
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:
* Main WebUI PR: https://github.com/qbittorrent/qBittorrent/pull/7610
```
WebUI\AlternativeUIEnabled=true
WebUI\RootFolder=/path/to/some/alternate/webui
```
If you wish to customize the default one and maybe develop your own, refer to the article on [Developing alternate WebUIs](https://github.com/qbittorrent/qBittorrent/wiki/Developing-alternate-WebUIs-(WIP)).