Welcome to the HomeTube documentation! This guide helps you install, use, and contribute to HomeTube.
| Goal | Documentation |
|---|---|
| Install & run HomeTube | Installation Guide |
| Download videos | Usage Guide |
| Deploy with Docker | Docker Guide |
| Contribute code | Contributing Guide |
- Installation Guide - Set up HomeTube (Docker or local)
- Usage Guide - Learn all features and download strategies
- Supported Platforms - 1800+ video sources supported
- Docker Guide - Container configuration and volumes
- Deployment Guide - Production deployment, reverse proxy, security
- Contributing Guide - Development setup, testing, and workflow
- Release Process - Versioning, tagging, and curated release notes
- Generic File Naming - Temporary file system and download resilience
- Intelligent Caching - URL info caching and resume support
- yt-dlp Version Management - Automated updates tracking
- Testing Guide - Test framework and guidelines
docs/
├── README.md # This index
├── installation.md # Setup instructions (Docker + local)
├── usage.md # User guide and features
├── docker.md # Container configuration
├── deployment.md # Production deployment
├── supported-platforms.md # Supported video sources
├── contributing.md # Development setup & workflow
├── testing.md # Testing framework
├── architecture/ # Technical documentation
│ ├── generic-file-naming.md # File naming system
│ ├── intelligent-caching.md # Caching system
│ └── ytdlp-version-management.md # Version tracking
├── examples/ # Configuration examples
│ └── nginx/ # Nginx configuration
├── icons/ # Favicon
└── images/ # Screenshots
- Main README - Project overview
- GitHub Repository
- GitHub Issues
- GitHub Discussions
Happy downloading! 🎬