Server Startup Options
The "help" command prints all applicable options
And the output will look like this:
--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://.
--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).