Portainer Templates logo

Portainer Templates

Yamtrack Yamtrack

Stack

MediaProductivity

Media tracker for films, TV, anime, manga, games, books, comics and board games, with ratings, progress, a calendar of upcoming releases and imports from Trakt, Simkl, AniList, IMDb and more. Source: https://github.com/FuzzyGrim/Yamtrack

Source details

Repo: FuzzyGrim/Yamtrack
Stars: 4k
Forks: 365
Language: Python
License: AGPL-3.0
Latest: v0.26.3 · 2 months ago
Updated: 9 hours ago

Configuration

Type
Compose
Platform
linux
Env vars
YAMTRACK_SECRET=''YAMTRACK_TZ=UTCYAMTRACK_PORT=8700
Restart
unless-stopped
Source
Repo

Template by NotAFlightRisk·Source

Report issue

Notes

Fill in the secret key before you deploy, since the stack won't start without one (openssl rand -hex 32), and keep it the same on every redeploy or everyone gets logged out. Open it on port 8700 and sign up - there's no admin, every account is its own tracker, and sign-ups stay open to anyone who can reach it. To close them, add YAMTRACK_REGISTRATION = false to the stack's environment variables and redeploy. Search works straight away using Yamtrack's own shared API keys, but the games, books and comics ones are rate limited, so add your own if you use those a lot (see the docs). Posters load from TMDB and the other sources in your browser. Settings --> Import takes your history from Trakt, Simkl, AniList, IMDb, Goodreads, Steam and more, and Settings --> Integrations hooks it up to Jellyfin, Plex or Emby. Everything you track lives in the yamtrack-db volume (SQLite). Docs: fuzzygrim.github.io/Yamtrack

Services

yamtrack

Configuration

Image
ghcr.io/fuzzygrim/yamtrack:latest
Ports
${YAMTRACK_PORT:-8700}:8000
Volumes
/yamtrack/db : yamtrack-db
Env vars
SECRET=${YAMTRACK_SECRET:?Set a secret key}TZ=${YAMTRACK_TZ:-UTC}REGISTRATION=${YAMTRACK_REGISTRATION:-true}REDIS_URL=redis://redis:6379
Restart
unless-stopped

Image details

User: fuzzygrim

redis

Configuration

Image
redis:8-alpine
Volumes
/data : redis-data
Restart
unless-stopped

Image details

Pulls: 11.6B
User: stackbrew
Created: Jun 05, 2014
Updated: 3 days ago
Status: active

Standalone Install

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

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 Yamtrack, 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:
  yamtrack:
    image: ghcr.io/fuzzygrim/yamtrack:latest
    restart: unless-stopped
    ports:
      - "${YAMTRACK_PORT:-8700}:8000"
    environment:
      SECRET: ${YAMTRACK_SECRET:?Set a secret key}
      TZ: ${YAMTRACK_TZ:-UTC}
      REGISTRATION: ${YAMTRACK_REGISTRATION:-true}
      REDIS_URL: redis://redis:6379
    volumes:
      - yamtrack-db:/yamtrack/db
    depends_on:
      redis:
        condition: service_healthy

  redis:
    image: redis:8-alpine
    restart: unless-stopped
    volumes:
      - redis-data:/data
    healthcheck:
      test: ["CMD", "redis-cli", "ping"]
      interval: 10s
      timeout: 5s
      retries: 5

volumes:
  yamtrack-db:
  redis-data:

Or deploy it directly from the source:

git clone https://github.com/NotAFlightRisk/portainer-templates-extras
cd portainer-templates-extras
docker compose -f apps/yamtrack/compose.yml up -d

More install options in our documentation, or see FuzzyGrim/Yamtrack for app-specific guidance.

Container Documentation

redis Documentation

Redis is the world’s fastest data platform for caching, vector search, and NoSQL databases.

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/fuzzygrim/yamtrack:latest

  • "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

Yamtrack 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:

  • yamtrack runs ghcr.io/fuzzygrim/yamtrack:latest, starts after redis
  • redis runs redis:8-alpine

Volumes

A volume is where Yamtrack 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:

  • /yamtrack/db kept in the yamtrack-db volume Docker manages
  • /data kept in the redis-data volume Docker manages

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Yamtrack takes 4 of them, and one needs a value before it'll start properly:

  • SECRET, needs a value
  • TZ, defaults to UTC
  • REGISTRATION, defaults to true
  • REDIS_URL, defaults to redis://redis:6379

Restart policy

The restart policy here is unless-stopped, so Docker restarts Yamtrack 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 yamtrack) 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.

Open source license

Yamtrack is open source, released under the AGPL-3.0 license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.

Portainer app templates

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