Quick Start

Quick Start

🌐 中文版本

This guide will help you quickly install and run TMDB-Helper.

---

Option 1: Docker Deployment (Recommended)

1. Using Docker Compose

git clone https://github.com/CeRu-007/TMDB-Helper.git
cd TMDB-Helper
docker-compose up -d

2. Using Docker Directly

docker pull ceru007/tmdb-helper:latest

docker run -d \
  --name tmdb-helper \
  -p 4949:4949 \
  -v tmdb_data:/app/data \
  -e JWT_SECRET=your_jwt_secret_key \
  ceru007/tmdb-helper:latest

3. Environment Variables

Variable	Default	Description
JWT_SECRET	your_jwt_secret_key_here_change_in_production	JWT secret (must change in production)
SESSION_EXPIRY_DAYS	7	Session expiry (days)
NODE_ENV	production	Node.js environment
PORT	4949	Application port

⚠️ The app uses a "register first, then login" model. The registration page will appear automatically on first visit.

---

Option 2: Desktop Download

Download the latest release from GitHub Releases.

Supported platforms:

• Windows (.exe)
• macOS (.dmg)
• Linux (.AppImage)

---

Option 3: Web (Direct Run)

Prerequisites

• Node.js 22 (required)
• pnpm package manager

Installation Steps

# 1. Clone the repository
git clone https://github.com/CeRu-007/TMDB-Helper.git
cd TMDB-Helper

# 2. Install dependencies
pnpm install

# 3. Start dev server
pnpm dev

Or run in production mode:

# Double-click the startup script (Windows)
start-production.bat

# Or manually
pnpm run build
pnpm run start

---

First Visit

1. Open browser and navigate to http://localhost:4949
2. On first visit, the registration page will appear automatically - create an admin account
3. After logging in, you'll see the main interface

---

Basic Configuration

After first login, configure your AI model service:

1. Click the gear icon in the top right to open Settings
2. Select the "Model Service" panel
3. Add your AI service provider (OpenAI, DeepSeek, etc.)
4. Enter your API Key and model name

💡 AI model configuration is required for AI-powered features (episode generation, hard subtitle extraction, etc.)

---

Related Pages

• Settings - Detailed configuration guide
• Deployment Guide - Full deployment documentation
• FAQ - Having issues?

← Back to Home