kieraneglin / pinchflat

> [!IMPORTANT] 
> (2025-02-14) zakkarry, who is a collaborator on cross-seed and an extremely helpful community member in general, is facing hard times due to medical debt and family illness. If you're able, please consider sponsoring him on GitHub or donating via buymeacoffee. Tell him I sent you!
 logo by @hernandito 
# Your next YouTube media manager
## Table of contents:
- What it does
- Features
- Screenshots
- Installation
 - Unraid
 - Portainer
 - Docker
 - Environment Variables
 - A note on reverse proxies
- Username and Password (authentication)
- Frequently asked questions
- Documentation
- EFF donations
- Pre-release disclaimer
- Development and Contributing
## What it does
Pinchflat is a self-hosted app for downloading YouTube content built using yt-dlp. It's designed to be lightweight, self-contained, and easy to use. You set up rules for how to download content from YouTube channels or playlists and it'll do the rest, periodically checking for new content. It's perfect for people who want to download content for use in with a media center app (Plex, Jellyfin, Kodi) or for those who want to archive media!
While you can download individual videos, Pinchflat is best suited for downloading content from channels or playlists. It's also not meant for consuming content in-app - Pinchflat downloads content to disk where you can then watch it with a media center app or VLC.
If it doesn't work for your use case, please make a feature request! You can also check out these great alternatives: Tube Archivist, ytdl-sub, and TubeSync
## Features
- Self-contained - just one Docker container with no external dependencies
- Powerful naming system so content is stored where and how you want it
- Easy-to-use web interface with presets to get you started right away
- First-class support for media center apps like Plex, Jellyfin, and Kodi (docs)
- Supports serving RSS feeds to your favourite podcast app (docs)
- Automatically downloads new content from channels and playlists
 - Uses a novel approach to download new content more quickly than other apps
- Supports downloading audio content
- Custom rules for handling YouTube Shorts and livestreams
- Apprise support for notifications
- Allows automatically redownloading new media after a set period
 - This can help improve the download quality of new content or improve SponsorBlock tags
- Optionally automatically delete old content (docs)
- Advanced options like setting cutoff dates and filtering by title (docs)
- Reliable hands-off operation
- Can pass cookies to YouTube to download your private playlists (docs)
- Sponsorblock integration
- \[Advanced\] allows custom `yt-dlp` options (docs)
- \[Advanced\] supports running custom scripts when after downloading/deleting media (alpha - docs)
## Screenshots
## Installation
### Unraid
Simply search for Pinchflat in the Community Apps store!
### Portainer
> [!IMPORTANT] 
> See the note below about storing config on a network file share. It's preferred to store t