mirrors/VueTorrent
1
0
Fork 0
mirror of https://github.com/VueTorrent/VueTorrent.git synced 2025-03-15 12:40:04 +03:00
Code Issues Projects Releases Packages Wiki Activity

Update wiki

Larsluph 2024-01-20 20:57:34 +01:00
parent 448ae1a3a2
commit a39abb5bbd
3 changed files with 48 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
Home.md

@ -1,5 +1,5 @@
Welcome to the VueTorrent wiki!
- [Installation Help](https://github.com/WDaan/VueTorrent/wiki/Installation-Help)
- [Alternative Installation Methods](Alternative_Installation_Methods)
- [Installation](Installation)
- [Alternative Installation Methods](Alternative-Installation-Methods)
- [FAQ](FAQ)

2
Installation-Help.md

@ -1,2 +0,0 @@
## UnRaid
If you're having troubling getting VueTorrent up and running, I suggest you check out [this](https://www.youtube.com/watch?v=60KXMYQDMGY) video. It is targeted at installing on UnRaid but it can also help out with other installation methods.

46
Installation.md Normal file

@ -0,0 +1,46 @@
## Manual
1. Download the [latest](https://github.com/VueTorrent/VueTorrent/releases/latest) build from the releases page
1. Unzip the `vuetorrent.zip` file
1. Point your alternate WebUI location to the `vuetorrent` folder in the qBittorrent settings
The targeted WebUI folder should look like this:
```shell
$ ls -lh
total 8.0K
drwxrwsr-x+ 3 larsluph users 4.0K Jan 20 16:00 public
-rw-rw-r-- 1 larsluph users 5 Jan 9 13:45 version.txt
```
## Using Git
### Stable version
1. Clone branch using git: `git clone --single-branch --branch latest-release https://github.com/VueTorrent/VueTorrent.git`
1. Pull changes every once in a while, using `git pull`
### Nightly version
If you like to always have the latest and greatest, you can sync to the `nightly-release` branch instead.
Please note that this version may contain bugs and breaking changes. Feel free to report them so that we can fix them before the stable release!
## Using source
Make sure you use Node 18 or higher.
1. Clone the repo
2. Run `npm install`
3. Run `npm run build`
4. Resulting build is in the `vuetorrent` folder
## Lazy/Easy
Use [hotio's qbittorrent docker image](https://hotio.dev/containers/qbittorrent/), that comes pre-packed with VueTorrent.
## UnRaid
If you're having troubling getting VueTorrent up and running, I suggest you check out [this](https://www.youtube.com/watch?v=60KXMYQDMGY) video. It is targeted at installing on UnRaid but it can also help out with other installation methods.
## Alternative methods
[May work for older QBit versions](../Alternative-Installation-Methods)