Skip to content

Latest commit

 

History

History
56 lines (44 loc) · 2.55 KB

DOCKER.md

File metadata and controls

56 lines (44 loc) · 2.55 KB
Raw

Docker

Use Docker to run the 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 bluebrain/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 bluebrain/bioexplorer

If you want to run the Blue Brain BioExplorer without a database, use:

# Runs the Blue Brain BioExplorer as a service with the HTTP interface bound to port 5000
docker run -ti --rm -p 5000:5000 bluebrain/bioexplorer

If you want to run the Blue Brain BioExplorer with a database use:

# Runs the Blue Brain BioExplorer as a service with the HTTP interface bound to port 5000
docker run -ti --rm -p 5000:5000 bluebrain/bioexplorer --http-server :5000 --plugin "BioExplorer --db-name=bioexplorer --db-password=bioexplorer --db-user=postgres --db-host=<ip address> --db-port=5432" --plugin MediaMaker

Replace <ip address> with the IP address of the host where the database docker container is running. Refer to the database Docker readme for more information on how to set up and populate the the Blue Brain BioExplorer database with publicly available datasets.

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 bluebrain/bioexplorer

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

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

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

Provide other flags (or env vars) to service:

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