Skip to content

Commit

Permalink
Merge pull request #375 from favreau/master
Browse files Browse the repository at this point in the history
Updated DOCKER.md
  • Loading branch information
favreau authored Jun 4, 2024
2 parents acefc93 + ad9ee5c commit d07152a
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions DOCKER.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,26 @@ Head over to [Docker](https://docs.docker.com/engine/installation/#supported-pla
## Setup
First build the image (*it's necessary to do this step if you want to run Brayns*):
```bash
docker build . -t bioexplorer
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:
```bash
# `-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
docker run -ti --rm --entrypoint bash -p 5000:5000 bluebrain/bioexplorer
```

If you want to run the Blue Brain BioExplorer without a database, use:
```bash
# Runs the Blue Brain BioExplorer as a service with the HTTP interface bound to port 5000
docker run -ti --rm -p 5000:5000 bioexplorer
docker run -ti --rm -p 5000:5000 bluebrain/bioexplorer
```

If you want to run the Blue Brain BioExplorer with a database use:
```bash
# Runs the Blue Brain BioExplorer as a service with the HTTP interface bound to port 5000
docker run -ti --rm -p 5000:5000 bioexplorer --http-server :5000 --plugin "BioExplorer --db-name=bioexplorer --db-password=bioexplorer --db-user=postgres --db-host=<ip address> --db-port=5432" --plugin MediaMaker
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](./storage/database/DOCKER.md) for more information on how to set up and populate the the Blue Brain BioExplorer database with publicly available datasets.
Expand All @@ -38,19 +38,19 @@ Replace `<ip address>` with the IP address of the host where the database docker
If you'd like to also run the UI, use [docker stack](https://docs.docker.com/get-started/part5):
```bash
# UI on port 8000 and Python SDK on port 8888
docker stack deploy -c docker-compose.yml bioexplorer
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:
```bash
docker run -ti --rm -p 5000:5000 bioexplorer --http-server :5000
docker run -ti --rm -p 5000:5000 bluebrain/bioexplorer --http-server :5000
```

Provide other flags (or env vars) to `braynsService`:
Provide other flags (or env vars) to `service`:
```bash
docker run -ti --rm -p 5000:5000 bioexplorer \
docker run -ti --rm -p 5000:5000 bluebrain/bioexplorer \
--http-server :5000 \
--plugin BioExplorer
```

0 comments on commit d07152a

Please sign in to comment.