Skip to main content

Deploy Bytebase

Before using the one-click template, here is a minimal Docker Compose file for running Bytebase locally.

If you're new to Docker Compose, check out our guide on how to self-host a Docker Compose app. You can also browse more examples in our Docker Compose library.

Self-host Bytebase with Docker Compose (minimal)

services:
bytebase:
image: bytebase/bytebase:latest
command: ["--port", "8080"]
ports:
- "8080:8080"
environment:
# Optional: connect to external Postgres if needed
# BB_DB: postgres
# BB_DB_HOST: your-postgres-host
# BB_DB_PORT: 5432
# BB_DB_USER: bytebase
# BB_DB_PASSWORD: yourpass
volumes:
- bb-data:/var/opt/bytebase

volumes:
bb-data:

Bytebase stores all metadata, migration history, and configuration inside /var/opt/bytebase.


Deploy Bytebase on Hostim.dev (One-Click)

Bytebase is an open-source database DevOps tool that provides database CI/CD capabilities with GitOps integration, SQL review, and comprehensive security features. With Hostim.dev, you can deploy Bytebase with Docker and PostgreSQL in one click, ready for managing your database schema changes with confidence.

🔄 Database CI/CD for DevOps teams – manage schema changes with confidence

Try it Yourself

Guest project runs for 1 hour. Log in to save and extend to 5 days.

Why Host Bytebase on Hostim.dev?

  • One-click Docker deployment
  • Built-in PostgreSQL
  • Instant HTTPS and domain
  • Real-time logs and metrics
  • GitOps integration
  • Security features including RBAC and audit logging

What's included

ResourceDetails
Appbytebase/bytebase Docker image
DatabasePostgreSQL (auto-provisioned)
DomainFree *.hostim.dev subdomain
SSLLet’s Encrypt (auto-enabled)
Port8080

How to Deploy

  1. Go to your Hostim.dev dashboard.
  2. Click Create ProjectUse a Template.
  3. Select the Bytebase template.
  4. Choose a resource plan.
  5. Hit Deploy.

Post-Deploy Notes

  • Configure admin user on first login
  • Add connections to your target databases
  • Set up GitOps with GitHub/GitLab
  • Configure RBAC for your team
  • Add a custom domain under Networking

FAQ

Does Bytebase require PostgreSQL?

Yes. Bytebase uses PostgreSQL as its primary metadata store. The Hostim template provisions it automatically.

Where does Bytebase store its data?

The server stores metadata, migration history, and configuration in /var/opt/bytebase, backed by a persistent volume.

How do I back up my Bytebase instance?

Export the PostgreSQL database and back up the volume under /var/opt/bytebase using the Bastion host.

How do I enable GitOps mode?

Go to Version Control in settings and connect GitHub/GitLab. Bytebase will manage SQL review and migration files automatically.

Can Bytebase manage multiple database types?

Yes. Bytebase supports PostgreSQL, MySQL, MariaDB, ClickHouse, TiDB, and more.

Why can't I connect to my external database?

Check network access, credentials, and ensure the target database allows inbound connections from the Bytebase instance.

How do I update Bytebase?

Docker Compose: docker compose pull && docker compose up -d Hostim.dev: redeploy the app.

Does Bytebase support SSO?

Yes. It supports OAuth2 providers and SSO integrations depending on version.


Alternatives

  • Liquibase — migration automation and CI/CD
  • Flyway — migration-based schema management
  • Sqitch — dependency-based database change tool

Source + Docs


Looking for something else? Browse all templates →


Try it now

Deploy Bytebase Now – in less than 60 seconds