Skip to main content

Install on Unraid

This guide covers a PlexSub installation on Unraid using Docker Compose or an equivalent stack.

Requirements​

  • Unraid with Docker enabled.
  • Docker Compose support or an equivalent plugin.
  • A persistent folder for PlexSub.
  • Secure keys for the database, encryption, and sessions.
  • A domain or reverse proxy for external HTTPS access.
/mnt/user/appdata/plexsub

Store docker-compose.yml and .env there.

Basic variables​

COMPOSE_PROJECT_NAME=plexsub
APP_IMAGE_REF=ghcr.io/pvpiimoore/plexsub:latest
PLEXSUB_POSTGRES_IMAGE_REF=postgres:18.4-alpine
PORT=5000

POSTGRES_DB=plexsub
POSTGRES_USER=plexsub
POSTGRES_PASSWORD=replace_with_a_long_secret

APP_BASE_URL=http://UNRAID_IP:5000
APP_SETTINGS_ENCRYPTION_KEY=replace_with_a_long_secret
SESSION_SIGNING_SECRET=replace_with_another_long_secret
TRUST_PROXY_LEVEL=0
FORCE_SECURE_COOKIES=0
PLEXSUB_ALLOW_PRIVATE_TARGETS=0

For an HTTPS domain:

APP_BASE_URL=https://plexsub.yourdomain.com
TRUST_PROXY_LEVEL=1
FORCE_SECURE_COOKIES=1

Basic Compose configuration​

services:
  db:
    image: ${PLEXSUB_POSTGRES_IMAGE_REF:-postgres:18.4-alpine}
    restart: unless-stopped
    environment:
      POSTGRES_DB: ${POSTGRES_DB}
      POSTGRES_USER: ${POSTGRES_USER}
      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
    volumes:
      - plexsub_postgres_data:/var/lib/postgresql
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U ${POSTGRES_USER} -d ${POSTGRES_DB}"]
      interval: 5s
      timeout: 5s
      retries: 10

  app:
    image: ${APP_IMAGE_REF:-ghcr.io/pvpiimoore/plexsub:latest}
    restart: unless-stopped
    depends_on:
      db:
        condition: service_healthy
    env_file:
      - .env
    environment:
      NODE_ENV: production
      PORT: ${PORT:-5000}
      DATABASE_URL: postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@db:5432/${POSTGRES_DB}
    ports:
      - "${PORT:-5000}:5000"
    volumes:
      - plexsub_backups_data:/app/backups
      - plexsub_backup_fallback_data:/app/backup-fallback
      - plexsub_uploads_data:/app/uploads
    security_opt:
      - no-new-privileges:true
    read_only: true
    tmpfs:
      - /tmp
      - /var/tmp
    cap_drop:
      - ALL
    cap_add:
      - NET_BIND_SERVICE

volumes:
  plexsub_postgres_data:
  plexsub_backups_data:
  plexsub_backup_fallback_data:
  plexsub_uploads_data:

First access​

Open http://UNRAID_IP:5000/adminportal. On a clean installation, create the first Owner user from the initial setup assistant.

Backups and PostgreSQL​

Protect the PostgreSQL, backups, and uploads volumes, plus .env. Do not change APP_SETTINGS_ENCRYPTION_KEY when integrations are already saved.

Use postgres:18.4-alpine for new installations. Never point an old volume at a new PostgreSQL major version without a backup, restore, and validation.