VueTorrent

VueTorrent

The sleekest looking WebUI for qBittorrent made with Vue.js!

Join us on [Discord](https://discord.gg/KDQP7fR467)
![Vue](https://img.shields.io/badge/Vue-%5E3.3.4-brightgreen) ![qBittorrent](https://img.shields.io/badge/qBittorrent-4.4%2B-brightgreen) ![Vuetify](https://img.shields.io/badge/Vuetify-%5E3.3.15-brightgreen) ![stars](https://img.shields.io/github/stars/WDaan/VueTorrent) ![Forks](https://img.shields.io/github/forks/WDaan/VueTorrent) ![Issues](https://img.shields.io/github/issues/WDaan/VueTorrent) ![Closed](https://img.shields.io/github/issues-closed/WDaan/VueTorrent) ![Closed PR](https://img.shields.io/github/issues-pr-closed/WDaan/VueTorrent) ![Version](https://img.shields.io/github/v/release/wdaan/vuetorrent) ![Test Status](https://img.shields.io/github/actions/workflow/status/wdaan/vuetorrent/test.yml) ![Downloads](https://img.shields.io/github/downloads/WDaan/VueTorrent/total) ## Screenshots - Desktop

Screenshot Desktop (Light Mode)

- Desktop Dark Mode

Screenshot Desktop (Dark Mode)

- Mobile Dark Mode

Screenshot Mobile Dashboard (Dark Mode) Screenshot Mobile Dashboard (Light Mode)

## Installation ### Manual - Visit the [Releases](https://github.com/WDaan/VueTorrent/releases) page! - Download the latest `vuetorrent.zip` - Unzip the downloaded file - Point your alternate WebUI location to the `vuetorrent` folder in qBittorrent settings ### From Source - Clone branch using - `git clone --single-branch --branch latest-release https://github.com/WDaan/VueTorrent.git` - Pull changes every once in a while, using `git pull` If you like to always have the latest and greatest, please sync to the `nightly-release`-branch. This can contain breaking changes though. ### Lazy/Easy - use [hotio's qbittorrent](https://hotio.dev/containers/qbittorrent/) docker image, that comes pre-packed with VueTorrent. [Alternative methods - May work for older QBit versions](../../wiki/Alternative_Installation_Methods) ## Development - Clone the repo - `npm install` - `npm start` - `npm run lint` (to format the code) - `docker-compose up -d` (starts a qbittorrent docker, optional) - Open the WebUI on localhost with the default credentials - Default username is always `admin` - Default password is `adminadmin` **on 4.6.0 and below**, and is generated on 4.6.1 and above - Make sure "CSRF protection" and "Host header verification" is disabled on the target server! - Edit `env.development` to tweak your dev environment (e.g. fake torrents) ## Features - Torrents - add / remove / pause / resume / rename torrents - selectively download files - view info / trackers / peers / content / tags & categories - search for new torrents straight from the WebUI! - search filtering powered by Fuse.js! - Keyboard shortcuts! - Mac keymap is supported (use Cmd instead of Ctrl) - Press Escape to dismiss any dialogs or to return to Dashboard view - Dashboard - Select all torrents with Ctrl-A - Focus search input with Ctrl-F - Press again to enable native browser search - When no dialogs are opened, press Escape to unfocus search input - Press again to unselect all torrents - Delete selected torrents with Delete (Fn-Backspace on Mac) - Ctrl-click on a torrent card to enable multi-select mode and select it - Hold Shift and click on a torrent card to select all torrents between the last selected torrent and the clicked torrent - System - see session stats (down / upload speed, session uploaded / downloaded, free space) - beautiful transfer graphs - change the most common settings - Extra features the default WebUI doesn't have - mobile friendly! (can be installed as a PWA) - Configureable Dashboard: choose which torrent properties are shown for both busy and completed torrents - Optimized for the latest version of qBittorrent ## Contributing Open up a PR or create an issue to discuss. Reach out on Discord if you need help getting started! [FAQ](../../wiki/FAQ) ### Localize the app We use [Tolgee](https://tolgee.io/) to manage translations. If you want to help, let us know which locale do you want to work on in the discord server to be added to the project. ## Support Open up an issue 😛 but before you do that: - confirm you're on the latest version of VueTorrent - confirm there is no other issue mentioning the same problem ## Contributors - [@m4ximuel](https://github.com/m4ximuel) - [@Larsluph](https://github.com/Larsluph)