From ff2fd77c5df9847d38f6f0adb2ceda7aded47f64 Mon Sep 17 00:00:00 2001 From: Philipp Horstenkamp Date: Tue, 2 Jan 2024 16:24:24 +0100 Subject: [PATCH 1/2] Added a section about the Webserver and its Settings --- .../PhHo/04-data-visualisation-container.md | 26 +++++++++++++++++++ documentations/index.rst | 1 + 2 files changed, 27 insertions(+) create mode 100644 documentations/Ergebnisse/Abschlussbericht_und_Praesentation/PhHo/04-data-visualisation-container.md diff --git a/documentations/Ergebnisse/Abschlussbericht_und_Praesentation/PhHo/04-data-visualisation-container.md b/documentations/Ergebnisse/Abschlussbericht_und_Praesentation/PhHo/04-data-visualisation-container.md new file mode 100644 index 0000000..37a370b --- /dev/null +++ b/documentations/Ergebnisse/Abschlussbericht_und_Praesentation/PhHo/04-data-visualisation-container.md @@ -0,0 +1,26 @@ +### Web-server (Philipp Horstenkamp) + +Der Webserver benötigt das Extra `web-server` um alle Abhängigkeiten sauber zu installieren. +Unser Webserver ist ein [`Dash`](https://dash.plotly.com/) Webserver welcher auf [`Flask`](https://dash.plotly.com/) aufbaut und nicht über `Gunicorn` gestartet wird. +Zusätzlich wurden die Pakete `dash-bootstrap-components` und `dash-daq` für mehr Virtualisierungskomponenten verwendet. +`dash-auth`-ermöglicht die Nutzung von Basic Auth. +Zudem wurde `flask-compress` genutzt um große Antworten als gzip an den Browser zu Schicken und so Traffic zu reduzieren. +Um Antwortzeiten zu reduzieren wurden Antworten und Zwischenergebnisse mit `cachetools`-Decorator gecacht. + +#### Einstallungen + +Nachfolgend eine Tabelle der möglichen Einstellungen über Umgebungsvariablen. +Natürlich kann auch hier eine wie in der [README.md](../../../../README.md) gezeigt eine `*.json` verwendet werden, um die Datenbankverbindung zu definieren. + +| Wert | Default | Compose-Defaults | Erklärung | +|:--------------------------:|:-------:|:---------------------:|---------------------------------------------------------------------------------------| +| HTTP_PORT | 80 | *Fehler* | Der Port auf dem die Applikation gestartet werden soll. | +| DASH_URL_BASE_PATHNAME | / | /transparenzregister/ | Der Basispfad auf dem HTTP-Requests empfangen werden. | +| PYTHON_DASH_LOGIN_USERNAME | | | Ein HTTP-Basic-Auth Username, kein login wenn leer. | +| PYTHON_DASH_LOGIN_PW | | | Ein HTTP-Basic-Auth Password, kein login wenn leer. | +| PYTHON_POSTGRES_USERNAME | | postgres | Ein Nutzername für Zugriff auf die Production DB (Postgres) | +| PYTHON_POSTGRES_PASSWORD | | *Fehler* | Ein Passwort für Zugriff auf die Production DB (Postgres) | +| PYTHON_POSTGRES_HOST | | postgres | Der Host auf dem die Production DB (Postgres) erreichbar ist. | +| PYTHON_POSTGRES_DATABASE | | db | Der Name der Production DB (Postgres). | +| PYTHON_POSTGRES_PORT | | 5432 | Der Port auf dem auf die Prodction DB (Postgres) Zugegriffen werden kann. | +| PYTHON_SQLITE_PATH | | | Ein Pfad um auf eine SQLLite Datenbank zuzugreifen. Überschreibt den Postgres Zugang. | diff --git a/documentations/index.rst b/documentations/index.rst index 6046456..a33e024 100644 --- a/documentations/index.rst +++ b/documentations/index.rst @@ -32,6 +32,7 @@ Diese sind, um Industriestandards zu entsprechen, auf Englisch gehalten. Ergebnisse/Abschlussbericht_und_Praesentation/TrNo/S4-2.md Ergebnisse/Abschlussbericht_und_Praesentation/TrNo/S4-3-1.md Ergebnisse/Abschlussbericht_und_Praesentation/PhHo/4-4-2-database-generator + Ergebnisse/Abschlussbericht_und_Praesentation/PhHo/04-data-visualisation-container.md .. toctree:: From bf75e320da8c71afa1e18798a0a3f60356929e31 Mon Sep 17 00:00:00 2001 From: Philipp Horstenkamp Date: Thu, 4 Jan 2024 19:03:14 +0100 Subject: [PATCH 2/2] Update documentations/Ergebnisse/Abschlussbericht_und_Praesentation/PhHo/04-data-visualisation-container.md --- .../PhHo/04-data-visualisation-container.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentations/Ergebnisse/Abschlussbericht_und_Praesentation/PhHo/04-data-visualisation-container.md b/documentations/Ergebnisse/Abschlussbericht_und_Praesentation/PhHo/04-data-visualisation-container.md index 37a370b..bc1fcf8 100644 --- a/documentations/Ergebnisse/Abschlussbericht_und_Praesentation/PhHo/04-data-visualisation-container.md +++ b/documentations/Ergebnisse/Abschlussbericht_und_Praesentation/PhHo/04-data-visualisation-container.md @@ -16,8 +16,8 @@ Natürlich kann auch hier eine wie in der [README.md](../../../../README.md) gez |:--------------------------:|:-------:|:---------------------:|---------------------------------------------------------------------------------------| | HTTP_PORT | 80 | *Fehler* | Der Port auf dem die Applikation gestartet werden soll. | | DASH_URL_BASE_PATHNAME | / | /transparenzregister/ | Der Basispfad auf dem HTTP-Requests empfangen werden. | -| PYTHON_DASH_LOGIN_USERNAME | | | Ein HTTP-Basic-Auth Username, kein login wenn leer. | -| PYTHON_DASH_LOGIN_PW | | | Ein HTTP-Basic-Auth Password, kein login wenn leer. | +| PYTHON_DASH_LOGIN_USERNAME | | | Ein HTTP-Basic-Auth Username, kein Passwortschutz wenn leer. | +| PYTHON_DASH_LOGIN_PW | | | Ein HTTP-Basic-Auth Password, kein Passwortschutz wenn leer. | | PYTHON_POSTGRES_USERNAME | | postgres | Ein Nutzername für Zugriff auf die Production DB (Postgres) | | PYTHON_POSTGRES_PASSWORD | | *Fehler* | Ein Passwort für Zugriff auf die Production DB (Postgres) | | PYTHON_POSTGRES_HOST | | postgres | Der Host auf dem die Production DB (Postgres) erreichbar ist. |