diff --git a/README.md b/README.md index d99b196..f9f415c 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,6 @@ +> [!NOTE] +> This is a community-maintained fork of [kieraneglin/pinchflat](https://github.com/kieraneglin/pinchflat). The original project is no longer actively maintained; this fork exists to continue development and apply community contributions. Docker images are published to `ghcr.io/communitymaintained/pinchflat`. + > [!IMPORTANT] > (2025-02-14) [zakkarry](https://github.com/sponsors/zakkarry), who is a collaborator on [cross-seed](https://github.com/cross-seed/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](https://github.com/sponsors/zakkarry) or donating via [buymeacoffee](https://tip.ary.dev). Tell him I sent you! @@ -17,11 +20,11 @@
-[![](https://img.shields.io/github/license/kieraneglin/pinchflat?style=for-the-badge&color=ee512b)](LICENSE) -[![](https://img.shields.io/github/v/release/kieraneglin/pinchflat?style=for-the-badge&color=purple)](https://github.com/kieraneglin/pinchflat/releases) +[![](https://img.shields.io/github/license/CommunityMaintained/pinchflat?style=for-the-badge&color=ee512b)](LICENSE) +[![](https://img.shields.io/github/v/release/CommunityMaintained/pinchflat?style=for-the-badge&color=purple)](https://github.com/CommunityMaintained/pinchflat/releases) [![](https://img.shields.io/static/v1?style=for-the-badge&logo=discord&message=Chat&color=5865F2&label=Discord)](https://discord.gg/j7T6dCuwU4) -[![](https://img.shields.io/github/actions/workflow/status/kieraneglin/pinchflat/lint_and_test.yml?style=for-the-badge)](#) -[![](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode&style=for-the-badge)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/kieraneglin/pinchflat) +[![](https://img.shields.io/github/actions/workflow/status/CommunityMaintained/pinchflat/lint_and_test.yml?style=for-the-badge)](#) +[![](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode&style=for-the-badge)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/CommunityMaintained/pinchflat)
@@ -38,18 +41,18 @@ - [Docker](#docker) - [Environment Variables](#environment-variables) - [A note on reverse proxies](#reverse-proxies) -- [Username and Password (authentication)](https://github.com/kieraneglin/pinchflat/wiki/Username-and-Password) -- [Frequently asked questions](https://github.com/kieraneglin/pinchflat/wiki/Frequently-Asked-Questions) -- [Documentation](https://github.com/kieraneglin/pinchflat/wiki) +- [Username and Password (authentication)](https://github.com/CommunityMaintained/pinchflat/wiki/Username-and-Password) +- [Frequently asked questions](https://github.com/CommunityMaintained/pinchflat/wiki/Frequently-Asked-Questions) +- [Documentation](https://github.com/CommunityMaintained/pinchflat/wiki) - [EFF donations](#eff-donations) - [Pre-release disclaimer](#pre-release-disclaimer) -- [Development and Contributing](https://github.com/kieraneglin/pinchflat/wiki/Development-and-Contributing) +- [Development and Contributing](https://github.com/CommunityMaintained/pinchflat/wiki/Development-and-Contributing) ## What it does Pinchflat is a self-hosted app for downloading YouTube content built using [yt-dlp](https://github.com/yt-dlp/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](https://github.com/kieraneglin/pinchflat/wiki/Frequently-Asked-Questions#how-do-i-download-one-off-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. +While you can [download individual videos](https://github.com/CommunityMaintained/pinchflat/wiki/Frequently-Asked-Questions#how-do-i-download-one-off-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](https://github.com/tubearchivist/tubearchivist), [ytdl-sub](https://github.com/jmbannon/ytdl-sub), and [TubeSync](https://github.com/meeb/tubesync) @@ -58,8 +61,8 @@ If it doesn't work for your use case, please make a feature request! You can als - 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](https://github.com/kieraneglin/pinchflat/wiki/Frequently-Asked-Questions#how-do-i-get-media-into-plexjellyfinkodi)) -- Supports serving RSS feeds to your favourite podcast app ([docs](https://github.com/kieraneglin/pinchflat/wiki/Podcast-RSS-Feeds)) +- First-class support for media center apps like Plex, Jellyfin, and Kodi ([docs](https://github.com/CommunityMaintained/pinchflat/wiki/Frequently-Asked-Questions#how-do-i-get-media-into-plexjellyfinkodi)) +- Supports serving RSS feeds to your favourite podcast app ([docs](https://github.com/CommunityMaintained/pinchflat/wiki/Podcast-RSS-Feeds)) - 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 @@ -67,13 +70,13 @@ If it doesn't work for your use case, please make a feature request! You can als - 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](https://github.com/kieraneglin/pinchflat/wiki/Automatically-Delete-Media)) -- Advanced options like setting cutoff dates and filtering by title ([docs](https://github.com/kieraneglin/pinchflat/wiki/Frequently-Asked-Questions#i-only-want-certain-videos-from-a-source---how-can-i-only-download-those)) +- Optionally automatically delete old content ([docs](https://github.com/CommunityMaintained/pinchflat/wiki/Automatically-Delete-Media)) +- Advanced options like setting cutoff dates and filtering by title ([docs](https://github.com/CommunityMaintained/pinchflat/wiki/Frequently-Asked-Questions#i-only-want-certain-videos-from-a-source---how-can-i-only-download-those)) - Reliable hands-off operation -- Can pass cookies to YouTube to download your private playlists ([docs](https://github.com/kieraneglin/pinchflat/wiki/YouTube-Cookies)) +- Can pass cookies to YouTube to download your private playlists ([docs](https://github.com/CommunityMaintained/pinchflat/wiki/YouTube-Cookies)) - Sponsorblock integration -- \[Advanced\] allows custom `yt-dlp` options ([docs](https://github.com/kieraneglin/pinchflat/wiki/%5BAdvanced%5D-Custom-yt%E2%80%90dlp-options)) -- \[Advanced\] supports running custom scripts when after downloading/deleting media (alpha - [docs](https://github.com/kieraneglin/pinchflat/wiki/%5BAdvanced%5D-Custom-lifecycle-scripts)) +- \[Advanced\] allows custom `yt-dlp` options ([docs](https://github.com/CommunityMaintained/pinchflat/wiki/%5BAdvanced%5D-Custom-yt%E2%80%90dlp-options)) +- \[Advanced\] supports running custom scripts when after downloading/deleting media (alpha - [docs](https://github.com/CommunityMaintained/pinchflat/wiki/%5BAdvanced%5D-Custom-lifecycle-scripts)) ## Screenshots @@ -112,9 +115,9 @@ services: 1. Create two directories on your host machine: one for storing config and one for storing downloaded media. Make sure they're both writable by the user running the Docker container. 2. Prepare the docker image in one of the two ways below: - - **From GHCR:** `docker pull ghcr.io/kieraneglin/pinchflat:latest` - - NOTE: also available on Docker Hub at `keglin/pinchflat:latest` - - **Building locally:** `docker build . --file docker/selfhosted.Dockerfile -t ghcr.io/kieraneglin/pinchflat:latest` + - **From GHCR:** `docker pull ghcr.io/communitymaintained/pinchflat:latest` + - NOTE: also available on Docker Hub at `communitymaintained/pinchflat:latest` + - **Building locally:** `docker build . --file docker/selfhosted.Dockerfile -t ghcr.io/communitymaintained/pinchflat:latest` 3. Run the container: ```bash @@ -126,7 +129,7 @@ docker run \ -p 8945:8945 \ -v /host/path/to/config:/config \ -v /host/path/to/downloads:/downloads \ - ghcr.io/kieraneglin/pinchflat:latest + ghcr.io/communitymaintained/pinchflat:latest ``` ### Podman @@ -141,26 +144,26 @@ podman run \ -p 8945:8945 \ -v /host/path/to/config:/config:rw \ -v /host/path/to/downloads/:/downloads:rw \ - ghcr.io/kieraneglin/pinchflat:latest + ghcr.io/communitymaintained/pinchflat:latest ``` Using this setup consider creating a new `pinchflat` user and giving that user ownership to the config and download directory. See [Podman --userns](https://docs.podman.io/en/v4.6.1/markdown/options/userns.container.html) docs. ### IMPORTANT: File permissions -You _must_ ensure the host directories you've mounted are writable by the user running the Docker container. If you get a permission error follow the steps it suggests. See [#106](https://github.com/kieraneglin/pinchflat/issues/106) for more. +You _must_ ensure the host directories you've mounted are writable by the user running the Docker container. If you get a permission error follow the steps it suggests. See [upstream #106](https://github.com/kieraneglin/pinchflat/issues/106) for more. > [!IMPORTANT] > It's not recommended to run the container as root. Doing so can create permission issues if other apps need to work with the downloaded media. ### ADVANCED: Storing Pinchflat config directory on a network share -As pointed out in [#137](https://github.com/kieraneglin/pinchflat/issues/137), SQLite doesn't like being run in WAL mode on network shares. If you're running Pinchflat on a network share, you can disable WAL mode by setting the `JOURNAL_MODE` environment variable to `delete`. This will make Pinchflat run in rollback journal mode which is less performant but should work on network shares. +As pointed out in [upstream #137](https://github.com/kieraneglin/pinchflat/issues/137), SQLite doesn't like being run in WAL mode on network shares. If you're running Pinchflat on a network share, you can disable WAL mode by setting the `JOURNAL_MODE` environment variable to `delete`. This will make Pinchflat run in rollback journal mode which is less performant but should work on network shares. > [!CAUTION] > Changing this setting from WAL to `delete` on an existing Pinchflat instance could, conceivably, result in data loss. Only change this setting if you know what you're doing, why this is important, and are okay with possible data loss or DB corruption. Backup your database first! -If you change this setting and it works well for you, please leave a comment on [#137](https://github.com/kieraneglin/pinchflat/issues/137)! Doubly so if it does _not_ work well. +If you change this setting and it works well for you, please open an issue or leave a comment on [upstream #137](https://github.com/kieraneglin/pinchflat/issues/137)! Doubly so if it does _not_ work well. ### Environment variables @@ -169,15 +172,15 @@ If you change this setting and it works well for you, please leave a comment on | `TZ` | No | `UTC` | Must follow IANA TZ format | | `LOG_LEVEL` | No | `debug` | Can be set to `info` but `debug` is strongly recommended | | `UMASK` | No | `022` | Unraid users may want to set this to `000` | -| `BASIC_AUTH_USERNAME` | No | | See [authentication docs](https://github.com/kieraneglin/pinchflat/wiki/Username-and-Password) | -| `BASIC_AUTH_PASSWORD` | No | | See [authentication docs](https://github.com/kieraneglin/pinchflat/wiki/Username-and-Password) | -| `EXPOSE_FEED_ENDPOINTS` | No | `false` | See [RSS feed docs](https://github.com/kieraneglin/pinchflat/wiki/Podcast-RSS-Feeds) | +| `BASIC_AUTH_USERNAME` | No | | See [authentication docs](https://github.com/CommunityMaintained/pinchflat/wiki/Username-and-Password) | +| `BASIC_AUTH_PASSWORD` | No | | See [authentication docs](https://github.com/CommunityMaintained/pinchflat/wiki/Username-and-Password) | +| `EXPOSE_FEED_ENDPOINTS` | No | `false` | See [RSS feed docs](https://github.com/CommunityMaintained/pinchflat/wiki/Podcast-RSS-Feeds) | | `ENABLE_IPV6` | No | `false` | Setting to _any_ non-blank value will enable IPv6 | | `JOURNAL_MODE` | No | `wal` | Set to `delete` if your config directory is stored on a network share (not recommended) | | `TZ_DATA_DIR` | No | `/etc/elixir_tzdata_data` | The container path where the timezone database is stored | | `BASE_ROUTE_PATH` | No | `/` | The base path for route generation. Useful when running behind certain reverse proxies - prefixes must be stripped. | | `YT_DLP_WORKER_CONCURRENCY` | No | `2` | The number of concurrent workers that use `yt-dlp` _per queue_. Set to 1 if you're getting IP limited, otherwise don't touch it | -| `ENABLE_PROMETHEUS` | No | `false` | Setting to _any_ non-blank value will enable Prometheus. See [docs](https://github.com/kieraneglin/pinchflat/wiki/Prometheus-and-Grafana) | +| `ENABLE_PROMETHEUS` | No | `false` | Setting to _any_ non-blank value will enable Prometheus. See [docs](https://github.com/CommunityMaintained/pinchflat/wiki/Prometheus-and-Grafana) | ### Reverse Proxies @@ -185,7 +188,7 @@ Pinchflat makes heavy use of websockets for real-time updates. If you're running ## EFF donations -Prior to 2024-05-10, a portion of all donations were given to the [Electronic Frontier Foundation](https://www.eff.org/). Now, the app doesn't accept donations that go to me personally and instead directs you straight to the EFF. [Here](https://github.com/kieraneglin/pinchflat/issues/234) are some people that have generously donated. +Prior to 2024-05-10, a portion of all donations were given to the [Electronic Frontier Foundation](https://www.eff.org/). Now, the app doesn't accept donations that go to me personally and instead directs you straight to the EFF. [Here](https://github.com/kieraneglin/pinchflat/issues/234) are some people that have generously donated to the original project. The EFF defends your online liberties and [backed](https://github.com/github/dmca/blob/9a85e0f021f7967af80e186b890776a50443f06c/2020/11/2020-11-16-RIAA-reversal-effletter.pdf) `youtube-dl` when Google took them down. @@ -199,5 +202,5 @@ See `LICENSE` file -[license-badge]: https://img.shields.io/github/license/kieraneglin/pinchflat?style=for-the-badge&color=ee512b +[license-badge]: https://img.shields.io/github/license/CommunityMaintained/pinchflat?style=for-the-badge&color=ee512b [license-badge-url]: LICENSE