Server Startup Options
The "help" command prints all applicable options
1
$ ./bytebase help
2
​
3
Bytebase is a database schema change and version control tool
4
​
5
Usage:
6
bytebase [flags]
7
bytebase [command]
8
​
9
Available Commands:
10
completion generate the autocompletion script for the specified shell
11
help Help about any command
12
version Print the version number of Bytebase
13
​
14
Flags:
15
--data string directory where Bytebase stores data. If relative path is
16
supplied, then the path is relative to the directory where
17
bytebase is under (default ".")
18
--debug whether to enable debug level logging
19
--demo whether to run using demo data
20
-h, --help help for bytebase
21
--host string host where Bytebase is accessed from, must start with
22
http:// or https://. This is used by Bytebase to create the
23
webhook callback endpoint for VCS integration (default
24
"https://localhost")
25
--port int port where Bytebase is accessed from. This is also used by
26
Bytebase to create the webhook callback endpoint for VCS
27
integration (default 80)
28
--readonly whether to run in read-only mode
Copied!

--data <<directory>>

default: .
The directory where Bytebase stores its own data. 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.

--demo

default: false
If specified, Bytebase will load the demo data instead of the real data. The data is the same used by https://demo.bytebase.com. 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 file, which means the demo data and real data never interferes with each other.

--host <<string>>

default: http://localhost
Must start with http:// or https://. Together with --port, the host:port should be the address your user visiting Bytebase. It's also used by Bytebase to create the webhook callback endpoint for VCS integration.
Because --host is part of the webhook callback endpoint. If the same Bytebase instance is brought up with a different --host, the webhook for the VCS integration created before will likely have a stale callback endpoint.

--port <<number>>

default: 80
The port where Bytebase is running. See --host for more info.

--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).
Whenever you download a new Bytebase version, first time you should always start it without --readonly so that Bytebase can apply its own schema upgrade if needed.
Last modified 3mo ago