tubearchivist/docs
1
0
Fork 0
mirror of https://github.com/tubearchivist/docs.git synced 2025-04-04 19:20:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

add cast docs

Browse Source
This commit is contained in:
Simon 2025-03-08 20:35:18 +07:00
parent 7a98e62f17
commit 0cb87169bb
No known key found for this signature in database
GPG Key ID: 2C15AA5E89985DD4
2 changed files with 10 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
mkdocs/docs/installation/env-vars.md
View File

@ -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]
<span class="tag-neutral">Type: Boolean</span>
Configure TA to use LDAP for authentication. See [configuration/ldap](../configuration/ldap.md) for more details.
## ENABLE_CAST
<span class="tag-optional">Optional</span>
<span class="tag-neutral">Type: Boolean</span>
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
<span class="tag-optional">Optional</span>
<span class="tag-neutral">Type: Boolean</span>

12
mkdocs/docs/settings/application.md
View File

@ -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.