Swush
Getting Started

Environment

Core env vars and how to set them.

Copy example.env to .env, then update values:

cp example.env .env

Core

  • APP_NAME / APP_URL
  • BETTER_AUTH_SECRET (generate a long random 32 character string)
  • UPLOAD_ROOT (local storage root)
  • STORAGE_DRIVER (local or s3)
  • CORS_ORIGIN (comma-separated list)

Example:

APP_NAME="Swush"
APP_URL="http://localhost:3000"
BETTER_AUTH_SECRET="replace-me"
UPLOAD_ROOT="/data/uploads"
STORAGE_DRIVER="local"
CORS_ORIGIN="http://localhost:3000"

Database

  • DATABASE_URL

S3 (if STORAGE_DRIVER=s3)

  • S3_ENDPOINT
  • S3_REGION
  • S3_BUCKET
  • S3_ACCESS_KEY
  • S3_SECRET_KEY
  • S3_FORCE_PATH_STYLE

Email

  • SMTP_HOST
  • SMTP_PORT
  • SMTP_USER
  • SMTP_PASS
  • SMTP_FROM
  • SUPPORT_NAME
  • SUPPORT_EMAIL

External APIs

  • TMDB_API_KEY
  • RAWG_API_KEY
  • STEAM_API_KEY
  • STEAM_LINK_SECRET

Cron

  • CRON_SECRET
  • ENABLE_APP_CRON
  • STREAM_JOBS_QUEUE_LIMIT (max queued stream jobs per run; default 15; hard cap 50)
  • STREAM_JOBS_CONCURRENCY (parallel stream jobs per run; default 5)

For the complete list and defaults, see example.env.

On this page