jncarter/soundboard repository overview

⁠Soundboard

A multi-app control panel for Laravel Reverb⁠. Soundboard keeps your Reverb apps in a database instead of config/reverb.php, so you can add an app or rotate a secret from a dashboard or an API with no deploy and no restart. It also shows live and historical metrics and sends alerts.

Source, full documentation, and issues: github.com/jncarter123/soundboard⁠

⁠Features

• Multi-app management: credentials, allowed origins, and connection and message limits for each app. Changes reach Reverb within seconds.
• Live and historical metrics: connections, channels, presence members, and messages, from 1 hour to 7 days.
• Alerts by email and signed webhook for connection and daily message limits, Reverb outages, clock skew, and stalled metrics.
• Role-based access control, an API with personal access tokens, and an audit log.
• Horizontal scaling: several Reverb servers sharing Redis, with correct metrics across them.

⁠Tags

Images are built for linux/amd64 and linux/arm64.

⁠Quick start

One image runs as four containers: the dashboard, the Reverb WebSocket server, the Pulse metrics recorder, and a scheduler.

curl -fsSLO https://raw.githubusercontent.com/jncarter123/soundboard/main/compose.yaml
curl -fsSL -o docker.env https://raw.githubusercontent.com/jncarter123/soundboard/main/docker.env.example
echo "SOUNDBOARD_IMAGE=jncarter/soundboard:2" > .env

docker compose up -d
docker compose exec app php artisan soundboard:add-user --role="Super Admin"

The dashboard listens on 127.0.0.1:8000 and Reverb on 127.0.0.1:8080. Both are plain HTTP on loopback, meant for a reverse proxy in front that terminates TLS.

Set APP_URL in docker.env to the dashboard's public URL, scheme included (https://soundboard.example.com). Otherwise the browser blocks the dashboard's assets as mixed content.

⁠Back up the volume

On first start the dashboard container generates an APP_KEY onto the soundboard-data volume and says so in its log. That key encrypts every stored app secret, so without it your clients can't connect. Back up the volume, or set APP_KEY in docker.env yourself.

Data lives in SQLite on the same volume by default.

⁠Configuration

Settings go in docker.env; docker.env.example⁠ documents each one.

⁠Upgrading

docker compose pull && docker compose up -d

Migrations run when the dashboard container starts.

⁠Scaling Reverb

One Reverb process uses one CPU core. To run several Reverb servers behind a load balancer, sharing channels and presence through Redis:

curl -fsSLO https://raw.githubusercontent.com/jncarter123/soundboard/main/compose.scaling.yaml
docker compose -f compose.yaml -f compose.scaling.yaml up -d

See Scaling Reverb⁠ in the README for what changes with more than one server.

⁠Connecting an application

Create an app in the dashboard, then point your Laravel app's broadcasting config at Soundboard's Reverb server with the credentials it shows:

BROADCAST_CONNECTION=reverb
REVERB_APP_ID=your-app-id
REVERB_APP_KEY=generated-key
REVERB_APP_SECRET=generated-secret
REVERB_HOST=realtime.example.com
REVERB_PORT=443
REVERB_SCHEME=https

Each app needs at least one allowed origin: a hostname such as app.example.com or *.example.com, or * for any.

⁠License

MIT. See LICENSE⁠.