Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.bytebase.com/llms.txt

Use this file to discover all available pages before exploring further.

Database Instance or simply Instance models after a single database server accessed via a host:port address or a primary/replica cluster. A typical database instance could be your on-premises MySQL instance, a PostgreSQL cluster, an AWS RDS instance etc. Each Database Instance belongs to an Environment.

​
Prerequisites

  • Workspace Admin or Workspace DBA role

​
Add instance

If you choose to use sample data during onboarding, Bytebase will start two embedded sample PostgreSQL instances accessible from /tmp:8083 and /tmp:8084.
Go to Instances and Add Instance. bb-instances bb-instances-2 For Host or socket, the screenshot assumes you run Bytebase inside Docker and try to connect to a database instance on the same host, thus it uses host.docker.internal. Check out Instance Connection Configuration for the detailed guide.