l1ving_youtube-dl/docker/README.md

## youtube-dl
youtube-dl - download videos from youtube.com or other video platforms

## Quick Start
**NOTE**: The docker command provided in this quick start is given as an example, and parameters should be adjusted to your needs.

It is suggested to configure an alias as follows (and place into your `.bash_aliases` file):

```
alias youtube-dl='docker run \
                  --rm -i \
                  -e PGID=$(id -g) \
                  -e PUID=$(id -u) \
                  -v $(pwd):/workdir:rw \
                  ytdl-org/youtube-dl'
```

When run (eg: `youtube-dl https://www.youtube.com/watch?v=dQw4w9WgXcQ`), it will download the video to the current working directory, and take any command line arguments that the normal youtube-dl binary would.

## Using a config file

To prevent having to specify many command line arguments every time you run youtube-dl, you may wish to have an external configuation file.

In order for the docker container to use the configuration file, it must be mapped through to the container.

```
docker run \
    --rm -i \
    -e PGID=$(id -g) \
    -e PUID=$(id -u) \
    -v /path/to/downloaded/videos:/workdir:rw \
    -v /path/to/youtube-dl.conf:/etc/youtube-dl.conf:ro \
    ytdl-org/youtube-dl
```

Where:
* `/path/to/downloaded/videos` is where youtube-dl will download videos to (use `$(pwd)` to downloade to current working directory.
* `/path/to/youtube-dl.conf` is the path to your youtube-dl.conf file.

## Environment Variables

To customize some properties of the container, the following environment variables can be passed via the `-e` parameter (one for each variable). This paramater has the format `<VARIABLE_NAME>=<VALUE>`.

| Variable | Description | Recommended Setting |
|----------|-------------|---------------------|
| PGID     | The Group ID that the `youtube-dl` process will run as | `$(id -u)` for the current user's GID |
| PUID     | The User ID that the `youtube-dl` process will run as | `$(id -g)` for the current user's UID |

## Authentication using .netrc

If you want to download videos that require authentication (or your youtube subscriptions for example, see below), it is recommended to use a .netrc file.

You can create a file with the following syntax:

```
machine youtube login USERNAME password PASSWORD
```

Where:
* `USERNAME` is replaced with your youtube account username
* `PASSWORD` is replaced with your youtube account password

You may need to disable some account security settings (such as '2-Step Verification' and 'Use your phone to sign in', so it is suggested to make a long, complex password (eg: 32 random characters).

This file can then be mapped through to the container as a .netrc file, eg:

```
docker run \
    --rm -i \
    -e PGID=$(id -g) \
    -e PUID=$(id -u) \
    -v /path/to/downloaded/videos:/workdir:rw \
    -v /path/to/youtube-dl.conf:/etc/youtube-dl.conf:ro \
    -v /path/to/netrc_file:/home/dockeruser/.netrc:ro
    ytdl-org/youtube-dl
```

## Data Volumes

There are no data volumes explicity set in the Dockerfile, however:

| Container Path | Permissions | Description |
|----------------|-------------|-------------|
| `/workdir` | rw | The `youtube-dl` process is executed with a working directory of `/workdir`. Thus, unless you override the output directory with the `--output` argument on the command line or via a configuration file, videos will end up in this directory. |
| `/etc/youtube-dl.conf` | ro | The `youtube-dl` process will look in this location for a configuration file by default. |
| `/home/dockeruser/.netrc` | ro | The `youtube-dl` process will look in this location for a .netrc file (if `--netrc` is specified on the command line or via a configuration file). |

## Scheduled download of youtube subscriptions

In order to perform a scheduled download of youtube subscriptions, it is recommended to use the following command to be executed via cron on a regular basis (eg: daily).

```
docker run \
    --rm 
    -i 
    --name youtube-dl-cron 
    -e PGID=GID 
    -e PUID=UID
    --cpus CPUS 
    -v /path/to/netrc:/home/dockeruser/.netrc:ro 
    -v /path/to/youtube/subscriptions:/workdir:rw
    -v /path/to/youtube-dl.conf:/etc/youtube-dl.conf:ro 
    mikenye/youtube-dl \
    :ytsubscriptions \
    --dateafter now-5days \
    --download-archive /workdir/.youtube-dl-archive \
    --cookies /workdir/cookiejar.dat \
    --netrc \
    --limit-rate 5000 2>> /path/to/logs/youtube-dl.err >> /path/to/logs/youtube-dl.log
```

Where:
* `GID`: a group ID to run as (if in a normal user's crontab, use `$(id -g)`
* `UID`: a user ID to run as (if in a normal user's crontab, use `$(id -u)`
* `CPUS`: the number of CPUs to constrain the docker container to. This may be required to prevent impacting system performance if transcoding takes place. If not, the `--cpus` argument can be completely omitted.
* `/path/to/netrc`: the path to the file containing your youtube credentials, see above.
* `/path/to/youtube/subscriptions`: the path where videos will be saved.
* `/path/to/youtube-dl.conf`: the path to your `youtube-dl.conf` file, where settings such as output file naming, quality, etc can be determined.
* `/path/to/logs/youtube-dl.err`: the path to the error log, if desired
* `/path/to/logs/youtube-dl.log`: the path to the application log, if desired

Notes:
* `--rm` is given so the container is destroyed when execution is finished. This will prevent your drive from slowly filling up with exited containers.
* `--name youtube-dl-cron` is given so that multiple instances are not started by cron. In the event the previous container is still running, docker will simply exit with an error that the container name is already taken.
* `--dateafter now-5days` is given to limit youtube-dl to only download recent videos. Feel free to adjust as required.
* `--limit-rate` is given to prevent impacting your internet connection. Feel free to adjust as required.

In the example above, a configuration file is used. This allows us to easily add commands to select a specific quality, and name the videos with a specific format. For example, to download the videos into a format recognised by Plex, you could use the following:

```
-v
--ignore-errors
--no-overwrites
--continue
--no-post-overwrites
--add-metadata
--write-thumbnail
--playlist-reverse
--write-description
--write-info-json
--write-annotations
--format "best[height<=?1080]"
--fixup fix
--output '/workdir/%(uploader)s/%(uploader)s - %(upload_date)s - %(title)s - %(id)s.%(ext)s'
```

The above example config file will:
* Ignore errors
* Will not overwrite existing videos
* Will continue downloading in the event a download is interrupted
* Will download metadata and embed into the resulting video, so that Plex will be able to display this information
* Will download oldest videos first, so videos can be sorted by "date added" in Plex
* Will download the best quality up to a maximum of 1080p (prevent 4K downloads)
* Will format videos with a separate folder for each uploader.

## Ports

No port mappings are required for this container.

## Docker Image Update

If the system on which the container runs doesn't provide a way to easily update the Docker image (eg: watchtower), simply pull the latest version of the container:

```
docker pull ytdl-org/youtube-dl
````

## Shell access

To get shell access to a running container, execute the following command:

```
docker exec -ti CONTAINER sh 
```

Where `CONTAINER` is the name of the running container.

To start a container with a shell (instead of `youtube-dl`), execute the following command:

```
docker run --rm -ti --entrypoint=/bin/sh ytdl-org/youtube-dl
```

## Support or Contact

Having troubles with the container or have questions? Please create a new issue on our github.