Update README for clarity and improve installation instructions for podman and unraid.

This commit is contained in:
arabcoders 2025-06-04 22:08:52 +03:00
parent 4294070b1e
commit 5543c68e61
4 changed files with 26 additions and 5 deletions

View file

@ -2,9 +2,11 @@
![Build Status](https://github.com/ArabCoders/ytptube/actions/workflows/main.yml/badge.svg) ![Build Status](https://github.com/ArabCoders/ytptube/actions/workflows/main.yml/badge.svg)
Web GUI for [yt-dlp](https://github.com/yt-dlp/yt-dlp) with playlist & channel support. **YTPTube** is a web-based GUI for [yt-dlp](https://github.com/yt-dlp/yt-dlp), designed to make downloading videos from
YouTube and other video platforms easier and more user-friendly. It supports downloading playlists, channels, and
live streams, and includes features like scheduling downloads, sending notifications, and a built-in video player.
[![Short screenshot](https://raw.githubusercontent.com/ArabCoders/ytptube/master/sc_short.png)](https://raw.githubusercontent.com/ArabCoders/ytptube/master/sc_full.png) ![Short screenshot](https://raw.githubusercontent.com/ArabCoders/ytptube/master/sc_short.png)
# YTPTube Features. # YTPTube Features.
@ -30,7 +32,9 @@ Web GUI for [yt-dlp](https://github.com/yt-dlp/yt-dlp) with playlist & channel s
* Apply `yt-dlp` options per custom defined conditions. * Apply `yt-dlp` options per custom defined conditions.
* Custom browser extensions, bookmarklets and iOS shortcuts to send links to YTPTube instance. * Custom browser extensions, bookmarklets and iOS shortcuts to send links to YTPTube instance.
# Run using docker command # Installation
## Run using docker command
```bash ```bash
mkdir -p ./{config,downloads} && docker run -d --rm --user "$UID:${GID-$UID}" --name ytptube \ mkdir -p ./{config,downloads} && docker run -d --rm --user "$UID:${GID-$UID}" --name ytptube \
@ -38,7 +42,13 @@ mkdir -p ./{config,downloads} && docker run -d --rm --user "$UID:${GID-$UID}" --
ghcr.io/arabcoders/ytptube:latest ghcr.io/arabcoders/ytptube:latest
``` ```
# Using compose file 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. The following is an example of a `compose.yaml` file that can be used to run YTPTube.
@ -58,12 +68,24 @@ services:
- /tmp - /tmp
``` ```
> [!IMPORTANT]
> Make sure to change the `user` line to match your user id and group id
```bash ```bash
$ mkdir -p ./{config,downloads} && docker compose -f compose.yaml up -d $ mkdir -p ./{config,downloads} && docker compose -f compose.yaml up -d
``` ```
Then you can access the WebUI at `http://localhost:8081`. 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.
# Browser extensions & bookmarklets # Browser extensions & bookmarklets
## Simple bookmarklet ## Simple bookmarklet

View file

@ -1688,7 +1688,6 @@ class HttpAPI(Common):
}, },
) )
except Exception as e: except Exception as e:
LOG.exception(e)
LOG.error(f"Failed to request random background image from '{backend!s}'.'. '{e!s}'.") LOG.error(f"Failed to request random background image from '{backend!s}'.'. '{e!s}'.")
return web.json_response( return web.json_response(
data={"error": "failed to retrieve the random background image."}, data={"error": "failed to retrieve the random background image."},

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.9 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 638 KiB

After

Width:  |  Height:  |  Size: 675 KiB