Any value that is set to null or is left undefined will be set to its default value.
If said variable does not have a default value, the program will exit and print out the specific error in the logs.
| Root => { | |||
| Field | Type | Remark | Default |
| application | Application Object | Contains the configs that are use globally by the application. | None/null |
| youtube | Youtube Object | Contains the configs for the YouTube related part of the application. | None/null |
| Application => { application { | |||
| Field | Type | Remark | Default |
| root_output_dir | String | Root directory where the downloaded data should be stored in. | ./data |
| logging_level_main | Integer |
Logging level for the main app. See Python's documentation for more information |
10 |
| auto_shutdown_after_ms | Integer |
Delay in milliseconds after which the application should automatically exit with a return code of 0.This can be used to restart containers and clean potential memory leaks. Will disable the functionality if set to -1.
|
-1 |
| auto_shutdown_do_wait_for_workers | Boolean |
Indicates whether or not the application should wait for all worker's thread to finish without sending
a SIGINT or SIGTERM signal back to them after the countdown was reached. If set to False, the application will forcefully kill these threads which could lead to a loss
or corruption of data.No new threads will be launched while the main loop waits for all threads to be finished with there work. |
True |
| auto_shutdown_number_to_send | Integer |
Indicates which signal should be send to threads if auto_shutdown_do_wait_for_workers is set to
False.Allowed values are -1, SIGINT (2) and SIGTERM (15).If it is set to an incorrect value, or to -1, it will automatically be set to
SIGTERM (15) and will be said in the debug-level logs.
|
-1 |
| signal_shutdown_do_wait_for_workers | Boolean |
Indicates whether or not the application should wait for all worker's thread to finish without sending
a SIGINT or SIGTERM signal back to them after receiving a shutdown signal. If set to False, the application will forcefully kill these threads which could lead to a loss
or corruption of data.No new threads will be launched while the main loop waits for all threads to be finished with there work. |
False |
| Youtube => { youtube { | |||
| Field | Type | Remark | Default |
| output_subdir | String |
Directory in which all YouTube related downloads are stored. Appended to application.root_output_dir.
|
./youtube |
| delay_ms_metadata_download | Integer | Delay in ms between the start of a live downloader thread and the moment it attempts to download its thumbnail
and description. Can be disabled if set to -1. |
30000 |
| logging_level_worker | Integer |
Logging level for all YouTube-related workers. See Python's documentation for more information |
10 |
| logging_level_thread | Integer |
Logging level for all YouTube-related threads. See Python's documentation for more information |
10 |
| channels | Array of Channel | See below for more info on these objects. | None/null |
| Channel => { youtube { channels [ { | |||
| Field | Type | Remark | Default |
| internal_id | String | Arbitrary string used in downloaded files and loggers' names. | Required |
| channel_id | String | Id of the relevant YouTube channel. | Required |
| name | String | Friendly name used in logging only. | {internal_id}Broken in 0.7.0, now required |
| output_subdir | String |
Directory in which all the files for this channel are downloaded into. Appended to application.root_output_dir and youtube.output_subdir.
|
./{internal_id}Broken in 0.7.0, now required |
| live_subdir | String |
Directory in which all the livestream files for this channel are downloaded into.
Appended to application.root_output_dir, youtube.output_subdir and youtube.{channel}.output_subdir.
|
./livestreams |
| upload_subdir | String |
Directory in which all the upload files for this channel are downloaded into.
Appended to application.root_output_dir, youtube.output_subdir and youtube.{channel}.output_subdir.
|
./uploads |
| check_live | Boolean | Toggles the live downloading worker and threads. | False |
| check_upload | Boolean | Toggles the video downloading worker and threads. | False |
| interval_ms_live | Integer |
Delay in ms between each verification of the channel to see if it is livestreaming. Will disable the functionality if set to -1.
|
-1 |
| interval_ms_upload | Integer |
Delay in ms between each verification of the channel to see if it is livestreaming. Will disable the functionality if set to -1.
|
-1 |
| quality_live | String | Quality setting used in streamlink when downloading a live. | "best" |
| quality_upload | String | Quality setting used in yt-dlp with the -f option. |
"best" |
| backlog_days_upload | Integer |
Number of days to look back to for uploads Added as-is in the --dateafter now-Xdays option where X is the number of days given here.
|
7 |
| break_on_existing | Boolean | Indicates if yt-dlp should stop downloading uploads when encountering an existing completed download. | True |
| break_on_reject | Boolean | Indicates if yt-dlp should stop downloading uploads when encountering a filtered video. | True |
| yt_dlp_extra_args | String | Extra args added as-is to the yt-dlp command right before the channel URL. | "" |
| allow_upload_while_live | Boolean | Indicates whether yt-dlp can download videos while a live worker is running for the given channel. | True |