Skip to main content
This page provides a comprehensive checklist for setting up Bytebase in a production environment.

​
System Requirements

​
CPU and 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
  • Decide whether you need High Availability
  • 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.

​
High Availability Checklist

If you plan to run Bytebase with multiple replicas:
  • Use external PostgreSQL. HA is not supported with embedded PostgreSQL
  • Start every replica with --ha
  • Put replicas behind one ingress, gateway, or load balancer
  • Set the same External URL for the whole deployment
  • Confirm your license has HA enabled before scaling above one replica

​
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