Docker

Create the docker-compose.yml file

There are a couple of things to consider when running QuantumHub in Docker.

1. By default, Docker will assign an IP address to the container. This IP address is not guaranteed to be static, and it may change when the container is restarted.
2. The frontend needs an environment variable pointing to the API. If you are using HTTPS for the frontend, you will also need to make sure the API is accessible over HTTPS.
3. The QuantumHub API and Frontend do not contain any authentication, so make sure you do not expose them to the public internet.

Currently you need to manually create the config.js file and mount it into the frontend container. This file needs to contain the following code:

window.API_URL = 'http://<IP-OF-BACKEND>:3000';

Create the docker-compose.yml file

---
version: "2.1"
services:
  quantumhub:
    image: sortedbit/quantumhub:latest
    container_name: quantumhub
    environment:
      - TZ=Etc/UTC
    ports:
      - 3000:3000
    volumes:
      - ./config.yaml:/home/node/app/config.yaml
    restart: always

  quantumhub_frontend:
    image: sortedbit/quantumhub-frontend:latest
    container_name: quantumhub-frontend
    volumes:
      - /PATH/TO/config.js:/usr/share/nginx/html/config.js    
    ports:
      - 3001:80

Grab the example configuration file

wget https://raw.githubusercontent.com/sorted-bits/quantumhub/main/config.yaml.example -O config.yaml

Update the configuration file

Edit the configuration file so it matches your setup.

Run the container

docker compose up

Access the Webinterface

Open your browser and navigate to http://localhost:3000.