DOCKER.md

Docker

Use Docker to run Blue Brain BioExplorer as a service and avoid painful tooling setup.

Prerequisites

Head over to Docker and install Docker for your own platform.

Setup

First build the image (it's necessary to do this step if you want to run Brayns):

docker build . -t bioexplorer

Usage

By default, the entrypoint when running the image is braynsService, but if you want to ssh into the container use:

# `-p 5000:5000` is used only to provide some port bindings (host:container) if you want to run and access Brayns from your host while in the container
docker run -ti --rm --entrypoint bash -p 5000:5000 bioexplorer

If you want to run Blue Brain BioExplorer use:

# Runs Blue Brain BioExplorer as a service with the HTTP interface binded on port 5000
docker run -ti --rm -p 5000:5000 bioexplorer

NOTE If you are having trouble exiting the process after you run the container (with the above command), use docker stop <container-id> to stop the container. docker ps will give you the current running process.

If you'd like to also run the UI, use docker stack:

# UI on port 8000 and Python SDK on port 8888
docker stack deploy -c docker-compose.yml bioexplorer

NOTE You have to build both the UI and API images (using docker-compose build) before you can run them using stacks.

Run Blue Brain BioExplorer with the HTTP interface binded to a different port:

docker run -ti --rm -p 5000:5000 bioexplorer --http-server :5000

Provide other flags (or env vars) to braynsService:

docker run -ti --rm -p 5000:5000 bioexplorer \
    --http-server :5000 \
    --plugin BioExplorer