mirror of
https://github.com/VueTorrent/VueTorrent.git
synced 2024-11-29 05:28:53 +03:00
116 lines
4 KiB
Markdown
116 lines
4 KiB
Markdown
# VueTorrent
|
|
|
|
The sleekest looking WebUI for qBittorrent made with Vue.js!
|
|
|
|
> Vue, qBitorrent, Vuetify
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
| | | |
|
|
| :--------------------------------: | :--------------------------------: | :--------------------------------: |
|
|
|  |  |  |
|
|
|  |  |  |
|
|
|
|
<p align="center">
|
|
<img src="https://imgur.com/weOOI7n.png" width="300" alt="Mobile screenshot">
|
|
</p>
|
|
|
|
## Installation
|
|
|
|
### Manual
|
|
|
|
- Visit the [Releases](https://github.com/WDaan/VueTorrent/releases) page!
|
|
- Download the latest `release.zip`
|
|
- Unzip the downloaded file
|
|
- Point your alternate WebUI location to the `vuetorrent` folder in qBittorrent settings
|
|
|
|
### From Source
|
|
|
|
- Head to the [`latest_release`](https://github.com/WDaan/VueTorrent/tree/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.
|
|
|
|
```nginx
|
|
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 <kbd>Ctrl</kbd>-<kbd>A</kbd>
|
|
- delete selected with delete button
|
|
- select with <kbd>Ctrl</kbd>+click or from right-click menu
|
|
- <kbd>Shift</kbd>-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](/../../issues/101)
|
|
- On an older version? check out [#90](/../../issues/90)
|
|
- Other? check out [#10](/../../issues/10)
|
|
|
|
### Disable/Uninstall
|
|
|
|
When you use VueTorrent, it gets installed as a [PWA](https://web.dev/progressive-web-apps/) so that it can feel more like an app.
|
|
|
|
If you disable or uninstall VueTorrent, sometimes you'll see fragments of the VueTorrent PWA stick around, due to the nature of how PWAs work.
|
|
|
|
Here's how to fix it:
|
|
- Open up your browser's inspector (on Chrome, click the ︙ menu, then go to More tools > Developer tools)
|
|
- Select the "Application" tab. Select the "Clear storage" submenu, and then press the `Clear site data` button.
|
|
|
|
|
|
## Support
|
|
|
|
- Open up an issue 😛
|
|
|
|
<a href="https://www.buymeacoffee.com/wdaan"><img src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=&slug=wdaan&button_colour=FFDD00&font_colour=000000&font_family=Arial&outline_colour=000000&coffee_colour=ffffff"></a>
|
|
|
|
## Credits
|
|
|
|
- Other alternate WebUI written in Vue [`CzBiX qb-web`](https://github.com/CzBiX/qb-web)
|