Server Startup Options

The "help" command prints all applicable options

./bytebase help

And the output will look like this:

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/install/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)
      --readonly                   whether to run in read-only mode

--data <<directory>>#

default: .

The directory where Bytebase stores its own data if --pg 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. 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>>#

default: https://www.bytebase.com/docs/get-started/install/external-url

The external URL where user visits Bytebase, must start with http:// or https://.

See Configure External URL.

--pg <<string>>#

default: ""

Optional external PostgreSQL instance connection url. If specified, Bytebase will store its own metadata there.

See Configure External PostgreSQL.

--port <<number>>#

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.

--readonly#

default: false

If specified, Bytebase will run in read-only mode. This mode is mostly useful when you want to schedule a maintenance window or enforce a deployment freeze.

You can also enable --demo and --readonly together to have a long running demo instance without worrying about the data being changed accidentally (this is how https://demo.bytebase.com is configured).