Getting Started with DBConvert Streams

This guide will help you get started with DBConvert Streams by walking through the key setup steps.

1. Account Setup and Trial Activation

1. Visit https://streams.dbconvert.com
2. Sign in using your preferred authentication method:
   • GitHub authentication
   • Google authentication
   • Microsoft authentication
   • Email/password
3. Once signed in, start your free trial:
   • Click on "Start Trial"
   • Review the trial terms and conditions
   • Activate your trial account
4. Go to https://streams.dbconvert.com/account
5. Locate and securely store your API key - you'll need this for deployment

2. Choose Your Deployment Method

DBConvert Streams offers two deployment options. Choose the one that best fits your needs:

Option A: Docker Deployment (Recommended)

Prerequisites:

• Docker Engine 20.10.0 or newer
• Docker Compose v2.0.0 or newer
• 2GB+ available RAM
• 1GB+ free disk space

Quick Install:

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

# Using wget
wget -qO- https://dbconvert.nyc3.digitaloceanspaces.com/downloads/streams/latest/docker-install.sh | sh

Read more about Docker deployment

Option B: Binary Deployment

Prerequisites:

• Unix-based operating system (Linux or macOS)
• curl or wget
• unzip
• sudo privileges

Quick Install:

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

# Using wget
wget -qO- https://dbconvert.nyc3.digitaloceanspaces.com/downloads/streams/latest/binary-install.sh | sh

Read more about Binary deployment

3. Configure Your Environment

1. Start the services:

   # For Docker deployment:
   ./start.sh
   
   # For Binary deployment:
   cd ~/dbconvert-streams-binary && ./start.sh

2. Verify services are running by accessing:
   • Web Interface: http://localhost (default port 80)
   • API: http://localhost:8020

4. Create Database Connections

1. Navigate to the web interface
2. Click "Create Connection" from the Quick Actions menu
3. For your source database:
   • Select database type (MySQL/PostgreSQL)
   • Enter connection details
   • Configure SSL if needed
   • Test the connection
   • Save configuration
4. Repeat the process for your target database

For detailed instructions on connection management, see the Connection Management Guide.

5. Set Up Your First Stream

1. Click "Create Stream" from Quick Actions
2. Configure your stream:
   • Select source connection
   • Choose tables for replication
   • Select mode:
     • Convert: For one-time migrations
     • CDC: For continuous replication
   • Configure any custom options
3. Select target connection
4. Start the stream

6. Monitor Your Progress

Monitor your stream through the dashboard:

• View real-time transfer statistics
• Check system logs for detailed information
• Track data usage against your plan limits
• Monitor system health

Next Steps

• Review the Dashboard UI Guide for detailed feature information
• Or Integrate with the API
• Explore advanced configuration options
• Set up additional streams as needed
• Monitor stream progress and view live logs through the dashboard or command line

Troubleshooting

If you encounter issues:

1. Check the logs directory for detailed error messages
2. Verify all services are running properly
3. Confirm database connections and permissions
4. Ensure API key is correctly configured

For additional support, contact us at https://streams.dbconvert.com/contact