Commit graph

50 commits

Author SHA1 Message Date
Ross Patterson
ff66ff5be0
fix(docker): Add default crontab download command (#1321)
* 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
2026-03-09 09:27:27 -07:00
Jesse Bannon
a68d5e4539
[FEATURE] Emby prebuilt presets (#1232)
Gives Emby first class support by creating prebuilt presets for each variant, including
- `Emby TV Show by Date`
- `Emby TV Show Collection`
- `Emby Music Videos`

Emby is identical to Jellyfin except in TV Show Collection, where it requires a `season.nfo`. A new plugin `StaticNfoTags` has been created to create those.

Huge thanks to @Kamaroth92 for the initial code for this feature!
2025-06-01 09:56:48 -07:00
Jesse Bannon
083db0d9dc
[FEATURE] Simplify TV Show Collection Preset (#953)
Simplifies TV Show Collection presets, drastically. Old version:
```
  rick_a_tv_show_collection:
    preset:
      - "jellyfin_tv_show_collection"
      - "season_by_collection__episode_by_year_month_day_reversed"
      - "collection_season_1"
      - "collection_season_2"
    overrides:
      tv_show_name: "Rick A"
      collection_season_1_url: "https://www.youtube.com/channel/UCuAXFkgsw1L7xaCfnd5JJOw"
      collection_season_1_name: "All Videos"
      collection_season_2_url: "https://www.youtube.com/playlist?list=PLlaN88a7y2_plecYoJxvRFTLHVbIVAOoc"
      collection_season_2_name: "Official Music Videos"
```

New version:
```
  Jellyfin TV Show Collection:
    "~Rick A":
      s01_name: "All Videos"
      s01_url: "https://www.youtube.com/channel/UCuAXFkgsw1L7xaCfnd5JJOw"
      s02_name: "Official Music Videos"
      s02_url: "https://www.youtube.com/playlist?list=PLlaN88a7y2_plecYoJxvRFTLHVbIVAOoc"
```
2024-03-30 22:04:45 -07:00
Jesse Bannon
248e9a15a6
[DOCS] Various doc cleanups (#928) 2024-02-17 08:53:06 -08:00
Jesse Bannon
1fcaba9274
[DOCS] Update links to reflect doc-upgrade (#858) 2023-12-27 11:07:11 -08:00
Jesse Bannon
544af2207b
[FEATURE] Add output_options.keep_max_files to limit number of downloads per subscription (#820)
Adds a new mechanism to limit subscriptions' number of videos to an explicit number (only supported date ranges prior to this).

Example usage:
```
output_options:
  keep_max_files: 10
```
will only keep 10 videos at max.

In addition:
- `keep_max_files` is bundled into the `Only Recent` preset and can be used via setting the `only_recent_max_files` override variable (see examples or README for usage).
- Changed the `date_range` variable name to `only_recent_date_range` for more clarity.  Usage of `date_range` will continue to work.
2023-11-17 09:01:21 -08:00
Jesse Bannon
19eee28f4a
[DOCKER] New default config/subscription in Docker (#798)
The default subscription file in the docker container now matches the one in the repo's README
2023-11-03 17:14:38 -07:00
Jesse Bannon
e9b2214a0a
[DOCS] New README with only subscriptions (#791) 2023-11-02 23:28:55 -07:00
Jesse Bannon
4339807bc9
[DOCS] Unraid in readme (#581) 2023-04-05 12:39:35 -07:00
myztillx
4795564a0c
[DOCS] Fix typo in One-time Download (#579)
There was a typo in the shell command in the One-time Download section.
2023-04-04 09:06:58 -07:00
Jesse Bannon
a96fcff55f
[DOCS] passthrough in README (#549) 2023-03-15 16:12:42 -07:00
Jesse Bannon
76c0097104
[DOCS] Install links to readthedocs (#492) 2023-03-01 21:10:07 -08:00
Jesse Bannon
fea3f86acf
[DOCS] Improved installation guide (#490) 2023-03-01 19:58:27 -08:00
Jesse Bannon
798bbbc62c
[BACKEND] Windows support (#476) 2023-02-28 17:07:03 -08:00
Jesse Bannon
a4dc61ea5b
[DOCS] Update readme with new executable install (#474) 2023-02-24 00:31:07 -08:00
Jesse Bannon
40d551793a
[DOCS] Pip install in README (#461) 2023-02-20 22:53:15 -08:00
Jesse Bannon
3349d0e358
[DOCS] Add README bit about navidrome (#422) 2023-01-14 17:10:47 -08:00
Jesse Bannon
3319ea6b07
[DOCS] Add FAQ in README support section (#417) 2023-01-13 14:25:13 -08:00
Benjamin Borlet
c783131ebf
Emby link point to Plex (#339) 2022-11-18 22:26:30 -08:00
Jesse Bannon
cb20a116d3
[DOCS] Update README again (#334) 2022-11-15 23:40:19 -08:00
Jesse Bannon
352b24470a
[DOCS] Update README.md (#333)
* Update README.md

* fix links

* remove extra line
2022-11-15 23:13:28 -08:00
Jesse Bannon
6280ea562a
[DOCS] Update README with prebuilt preset example (#308) 2022-11-02 08:57:34 -07:00
Jesse Bannon
7dfbb043fa
[DOCS] Add link to walk-through wiki on the README 2022-08-04 17:44:48 -07:00
Jesse Bannon
fe9803ca28
[DOCS] Slight README change 2022-08-04 00:07:07 -07:00
Jesse Bannon
879966aa66
[DOCS] MusicBee example in README 2022-08-03 11:44:58 -07:00
Jesse Bannon
b667301d4d
[DOCS] Update README with preview images 2022-08-03 11:04:01 -07:00
jbannon
3d6b0410f3 [DOCS|HOTFIX] Describe ytdl-sub as a CLI tool in the readme 2022-07-23 05:50:12 +00:00
Jesse Bannon
3d46909b4a
[DOCS] Add a config.yaml example and more info in the README (#124)
* add config in readme

* subtitle

* download aliases

* automated bit

* better subtitle
2022-07-22 22:46:33 -07:00
Jesse Bannon
bd5b2e76d8
[DOCS] Add discord link in README (#123)
* discord on readme

* link to codecov

* link to codecov, matching discord button

* no subtitle
2022-07-22 21:43:57 -07:00
Jesse Bannon
df9f5a7836
[DOCS] Automated download via cron docs (#95)
* [DOCS] Automated download docs, fix -thumb.jpg

* patty
2022-07-08 11:46:47 -07:00
Jesse Bannon
cbb4524bd4
Update README.md 2022-07-05 23:39:41 -07:00
Jesse Bannon
a79fcaa25b
Use URLs instead of IDs for sources (#70)
* youtube video url

* WIP, channel /user/ and /c/ should be valid

* unit tests passing

* soundcloud artist url

* soundcloud username

* break configs with name change

* Update all yamls with urls

* update all docs

* more negative url tests
2022-06-05 16:19:08 -07:00
Jesse Bannon
67104bca43
Move docker install into main readme (#61) 2022-06-02 22:34:09 -07:00
Jesse Bannon
a7524e1348
Simplify the README (#54)
* better readme

* code block ytdl-sub

* update links
2022-05-30 12:51:16 -07:00
Jesse Bannon
8b336e6fb0
Always convert thumbnails to jpg (#51)
* always use jpg

* fix unit test

* update readme and configs
2022-05-30 09:59:25 -07:00
Jesse Bannon
9c97fb7572
sanitized suffix (#41) 2022-05-26 23:02:40 -07:00
Jesse Bannon
3543101592
simplified readme (#25) 2022-05-15 21:56:43 -07:00
Jesse Bannon
29ef377cc7
Add documentation for plugins + improve docs overall (#23) 2022-05-10 22:22:03 -07:00
jbannon
f67a4dc7dc readthedocs badge 2022-05-07 06:49:39 +00:00
jbannon
e81aad9de1 badges 2022-05-07 06:19:12 +00:00
jbannon
b37a138f65 link to dir 2022-05-03 06:49:13 +00:00
jbannon
360d075189 install section 2022-05-03 06:47:31 +00:00
Jesse Bannon
b564e1fcf4
Make readme up to date and improved (#19) 2022-05-02 23:31:47 -07:00
jbannon
a0187cab41 variables in readme 2022-04-01 20:03:05 +00:00
jbannon
ea573a310d last update to readme for now 2022-04-01 19:17:36 +00:00
jbannon
f3b7be04b6 update readme again 2022-04-01 19:14:57 +00:00
jbannon
02203e3a7b update readme 2022-04-01 18:56:29 +00:00
Jesse Bannon
6662bc5112 entries 2022-03-30 07:41:12 +00:00
Jesse Bannon
df827b248f readme 2021-09-10 23:20:43 -07:00
Jesse Bannon
d9382f9f51
Initial commit 2021-09-08 21:44:33 -07:00