Table of Contents
Introduction
On Linux, the qbittorrent-nox package includes a version of qBittorrent that does not require any GUI-related components to run, ideal to run in headless server environments. It can be controlled via a feature rich HTTP WebAPI and WebUI.
You can install it from a binary package repository such as your distro's repositories, the official Ubuntu PPAs, etc.
You can also compile it from source by toggling the flag that disables the GUI (refer to the relevant compilation guides on the wiki).
Running
Simply execute qbittorrent-nox. At first execution, you should get prompted to accept the legal disclaimer. After that, qBittorrent will print out some useful information, such as the URL the WebAPI/WebUI can be accessed at, via a web browser, and the default credentials.
To quit, simply press Ctrl-c or send SIGINT or SIGTERM to the process.
Running in the background
After first start and having accepted the legal disclaimer, you can also use qbittorrent-nox -d to execute qbittorrent as a daemon in the background, instead of running it in the foreground.
You probably want to control the daemon, like setting it to start on system boot, for example. To learn how to do that with systemd on Ubuntu 15.04 and other modern releases of mainstream distros, check out the dedicated article.
Settings and logs
Settings can be customized via the WebUI, WebAPI, or, if needed, manually editing the config file when qBitorrent is not running (`~/.config/qBittorrent/qBittorrent.conf).
The logs as well as other program data are located in ~/.local/share/data/qBittorrent.
Consult the man page or pass --help for more information.
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
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
- 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
*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