Skip to content
Merged
Show file tree
Hide file tree
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
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ spec:
[
'--port',
'8080',
'--disable-sample',
]
ports:
- containerPort: 8080
Expand Down
2 changes: 1 addition & 1 deletion mintlify/get-started/step-by-step/add-an-instance.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ title: 'Step 4: Add an Instance'

<Info>

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`.

</Info>

Expand Down
93 changes: 17 additions & 76 deletions mintlify/reference/command-line.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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` &lt;&lt;directory&gt;&gt;

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 &lt;&lt;directory&gt;&gt; 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` &lt;&lt;string&gt;&gt;

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` &lt;&lt;string&gt;&gt;
## Available Flags

default: **[/get-started/self-host/external-url](https://www.bytebase.com/docs/get-started/self-host/external-url)**
### `--data <directory>`

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` &lt;&lt;string&gt;&gt;
- 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.

<Tip>
### `--external-url <string>`

Alternatively, you can also pass PG_URL environment variable.
**Default:** See [Configure External URL](/get-started/self-host/external-url)

</Tip>
The external URL where users access Bytebase. Must start with `http://` or `https://`.

## `--port` &lt;&lt;number&gt;&gt;
### `--port <number>`

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).
The port where Bytebase server runs. Bytebase listens on all network interfaces for the specified port.
6 changes: 2 additions & 4 deletions src/app/[locale]/(legal)/security/page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,7 @@ export default function Page() {
.
</li>
<li>
One can specify <Link href="/docs/get-started/install/external-postgres/">--pg</Link> 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.
</li>
</ul>
<h2 id="cloud">Bytebase Cloud</h2>
Expand Down Expand Up @@ -94,8 +93,7 @@ export default function Page() {
bare-metal.
</li>
<li>
Anonymous usage metrics are collected and sent to Segment. Collection can be disabled by
passing <Link href="/docs/reference/command-line/#disable-sample">--disable-sample</Link>.
Anonymous usage metrics are collected and sent to Segment. Collection can be disabled in the workspace settings.
</li>
</ul>
<h2>Shared practices between Bytebase Cloud and self-hosted</h2>
Expand Down