mirrors/VueTorrent
1
0
Fork 0
mirror of https://github.com/VueTorrent/VueTorrent.git synced 2024-11-25 10:55:50 +03:00
Code Issues Projects Releases Packages Wiki Activity
VueTorrent/README.md
WDaan 42b117b342 chore: readme
2022-12-30 14:19:30 +01:00

3.9 KiB
Raw Blame History

VueTorrent

VueTorrent

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

Vue qBittorrent Vuetify

stars Forks Issues Closed Closed PR Version Test Status Downloads

Screenshots

  • Desktop

  • Desktop Dark Mode

  • Mobile Dark Mode

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

  • 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

Alternative methods - May work for older QBit versions

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 username admin and password adminadmin.
  • 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!
    • 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.4 and later

Contributing

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

FAQ

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

Credits