study-faraphel/M1-PE-Kafka
1
1
Fork 0
Code Issues Pull requests Projects 1 Releases Packages Wiki Activity Actions

added the configuration section to the README file

Browse source
This commit is contained in:
Faraphel 2024-06-23 14:51:09 +02:00
parent 009735dc63
commit bf3e1310af
1 changed files with 14 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -21,6 +21,18 @@ gradlew build
docker compose up
```
## Configuration
If wished, you can modify the configuration of the `docker-compose.yaml` file to fit your need.
The container `application` can be easily modified with the following environment variables :
| Name | Required | Format | Default | Description |
|------------------------------|----------|-----------------------------------------------------|--------------------------------------------------------------------|---------------------------------------------------------------|
| KAFKA_BOOTSTRAP_SERVERS | true | \<ip>[:port] | / | The Kafka server address |
| TOPIC_TEMPERATURE_CELSIUS | false | string of alphanumeric characters, ".", "_" and "-" | temperature-celsius | The name of the Kafka topic for the temperature in Celsius |
| TOPIC_TEMPERATURE_FAHRENHEIT | false | string of alphanumeric characters, ".", "_" and "-" | temperature-fahrenheit | The name of the Kafka topic for the temperature in Fahrenheit | |
| TEMPERATURE_LOCATION | true | \<latitude>, \<longitude> | 49.9, 2.3 ([Amiens, France](https://fr.wikipedia.org/wiki/Amiens)) | The coordinates were to get the temperatures from |
## Expectation
The `application` container shall print the current temperature at the selected place in
Fahrenheit every minute.
The `application` container shall print the current temperature at the selected place in
Fahrenheit every minute.