106 lines
4.4 KiB
Markdown
106 lines
4.4 KiB
Markdown
# YTPTube
|
|
|
|
|
|
|
|
|
|
|
|
**YTPTube** is a web-based GUI for [yt-dlp](https://github.com/yt-dlp/yt-dlp), designed to make downloading videos from
|
|
video platforms easier and user-friendly. It supports downloading playlists, channels, live streams and
|
|
includes features like scheduling downloads, sending notifications, and built-in video player.
|
|
|
|
|
|
|
|
# YTPTube Features.
|
|
|
|
* Multi-download support.
|
|
* Random beautiful background.
|
|
* Handles live and upcoming streams.
|
|
* Schedule channels or playlists to be downloaded automatically with support for creating custom download feeds from non-supported sites. See [Feeds documentation](FAQ.md#how-can-i-monitor-sites-without-rss-feeds).
|
|
* Send notification to targets based on selected events. includes [Apprise](https://github.com/caronc/apprise?tab=readme-ov-file#readme) support.
|
|
* Support per link options.
|
|
* Support for limits per extractor and overall global limit.
|
|
* Queue multiple URLs at once.
|
|
* Powerful presets system for applying `yt-dlp` options. with a pre-made preset for media servers users.
|
|
* A simple file browser.
|
|
* A built in video player **with support for sidecar external subtitles**.
|
|
* Basic authentication support.
|
|
* Supports `curl-cffi`. See [yt-dlp documentation](https://github.com/yt-dlp/yt-dlp?tab=readme-ov-file#impersonation)
|
|
* Bundled `pot provider plugin`. See [yt-dlp documentation](https://github.com/yt-dlp/yt-dlp/wiki/PO-Token-Guide)
|
|
* Automatic updates for `yt-dlp` and custom `pip` packages.
|
|
* Conditions feature to apply custom options based on `yt-dlp` returned info.
|
|
* Custom browser extensions, bookmarklets and iOS shortcuts to send links to YTPTube instance.
|
|
* A bundled executable version for Windows, macOS and Linux. `For non-docker users`.
|
|
|
|
Please read the [FAQ](FAQ.md) for more information.
|
|
|
|
# Installation
|
|
|
|
## Run using docker command
|
|
|
|
```bash
|
|
mkdir -p ./{config,downloads} && docker run -d --rm --user "${UID}:${UID}" --name ytptube \
|
|
-p 8081:8081 -v ./config:/config:rw -v ./downloads:/downloads:rw \
|
|
ghcr.io/arabcoders/ytptube:latest
|
|
```
|
|
|
|
Then you can access the WebUI at `http://localhost:8081`.
|
|
|
|
> [!NOTE]
|
|
> If you are using `podman` instead of `docker`, you can use the same command, but you need to change the user to `0:0`
|
|
> it will appears to be running as root, but it will run as the user who started the container.
|
|
|
|
## Using compose file
|
|
|
|
The following is an example of a `compose.yaml` file that can be used to run YTPTube.
|
|
|
|
```yaml
|
|
services:
|
|
ytptube:
|
|
user: "${UID:-1000}:${UID:-1000}" # change this to your user id and group id, for example: "1000:1000"
|
|
image: ghcr.io/arabcoders/ytptube:latest
|
|
container_name: ytptube
|
|
restart: unless-stopped
|
|
ports:
|
|
- "8081:8081"
|
|
volumes:
|
|
- ./config:/config:rw
|
|
- ./downloads:/downloads:rw
|
|
tmpfs:
|
|
- /tmp
|
|
```
|
|
|
|
> [!IMPORTANT]
|
|
> Make sure to change the `user` line to match your user id and group id
|
|
|
|
```bash
|
|
$ mkdir -p ./{config,downloads} && docker compose -f compose.yaml up -d
|
|
```
|
|
|
|
Then you can access the WebUI at `http://localhost:8081`.
|
|
|
|
> [!NOTE]
|
|
> you can use podman-compose instead of docker-compose, as it supports the same syntax. However, you should change the
|
|
> user to `0:0` it will appears to be running as root, but it will run as the user who started the container.
|
|
|
|
## Unraid
|
|
|
|
For `Unraid` users You can install the `Community Applications` plugin, and search for **ytptube** it comes
|
|
pre-configured.
|
|
|
|
# API Documentation
|
|
|
|
For simple API documentation, you can refer to the [API documentation](API.md).
|
|
|
|
# Disclaimer
|
|
|
|
This project is not affiliated with yt-dlp, or any other service. It's a personal project that was created to
|
|
make downloading videos from the internet easier. It's not intended to be used for piracy or any other illegal activities.
|
|
|
|
# Social contact
|
|
|
|
If you have short or quick questions, you are free to join my [discord server](https://discord.gg/G3GpVR8xpb) and ask
|
|
the question. keep in mind it's solo project, as such it might take me a bit of time to reply.
|
|
|
|
# Donation
|
|
|
|
If you feel like donating and appreciate my work, you can do so by donating to children charity. For example [Make-A-Wish](https://worldwish.org).
|