📋Prerequisites
This guide assumes you're starting with a fresh PC. We'll walk you through every step!
🐍Step 1: Install Python
Visit python.org/downloads and download Python 3.8 or higher.
Important: Check "Add Python to PATH" before clicking Install.
Open Command Prompt and run:
python --version
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
brew install python@3.11
python3 --version
sudo apt update && sudo apt upgrade -y
sudo apt install python3 python3-pip python3-venv -y
python3 --version
📦Step 2: Download & Extract Application
Download the application ZIP file from your provided link.
Windows: Right-click the ZIP → "Extract All..." → Choose destination
macOS: Double-click the ZIP file
Linux: Right-click → "Extract Here" or:
unzip application.zip
Open Terminal/Command Prompt and navigate to the extracted folder:
# Example - adjust path based on where you extracted cd Desktop/media-server-application # Or cd Downloads/media-server-application
🔧Step 3: Setup Virtual Environment
It keeps project dependencies isolated and prevents conflicts with other Python projects.
# Windows python -m venv venv # macOS/Linux python3 -m venv venv
# Windows venv\Scripts\activate # macOS/Linux source venv/bin/activate
✅ You should see (venv) prefix in your terminal.
📚Step 4: Install Dependencies
pip install --upgrade pip
pip install -r requirements.txt
⏳ This may take a few minutes...
⚙️Step 5: Configure Environment Variables
Find the .env or .env.example file in the root directory.
If you only see .env.example, copy it:
# Windows copy .env.example .env # macOS/Linux cp .env.example .env
Open .env and set values:
# Secret key for signing session cookies SESSION_SECRET=replace-with-a-long-random-string # Fixed login credentials AUTH_USERNAME=admin AUTH_PASSWORD=change-me # Optional API key (or set via /settings/api-key) API_KEY=
- Use a long, random
SESSION_SECRET(32+ chars). - Change default username/password.
- Never commit your
.envto Git.
🚀Step 6: Run the Application
Use the included script:
cd /d "g:\code_files\Fivem\Media Storage\cmd" run.cmd
This will activate the venv, install dependencies, and start at http://127.0.0.1:8000.
Manual Method (All OS)
# Basic uvicorn main:app --reload # Custom host/port uvicorn main:app --host 0.0.0.0 --port 8000 --reload
- App: http://localhost:8000
- Swagger: /docs
- ReDoc: /redoc