https://github.com/alexta69/metube
https://github.com/alexta69/metube/raw/master/screenshot.gif
Run using Docker
docker run -d -p 8081:8081 -v /path/to/downloads:/downloads ghcr.io/alexta69/metube
Run using docker-compose
services:
metube:
image: ghcr.io/alexta69/metube
container_name: metube
restart: unless-stopped
ports:
- "8081:8081"
volumes:
- /path/to/downloads:/downloads
Configuration via environment variables
Certain values can be set via environment variables, using the -e parameter on the docker command line, or the environment: section in docker-compose.
UID: user under which MeTube will run. Defaults to 1000.
GID: group under which MeTube will run. Defaults to 1000.
UMASK: umask value used by MeTube. Defaults to 022.
DEFAULT_THEME: default theme to use for the ui, can be set to light, dark or auto. Defaults to auto.
DOWNLOAD_DIR: path to where the downloads will be saved. Defaults to /downloads in the docker image, and . otherwise.
AUDIO_DOWNLOAD_DIR: path to where audio-only downloads will be saved, if you wish to separate them from the video downloads. Defaults to the value of DOWNLOAD_DIR.
DOWNLOAD_DIRS_INDEXABLE: if true, the download dirs (DOWNLOAD_DIR and AUDIO_DOWNLOAD_DIR) are indexable on the webserver. Defaults to false.
CUSTOM_DIRS: whether to enable downloading videos into custom directories within the DOWNLOAD_DIR (or AUDIO_DOWNLOAD_DIR). When enabled, a drop-down appears next to the Add button to specify the download directory. Defaults to true.
CREATE_CUSTOM_DIRS: whether to support automatically creating directories within the DOWNLOAD_DIR (or AUDIO_DOWNLOAD_DIR) if they do not exist. When enabled, the download directory selector becomes supports free-text input, and the specified directory will be created recursively. Defaults to true.
STATE_DIR: path to where the queue persistence files will be saved. Defaults to /downloads/.metube in the docker image, and . otherwise.
TEMP_DIR: path where intermediary download files will be saved. Defaults to /downloads in the docker image, and . otherwise.
Set this to an SSD or RAM filesystem (e.g., tmpfs) for better performance
Note: Using a RAM filesystem may prevent downloads from being resumed
DELETE_FILE_ON_TRASHCAN: if true, downloaded files are deleted on the server, when they are trashed from the "Completed" section of the UI. Defaults to false.
URL_PREFIX: base path for the web server (for use when hosting behind a reverse proxy). Defaults to /.
PUBLIC_HOST_URL: base URL for the download links shown in the UI for completed files. By default MeTube serves them under its own URL. If your download directory is accessible on another URL and you want the download links to be based there, use this variable to set it.
HTTPS: use https instead of http(CERTFILE and KEYFILE required). Defaults to false.
CERTFILE: HTTPS certificate file path.
KEYFILE: HTTPS key file path.
PUBLIC_HOST_AUDIO_URL: same as PUBLIC_HOST_URL but for audio downloads.
OUTPUT_TEMPLATE: the template for the filenames of the downloaded videos, formatted according to this spec. 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.
OUTPUT_TEMPLATE_PLAYLIST: the template for the filenames of the downloaded videos, when downloaded as a playlist. Defaults to %(playlist_title)s/%(title)s.%(ext)s. When empty then OUTPUT_TEMPLATE is used.
DEFAULT_OPTION_PLAYLIST_STRICT_MODE: if true, the "Strict Playlist mode" switch will be enabled by default. In this mode the playlists will be downloaded only if the url strictly points to a playlist. Urls to videos inside a playlist will be treated same as direct video url. Defaults to false .
DEFAULT_OPTION_PLAYLIST_ITEM_LIMIT: Maximum numer of playlist items that can be downloaded. Defaults to 0 (no limit).
YTDL_OPTIONS: Additional options to pass to youtube-dl, in JSON format. See available options here. 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.
YTDL_OPTIONS_FILE: A path to a JSON file that will be loaded and used for populating YTDL_OPTIONS above. Please note that if both YTDL_OPTIONS_FILE and YTDL_OPTIONS are specified, the options in YTDL_OPTIONS take precedence.
ROBOTS_TXT: A path to a robots.txt file mounted in the container
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 and sets the file modification timestamp to the date of when it was downloaded:
environment:
- 'YTDL_OPTIONS={"writesubtitles":true,"subtitleslangs":["en","-live_chat"],"updatetime":false,"postprocessors":[{"key":"Exec","exec_cmd":"chmod 0664","when":"after_move"},{"key":"FFmpegEmbedSubtitle","already_have_subtitle":false},{"key":"FFmpegMetadata","add_chapters":true}]}'
The following example value for OUTPUT_TEMPLATE sets: