Skip to content

docs: move System Requirements from FAQ to Production Setup #795

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
tianzhou merged 1 commit into from
Aug 11, 2025
Merged

docs: move System Requirements from FAQ to Production Setup #795

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 0 additions & 22 deletions mintlify/faq.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,28 +17,6 @@ English, 简体中文, Español, 日本語

SOC 2 Type II.

## System requirements

### Resources

Bytebase is a single Go binary and is lightweight.

#### CPU and RAM

| Usage | Bytebase | [External PostgreSQL](/get-started/self-host/external-postgres/) if used |
| ------------------------------- | ------------------------- | ---------------------------------------------------------------------- |
| 5 users and 5 instances | 1 CPU cores and 2 GB RAM | 1 CPU cores and 2 GB RAM |
| 20 users and 20 instances | 2 CPU cores and 4 GB RAM | 1 CPU cores and 2 GB RAM |
| 50 users and 50 instances | 4 CPU cores and 8 GB RAM | 2 CPU cores and 4 GB RAM |
| Above 250 users or 50 instances | 8 CPU cores and 16 GB RAM | 2 CPU cores and 4 GB RAM |

#### Storage

Bytebase stores the SQL statements. If your team submits large SQL statements frequently,
then you need to reserve large disk space. A good starting point is to reserve 100 GB for where
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.




Expand Down
2 changes: 1 addition & 1 deletion mintlify/get-started/self-host/deploy-with-docker.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Bytebase is now accessible at http://localhost:8080.

For production deployments:

1. Review [System Requirements](/faq#system-requirements) to ensure adequate resources.
1. Review [System Requirements](/get-started/self-host/production-setup#system-requirements) to ensure adequate resources.
2. Configure [External PostgreSQL](/get-started/self-host/external-postgres/) for production deployments.
3. Configure [HTTPS and WebSocket](/get-started/self-host/external-access) in your gateway (e.g., Nginx) for secure connections.
4. See the complete [Production Setup Guide](/get-started/self-host/production-setup/) for additional recommendations.
Expand Down
2 changes: 1 addition & 1 deletion mintlify/get-started/self-host/deploy-with-kubernetes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Deploy with Kubernetes

## Prerequisites

1. Review [System Requirements](/faq#system-requirements) to ensure adequate resources.
1. Review [System Requirements](/get-started/self-host/production-setup#system-requirements) to ensure adequate resources.
2. Configure [External PostgreSQL](/get-started/self-host/external-postgres/) for production deployments.
3. Configure [External Access](/get-started/self-host/external-access) in your gateway or ingress for secure connections.
4. See the complete [Production Setup Guide](/get-started/self-host/production-setup/) for additional recommendations.
Expand Down
20 changes: 19 additions & 1 deletion mintlify/get-started/self-host/production-setup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,25 @@ title: Production Setup

This page describes how to set up Bytebase in production environment.

[System Requirements](/faq/##system-requirements)
## System Requirements

### CPU and RAM

| Usage | Bytebase | [External PostgreSQL](/get-started/self-host/external-postgres/) if used |
| ------------------------------- | ------------------------- | ---------------------------------------------------------------------- |
| 5 users and 5 instances | 1 CPU cores and 2 GB RAM | 1 CPU cores and 2 GB RAM |
| 20 users and 20 instances | 2 CPU cores and 4 GB RAM | 1 CPU cores and 2 GB RAM |
| 50 users and 50 instances | 4 CPU cores and 8 GB RAM | 2 CPU cores and 4 GB RAM |
| Above 250 users or 50 instances | 8 CPU cores and 16 GB RAM | 2 CPU cores and 4 GB RAM |

### Storage

Bytebase uses a PostgreSQL database to store SQL statements and other metadata.

- If using cloud services (RDS, Cloud SQL) that support disk expansion, you can start with 20 GB and increase the size later as usage grows
- Otherwise, start with 100 GB to avoid running out of space

Teams that frequently work with large SQL files may need more.

## Enable HTTPS and WebSocket

Expand Down
2 changes: 1 addition & 1 deletion mintlify/onboarding/poc.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ enterprise license.

## Install

- [System Requirements](/faq/##system-requirements)
- [System Requirements](/get-started/self-host/production-setup#system-requirements)
- [Docker](/get-started/self-host/deploy-with-docker), [Kubernetes](/get-started/self-host/deploy-with-kubernetes)
- [Production Setup](/get-started/self-host/production-setup)

Expand Down