VCS with ngrok

ngrok is a reverse proxy tunnel, and in our case, we need it for a public network address in order to receive webhooks from VCS. ngrok we used here is for demonstration purposes. For production use, we recommend using Caddy.

1. Login to ngrok Dashboard and follow its Getting Started steps to install and configure.

2. Run ngrok:

   ngrok http 5678

   and obtain the public URL https://b725-103-197-71-76.ap.ngrok.io:

3. Run Bytebase in Docker with the following command:

   docker run --init \
     --name bytebase \
     --restart always \
     --publish 5678:8080 \
     --health-cmd "curl --fail http://localhost:5678/healthz || exit 1" \
     --health-interval 5m \
     --health-timeout 60s \
     --volume ~/.bytebase/data:/var/opt/bytebase \
     bytebase/bytebase:2.11.1 \
     --data /var/opt/bytebase \
     --port 8080

4. Bytebase is running successfully in Docker, and you can visit it via localhost:5678. Register an admin account and it will be granted the workspace admin role automatically.

5. Click the gear icon (Settings) on the top right. Click General under Workspace. Paste https://b725-103-197-71-76.ap.ngrok.io as External URL under Network section and click Update.

   

6. Bytebase is running successfully in Docker, and you can visit it via https://b725-103-197-71-76.ap.ngrok.io.