mirror of
https://github.com/VueTorrent/VueTorrent.git
synced 2024-10-22 18:56:38 +03:00
The sleekest looking WEBUI for qBittorrent made with Vuejs!
a1d78164ec
Some checks are pending
Build project and release / Run Release Please action (push) Waiting to run
Build project and release / Build VueTorrent (push) Waiting to run
Build project and release / Push to nightly branch (push) Blocked by required conditions
Build project and release / Upload release to GitHub (push) Blocked by required conditions
Build project and release / Push to latest branch (push) Blocked by required conditions
CodeQL / Analyze (javascript-typescript) (push) Waiting to run
|
||
|---|---|---|
| .github | ||
| .vscode | ||
| public | ||
| readme_assets | ||
| src | ||
| tests | ||
| .env.development | ||
| .eslintignore | ||
| .eslintrc.cjs | ||
| .gitignore | ||
| .prettierignore | ||
| .prettierrc.json | ||
| .release-please-manifest.json | ||
| CHANGELOG.md | ||
| docker-compose.yml | ||
| index.html | ||
| LICENSE | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| release-please-config.json | ||
| tsconfig.json | ||
| tsconfig.node.json | ||
| vite.config.ts | ||
| VueTorrent-logo.png | ||
| write-version.cjs | ||
VueTorrent
The sleekest looking WebUI for qBittorrent made with Vue.js!
Screenshots
- Desktop
- Desktop Dark Mode
- Mobile
Installation
Checkout the wiki!
Development
- Clone the repo
npm installnpm startnpm 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
adminadminon 4.6.0 and below, and is generated on 4.6.1 and above
- Default username is always
- Make sure "CSRF protection" and "Host header verification" is disabled on the target server!
- Edit
env.developmentto 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!
- 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
- 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
- Additional backend for improved experience, see the repo for more info
- This is a work in progress, and is not required to use VueTorrent
- Stores server-side settings
Important Information
VueTorrent is a WebUI (think of it as a "visual skin") that uses qBittorrent's API, enabling compatibility with automation solutions like the Servarr stack.
Everything that is compatible with qBittorrent will work regardless of the WebUI you chose to use.
Contributing
We gladly accept contributions!
Any help is appreciated, whether it's reporting bugs, suggesting enhancements, contributing code or localizing the app.
See the Contributing Guidelines for more information.
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
Funding
All donations are appreciated but purely optional.
Checkout the sponsor section of the repository.