mirror of
https://github.com/VueTorrent/VueTorrent.git
synced 2025-02-26 20:31:13 +03:00
readme
This commit is contained in:
Daan Wijns
parent
e99239d770
commit
402bb61a98
1 changed files with 219 additions and 218 deletions
437
README.md
437
README.md
|
|
@ -1,219 +1,220 @@
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# VueTorrent
|
# VueTorrent
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
A modern looking WEBUI for qBittorrent made with Vuejs & express!
|
A modern looking WEBUI for qBittorrent made with Vuejs & express!
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
(support for more clients coming in the future)
|
(support for more clients coming in the future)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
> Vue, Node, Express, qBitorrent
|
> Vue, Node, Express, qBitorrent
|
||||||
|
|
||||||
|
|
||||||
PS : This is NOT an alternate WEBUI, this is a webapp that interacts with your existing qBitorrent client.
|
PS : This is NOT an alternate WEBUI, this is a webapp that interacts with your existing qBitorrent client.
|
||||||
|
|
||||||
|
|
||||||
## Update
|
## Update
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
now using this 'https://github.com/TheFlow95/node-qbittorrent-api-v2' qbittorrent-api
|
now using this 'https://github.com/TheFlow95/node-qbittorrent-api-v2' qbittorrent-api
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
& deleting & adding don't quite work yet :/
|
& deleting & adding don't quite work yet :/
|
||||||
|
|
||||||
|
|
||||||
|
### With the updates it has become too unstable to use unfortunately, I'll update it when I find a fully working library or maybe write one myself if I find the time.
|
||||||
## Screenshots
|
|
||||||
|
## Screenshots
|
||||||
|
|
||||||
|
|
||||||
<p align="center">
|
|
||||||
|
<p align="center">
|
||||||
|
|
||||||
|
|
||||||
<a href="https://i.imgur.com/vPBcrK4.png"><img src="https://i.imgur.com/vPBcrK4.png" title="Desktop" alt="Desktop Screenshot" ></a>
|
|
||||||
|
<a href="https://i.imgur.com/vPBcrK4.png"><img src="https://i.imgur.com/vPBcrK4.png" title="Desktop" alt="Desktop Screenshot" ></a>
|
||||||
|
|
||||||
|
|
||||||
</p>
|
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
<p align="center">
|
|
||||||
|
<p align="center">
|
||||||
|
|
||||||
|
|
||||||
<a href="https://i.imgur.com/SUOEyy9.png"><img src="https://i.imgur.com/SUOEyy9.png" title="Mobile" alt="Mobile Screenshot" width="320" height="540"></a>
|
|
||||||
|
<a href="https://i.imgur.com/SUOEyy9.png"><img src="https://i.imgur.com/SUOEyy9.png" title="Mobile" alt="Mobile Screenshot" width="320" height="540"></a>
|
||||||
|
|
||||||
|
|
||||||
</p>
|
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
## Installation
|
||||||
Easiest way is with docker-compose:
|
|
||||||
|
Easiest way is with docker-compose:
|
||||||
```
|
|
||||||
|
```
|
||||||
vuetorrent:
|
|
||||||
|
vuetorrent:
|
||||||
image: wdaan/vuetorrent
|
|
||||||
|
image: wdaan/vuetorrent
|
||||||
container_name: vuetorrent
|
|
||||||
|
container_name: vuetorrent
|
||||||
restart: always
|
|
||||||
|
restart: always
|
||||||
ports:
|
|
||||||
|
ports:
|
||||||
- "4000:3000"
|
|
||||||
|
- "4000:3000"
|
||||||
environment:
|
|
||||||
|
environment:
|
||||||
- VUE_APP_WEB_USER=vuetr
|
|
||||||
|
- VUE_APP_WEB_USER=vuetr
|
||||||
- VUE_APP_WEB_PASS=vuetr
|
|
||||||
|
- VUE_APP_WEB_PASS=vuetr
|
||||||
- QBIT_USER=qbit
|
|
||||||
|
- QBIT_USER=qbit
|
||||||
- QBIT_PASS=qbit
|
|
||||||
|
- QBIT_PASS=qbit
|
||||||
- QBIT_HOST=https://qbit.example.com
|
|
||||||
|
- QBIT_HOST=https://qbit.example.com
|
||||||
```
|
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
With Docker run
|
|
||||||
|
With Docker run
|
||||||
|
|
||||||
|
|
||||||
```
|
|
||||||
|
```
|
||||||
docker run --name=vuetorrent -d --env VUE_APP_WEB_USER=vuetr --env VUE_APP_WEB_PASS=vuetr --env QBIT_USER=admin --env QBIT_PASS=adminadmin --env QBIT_HOST=http://10.0.0.10:8080 --restart unless-stopped -p 3000:3000 wdaan/vuetorrent:latest
|
|
||||||
|
docker run --name=vuetorrent -d --env VUE_APP_WEB_USER=vuetr --env VUE_APP_WEB_PASS=vuetr --env QBIT_USER=admin --env QBIT_PASS=adminadmin --env QBIT_HOST=http://10.0.0.10:8080 --restart unless-stopped -p 3000:3000 wdaan/vuetorrent:latest
|
||||||
```
|
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
## Development
|
|
||||||
|
## Development
|
||||||
|
|
||||||
|
|
||||||
FRONTEND : Git clone & npm run serve!
|
|
||||||
|
FRONTEND : Git clone & npm run serve!
|
||||||
|
|
||||||
|
|
||||||
SERVER : npm run build & npm run start!
|
|
||||||
|
SERVER : npm run build & npm run start!
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Features
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
|
||||||
- viewing sessions stats ( down / upload speed, session uploaded / downloaded )
|
|
||||||
|
- viewing sessions stats ( down / upload speed, session uploaded / downloaded )
|
||||||
|
|
||||||
|
|
||||||
- adding / removing / pausing / resuming torrents
|
|
||||||
|
- adding / removing / pausing / resuming torrents
|
||||||
|
|
||||||
|
|
||||||
- sorting by every property shown!
|
|
||||||
|
- sorting by every property shown!
|
||||||
|
|
||||||
|
|
||||||
- mobile friendly! (maybe not for thousands of torrents...)
|
|
||||||
|
- mobile friendly! (maybe not for thousands of torrents...)
|
||||||
|
|
||||||
- works on QBittorrent V4.2 and later
|
|
||||||
|
- works on QBittorrent V4.2 and later
|
||||||
|
|
||||||
## Contributing
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
I'll gladly accept help/pull requests & advice! (this is my first project of this nature, pls be kind 😛 ).
|
|
||||||
|
I'll gladly accept help/pull requests & advice! (this is my first project of this nature, pls be kind 😛 ).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## FAQ
|
|
||||||
|
## FAQ
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
- **Why build this??**
|
|
||||||
|
- **Why build this??**
|
||||||
|
|
||||||
|
|
||||||
- Why not? Most WebUI's look very dated and now it's no longer necessary to search for a remote control app!
|
|
||||||
|
- Why not? Most WebUI's look very dated and now it's no longer necessary to search for a remote control app!
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Support
|
|
||||||
|
## Support
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Reach out to me at one of the following places!
|
|
||||||
|
Reach out to me at one of the following places!
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
- <a href="https://m.me/WijnsDaan" target="_blank">`Facebook Messenger`</a>
|
|
||||||
|
- <a href="https://m.me/WijnsDaan" target="_blank">`Facebook Messenger`</a>
|
||||||
|
|
||||||
|
|
||||||
- Open up an issue 😛
|
|
||||||
|
- Open up an issue 😛
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Credits
|
|
||||||
|
## Credits
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Dashboard design heavily inspired by: 'https://github.com/iamshaunjp/vuetify-playlist'
|
|
||||||
|
Dashboard design heavily inspired by: 'https://github.com/iamshaunjp/vuetify-playlist'
|
||||||
|
|
||||||
|
|
||||||
Also check out The Net Ninja's Youtube Channel.
|
|
||||||
|
Also check out The Net Ninja's Youtube Channel.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
---
|
|
||||||
|
---
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[](https://www.gnu.org/licenses/gpl-3.0)
|
[](https://www.gnu.org/licenses/gpl-3.0)
|
||||||
Loading…
Add table
Reference in a new issue