Skip to content

Commit ae98fa9

Browse files
Tamas Pallospallost
authored andcommitted
Add Docker reference to the README
1 parent f5176af commit ae98fa9

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,3 +45,21 @@ Code should be written using [standard Kotlin coding conventions](https://kotlin
4545
Also:
4646

4747
- Additionally, minimize the use of mutable variables, using `val` whenever possible.
48+
49+
## Docker reference
50+
51+
The application uses spring boot which allows overwriting configuration properties as described
52+
[here](https://docs.spring.io/spring-boot/docs/current/reference/html/features.html#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables).
53+
The docker container is also able to
54+
[read secrets](https://github.com/HSLdevcom/jore4-tools#read-secretssh) and expose
55+
them as environment variables.
56+
57+
The following configuration properties are to be defined for each environment:
58+
59+
| Config property | Environment variable | Secret name | Example | Description |
60+
| --------------- | ---------------------- | ----------- | ----------------------------------- | --------------------------------------------------------------------------------------------------- |
61+
| - | SECRET_STORE_BASE_PATH | - | /mnt/secrets-store | Directory containing the docker secrets |
62+
| hasura.url | HASURA_URL | hasura-url | http://jore4-hasura:8080/v1/graphql | Hasura microservice base url |
63+
| hasura.secret | _don't use_ | _don't use_ | hasura | Hasura admin secret used only for generating graphql schema. _Don't use it for the running service_ |
64+
65+
More properties can be found from `/profiles/prod/config.properties`

0 commit comments

Comments
 (0)