> ## Documentation Index
> Fetch the complete documentation index at: https://zepeed.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Using Docker Image
> Deploy Zepeed using Docker on Proxmox, CasaOS, Ubuntu, or any homelab running Docker Engine 24+.
## Requirements
Install via `curl -fsSL https://get.docker.com | sh`
An existing external MariaDB instance is required
2 GB recommended for production use
For the container image and persistent volumes
WebSocket server required for the realtime dashboard data feed and provider testing results
Soketi is **required**, not optional. Without it the dashboard will not receive realtime updates and provider connection tests will not return results to the UI.
***
## 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](/environment#database) for the available `DB_CONNECTION` drivers and their connection parameters.
Connect to your MariaDB instance and create the database and user:
```sql theme={null}
CREATE DATABASE zepeed CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
CREATE USER 'zepeed'@'%' IDENTIFIED BY 'your_strong_password';
GRANT ALL PRIVILEGES ON zepeed.* TO 'zepeed'@'%';
FLUSH PRIVILEGES;
```
Use `'%'` as the host so the MariaDB user is reachable from inside the Docker container. `'localhost'` will not work because the container has its own network namespace.
```bash theme={null}
echo "base64:$(openssl rand -base64 32 2>/dev/null)"
```
Copy the full output — it starts with `base64:`. You will use it as `APP_KEY` in the next step.
Zepeed uses [Soketi](https://docs.soketi.app/) 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:
```bash theme={null}
docker run -d \
--name soketi \
--restart unless-stopped \
-p 6001:6001 \
-e SOKETI_DEFAULT_APP_ID="zepeed" \
-e SOKETI_DEFAULT_APP_KEY="zepeed_key" \
-e SOKETI_DEFAULT_APP_SECRET="your_ws_secret" \
quay.io/soketi/soketi:latest-16-alpine
```
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.
If Soketi runs on a different host than Zepeed, set `PUSHER_HOST` to that host's address (instead of `127.0.0.1`) when running the Zepeed container.
```bash theme={null}
docker run -d \
--name zepeed \
--restart unless-stopped \
-p 8080:8080 \
-e APP_KEY="base64:your_generated_key_here" \
-e APP_URL="http://your-host:8080" \
-e APP_TIMEZONE="UTC" \
-e DB_CONNECTION="mariadb" \
-e DB_HOST="your-mariadb-host" \
-e DB_PORT="3306" \
-e DB_DATABASE="zepeed" \
-e DB_USERNAME="zepeed" \
-e DB_PASSWORD="your_strong_password" \
-e PUSHER_APP_ID="zepeed" \
-e PUSHER_APP_KEY="zepeed_key" \
-e PUSHER_APP_SECRET="your_ws_secret" \
-e PUSHER_HOST="127.0.0.1" \
-e PUSHER_PORT="6001" \
-e PUSHER_SCHEME="http" \
-e DEFAULT_ADMIN_NAME="Zepeed Admin" \
-e DEFAULT_ADMIN_EMAIL="admin@zepeed.local" \
-e DEFAULT_ADMIN_PASSWORD="your_admin_password" \
-v zepeed-storage:/var/www/html/storage/app \
-v zepeed-logs:/var/www/html/storage/logs \
marjose123/zepeed:latest
```
```bash theme={null}
docker run -d \
--name zepeed \
--restart unless-stopped \
-p 8080:8080 \
-e APP_KEY="base64:your_generated_key_here" \
-e APP_URL="http://your-host:8080" \
-e APP_TIMEZONE="UTC" \
-e DB_CONNECTION="mysql" \
-e DB_HOST="your-mysql-host" \
-e DB_PORT="3306" \
-e DB_DATABASE="zepeed" \
-e DB_USERNAME="zepeed" \
-e DB_PASSWORD="your_strong_password" \
-e PUSHER_APP_ID="zepeed" \
-e PUSHER_APP_KEY="zepeed_key" \
-e PUSHER_APP_SECRET="your_ws_secret" \
-e PUSHER_HOST="127.0.0.1" \
-e PUSHER_PORT="6001" \
-e PUSHER_SCHEME="http" \
-e DEFAULT_ADMIN_NAME="Zepeed Admin" \
-e DEFAULT_ADMIN_EMAIL="admin@zepeed.local" \
-e DEFAULT_ADMIN_PASSWORD="your_admin_password" \
-v zepeed-storage:/var/www/html/storage/app \
-v zepeed-logs:/var/www/html/storage/logs \
marjose123/zepeed:latest
```
```bash theme={null}
docker run -d \
--name zepeed \
--restart unless-stopped \
-p 8080:8080 \
-e APP_KEY="base64:your_generated_key_here" \
-e APP_URL="http://your-host:8080" \
-e APP_TIMEZONE="UTC" \
-e DB_CONNECTION="pgsql" \
-e DB_HOST="your-postgres-host" \
-e DB_PORT="5432" \
-e DB_DATABASE="zepeed" \
-e DB_USERNAME="zepeed" \
-e DB_PASSWORD="your_strong_password" \
-e PUSHER_APP_ID="zepeed" \
-e PUSHER_APP_KEY="zepeed_key" \
-e PUSHER_APP_SECRET="your_ws_secret" \
-e PUSHER_HOST="127.0.0.1" \
-e PUSHER_PORT="6001" \
-e PUSHER_SCHEME="http" \
-e DEFAULT_ADMIN_NAME="Zepeed Admin" \
-e DEFAULT_ADMIN_EMAIL="admin@zepeed.local" \
-e DEFAULT_ADMIN_PASSWORD="your_admin_password" \
-v zepeed-storage:/var/www/html/storage/app \
-v zepeed-logs:/var/www/html/storage/logs \
marjose123/zepeed:latest
```
See [Environment Variables](/environment) for a full description of every option.
```bash theme={null}
docker run -d \
--name zepeed \
--restart unless-stopped \
-p 8080:8080 \
-e APP_KEY="base64:your_generated_key_here" \
-e APP_URL="http://your-host:8080" \
-e APP_TIMEZONE="UTC" \
-e DB_CONNECTION="mariadb" \
-e DB_HOST="your-mariadb-host" \
-e DB_PORT="3306" \
-e DB_DATABASE="zepeed" \
-e DB_USERNAME="zepeed" \
-e DB_PASSWORD="your_strong_password" \
-e PUSHER_APP_ID="zepeed" \
-e PUSHER_APP_KEY="zepeed_key" \
-e PUSHER_APP_SECRET="your_ws_secret" \
-e PUSHER_HOST="127.0.0.1" \
-e PUSHER_PORT="6001" \
-e PUSHER_SCHEME="http" \
-e DEFAULT_ADMIN_NAME="Zepeed Admin" \
-e DEFAULT_ADMIN_EMAIL="admin@zepeed.local" \
-e DEFAULT_ADMIN_PASSWORD="your_admin_password" \
-v zepeed-storage:/var/www/html/storage/app \
-v zepeed-logs:/var/www/html/storage/logs \
marjose123/zepeed:latest
```
```bash theme={null}
docker run -d \
--name zepeed \
--restart unless-stopped \
-p 8080:8080 \
-e APP_KEY="base64:your_generated_key_here" \
-e APP_URL="http://your-host:8080" \
-e APP_TIMEZONE="UTC" \
-e DB_CONNECTION="mysql" \
-e DB_HOST="your-mysql-host" \
-e DB_PORT="3306" \
-e DB_DATABASE="zepeed" \
-e DB_USERNAME="zepeed" \
-e DB_PASSWORD="your_strong_password" \
-e PUSHER_APP_ID="zepeed" \
-e PUSHER_APP_KEY="zepeed_key" \
-e PUSHER_APP_SECRET="your_ws_secret" \
-e PUSHER_HOST="127.0.0.1" \
-e PUSHER_PORT="6001" \
-e PUSHER_SCHEME="http" \
-e DEFAULT_ADMIN_NAME="Zepeed Admin" \
-e DEFAULT_ADMIN_EMAIL="admin@zepeed.local" \
-e DEFAULT_ADMIN_PASSWORD="your_admin_password" \
-v zepeed-storage:/var/www/html/storage/app \
-v zepeed-logs:/var/www/html/storage/logs \
marjose123/zepeed:latest
```
```bash theme={null}
docker run -d \
--name zepeed \
--restart unless-stopped \
-p 8080:8080 \
-e APP_KEY="base64:your_generated_key_here" \
-e APP_URL="http://your-host:8080" \
-e APP_TIMEZONE="UTC" \
-e DB_CONNECTION="pgsql" \
-e DB_HOST="your-postgres-host" \
-e DB_PORT="5432" \
-e DB_DATABASE="zepeed" \
-e DB_USERNAME="zepeed" \
-e DB_PASSWORD="your_strong_password" \
-e PUSHER_APP_ID="zepeed" \
-e PUSHER_APP_KEY="zepeed_key" \
-e PUSHER_APP_SECRET="your_ws_secret" \
-e PUSHER_HOST="127.0.0.1" \
-e PUSHER_PORT="6001" \
-e PUSHER_SCHEME="http" \
-e DEFAULT_ADMIN_NAME="Zepeed Admin" \
-e DEFAULT_ADMIN_EMAIL="admin@zepeed.local" \
-e DEFAULT_ADMIN_PASSWORD="your_admin_password" \
-v zepeed-storage:/var/www/html/storage/app \
-v zepeed-logs:/var/www/html/storage/logs \
marjose123/zepeed:latest
```
See [Environment Variables](/environment) for a full description of every option.
```bash theme={null}
docker logs -f zepeed
```
Wait until you see: `[default-account] Default admin account created: admin@zepeed.local`
This confirms that migrations ran successfully and the admin account is ready.
```bash theme={null}
docker logs -f zepeed
```
Wait until you see: `[default-account] Default admin account created: admin@zepeed.local`
This confirms that migrations ran successfully and the admin account is ready.
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**.
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
```bash theme={null}
docker pull marjose123/zepeed:latest
docker stop zepeed && docker rm zepeed
```
Re-run the same `docker run` command from step 3. Migrations run automatically on startup. Your volumes (`zepeed-storage`, `zepeed-logs`) persist across updates.
To pin a specific version replace `:latest` with a version tag, e.g. `marjose123/zepeed:1.2.0`.
***
## Useful Commands
```bash View live logs theme={null}
docker logs -f zepeed
```
```bash Open Artisan shell theme={null}
docker exec -it zepeed php artisan tinker
```
```bash Check container health theme={null}
docker inspect --format='{{.State.Health.Status}}' zepeed
```
```bash Stop the container theme={null}
docker stop zepeed
```
```bash Remove the container theme={null}
docker rm zepeed
```