VueTorrent/README.md
2021-02-19 07:46:23 +01:00

3.4 KiB

VueTorrent

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

Vue, qBitorrent, Vuetify

Screenshots

Desktop screenshot

Mobile screenshot

Installation

Manual

  • Visit the 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

  • Head to the latest-release branch
  • 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

NGINX install

You can use NGINX reverse proxy to use VueTorrent, without making any change to qBittorrent.

Simply download and unzip the folder to a location (/opt here) and paste this code into your NGINX config file.

server {
  server_name vue.torrent;
  location / {
    root /opt/vuetorrent/public/;
  }
  location /api {
    proxy_pass http://127.0.0.1:8081;
    http2_push_preload on;
    client_max_body_size 10M;
  }
}

Development

  • Clone the repo
  • npm install
  • npm run serve
  • npm run lint (to format the code)
  • docker-compose up -d (to start qbittorrent docker => optional, you can edit vue.config.js as well)

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!
    • select all torrents with Ctrl-A
    • delete selected torrents with delete
    • select with Ctrl+click
    • Shift-click to select from one 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
  • works with qBittorrent v4.2 and later

Contributing

I'll gladly accept help/pull requests & advice!

FAQ

Unacceptable file type, only regular file is allowed.

  • Running FreeNAS? check out #101
  • On an older version? check out #90
  • Other? check out #10

Support

  • Open up an issue 😛

Credits