README
¶
qui
A fast, modern web interface for qBittorrent. Supports managing multiple qBittorrent instances from a single, lightweight application.
Documentation
Full documentation available at getqui.com
Quick Start
Linux x86_64
# Download and extract the latest release
wget $(curl -s https://api.github.com/repos/autobrr/qui/releases/latest | grep browser_download_url | grep linux_x86_64 | cut -d\" -f4)
sudo tar -C /usr/local/bin -xzf qui*.tar.gz qui
# Run
qui serve
The web interface will be available at http://localhost:7476
Docker
docker run -d \
-p 7476:7476 \
-v $(pwd)/config:/config \
ghcr.io/autobrr/qui:latest
Features
- Single Binary: No dependencies, just download and run
- Multi-Instance Support: Manage all your qBittorrent instances from one place
- Fast & Responsive: Optimized for performance with large torrent collections
- Cross-Seed: Automatically find and add matching torrents across trackers
- Automations: Rule-based torrent management with conditions and actions
- Backups & Restore: Scheduled snapshots with multiple restore modes
- Reverse Proxy: Transparent qBittorrent proxy for external apps
- Multi-Language: Available in English, German, French, Italian, Czech, Ukrainian, Korean, Brazilian Portuguese, Simplified Chinese, Traditional Chinese, and Catalan, with automatic browser-language detection
Community
Join our community on Discord!
Support
- GitHub Discussions - Feature requests and bug reports
- GitHub Issues - Work in progress
Support Development
qui is developed and maintained by volunteers. Your support helps us continue improving the project.
Premium Themes
Purchase premium themes from Settings → Premium Themes in your qui instance. The checkout page shows your license key. If you donate with crypto, verify your transaction at crypto.getqui.com to receive a 100% discount code for premium themes. A license also unlocks custom themes, which you can write yourself or take from qui-community-themes.
Donations
If you'd like to support development beyond theme purchases, donations are always appreciated.
Cryptocurrency
Verify your crypto donation at crypto.getqui.com to receive a 100% discount code for premium themes.
Bitcoin (BTC)
- soup:
bc1qfe093kmhvsa436v4ksz0udfcggg3vtnm2tjgem - zze0s:
bc1q2nvdd83hrzelqn4vyjm8tvjwmsuuxsdlg4ws7x
Ethereum (ETH)
- soup:
0xD8f517c395a68FEa8d19832398d4dA7b45cbc38F - zze0s:
0xBF7d749574aabF17fC35b27232892d3F0ff4D423
Litecoin (LTC)
- soup:
ltc1q86nx64mu2j22psj378amm58ghvy4c9dw80z88h - zze0s:
ltc1qza9ffjr5y43uk8nj9ndjx9hkj0ph3rhur6wudn
Monero (XMR)
- XMR discount codes are handled manually. Reach out on Discord or email
s0up4200@pm.me. - soup:
8AMPTPgjmLG9armLBvRA8NMZqPWuNT4US3kQoZrxDDVSU21kpYpFr1UCWmmtcBKGsvDCFA3KTphGXExWb3aHEu67JkcjAvC - zze0s:
44AvbWXzFN3bnv2oj92AmEaR26PQf5Ys4W155zw3frvEJf2s4g325bk4tRBgH7umSVMhk88vkU3gw9cDvuCSHgpRPsuWVJp
For other currencies or donation methods, reach out on Discord.
Contributing
Contributions are welcome.
See CONTRIBUTING.md for the development and test workflow.
Alternatives
If qui does not fit your setup, these projects offer different approaches:
- VueTorrent is a modern, responsive alternative WebUI.
- iQbit is a mobile-focused WebUI and PWA.
- Flood supports qBittorrent and other torrent clients.
- qBitController is a native app for Android, iOS, Linux, macOS, and Windows.
The qBittorrent wiki includes a longer list of community WebUIs.
License
GPL-2.0-or-later
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
qui
command
|
|
|
internal
|
|
|
automationsgen
command
Command automationsgen writes the automation rule JSON reference for the docs and the condition field table for the query builder.
|
Command automationsgen writes the automation rule JSON reference for the docs and the condition field table for the query builder. |
|
database
Package database provides a SQLite database layer with string interning.
|
Package database provides a SQLite database layer with string interning. |
|
dbinterface
Package dbinterface provides database interfaces to avoid import cycles.
|
Package dbinterface provides database interfaces to avoid import cycles. |
|
fsops
Package fsops defines the Backend interface that abstracts filesystem operations for qui's services.
|
Package fsops defines the Backend interface that abstracts filesystem operations for qui's services. |
|
fsops/local
Package local implements fsops.Backend by delegating to the local filesystem via os.*, pkg/hardlinktree, pkg/reflinktree, pkg/hardlink, and pkg/fsutil.
|
Package local implements fsops.Backend by delegating to the local filesystem via os.*, pkg/hardlinktree, pkg/reflinktree, pkg/hardlink, and pkg/fsutil. |
|
fsops/remote
Package remote implements fsops.Backend over SFTP, on the pooled SSH connection the instance's stored credentials open.
|
Package remote implements fsops.Backend over SFTP, on the pooled SSH connection the instance's stored credentials open. |
|
logstream
Package logstream provides a thread-safe log broadcasting system with a ring buffer for log history and SSE-based streaming to subscribers.
|
Package logstream provides a thread-safe log broadcasting system with a ring buffer for log history and SSE-based streaming to subscribers. |
|
qbittorrent/prefcatalog
Package prefcatalog is the preference catalog: for each qBittorrent preference key, it says where qui shows the key and whether a user can change it.
|
Package prefcatalog is the preference catalog: for each qBittorrent preference key, it says where qui shows the key and whether a user can change it. |
|
services/activity
Package activity provides a small in-process pub/sub hub for qui-owned server events ("server activity").
|
Package activity provides a small in-process pub/sub hub for qui-owned server events ("server activity"). |
|
services/automations
Package automations provides an expression-based automation system for managing torrents.
|
Package automations provides an expression-based automation system for managing torrents. |
|
services/crossseed
Package crossseed provides intelligent cross-seeding functionality for torrents.
|
Package crossseed provides intelligent cross-seeding functionality for torrents. |
|
services/crossseed/gazellemusic
Package gazellemusic implements gzlx-style cross-seed matching against Gazelle trackers (OPS/RED) using their JSON APIs.
|
Package gazellemusic implements gzlx-style cross-seed matching against Gazelle trackers (OPS/RED) using their JSON APIs. |
|
services/dirscan
Package dirscan provides directory scanning functionality to find media files and match them against Torznab indexers for cross-seeding.
|
Package dirscan provides directory scanning functionality to find media files and match them against Torznab indexers for cross-seeding. |
|
services/discscan
Package discscan queues BDInfo scans of Discs (a folder holding BDMV, or an .iso) and stores the Disc report in the database.
|
Package discscan queues BDInfo scans of Discs (a folder holding BDMV, or an .iso) and stores the Disc report in the database. |
|
services/externalprograms
Package externalprograms provides a unified service for executing external programs with torrent data.
|
Package externalprograms provides a unified service for executing external programs with torrent data. |
|
services/orphanscan
Package orphanscan finds and removes orphan files not associated with any torrent.
|
Package orphanscan finds and removes orphan files not associated with any torrent. |
|
sshpool
Package sshpool dials an instance's SSH endpoint with its stored credentials and reports how the presented host key relates to the pinned one.
|
Package sshpool dials an instance's SSH endpoint with its stored credentials and reports how the presented host key relates to the pinned one. |
|
testutil/postgres
command
Command postgres runs Postgres integration tests with a temporary server.
|
Command postgres runs Postgres integration tests with a temporary server. |
|
testutil/qbtstub
Package qbtstub is a small qBittorrent WebAPI over a temp dir.
|
Package qbtstub is a small qBittorrent WebAPI over a temp dir. |
|
testutil/sshtest
Package sshtest generates the SSH key material and credential key that the models and database tests both need.
|
Package sshtest generates the SSH key material and credential key that the models and database tests both need. |
|
testutil/testdb
Package testdb provides isolated migrated database fixtures for tests.
|
Package testdb provides isolated migrated database fixtures for tests. |
|
themes
Package themes embeds the built-in theme CSS files and exposes their metadata so the API can serve and validate them.
|
Package themes embeds the built-in theme CSS files and exposes their metadata so the API can serve and validate them. |
|
tray
Package tray shows the Tray: qui's icon in the Windows notification area.
|
Package tray shows the Tray: qui's icon in the Windows notification area. |
|
pkg
|
|
|
fsutil
Package fsutil provides filesystem utilities for hardlink operations.
|
Package fsutil provides filesystem utilities for hardlink operations. |
|
hardlinktree
Package hardlinktree provides utilities for creating hardlink trees that mirror torrent file layouts for cross-seeding.
|
Package hardlinktree provides utilities for creating hardlink trees that mirror torrent file layouts for cross-seeding. |
|
pathcmp
Package pathcmp provides shared path normalization helpers used for cross-platform path comparisons.
|
Package pathcmp provides shared path normalization helpers used for cross-platform path comparisons. |
|
pathutil
Package pathutil provides cross-platform path sanitization utilities.
|
Package pathutil provides cross-platform path sanitization utilities. |
|
redact
Package redact provides utilities for redacting sensitive information from URLs and errors.
|
Package redact provides utilities for redacting sensitive information from URLs and errors. |
|
reflinktree
Package reflinktree provides utilities for creating reflink (copy-on-write) trees that mirror torrent file layouts for cross-seeding.
|
Package reflinktree provides utilities for creating reflink (copy-on-write) trees that mirror torrent file layouts for cross-seeding. |
|
sharedextents
Package sharedextents reports whether two known files currently share allocated storage.
|
Package sharedextents reports whether two known files currently share allocated storage. |
|
Package web web/build.go
|
Package web web/build.go |
Click to show internal directories.
Click to hide internal directories.