Skip to main content

​
Prerequisites

Before installing StreamVault, ensure you have the following dependencies installed:
Required for: Frontend development and build processDownload from nodejs.org or install via package manager:
winget install OpenJS.NodeJS.LTS
Verify installation:
node --version  # Should be v18.0.0 or higher
npm --version
Required for: Backend compilation and Tauri frameworkInstall Rust using rustup:
# Download and run rustup-init.exe from:
# https://rustup.rs/

# Or use winget:
winget install Rustlang.Rustup
After installation, restart your terminal and verify:
rustc --version
cargo --version
The Rust installer will add ~/.cargo/bin to your PATH automatically. You may need to restart your terminal for changes to take effect.
Required for: Video playback functionalityStreamVault uses MPV for all media playback. Install it for your platform:
Option 1: Direct download (recommended)
  1. Download MPV from mpv.io
  2. Or use pre-built Windows binaries from SourceForge
  3. Extract to a permanent location (e.g., C:\Program Files\mpv\)
  4. Add the MPV directory to your system PATH:
    • Open System Properties → Environment Variables
    • Under System variables, select Path → Edit
    • Click New and add the path to mpv.exe (e.g., C:\Program Files\mpv)
    • Click OK to save
Option 2: Package managers
choco install mpv
StreamVault will auto-detect MPV in common installation locations, including Scoop, Chocolatey, and standard Program Files directories.
Without MPV installed, StreamVault will not be able to play any media files. Ensure MPV is properly installed and accessible in your system PATH.

​
Clone the repository

1

Clone from GitHub

git clone https://github.com/SlasshyOverhere/StreamVault.git
cd StreamVault
If you plan to contribute, fork the repository first and clone your fork instead.
2

Install dependencies

Install all Node.js dependencies using npm:
npm install
This will install:
  • React 18 and React DOM
  • TypeScript and type definitions
  • Vite build tooling
  • Tauri CLI and API bindings
  • UI libraries (Radix UI, Framer Motion, Lucide icons)
  • TailwindCSS and styling utilities
The installation process will also download Rust dependencies for Tauri automatically.

​
Development setup

1

Configure environment (optional)

If you’re self-hosting the backend, create a .env file in the project root:
.env
# Frontend environment variables
VITE_AUTH_SERVER_URL=https://your-backend-domain
And set Tauri-side environment variables before building:
$env:STREAMVAULT_AUTH_SERVER_URL="https://your-backend-domain"
$env:STREAMVAULT_TMDB_PROXY_URL="https://your-backend-domain/api/tmdb"
$env:STREAMVAULT_WS_URL="wss://your-backend-domain/ws/watchtogether"
For most users, the default backend (https://streamvault-backend-server.onrender.com) will work out of the box. See self-hosting guide for custom backend setup.
2

Run in development mode

Start both the Vite dev server and Tauri application:
npm run tauri dev
This command:
  • Starts the Vite dev server on http://localhost:3000
  • Compiles the Rust backend
  • Launches the Tauri window with hot-reload enabled
  • Watches for file changes in both frontend and backend code
The first run will take longer as it compiles all Rust dependencies. Subsequent runs are much faster due to incremental compilation.
3

Frontend-only development (optional)

If you only need to work on the frontend without Tauri:
npm run dev
This starts just the Vite dev server at http://localhost:3000. Tauri commands will not be available in this mode.

​
Production build

1

Sync version numbers

StreamVault automatically syncs version numbers between package.json and src-tauri/Cargo.toml:
npm run version:sync
Or bump the version and sync:
npm run version:bump patch  # or minor, major
2

Build the application

Create a production build with platform-specific installers:
npm run tauri build
This command:
  • Builds the optimized frontend bundle with Vite
  • Compiles the Rust backend in release mode
  • Creates platform-specific installers and executables
  • Generates update manifests for auto-updates
The first production build can take 5-10 minutes as Rust compiles all dependencies with optimizations. Grab a coffee!
3

Locate build artifacts

After building, find your application in:
  • Executable: src-tauri/target/release/streamvault.exe (Windows) or streamvault (macOS/Linux)
  • Installers: src-tauri/target/release/bundle/
    • Windows: .msi installer and .exe portable
    • macOS: .dmg disk image and .app bundle
    • Linux: .deb, .AppImage, or .rpm packages
src-tauri/target/release/bundle/msi/StreamVault_3.0.21_x64_en-US.msi

​
MPV configuration

StreamVault will automatically detect MPV in the following locations:
  • System PATH (via where mpv.exe)
  • C:\Program Files\mpv\mpv.exe
  • C:\Program Files (x86)\mpv\mpv.exe
  • C:\Program Files\mpv.net\mpv.exe
  • Scoop installations: C:\Users\*\scoop\apps\mpv\current\mpv.exe
  • Chocolatey: C:\ProgramData\chocolatey\bin\mpv.exe
  • Portable installations in common locations
  • User profile: C:\Users\*\AppData\Local\Programs\mpv\mpv.exe
The application performs a deep search in C:\Program Files, C:\, and D:\ directories up to 3 levels deep.
If MPV is not detected automatically, you can manually configure the path in Settings → Player after first launch.

​
Troubleshooting

Error: error: linking with 'link.exe' failed (Windows)Solution: Install Visual Studio Build Tools
  1. Download Visual Studio Build Tools
  2. Install “Desktop development with C++” workload
  3. Restart your terminal and try again
Error: error: could not compile 'tauri'Solution: Update Rust toolchain
rustup update stable
Error: engine 'node' is incompatibleSolution: Upgrade Node.js to v18 or higher
node --version  # Check current version
Download the latest LTS from nodejs.org or use a version manager like nvm.
Error: “MPV player not found” when trying to play mediaSolution 1: Add MPV to system PATH
  • Locate your mpv.exe installation
  • Add the directory to your system PATH environment variable
  • Restart StreamVault
Solution 2: Manually configure MPV path
  • Open StreamVault Settings
  • Navigate to Player settings
  • Click Browse and select mpv.exe
  • Save and try playing media again
Error: Can’t find built applicationSolution: Check build output
# List build artifacts
ls src-tauri/target/release/

# List installers
ls src-tauri/target/release/bundle/
Look for error messages in the build output. Common issues:
  • Insufficient disk space
  • Antivirus blocking compilation
  • Missing system dependencies

​
Next steps

Quickstart guide

Complete the onboarding and scan your first library

Configuration

Customize settings and configure integrations

Google Drive setup

Connect your Google Drive for cloud media indexing

TMDB setup

Get your TMDB API key for metadata fetching
Need help? Check the troubleshooting guide or open an issue on GitHub.

Build docs developers (and LLMs) love

Get started for freeTalk to us