Portainer Templates logo

Portainer Templates

Ryot Ryot

Stack

MediaBooksProductivity

Tracker for the films, shows, books, anime, music and podcasts you get through, plus your workouts: progress, ratings, reviews and stats in one place, with imports from Trakt, Goodreads, Jellyfin, Plex and more. Source: https://github.com/IgnisDa/ryot

Source details

Repo: IgnisDa/ryot
Stars: 4k
Forks: 143
Language: TypeScript
License: GPL-3.0
Latest: v10.5.0 · 2 months ago
Updated: 1 day ago
Website: ryot.io/

Configuration

Type
Compose
Platform
linux
Env vars
RYOT_ADMIN_TOKEN=''RYOT_DB_PASSWORD=''RYOT_TMDB_TOKEN=''RYOT_URL=http://localhost:8880RYOT_PORT=8880
Restart
unless-stopped
Source
Repo

Template by NotAFlightRisk·Source

Report issue

Notes

Set the admin token and database password before you deploy (openssl rand -hex 32 makes either), since the stack won't start without them. Then open http://<your-host>:8880 (or whichever port you picked) and sign up: the first account becomes the admin. Anyone who can reach it can sign up after that, so once you're in, add RYOT_SIGNUPS = false to the stack's environment variables and redeploy. Anime, manga, podcasts and workouts work straight away, and books and music do once you switch the search source to Open Library or MusicBrainz (the default ones want API keys). Films and shows need the TMDB token. Ryot sends page views and a few events to its developer's Umami analytics from your browser; add RYOT_TELEMETRY_OFF = true the same way to stop it. Everything lives in Postgres, in the postgres-data volume. Docs: docs.ryot.io

Services

ryot

Configuration

Image
ignisda/ryot:v10
Ports
${RYOT_PORT:-8880}:8000
Env vars
DATABASE_URL=postgres://ryot:${RYOT_DB_PASSWORD:?Set a database password}@postgres:5432/ryotSERVER_ADMIN_ACCESS_TOKEN=${RYOT_ADMIN_TOKEN:?Set an admin token}FRONTEND_URL=${RYOT_URL:-http://localhost:8880}MOVIES_AND_SHOWS_TMDB_ACCESS_TOKEN=${RYOT_TMDB_TOKEN:-}USERS_ALLOW_REGISTRATION=${RYOT_SIGNUPS:-true}DISABLE_TELEMETRY=${RYOT_TELEMETRY_OFF:-false}
Restart
unless-stopped

Image details

Pulls: 563k
User: ignisda
Created: Jun 15, 2024
Updated: 1 day ago
Status: active

postgres

Configuration

Image
postgres:17-alpine
Volumes
/var/lib/postgresql/data : postgres-data
Env vars
POSTGRES_DB=ryotPOSTGRES_USER=ryotPOSTGRES_PASSWORD=${RYOT_DB_PASSWORD:?Set a database password}
Restart
unless-stopped

Image details

Pulls: 12.1B
User: stackbrew
Created: Jun 05, 2014
Updated: 14 hours ago
Status: active

Standalone Install

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

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 Ryot, 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:
  ryot:
    image: ignisda/ryot:v10
    restart: unless-stopped
    ports:
      - "${RYOT_PORT:-8880}:8000"
    environment:
      DATABASE_URL: postgres://ryot:${RYOT_DB_PASSWORD:?Set a database password}@postgres:5432/ryot
      SERVER_ADMIN_ACCESS_TOKEN: ${RYOT_ADMIN_TOKEN:?Set an admin token}
      FRONTEND_URL: ${RYOT_URL:-http://localhost:8880}
      MOVIES_AND_SHOWS_TMDB_ACCESS_TOKEN: ${RYOT_TMDB_TOKEN:-}
      USERS_ALLOW_REGISTRATION: ${RYOT_SIGNUPS:-true}
      DISABLE_TELEMETRY: ${RYOT_TELEMETRY_OFF:-false}
    depends_on:
      postgres:
        condition: service_healthy

  postgres:
    image: postgres:17-alpine
    restart: unless-stopped
    environment:
      POSTGRES_DB: ryot
      POSTGRES_USER: ryot
      POSTGRES_PASSWORD: ${RYOT_DB_PASSWORD:?Set a database password}
    volumes:
      - postgres-data:/var/lib/postgresql/data
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U ryot -d ryot"]
      interval: 10s
      timeout: 5s
      retries: 5

volumes:
  postgres-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/ryot/compose.yml up -d

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

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 ignisda/ryot:v10

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

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

  • ryot runs ignisda/ryot:v10, starts after postgres
  • postgres runs postgres:17-alpine

Volumes

A volume is where Ryot 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/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. Ryot takes 9 of them, and 2 need a value before it'll start properly:

  • DATABASE_URL, defaults to postgres://ryot:@postgres:5432/ryot
  • SERVER_ADMIN_ACCESS_TOKEN, needs a value
  • FRONTEND_URL, defaults to http://localhost:8880
  • MOVIES_AND_SHOWS_TMDB_ACCESS_TOKEN, pulled from your own environment
  • USERS_ALLOW_REGISTRATION, defaults to true
  • DISABLE_TELEMETRY, defaults to false
  • POSTGRES_DB, defaults to ryot
  • POSTGRES_USER, defaults to ryot
  • POSTGRES_PASSWORD, needs a value

Restart policy

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

Ryot is open source, released under the GPL-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 Ryot up. Add the template list to Portainer once, then deploying Ryot is a click rather than a wall of config.