From 0cb87169bbc21002013217bbe71b9f81f8c393cc Mon Sep 17 00:00:00 2001 From: Simon Date: Sat, 8 Mar 2025 20:35:18 +0700 Subject: [PATCH] add cast docs --- mkdocs/docs/installation/env-vars.md | 10 +--------- mkdocs/docs/settings/application.md | 12 +++++++++--- 2 files changed, 10 insertions(+), 12 deletions(-) diff --git a/mkdocs/docs/installation/env-vars.md b/mkdocs/docs/installation/env-vars.md index 683c601..1b9d297 100644 --- a/mkdocs/docs/installation/env-vars.md +++ b/mkdocs/docs/installation/env-vars.md @@ -16,7 +16,7 @@ This is a comprehensive list of environment variables for the **Tube Archivist** Set the environment variable `TA_HOST` to match with the expected origin from where you will access your **Tube Archivist** instance. That is whatever you input into your browser URL bar. - This can be a domain like *example.com*, a subdomain like *ta.example.com* or an IP address like *192.168.1.20*. -- If you are running **Tube Archivist** behind a SSL reverse proxy, specify the protocol (`https://`). +- Define the protocol, e.g. `https://` oder `http://`. - Specify the port If you are using a nonstandard port. - You can add multiple hostnames separated with a space. - Any wrong configurations here will result in a `Bad Request (400)` response. @@ -75,14 +75,6 @@ Configure TA to authenticate with a auth proxy. See [configuration/forward-auth] Type: Boolean Configure TA to use LDAP for authentication. See [configuration/ldap](../configuration/ldap.md) for more details. -## ENABLE_CAST -Optional -Type: Boolean -Enable casting support. See [configuration/cast](../configuration/cast.md) for more details. - -!!! info - Enabling Cast also requires to disable authentication for your static files by setting the `DISABLE_STATIC_AUTH` variable. - ## DISABLE_STATIC_AUTH Optional Type: Boolean diff --git a/mkdocs/docs/settings/application.md b/mkdocs/docs/settings/application.md index 124aed5..598a02b 100644 --- a/mkdocs/docs/settings/application.md +++ b/mkdocs/docs/settings/application.md @@ -71,9 +71,12 @@ Enabling subtitle indexing will add the lines to Elasticsearch and will make sub ## Comments ### Index Comments -Set your configuration for downloading and indexing comments. This takes the same values as documented in the `max_comments` section for the youtube extractor of [yt-dlp](https://github.com/yt-dlp/yt-dlp#youtube). Add, without spaces, between the four different fields: *max-comments,max-parents,max-replies,max-replies-per-thread*. Example: - - `all,100,all,30`: Get 100 max-parents and 30 max-replies-per-thread. - - `1000,all,all,50`: Get a total of 1000 comments over all, 50 replies per thread. +Set your configuration for downloading and indexing comments. This takes the same values as documented in the `max_comments` section for the youtube extractor of [yt-dlp](https://github.com/yt-dlp/yt-dlp#youtube). Add, without spaces, between the four different fields: *max-comments,max-parents,max-replies,max-replies-per-thread*. + +Example: + +- `all,100,all,30`: Get 100 max-parents and 30 max-replies-per-thread. +- `1000,all,all,50`: Get a total of 1000 comments over all, 50 replies per thread. ### Comment sort method Change sort method between *top* or *new*. The default is *top*, as decided by YouTube. @@ -124,6 +127,9 @@ This will return dislikes and average ratings for each video by integrating with ### SponsorBlock Using [SponsorBlock](https://sponsor.ajay.app/) to retrieve timestamps for, and skip, sponsored content. If a video doesn't have timestamps, or has unlocked timestamps, use the browser addon to contribute to this excellent project. Can also be activated and deactivated on a per [channel overwrite](../channels.md#about). +### Cast +For more details see [configuration/cast](../configuration/cast.md). + ## Snapshots !!! info This will make a snapshot of your metadata index only. No media files or additional configuration variables you have set on the settings page will be backed up.