Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/qdm12/youtube-dl-docker

Download with youtube-dl using command line arguments or a configuration file + Automated updates
https://github.com/qdm12/youtube-dl-docker

alpine docker docker-youtube-dl ffmpeg youtube-dl

Last synced: about 1 month ago
JSON representation

Download with youtube-dl using command line arguments or a configuration file + Automated updates

Host: GitHub
URL: https://github.com/qdm12/youtube-dl-docker
Owner: qdm12
License: mit
Created: 2018-02-17T20:37:17.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2023-07-09T13:20:01.000Z (about 1 year ago)
Last Synced: 2024-06-28T06:37:33.568Z (3 months ago)
Topics: alpine, docker, docker-youtube-dl, ffmpeg, youtube-dl
Language: Shell
Homepage: https://hub.docker.com/r/qmcgaw/youtube-dl-alpine/
Size: 182 KB
Stars: 45
Watchers: 6
Forks: 17
Open Issues: 0
Metadata Files:
- Readme: readme.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        # Docker Youtube-DL Alpine

*Download with [**yt-dlp**](https://github.com/yt-dlp/yt-dlp) using command line arguments or configuration files*

[![Docker Youtube-DL](https://github.com/qdm12/youtube-dl-docker/raw/master/title.png)](https://hub.docker.com/r/qmcgaw/youtube-dl-alpine/)

[![Build status](https://github.com/qdm12/youtube-dl-docker/actions/workflows/ci.yml/badge.svg)](https://github.com/qdm12/youtube-dl-docker/actions/workflows/ci.yml/badge.svg)

[![Docker Pulls](https://img.shields.io/docker/pulls/qmcgaw/youtube-dl-alpine.svg)](https://hub.docker.com/r/qmcgaw/youtube-dl-alpine)

[![Docker Stars](https://img.shields.io/docker/stars/qmcgaw/youtube-dl-alpine.svg)](https://hub.docker.com/r/qmcgaw/youtube-dl-alpine)

[![Docker Automated](https://img.shields.io/docker/automated/qmcgaw/youtube-dl-alpine.svg)](https://hub.docker.com/r/qmcgaw/youtube-dl-alpine)

[![GitHub last commit](https://img.shields.io/github/last-commit/qdm12/youtube-dl-docker.svg)](https://github.com/qdm12/youtube-dl-docker/issues)

[![GitHub commit activity](https://img.shields.io/github/commit-activity/y/qdm12/youtube-dl-docker.svg)](https://github.com/qdm12/youtube-dl-docker/issues)

[![GitHub issues](https://img.shields.io/github/issues/qdm12/youtube-dl-docker.svg)](https://github.com/qdm12/youtube-dl-docker/issues)

[![Donate PayPal](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://paypal.me/qmcgaw)

## Features

- Works with command line arguments to *youtube-dl*

- Compatible with AMD64, 386, ARM v6/v7/v8 CPU architectures

- Small Docker image based on

  - [Alpine 3.18](https://alpinelinux.org)

  - [Youtube-dl](https://github.com/yt-dlp/yt-dlp)

  - [ffmpeg 6.0](https://pkgs.alpinelinux.org/package/v3.18/community/x86_64/ffmpeg)

  - [Ca-Certificates](https://pkgs.alpinelinux.org/package/v3.18/main/x86_64/ca-certificates)

  - [Python 3.11.4](https://pkgs.alpinelinux.org/package/v3.18/main/x86_64/python3)

- The container updates youtube-dl at launch if `-e AUTOUPDATE=yes`

- Docker healthcheck downloading `https://duckduckgo.com` with `wget` every 10 minutes

- You can receive a notification on your Android device through Gotify when the *youtube-dl* has finished

## Setup

1. Run the container with

    ```bash

    docker run -d -v $(pwd)/yourdir:/downloads qmcgaw/youtube-dl-alpine \

    https://www.youtube.com/watch?v=HagVnWAeGcM \

    -o "/downloads/%(title)s.%(ext)s"

    ```

    or use [docker-compose.yml](https://github.com/qdm12/youtube-dl-docker/blob/master/docker-compose.yml) with

    ```bash

    docker-compose up -d

    ```

1. See the [youtube-dl command line options](https://github.com/rg3/youtube-dl/blob/master/README.md#options)

1. By default the container runs as user ID `1000` in order to not run as `root`.

If you encounter permission issues with your bind mounted `yourdir` directory, either:

    - Change the ownership and permission of your directory to match user id `1000`:

        ```sh

        chown 1000 yourdir && chmod 700 yourdir

        ```

    - Run the container with the user ID owning `yourdir`, for example with the Docker flag `--user=1030`.

### Environment variables

| Environment variable | Default | Description |

| --- | --- | --- |

| `AUTOUPDATE` | `no` | Updates youtube-dl to the latest version at launch |

| `GOTIFYURL` |  | Gotify server URL address (i.e. `http://192.168.1.5:8000` or `https://a.com/gotify`) |

| `GOTIFYTOKEN` |  | Gotify server Token |

### Downloads directory permission issues

You can either:

- Change the ownership and permissions of `./downloads` on your host with:

    ```sh

    chown 1000 -R ./downloads

    chmod 700 ./downloads

    chmod -R 600 ./downloads/*

    ```

- Launch the container as `root` user using `--user=root`

### Authenticate with Netrc file

To authenticate you can bind mount a [`.netrc` file](https://github.com/ytdl-org/youtube-dl/blob/master/README.md#authentication-with-netrc-file).

You should, on your host, set the right ownership and permissions as follow:

```sh

chown 1000:1000 .netrc

chmod 600 .netrc

```

And then bind mount it with `-v "$(pwd)/.netrc:/.netrc:ro"` and youtube-dl will pick it up.

## TODOs

- [ ] Healthcheck to check ydl logs

- [ ] Colors in terminal