danvics/ytptube
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

reflect preset options in tasks page.

Browse source
This commit is contained in:
arabcoders 2025-09-03 19:25:08 +03:00
parent 063f62bebb
commit aab690a822
5 changed files with 89 additions and 98 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

84
FAQ.md
View file

@ -3,48 +3,48 @@
Certain configuration values can be set via environment variables, using the `-e` parameter on the docker command line, Certain configuration values can be set via environment variables, using the `-e` parameter on the docker command line,
or the `environment:` section in `compose.yaml` file. or the `environment:` section in `compose.yaml` file.
| Environment Variable | Description | Default | | Environment Variable | Description | Default |
| ------------------------------ | ------------------------------------------------------------------ | ---------------------------------- | | ------------------------------ | ------------------------------------------------------------------ | -------------------------- |
| YTP_OUTPUT_TEMPLATE | The template for the filenames of the downloaded videos | `%(title)s.%(ext)s` | | TZ | The timezone to use for the application | `(not_set)` |
| YTP_DEFAULT_PRESET | The default preset to use for the download | `default` | | YTP_OUTPUT_TEMPLATE | The template for the filenames of the downloaded videos | `%(title)s.%(ext)s` |
| YTP_INSTANCE_TITLE | The title of the instance | `empty string` | | YTP_DEFAULT_PRESET | The default preset to use for the download | `default` |
| YTP_FILE_LOGGING | Whether to log to file | `false` | | YTP_INSTANCE_TITLE | The title of the instance | `empty string` |
| YTP_DOWNLOAD_PATH | Path to where the downloads will be saved | `/downloads` | | YTP_FILE_LOGGING | Whether to log to file | `false` |
| YTP_MAX_WORKERS | How many works to use for downloads | `1` | | YTP_DOWNLOAD_PATH | Path to where the downloads will be saved | `/downloads` |
| YTP_AUTH_USERNAME | Username for basic authentication | `empty string` | | YTP_MAX_WORKERS | How many works to use for downloads | `1` |
| YTP_AUTH_PASSWORD | Password for basic authentication | `empty string` | | YTP_AUTH_USERNAME | Username for basic authentication | `empty string` |
| YTP_CONSOLE_ENABLED | Whether to enable the console | `false` | | YTP_AUTH_PASSWORD | Password for basic authentication | `empty string` |
| YTP_REMOVE_FILES | Remove the actual file when clicking the remove button | `false` | | YTP_CONSOLE_ENABLED | Whether to enable the console | `false` |
| YTP_CONFIG_PATH | Path to where the config files will be stored. | `/config` | | YTP_REMOVE_FILES | Remove the actual file when clicking the remove button | `false` |
| YTP_TEMP_PATH | Path to where tmp files are stored. | `/tmp` | | YTP_CONFIG_PATH | Path to where the config files will be stored. | `/config` |
| YTP_TEMP_KEEP | Whether to keep the Individual video temp directory or remove it | `false` | | YTP_TEMP_PATH | Path to where tmp files are stored. | `/tmp` |
| YTP_HOST | Which IP address to bind to | `0.0.0.0` | | YTP_TEMP_KEEP | Whether to keep the Individual video temp directory or remove it | `false` |
| YTP_PORT | Which port to bind to | `8081` | | YTP_HOST | Which IP address to bind to | `0.0.0.0` |
| YTP_LOG_LEVEL | Log level | `info` | | YTP_PORT | Which port to bind to | `8081` |
| YTP_STREAMER_VCODEC | The video codec to use for in-browser streaming | `libx264` | | YTP_LOG_LEVEL | Log level | `info` |
| YTP_STREAMER_ACODEC | The audio codec to use for in-browser streaming | `aac` | | YTP_STREAMER_VCODEC | The video codec to use for in-browser streaming | `libx264` |
| YTP_ACCESS_LOG | Whether to log access to the web server | `true` | | YTP_STREAMER_ACODEC | The audio codec to use for in-browser streaming | `aac` |
| YTP_DEBUG | Whether to turn on debug mode | `false` | | YTP_ACCESS_LOG | Whether to log access to the web server | `true` |
| YTP_DEBUGPY_PORT | The port to use for the debugpy debugger | `5678` | | YTP_DEBUG | Whether to turn on debug mode | `false` |
| YTP_EXTRACT_INFO_TIMEOUT | The timeout for extracting video information | `70` | | YTP_DEBUGPY_PORT | The port to use for the debugpy debugger | `5678` |
| YTP_DB_FILE | The path to the SQLite database file | `{config_path}/ytptube.db` | | YTP_EXTRACT_INFO_TIMEOUT | The timeout for extracting video information | `70` |
| YTP_UI_UPDATE_TITLE | Whether to update the title of the page with the current stats | `true` | | YTP_DB_FILE | The path to the SQLite database file | `{config_path}/ytptube.db` |
| YTP_PIP_PACKAGES | A space separated list of pip packages to install | `empty string` | | YTP_UI_UPDATE_TITLE | Whether to update the title of the page with the current stats | `true` |
| YTP_PIP_IGNORE_UPDATES | Do not update the custom pip packages | `false` | | YTP_PIP_PACKAGES | A space separated list of pip packages to install | `empty string` |
| YTP_BASIC_MODE | Whether to run WebUI in basic mode | `false` | | YTP_PIP_IGNORE_UPDATES | Do not update the custom pip packages | `false` |
| YTP_PICTURES_BACKENDS | A comma separated list of pictures urls to use | `empty string` | | YTP_BASIC_MODE | Whether to run WebUI in basic mode | `false` |
| YTP_BROWSER_ENABLED | Whether to enable the file browser | `false` | | YTP_PICTURES_BACKENDS | A comma separated list of pictures urls to use | `empty string` |
| YTP_BROWSER_CONTROL_ENABLED | Whether to enable the file browser actions | `false` | | YTP_BROWSER_ENABLED | Whether to enable the file browser | `false` |
| YTP_YTDLP_AUTO_UPDATE | Whether to enable the auto update for yt-dlp | `true` | | YTP_BROWSER_CONTROL_ENABLED | Whether to enable the file browser actions | `false` |
| YTP_YTDLP_DEBUG | Whether to turn debug logging for the internal `yt-dlp` package | `false` | | YTP_YTDLP_AUTO_UPDATE | Whether to enable the auto update for yt-dlp | `true` |
| YTP_YTDLP_VERSION | The version of yt-dlp to use. Defaults to latest version | `empty string` | | YTP_YTDLP_DEBUG | Whether to turn debug logging for the internal `yt-dlp` package | `false` |
| YTP_BASE_PATH | Set this if you are serving YTPTube from sub-folder | `/` | | YTP_YTDLP_VERSION | The version of yt-dlp to use. Defaults to latest version | `empty string` |
| YTP_PREVENT_LIVE_PREMIERE | Prevents the initial youtube premiere stream from being downloaded | `false` | | YTP_BASE_PATH | Set this if you are serving YTPTube from sub-folder | `/` |
| YTP_TASKS_HANDLER_TIMER | The cron expression for the tasks handler timer | `15 */1 * * *` | | YTP_PREVENT_LIVE_PREMIERE | Prevents the initial youtube premiere stream from being downloaded | `false` |
| YTP_PLAYLIST_ITEMS_CONCURRENCY | The number of playlist items be to processed at same time | `1` | | YTP_TASKS_HANDLER_TIMER | The cron expression for the tasks handler timer | `15 */1 * * *` |
| YTP_TEMP_DISABLED | Disable temp files handling. | `false` | | YTP_PLAYLIST_ITEMS_CONCURRENCY | The number of playlist items be to processed at same time | `1` |
| YTP_DOWNLOAD_PATH_DEPTH | How many subdirectories to show in auto complete. | `1` | | YTP_TEMP_DISABLED | Disable temp files handling. | `false` |
| YTP_DOWNLOAD_PATH_DEPTH | How many subdirectories to show in auto complete. | `1` |
# Browser extensions & bookmarklets # Browser extensions & bookmarklets

20
ui/app/components/NewDownload.vue
View file

@ -484,26 +484,6 @@ const filter_presets = (flag: boolean = true) => config.presets.filter(item => i
const get_preset = (name: string | undefined) => config.presets.find(item => item.name === name) const get_preset = (name: string | undefined) => config.presets.find(item => item.name === name)
const expand_description = (e: Event) => toggleClass(e.target as HTMLElement, ['is-ellipsis', 'is-pre-wrap']) const expand_description = (e: Event) => toggleClass(e.target as HTMLElement, ['is-ellipsis', 'is-pre-wrap'])
const get_output_template = () => {
if (form.value.preset && !hasFormatInConfig.value) {
const preset = config.presets.find(p => p.name === form.value.preset)
if (preset && preset.template) {
return preset.template
}
}
return config.app.output_template || '%(title)s.%(ext)s'
}
const get_download_folder = (): string => {
if (form.value.preset && false === hasFormatInConfig.value) {
const preset = config.presets.find(p => p.name === form.value.preset)
if (preset?.folder) {
return preset.folder.replace(config.app.download_path, '')
}
}
return '/'
}
const getDefault = (type: 'cookies' | 'cli' | 'template' | 'folder', ret: string = '') => { const getDefault = (type: 'cookies' | 'cli' | 'template' | 'folder', ret: string = '') => {
if (false !== hasFormatInConfig.value || !form.value.preset) { if (false !== hasFormatInConfig.value || !form.value.preset) {
return ret return ret

70
ui/app/components/TaskForm.vue
View file

@ -160,13 +160,13 @@
Save in Save in
</label> </label>
<div class="control"> <div class="control">
<input type="text" class="input" id="folder" placeholder="Leave empty to use default download path" <input type="text" class="input" id="folder" :placeholder="getDefault('folder', '/')"
v-model="form.folder" :disabled="addInProgress" list="folders"> v-model="form.folder" :disabled="addInProgress" list="folders">
</div> </div>
<span class="help"> <span class="help">
<span class="icon"><i class="fa-solid fa-info" /></span> <span class="icon"><i class="fa-solid fa-info" /></span>
<span class="is-bold">Current download folder: <code>{{ get_download_folder() }}</code>. All folders <span class="is-bold">All folders are sub-folders of
are sub-folders of <code>{{ config.app.download_path }}</code>.</span> <code>{{ config.app.download_path }}</code>.</span>
</span> </span>
</div> </div>
</div> </div>
@ -179,11 +179,12 @@
</label> </label>
<div class="control"> <div class="control">
<input type="text" class="input" id="output_template" :disabled="addInProgress" <input type="text" class="input" id="output_template" :disabled="addInProgress"
placeholder="Leave empty to use default template." v-model="form.template"> :placeholder="getDefault('template', config.app.output_template || '%(title)s.%(ext)s')"
v-model="form.template">
</div> </div>
<span class="help"> <span class="help">
<span class="icon"><i class="fa-solid fa-info" /></span> <span class="icon"><i class="fa-solid fa-info" /></span>
<span class="is-bold">Current output format: <code>{{ get_output_template() }}</code>.</span> <span class="is-bold">The template to use for the output file name.</span>
</span> </span>
</div> </div>
</div> </div>
@ -237,7 +238,7 @@
<span>Command options for yt-dlp</span> <span>Command options for yt-dlp</span>
</label> </label>
<TextareaAutocomplete id="cli_options" v-model="form.cli" :options="ytDlpOpt" <TextareaAutocomplete id="cli_options" v-model="form.cli" :options="ytDlpOpt"
:disabled="addInProgress" /> :placeholder="getDefault('cli', '')" :disabled="addInProgress" />
<span class="help is-bold"> <span class="help is-bold">
<span class="icon"><i class="fa-solid fa-info" /></span> <span class="icon"><i class="fa-solid fa-info" /></span>
<span> <span>
@ -282,10 +283,8 @@
<li>RSS monitoring runs every hour alongside the actual task execution. Regardless if the task has timer set <li>RSS monitoring runs every hour alongside the actual task execution. Regardless if the task has timer set
or not. To opt out of RSS monitoring for a specific task, simply disable the <code>Enable Handler</code> or not. To opt out of RSS monitoring for a specific task, simply disable the <code>Enable Handler</code>
option. To have the task only monitor RSS feed, <b>do not set timer</b>.</li> option. To have the task only monitor RSS feed, <b>do not set timer</b>.</li>
<li>RSS Feed monitoring will only work if you have <code>--download-archive</code> set in command options <li>RSS Feed monitoring will only work if you have <code>--download-archive</code> set in <code>Command options
for ytdlp.cli, preset or task. If you don't have <code>--download-archive</code> set but for yt-dlp</code> via the task itself, or preset. command options
<code>YTP_KEEP_ARCHIVE</code> environment option is set to <code>true</code> which is the default, It will
also work.
</li> </li>
</ul> </ul>
</span> </span>
@ -463,26 +462,6 @@ const hasFormatInConfig = computed<boolean>(() => !!form.cli && /(?<!\S)(-f|--fo
const filter_presets = (flag = true) => config.presets.filter(item => item.default === flag) const filter_presets = (flag = true) => config.presets.filter(item => item.default === flag)
const get_download_folder = (): string => {
if (form.preset && false === hasFormatInConfig.value) {
const preset = config.presets.find(p => p.name === form.preset)
if (preset?.folder) {
return preset.folder.replace(config.app.download_path, '')
}
}
return '/'
}
const get_output_template = (): string => {
if (form.preset && false === hasFormatInConfig.value) {
const preset = config.presets.find(p => p.name === form.preset)
if (preset?.template) {
return preset.template
}
}
return config.app.output_template || '%(title)s.%(ext)s'
}
const is_yt_handle = (url: string): boolean => { const is_yt_handle = (url: string): boolean => {
if (!url || '' === url) { if (!url || '' === url) {
return false return false
@ -513,7 +492,6 @@ const convert_url = async (url: string): Promise<string> => {
const resp = await request('/api/yt-dlp/url/info?' + params.toString()) const resp = await request('/api/yt-dlp/url/info?' + params.toString())
const body = await resp.json() const body = await resp.json()
const channel_id = ag(body, 'channel_id', null) const channel_id = ag(body, 'channel_id', null)
console.log('convert_url', { url, channel_id, body })
if (channel_id) { if (channel_id) {
return url.replace(`/@${m.groups.handle}`, `/channel/${channel_id}`) return url.replace(`/@${m.groups.handle}`, `/channel/${channel_id}`)
@ -528,4 +506,34 @@ const convert_url = async (url: string): Promise<string> => {
return url return url
} }
const getDefault = (type: 'cookies' | 'cli' | 'template' | 'folder', ret: string = '') => {
if (false !== hasFormatInConfig.value || !form.preset) {
return ret
}
const preset = config.presets.find(p => p.name === form.preset)
if (!preset) {
return ret
}
if (type === 'cookies' && preset.cookies) {
return preset.cookies
}
if (type === 'cli' && preset.cli) {
return preset.cli
}
if (type === 'template' && preset.template) {
return preset.template
}
if (type === 'folder' && preset.folder) {
return preset.folder.replace(config.app.download_path, '') || ret
}
return ret
}
</script> </script>

3
ui/app/pages/index.vue
View file

@ -67,7 +67,8 @@
<DeprecatedNotice :version="config.app.app_version" title="Deprecation Notice" tone="warning" <DeprecatedNotice :version="config.app.app_version" title="Deprecation Notice" tone="warning"
icon="fas fa-exclamation-triangle fa-fade fa-spin-10"> icon="fas fa-exclamation-triangle fa-fade fa-spin-10">
<p> <p>
The following environment variables and features are deprecated and will be removed in future releases: The following environment variables and features are deprecated and will be removed in
<strong class="has-text-danger">v0.10.x</strong>
</p> </p>
<ul> <ul>
<li> <li>

10
ui/app/pages/tasks.vue
View file

@ -55,7 +55,8 @@
</div> </div>
<div class="is-hidden-mobile"> <div class="is-hidden-mobile">
<span class="subtitle"> <span class="subtitle">
The task runner is simple queue system that allows you to schedule downloads to run at the specific time. The task runner is simple queue system that allows you to poll channels or playlists for new content at
specified intervals.
</span> </span>
</div> </div>
</div> </div>
@ -361,9 +362,10 @@
<Message title="Tips" class="is-info is-background-info-80" icon="fas fa-info-circle"> <Message title="Tips" class="is-info is-background-info-80" icon="fas fa-info-circle">
<span> <span>
<ul> <ul>
<li>If you are adding a big channel or playlist and you want to skip all old videos, please click on <li>
<code>Actions > Archive All</code> button to mark all videos as downloaded. otherwise, it will try to If you don't wish to download <strong>ALL</strong> content from a channel or playlist, click on
download all videos. <code> <span class="icon"><i class="fa-solid fa-cogs" /></span> Actions > <span class="icon"><i
class="fa-solid fa-box-archive" /></span> Archive All</code> to archive all existing content.
</li> </li>
</ul> </ul>
</span> </span>