diff --git a/Configuration-(WIP).md b/Configuration-(WIP).md index fc309e9..9d3450f 100644 --- a/Configuration-(WIP).md +++ b/Configuration-(WIP).md @@ -4,16 +4,16 @@ The configuration is stored in `appdata` directory. It's a JSON file separated i # Items -| Text | Default.json Path | Key/ENV Var | Explanation | Default value | +| Text | Name | Key/ENV Var | Explanation | Default value | | ----------- | ----------- | ----------- | ----------- | ----------- | -| URL | Host.url | ytdl_url | URL for the frontend - not always needed especially with Docker | http://example.com | -| Port | Host.port | ytdl_port | Port for the frontend | 17442 | -| Audio path | Downloader.path-audio | ytdl_audio_folder_path | Deprecated - not used | "audio" | -| Video path | Downloader.path-video | ytdl_video_folder_path | Deprecated - not used | "video" | -| Default file output | Downloader.default_file_output | ytdl_default_file_output | Changes the formatting for file names based on [youtube-dl's output template](https://github.com/ytdl-org/youtube-dl/blob/master/README.md#output-template) | "" | -| Use youtube-dl archive | Downloader.use_youtubedl_archive | ytdl_use_youtubedl_archive | Creates and uses [archive text files](https://github.com/ytdl-org/youtube-dl/blob/master/README.md#how-do-i-download-only-new-videos-from-a-playlist) to avoid redownloading the same file, and helps track/port already downloaded files | false | -| Global custom args | Downloader.custom_args | ytdl_custom_args | youtube-dl args that get added to every download | "" | -| Include thumbnail | Downloader.include_thumbnail | ytdl_include_thumbnail | Downloads thumbnail along with file | true | -| Include metadata | Downloader.include_metadata | ytdl_include_metadata | Downloads [.info.json files](https://github.com/ytdl-org/youtube-dl#filesystem-options) along with file (highly recommended) | true | -| Max concurrent downloads | Downloader.max_concurrent_downloads | ytdl_max_concurrent_downloads | Limits the number of simultaneous downloads | 5 | -| Download rate limit | Downloader.download_rate_limit | ytdl_download_rate_limit | Limits download speed | "" | +| URL | url | ytdl_url | URL for the frontend - not always needed especially with Docker | http://example.com | +| Port | port | ytdl_port | Port for the frontend | 17442 | +| Audio path | path-audio | ytdl_audio_folder_path | Deprecated - not used | "audio" | +| Video path | path-video | ytdl_video_folder_path | Deprecated - not used | "video" | +| Default file output | default_file_output | ytdl_default_file_output | Changes the formatting for file names based on [youtube-dl's output template](https://github.com/ytdl-org/youtube-dl/blob/master/README.md#output-template) | "" | +| Use youtube-dl archive | use_youtubedl_archive | ytdl_use_youtubedl_archive | Creates and uses [archive text files](https://github.com/ytdl-org/youtube-dl/blob/master/README.md#how-do-i-download-only-new-videos-from-a-playlist) to avoid redownloading the same file, and helps track/port already downloaded files | false | +| Global custom args | custom_args | ytdl_custom_args | youtube-dl args that get added to every download | "" | +| Include thumbnail | include_thumbnail | ytdl_include_thumbnail | Downloads thumbnail along with file | true | +| Include metadata | include_metadata | ytdl_include_metadata | Downloads [.info.json files](https://github.com/ytdl-org/youtube-dl#filesystem-options) along with file (highly recommended) | true | +| Max concurrent downloads | max_concurrent_downloads | ytdl_max_concurrent_downloads | Limits the number of simultaneous downloads | 5 | +| Download rate limit | download_rate_limit | ytdl_download_rate_limit | Limits download speed | "" |