How to install TubeSync with Docker Compose?

The README provides a Docker Compose example: define a service with the ghcr.io/meeb/tubesync image, map volumes for config and downloads, set environment variables like TZ, PUID, and PGID, and expose port 4848. Use 'restart: unless-stopped' for automatic recovery.

TubeSync vs yt-dlp: which is better for automatic YouTube downloads?

TubeSync is ideal for hands-off, continuous syncing to media servers with scheduling and integration, while yt-dlp is a command-line tool for manual downloads. Choose TubeSync for a full PVR experience, or yt-dlp for one-off tasks.

Can TubeSync download from Vimeo or other sites?

No, TubeSync currently only supports YouTube, as stated in the FAQ. It relies on yt-dlp, which supports many platforms, but the web interface integration is not yet implemented for other sources.

How do I enable password protection in TubeSync?

Set the HTTP_USER and HTTP_PASS environment variables to enable basic HTTP authentication, as detailed in the optional authentication section. This adds a simple login layer but lacks multi-user management.

Does TubeSync work on Raspberry Pi?

Yes, the container supports arm64 architecture, which includes Raspberry Pi 3 and later models, making it suitable for low-power homelab setups. Ensure you allocate sufficient storage for downloads.

What happens if downloads fail in TubeSync?

TubeSync implements gradual retrying with back-off timers, so failed downloads are automatically retried over an extended period. Check the tasks tab or container logs for error details, but many issues resolve without intervention.

Open-Awesome

tubesync

AGPL-3.0Pythonv0.18.1Self-Hosted

A PVR for YouTube that syncs channels and playlists to your local media server, automating downloads and library updates.

GitHub

2.7k stars166 forks0 contributors

What is tubesync?

TubeSync is a personal video recorder (PVR) for YouTube that automates the downloading and organization of YouTube channels and playlists to a local media server. It solves the problem of manually managing YouTube content for offline viewing by continuously syncing new videos, handling failures gracefully, and updating media libraries automatically.

Target Audience

Media server enthusiasts, homelab users, and anyone who wants to maintain a local archive of YouTube content for offline access, especially those using Plex or Jellyfin.

Value Proposition

Developers choose TubeSync for its full PVR experience, seamless integration with popular media servers, and hands-free automation with robust failure recovery, setting it apart from basic YouTube downloader tools.

Overview

Syncs YouTube channels and playlists to a locally hosted media server

Use Cases

Best For

Automatically archiving YouTube channels for offline viewing
Building a local media library integrated with Plex or Jellyfin
Downloading YouTube playlists with specific quality and format preferences
Creating a hands-free YouTube content sync system with failure retries
Running a self-hosted YouTube PVR on Docker or Raspberry Pi
Managing large collections of YouTube videos without manual intervention

Not Ideal For

Users who need to download single videos on an ad-hoc basis
Projects requiring synchronization from video platforms other than YouTube
Scenarios where real-time progress tracking or a modern, interactive web UI is critical
Deployments that demand built-in HTTPS without additional proxy configuration

Pros & Cons

Pros

Automated Hands-Off Syncing

Implements a set-and-forget PVR model with continuous monitoring and downloading of new YouTube content, minimizing user intervention through scheduled tasks and automatic updates.

Seamless Media Server Updates

Automatically updates Plex and Jellyfin libraries when new media is downloaded, creating an integrated offline viewing experience without manual library scans.

Robust Failure Recovery

Uses gradual retry logic with back-off timers for failed downloads, enhancing reliability over long periods as highlighted in the failure recovery feature description.

Containerized Simplicity

Offers easy deployment via Docker or Podman with support for amd64 and arm64 architectures, including Raspberry Pi, as outlined in the installation guide with clear examples.

Cons

YouTube-Only Support

Currently limited to YouTube despite yt-dlp's capability for hundreds of sources, which the README admits is a pre-release limitation, reducing versatility for multi-platform use.

No Built-in Security Features

Lacks native HTTPS support and requires a reverse proxy for secure access, with only basic HTTP authentication available via environment variables, adding setup complexity.

Basic Web Interface

The admin dashboard uses no JavaScript, so it lacks real-time progress bars and dynamic updates, making it less interactive for monitoring active downloads.

Open Source Alternative To

tubesync is an open-source alternative to the following products:

Sonarr

Sonarr is a PVR (Personal Video Recorder) for Usenet and BitTorrent users that monitors TV shows and automatically downloads episodes when they become available.

Frequently Asked Questions

Related Projects

MeTube

Self-hosted video downloader for YouTube and other sites (web UI for youtube-dl / yt-dlp)

Stars13,795

Forks989

Last commit2 days ago

Seerr

Open-source media request and discovery manager for Jellyfin, Plex, and Emby.

Your next YouTube media manager

Stars5,003

Forks144

Last commit5 months ago

Headphones

Automatic music downloader for SABnzbd

Stars3,732

Forks596

Last commit10 months ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub