The project consinsts of three parts: Python API (/api), main page (/frontpage) and the results page (/results).

Two setups are available, a local development version and a production version meant to be run in Openstack cloud.

To run the development version of ChannelsDB 2, use the following commands:

$ docker compose -f docker/docker-compose.yaml build
$ docker compose -f docker/docker-compose.yaml up

By default, the application runs on port 80 and uses /data as the data directory. To change this behaviour, set the following environment variables before running docker compose up. For example:

export CHANNELSDB_PORT=8080
export CHANNELSDB_DATA=/home/channelsdb/data

The production version has to use docker/docker-compose.production.yaml together with the main docker/docker-compose.yaml file. No further setup is allowed.