diff --git a/mintlify/docs.json b/mintlify/docs.json index c0c3267c5..26dbac0a4 100644 --- a/mintlify/docs.json +++ b/mintlify/docs.json @@ -225,7 +225,6 @@ { "group": "Reference", "pages": [ - "reference/command-line", "reference/error-code/core", "reference/error-code/advisor", "reference/schema-definition-language" diff --git a/mintlify/get-started/self-host/deploy-with-docker.mdx b/mintlify/get-started/self-host/deploy-with-docker.mdx index 43953ed61..90809471f 100644 --- a/mintlify/get-started/self-host/deploy-with-docker.mdx +++ b/mintlify/get-started/self-host/deploy-with-docker.mdx @@ -54,28 +54,8 @@ Due to the vm mechanism of [Colima](https://github.com/abiosoft/colima), try to ```text mkdir ~/volumes colima start --mount ~/volumes:w -docker run --init \ - --name bytebase \ - --restart always \ - --publish 80:8080 --pull always \ - --volume ~/.bytebase/data:/var/opt/bytebase bytebase/bytebase:latest \ - --data /var/opt/bytebase \ - --external-url http://bytebase.example.com \ - --port 8080 ``` -### Advanced Options - -For more control over the server configuration, see [Server Startup Options](/reference/command-line). - ### China Access -If accessing from China, use the mirror image: - -```bash -docker run --rm --init \ - --name bytebase \ - --publish 8080:8080 --pull always \ - --volume ~/.bytebase/data:/var/opt/bytebase \ - registry.cn-shanghai.aliyuncs.com/bytebase/bytebase:latest -``` \ No newline at end of file +If accessing from China, use the mirror image: `registry.cn-shanghai.aliyuncs.com/bytebase/bytebase:latest` \ No newline at end of file diff --git a/mintlify/get-started/self-host/external-postgres.mdx b/mintlify/get-started/self-host/external-postgres.mdx index e24779bdd..a0886e287 100644 --- a/mintlify/get-started/self-host/external-postgres.mdx +++ b/mintlify/get-started/self-host/external-postgres.mdx @@ -4,7 +4,7 @@ title: Configure External PostgreSQL import TerminalDockerRunExternalUrl from '/snippets/install/terminal-docker-run-external-url.mdx'; -By default, Bytebase bundles an embedded PostgreSQL instance for storing its own metadata. The metadata is stored under the [`--data`](/reference/command-line#--data-directory) directory. +By default, Bytebase bundles an embedded PostgreSQL instance for storing its own metadata. The metadata is stored under the data directory. **For production setup, you should pass `PG_URL` environment variable to store these metadata in an external PostgreSQL database.** diff --git a/mintlify/reference/command-line.mdx b/mintlify/reference/command-line.mdx deleted file mode 100644 index 58fdc0c3b..000000000 --- a/mintlify/reference/command-line.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Server Startup Options ---- - -The help command prints all applicable options: - -```bash -./bytebase help -``` - -## Available Flags - -### `--data ` - -**Default:** `.` (current directory) - -Specifies the directory where Bytebase stores its metadata. The directory must exist beforehand, otherwise Bytebase will fail to start. - -- If a relative path is supplied, it's relative to the directory where the bytebase binary runs -- Ensure the directory has appropriate read/write permissions - -### `--debug` - -**Default:** `false` - -Enables debug level logging for troubleshooting Bytebase issues. This flag produces verbose output that can help diagnose problems. - -### `--external-url ` - -**Default:** See [Configure External URL](/get-started/self-host/external-url) - -The external URL where users access Bytebase. Must start with `http://` or `https://`. - -### `--port ` - -**Default:** `8080` - -The port where Bytebase server runs. Bytebase listens on all network interfaces for the specified port. \ No newline at end of file