From 6d97cc850d6129791e924ed0642788ef5aab553a Mon Sep 17 00:00:00 2001
From: Philipp Fruck <dev@p-fruck.de>
Date: Tue, 1 Nov 2022 21:52:17 +0100
Subject: [PATCH] add .env sample to README

---
 README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/README.md b/README.md
index e69de29..ba67db8 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,21 @@
+# Fab Access
+
+The backend implementation that handles access control for the FabLab. In order to test, a `.env` file with the following content must be created. A test setup can then be started using `docker-compose up --build`
+
+
+```sh
+KEYCLOAK_URL=auth.sfz-aalen.space
+KEYCLOAK_USER_NAME=YOUR_USERNAME
+KEYCLOAK_USER_PW=YOUR_PASSWORD
+KEYCLOAK_REALM=master
+
+DB_HOSTNAME=db
+DB_USERNAME=postgres
+DB_PASSWORD=postgres
+DB_DATABASE=fab_access
+
+MQTT_USERNAME=user
+MQTT_PASSWORD=password
+MQTT_BROKER=mqtt
+MQTT_CLIENT=FabMan
+```