Install with Portainer

This guide deploys PlexSub from Portainer as a Docker Compose stack.

Requirements

• A working Portainer installation.
• Permission to create stacks.
• Secure keys for PostgreSQL, encryption, and sessions.
• A local URL or public domain.

Environment 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=https://plexsub.yourdomain.com
APP_SETTINGS_ENCRYPTION_KEY=replace_with_a_long_secret
SESSION_SIGNING_SECRET=replace_with_another_long_secret
TRUST_PROXY_LEVEL=1
FORCE_SECURE_COOKIES=1
PLEXSUB_ALLOW_PRIVATE_TARGETS=0

When testing only on a local HTTP network, use APP_BASE_URL=http://SERVER_IP:5000, TRUST_PROXY_LEVEL=0, and FORCE_SECURE_COOKIES=0.

Compose stack

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
    environment:
      NODE_ENV: production
      PORT: ${PORT:-5000}
      DATABASE_URL: postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@db:5432/${POSTGRES_DB}
      APP_BASE_URL: ${APP_BASE_URL}
      APP_SETTINGS_ENCRYPTION_KEY: ${APP_SETTINGS_ENCRYPTION_KEY}
      SESSION_SIGNING_SECRET: ${SESSION_SIGNING_SECRET}
      TRUST_PROXY_LEVEL: ${TRUST_PROXY_LEVEL:-1}
      FORCE_SECURE_COOKIES: ${FORCE_SECURE_COOKIES:-1}
      PLEXSUB_ALLOW_PRIVATE_TARGETS: ${PLEXSUB_ALLOW_PRIVATE_TARGETS:-0}
    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:

Deploy and validate

1. Create a stack named plexsub.
2. Paste the variables and Compose configuration.
3. Select Deploy the stack.
4. Confirm that db is healthy and app is running.
5. Open /adminportal and finish the initial setup assistant.

Do not delete volumes if you want to retain data. Do not use postgres:latest.