Quickstart

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
• SUPPORT_NAME
• SUPPORT_EMAIL
• DATABASE_URL
• CORS_ORIGIN
• BETTER_AUTH_URL
• BETTER_AUTH_SECRET
• SMTP_HOST
• SMTP_PORT
• SMTP_USER
• SMTP_PASS
• SMTP_FROM
• STORAGE_DRIVER (local or s3)
• UPLOAD_ROOT (if using local storage)
• S3_ENDPOINT (if using S3-compatible storage)
• S3_REGION
• S3_BUCKET
• S3_ACCESS_KEY_ID
• S3_SECRET_ACCESS_KEY
• S3_FORCE_PATH_STYLE

3) Run migrations

bun push:db

4) Build and Start the app

bun run build

bun start

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