Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions mkdocs/docs/settings/application.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,43 @@ There is only one cookie per Tube Archivist instance. This will be shared betwee
## PO Token
Also known as _proof of origin token_, this is a token required in some cases by YT to validate the requests. See the wiki on the yt-dlp repo with more info, particularly the [PO Token Guide](https://github.com/yt-dlp/yt-dlp/wiki/PO-Token-Guide) page.

## PO Token Provider URL
yt-dlp offers a [plugin](https://github.com/yt-dlp/yt-dlp/wiki/PO-Token-Guide#po-token-provider-plugins) to support for the Proof of Origin (PO) Token.
In an effort to make it easier for the user, **Tube Archivist** has implemented the plugin:

- [bgutil-ytdlp-pot-provider](https://github.com/Brainicism/bgutil-ytdlp-pot-provider) by [Brainicism](https://github.com/Brainicism)

### Installation
The following is a suggested docker-compose.yml to use the plugin with the default **Tube Archivist** container.
The default container creates it's own network named tubearchivist_default.
Please customize this example to your needs.

```yml
services:
bgutil-provider:
image: brainicism/bgutil-ytdlp-pot-provider
container_name: bgutil-provider
restart: unless-stopped
init: true
ports:
- "4416:4416"
environment:
- TZ=Etc/UTC
networks:
- tubearchivist_default

networks:
tubearchivist_default:
external: true
```

### Configuration
If you are using the above example docker container for **bgutil-ytdlp-pot-provider**, here is an example of what the URL would be:

```text
http://bgutil-provider:4416
```

## Integrations
All third party integrations of **Tube Archivist** will **always** be *opt in*.

Expand Down