Bytebase

Development1024MB+ RAM

Database DevOps and schema change management for MySQL, PostgreSQL, SQL Server, Oracle, MongoDB, and more

Download Server Compass Install Bytebase to server

developmentdevtoolsbytebaseopen-sourceself-hosteddocker

Deploy Bytebase in 3 Steps

Connect Your VPS

Add your server credentials to Server Compass

Select Bytebase

Choose from our template library

Deploy & Configure

Fill in settings and click Deploy

No Docker knowledge required

Step-by-step deployment guide

Deploy Bytebase on a VPS with Server Compass

Use the Bytebase template in Server Compass to deploy a self-hosted database DevOps workspace on your VPS, then verify the web UI.

About 10 minutesBrowser verified

Step 1

Open the server Apps tab

Select the tutorial-vps VPS, open the Apps tab, and start a new app deployment. Keep sensitive server details hidden before capturing or sharing screenshots.

Server Compass Apps tab before creating a Bytebase app

Step 2

Choose an app template

Click New App and choose the template deployment path so Server Compass can load the built-in catalog.

Choosing to deploy an app from a Server Compass template

Step 3

Search for Bytebase

Use the template picker search to find Bytebase in the Server Compass template catalog.

Searching for Bytebase in the Server Compass template picker

Step 4

Select the Bytebase template

Choose the Bytebase template. Server Compass fills the Bytebase service, persistent data volume, external URL, and public web port.

Bytebase template selected in Server Compass

Step 5

Review the Bytebase settings

Confirm the app name and compose service. In this run, the app was named bytebase-demo and used host port 4124.

Reviewing Bytebase project settings and compose service

Step 6

Deploy Bytebase

Review the generated compose settings, confirm the Bytebase web port is available, and click Deploy.

Reviewing Bytebase web port before deployment

Step 7

Watch the deployment progress

Keep the deployment modal open while Server Compass uploads the compose file, pulls the Bytebase image, starts the container, and verifies the stack.

Server Compass deploying the Bytebase template on the VPS

Step 8

Confirm Bytebase is running

After deployment finishes, return to the Apps tab and confirm the Bytebase app is marked Running with its application URL available.

Bytebase template running in the Server Compass Apps tab

Step 9

Open Bytebase in the browser

Open the application URL in a browser. The Bytebase setup or login screen confirms the database DevOps web UI is reachable.

The deployed Bytebase web UI loaded in a browser

After Bytebase Opens

Place Bytebase behind HTTPS before connecting production databases.
Create the first admin account intentionally and restrict registration after setup.
Update EXTERNAL_URL to the real public URL before using email links, SSO callbacks, or production approvals.
Back up the Bytebase data volume because it stores workspace configuration, users, projects, and connection metadata.
Use least-privilege database accounts when adding production instances to Bytebase.
Keep the Bytebase image updated for dependency and security fixes.

Verified Result

The Bytebase web interface loaded successfully from the deployed container.

Download Server Compass Docs

Bytebase deployment questions

What does the Bytebase template deploy?

It deploys the Bytebase database DevOps web app with a persistent data volume.

Which port did the tutorial use?

The tutorial used host port 4124, which maps to the Bytebase web UI on container port 8080.

Does Bytebase need setup after deployment?

Yes. Create the first workspace admin account, configure the public URL, then add database instances and projects.

Should this become a blog post?

No. The deployment guide should live on the Bytebase template detail page and be linked from the reusable template deployment docs page.

After Deployment

After deploying Bytebase with Server Compass, complete these steps to finish setup

Visit the application URL

Create the workspace admin account (first registration becomes admin)

Add database instances (MySQL, PostgreSQL, etc.) and assign them to environments

Configure SQL review policies, change workflows, and (optionally) GitOps integration

Need help? Check out our documentation for detailed guides.

Bytebase FAQ

Common questions about self-hosting Bytebase

How do I deploy Bytebase with Server Compass?

Simply download Server Compass, connect to your VPS, and select Bytebase from the templates list. Fill in the required configuration and click Deploy. The entire process takes under 3 minutes.

What are the system requirements for Bytebase?

Bytebase requires a minimum of 1024MB RAM. We recommend a VPS with at least 2048MB RAM for optimal performance. Any modern Linux server with Docker support will work.

Can I migrate my existing Bytebase data?

Yes! Server Compass provides volume mapping that allows you to import existing data. You can also use standard Bytebase backup and restore procedures.

How do I update Bytebase to the latest version?

Server Compass makes updates easy. Simply click the Update button in your deployment dashboard, and the latest Bytebase image will be pulled and deployed with zero downtime.

Is Bytebase free to self-host?

Bytebase is open-source software. You only pay for your VPS hosting (typically $5-20/month) and optionally Server Compass ($29 one-time). No subscription fees or per-seat pricing.

Related Templates

View all Development

PocketBase

Open-source backend in a single file with realtime database, auth, and file storage

Appwrite

Open-source backend-as-a-service - self-hosted Firebase alternative

Parse Server

Open-source backend framework with dashboard

Supabase

Full Supabase self-hosted with Kong, GoTrue Auth, Realtime, and Studio

Ready to Self-Host Bytebase?

Download Server Compass and deploy Bytebase to your VPS in under 3 minutes. No Docker expertise required.

Download Server Compass