Portainer Templates logo

Portainer Templates

Tubearchivist Tubearchivist

Stack

Multimedia

Tubearchivist is your self hosted YouTube media server

Configuration

Type
Compose
Platform
linux
Source
Repo

Template by xneo1·Source

Services

tubearchivist

Configuration

Image
bbilly1/tubearchivist
Ports
8999:8000
Volumes
/youtube : /portainer/media/cache : /portainer/cache
Env vars
ES_URL=http://archivist-es:9200REDIS_HOST=archivist-redisHOST_UID=1000HOST_GID=1000TA_HOST=INSERT_YOURIP_OR_HOSTNAMETA_USERNAME=tubearchivistTA_PASSWORD=verysecretELASTIC_PASSWORD=verysecretTZ=Europe/Athens
Restart
unless-stopped

Image details

Pulls: 4.2M
User: bbilly1
Created: Sep 04, 2021
Updated: 1 day ago
Status: active

archivist-redis

Configuration

Image
redis/redis-stack-server
Volumes
/data : /portainer/Files/AppData/Config/tubearchivist/redis
Restart
unless-stopped

Image details

Pulls: 29.8M
User: kajo
Created: Mar 07, 2022
Updated: 9 months ago
Status: active

archivist-es

Configuration

Image
bbilly1/tubearchivist-es
Volumes
/usr/share/elasticsearch/data : /portainer/Files/AppData/Config/tubearchivist/es
Env vars
ELASTIC_PASSWORD=verysecretES_JAVA_OPTS=-Xms512m -Xmx512mxpack.security.enabled=truediscovery.type=single-nodepath.repo=/usr/share/elasticsearch/data/snapshot
Restart
unless-stopped

Image details

Pulls: 2.1M
User: bbilly1
Created: Mar 31, 2022
Updated: 6 months ago
Status: active

Standalone Install

Select an install method, to see config/commands for deploying Tubearchivist

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Tubearchivist, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

services:
  tubearchivist:
    container_name: tubearchivist
    restart: unless-stopped
    image: bbilly1/tubearchivist
    ports:
      - 8999:8000
    volumes:
      - /portainer/media:/youtube
      - /portainer/cache:/cache
    environment:
      - ES_URL=http://archivist-es:9200     # needs protocol e.g. http and port
      - REDIS_HOST=archivist-redis          # don't add protocol
      - HOST_UID=1000
      - HOST_GID=1000
      - TA_HOST=INSERT_YOURIP_OR_HOSTNAME         ##REQUIRED -  set your Server IP or host name
      - TA_USERNAME=tubearchivist           # your initial TA credentials
      - TA_PASSWORD=verysecret              # your initial TA credentials
      - ELASTIC_PASSWORD=verysecret         # set password for Elasticsearch
      - TZ=Europe/Athens                # set your time zone
    depends_on:
      - archivist-es
      - archivist-redis
  archivist-redis:
    image: redis/redis-stack-server
    container_name: archivist-redis
    restart: unless-stopped
    expose:
      - 6379
    volumes:
      - /portainer/Files/AppData/Config/tubearchivist/redis:/data
    depends_on:
      - archivist-es
  archivist-es:
    image: bbilly1/tubearchivist-es         # only for amd64, or use official es 8.7.0
    container_name: archivist-es
    restart: unless-stopped
    environment:
      - ELASTIC_PASSWORD=verysecret       # matching Elasticsearch password
      - ES_JAVA_OPTS=-Xms512m -Xmx512m
      - xpack.security.enabled=true
      - discovery.type=single-node
      - path.repo=/usr/share/elasticsearch/data/snapshot
    ulimits:
      memlock:
        soft: -1
        hard: -1
    volumes:
      - /portainer/Files/AppData/Config/tubearchivist/es:/usr/share/elasticsearch/data    # check for permission error when using bind mount, see readme
    expose:
      - 9200

Or deploy it directly from the source:

git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/tubearchivist.yml up -d

More install options in our documentation.

Container Documentation

tubearchivist Documentation

Your self hosted YouTube media server

archivist-redis Documentation

redis-stack-server installs a Redis server with additional database capabilities

archivist-es Documentation

Tube Archivist compatible Elasticsearch

Serve Tubearchivist on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying tubearchivist.example.com to http://tubearchivist:8000

Add this to your Caddyfile

tubearchivist.example.com {
	reverse_proxy http://tubearchivist:8000
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:8999 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :8999
  • Stop the other service, or pick a different host port. In 8999:8000 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:8999. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, tubearchivist can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 8999

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /portainer/media (and the same for the other mapped folders)

Image won't pull

Test the pull directly on the host: docker pull bbilly1/tubearchivist

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

Tubearchivist is a Compose stack, a set of containers (3 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.

The services

This stack is built from 3 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • tubearchivist runs bbilly1/tubearchivist, starts after archivist-es, archivist-redis
  • archivist-redis runs redis/redis-stack-server, starts after archivist-es
  • archivist-es runs bbilly1/tubearchivist-es

Ports

A port is the door the app answers on. A mapping like 8999:8000 means it's reachable on port 8999 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:8999 in a browser. It opens:

  • 8999:8000, likely the web interface

Volumes

A volume is where Tubearchivist keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /youtube from /portainer/media on the host
  • /cache from /portainer/cache on the host
  • /data from /portainer/Files/AppData/Config/tubearchivist/redis on the host
  • /usr/share/elasticsearch/data from /portainer/Files/AppData/Config/tubearchivist/es on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Tubearchivist takes 13 of them, all with defaults you can leave alone or tweak:

  • ES_URL, defaults to http://archivist-es:9200
  • REDIS_HOST, defaults to archivist-redis
  • HOST_UID, defaults to 1000
  • HOST_GID, defaults to 1000
  • TA_HOST, defaults to INSERT_YOURIP_OR_HOSTNAME
  • TA_USERNAME, defaults to tubearchivist
  • TA_PASSWORD, defaults to verysecret
  • ELASTIC_PASSWORD, defaults to verysecret
  • TZ, defaults to Europe/Athens
  • ES_JAVA_OPTS, defaults to -Xms512m -Xmx512m
  • xpack.security.enabled, defaults to true
  • discovery.type, defaults to single-node
  • path.repo, defaults to /usr/share/elasticsearch/data/snapshot

Restart policy

The restart policy here is unless-stopped, so Docker restarts Tubearchivist after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like tubearchivist) while only the ports above are open to you.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Tubearchivist up. Add the template list to Portainer once, then deploying Tubearchivist is a click rather than a wall of config.