tubearchivist/docs
1
0
Fork 0
mirror of https://github.com/tubearchivist/docs.git synced 2025-08-29 10:58:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add docs for TA_AUTO_UPDATE_YTDLP (#64)

Browse Source 
* Add docs for TA_AUTO_UPDATE_YTDLP

* Remove old update instructions

* fix relative link

---------

Co-authored-by: Simon <simobilleter@gmail.com>
This commit is contained in:
Craig Alexander 2025-07-31 10:53:30 -04:00 committed by GitHub
parent e3ce39c8b3
commit f9776a2c4a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 9 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
mkdocs/docs/advanced.md
View File

@ -126,27 +126,7 @@ Then you can restart the container and the migration will run again. If your err
This project strives for timely updates when yt-dlp makes a new release, but sometimes ideals meet reality. Also, sometimes yt-dlp has a fix published, but not yet released.
**Build your own image**: Update the version in `requirements.txt` and rebuild the image from `Dockerfile`. This will use your own image, even on container rebuild.
**Update yt-dlp on its own**: You can also update the yt-dlp library alone in the container.
- Restart your container for changes to take effect.
- These changes won't persist a container rebuild from image.
Update to newest regular yt-dlp release:
```bash
pip install --upgrade yt-dlp
```
To update to nightly you'll have to specify the correct `--target` folder:
```bash
pip install \
--upgrade \
--target=/root/.local/bin \
https://github.com/yt-dlp/yt-dlp/archive/master.tar.gz
```
This is obviously particularly likely to create problems. Also note that the `--version` command will only show the latest regular release, not a nightly version mentioned.
To update, set the [TA_AUTO_UPDATE_YTDLP](installation/env-vars.md#ta_auto_update_ytdlp) environment variable and restart your container. If this makes things worse and you wish to undo the update, unset the variable and recreate your container.
## Erase errors from download queue
Sometimes videos will fail to download. That can be because of expected errors:

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

@ -81,6 +81,14 @@ 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.
## TA_AUTO_UPDATE_YTDLP
<span class="tag-optional">Optional</span>
<span class="tag-neutral">Type: String</span>
Configure TA to automatically install the latest yt-dlp on container start. Enable by setting to `release` or `nightly` depending on which version you would like to install.
!!! warning "Potential Incompatibility"
Future versions of yt-dlp may not be compatible with your current Tube Archivist version. If you encounter errors while downloading, remove the value and recreate your container to restore the default version.
## DISABLE_STATIC_AUTH
<span class="tag-optional">Optional</span>
<span class="tag-neutral">Type: Boolean</span>