Skip to content

docs: improve database instance documentation clarity and structure #826

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
d-bytebase merged 2 commits into from
Aug 13, 2025
Merged

docs: improve database instance documentation clarity and structure #826

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b2b064c
docs: improve database instance documentation clarity and structure
d-bytebase Aug 13, 2025
c9788b1
docs: revert title to 'Connect Your Database' per preference
d-bytebase Aug 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed mintlify/content/docs/get-started/instance/connect-local-docker.webp
View file
Open in desktop
Binary file not shown.
Binary file removed mintlify/content/docs/get-started/instance/connect-local-no-docker.webp
View file
Open in desktop
Binary file not shown.
24 changes: 4 additions & 20 deletions mintlify/get-started/instance.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,27 +28,11 @@ connection info for your database instance.

## General

### Connect to the instance on the same host
### Database Connectivity

<Note>

If you run Bytebase inside Docker and try to connect to a database instance on the same host, then
you need to set host as [host.docker.internal](https://docs.docker.com/desktop/networking/#i-want-to-connect-from-a-container-to-a-service-on-the-host).

</Note>

![connect-local-docker](/content/docs/get-started/instance/connect-local-docker.webp)

- If you run Bytebase without Docker and try to connect to a database instance on the same host, then
you need to set host as `127.0.0.1`

![connect-local-no-docker](/content/docs/get-started/instance/connect-local-no-docker.webp)

### Connect to the instance from Bytebase Cloud

<Note>
If you're using Bytebase Cloud, make sure you've whitelisted the required IP address. See the [Prerequisites section](/get-started/cloud#prerequisites) in the Cloud documentation.
</Note>
- **Docker (standard mode)**: Use `host.docker.internal` for localhost databases. [Learn more](https://docs.docker.com/desktop/networking/#i-want-to-connect-from-a-container-to-a-service-on-the-host)
- **Docker (--network host)**: Use `127.0.0.1` for localhost databases
- **Bytebase Cloud**: Whitelist required IP addresses first. See [Cloud Prerequisites](/get-started/cloud#prerequisites)

### Read-Only Connection

Expand Down