Skip to content
rupsdbbPublic

About

A small-screen PWA for qBittorrent-nox

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

1 Commit

Folders and files

Repository files navigation

qb

A small-screen front end for qBittorrent-nox, built as a single Rust binary (qbm). It is a PWA: open it in Chrome on your phone and choose "Install app". It then behaves like an app, and you can send magnet links straight to it.

Features

  • A torrent list with filter chips, search, live speeds and free space.
  • Tap a torrent to pause/resume, force start, recheck, reannounce, copy its magnet, or delete it (with or without files).
  • Add torrents from magnet links, http(s) torrent URLs, bare info-hashes or .torrent files, with a category and an optional "start paused".
  • An alt-speed (🐢) toggle.
  • Works with qBittorrent 4.x and 5.x.

Build and run

Needs Rust 1.85+. Everything under web/ is compiled into the binary, so the binary and a .env file are all you need to deploy.

cargo build --release
cp .env.example .env    # then edit it
./target/release/qbm

qbm.service is an example systemd unit. To work on the code, run cargo test. The tests run the real router against an in-process fake qBittorrent.

Configuration

Variable Default
QB_URL http://127.0.0.1:8080 qBittorrent WebUI address
QB_USER / QB_PASS empty qBittorrent WebUI login. Leave empty if qBittorrent bypasses auth for localhost
LISTEN 0.0.0.0:8099 address and port this app listens on
BASE_PATH empty serve under a sub-path such as /m
UI_PASSWORD empty password for this UI. Changing it logs out every device

Getting magnet links into the app

Where How
Android, installed PWA Long-press a magnet link → Share → qb. Sharing text that contains a magnet works too. (manifest share_target)
Android, tapping magnet: The manifest declares a magnet protocol handler. Chrome on Android supports this only for some WebAPKs and versions. If a tap doesn't offer the app, use Share.
Desktop Chrome/Edge (installed or tab) Clicking magnet: links opens the app. In a normal tab, use "Open magnet links with this app" in the Add sheet.

The app always shows the link pre-filled in the Add sheet, so adding it takes one tap. A web page can't silently add torrents.

Installing requires HTTPS

Chrome only installs a PWA (and only creates the Android WebAPK) from a secure origin. http://192.168.x.x:8099 works in a tab but won't install properly. Options:

  • Tailscale: tailscale serve --bg 8099 gives https://<host>.<tailnet>.ts.net/.
  • A reverse proxy (Caddy/nginx) with a real certificate. To serve it under a sub-path, forward /m/ unchanged and set BASE_PATH=/m.

Security

  • Set UI_PASSWORD unless the port is only reachable over a private network. Failed logins are limited to one guess per second across all clients.
  • Cross-site POSTs are refused (Sec-Fetch-Site), so other websites can't add or delete torrents through your browser.
  • The qBittorrent credentials stay on the server. After a rejected qBittorrent login the app waits 60 s before retrying, so it never triggers qBittorrent's IP ban.

Icons

web/icons/ is generated by tools/icons.py. Rasterising needs an SVG renderer with filter support, such as resvg: tools/icons.py resvg.

License

GPL-3.0-or-later. See LICENSE.

The "qb" letterforms in the icons come from the qBittorrent logo (GPL-2.0-or-later). This project is not affiliated with the qBittorrent project.

About

A small-screen PWA for qBittorrent-nox

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages