mirrors/VueTorrent
1
0
Fork 0
mirror of https://github.com/VueTorrent/VueTorrent.git synced 2024-11-28 21:18:54 +03:00
Code Issues Projects Releases Packages Wiki Activity
VueTorrent/README.md
Rémi Marseault f70fb22513
chore(readme): Move installation to wiki (#1475)
2024-01-20 22:17:56 +01:00

4.5 KiB
Raw Blame History

VueTorrent

VueTorrent

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

Join us on Discord

Vue qBittorrent Vuetify

stars Forks Issues Closed Closed PR Version Test Status Downloads

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

Checkout the wiki!

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

Localize the app

We use Tolgee 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