This page provides a comprehensive checklist for setting up Bytebase in a production environment.

​
System Requirements

​
CPU and RAM

Users & InstancesBytebaseExternal PostgreSQL
Up to 5 users / 5 instances1 CPU / 2 GB RAM1 CPU / 2 GB RAM
Up to 20 users / 20 instances2 CPU / 4 GB RAM1 CPU / 2 GB RAM
Up to 50 users / 50 instances4 CPU / 8 GB RAM2 CPU / 4 GB RAM
250+ users or 50+ instances8 CPU / 16 GB RAM2 CPU / 4 GB RAM

​
Storage

Bytebase uses a PostgreSQL database to store SQL statements and other metadata.
  • If using cloud services (RDS, Cloud SQL) that support disk expansion, you can start with 20 GB and increase the size later as usage grows
  • Otherwise, start with 100 GB to avoid running out of space
Teams that frequently work with large SQL files may need more.

​
Production Setup Checklist

  • Review system requirements (see above)
  • Configure External PostgreSQL
  • Configure External Access
  • Configure External URL
  • Pin Docker image to specific version instead of latest (changelog) While version tags like 3.7.0 are better than latest, Bytebase may still add patches to existing versions. For a truly fixed version, use the SHA256 digest from Docker Hub. 
    # Pin to exact image using digest (prevents any updates)
docker pull bytebase/bytebase:3.7.0@sha256:00b436855b08739aad02fd52e41b5d74c03db9c70c49ce5de42376347cd1403c

​
Monitoring

  • Telemetry metrics available at /metrics endpoint

​
Cloud Provider Recommendations

If deploying on a cloud provider, use the recommended stack:

​
AWS

  • Compute: EC2 or ECS/EKS
  • Database: RDS for PostgreSQL

​
GCP

  • Compute: GCE or GKE
  • Database: Cloud SQL for PostgreSQL

​
Azure

  • Compute: Virtual Machines or AKS
  • Database: Azure Database for PostgreSQL