Portainer Templates logo

Portainer Templates

Asciinema {shmolf} Asciinema {shmolf}

Stack

Tools

Self-hosted terminal recording and playback

Configuration

Type
Compose
Platform
linux
Env vars
PUID=1000PGID=1000HOST_NAME=localhostHOST_PORT=3033SECRET_KEY=please-change-this-to-a-random-secret
Source
Repo

Template by shmolf·Source

Notes

Application documentation 🗗
For the application secret key, you can use the terminal command tr -dc A-Za-z0-9 </dev/urandom | head -c 64; echo

Services

asciinema

Configuration

Image
ghcr.io/asciinema/asciinema-server:20231217
Ports
${HOST_PORT}:4000
Volumes
/var/opt/asciinema : asciinema_data
Env vars
SECRET_KEY_BASE=${SECRET_KEY}URL_HOST=${HOST_NAME}URL_PORT=${HOST_PORT}PUID=${PUID}PGID=${PGID}
Restart
unless-stopped

Image details

User: asciinema

postgres

Configuration

Image
docker.io/library/postgres:14
Volumes
/var/lib/postgresql/data : postgres_data
Env vars
POSTGRES_HOST_AUTH_METHOD=trust
Restart
unless-stopped

Image details

Pulls: 11.2B
User: stackbrew
Created: Jun 05, 2014
Updated: 40 minutes ago
Status: active

Standalone Install

Select an install method, to see config/commands for deploying Asciinema {shmolf}

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 Asciinema {shmolf}, 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:
  asciinema:
    image: ghcr.io/asciinema/asciinema-server:20231217
    ports:
      - '${HOST_PORT}:4000'
    environment:
      # created with: tr -dc A-Za-z0-9 </dev/urandom | head -c 64; echo
      - SECRET_KEY_BASE=${SECRET_KEY}
      - URL_HOST=${HOST_NAME}
      - URL_PORT=${HOST_PORT}
      - PUID=${PUID}
      - PGID=${PGID}
    volumes:
      - asciinema_data:/var/opt/asciinema
    restart: unless-stopped
    depends_on:
      postgres:
        condition: service_healthy

  postgres:
    image: docker.io/library/postgres:14
    environment:
      - POSTGRES_HOST_AUTH_METHOD=trust
    volumes:
      - postgres_data:/var/lib/postgresql/data
    restart: unless-stopped
    healthcheck:
      test: ['CMD-SHELL', 'pg_isready -U postgres']
      interval: 2s
      timeout: 5s
      retries: 10

volumes:
  asciinema_data:
  postgres_data:

Or deploy it directly from the source:

git clone https://github.com/shmolf/portainer-templates
cd portainer-templates
docker compose -f stacks/asciinema/docker-compose.yml up -d

More install options in our documentation.

Container Documentation

postgres Documentation

The PostgreSQL object-relational database system provides reliability and data integrity.

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.

Image won't pull

Test the pull directly on the host: docker pull ghcr.io/asciinema/asciinema-server:20231217

  • "manifest unknown" means the tag no longer exists.
  • "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

Asciinema {shmolf} is a Compose stack, a set of containers (2 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 2 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • asciinema runs ghcr.io/asciinema/asciinema-server:20231217, starts after postgres
  • postgres runs docker.io/library/postgres:14

Volumes

A volume is where Asciinema {shmolf} 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:

  • /var/opt/asciinema kept in the asciinema_data volume Docker manages
  • /var/lib/postgresql/data kept in the postgres_data volume Docker manages

Environment variables

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

  • SECRET_KEY_BASE, pulled from your own environment
  • URL_HOST, pulled from your own environment
  • URL_PORT, pulled from your own environment
  • PUID, pulled from your own environment
  • PGID, pulled from your own environment
  • POSTGRES_HOST_AUTH_METHOD, defaults to trust

Restart policy

The restart policy here is unless-stopped, so Docker restarts Asciinema {shmolf} 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).

Users and permissions

The PUID and PGID settings tell it which user and group to act as on your host. Point them at your own account (find yours with id $USER) so the files it writes into your mounted folders come out owned by you rather than root.

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like asciinema) 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 Asciinema {shmolf} up. Add the template list to Portainer once, then deploying Asciinema {shmolf} is a click rather than a wall of config.