Tube Archivist¶

Description / name	Input element
Your domain name

Overview¶

Tube Archivist is a self-hosted YouTube media server designed to help users download, index, and organize their favorite YouTube content for offline viewing.

Manual

Releases

Community

Deployment¶

sb install sandbox-tubearchivist

Usage¶

Visit https://tubearchivist.iYOUR_DOMAIN_NAMEi.

Basics¶

Default login:

Username: "your user from accounts.yml"
Password: your_normal_password

Note

Tubearchivist adds the downloaded media to /mnt/unionfs/downloads/tubearchivist/YT_CHANNEL_NAME

Role Defaults¶

Use the Inventory to customize variables. (1)

Example override
```
tubearchivist_name: "custom_value"
```
Avoid overriding variables ending in _default

When overriding variables that end in _default (like tubearchivist_docker_envs_default), you replace the entire default configuration. Future updates that add new default values will not be applied to your setup, potentially breaking functionality.

Instead, use the corresponding _custom variable (like tubearchivist_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.

BasicsSettingsWebDNSTraefikDockerDocker+Global Override Options

tubearchivist_name

# Type: string
tubearchivist_name: tubearchivist

tubearchivist_role_enable_cast

# Type: string
tubearchivist_role_enable_cast: "false"

tubearchivist_role_web_subdomain

# Type: string
tubearchivist_role_web_subdomain: "{{ tubearchivist_name }}"

tubearchivist_role_web_domain

# Type: string
tubearchivist_role_web_domain: "{{ user.domain }}"

tubearchivist_role_web_port

# Type: string
tubearchivist_role_web_port: "8000"

tubearchivist_role_web_url

# Type: string
tubearchivist_role_web_url: "{{ 'https://' + (lookup('role_var', '_web_subdomain', role='tubearchivist') + '.' + lookup('role_var', '_web_domain', role='tubearchivist')
                             if (lookup('role_var', '_web_subdomain', role='tubearchivist') | length > 0)
                             else lookup('role_var', '_web_domain', role='tubearchivist')) }}"

tubearchivist_role_dns_record

# Type: string
tubearchivist_role_dns_record: "{{ lookup('role_var', '_web_subdomain', role='tubearchivist') }}"

tubearchivist_role_dns_zone

# Type: string
tubearchivist_role_dns_zone: "{{ lookup('role_var', '_web_domain', role='tubearchivist') }}"

tubearchivist_role_dns_proxy

# Type: bool (true/false)
tubearchivist_role_dns_proxy: "{{ dns_proxied }}"

tubearchivist_role_traefik_sso_middleware

# Type: string
tubearchivist_role_traefik_sso_middleware: "{{ traefik_default_sso_middleware }}"

tubearchivist_role_traefik_middleware_default

# Type: string
tubearchivist_role_traefik_middleware_default: "{{ traefik_default_middleware }}"

tubearchivist_role_traefik_middleware_custom

# Type: string
tubearchivist_role_traefik_middleware_custom: ""

tubearchivist_role_traefik_certresolver

# Type: string
tubearchivist_role_traefik_certresolver: "{{ traefik_default_certresolver }}"

tubearchivist_role_traefik_enabled

# Type: bool (true/false)
tubearchivist_role_traefik_enabled: true

tubearchivist_role_traefik_api_enabled

# Type: bool (true/false)
tubearchivist_role_traefik_api_enabled: true

tubearchivist_role_traefik_api_endpoint

# Type: string
tubearchivist_role_traefik_api_endpoint: "PathPrefix(`/api`)"

Container

tubearchivist_role_docker_container

# Type: string
tubearchivist_role_docker_container: "{{ tubearchivist_name }}"

Image

tubearchivist_role_docker_image_pull

# Type: bool (true/false)
tubearchivist_role_docker_image_pull: true

tubearchivist_role_docker_image_tag

# Type: string
tubearchivist_role_docker_image_tag: "v0.4.13"

tubearchivist_role_docker_image_repo

# Type: string
tubearchivist_role_docker_image_repo: "bbilly1/tubearchivist"

tubearchivist_role_docker_image

# Type: string
tubearchivist_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='tubearchivist') }}:{{ lookup('role_var', '_docker_image_tag', role='tubearchivist') }}"

Envs

tubearchivist_role_docker_envs_http_header

# Type: string
tubearchivist_role_docker_envs_http_header: "{{ 'HTTP_REMOTE_USER'
                                             if ('authelia' in lookup('role_var', '_traefik_sso_middleware', role='tubearchivist'))
                                             else ('HTTP_X_AUTHENTIK_USERNAME'
                                                  if ('authentik' in lookup('role_var', '_traefik_sso_middleware', role='tubearchivist'))
                                                  else '') }}"

tubearchivist_role_docker_envs_default

# Type: dict
tubearchivist_role_docker_envs_default:
  TZ: "{{ tz }}"
  ES_URL: "http://{{ tubearchivist_name }}-elasticsearch:9200"
  REDIS_HOST: "{{ tubearchivist_name }}-redis"
  HOST_UID: "{{ uid }}"
  HOST_GID: "{{ gid }}"
  TA_HOST: "localhost 127.0.0.1 {{ tubearchivist_name }} {{ lookup('role_var', '_web_subdomain', role='tubearchivist') + '.' + lookup('role_var', '_web_domain', role='tubearchivist') }} {{ lookup('role_var', '_web_url', role='tubearchivist') }}"
  TA_ENABLE_AUTH_PROXY: "{{ 'true' if (lookup('role_var', '_traefik_sso_middleware', role='tubearchivist') | length > 0) else omit }}"
  TA_AUTH_PROXY_USERNAME_HEADER: "{{ lookup('role_var', '_docker_envs_http_header', role='tubearchivist') if (lookup('role_var', '_traefik_sso_middleware', role='tubearchivist') | length > 0) else omit }}"
  TA_USERNAME: "{{ user.name }}"
  TA_PASSWORD: "{{ user.pass }}"
  ELASTIC_PASSWORD: "{{ lookup('role_var', '_docker_env_password', role='elasticsearch') }}"
  ENABLE_CAST: "{{ lookup('role_var', '_enable_cast', role='tubearchivist') }}"

tubearchivist_role_docker_envs_custom

# Type: dict
tubearchivist_role_docker_envs_custom: {}

Volumes

tubearchivist_role_docker_volumes_default

# Type: list
tubearchivist_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_downloads_location', role='tubearchivist') }}/:/youtube"
  - "{{ lookup('role_var', '_paths_location', role='tubearchivist') }}/cache:/cache"

tubearchivist_role_docker_volumes_custom

# Type: list
tubearchivist_role_docker_volumes_custom: []

Hostname

tubearchivist_role_docker_hostname

# Type: string
tubearchivist_role_docker_hostname: "{{ tubearchivist_name }}"

Networks

tubearchivist_role_docker_networks_alias

# Type: string
tubearchivist_role_docker_networks_alias: "{{ tubearchivist_name }}"

tubearchivist_role_docker_networks_default

# Type: list
tubearchivist_role_docker_networks_default: []

tubearchivist_role_docker_networks_custom

# Type: list
tubearchivist_role_docker_networks_custom: []

Restart Policy

tubearchivist_role_docker_restart_policy

# Type: string
tubearchivist_role_docker_restart_policy: unless-stopped

State

tubearchivist_role_docker_state

# Type: string
tubearchivist_role_docker_state: started

Dependencies

tubearchivist_role_depends_on

# Type: string
tubearchivist_role_depends_on: "{{ tubearchivist_name }}-elasticsearch,{{ tubearchivist_name }}-redis"

tubearchivist_role_depends_on_delay

# Type: string (quoted number)
tubearchivist_role_depends_on_delay: "0"

tubearchivist_role_depends_on_healthchecks

# Type: string ("true"/"false")
tubearchivist_role_depends_on_healthchecks: "false"

The following advanced options are available via create_docker_container but are not defined in the role. See: docker_container module

Resource Limits

tubearchivist_role_docker_blkio_weight

# Type: int
tubearchivist_role_docker_blkio_weight:

tubearchivist_role_docker_cpu_period

# Type: int
tubearchivist_role_docker_cpu_period:

tubearchivist_role_docker_cpu_quota

# Type: int
tubearchivist_role_docker_cpu_quota:

tubearchivist_role_docker_cpu_shares

# Type: int
tubearchivist_role_docker_cpu_shares:

tubearchivist_role_docker_cpus

# Type: string
tubearchivist_role_docker_cpus:

tubearchivist_role_docker_cpuset_cpus

# Type: string
tubearchivist_role_docker_cpuset_cpus:

tubearchivist_role_docker_cpuset_mems

# Type: string
tubearchivist_role_docker_cpuset_mems:

tubearchivist_role_docker_kernel_memory

# Type: string
tubearchivist_role_docker_kernel_memory:

tubearchivist_role_docker_memory

# Type: string
tubearchivist_role_docker_memory:

tubearchivist_role_docker_memory_reservation

# Type: string
tubearchivist_role_docker_memory_reservation:

tubearchivist_role_docker_memory_swap

# Type: string
tubearchivist_role_docker_memory_swap:

tubearchivist_role_docker_memory_swappiness

# Type: int
tubearchivist_role_docker_memory_swappiness:

tubearchivist_role_docker_shm_size

# Type: string
tubearchivist_role_docker_shm_size:

Security & Devices

tubearchivist_role_docker_cap_drop

# Type: list
tubearchivist_role_docker_cap_drop:

tubearchivist_role_docker_cgroupns_mode

# Type: string
tubearchivist_role_docker_cgroupns_mode:

tubearchivist_role_docker_device_cgroup_rules

# Type: list
tubearchivist_role_docker_device_cgroup_rules:

tubearchivist_role_docker_device_read_bps

# Type: list
tubearchivist_role_docker_device_read_bps:

tubearchivist_role_docker_device_read_iops

# Type: list
tubearchivist_role_docker_device_read_iops:

tubearchivist_role_docker_device_requests

# Type: list
tubearchivist_role_docker_device_requests:

tubearchivist_role_docker_device_write_bps

# Type: list
tubearchivist_role_docker_device_write_bps:

tubearchivist_role_docker_device_write_iops

# Type: list
tubearchivist_role_docker_device_write_iops:

tubearchivist_role_docker_devices

# Type: list
tubearchivist_role_docker_devices:

tubearchivist_role_docker_devices_default

# Type: string
tubearchivist_role_docker_devices_default:

tubearchivist_role_docker_groups

# Type: list
tubearchivist_role_docker_groups:

tubearchivist_role_docker_privileged

# Type: bool (true/false)
tubearchivist_role_docker_privileged:

tubearchivist_role_docker_security_opts

# Type: list
tubearchivist_role_docker_security_opts:

tubearchivist_role_docker_user

# Type: string
tubearchivist_role_docker_user:

tubearchivist_role_docker_userns_mode

# Type: string
tubearchivist_role_docker_userns_mode:

Networking

tubearchivist_role_docker_dns_opts

# Type: list
tubearchivist_role_docker_dns_opts:

tubearchivist_role_docker_dns_search_domains

# Type: list
tubearchivist_role_docker_dns_search_domains:

tubearchivist_role_docker_dns_servers

# Type: list
tubearchivist_role_docker_dns_servers:

tubearchivist_role_docker_domainname

# Type: string
tubearchivist_role_docker_domainname:

tubearchivist_role_docker_exposed_ports

# Type: list
tubearchivist_role_docker_exposed_ports:

tubearchivist_role_docker_hosts

# Type: dict
tubearchivist_role_docker_hosts:

tubearchivist_role_docker_hosts_use_common

# Type: bool (true/false)
tubearchivist_role_docker_hosts_use_common:

tubearchivist_role_docker_ipc_mode

# Type: string
tubearchivist_role_docker_ipc_mode:

tubearchivist_role_docker_links

# Type: list
tubearchivist_role_docker_links:

tubearchivist_role_docker_network_mode

# Type: string
tubearchivist_role_docker_network_mode:

tubearchivist_role_docker_pid_mode

# Type: string
tubearchivist_role_docker_pid_mode:

tubearchivist_role_docker_ports

# Type: list
tubearchivist_role_docker_ports:

tubearchivist_role_docker_uts

# Type: string
tubearchivist_role_docker_uts:

Storage

tubearchivist_role_docker_keep_volumes

# Type: bool (true/false)
tubearchivist_role_docker_keep_volumes:

tubearchivist_role_docker_mounts

# Type: list
tubearchivist_role_docker_mounts:

tubearchivist_role_docker_storage_opts

# Type: dict
tubearchivist_role_docker_storage_opts:

tubearchivist_role_docker_tmpfs

# Type: list
tubearchivist_role_docker_tmpfs:

tubearchivist_role_docker_volume_driver

# Type: string
tubearchivist_role_docker_volume_driver:

tubearchivist_role_docker_volumes_from

# Type: list
tubearchivist_role_docker_volumes_from:

tubearchivist_role_docker_volumes_global

# Type: bool (true/false)
tubearchivist_role_docker_volumes_global:

tubearchivist_role_docker_working_dir

# Type: string
tubearchivist_role_docker_working_dir:

Monitoring & Lifecycle

tubearchivist_role_docker_auto_remove

# Type: bool (true/false)
tubearchivist_role_docker_auto_remove:

tubearchivist_role_docker_cleanup

# Type: bool (true/false)
tubearchivist_role_docker_cleanup:

tubearchivist_role_docker_force_kill

# Type: string
tubearchivist_role_docker_force_kill:

tubearchivist_role_docker_healthcheck

# Type: dict
tubearchivist_role_docker_healthcheck:

tubearchivist_role_docker_healthy_wait_timeout

# Type: int
tubearchivist_role_docker_healthy_wait_timeout:

tubearchivist_role_docker_init

# Type: bool (true/false)
tubearchivist_role_docker_init:

tubearchivist_role_docker_kill_signal

# Type: string
tubearchivist_role_docker_kill_signal:

tubearchivist_role_docker_log_driver

# Type: string
tubearchivist_role_docker_log_driver:

tubearchivist_role_docker_log_options

# Type: dict
tubearchivist_role_docker_log_options:

tubearchivist_role_docker_oom_killer

# Type: bool (true/false)
tubearchivist_role_docker_oom_killer:

tubearchivist_role_docker_oom_score_adj

# Type: int
tubearchivist_role_docker_oom_score_adj:

tubearchivist_role_docker_output_logs

# Type: bool (true/false)
tubearchivist_role_docker_output_logs:

tubearchivist_role_docker_paused

# Type: bool (true/false)
tubearchivist_role_docker_paused:

tubearchivist_role_docker_recreate

# Type: bool (true/false)
tubearchivist_role_docker_recreate:

tubearchivist_role_docker_restart_retries

# Type: int
tubearchivist_role_docker_restart_retries:

tubearchivist_role_docker_stop_timeout

# Type: int
tubearchivist_role_docker_stop_timeout:

Other Options

tubearchivist_role_docker_capabilities

# Type: list
tubearchivist_role_docker_capabilities:

tubearchivist_role_docker_cgroup_parent

# Type: string
tubearchivist_role_docker_cgroup_parent:

tubearchivist_role_docker_commands

# Type: list
tubearchivist_role_docker_commands:

tubearchivist_role_docker_create_timeout

# Type: int
tubearchivist_role_docker_create_timeout:

tubearchivist_role_docker_entrypoint

# Type: string
tubearchivist_role_docker_entrypoint:

tubearchivist_role_docker_env_file

# Type: string
tubearchivist_role_docker_env_file:

tubearchivist_role_docker_labels

# Type: dict
tubearchivist_role_docker_labels:

tubearchivist_role_docker_labels_use_common

# Type: bool (true/false)
tubearchivist_role_docker_labels_use_common:

tubearchivist_role_docker_read_only

# Type: bool (true/false)
tubearchivist_role_docker_read_only:

tubearchivist_role_docker_runtime

# Type: string
tubearchivist_role_docker_runtime:

tubearchivist_role_docker_sysctls

# Type: list
tubearchivist_role_docker_sysctls:

tubearchivist_role_docker_ulimits

# Type: list
tubearchivist_role_docker_ulimits:

tubearchivist_role_autoheal_enabled

# Enable or disable Autoheal monitoring for the container created when deploying
# Type: bool (true/false)
tubearchivist_role_autoheal_enabled: true

tubearchivist_role_depends_on

# List of container dependencies that must be running before the container start
# Type: string
tubearchivist_role_depends_on: ""

tubearchivist_role_depends_on_delay

# Delay in seconds before starting the container after dependencies are ready
# Type: string (quoted number)
tubearchivist_role_depends_on_delay: "0"

tubearchivist_role_depends_on_healthchecks

# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
tubearchivist_role_depends_on_healthchecks:

tubearchivist_role_diun_enabled

# Enable or disable Diun update notifications for the container created when deploying
# Type: bool (true/false)
tubearchivist_role_diun_enabled: true

tubearchivist_role_dns_enabled

# Enable or disable automatic DNS record creation for the container
# Type: bool (true/false)
tubearchivist_role_dns_enabled: true

tubearchivist_role_docker_controller

# Enable or disable Saltbox Docker Controller management for the container
# Type: bool (true/false)
tubearchivist_role_docker_controller: true

tubearchivist_role_docker_env_password

# Type: string
tubearchivist_role_docker_env_password:

tubearchivist_role_docker_envs_http_header

# Type: string
tubearchivist_role_docker_envs_http_header:

tubearchivist_role_docker_image_repo

# Type: string
tubearchivist_role_docker_image_repo:

tubearchivist_role_docker_image_tag

# Type: string
tubearchivist_role_docker_image_tag:

tubearchivist_role_docker_volumes_download

# Type: bool (true/false)
tubearchivist_role_docker_volumes_download:

tubearchivist_role_enable_cast

# Type: string
tubearchivist_role_enable_cast:

tubearchivist_role_paths_downloads_location

# Type: string
tubearchivist_role_paths_downloads_location:

tubearchivist_role_paths_location

# Type: string
tubearchivist_role_paths_location:

tubearchivist_role_themepark_addons

# Type: string
tubearchivist_role_themepark_addons:

tubearchivist_role_themepark_app

# Type: string
tubearchivist_role_themepark_app:

tubearchivist_role_themepark_theme

# Type: string
tubearchivist_role_themepark_theme:

tubearchivist_role_traefik_api_endpoint

# Type: dict/omit
tubearchivist_role_traefik_api_endpoint:

tubearchivist_role_traefik_api_middleware

# Type: string
tubearchivist_role_traefik_api_middleware:

tubearchivist_role_traefik_api_middleware_http

# Type: string
tubearchivist_role_traefik_api_middleware_http:

tubearchivist_role_traefik_autodetect_enabled

# Enable Traefik autodetect middleware for the container
# Type: bool (true/false)
tubearchivist_role_traefik_autodetect_enabled: false

tubearchivist_role_traefik_certresolver

# Type: string
tubearchivist_role_traefik_certresolver:

tubearchivist_role_traefik_crowdsec_enabled

# Enable CrowdSec middleware for the container
# Type: bool (true/false)
tubearchivist_role_traefik_crowdsec_enabled: false

tubearchivist_role_traefik_error_pages_enabled

# Enable custom error pages middleware for the container
# Type: bool (true/false)
tubearchivist_role_traefik_error_pages_enabled: false

tubearchivist_role_traefik_gzip_enabled

# Enable gzip compression middleware for the container
# Type: bool (true/false)
tubearchivist_role_traefik_gzip_enabled: false

tubearchivist_role_traefik_middleware_http

# Type: string
tubearchivist_role_traefik_middleware_http:

tubearchivist_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
tubearchivist_role_traefik_middleware_http_api_insecure:

tubearchivist_role_traefik_middleware_http_insecure

# Type: bool (true/false)
tubearchivist_role_traefik_middleware_http_insecure:

tubearchivist_role_traefik_priority

# Type: string
tubearchivist_role_traefik_priority:

tubearchivist_role_traefik_robot_enabled

# Enable robots.txt middleware for the container
# Type: bool (true/false)
tubearchivist_role_traefik_robot_enabled: true

tubearchivist_role_traefik_sso_middleware

# Type: string
tubearchivist_role_traefik_sso_middleware:

tubearchivist_role_traefik_tailscale_enabled

# Enable Tailscale-specific Traefik configuration for the container
# Type: bool (true/false)
tubearchivist_role_traefik_tailscale_enabled: false

tubearchivist_role_traefik_wildcard_enabled

# Enable wildcard certificate for the container
# Type: bool (true/false)
tubearchivist_role_traefik_wildcard_enabled: true

tubearchivist_role_web_domain

# Type: string
tubearchivist_role_web_domain:

tubearchivist_role_web_fqdn_override

# Override the Traefik fully qualified domain name (FQDN) for the container
# Type: list
tubearchivist_role_web_fqdn_override:

Example Override

tubearchivist_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "tubearchivist2.{{ user.domain }}"
  - "tubearchivist.otherdomain.tld"

Note: Include {{ traefik_host }} to preserve the default FQDN alongside your custom entries

tubearchivist_role_web_host_override

# Override the Traefik web host configuration for the container
# Type: string
tubearchivist_role_web_host_override:

Example Override

tubearchivist_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'tubearchivist2.' + user.domain }}`)"

Note: Use {{ traefik_host }} to include the default host configuration in your custom rule

tubearchivist_role_web_http_port

# Type: string (quoted number)
tubearchivist_role_web_http_port:

tubearchivist_role_web_http_scheme

# Type: string ("http"/"https")
tubearchivist_role_web_http_scheme:

tubearchivist_role_web_http_serverstransport

# Type: dict/omit
tubearchivist_role_web_http_serverstransport:

tubearchivist_role_web_scheme

# URL scheme to use for web access to the container
# Type: string ("http"/"https")
tubearchivist_role_web_scheme:

tubearchivist_role_web_serverstransport

# Type: dict/omit
tubearchivist_role_web_serverstransport:

tubearchivist_role_web_subdomain

# Type: string
tubearchivist_role_web_subdomain:

tubearchivist_role_web_url

# Type: string
tubearchivist_role_web_url: