10 Alternate WebUI usage

Jad edited this page 2020-05-28 19:44:44 -05:00

Table of Contents

• Introduction
• Procedure

Introduction

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.

Procedure

First, you need to download a compatible WebUI. You can find a list of unofficial community-developed WebUIs at List of unofficial alternate WebUIs.

1. Under Tools->Preferences->WebUI enable Use alternative WebUI.
2. Choose a location that points to a WebUI-compatible folder location.
3. Restart qBittorrent or refresh your browser for changes to take effect.

You can also change these settings via the config file. The relevant entries are:

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.

General

• Installing qBittorrent
• Frequently Asked Questions (FAQ)
• qBittorrent options (current and deprecated)
• How to use qBittorrent as a tracker
• How to use portable mode
• Anonymous mode
• How to bind your vpn to prevent ip leaks

Troubleshooting

• qBittorrent support forum
• I forgot my GUI lock password
• I forgot my WebUI password
• Speed issues

External programs

• How-to
• savecategory

Search plugins

• List of unofficial search plugins

Themes

• Developing custom UI themes
• How to use custom UI themes
• List of unofficial themes

Translation

• How to translate qBittorrent

---

WebUI

WebUI API

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

WebAPI clients

• List of unofficial WebAPI clients

Alternate WebUI

• Alternate WebUI usage
• Developing alternate WebUIs
• List of unofficial alternate WebUIs

Reverse proxy setup for WebUI access

• NGINX
• Microsoft IIS ARR
• Traefik

WebUI HTTPS configuration

• Let's Encrypt Certificates + Caddy2 Reverse Proxy
• Let's Encrypt certificates + NGINX reverse proxy - Linux
• Let's Encrypt certificates - Linux
• Self-signed SSL certificates - Linux

---

Linux

• Running qBittorrent without X server (WebUI only)
• Running qBittorrent without X server (WebUI only, systemd service set up, Ubuntu 15.04 or newer)
• OpenVPN and qBittorrent without X server

---

Development

• Coding style
• Contributing
• How to write a search plugin
• Using VSCode for qBittorrent development
• Setup GDB with Qt pretty printers
• How to debug WebUI code

Compilation

Common information for CMake

*BSD, Linux

• Alpine Linux
• CentOS 8.x
• Debian / Ubuntu and derivatives (CMake)
• Debian / Ubuntu and derivatives (autotools/qmake)
• Docker
• FreeBSD (no GUI)
• Fully static binaries on Linux (glibc or musl)
• Raspberry Pi OS / DietPi
• Raspbian for LeMaker Banana Pro

macOS

• cmake (x86_64, arm64, cross-compilation, static linkage)
• autotools/qmake

Windows

• MSVC 2019 (CMake, static linkage)
• MSVC 2019 (qmake, static linkage)
• MSYS2

Obsolete compilation guides

Go back to home