Skip to content

Commit 7998815

Browse files
committed
fix(docker): Unintentional unattended dry runs
[PR feedback](#1321 (comment)) 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.
1 parent 7cae94a commit 7998815

File tree

1 file changed

+9
-6
lines changed
  • docker/root/defaults

1 file changed

+9
-6
lines changed

docker/root/defaults/cron

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,12 @@
44
# default `./config.yaml` and `./subscriptions.yaml`, so you don't need to use the
55
# `--config` CLI option or pass a `SUBPATH` to the `$ ytdl-sub sub` sub-command.
66
#
7-
# To prevent users accidentally triggering throttles or bans or downloading before
8-
# testing their configuration, these default options only simulate a few
9-
# downloads. Remove the `--dry-run` and `-o ...` CLI options when you've tested your
10-
# configuration and you're ready to download entries unattended:
11-
12-
ytdl-sub --dry-run sub -o '--ytdl_options.max_downloads 3'
7+
# Test your configuration and subscriptions carefully before automating downloads to
8+
# prevent triggering throttles or bans:
9+
#
10+
# https://ytdl-sub.readthedocs.io/en/latest/guides/getting_started/downloading.html
11+
#
12+
# Once you've tested your configuration and you're ready to download entries unattended,
13+
# remove the next line and un-comment the following line:
14+
echo "WARNING: Read /config/ytdl-sub-configs/cron and modify to automate downloads."
15+
# ytdl-sub sub

0 commit comments

Comments
 (0)