alexta69/metube

Maintainer? Show your league in your README

Card: your league's emblem, from Copper to Legendary

[![bestofgithub](https://bestofgithub.dev/badge/alexta69/metube.svg?style=card)](https://bestofgithub.dev/repo/alexta69/metube)

Flat: fits beside your other badges

[![bestofgithub](https://bestofgithub.dev/badge/alexta69/metube.svg)](https://bestofgithub.dev/repo/alexta69/metube)

Loading README…

Variable	Default	Description
`PUID` / `PGID`	`1000`	User and group MeTube runs as and writes files with. Legacy `UID`/`GID` also work.
`UMASK`	`022`	Umask for the files MeTube creates.
`CHOWN_DIRS`	`true`	Make `PUID:PGID` the owner of the download, state and temp directories at startup. With `false`, MeTube's user must already have access.
`LOGLEVEL`	`INFO`	`DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL` or `NONE`.
`ENABLE_ACCESSLOG`	`false`	Log every HTTP request.
`DEFAULT_THEME`	`auto`	UI theme: `light`, `dark`, or `auto` to follow the system.

Variable	Default	Description
`MAX_CONCURRENT_DOWNLOADS`	`3`	Downloads that run at once; the rest wait their turn.
`DEFAULT_OPTION_PLAYLIST_ITEM_LIMIT`	`0`	Default for the Items Limit field: how many entries of a playlist or channel to download (`0` = all).
`CLEAR_COMPLETED_AFTER`	`0`	Seconds before finished and failed downloads leave the Completed list (`0` = never).
`DELETE_FILE_ON_TRASHCAN`	`false`	Also delete the file from disk when its entry is removed from Completed. `ask` prompts each time.
`SUBSCRIPTION_DEFAULT_CHECK_INTERVAL`	`60`	Default minutes between checks of a subscription.
`SUBSCRIPTION_SCAN_PLAYLIST_END`	`50`	Newest entries fetched each time a subscription is checked.
`SUBSCRIPTION_MAX_SEEN_IDS`	`50000`	Video IDs remembered per subscription, to bound the state file's size.

Variable	Default	Description
`DOWNLOAD_DIR`	`/downloads`	Where downloads are saved.
`AUDIO_DOWNLOAD_DIR`	same as `DOWNLOAD_DIR`	Where audio-only downloads are saved, to keep them apart from video.
`TEMP_DIR`	`/downloads`	Where files are written while downloading. An SSD or `tmpfs` is faster, but on a RAM disk interrupted downloads can't resume.
`STATE_DIR`	`/downloads/.metube`	Where MeTube keeps its queue, history, subscriptions and uploaded cookies.
`CUSTOM_DIRS`	`true`	Show a Download Folder field under Advanced Options, to save into a subfolder of the download directory.
`CREATE_CUSTOM_DIRS`	`true`	Let that field create folders that don't exist yet.
`CUSTOM_DIRS_EXCLUDE_REGEX`	`(^\|/)[.@].*$`	Folders left out of the field's suggestions; the default hides names starting with `.` or `@`. Empty hides none.
`DEFAULT_FOLDER`		Folder the field starts with, relative to the download directory. Requires `CUSTOM_DIRS`.
`DOWNLOAD_DIRS_INDEXABLE`	`false`	Serve browsable listings of the download directories.

Variable	Default	Description
`OUTPUT_TEMPLATE`	`%(title)s.%(ext)s`	Filename for downloads.
`OUTPUT_TEMPLATE_PLAYLIST`	`%(playlist_title)s/%(title)s.%(ext)s`	Filename for items added from a playlist. Empty means `OUTPUT_TEMPLATE`.
`OUTPUT_TEMPLATE_CHANNEL`	`%(channel)s/%(title)s.%(ext)s`	Filename for items added from a channel. Empty means `OUTPUT_TEMPLATE`.
`OUTPUT_TEMPLATE_CHAPTER`	`%(title)s - %(section_number)02d - %(section_title)s.%(ext)s`	Default filename for each chapter when Split by chapters is on.

Variable	Default	Description
`YTDL_OPTIONS`	`{}`	Options for every download, as a JSON object — see yt-dlp options.
`YTDL_OPTIONS_FILE`		Path to a JSON file of such options. Reloaded when it changes; wins over `YTDL_OPTIONS` for the same key.
`YTDL_OPTIONS_PRESETS`	`{}`	Named option bundles, picked per download in the UI.
`YTDL_OPTIONS_PRESETS_FILE`		Path to a JSON file of presets. Reloaded when it changes; wins over `YTDL_OPTIONS_PRESETS` for the same name.
`ALLOW_YTDL_OPTIONS_OVERRIDES`	`false`	Show a field for per-download yt-dlp options in the UI. Trusted users only: it allows running commands in the container.
`YTDL_NIGHTLY_UPDATE_TIME`		Use nightly yt-dlp builds, upgrading and restarting daily at this time (`HH:MM`, 24-hour).

MeTube

Variable	Default	Description
`HOST`	`0.0.0.0`	Address to listen on. The default is every IPv4 interface; `*` (or empty) adds IPv6; `::` is IPv6 only.
`PORT`	`8081`	Port to listen on.
`URL_PREFIX`	`/`	Base path, for serving MeTube under a subpath of a reverse proxy.
`HTTPS`	`false`	Serve HTTPS directly, using `CERTFILE` and `KEYFILE`.
`CERTFILE` / `KEYFILE`		Paths to the HTTPS certificate and key.
`PUBLIC_HOST_URL`	`download/`	Base URL for the links to completed files. The default is relative to MeTube itself; set a full URL if the files are served from elsewhere.
`PUBLIC_HOST_AUDIO_URL`	`audio_download/`	The same, for audio downloads.
`CORS_ALLOWED_ORIGINS`		Comma-separated origins allowed to call MeTube from other sites, as browser extensions and bookmarklets do. `*` allows any site, so prefer naming them.
`ALLOW_PRIVATE_ADDRESSES`	`false`	Allow URLs on private and internal addresses, turning off SSRF protection. Needed for Fake-IP proxy clients, not for ordinary proxies — details.
`ROBOTS_TXT`		Path to a `robots.txt` file to serve, mounted into the container.