Skip to main content

Watch YouTube offline

Search, download, and enjoy YouTube videos offline with a familiar interface. Full control over quality, format, and your personal media library.

Get startedAPI reference

Quick start

Get OfflineTube running in minutes with these simple steps.

1

Install dependencies

Install Node.js, Python, and ffmpeg on your system.
# Check Node.js version (20+ required)
node --version

# Check Python version (3.10+ required)
python3 --version

# Verify ffmpeg is installed
ffmpeg -version
2

Set up the project

Clone the repository and install frontend and backend dependencies.
# Clone the repository
git clone https://github.com/mario1027/offlinetube
cd offlinetube

# Install frontend dependencies
npm install

# Set up backend
cd mini-services/offlinetube-api
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
3

Start the application

Launch both the backend API and frontend in separate terminals.
# Terminal 1: Start backend
cd mini-services/offlinetube-api
source .venv/bin/activate
python main.py

# Terminal 2: Start frontend
npm run dev
Open http://localhost:3000 in your browser to access OfflineTube.

Explore by feature

Learn what OfflineTube can do for you.

Search and discovery

Find videos through search or explore trending content from YouTube.

Download management

Queue downloads with custom quality and format settings, track progress in real time.

Offline playback

Stream downloaded videos locally with a YouTube-style player interface.

Library management

Organize and manage your offline video collection with thumbnails and metadata.

Developer resources

Everything you need to integrate, customize, and extend OfflineTube.

API reference

Complete API documentation for all backend endpoints.

Frontend components

Explore the React components that power the UI.

Configuration

Configure API URLs, quality defaults, and network settings.

Deployment

Deploy OfflineTube to production environments.

Type definitions

TypeScript interfaces for video, downloads, and player state.

Network access

Set up OfflineTube for local network access from other devices.

Ready to start?

Follow our quickstart guide to get OfflineTube running on your system in minutes. Learn how to search, download, and watch videos offline.

View quickstart guide

Build docs developers (and LLMs) love

Get started for freeTalk to us