aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlex Shnitman <alexta69@gmail.com>2022-06-19 21:51:10 +0300
committerAlex Shnitman <alexta69@gmail.com>2022-06-19 21:51:10 +0300
commit38a911f489640b272e05b80b97b5262dd25f53d8 (patch)
tree7f1d83107ca973adac74069cff70e5bad8432f4f
parentPass to yt_dlp a chapter-specific output template (diff)
downloadmetube-38a911f489640b272e05b80b97b5262dd25f53d8.tar.gz
metube-38a911f489640b272e05b80b97b5262dd25f53d8.tar.bz2
metube-38a911f489640b272e05b80b97b5262dd25f53d8.zip
added note about the OUTPUT_TEMPLATE_CHAPTER config variable to the README
-rw-r--r--README.md1
1 files changed, 1 insertions, 0 deletions
diff --git a/README.md b/README.md
index 6d2562b..b1cade6 100644
--- a/README.md
+++ b/README.md
@@ -37,6 +37,7 @@ Certain values can be set via environment variables, using the `-e` parameter on
* __STATE_DIR__: path to where the queue persistence files will be saved. Defaults to `/downloads/.metube` in the docker image, and `.` otherwise.
* __URL_PREFIX__: base path for the web server (for use when hosting behind a reverse proxy). Defaults to `/`.
* __OUTPUT_TEMPLATE__: the template for the filenames of the downloaded videos, formatted according to [this spec](https://github.com/yt-dlp/yt-dlp/blob/master/README.md#output-template). Defaults to `%(title)s.%(ext)s`.
+* __OUTPUT_TEMPLATE_CHAPTER__: the template for the filenames of the downloaded videos, when split into chapters via postprocessors. Defaults to `%(title)s - %(section_number)s %(section_title)s.%(ext)s`.
* __YTDL_OPTIONS__: Additional options to pass to youtube-dl, in JSON format. [See available options here](https://github.com/yt-dlp/yt-dlp/blob/master/yt_dlp/YoutubeDL.py#L176). They roughly correspond to command-line options, though some do not have exact equivalents here, for example `--recode-video` has to be specified via `postprocessors`. Also note that dashes are replaced with underscores.
The following example value for `YTDL_OPTIONS` embeds English subtitles and chapter markers (for videos that have them), and also changes the permissions on the downloaded video:
bgstack15