From 4c1c441e5102c2ebefd4df056dc9662545d9d901 Mon Sep 17 00:00:00 2001
From: alex <alex@alexloehr.net>
Date: Mon, 26 May 2025 16:05:54 +0000
Subject: [PATCH] adding doc

---
 README.md |   53 ++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 files changed, 52 insertions(+), 1 deletions(-)

diff --git a/README.md b/README.md
index aa3e813..21ddce3 100644
--- a/README.md
+++ b/README.md
@@ -12,6 +12,12 @@
 
 ## Setup
 
+### Env und Settings
+
+Als Erstes wird die ENV Variable "NODE_ENV" gebraucht. Diese muss gesetzt sein.
+Je nach ENV (dev, test, prod, ...) muss dann auch die settings Datei angepasst werden.
+
+
 ### Service
 
 Der REST-Service an sich muss auf dem gleichen Rechner laufen auf dem auch die ILIAS DB läuft (ansonsten die Config anpassen).
@@ -28,4 +34,49 @@
 
 Apache muss als Proxy für globus-ilias-rest fungieren und Verbindungen an diesen weiterreichen.
 
-todo
+__ACHTUNG__
+Der Service __muss__ unter https laufen. Ansonsten kann das AUTH-TOKEN ausgelesen werden.
+
+#### MOds aktivieren
+
+    a2enmod proxy
+    a2enmod proxy_http
+
+#### Apache Config anpassen
+
+z.B. unter `/etc/apache2/sites-available/globusfm-dev2.minervis.com.conf`
+
+    ProxyPreserveHost On
+    ProxyPass /popcorn http://localhost:4101         
+    ProxyPassReverse / http://localhost:4101
+
+
+_testen_
+
+    https://globusfm-dev2.minervis.com/popcorn/users?token=AUTHTOKEN
+
+
+## Usage
+
+Es wird ein Auth-Token gebraucht um den Service zu benutzen. Dieses wird in settings.js definiert.
+
+Dann kann der Service angesprochen werden (test mit curl):
+
+    curl localhost:4101/users?token=AUTHTOKEN
+
+Die Antwort prettyfeien:
+
+    curl localhost:4101/users?token=AUTHTOKEN | jq .
+   
+
+
+### Routes
+
+Verfügbare Routen sind:
+
+    GET /users
+    GET /users/count
+    GET /user/login/:login
+    GET /user/userId/:userId
+
+

--
Gitblit v1.8.0