aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorunref (Nikolai G) <unref@inbox.ru>2022-08-25 18:01:06 +0300
committerunref (Nikolai G) <unref@inbox.ru>2022-08-25 18:20:50 +0300
commit818b2154757ab810e9678cd0c76519500e1fb951 (patch)
tree5dfc57786ad14eb7c94000717a4320b82a99f5c4 /README.md
parentupgraded yt-dlp (diff)
downloadmetube-818b2154757ab810e9678cd0c76519500e1fb951.tar.gz
metube-818b2154757ab810e9678cd0c76519500e1fb951.tar.bz2
metube-818b2154757ab810e9678cd0c76519500e1fb951.zip
add couple env variables
Diffstat (limited to 'README.md')
-rw-r--r--README.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/README.md b/README.md
index 0e1528a..8bb811c 100644
--- a/README.md
+++ b/README.md
@@ -41,6 +41,9 @@ Certain values can be set via environment variables, using the `-e` parameter on
* __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.
+* __HOST__: ip address under which MeTube will run. Defaults to `0.0.0.0`.
+* __PORT__: port under which MeTube will run. Defaults to `8081`.
+* __BASEDIR__: path to where MeTube is located. Defaults to empty string.
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