Skip to content

Latest commit

 

History

History
121 lines (97 loc) · 5.3 KB

README.md

File metadata and controls

121 lines (97 loc) · 5.3 KB
Raw

Jeeaaasus - youtube-dl

Docker Automated build Image Size Docker Pulls Docker Stars

Automated youtube-dl Docker image for downloading YouTube subscriptions

Docker hub page here.
youtube-dl documentation here.

Features

  • Easy Usage with Minimal Setup
    • Quality options with env parameter
    • Included format selection argument
    • Included set of starter arguments
  • Automatic Updates
    • Self updating container
    • Automated image building
  • Automatic Downloads
    • Interval options with env parameter
    • Channel URLs from file
  • PUID/PGID
  • youtube-dl Options
    • Format
    • Quality
    • High fps videos
    • Download archive
    • Output
    • Subtitles
    • Thumbnails
    • Geo bypass
    • Proxy support
    • Metadata
    • Etc

Usage

docker run -d \
    --name youtube-dl \
    -v youtube-dl_data:/config \
    -v <PATH>:/downloads \
    jeeaaasustest/youtube-dl

Then configure the channels as explained in the Configure youtube-dl section below.

Explanation

  • -v youtube-dl_data:/config
    This makes a Docker volume where your config files are saved, named: youtube-dl_data.

  • -v <PATH>:/downloads
    This makes a bind mount where the videos are downloaded.

    This is where on your Docker host you want youtube-dl to download videos.
    Replace <PATH>, example: -v /media/youtube-dl:/downloads

Env Parameters

-e <Parameter>=<Value>

Parameter Value (Default) What it does
TZ Europe/London Specify TimeZone for the log timestamps to be correct.
PUID (911) If you need to specify UserID for file permission reasons.
PGID (911) If you need to specify GroupID for file permission reasons.
youtubedl_debug true (false) If you want to enable verbose mode.
youtubedl_interval 1h (3h) 12h 3d If you want to change the default download interval. 1 hour, (3 hours), 12 hours, 3 days.
youtubedl_quality 720 (1080) 1440 2160 If you want to change the default download resolution. 720p, (1080p), 1440p, 4k.

Image Tags

  • latest
    • Automatically built when a youtube-dl version is released.
    • Container updates to latest youtube-dl while running.
  • v<VERSION>
    • Automatically built when a youtube-dl version is released.
    • Does not update.

Configure youtube-dl

  • channels.txt

    File location: /config/channels.txt.
    This is where you input all the YouTube channels you want to have videos downloaded from.

    # One per line
# Name
https://www.youtube.com/user/channel_username/videos
# Another one
https://www.youtube.com/channel/UC0vaVaSyV14uvJ4hEZDOl0Q/videos

    Adding with Docker:
    docker exec youtube-dl bash -c 'echo "# NAME" >> ./channels.txt'
    docker exec youtube-dl bash -c 'echo "URL" >> ./channels.txt'

    It is recommended to use the ID-based URLs, they look like: /channel/UC0vaVaSyV14uvJ4hEZDOl0Q, as the other ones might get changed. You find the ID-based URL by going to a video and clicking on the uploader.

    All channel URLs must end with /videos, otherwise you will download "related" channels and other things.
    This should be added automatically but still recommend you add it to the end of all channel URLs.

  • archive.txt

    File location: /config/archive.txt.   delete to make youtube-dl forget downloaded videos
    This is where youtube-dl stores all previously downloaded video IDs.

  • args.conf

    File location: /config/args.conf.   delete and restart container to restore default arguments
    This is where all youtube-dl execution arguments are, you can add or remove them however you like, exceptions being that --config-location and --batch-file cannot be used.

    Keep in mind that if you define --format, the ENV youtubedl_quality is not used anymore.

    The default --playlist-end 8 makes youtube-dl only download the latest 8 videos. Be careful changing this! YouTube may feel like you are making too many requests and therefore ip banning you.

    The default --match-filter "! is_live" makes youtube-dl ignore live streams.

    Don't want a folder for every channel? Change the line with --output to suit your needs.

    Don't want mp4 files? Change the line with --merge-output-format to suit your needs.

    youtube-dl configuration options documentation here.