Docker Local Deployment

Deploy DBConvert Streams on your local machine with Docker.

For prerequisites and deployment modes, see Docker Deployment Overview.

Install and start

1. Run the installer:

curl -fsSL https://dbconvert.nyc3.digitaloceanspaces.com/downloads/streams/latest/docker-install.sh | sh

The installer prompts for an installation directory (default: /opt/dbconvert-streams-docker). Press Enter to accept or type a custom path. On a local machine, the script auto-detects the environment and configures all services to use localhost.

2. Obtain your account API key from the Account page.
3. Change to the installation directory and start the services:

cd /opt/dbconvert-streams-docker
./start.sh

Verify

Open http://localhost in your browser. You should see the DBConvert Streams UI.

On first use, each client enters and stores the account API key locally in the UI. Seat usage is tracked separately by install ID.

Service endpoints after startup:

Check that all containers are running:

docker compose ps

Manage services

./stop.sh                    # Stop services, preserve data
./update.sh                  # Update to latest version
./update.sh --version v2.1.0 # Update to specific version
./uninstall.sh               # Remove all services and data

Data persistence

Docker Volumes

• api-data: SQLite database and encrypted secrets (standalone mode)
• nats-data: Message store
• consul-data: Service registry and configurations (corporate mode)
• vault-data: Encrypted credentials (corporate mode)

Local Directories

• logs/: Service logs (api.log, reader.log, writer-1.log, writer-2.log)
• imports/: Shared local file sources, mounted into containers as /data/imports
• exports/: Shared local file targets, mounted into containers as /data/exports
• config/: Service configurations, Nginx config, certificates, host detection

Troubleshooting

Port 8080 already in use

Another service is using port 8080. Find and stop it:

sudo lsof -i :8080

Docker daemon not running

sudo systemctl start docker

Docker permission denied

Add your user to the docker group, then log out and back in:

sudo usermod -aG docker $USER

Services crashing after startup

Check Docker resource limits. If using Docker Desktop, increase memory allocation in Settings. Check logs for details:

docker compose logs -f

Next steps

• Docker Cloud Deployment — deploy to a cloud server
• Quick Start — end-to-end first stream walkthrough
• Dashboard Overview — navigate the UI