🪟 DBConvert Streams – Windows Quick Start Guide

Prerequisites

Install Docker Desktop for Windows

Download and install from:
👉 https://www.docker.com/products/docker-desktop/

Docker Desktop provides the Docker engine required to run containers on Windows.

Installation Steps

✅ Step 1: Install Git for Windows

Download and install from:
👉 https://git-scm.com/download/win

This gives you a Git Bash terminal that can run .sh scripts on Windows.

✅ Step 2: Open Git Bash

• Click Start
• Search for "Git Bash"
• Right-click → "Run as Administrator" (recommended)

✅ Step 3: Download & extract deployment package

In Git Bash, run:

# Download the latest deployment package
curl -o docker-deploy.tar.gz https://dbconvert.nyc3.digitaloceanspaces.com/downloads/streams/latest/docker-deploy-latest.tar.gz

# Extract it (requires tar, which Git Bash includes)
tar -xf docker-deploy.tar.gz

✅ Step 4: Install gum (interactive UI helper)

Still in Git Bash:

winget install --id=charmbracelet.gum -e

📌 Managing Services

🏁 Starting Services

Before starting the services, obtain your API key from https://streams.dbconvert.com/account.

# Navigate to deployment directory
cd docker-deploy

# Start services
./start.sh

❌ Stopping Services

To temporarily stop all services while preserving data:

./stop.sh

🔄 Updating Services

To update the DBConvert Streams services to a newer version:

# Update to latest version
./update.sh

# Update to specific version
./update.sh --version v1.0.0

🗑️ Uninstallation

To permanently remove DBConvert Streams and all associated data:

./uninstall.sh

Service URLs

After starting the services, they will be available at:

• DBConvert Streams UI: http://localhost (default port 80)
• DBConvert Streams API: http://localhost/api/
• Consul UI: http://localhost:8500
• Vault UI: http://localhost:8200
• NATS Monitoring: http://localhost:8222

---

❓ Need Help?

Check the documentation or reach out to support if you run into issues with Docker, firewall, or permissions.