Quick Start

Up and running in 3 minutes.

Prerequisites

• Docker and Docker Compose installed on your host
• Port 3000 free and accessible
• A working internet connection (to pull the image from GHCR)

One-liner (Docker)

PG_PASS=$(openssl rand -hex 24)
MINIO_PASS=$(openssl rand -hex 24)

docker run -d \
  --name itsweber-play \
  -p 3000:3000 \
  -v play-data:/data \
  -e PUBLIC_URL=http://localhost:3000 \
  -e NEXT_PUBLIC_SITE_URL=http://localhost:3000 \
  -e AUTH_SECRET=$(openssl rand -hex 32) \
  -e POSTGRES_PASSWORD=$PG_PASS \
  -e DATABASE_URL=postgresql://play:$PG_PASS@127.0.0.1:5432/itsweber_play \
  -e MINIO_ROOT_USER=play-admin \
  -e MINIO_ROOT_PASSWORD=$MINIO_PASS \
  -e S3_ACCESS_KEY=play-admin \
  -e S3_SECRET_KEY=$MINIO_PASS \
  -e INITIAL_ADMIN_EMAIL=admin@example.com \
  ghcr.io/itsweber-official/itsweber-play:main

This pulls the current build of the main branch, starts all internal services (Postgres, Redis, MinIO, API, Worker, Web, Nginx) inside a single container, and stores all persistent data in the play-data Docker volume.

Open in Browser

Navigate to http://localhost:3000.

On the first visit the instance redirects to the first-run wizard at /setup. This keeps happening until the wizard has been completed once, regardless of whether an account already exists.

First-run Wizard Steps

1. Language — Choose Deutsch or English for the interface.
2. Site name — Set name, tagline and an optional contact email.
3. Branding — Upload a custom logo or skip this step.
4. Admin account — Create the admin account. If INITIAL_ADMIN_EMAIL is set, the email field is pre-filled and locked.
5. Email (SMTP) — Optionally enter the mail server for password reset and notifications.
6. Theme — Pick one of the bundled presets.
7. Registration — Open, invite only or closed.
8. Storage — Confirm the notes on volumes, backups and reverse proxy.
9. Done — Review the summary and finish.

You do not need to create a channel, every account gets a default channel on registration. Once the wizard is complete you are taken directly to the admin panel at /admin.

What's Next?

Production Note

The one-liner above is suitable for local testing. For a production deployment:

• Set PUBLIC_URL and NEXT_PUBLIC_SITE_URL to your real public URL (e.g. https://play.example.com)
• Configure email delivery in the first-run wizard or later under /admin/settings so password reset and notifications work. SMTP settings live in the database, there are no SMTP_* environment variables
• Place the container behind a reverse proxy (Nginx, Traefik, Caddy) that handles TLS termination
• HTTPS is strongly recommended — browser upload APIs and session cookies require a secure context for full functionality

See Configuration for the full list of environment variables.