2022-06-28 03:17:56 -04:00
|
|
|
# Include{groups}
|
|
|
|
portals:
|
|
|
|
open:
|
2022-08-08 17:25:02 -04:00
|
|
|
# Include{portalLink}
|
2022-06-28 03:17:56 -04:00
|
|
|
questions:
|
|
|
|
# Include{global}
|
2022-08-08 17:25:02 -04:00
|
|
|
# Include{controller}
|
|
|
|
# Include{replicas}
|
|
|
|
# Include{replica1}
|
2022-08-12 04:40:46 -04:00
|
|
|
# Include{controllerExpertExtraArgs}
|
2022-06-28 03:17:56 -04:00
|
|
|
- variable: env
|
2022-11-10 11:56:28 -05:00
|
|
|
group: App Configuration
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Image Environment
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
additional_attrs: true
|
|
|
|
type: dict
|
|
|
|
attrs:
|
|
|
|
- variable: mainsettings
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Main Settings
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: boolean
|
|
|
|
default: true
|
|
|
|
show_subquestions_if: true
|
|
|
|
subquestions:
|
|
|
|
- variable: ytdl_url
|
2022-11-01 05:25:17 -04:00
|
|
|
label: URL
|
|
|
|
description: URL for the frontend
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: string
|
|
|
|
default: ""
|
|
|
|
- variable: ytdl_multi_user_mode
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Multi User Mode
|
|
|
|
description: Allows creation of users (with their own files), roles, and permissions
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: boolean
|
|
|
|
default: false
|
|
|
|
- variable: ytdl_allow_subscriptions
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Allow Subscriptions
|
|
|
|
description: Allows subscribing to channels
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: boolean
|
|
|
|
default: true
|
|
|
|
- variable: ytdl_subscriptions_check_interval
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Subscriptions Check Interval
|
|
|
|
description: Amount of time between cycling through all subscriptions.
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: int
|
|
|
|
default: 86400
|
|
|
|
- variable: ytdl_subscriptions_redownload_fresh_uploads
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Subscriptions Redownload Fresh Uploads
|
|
|
|
description: Checks day-old or newer videos in a subscription to see if a higher quality one exists. If it does, it's downloaded.
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: boolean
|
|
|
|
default: false
|
|
|
|
- variable: ytdl_allow_theme_change
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Allow Theme Change
|
|
|
|
description: Allows the theme to be changed by hitting the 3 dots in the top right corner
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: boolean
|
|
|
|
default: true
|
|
|
|
- variable: ytdl_default_theme
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Default Theme
|
|
|
|
description: Sets the default theme.
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: string
|
2022-11-01 05:25:17 -04:00
|
|
|
default: default
|
2022-06-28 03:17:56 -04:00
|
|
|
enum:
|
2022-11-01 05:25:17 -04:00
|
|
|
- value: default
|
|
|
|
description: default
|
|
|
|
- value: dark
|
|
|
|
description: dark
|
2022-06-28 03:17:56 -04:00
|
|
|
- variable: extrasettigns
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Extra Settings
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: boolean
|
|
|
|
default: false
|
|
|
|
show_subquestions_if: true
|
|
|
|
subquestions:
|
|
|
|
- variable: ytdl_title_top
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Title Top
|
|
|
|
description: Sets the top bar and browser tab title.
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: string
|
2022-11-01 05:25:17 -04:00
|
|
|
default: YoutubeDL-Material
|
2022-06-28 03:17:56 -04:00
|
|
|
- variable: ytdl_file_manager_enabled
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Enable File Manager
|
|
|
|
description: Enables file management in the home screen.
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: boolean
|
|
|
|
default: true
|
|
|
|
- variable: ytdl_enable_downloads_manager
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Enable Download Manager
|
|
|
|
description: Enables download management page.
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: boolean
|
|
|
|
default: true
|
|
|
|
- variable: ytdl_allow_quality_select
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Allow Quality Select
|
|
|
|
description: Allows changing quality of files (resolution/bitrate). Disabling this means it's always the best quality selected.
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: boolean
|
|
|
|
default: true
|
|
|
|
- variable: ytdl_download_only_mode
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Download Only Mode
|
|
|
|
description: Playing videos is disabled, they can only be downloaded.
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: boolean
|
|
|
|
default: false
|
|
|
|
- variable: ytdl_use_api_key
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Enable YTDL-Material API Key
|
|
|
|
description: Allows YoutubeDL-Material's API to be utilized.
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: boolean
|
|
|
|
default: false
|
|
|
|
- variable: ytdl_api_key
|
2022-11-01 05:25:17 -04:00
|
|
|
label: YTDL-Material API Key
|
|
|
|
description: Key used to authenticate YoutubeDL-Material's API users.
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: string
|
|
|
|
private: true
|
|
|
|
default: ""
|
|
|
|
- variable: ytdl_youtube_api_key
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Youtube API Key
|
|
|
|
description: Youtube API Key.
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: string
|
|
|
|
private: true
|
|
|
|
default: ""
|
|
|
|
- variable: ytdl_use_twitch_api
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Enable Twitch API Key
|
|
|
|
description: Enables Twitch API use, currently only used for downloading chats for VODs.
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: boolean
|
|
|
|
default: false
|
|
|
|
- variable: ytdl_twitch_api_key
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Twitch API Key
|
|
|
|
description: Twitch API Key.
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: string
|
|
|
|
private: true
|
|
|
|
default: ""
|
|
|
|
- variable: ytdl_twitch_auto_download_chat
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Twitch Auto Download Chat
|
|
|
|
description: Automatically downloads Twitch chats for VODs.
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: boolean
|
|
|
|
default: false
|
|
|
|
- variable: ytdl_use_sponsorblock_api
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Enable SponsorBlock
|
|
|
|
description: Enables Skip ads button in the video player if found on SponsorBlock.
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: boolean
|
|
|
|
default: false
|
|
|
|
- variable: ytdl_generate_nfo_files
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Generate NFO Files
|
|
|
|
description: Automatically creates NFO files for downloaded videos, primarily used with Kodi.
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: boolean
|
|
|
|
default: false
|
|
|
|
- variable: downloadersettigns
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Downloader Settings
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: boolean
|
|
|
|
default: false
|
|
|
|
show_subquestions_if: true
|
|
|
|
subquestions:
|
|
|
|
- variable: ytdl_default_file_output
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Default File Output
|
|
|
|
description: Changes the formatting for file names based on youtube-dl output template.
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: string
|
|
|
|
default: ""
|
|
|
|
- variable: ytdl_custom_args
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Custom Args
|
|
|
|
description: Youtube-dl args that get added to every download.
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: string
|
|
|
|
default: ""
|
|
|
|
- variable: ytdl_allow_playlist_categorization
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Allow Playlist Categorization
|
|
|
|
description: Allow Playlist Categorization
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: boolean
|
|
|
|
default: true
|
|
|
|
- variable: ytdl_use_youtubedl_archive
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Use Youtubedl Archive
|
|
|
|
description: Creates and uses archive text files to avoid redownloading the same file, and helps track/port already downloaded files.
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: boolean
|
|
|
|
default: false
|
|
|
|
- variable: ytdl_include_thumbnail
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Include Thumbnail
|
|
|
|
description: Downloads thumbnail along with file.
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: boolean
|
|
|
|
default: true
|
|
|
|
- variable: ytdl_include_metadata
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Include Metadata
|
|
|
|
description: Downloads .info.json files along with file (highly recommended).
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: boolean
|
|
|
|
default: true
|
|
|
|
- variable: ytdl_max_concurrent_downloads
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Max Concurrent Downloads
|
|
|
|
description: Limits the number of simultaneous downloads.
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: int
|
|
|
|
default: 5
|
|
|
|
- variable: ytdl_download_rate_limit
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Rate Limit
|
|
|
|
description: Limits download speed.
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: string
|
|
|
|
default: ""
|
|
|
|
- variable: advancedsettigns
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Advanced Settings
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: boolean
|
|
|
|
default: false
|
|
|
|
show_subquestions_if: true
|
|
|
|
subquestions:
|
|
|
|
- variable: ytdl_default_downloader
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Default Downloader
|
|
|
|
description: youtube-dl fork to use (youtube-dl, youtube-dlc, or yt-dlp)
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: string
|
2022-11-01 05:25:17 -04:00
|
|
|
default: yt-dlp
|
2022-06-28 03:17:56 -04:00
|
|
|
enum:
|
2022-11-01 05:25:17 -04:00
|
|
|
- value: yt-dlp
|
|
|
|
description: yt-dlp
|
|
|
|
- value: youtube-dlc
|
|
|
|
description: youtube-dlc
|
|
|
|
- value: youtube-dl
|
|
|
|
description: youtube-dl
|
2022-06-28 03:17:56 -04:00
|
|
|
- variable: ytdl_use_default_downloading_agent
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Use Default Downloading Agent
|
|
|
|
description: Whether to use youtube-dl's default agent or an alternative.
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: boolean
|
|
|
|
default: true
|
|
|
|
- variable: ytdl_custom_downloading_agent
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Custom Downloading Agent
|
|
|
|
description: Preferred download agent, only used if Use default downloading agent is set to false.
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: string
|
|
|
|
default: ""
|
|
|
|
- variable: ytdl_logger_level
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Logger Level
|
|
|
|
description: Logger Level.
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: string
|
2022-11-01 05:25:17 -04:00
|
|
|
default: info
|
2022-06-28 03:17:56 -04:00
|
|
|
enum:
|
2022-11-01 05:25:17 -04:00
|
|
|
- value: info
|
|
|
|
description: info
|
|
|
|
- value: info
|
|
|
|
description: info
|
|
|
|
- value: debug
|
|
|
|
description: debug
|
|
|
|
- value: verbose
|
|
|
|
description: verbose
|
|
|
|
- value: warn
|
|
|
|
description: warn
|
|
|
|
- value: error
|
|
|
|
description: error
|
2022-06-28 03:17:56 -04:00
|
|
|
- variable: ytdl_jwt_expiration
|
2022-11-01 05:25:17 -04:00
|
|
|
label: JWT Expiration
|
|
|
|
description: Length of time it takes for logins to expire.
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: int
|
|
|
|
default: 86400
|
|
|
|
- variable: ytdl_allow_advanced_download
|
2022-11-01 05:25:17 -04:00
|
|
|
label: JWT Expiration
|
|
|
|
description: Enables an advanced download tab on the home page for additional download settings and information.
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: boolean
|
|
|
|
default: false
|
|
|
|
- variable: ytdl_use_cookies
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Use Cookies
|
|
|
|
description: Enables usage of uploaded cookies to download videos as if you were logged into that website.
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: boolean
|
|
|
|
default: false
|
|
|
|
# Include{containerConfig}
|
2022-08-08 17:25:02 -04:00
|
|
|
# Include{serviceRoot}
|
2022-06-28 03:17:56 -04:00
|
|
|
- variable: main
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Main Service
|
|
|
|
description: The Primary service on which the healthcheck runs, often the webUI
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
additional_attrs: true
|
|
|
|
type: dict
|
|
|
|
attrs:
|
2022-09-17 07:24:06 -04:00
|
|
|
# Include{serviceSelectorLoadBalancer}
|
2022-09-14 17:27:12 -04:00
|
|
|
# Include{serviceSelectorExtras}
|
2022-06-28 03:17:56 -04:00
|
|
|
- variable: main
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Main Service Port Configuration
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
additional_attrs: true
|
|
|
|
type: dict
|
|
|
|
attrs:
|
|
|
|
- variable: port
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Port
|
|
|
|
description: This port exposes the container port on the service
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: int
|
|
|
|
default: 10253
|
|
|
|
required: true
|
2022-08-08 17:25:02 -04:00
|
|
|
# Include{serviceExpertRoot}
|
2022-06-28 03:17:56 -04:00
|
|
|
default: false
|
|
|
|
# Include{serviceExpert}
|
|
|
|
# Include{serviceList}
|
2022-08-08 17:25:02 -04:00
|
|
|
# Include{persistenceRoot}
|
2022-06-28 03:17:56 -04:00
|
|
|
- variable: appdata
|
2022-11-01 05:25:17 -04:00
|
|
|
label: App AppData Storage
|
|
|
|
description: Stores the Application AppData.
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
additional_attrs: true
|
|
|
|
type: dict
|
|
|
|
attrs:
|
|
|
|
# Include{persistenceBasic}
|
|
|
|
- variable: users
|
2022-11-01 05:25:17 -04:00
|
|
|
label: App Users Storage
|
|
|
|
description: Stores the Application Users.
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
additional_attrs: true
|
|
|
|
type: dict
|
|
|
|
attrs:
|
|
|
|
# Include{persistenceBasic}
|
|
|
|
- variable: subscriptions
|
2022-11-01 05:25:17 -04:00
|
|
|
label: App Subscriptions Storage
|
|
|
|
description: Stores the Application Subscriptions.
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
additional_attrs: true
|
|
|
|
type: dict
|
|
|
|
attrs:
|
|
|
|
# Include{persistenceBasic}
|
|
|
|
- variable: audio
|
2022-11-01 05:25:17 -04:00
|
|
|
label: App Audio Storage
|
|
|
|
description: Stores the Application Audio.
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
additional_attrs: true
|
|
|
|
type: dict
|
|
|
|
attrs:
|
|
|
|
# Include{persistenceBasic}
|
|
|
|
- variable: video
|
2022-11-01 05:25:17 -04:00
|
|
|
label: App Video Storage
|
|
|
|
description: Stores the Application Video.
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
additional_attrs: true
|
|
|
|
type: dict
|
|
|
|
attrs:
|
|
|
|
# Include{persistenceBasic}
|
|
|
|
# Include{persistenceList}
|
2022-08-08 17:25:02 -04:00
|
|
|
# Include{ingressRoot}
|
2022-06-28 03:17:56 -04:00
|
|
|
- variable: main
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Main Ingress
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
additional_attrs: true
|
|
|
|
type: dict
|
|
|
|
attrs:
|
|
|
|
# Include{ingressDefault}
|
|
|
|
# Include{ingressTLS}
|
|
|
|
# Include{ingressTraefik}
|
2022-11-11 13:09:57 -05:00
|
|
|
# Include{ingressList}
|
2022-06-28 03:17:56 -04:00
|
|
|
# Include{security}
|
2022-08-08 17:25:02 -04:00
|
|
|
# Include{securityContextAdvancedRoot}
|
2022-06-28 03:17:56 -04:00
|
|
|
- variable: privileged
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Privileged mode
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: boolean
|
|
|
|
default: false
|
|
|
|
- variable: readOnlyRootFilesystem
|
2022-11-01 05:25:17 -04:00
|
|
|
label: ReadOnly Root Filesystem
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: boolean
|
|
|
|
default: false
|
|
|
|
- variable: allowPrivilegeEscalation
|
2022-11-01 05:25:17 -04:00
|
|
|
label: Allow Privilege Escalation
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: boolean
|
|
|
|
default: false
|
|
|
|
- variable: runAsNonRoot
|
2022-11-01 05:25:17 -04:00
|
|
|
label: runAsNonRoot
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: boolean
|
|
|
|
default: false
|
2022-08-08 17:25:02 -04:00
|
|
|
# Include{podSecurityContextRoot}
|
2022-06-28 03:17:56 -04:00
|
|
|
- variable: runAsUser
|
2022-11-01 05:25:17 -04:00
|
|
|
label: runAsUser
|
|
|
|
description: The UserID of the user running the application
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: int
|
|
|
|
default: 0
|
|
|
|
- variable: runAsGroup
|
2022-11-01 05:25:17 -04:00
|
|
|
label: runAsGroup
|
|
|
|
description: The groupID this App of the user running the application
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: int
|
|
|
|
default: 0
|
|
|
|
- variable: fsGroup
|
2022-11-01 05:25:17 -04:00
|
|
|
label: fsGroup
|
|
|
|
description: The group that should own ALL storage.
|
2022-06-28 03:17:56 -04:00
|
|
|
schema:
|
|
|
|
type: int
|
|
|
|
default: 1000
|
|
|
|
# Include{podSecurityContextAdvanced}
|
|
|
|
# Include{resources}
|
|
|
|
# Include{advanced}
|
|
|
|
# Include{addons}
|
2022-10-01 17:39:52 -04:00
|
|
|
# Include{codeserver}
|
|
|
|
# Include{vpn}
|
2022-08-12 07:15:27 -04:00
|
|
|
# Include{documentation}
|