Introduction toggle
What is Bytebase
Use Cases
Supported Databases
Get Started toggle
5 Mins Quick Start
Install toggle
Configure Workspace toggle
Work with a Project toggle
Manage with Terraform
Concepts toggle
SQL Review toggle
Change Database toggle
SQL Editor toggle
VCS Integration (GitOps) toggle
Tenant Database Management toggle
Disaster Recovery toggle
Anomaly Detection toggle
Administration toggle
Reference toggle
FAQ
Document Write Guide

FAQ

How to reach us?

System requirements and supported versions

System requirements

Bytebase is lightweight and has no external dependency. For normal workload, it consumes 10MB ~ 20MB memory and can run on the lowest tier machine from any cloud provider.

Supported database versions

See Supported Databases.

Supported version control systems (VCS) and providers

Bytebase only supports Git-based VCS. It currently supports:

  • Self-host GitLab EE/CE
  • GitHub.com

We plan to support more Git providers roughly in the following order:

  • GitHub Enterprise
  • GitLab.com

How to enable https

You can use Caddy or Nginx.

How to enable debug mode

Debug mode emits more detailed logs on the backend as well as returning more verbose logs to the frontend.

!

Debug mode is a global setting and is only supposed to be used for troubleshooting.

Enable --debug on startup

You can pass --debug when starting the Bytebase.

Toggle debug mode at runtime

If you are an OWNER or DBA, you can also toggle debug mode at runtime. The toggle is under the top-right profile dropdown

_

Which data does Bytebase collect?

  • Instance-wide anonymised usage data.
  • The registered email and name of the first member in the workspace.
Edit this page on GitHub prev
← Error Code for SQL Advisor Document Write Guide →