PQCA CBOMKit

This guide details the process for deploying the PQCA CBOMKit (formerly by IBM) using Docker.

Prerequisites

Update your package index and install the necessary dependencies.

sudo apt update && sudo apt upgrade -y
sudo apt install -y ca-certificates curl gnupg lsb-release make

Install Docker Engine

Follow these steps to set up the official Docker repository and install Docker.

1. Add Docker's official GPG key:

sudo mkdir -p /etc/apt/keyrings
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg

2. Set up the repository:

echo \
  "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu \
  $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null

3. Install Docker packages:

sudo apt update
sudo apt install -y docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin

4. Configure user permissions: Add your current user to the docker group to execute commands without root privileges.

sudo usermod -aG docker ${USER}

Note

Log out and back in (or restart your session) for group changes to take effect.

Deploy CBOMKit

1. Clone the repository:

git clone https://github.com/cbomkit/cbomkit
cd cbomkit

2. Configure the Makefile: Open the Makefile for editing:

vim Makefile

Locate the production section and change the command $(ENGINE)-compose to $(ENGINE) compose to use the modern Docker Compose plugin.

3. Start the application: Run the production build command:

make production

Once the deployment is complete, access the CBOMKit interface at: http://localhost:8001.

Important

If you are deploying this on a Virtual Machine (VM) rather than your local machine, you must replace all instances of localhost with your VM's IP address in docker-compose.yaml. Then you can access the CBOMKit interface at http://<VM_IP_ADDRESS>:8001.