Skip to main content
An Instance is a database server Bytebase connects to — a PostgreSQL cluster, an AWS RDS instance, an on-premises MySQL server. Register one and Bytebase syncs the databases on it.
If you enabled sample databases in Step 1, open the project created during setup and go to Instances — Sample Project Instance is already there with its database in the Test environment. Skip to Step 3.Otherwise, connect your own database. Go to Instances and click Connect instance. Pick the database engine, then fill in the Basic Info — an instance name, and Test for Environment.
A workspace with no instances yet can still get the sample: open a project, go to Instances > Connect instance, and click Use sample instance. See Sample Project Instance for its limits.
Choose engine and fill basic infoNext, scroll down to the Connection section and enter how Bytebase reaches the database.Configure the connectionFor Hostname, enter the database’s public hostname — Bytebase Cloud can’t reach localhost or a private network.Click Test Connection, then Create.