Skip to content

Latest commit

 

History

History
54 lines (41 loc) · 1.75 KB

DOCKER.md

File metadata and controls

54 lines (41 loc) · 1.75 KB
Raw

Brayns with Docker

Use Docker to run Brayns 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 brayns

Usage

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

# `-p 8200:8200` 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 8200:8200 brayns

If you want to run Brayns use:

# Runs Brayns as a service with the HTTP interface binded on port 8200
docker run -ti --rm -p 8200:8200 brayns

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 API on port 8200
docker stack deploy -c docker-compose.yml brayns

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

Run Brayns with the HTTP interface binded to a different port:

docker run -ti --rm -p 8300:8300 brayns --http-server :8300

Provide other flags (or env vars) to braynsService:

docker run -ti --rm -p 8300:8300 brayns \
    --http-server :8300 \
    --plugin braynsCircuitViewer