Tube Archivist

https://docs.tubearchivist.com
Admin
Tube Archivist is a self-hosted YouTube media server that allows users to download, archive, and...
Tokens:14,950
Snippets:271
Trust Score:8.5
Update:6 months ago
Show doc for...
Tokens:
Raw
### Start Docker Containers

Source: https://docs.tubearchivist.com/installation/docker-for-beginners

Starts all services defined in your docker-compose.yml file in detached mode (-d). Downloads images if they are not present.

```bash
docker compose up -d

```

--------------------------------

### Cron Schedule Examples

Source: https://docs.tubearchivist.com/settings/scheduling

Examples of cron-like formats for scheduling tasks. Note that non-standard formats like 'number/number' are not supported; use '*/number' instead. Schedules are tied to the TZ environment variable.

```cron
0 15 *
```

```cron
30 8 */2
```

```cron
0 */3,8-17 *
```

```cron
0 8,16 *
```

```cron
auto
```

--------------------------------

### Run Docker Compose Up

Source: https://docs.tubearchivist.com/installation/proxmox-lxc

Starts the Tube Archivist services defined in the docker-compose.yml file in detached mode. Ensure you are in the directory containing your compose file.

```bash
docker compose up -d
```

--------------------------------

### Configure Elasticsearch Container

Source: https://docs.tubearchivist.com/installation/synology

Set up the Elasticsearch container with specific advanced settings, including auto-restart, volume mapping for data, port configuration, and essential environment variables for a single-node setup.

```bash
discovery.type
single-node
```

```bash
ES_JAVA_OPTS
-Xms512m -Xmx512m
```

```bash
UID
1000
```

```bash
GID
0
```

```bash
xpack.security.enabled
true
```

```bash
ELASTIC_PASSWORD
verysecret
```

```bash
path.repo
/usr/share/elasticsearch/data/snapshot
```

--------------------------------

### Authenticate API Request with Python Requests

Source: https://docs.tubearchivist.com/api/introduction

This Python script demonstrates how to make an authenticated GET request to the API using the requests library. Ensure you replace '<video-id>' with the correct ID and 'Token xxxxxxxxxx' with your actual token.

```python
import requests

url = "/api/video/<video-id>/"
headers = {"Authorization": "Token xxxxxxxxxx"}
response = requests.get(url, headers=headers)

```

--------------------------------

### PO Token Provider URL Configuration

Source: https://docs.tubearchivist.com/settings/application

This is the URL to use when configuring the PO token provider if you are using the example Docker container. It points to the service exposed by the container.

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

```

--------------------------------

### GET /api/video/<video-id>/

Source: https://docs.tubearchivist.com/api/introduction

Retrieve details for a specific video by its unique identifier.

```APIDOC
## GET /api/video/<video-id>/

### Description
Retrieve details for a specific video using its unique ID.

### Method
GET

### Endpoint
/api/video/<video-id>/

### Parameters
#### Path Parameters
- **video-id** (string) - Required - The unique identifier of the video.

### Request Example
curl -v /api/video/<video-id>/ -H "Authorization: Token xxxxxxxxxx"
```

--------------------------------

### List Elasticsearch Indices in TubeArchivist Container

Source: https://docs.tubearchivist.com/advanced

This command, run from within the Elasticsearch container, lists all indices starting with 'ta_*' and sorts them by name. It's useful for monitoring index status during mapping migrations or troubleshooting.

```bash
curl -u elastic:$ELASTIC_PASSWORD "localhost:9200/_cat/indices/ta_*?v&s=index"

```

--------------------------------

### Download Docker Images

Source: https://docs.tubearchivist.com/installation/synology

Search for and download the required Docker images from the Registry tab in the Synology Docker utility. Use the 'latest' tag for upgrades.

```bash
redis/redis-stack-server
```

```bash
docker.elastic.co/elasticsearch/elasticsearch:8.14.3
```

```bash
bbilly1/tubearchivist
```

--------------------------------

### Basic Docker Compose File Structure

Source: https://docs.tubearchivist.com/installation/docker-for-beginners

Defines services (containers) with their names and images. Ensure correct YAML indentation.

```yaml
services:
  container1:
    container_name: name1
    image: image1
  container2:
    container_name: name2
    image: image2

```

--------------------------------

### Bind Mount with Absolute Path

Source: https://docs.tubearchivist.com/installation/docker-for-beginners

Mounts a directory from the host system into a container using an absolute path. Ensure host permissions match container user permissions to avoid issues.

```yaml
volumes:
  - /media/docker/volume/youtube:/youtube

```

--------------------------------

### Bind Mount with Relative Path

Source: https://docs.tubearchivist.com/installation/docker-for-beginners

Mounts a directory from the host system into a container. The path './volume/youtube' is relative to the docker-compose.yml file location. Ensure host permissions match container user permissions to avoid issues.

```yaml
volumes:
  - ./volume/youtube:/youtube

```

--------------------------------

### Configure Redis Container

Source: https://docs.tubearchivist.com/installation/synology

Configure the Redis container, including enabling auto-restart, mapping the volume for data persistence, setting the local port, and linking it to the Elasticsearch container with an alias.

--------------------------------

### View Docker Container Logs

Source: https://docs.tubearchivist.com/installation/docker-for-beginners

Retrieves logs from all running containers. Use '-f' to follow the logs in real-time.

```bash
docker compose logs

```

```bash
docker compose logs tubearchivist

```

```bash
docker compose logs -f tubearchivist

```

```bash
docker compose logs -f

```

--------------------------------

### Access TubeArchivist Web Interface

Source: https://docs.tubearchivist.com/installation/proxmox-lxc

Navigate to your server's IP address and the configured port (default 9000) to access the TubeArchivist login screen. Use the credentials defined in your compose file.

```bash
http://123.123.123.123:9000
```

--------------------------------

### Test Notification Command

Source: https://docs.tubearchivist.com/settings/scheduling

Use this command to send a test notification to verify your Apprise link configuration. The output will appear in the container logs.

```bash
docker exec -it tubearchivist apprise -b "Hello from TA" <link>
```

--------------------------------

### Change Directory Permissions via CLI

Source: https://docs.tubearchivist.com/installation/synology

Use these commands to navigate to the correct directory and change ownership of the redis and es folders. Ensure SSH access is enabled and you have root privileges.

```bash
cd /volume1
```

```bash
cd Docker
```

```bash
cd TubeArchivist
```

```bash
chown 999:100 redis
```

```bash
chown 1000:0 es
```

```bash
ls -hl
```

```bash
logout
```

```bash
exit
```

--------------------------------

### Docker Compose for PO Token Provider

Source: https://docs.tubearchivist.com/settings/application

Use this Docker Compose configuration to set up the bgutil-ytdlp-pot-provider container. Ensure the image version matches the Tube Archivist backend requirements to avoid compatibility issues.

```yaml
services:
  bgutil-provider:
    image: brainicism/bgutil-ytdlp-pot-provider
    container_name: bgutil-provider
    restart: unless-stopped
    init: true
    expose:
      - "4416"

```

--------------------------------

### Minimum Required info.json Tags

Source: https://docs.tubearchivist.com/settings/actions

The absolute minimum JSON structure required for manually importing media files when using an info.json file.

```json
{
  "id": "",
  "channel_id": "",
  "title": "",
  "upload_date": "",
  "thumbnail": null
}
```

--------------------------------

### Authenticate API Request with Curl

Source: https://docs.tubearchivist.com/api/introduction

Use this curl command to authenticate your API requests by including your token in the Authorization header. Replace '<video-id>' with the actual video ID.

```bash
curl -v /api/video/<video-id>/ \
    -H "Authorization: Token xxxxxxxxxx"
```

--------------------------------

### Extract 'ta' Metadata using ffprobe

Source: https://docs.tubearchivist.com/settings/application

Use ffprobe to extract the 'ta' metadata tag from a video file and output it as JSON. Requires jq for parsing.

```bash
ffprobe -v quiet -show_entries format_tags -of json video.mp4 \
  | jq -r '.format.tags.ta

```

--------------------------------

### Enable Podman Systemd Restart Service

Source: https://docs.tubearchivist.com/installation/podman

Enable the systemd service to automatically restart Podman containers after reboots.

```bash
systemctl enable podman-restart.service

```

--------------------------------

### Configure Podman Pod Networking

Source: https://docs.tubearchivist.com/installation/podman

Add this to your docker-compose.yml to ensure containers run within the same network namespace, allowing communication via localhost or container names.

```yaml
x-podman:
    in_pod: true

```

--------------------------------

### Mount Docker Managed Volume to Container

Source: https://docs.tubearchivist.com/installation/docker-for-beginners

Mounts a Docker-managed volume (e.g., 'media') into a container at a specified path (e.g., '/youtube'). The left side is the host path (Docker managed), and the right side is the container path.

```yaml
volumes:
  - media:/youtube

```

--------------------------------

### Extract 'ta' Metadata using mediainfo

Source: https://docs.tubearchivist.com/settings/application

Use mediainfo to extract the 'ta' metadata tag from a video file and output it as JSON. Requires jq for parsing.

```bash
mediainfo --Output=JSON video.mp4 | jq -r '.media.track.[].extra.ta'

```

--------------------------------

### Mount Custom Stylesheet with Docker Compose

Source: https://docs.tubearchivist.com/configuration/stylesheets

Mount a local custom.css file into the tubearchivist container's static CSS directory. Ensure custom.css is in the same directory as your docker-compose.yml file.

```yaml
volumes:
  - media:/youtube
  - cache:/cache
  - ./custom.css:/app/static/css/custom.css
```

--------------------------------

### Follow Docker Compose Logs

Source: https://docs.tubearchivist.com/installation/proxmox-lxc

Streams the logs from all services defined in the docker-compose.yml file. Useful for monitoring the application and debugging issues.

```bash
docker compose logs -f
```

--------------------------------

### Reset Password via CLI

Source: https://docs.tubearchivist.com/users

Use the CLI to update a user's password when the web interface is inaccessible.

```bash
docker compose exec -it tubearchivist python manage.py ta_change_password tubearchivist 123456
```

--------------------------------

### Extended info.json Tags

Source: https://docs.tubearchivist.com/settings/actions

An expanded JSON structure for manual imports that includes additional metadata tags for a more complete result.

```json
{
  "id": "",
  "channel_id": "",
  "title": "",
  "upload_date": "",
  "description": null,
  "categories": null,
  "thumbnail": null,
  "tags": null,
  "view_count": null
}
```

--------------------------------

### Pull Docker Images

Source: https://docs.tubearchivist.com/installation/docker-for-beginners

Downloads (pulls) the images for all services defined in your docker-compose.yml file. Run from the directory containing the compose file.

```bash
docker compose pull

```

--------------------------------

### Set Container Restart Policy (unless-stopped)

Source: https://docs.tubearchivist.com/installation/podman

Configure a container to restart automatically unless it is explicitly stopped. This is an alternative to enabling the systemd restart service.

```yaml
    restart: unless-stopped

```

--------------------------------

### Publish Container Port to Host

Source: https://docs.tubearchivist.com/installation/docker-for-beginners

Map a container's internal port to a port on the host machine. The left side of the colon is the host port, and the right side is the container port. Use this to access services running inside containers from your browser or other host applications.

```yaml
ports:
  - "8080:8000"
```

```yaml
ports:
  - "8008:8000"
```

--------------------------------

### Set Container Restart Policy (always)

Source: https://docs.tubearchivist.com/installation/podman

Configure a container to always restart automatically. This is an alternative to enabling the systemd restart service.

```yaml
    restart: always

```

--------------------------------

### Check Elasticsearch Aliases

Source: https://docs.tubearchivist.com/advanced

Verify Elasticsearch aliases to ensure they are correctly pointing to the current index version. This is crucial after index management operations or potential interruptions.

```bash
curl -u elastic:$ELASTIC_PASSWORD "localhost:9200/_cat/aliases/ta_*?v&s=index"
```

--------------------------------

### Reactivate All Videos in TubeArchivist

Source: https://docs.tubearchivist.com/advanced

Use this command within the TA container to reactivate all videos marked as inactive in Elasticsearch. This ensures they are re-checked by the metadata refresh task.

```bash
curl -XPOST "$ES_URL/ta_video/_update_by_query?pretty" -u elastic:$ELASTIC_PASSWORD -H "Content-Type: application/json" -d '
{
"query": {
    "term": {
        "active": {
            "value": false
        }
    }
},
"script": {
    "source": "ctx._source.active = true",
    "lang": "painless"
}
}'

```

--------------------------------

### Reactivate All Playlists in TubeArchivist

Source: https://docs.tubearchivist.com/advanced

Run this command inside the TA container to reactivate all playlists marked as inactive. This prompts the metadata refresh task to check their current status on YouTube.

```bash
curl -XPOST "$ES_URL/ta_playlist/_update_by_query?pretty" -u elastic:$ELASTIC_PASSWORD -H "Content-Type: application/json" -d '
{
"query": {
    "term": {
        "playlist_active": {
            "value": false
        }
    }
},
"script": {
    "source": "ctx._source.playlist_active = true",
    "lang": "painless"
}
}'

```

--------------------------------

### Update Docker Containers

Source: https://docs.tubearchivist.com/installation/docker-for-beginners

Updates all containers to their latest images by pulling new images and then restarting the services. Always check release notes for breaking changes before updating.

```bash
docker compose pull
docker compose up -d

```

--------------------------------

### Configure Redis on a custom port

Source: https://docs.tubearchivist.com/installation/docker-compose

Update the Redis service command and expose port to use a non-standard port instead of the default 6379.

```yaml
services:
  archivist-redis:
    [...]
    command: --port 6380
    expose:
      - "6380"
    [...]
```

--------------------------------

### Reactivate All Channels in TubeArchivist

Source: https://docs.tubearchivist.com/advanced

Execute this command within the TA container to reactivate all channels marked as inactive. The metadata refresh task will then re-evaluate their status.

```bash
curl -XPOST "$ES_URL/ta_channel/_update_by_query?pretty" -u elastic:$ELASTIC_PASSWORD -H "Content-Type: application/json" -d '
{
"query": {
    "term": {
        "channel_active": {
            "value": false
        }
    }
},
"script": {
    "source": "ctx._source.channel_active = true",
    "lang": "painless"
}
}'

```

--------------------------------

### Stop Docker Compose Services

Source: https://docs.tubearchivist.com/installation/proxmox-lxc

Stops and removes all containers, networks, and volumes defined in the docker-compose.yml file. Use this before making significant configuration changes or troubleshooting.

```bash
docker compose down
```

--------------------------------

### Extract 'ta' Metadata using mutagen

Source: https://docs.tubearchivist.com/settings/application

Use the Python mutagen library to load MP4 metadata and extract the 'ta' tag, which is stored as a JSON string. Requires the mutagen library.

```python
import json
from mutagen.mp4 import MP4

video = MP4("video.mp4")
metadata = json.loads(video.tags["----:com.tubearchivist:ta"][0].decode())
print(metadata)

```

--------------------------------

### Stop Docker Containers

Source: https://docs.tubearchivist.com/installation/docker-for-beginners

Stops and removes all containers, networks, and volumes defined in your docker-compose.yml file. Run from the directory containing the compose file.

```bash
docker compose down

```

--------------------------------

### Expose Container Port for Inter-Container Communication

Source: https://docs.tubearchivist.com/installation/docker-for-beginners

Declare the port a service listens on internally for other containers to access. This is primarily for documentation and setting environment variables for inter-container communication, not for direct host access.

```yaml
expose:
  - "9200"
```

--------------------------------

### Change Directory Permissions

Source: https://docs.tubearchivist.com/installation/proxmox-lxc

Changes the ownership and permissions of a directory. This is often used to resolve file permission errors, particularly for Elasticsearch data volumes.

```bash
chown 1000:0 -R /path/to/mount/point
```

--------------------------------

### Define Docker Managed Volumes

Source: https://docs.tubearchivist.com/installation/docker-for-beginners

Declares Docker-managed volumes at the top level of the compose file. These are typically stored in /var/lib/docker/ on Linux.

```yaml
volumes:
  media:
  cache:
  redis:
  es:

```

--------------------------------

### Delete Elasticsearch Index

Source: https://docs.tubearchivist.com/advanced

Use this command to delete an existing Elasticsearch index, typically when a migration attempt was interrupted and the index needs to be cleared before retrying.

```bash
curl -u elastic:$ELASTIC_PASSWORD -XDELETE "localhost:9200/ta_download_v2"
```

--------------------------------

### Override CSS Properties for Paragraphs

Source: https://docs.tubearchivist.com/configuration/stylesheets

Add custom CSS rules to change the font-family of all paragraph elements. This can be done in your custom stylesheet.

```css
p {
    font-family: cursive;
}
```
Tokens:
Raw