Requirements
Docker Engine 24+
Install via
curl -fsSL https://get.docker.com | shMariaDB 10.6+ or 11.x
An existing external MariaDB instance is required
1 GB RAM minimum
2 GB recommended for production use
4 GB Disk
For the container image and persistent volumes
Soketi (required)
WebSocket server required for the realtime dashboard data feed and provider testing results
Installation
Docker run commands assume you already have a database installed and configured. SQLite is fine for most installs, but you can also use more traditional relational databases like MariaDB, MySQL, and PostgreSQL. See Environment Variables for the available
DB_CONNECTION drivers and their connection parameters.1
Prepare your database
Connect to your MariaDB instance and create the database and user:
2
Generate an application key
base64:. You will use it as APP_KEY in the next step.3
Run Soketi (required for realtime features)
Zepeed uses Soketi as its WebSocket server to power the realtime dashboard data feed and to stream provider testing results back to the UI. Start it before launching Zepeed:The
SOKETI_DEFAULT_APP_ID, SOKETI_DEFAULT_APP_KEY, and SOKETI_DEFAULT_APP_SECRET values must match the PUSHER_APP_ID, PUSHER_APP_KEY, and PUSHER_APP_SECRET you set on the Zepeed container in the next step.4
Run the container
- MariaDB
- MySQL
- PostgreSQL
5
Run the container
- MariaDB
- MySQL
- PostgreSQL
6
Follow the first-boot logs
[default-account] Default admin account created: admin@zepeed.localThis confirms that migrations ran successfully and the admin account is ready.7
Follow the first-boot logs
[default-account] Default admin account created: admin@zepeed.localThis confirms that migrations ran successfully and the admin account is ready.8
Open in your browser
Navigate to
http://your-host:8080 and log in with the DEFAULT_ADMIN_EMAIL and DEFAULT_ADMIN_PASSWORD you set in step 3.Change your password immediately after first login via Profile Settings.
9
Open in your browser
Navigate to
http://your-host:8080 and log in with the DEFAULT_ADMIN_EMAIL and DEFAULT_ADMIN_PASSWORD you set in step 3.Change your password immediately after first login via Profile Settings.
Updating
docker run command from step 3. Migrations run automatically on startup. Your volumes (zepeed-storage, zepeed-logs) persist across updates.