Swush
Getting Started

Quickstart

Get Swush running in minutes.

This is the fastest path to a working Swush instance for local testing.

1) Clone + install

bun x degit imthatdev/swush
cd swush
bun install

2) Configure env

cp example.env .env

Minimum to update:

  • APP_NAME
  • APP_URL (e.g. http://localhost:3000)
  • DATABASE_URL
  • BETTER_AUTH_SECRET
  • UPLOAD_ROOT

3) Run migrations

bun run db:migrate

4) Start the app

bun dev

Open http://localhost:3000 and complete the setup wizard.

Next steps

  • Configure storage: Configuration → Storage
  • Tune uploads: Configuration → Uploads
  • Enable streaming: Configuration → Streaming
  • Review security defaults: Configuration → Security

On this page