Skip to main content

Containerized Installation

Method 1: Installing from Docker Hub (fast)​

Pull the latest Docker image from Docker Hub:

docker pull manuelrueda/clarid-tools:latest
docker image tag manuelrueda/clarid-tools:latest cnag/clarid-tools:latest

Method 2: Building from source​

Clone the repository so Docker can build the image from that exact checkout:

git clone https://github.com/CNAG-Biomedical-Informatics/clarid-tools.git
cd clarid-tools

To reproduce a release image, check out the desired annotated release tag before building.

Then build the container from the repository root:

  • For Docker version 19.03 and above (supports buildx):

    docker buildx build -f docker/Dockerfile -t cnag/clarid-tools:latest .

  • For Docker versions older than 19.03 (no buildx support):

    docker build -f docker/Dockerfile -t cnag/clarid-tools:latest .

Running and Interacting with the Container​

The Docker image already includes the external QR dependencies used by clarid-tools qrcode, including qrencode and zbarimg (zbar-tools).

To run the container:

docker run -tid -e USERNAME=root --name clarid-tools cnag/clarid-tools:latest

To connect to the container:

docker exec -ti clarid-tools bash

Or, to run directly from the host:

alias clarid-tools='docker exec -ti clarid-tools /usr/share/clarid-tools/bin/clarid-tools'
clarid-tools

System requirements​

  • OS/ARCH supported: linux/amd64 and linux/arm64.
  • Ideally a Debian-based distribution (Ubuntu or Mint), but any other (e.g., CentOS, OpenSUSE) should do as well (untested).
  • 1GB of RAM
  • >= 1 core (ideally i7 or Xeon).
  • At least 5GB HDD.

Common errors: Symptoms and treatment​