Skip to content

Download videos for use with local media server such as Plex

Notifications You must be signed in to change notification settings

digitalcraig/vidgrab

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Vidgrab

Vidgrab will automatically back up channels/videos on any site supported by yt-dlp (a fork of youtube-dl):

Environment variables:

  • DOWNLOAD_RATE - set maximum download rate.
  • DOWNLOAD_SUBS - set to 'yes' (default value) to download and embed any subtitles. Set to 'no' to ignore subtitles.
  • APPRISE_SERVICE - if set, the container will send notifications to chosen service via Apprise. See Apprise documentation for details.
  • SLEEP_INTERVAL - default to 1d (1 day) to sleep before restarting after downloads complete.
  • EXTRA_ARGS - pass any additional arguments to yt-dlp.

Files and directories in volume mounted at /downloads:

  • cookies.txt (created if missing) - Use an extension like cookies.txt to save cookies.txt to acccess videos requiring authentication.
  • channels.txt (created if missing) - URLs, one per line, of individual videos, playlists, or channels to be downloaded.
  • archive.txt (created if missing) - Saves ID of downloaded videos so they will not be downloaded again.
  • Videos will be downloaded:
    • uploader/uploader - upload_date - title.ext

Docker Compose

Example docker-compose.yaml:

vidgrab:
  image: digitalcraig/vidgrab
  container_name: vidgrab
  environment:
    - DOWNLOAD_RATE=500K
    - APPRISE_SERVICE=discord://webhook_id/webhook_token
    - SLEEP_INTERVAL=1d
  volumes:
    - /path/to/download/directory:/downloads
  restart: unless-stopped

Example docker-compose.yaml which only downloads videos from the past week from a playlist:

vidgrab:
  image: digitalcraig/vidgrab
  container_name: vidgrab
  environment:
    - DOWNLOAD_RATE=500K
    - APPRISE_SERVICE=discord://webhook_id/webhook_token
    - SLEEP_INTERVAL=1d
    - EXTRA_ARGS="--dateafter now-1week --playlist-reverse"
  volumes:
    - /path/to/download/directory:/downloads
  restart: unless-stopped

To execute in background, run docker-compose with -d :

$ docker-compose up -d

Use with Plex

Videos can be downloaded and played with Plex by creating a TV Show library and installing the Extended Personal Media Scanner. See scanner documentation for details.

Credits

Based on Docker image for yt-dlp, originally forked from timlinden.

About

Download videos for use with local media server such as Plex

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Shell 95.7%
  • Dockerfile 4.3%