ff66ff5be0
* docs(docker): Recommended image DEFAULT_WORKSPACE * fix(docker): Add default crontab download command Clarify the `/config/ytdl-sub-configs/cron` script with explanatory comments and a default `--dry-run` command. Also change the wrapper script to echo commands for easier debugging. To update an existing script, move the old script aside, restart the container to regenerate it, and edit the new script. Also clarify the Automating page in the Getting Started guide docs. * fix(docker): Unintentional unattended dry runs [PR feedback](https://github.com/jmbannon/ytdl-sub/pull/1321#discussion_r2315215600) prompted me to reconsider having a default command at all. We should assume, unfortunately, that many new users will just skim the docs enough to enable the image's cron integration but not actually incrementally test their configuration. In those cases, they'd end up sending dry-run non-download requests for all their subscriptions every 6 hours for no good reason. There's just no way to provide a default command that isn't also providing a footgun. * docs(docker): More open cron schedule generator From [PR feedback](https://github.com/jmbannon/ytdl-sub/pull/1321#discussion_r2320521024), this seems like less of an ad than the previous and the source for the page is itself open source. * docs(docker): Document image environment footgun From [PR feedback](https://github.com/jmbannon/ytdl-sub/pull/1321#discussion_r2320515419). * docs(automate): Avoid external link 404 responses * docs(automate): False simultaneous run warning * docs(automate): Clarify Docker daemon restarts * docs(automate): Revert run start non-recommended * docs(automate): Remove footgun manual run command Addressing this underlying issue requires more thought and should be a separate PR. * docs(automate): Restore env var footgun in example
101 lines
3 KiB
YAML
101 lines
3 KiB
YAML
###############################################################################
|
|
# Top-level configurations to apply umask and write log files
|
|
configuration:
|
|
umask: "002"
|
|
persist_logs:
|
|
logs_directory: '/config/logs'
|
|
keep_successful_logs: False
|
|
|
|
presets:
|
|
|
|
###############################################################################
|
|
# Set tv_show_directory here instead of in the subscriptions file
|
|
tv_show_paths:
|
|
overrides:
|
|
tv_show_directory: "/tv_shows"
|
|
|
|
###############################################################################
|
|
# Filter out any YouTube shorts
|
|
no_shorts:
|
|
match_filters:
|
|
filters:
|
|
- "original_url!*=/shorts/"
|
|
|
|
###############################################################################
|
|
# Remove all the following sponsorblock sections
|
|
sponsorblock:
|
|
chapters:
|
|
sponsorblock_categories:
|
|
- "outro"
|
|
- "selfpromo"
|
|
- "preview"
|
|
- "interaction"
|
|
- "sponsor"
|
|
- "music_offtopic"
|
|
- "intro"
|
|
remove_sponsorblock_categories: "all"
|
|
force_key_frames: False
|
|
|
|
###############################################################################
|
|
# Wait 2 days before downloading in hopes to get more accurate sponsorblock
|
|
sponsorblock_wait:
|
|
# Import the sponsorblock preset defined above
|
|
preset:
|
|
- "sponsorblock"
|
|
|
|
date_range:
|
|
before: "today-2days"
|
|
|
|
|
|
###############################################################################
|
|
# base preset to use on all TV Show-based subscriptions
|
|
base:
|
|
preset:
|
|
- "Kodi TV Show by Date" # Set intended player
|
|
- "best_video_quality" # prebuilt preset to get best quality
|
|
- "tv_show_paths"
|
|
|
|
# Embed chapters into video files
|
|
chapters:
|
|
embed_chapters: True
|
|
|
|
# Embed English subtitles into video files (supports more)
|
|
subtitles:
|
|
embed_subtitles: True
|
|
languages:
|
|
- "en"
|
|
allow_auto_generated_subtitles: True
|
|
|
|
# ytdl_options lets you pass any arg into yt-dlp's Python API
|
|
ytdl_options:
|
|
# Set the cookie file
|
|
# cookiefile: "/config/ytdl-sub-configs/youtube_cookies.txt"
|
|
|
|
# For YouTube, get English metadata if multiple languages are present
|
|
extractor_args:
|
|
youtube:
|
|
lang:
|
|
- "en"
|
|
|
|
###############################################################################
|
|
# Custom preset to archive an entire channel
|
|
TV Show Full Archive:
|
|
preset:
|
|
- "base"
|
|
- "sponsorblock_wait" # wait for sponsorblock when full-archiving
|
|
|
|
###############################################################################
|
|
# Custom preset to only fetch and keep recent videos.
|
|
# Format the videos in reverse order, so the first video is the most recent
|
|
# Also include the prebuilt "Only Recent" preset
|
|
TV Show Only Recent:
|
|
preset:
|
|
- "base"
|
|
- "sponsorblock"
|
|
- "no_shorts"
|
|
- "season_by_year__episode_by_month_day_reversed"
|
|
- "Only Recent"
|
|
|
|
overrides:
|
|
only_recent_date_range: "2months"
|
|
only_recent_max_files: 30
|