From 75872a149f85e92ace8e82b2aa53e887e3043035 Mon Sep 17 00:00:00 2001 From: Paul-Christian Volkmer Date: Fri, 5 Jan 2024 11:53:51 +0100 Subject: [PATCH] docs: add some more information within README.doc --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a8a4f2e..8839d0e 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,15 @@ Diese Anwendung versendet ein bwHC-MTB-File an das bwHC-Backend und pseudonymisi ### Einordnung innerhalb einer DNPM-ETL-Strecke -Diese Anwendung erlaubt das Entgegennehmen HTTP/REST-Anfragen aus dem Onkostar-Plugin **[onkostar-plugin-dnpmexport](https://github.com/CCC-MF/onkostar-plugin-dnpmexport)**. +Diese Anwendung erlaubt das Entgegennehmen von HTTP/REST-Anfragen aus dem Onkostar-Plugin **[onkostar-plugin-dnpmexport](https://github.com/CCC-MF/onkostar-plugin-dnpmexport)**. Der Inhalt einer Anfrage, wenn ein bwHC-MTBFile, wird pseudonymisiert und auf Duplikate geprüft. Duplikate werden verworfen, Änderungen werden weitergeleitet. Löschanfragen werden immer als Löschanfrage an das bwHC-backend weitergeleitet. +Zudem ist eine minimalistische Weboberfläche integriert, die einen Einblick in den aktuellen Zustand der Anwendung gewährt. + ![Modell DNPM-ETL-Strecke](docs/etl.png) #### HTTP/REST-Konfiguration @@ -168,18 +170,22 @@ automatisch erkannt und verwendet werden. Dadurch ist z.B. eine abweichende Anga #### Beispiel *Traefik* (mit Docker-Labels): +Das folgende Beispiel zeigt die Konfiguration in einer Docker-Compose-Datei mit Service-Labels. + ``` ... deploy: labels: - - "traefik.http.routers.portainer.rule=PathPrefix(`/etl-processor`)" - - "traefik.http.routers.portainer.middlewares=portainer-strip" - - "traefik.http.middlewares.portainer-strip.stripprefix.prefixes=/etl-processor" + - "traefik.http.routers.etl.rule=PathPrefix(`/etl-processor`)" + - "traefik.http.routers.etl.middlewares=etl-path-strip" + - "traefik.http.middlewares.etl-path-strip.stripprefix.prefixes=/etl-processor" ... ``` #### Beispiel *nginx* +Das folgende Beispiel zeigt die Konfiguration einer _location_ in einer nginx-Konfigurationsdatei. + ``` ... location /etl-processor {