Step 1: Deploy Bytebase

This quick start takes you from an empty workspace to a reviewed schema change and a query. Choose how you want to run Bytebase below — the remaining steps are the same.

Bytebase Cloud
Self-Host with Docker

If you already have a publicly reachable database, this is the fastest way to get started — no installation required.Sign in at cloud.bytebase.com with Google, Microsoft, GitHub, or email, then click Create workspace.

Need a database? A free database from Neon, Supabase, or Aiven works well for this quick start — as does any managed database that accepts public connections.Using an existing database with inbound IP restrictions? See Network requirements.

Run Bytebase locally with Docker. The setup wizard can create sample databases for you, so you don’t need to prepare a database yourself.

Install Docker if you don’t have it, and make sure it’s running.

Start Bytebase, then open localhost:8080.

docker run --rm --init \
  --name bytebase \
  --publish 8080:8080 --pull always \
  --volume ~/.bytebase/data:/var/opt/bytebase \
  bytebase/bytebase:latest

Fill in the fields and click Create admin account.
In the wizard’s Setup step, choose Use built-in sample to get the hr_test and hr_prod databases. Keep the defaults on the remaining steps.

⌘I

Introduction

Install

Connect Databases

Quick Start

Onboarding Guides