MindBuzz Quick Start

Launch your first quiz host.

Docker Compose is the simplest way to start MindBuzz with persistent config and media folders.

Docker Compose

git clone https://github.com/kriziw/MindBuzz.git
cd MindBuzz
mkdir -p config media
docker compose -f compose.yml pull
docker compose -f compose.yml up -d

The app is available at http://localhost:3000.

Persistent folders

The Compose file bind-mounts two folders from the checkout. Create and back them up before treating the install as real.

  • config/ stores history.db, legacy quiz imports, and auth.json for SSO settings.
  • media/ stores manager-uploaded local audio files.

Domain or reverse proxy

MindBuzz normally uses same-origin browser requests, so there is no public base URL variable for a standard reverse-proxy install. Point your HTTPS host at container port 3000 and preserve Host, X-Forwarded-Proto, and WebSocket Upgrade/Connection headers.

If you enable SSO, configure the identity provider callback to match the public URL users open, for example https://quiz.example.com/auth/oidc/callback.

First run

  1. Open http://localhost:3000/manager.
  2. Create the initial admin account.
  3. Sign in with local credentials or SSO when SSO is configured.
  4. Create or import a quiz, launch it, and share the room code with players.

Local development

pnpm install
pnpm run dev

Production builds use pnpm run build followed by pnpm start.