Docker image for FACT_core

This repository mainly contains the Dockerfile and docker-compose.yml to build and run a containerized installation of FACT_core. FACT is split in two images (backend and frontend).

Because FACT uses docker itself, the docker socket from the host will be passed to the container. Please make sure that your user is a member of the docker group.

Usage

To initialize the containers the the following lines of shell should get you started.

$ docker pull ghcr.io/fkie-cad/fact-core-frontend:4.0.1
$ docker pull ghcr.io/fkie-cad/fact-core-backend:4.0.1
$ docker pull ghcr.io/fkie-cad/fact-core-scripts:4.0.1
$ ./start.py pull
$ ./start.py compose-env \
    --firmware-file-storage-dir path_to_fw_data_dir
    # Have a look if it looks right
$ eval $(./start.py compose-env --firmware-file-storage-dir path_to_fw_data_dir)
$ export FACT_DOCKER_POSTGRES_PASSWORD=mypassword
$ docker volume create fact_postgres_data
$ docker-compose up -d database
# Wait some seconds until the db is ready
$ ./start.py initialize-db \
    --network fact_docker_fact-network
$ docker-compose up

To shut down the containers use docker-compose stop (Or press Ctrl+C). When you want to start them again use docker-compose start. Don't forget to run eval $(./start.py compose-env --firmware-file-storage-dir path_to_fw_data_dir) beforehand.

We provide a docker-compose.yml and a python script to get FACT in docker running. The docker-compose.yml is parameterized with environment variables. All variables are prefixed by FACT_DOCKER_. The variables can be set to sane defaults with ./start.py compose-env. For documentation about their meanings see docker-compose.yml.

Use ./start.py --help to get help about the usage of the script.

Building the images

To build the docker images locally run make. For this to work you have to set the environment variable FACT_DOCKER_VERSION to the FACT_version you want to install. The lowest supported version is 4.0.1.

Development of FACT_core in FACT_docker

Since the FACT_core is pretty invasive is might be desirable to not install FACT on your system and use this docker image instead. To have access to a FACT installation you can for example start the container with --entrypoint /bin/bash.

Bugs

FACT_docker is in early stages and has some bugs that currently can't be fixed due to FACT_core's architecture. These bugs are documented here.

Docker in docker

As FACT uses docker heavily, we pass the docker socket to the container.

One use of docker is the unpacker. Docker is started with something along the lines of docker run -v PATH_ON_DOCKER_HOST:HARDCODED_PATH_USED_IN_THE_CONTAINER unpacker.

This means that when FACT runs inside a container it must have access to PATH_ON_DOCKER_HOST. Currently PATH_ON_DOCKER_HOST is not always a subdirectory of docker-mount-base-dir. This mostly affects tests (where test data is mounted in containers).