Skip to content

Commit

Permalink
Fix patternatlas setup (#23)
Browse files Browse the repository at this point in the history
  • Loading branch information
manuwei authored Aug 24, 2021
1 parent 8e143d1 commit 195c519
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 5 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,21 +19,27 @@ A detailed documentation can be found [here](https://quantil.readthedocs.io/en/l
The fastest way to get started is using [Docker Compose](https://docs.docker.com/compose/).

The base components QC Atlas, QC Atlas UI, LaTeX Renderer, and the databases without any of the named features run by default using:
```shell
docker-compose pull
docker-compose up
```
```shell
docker-compose pull
docker-compose up db -d
docker-compose up
```

> ⚠️ The database (db) must be started before the other containers to ensure that it was fully initialized. Otherwise the other containers may fail to start.

For running certain feature sets on top of the base components, [Profiles](https://docs.docker.com/compose/profiles/) are used.
To start a certain feature set run:
```shell
docker-compose --profile <name-of-feature-set> pull
docker-compose up db -d
docker-compose --profile <name-of-feature-set> up
```

For running multiple feature sets, e.g. two sets, run:
```shell
docker-compose --profile <name-of-feature-set-1> --profile <name-of-feature-set-2> pull
docker-compose --profile <name-of-feature-set-1> --profile <name-of-feature-set-2> up
docker-compose --profile <name-of-feature-set-1> up db -d
docker-compose --profile <name-of-feature-set-1> --profile <name-of-feature-set-2> up db
```

For running all feature sets, choose `--profile all`.
Expand Down
2 changes: 2 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,8 @@ services:
JDBC_DATABASE_USERNAME: patternatlas
JDBC_DATABASE_PASSWORD: patternatlas
JDBC_DATABASE_PORT: 5060
LATEX_RENDERER_HOST_NAME: latex-renderer
LATEX_RENDERER_PORT: 5030
API_PORT: 1977
ports:
- '1977:1977'
Expand Down

0 comments on commit 195c519

Please sign in to comment.