Configure External URL
warning
You must configure the correct External URL otherwise following features won't work:
When running Bytebase in production, you should not make the node that's running the Bytebase server directly accessible to the public internet. Instead, you should set up an internet gateway such as Nginx or Caddy by configuring External URL to the endpoint exposed by the gateway.
info
If the exposed port is not 80 or 443, please include the port number in External URL as well. e.g. Use https://bytebase.example.com:8080 instead of https://bytebase.example.com.
Pass --external-url when starting Bytebase
Pass --external-url when starting Bytebase.
info
This will persist the External URL setting. Thus if Bytebase starts without specifying --external-url next time, the previously passed External URL value will still be there.
Configure via UI
- Click Settings on the top bar.
- Click General under Workspace, fill in the desired External URL and click Update.
