diff --git a/mintlify/get-started/self-host/deploy-with-kubernetes.mdx b/mintlify/get-started/self-host/deploy-with-kubernetes.mdx index 8a6d1d7ab..1a537ffcf 100644 --- a/mintlify/get-started/self-host/deploy-with-kubernetes.mdx +++ b/mintlify/get-started/self-host/deploy-with-kubernetes.mdx @@ -43,7 +43,6 @@ spec: [ '--port', '8080', - '--disable-sample', ] ports: - containerPort: 8080 diff --git a/mintlify/get-started/step-by-step/add-an-instance.mdx b/mintlify/get-started/step-by-step/add-an-instance.mdx index d486258cc..a0fce2ce8 100644 --- a/mintlify/get-started/step-by-step/add-an-instance.mdx +++ b/mintlify/get-started/step-by-step/add-an-instance.mdx @@ -12,7 +12,7 @@ title: 'Step 4: Add an Instance' -Bytebase starts two embedded sample PostgreSQL instances accessible from `/tmp:8083` and `/tmp:8084`, you can turn them off by passing [`--disable-sample`](/reference/command-line/#disable-sample) upon startup. +If you choose to use sample data during onboarding, Bytebase will start two embedded sample PostgreSQL instances accessible from `/tmp:8083` and `/tmp:8084`. diff --git a/mintlify/reference/command-line.mdx b/mintlify/reference/command-line.mdx index 0b1f4fc12..58fdc0c3b 100644 --- a/mintlify/reference/command-line.mdx +++ b/mintlify/reference/command-line.mdx @@ -2,96 +2,37 @@ title: Server Startup Options --- -The "help" command prints all applicable options +The help command prints all applicable options: -```text +```bash ./bytebase help ``` -And the output will look like this: - -```plain -Bytebase is a database schema change and version control tool - -Usage: - bytebase [flags] - bytebase [command] - -Available Commands: - completion Generate the autocompletion script for the specified shell - help Help about any command - version Print the version of Bytebase - -Flags: - --data string directory where Bytebase stores metadata if `--pg` is not specified. If relative path is supplied, then the path is relative to the directory where Bytebase is under (default ".") - --debug whether to enable debug level logging - --demo string name of the demo to use. If specified, Bytebase will run in demo mode - --disable-metric disable the metric collector - --disable-sample disable the sample instance - --external-url string the external URL where user visits Bytebase, must start with http:// or https:// (default "https://www.bytebase.com/docs/get-started/self-host/external-url") - -h, --help help for bytebase - --pg string optional external PostgreSQL instance connection url(must provide dbname); for example postgresql://user:secret@masterhost:5432/dbname?sslrootcert=cert - --port int port where Bytebase server runs. Default to 8080 (default 8080) -``` - -## `--data` <<directory>> - -default: **.** - -The directory where Bytebase stores its own data if [`--pg`](#pg-string) is not specified. The directory must exist beforehand, otherwise Bytebase will fail to start. If <<directory>> is a relative path, then it's relative to the directory where the bytebase binary runs. - -## `--debug` - -default: **false** - -If specified, Bytebase will emit more logs, this is only used when troubleshooting Bytebase issues. - -## `--disable-metric` - -default: **false** - -If specified, Bytebase will not collect usage metric. - -## `--disable-sample` - -default: **false** - -If specified, Bytebase will not start sample Postgres instance. - -## `--demo` <<string>> - -default: **""** - -The demo name. If specified, Bytebase will load the demo data instead of the real data. The data is the same used by [the demo](https://www.bytebase.com/view-live-demo). This is a quick way to test the product yourself or demonstrate it to your peers. When Bytebase is started with `--demo`, it stores the data in a separate location, which means the demo data and real data never interferes with each other. - -The current available demo names are: - -- default - -## `--external-url` <<string>> +## Available Flags -default: **[/get-started/self-host/external-url](https://www.bytebase.com/docs/get-started/self-host/external-url)** +### `--data ` -The external URL where user visits Bytebase, must start with `http://` or `https://`. +**Default:** `.` (current directory) -See [Configure External URL](/get-started/self-host/external-url). +Specifies the directory where Bytebase stores its metadata. The directory must exist beforehand, otherwise Bytebase will fail to start. -## `--pg` <<string>> +- 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 -default: **""** +### `--debug` -Optional external PostgreSQL instance connection url. If specified, Bytebase will store its own metadata there. +**Default:** `false` -See [Configure External PostgreSQL](/get-started/self-host/external-postgres). +Enables debug level logging for troubleshooting Bytebase issues. This flag produces verbose output that can help diagnose problems. - +### `--external-url ` -Alternatively, you can also pass PG_URL environment variable. +**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` <<number>> +### `--port ` -default: **8080** +**Default:** `8080` -The port where Bytebase is running. Bytebase listens on all network interfaces for the specified port. For production setup, see [Configure External URL](/get-started/self-host/external-url). \ No newline at end of file +The port where Bytebase server runs. Bytebase listens on all network interfaces for the specified port. \ No newline at end of file diff --git a/src/app/[locale]/(legal)/security/page.tsx b/src/app/[locale]/(legal)/security/page.tsx index 67b7d210f..9583f56b7 100644 --- a/src/app/[locale]/(legal)/security/page.tsx +++ b/src/app/[locale]/(legal)/security/page.tsx @@ -43,8 +43,7 @@ export default function Page() { .
  • - One can specify --pg to - store the metadata in an external PostgreSQL instance instead of the embedded one. + One can store the metadata in an external PostgreSQL instance instead of the embedded one.
  • Bytebase Cloud

    @@ -94,8 +93,7 @@ export default function Page() { bare-metal.
  • - Anonymous usage metrics are collected and sent to Segment. Collection can be disabled by - passing --disable-sample. + Anonymous usage metrics are collected and sent to Segment. Collection can be disabled in the workspace settings.
  • Shared practices between Bytebase Cloud and self-hosted