Skip to content
Merged
Changes from all commits
Commits
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
73 changes: 0 additions & 73 deletions mintlify/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,82 +39,9 @@ then you need to reserve large disk space. A good starting point is to reserve 1
the Bytebase server runs. And if you use [External PostgreSQL](/get-started/self-host/external-postgres/),
then you need to make sure to reserve enough space there.

### Docker

If you use Docker to deploy Bytebase, please use Docker version >= [20.10.24](https://docs.docker.com/engine/release-notes/20.10/).

### WebSocket

SQL Editor autocomplete requires [enabling WebSocket](/get-started/self-host/external-access#websocket-support) in your gateway if present.

## Does Bytebase retain your data

Bytebase does not retain any database row data.

### Database credentials

In order to perform database operations on users' behalf, Bytebase needs users to provide the database credentials.
By default, Bytebase stores the supplied credentials in the obfuscated format. For the Enterprise plan, you can
instruct Bytebase to [use the external secret manager](/get-started/instance/#use-secret-manager).

### Database schema (metadata)

Bytebase syncs and stores the database schema information. If you enable [AI Assistant](/ai-assistant/),
Bytebase will also send the schema info to OpenAI or the configured endpoint.

### Database data (row data)

When you query the database via Bytebase, Bytebase does not store the result data. [Audit log](/security/audit-log/)
only records the query.

If you enable [Data Rollback](/change-database/rollback-data-changes/), Bytebase will store the backup data in your
own database instance.

## Production Setup

See [Production Setup](/get-started/self-host/production-setup/).

## Supported database and versions

See [Supported Databases](/introduction/supported-databases).

## Supported version control systems (VCS) and providers

See [GitOps](/vcs-integration/overview).

## How to enable https

You can use [Caddy](https://caddyserver.com/docs/quick-starts/reverse-proxy) or [Nginx](https://www.nginx.com/).

## How to enable debug mode

<Note>

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

</Note>

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

### Enable `--debug` on startup

You can pass [`--debug`](/reference/command-line#--debug) when starting 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

<p align="center">
<img src="/content/docs/FAQ/troubleshoot-debug-mode.webp" width="50%" />
</p>

## Does Bytebase support post action after applying a change to the database

You can configure [project webhook](/change-database/webhook/#supported-webhook-endpoints) to observe events.

## Which data does Bytebase collect?

_To make deployment air-gapped, you can disable the collection by passing [`--disable-metric`](/reference/command-line/#disable-sample) on startup_.

- Anonymous usage data.
- The registered email and name of the first member in the workspace.