cleanup FAQ and README

This commit is contained in:
arabcoders 2025-09-16 16:15:07 +03:00
parent 314752a644
commit 816fd55397
2 changed files with 4 additions and 13 deletions

9
FAQ.md
View file

@ -85,10 +85,6 @@ the `yt-dlp` output and attempt to download the media directly to your iOS devic
starting point for those who want to download media directly to their iOS device. We provide no support for this use case
other than the shortcut itself. this shortcut missing support for parsing the http_headers, it's only parse the cookies.
# Authentication
To enable basic authentication, set the `YTP_AUTH_USERNAME` and `YTP_AUTH_PASSWORD` environment variables. And restart
@ -97,11 +93,6 @@ As this is a simple basic authentication, if your browser doesn't show the promp
`http://username:password@your_ytptube_url:port`
# Basic mode
What does the basic mode do? it basically strips down the interface to the bare minimum,
to make it easier for non-technical users to use it.
# I cant download anything
If you are receiving errors like:

View file

@ -5,8 +5,8 @@
![Docker pull](https://ghcr-badge.elias.eu.org/shield/arabcoders/ytptube/ytptube)
**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.
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.
![Short screenshot](https://raw.githubusercontent.com/ArabCoders/ytptube/master/sc_short.png)
@ -38,7 +38,7 @@ Please read the [FAQ](FAQ.md) for more information.
## Run using docker command
```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}:${UID}" --name ytptube \
-p 8081:8081 -v ./config:/config:rw -v ./downloads:/downloads:rw \
ghcr.io/arabcoders/ytptube:latest
```
@ -93,7 +93,7 @@ For simple API documentation, you can refer to the [API documentation](API.md).
# Disclaimer
This project is not affiliated with YouTube, yt-dlp, or any other service. It's a personal project that was created to
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