Änderungen von Dokument Digitale Mitgliederverwaltung

Zusammenfassung

• Seiteneigenschaften (1 geändert, 0 hinzugefügt, 0 gelöscht)

Details

Seiteneigenschaften

Inhalt

...	...	@@ -484,13 +484,13 @@
484	484
485	485	=== Paperless NGX ===
486	486
487		-Paperless-NGX ist ein freies, quelloffenes Dokumentenmanagementsystem (DMS), das als aktiv gepflegter Community-Fork des eingestellten „paperless-ng“ entstanden ist. Die Software läuft unter Linux, ist in Python und TypeScript geschrieben, unter der GPL-3.0 lizenziert und wird üblicherweise containerisiert mit Docker betrieben. In unserem Fall wird sie vor Ort im Makerspace auf dem vorhandenen Kubernetes-Cluster betrieben.
	487	+(% style="text-decoration: none;color:var(--ds-text,#333333);" %)Paperless-NGX ist ein freies, quelloffenes Dokumentenmanagementsystem (DMS), das als aktiv gepflegter Community-Fork des eingestellten „paperless-ng“ entstanden ist. Die Software läuft unter Linux, ist in Python und TypeScript geschrieben, unter der GPL-3.0 lizenziert und wird üblicherweise containerisiert mit Docker betrieben. In unserem Fall wird sie vor Ort im Makerspace auf dem vorhandenen Kubernetes-Cluster betrieben.
488	488
489		-Sie dient dazu, Papierdokumente und digitale Dateien zentral zu erfassen, automatisch zu verarbeiten, strukturiert zu archivieren und komfortabel wiederzufinden. Die Dokumente können über verschiedene Wege ins System gelangen – etwa durch einen speziellen „consume“-Ordner, per E-Mail-Import oder via Drag-and-drop im Webinterface. Bei der Verarbeitung wird eine leistungsfähige Texterkennung (OCR) auf Basis von Tesseract eingesetzt, die über 100 Sprachen unterstützt und auch gescannte Dokumente durchsuchbar macht. Zusätzlich werden Metadaten wie Tags, Korrespondenten, Dokumenttypen oder benutzerdefinierte Felder erfasst; diese lassen sich automatisiert per Machine-Learning oder durch definierte Workflows zuweisen, die auch externe Aktionen wie E-Mails oder Webhooks auslösen können.
	489	+(% style="text-decoration: none;color:var(--ds-text,#333333);" %) Sie dient dazu, Papierdokumente und digitale Dateien zentral zu erfassen, automatisch zu verarbeiten, strukturiert zu archivieren und komfortabel wiederzufinden. Die Dokumente können über verschiedene Wege ins System gelangen – etwa durch einen speziellen „consume“-Ordner, per E-Mail-Import oder via Drag-and-drop im Webinterface. Bei der Verarbeitung wird eine leistungsfähige Texterkennung (OCR) auf Basis von Tesseract eingesetzt, die über 100 Sprachen unterstützt und auch gescannte Dokumente durchsuchbar macht. Zusätzlich werden Metadaten wie Tags, Korrespondenten, Dokumenttypen oder benutzerdefinierte Felder erfasst; diese lassen sich automatisiert per Machine-Learning oder durch definierte Workflows zuweisen, die auch externe Aktionen wie E-Mails oder Webhooks auslösen können.
490	490
491		-Die Speicherung erfolgt in einem standardisierten PDF/A-Format für die Langzeitarchivierung, wobei stets auch die Originaldateien erhalten bleiben. Metadaten werden in einer Datenbank (PostgreSQL) verwaltet, während die eigentlichen Dateien im Dateisystem (über Kubernetes CSI direkt auf dem NAS) liegen. Über das Webinterface stehen Funktionen wie Volltextsuche mit Auto-Completion, Hervorhebung von Treffern, Filterung und „Ähnliche Dokumente“-Vorschläge zur Verfügung. Mehrbenutzerfähigkeit, fein abgestufte Rechtevergabe und ein anpassbares Dashboard erleichtern die Zusammenarbeit.
	491	+(% style="text-decoration: none;color:var(--ds-text,#333333);" %)Die Speicherung erfolgt in einem standardisierten PDF/A-Format für die Langzeitarchivierung, wobei stets auch die Originaldateien erhalten bleiben. Metadaten werden in einer Datenbank (PostgreSQL) verwaltet, während die eigentlichen Dateien im Dateisystem (über Kubernetes CSI direkt auf dem NAS) liegen. Über das Webinterface stehen Funktionen wie Volltextsuche mit Auto-Completion, Hervorhebung von Treffern, Filterung und „Ähnliche Dokumente“-Vorschläge zur Verfügung. Mehrbenutzerfähigkeit, fein abgestufte Rechtevergabe und ein anpassbares Dashboard erleichtern die Zusammenarbeit.
492	492
493		-=== N8n ===
	493	+=== (% style="text-decoration: none;color:var(--ds-text,#333333);" %)N8n(%%) ===
494	494
495	495	n8n ist ein **Open-Source-Tool zur Workflow-Automatisierung**, das man selbst hosten kann. Über eine **visuelle Oberfläche** baut man Workflows per Drag-and-drop aus sogenannten „Nodes“, die verschiedene Dienste und Aktionen miteinander verbinden. Es gibt Hunderte vorgefertigte Integrationen, z. B. für Slack, Mail oder MQTT. Ebenfalls gibt es eine große Auswahl an für uns relevante Community Nodes (Vikunja, Listmonk, und so weiter) sowie die Möglichkeit, eigene Nodes zu schreiben (beispielsweise Paperless oder NATS).
496	496
...	...	@@ -515,7 +515,7 @@
515	515	Im Wesentlichen teilt sich die Architektur in zwei Zonen, die **öffentliche** und die **interne** Zone:
516	516
517	517	* **Paperless** ist das maßgebliche System, welches ausschließlich **intern** erreichbar ist. Es enthält alle Dokumente und somit sehr viele Mitglieder-Daten. Weiterhin ist es auf ein Teil der Infrastruktur im Makerspace (NAS, Drucker, Scanner) angewiesen, sodass es im Netzwerk des Makerspaces laufen muss. Aus Sicherheitsgründen ist Paperless ausschließlich im lokalen Netzwerk des Makerspaces oder per VPN erreichbar.
518		-* Alle den **Mitgliedern gegenüber sichtbare Systeme (Homepage, Backend, ...) sind öffentlich **und auf einem gemieteten Server beim deutschen Anbieter Hetzner gehostet. [[Details dazu finden sich im Wiki>>doc:xwiki:IN.IT Infrastruktur.Public Server Infrastruktur.WebHome]]. Die meiste bestehende Automatisierung wird aktuell im Backend durchgeführt, ist dort allerdings in Python Logic fest einprogrammiert. Die meiste Logik soll in Zukunft über N8n realisiert werden.
	518	+* Alle den **Mitgliedern gegenüber sichtbare Systeme (Homepage, Backend, ...) sind öffentlich **und auf einem gemieteten Server beim deutschen Anbieter Hetzner gehostet. [[Details dazu finden sich im Wiki>>confluencePage:page:IN.Public Server Infrastruktur]]. Die meiste bestehende Automatisierung wird aktuell im Backend durchgeführt, ist dort allerdings in Python Logic fest einprogrammiert. Die meiste Logik soll in Zukunft über N8n realisiert werden.
519	519
520	520	Für die Kommunikation zwischen beiden Zonen kommt eine **Event Queue** zum Einsatz, wir nutzen hier NATS. NATS wird ebenfalls **auf dem öffentlichen Server installiert. **Der Makerspace selbst ist nur über eine reguläre DSL Leitung an das Internet angebunden, sodass wir hier keine hohe Verfügbarkeit voraussetzen können. Durch die Installation der NATS Services auf dem öffentlichen Server können die dort laufenden Services wie das Backend jederzeit (auch wenn die Internet-Verbindung im Makerspace nicht zur Verfügung steht) die Events veröffentlichen. Die Events werden dann bis zu 7 Tage in der NATS EventQueue persistent gespeichert, und nach Wiederherstellung der Verbindung abgearbeitet.
521	521
...	...	@@ -704,7 +704,7 @@
704	704
705	705	= Paperless NGX =
706	706
707		-Das Herzstück der digitalen Mitgliederakte bildet Paperless NGX. Es wird im Makerspace lokal betrieben und ist daher nur aus dem Netzwerk des Makerspaces oder [[per VPN>>doc:xwiki:IN.IT Infrastruktur.IT im Makerspace.[HOWTO] Makerspace VPN.WebHome]] erreichbar. Der Zugang zu Paperless ist über OpenID Connect an [[doc:xwiki:IN.IT Infrastruktur.Services.Keycloak.WebHome]] gekoppelt, Zugang besteht nur für Mitglieder der Gruppen **Vorstand** und **Mitgliederverwaltung**.
	707	+Das Herzstück der digitalen Mitgliederakte bildet Paperless NGX. Es wird im Makerspace lokal betrieben und ist daher nur aus dem Netzwerk des Makerspaces oder [[per VPN>>confluencePage:page:IN.[HOWTO] Makerspace VPN]] erreichbar. Der Zugang zu Paperless ist über OpenID Connect an [[confluencePage:page:IN.Keycloak]] gekoppelt, Zugang besteht nur für Mitglieder der Gruppen **Vorstand** und **Mitgliederverwaltung**.
708	708
709	709	== Paperless Übersicht ==
710	710
...	...	@@ -812,9 +812,9 @@
812	812
813	813	**Aus diesem Grund wird auf jedes Dokument einen spezieller QR Code aufgedruckt**. Der QR code wird vom Post-Consume Script verwendet um die Metadaten in Paperless zuzuordnen. Weiterhin können Daten übermittelt werden, die dann mittels Webhook an N8n übermittelt werden und dort im Workflow verwendet werden können. Der Aufbau orientiert sich an dem Aufbau eines **JSON Web Tokens (JWT).**
814	814
815		-=== (% style="color:var(--ds-text-accent-purple-bolder,#352c63)" %)Barcode erzeugen(%%) ===
	815	+=== (% style="color:var(--ds-text-accent-purple-bolder,#352c63);" %)Barcode erzeugen(%%) ===
816	816
817		-(% style="color:var(--ds-text-accent-purple-bolder,#352c63)" %)Der Prozess zur Erzeugung eines QR Codes ist wie folgt:
	817	+(% style="color:var(--ds-text-accent-purple-bolder,#352c63);" %)Der Prozess zur Erzeugung eines QR Codes ist wie folgt:
818	818
819	819	* **Payload (Daten) festlegen**. Einige Werte sind verpflichtend, andere können nach Bedarf optional hinzugefügt werden.
820	820	* JWT erzeugen und signieren. der JWT besteht aus drei Teilen:
...	...	@@ -829,7 +829,7 @@
829	829
830	830	=== Body ===
831	831
832		-Die folgenden Claims sind im Body verfügbar.
	832	+Die folgenden Claims sind im Body verfügbar:
833	833
834	834	|=(((
835	835	Claim
...	...	@@ -879,7 +879,6 @@
879	879	)))|(((
880	880	Typ des Dokuments basierend auf der unten definierten Liste.
881	881	)))
882		-|mode|String|✅️ |Kann entweder "online" oder "onsite" sein und bestimmt, ob N8n den unterschriebenen Vertrag ans Backend meldet.
883	883	|(((
884	884	(% class="code" %)
885	885	(((
...	...	@@ -934,25 +934,25 @@
934	934
935	935	Die Implementierung für die Erzeugung und das Validieren erfolgt in Python. Dies hat den Hintergrund, dass sowohl unser Backend als auch Paperless NGX (und damit das Post-Consumption Script) in Python implementiert ist. Es gibt verschiedene Libraries, die betrachtet wurden:
936	936
937		-|=(((
	936	+|=(% scope="col" %)(((
938	938	Name
939		-)))|=(((
	938	+)))|=(% scope="col" %)(((
940	940	CVE
941		-)))|=(((
	940	+)))|=(% scope="col" %)(((
942	942	Github
943		-)))|=(((
	942	+)))|=(% scope="col" %)(((
944	944	GH⭐
945		-)))|=(((
	944	+)))|=(% scope="col" %)(((
946	946	Letztes Release
947		-)))|=(((
	946	+)))|=(% scope="col" %)(((
948	948	Offene Issues
949		-)))|=(((
	948	+)))|=(% scope="col" %)(((
950	950	Dokumentation
951		-)))|=(((
	950	+)))|=(% scope="col" %)(((
952	952	Qualität Dokumentation
953		-)))|=(((
	952	+)))|=(% scope="col" %)(((
954	954	In Backend vorhanden?
955		-)))|=(((
	954	+)))|=(% scope="col" %)(((
956	956	In Paperless vorhanden?
957	957	)))
958	958	|(((
...	...	@@ -1025,11 +1025,11 @@
1025	1025
1026	1026	=== PDF417 Code ===
1027	1027
1028		-Als Format für den Code wurde PDF417 ausgewählt, da dieser mehr Platz und Fehlerkorrektur bietet. Weiterhin gibt es eine einfach zu nutzende Library für Python (Erzeugung) und PDF417 wird von (% style="color:var(--ds-text-accent-purple-bolder,#352c63); text-decoration:none" %)ZXING unterstützt, welches in Paperless eingebettet ist. Ein solcher Barcode sieht beispielsweise so aus:
	1027	+Als Format für den Code wurde PDF417 ausgewählt, da dieser mehr Platz und Fehlerkorrektur bietet. Weiterhin gibt es eine einfach zu nutzende Library für Python (Erzeugung) und PDF417 wird von (% style="text-decoration: none;color:var(--ds-text-accent-purple-bolder,#352c63);" %)ZXING unterstützt, welches in Paperless eingebettet ist. Ein solcher Barcode sieht beispielsweise so aus:
1029	1029
1030		-(% style="color:var(--ds-text-accent-purple-bolder,#352c63); text-decoration:none" %)[[image:attach:barcode.jpg||height="250"]]
	1029	+(% style="text-decoration: none;color:var(--ds-text-accent-purple-bolder,#352c63);" %)[[image:attach:barcode.jpg||height="250"]]
1031	1031
1032		-(% style="color:var(--ds-text-accent-purple-bolder,#352c63); text-decoration:none" %)Daraus kann dann eine Base64 basierte Repräsentation berechnet werden, die einfach in Docuseal hochgeladen werden kann.
	1031	+(% style="text-decoration: none;color:var(--ds-text-accent-purple-bolder,#352c63);" %)Daraus kann dann eine Base64 basierte Repräsentation berechnet werden, die einfach in Docuseal hochgeladen werden kann.
1033	1033
1034	1034	=== Referenz-Implementierung ===
1035	1035