Skip to content

Commit b23c871

Browse files
author
Dennis Labordus
committed
Updated readme for development.
Signed-off-by: Dennis Labordus <[email protected]>
1 parent bf3b0ac commit b23c871

File tree

2 files changed

+46
-1
lines changed

2 files changed

+46
-1
lines changed

doc/basex.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,28 @@ docker run --rm --name compas_basex \
3737
> **Note:** Replace <BASEX-DIR> with a directory on your local machine, for instance "~/basex".
3838
> All data will be stored in this directory under "data". This way data isn't lost after stopping the docker container.
3939
40+
### Application depends on a running KeyCloak instance
41+
42+
Beside a BaseX Database there is also a KeyCloak instance need to be running on port 8089 by default.
43+
See [README.md](../README.md#security) for default values, if custom keycloak is used.
44+
45+
There is a preconfigured keycloak instance available in
46+
the [CoMPAS Deployment Repository](https://github.com/com-pas/compas-deployment). This repository can be cloned and
47+
when going to this directory the following command can be executed to create a local Docker Image with configuration.
48+
49+
```shell
50+
cd <CoMPAS Deployment Repository Directory>/compas/keycloak
51+
docker build -t compas_keycloak .
52+
```
53+
54+
There is now a Docker Image `compas_keycloak` created that can be started using the following command
55+
56+
```shell
57+
docker run --rm --name compas_keycloak \
58+
-p 8089:8080
59+
-d compas_keycloak:latest
60+
```
61+
4062
### Building the application
4163

4264
You can run the following command to build the BaseX version of the application.

doc/postgresql.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,30 @@ docker run --rm --name compas_postgresql \
5656
```
5757

5858
> **Note:** Replace <LOCAL-DATA-DIR> with a directory on your local machine, for instance "~/postgres".
59-
> All data will be stored in this directory under "compas". This way data isn't lost after stopping the docker container.
59+
> All data will be stored in this directory under "compas". This way data isn't lost after stopping the docker
60+
> container.
61+
62+
### Application depends on a running KeyCloak instance
63+
64+
Beside a PostgreSQL Database there is also a KeyCloak instance need to be running on port 8089 by default.
65+
See [README.md](../README.md#security) for default values, if custom keycloak is used.
66+
67+
There is a preconfigured keycloak instance available in
68+
the [CoMPAS Deployment Repository](https://github.com/com-pas/compas-deployment). This repository can be cloned and
69+
when going to this directory the following command can be executed to create a local Docker Image with configuration.
70+
71+
```shell
72+
cd <CoMPAS Deployment Repository Directory>/compas/keycloak
73+
docker build -t compas_keycloak .
74+
```
75+
76+
There is now a Docker Image `compas_keycloak` created that can be started using the following command
77+
78+
```shell
79+
docker run --rm --name compas_keycloak \
80+
-p 8089:8080
81+
-d compas_keycloak:latest
82+
```
6083

6184
### Building the application
6285

0 commit comments

Comments
 (0)