Swush
Getting Started

Overview

What you need and how the setup flow works.

This section walks you from cloning the repo to a working Swush instance, including storage, auth, and optional services like media processing.

Setup flow

  1. Install dependencies
  2. Configure .env
  3. Run database migrations
  4. Start the app
  5. Complete the setup wizard
  6. Verify uploads, streaming, and sharing

Two deployment paths

  • Local dev: bun dev for rapid iteration
  • Production: Docker Compose or PM2 with a persistent database and storage volume

Need it fast?

Jump to Quickstart for the shortest path to a running instance.

Next: Requirements → Install → Environment → Migrations.

On this page