Self-Hosting Guide
Complete instructions for deploying your private VAULT instance on local infrastructure.
1
Prerequisites
Ensure your system meets the following requirements before installation:
- Python 3.8+: Required for the backend.
- FFmpeg: Essential for media processing and conversion. Must be added to your system PATH.
Windows Instructions:
- Download FFmpeg (Windows build) from gyan.dev or similar.
- Extract the zip to a permanent folder (e.g.,
C:\ffmpeg). - Search Windows for "Edit the system environment variables".
- Click Environment Variables button.
- Under System variables, select Path and click Edit.
- Click New and paste the path to the
binfolder (e.g.,C:\ffmpeg\bin). - Click OK on all dialogs to save.
- Git: To clone the repository (optional, can download zip).
2
Installation
Easy Method (Recommended)
We've included an automated script. No commands needed.
- Download/Clone the repository.
- Double-click
run_app.bat - The app will install dependencies and launch automatically.
Transparency: What does this script do?
- Creates a private Python virtual environment (venv).
- Installs required libraries (FastAPI, yt-dlp) locally.
- Starts the local web server on your machine.
Show Manual Terminal Method
Clone Repository
git clone https://github.com/your-repo/vault.git cd vault
Setup Environment
Windows (PowerShell):
python -m venv venv .\venv\Scripts\Activate pip install -r requirements.txt
3
Launch
Quick Start
Simply double-click the run_app.bat file in the root directory.
Manual Start
# Ensure venv is activated python -m uvicorn app.main:app --reload --host 0.0.0.0 --port 8000
System Online
Once running, access your vault at http://localhost:8000