Server Startup Options
The "help" command prints all applicable options
And the output will look like this:
If specified, Bytebase will store all of the backup data in the cloud bucket. For MySQL instances, this also means all binlog files are stored in the cloud bucket.
For detailed instructions to setup the cloud bucket, please follow this doc.
Must be specified if
--backup-bucket is provided. Bytebase will use this file as the credentials to access the cloud bucket.
Must be specified if
--backup-bucket is provided and the cloud vendor is AWS S3.
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.
If specified, Bytebase will emit more logs, this is only used when troubleshooting Bytebase issues.
The demo name. 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 location, which means the demo data and real data never interferes with each other.
The current available demo names are:
The external URL where user visits Bytebase, must start with http:// or https://.
Optional external PostgreSQL instance connection url. If specified, Bytebase will store its own metadata there. Check setup guide for details.
The port where Bytebase is running. Bytebase listens on all network interfaces for the specified port. For production setup, see Configure External URL.
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).