7 Installation

Rémi Marseault edited this page 2024-08-11 23:48:05 -05:00

Table of Contents

• Manual
• Using Git
• Stable version
• Nightly version
• Using source
• Using LSIO docker mod
• Lazy/Easy
• UnRaid
• Alternative methods
• Install Optional Backend

Manual

1. Download the latest build from the releases page
2. Unzip the vuetorrent.zip file
3. Point your alternate WebUI location to the vuetorrent folder in the qBittorrent settings

The targeted WebUI folder should look like this:

$ 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
2. 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 20 or higher.

1. Clone the repo
2. Run npm install
3. Run npm run build
4. Point your alternate WebUI location to the vuetorrent folder

Using LSIO docker mod

Warning

Only available when using the linuxserver.io qBittorrent image

1. Add the following environment variable to your docker container:

DOCKER_MODS=ghcr.io/vuetorrent/vuetorrent-lsio-mod:latest

2. Edit your qBittorrent configuration to use alternative WebUI
   1. Settings > WebUI > Use alternative WebUI: checked
   2. Settings > WebUI > Files location: /vuetorrent

If you want to stick to a specific version, either to rollback or to disable updates, you must change the latest tag above.

Similar to the Nightly branch, you can use the nightly tag to use the latest commits.

The list of available versions can be found on the package page

Lazy/Easy

Use hotio's qbittorrent docker image, that comes pre-packed with VueTorrent.

UnRaid

If you're having troubling getting VueTorrent up and running, I suggest you check out this 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

Install Optional Backend

Checkout the backend repo for information on how to set it up.