DBCraft LogoDBCraft
Documentation/Quick Start

Quick Start Guide

Get DBCraft running in under 5 minutes. From zero to beautiful dashboards with just a few commands.

Prerequisites

  • Docker installed and running (Get Docker)
  • A database to connect to (PostgreSQL, MySQL, ClickHouse, or SQLite)
  • Port 3001 available (or configure a different port)
01

Start DBCraft with Docker

Run a single command to get DBCraft up and running. This will pull the latest image and start the server on port 3001.

# Pull and run DBCraft
docker run -d \
  --name dbcraft \
  -p 3001:9000 \
  -v dbcraft_data:/app/data \
  krishcdbry/dbcraft:latest

💡The data volume ensures your dashboards and settings persist across container restarts.

02

Access the Web Interface

Open your browser and navigate to the DBCraft interface. Create your admin account on first launch.

# Open in your browser
http://localhost:3001

💡First user to sign up becomes the organization admin with full permissions.

03

Connect Your Database

Add your first data source. DBCraft supports PostgreSQL, MySQL, ClickHouse, SQLite, and more.

  1. 1Navigate to Settings → Data Sources
  2. 2Click "Add Data Source"
  3. 3Select your database type
  4. 4Enter connection details (host, port, credentials)
  5. 5Click "Test Connection" to verify
  6. 6Save and start querying!
04

Create Your First Dashboard

Build stunning visualizations from your data in minutes.

  1. 1Go to Dashboards → Create New
  2. 2Click "Add Chart"
  3. 3Select your data source
  4. 4Write a query or use the visual builder
  5. 5Choose a visualization type
  6. 6Customize colors and layout
  7. 7Save and share!

What's Next?

Configure Data Sources

Learn about all supported databases and connection options.

Master Dashboards

Create advanced dashboards with filters and drill-downs.

Production Setup

Deploy to Kubernetes for production-grade reliability.

Having Issues?

Check out our troubleshooting guide or reach out to the community.

TroubleshootingAPI Reference