Skip to main content

Docker

Prerequisites​

This section provides all required dependencies to install and start the UI with Docker.

Dependency 1: Docker​

Docker will be used for downloading the UI and managing the lifecycle of the application.

You can refer to Docker's official documentation on installing and configuring the service.

Installation​

This section provides an example of installing the UI with Docker.

This example only shows a subset of all possible configuration options.

Step 1: Download the Image​

Download the Docker image for the Vela UI from DockerHub.

You can use the docker pull command to download the image:

$ docker pull target/vela-ui:latest
info

The latest tag will ensure you install the most-recent version of the Vela UI.

To see the full list of available versions, please refer to the official registry.

Step 2: Start the UI​

Start the Vela UI as a Docker container that is configured via environment variables.

You can use the docker run command to start the worker:

$ docker run \
  --detach=true \
  --env=VELA_API=https://vela-server.example.com \
  --name=ui \
  --publish=80:80 \
  --publish=443:443 \
  --restart=always \
  target/vela-ui:latest
info

For a full list of configuration options, please see the UI reference.

Step 3: Verify the UI Logs​

Ensure the UI started up successfully and is running as expected by inspecting the logs.

You can use the docker logs command to verify the logs:

$ docker logs ui