From 480ef49018662bfad61dcbcb4004ffa3a8d7b327 Mon Sep 17 00:00:00 2001
From: Jesper Zedlitz <jesper@zedlitz.de>
Date: Mon, 11 Apr 2022 10:28:10 +0200
Subject: [PATCH] =?UTF-8?q?README=20hinzugef=C3=BCgt?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a084c18
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# opendata-uploadform
+
+
+
+## Produktion
+
+Gestartet werden kann das Programm so:
+
+```bash
+java -Dspring.profiles.active=production -jar uploadform.jar --server.servlet.context-path=/upload
+```
+
+Im Produktivmodus erwartet das Programm folgende Environment-Variablen:
+
+- `DB_FILE` - Datei für die H2-Datenbank
+- `DIRECTORY` - in diesem Verzeichnis werden hochgeladene Dateien gespeichert
+- `SECRECT` - zufällige Zeichenkette, die zum Erzeugen des HMAC verwendet wird
+- `PASSWORD` - Passwort für den (einzigen) Account `leitstelle`
+
+## Entwicklung
+
+Gestartet werden kann das Programm so:
+
+```bash
+./mvnw spring-boot:run
+```
+
+Im Entwicklungsmodus ist das System vorkonfiguriert: Die Datenbank existiert nur im Speicher und wird nach Beenden des Programms verworfen. Zugangsdaten sind `leitstelle:leitstelle`. Hochgeladene Dateien werden in `/tmp` gespeichert.
-- 
GitLab