Änderungen von Dokument Digitale Mitgliederverwaltung

Zuletzt geändert von Daniel Herrmann am 2026/02/22 21:17

Verwalten
- Kopieren
Aktionen
- Exportieren
- Druckvorschau
Ansichten

Von 46.1 nach 47.1 Von 51.1 nach 52.1

Von Version

47.1

bearbeitet von Daniel Herrmann
am 2025/08/31 18:23

Änderungskommentar: Es gibt keinen Kommentar für diese Version

Auf Version

51.1

bearbeitet von Daniel Herrmann
am 2025/10/19 18:49

Änderungskommentar: Es gibt keinen Kommentar für diese Version

Rohform
Im Layout

Zusammenfassung

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

Details

Seiteneigenschaften

Inhalt

@@ -7,11 +7,11 @@
  zu diesem Zweck schaffen wir eine Platform basierend auf mehreren Open Source Software Produkten sowie einigen Hardware Produkten (NAS Speicher, Dokumentenscanner, PC Arbeitsplatz für die Mitgliederverwaltung).
--= {{id name="DigitaleMitgliederverwaltung-Inhaltsverzeichnis"/}}Inhaltsverzeichnis =
++= Inhaltsverzeichnis =
  {{toc/}}
--= {{id name="DigitaleMitgliederverwaltung-Hintergrundinformationen"/}}Hintergrundinformationen =
++= Hintergrundinformationen =
  Viele der Dokumente müssen von einer oder mehreren Partien unterschrieben werden. Wir unterscheiden dabei Dokumente mit geringem und hohem "Streitwert". Unsere Definition zielt hierbei auf eine Einschätzung ab, welcher Schaden dem Verein potentiell entstehen könnte und ob wir im Zweifel eine ordnungsgemäße Unterschrift vor Gericht beweisen können müssen. Beispielsweise hat der Lagervertrag (mögliche Schäden im 2-3 stelligen Eurobereich) einen anderen Stellenwert als beispielsweise ein Einweisungszettel (potentiell Personenschäden, dies kann in Millionen gehen).
@@ -67,9 +67,9 @@
  Für uns im Makerspace bedeutet das, dass wir die EES und FES (über DocuSeal) einsetzen können. Wir haben keine Partnerschaft mit einem Anbieter, der die QES und damit die Schriftformerfordernis abdecken würde, sodass wir alle Dokumente, für die die Schriftform erforderlich ist, weiterhin handschriftlich unterschreiben lassen.
  {{/confluence_tip}}
--= {{id name="DigitaleMitgliederverwaltung-DokumenteundWorkflow"/}}Dokumente und Workflow =
++= Dokumente und Workflow =
--== {{id name="DigitaleMitgliederverwaltung-Dokumenten-Arten"/}}Dokumenten-Arten ==
++== Dokumenten-Arten ==
  Am Dienstag, den 12.08.2025 fand hierzu ein Workshop statt, bei dem Vertreter des IT Teams, der Mitgliederverwaltung sowie des Vorstands teilgenommen haben. Dabei wurden die Ziele erläutert und definiert, ebenfalls haben eine Übersicht der bestehenden Dokumenten-Typen erstellt, mit denen wir im Verein heute hantieren. Für jedes Dokument wurde dann evaluiert, ob es in Zukunft komplett digitalisiert werden kann oder ob beispielsweise aus Haftungsgründen die Schriftform und damit eine handschriftliche Unterschrift weiterhin notwendig ist. Die folgende Tabelle gibt einen Überblick:
@@ -286,19 +286,19 @@
  **Vollständig digital**, die Papierform entfällt. Self-Service durch Nutzer:in.
  )))
--== {{id name="DigitaleMitgliederverwaltung-WorkflowBeschreibung"/}}Workflow Beschreibung ==
++== Workflow Beschreibung ==
  Grundsätzlich teilt sich der Umgang mit Dokumenten in folgende Phasen auf:
  {{confluence_drawio border="true" diagramName="Prozess Allgemein" simpleViewer="false" links="auto" tbstyle="top" lbox="true" diagramWidth="991" height="221" revision="2"/}}
--=== {{id name="DigitaleMitgliederverwaltung-Trigger/StartendesWorkflows"/}}Trigger / Starten des Workflows ===
++=== Trigger / Starten des Workflows ===
  Eine neues Dokument kann auf unterschiedliche Arten erstellt werden. Im Allgemeinen ist es unser Ziel, alle Dokumente vorausgefüllt zur Verfügung zu stellen. Vorausgefüllt bedeutet hierbei, dass mindestens ein QR Code vorhanden ist, der später eine automatische Verarbeitung in Paperless möglich macht. Dabei ist es unerheblich, ob das Dokument komplett digital verarbeitet wird oder zwischenzeitlich auf Grund der Schriftformerfordernis ausgedruckt werden muss.
  In seltenen Fällen (Haftungsauschluss oder der Nutzungsvereinbarung für Schulungsinhalte) ist eine Personalisierung nicht möglich. In diesem Fall wird der Vorgang mit dem Einscannen des Dokuments begonnen und muss von der Mitgliederverwaltung manuell verarbeitet werden.
--==== {{id name="DigitaleMitgliederverwaltung-StartüberdieHomepage"/}}Start über die Homepage ====
++==== Start über die Homepage ====
  Ein Prozess kann über die Homepage eingeleitet werden, entweder durch
@@ -306,13 +306,13 @@
  * **remote, explizit durch den Use**r für sich selbst (Self-Service, beispielsweise der Lager-Vertrag)
  * **remote, explizit durch einen Funktionär** für einen andere User (Datenschutzvereinbarung, Übungsleitervertrag, ...)
--==== {{id name="DigitaleMitgliederverwaltung-LokalimMakerspace"/}}Lokal im Makerspace ====
++==== Lokal im Makerspace ====
  Alternativ kann der Prozess lokal im Makerspace angestoßen werden, beispielsweise wenn die lokale Präsenz des Mitglieds notwendig ist (Schlüsselausgabe) oder nach einer Vor-Ort Einweisung. In diesem Fall wird der Prozess beispielsweise ein Tablet im Space verwendet.
  * **lokal, explizit durch einen Funktionär** (Einweisungsleiter:in, Mitgliederverwaltung, Vorstand), beispielsweise Einweisungszettel oder Schlüsselausgabeformular
--=== {{id name="DigitaleMitgliederverwaltung-Dokumenterstellen"/}}Dokument erstellen ===
++=== Dokument erstellen ===
  Im zweiten Schritt wird nun ein oder mehrere personalisierte Dokumente erstellt. Hier gibt es eine Entscheidungsmatrix:
@@ -368,7 +368,7 @@
  Das genannte Feature "One-Off" Submission ist ein DocuSeal Pro Feature, welches uns nicht zur Verfügung steht. Eventuell müssen wir
  {{/error}}
--=== {{id name="DigitaleMitgliederverwaltung-Unterschriftleisten"/}}Unterschrift leisten ===
++=== Unterschrift leisten ===
  Im dritten Schritt müssen eine oder mehrere Parteien das Dokument unterschreiben. Wie viele Parteien ist abhängig vom Dokument. So muss beispielsweise der Mitgliedsantrag nur vom werdenden Mitglied unterschrieben werden, während das Schlüsselausgabeformular vom ausgebenen Funktionär und dem Mitglied unterschrieben werden muss. Analog zur Erstellung des Dokuments wird hier unterschieden, ob das Dokument zuhause unterschrieben werden kann oder ob es vor Ort im Makerspace passiert.
@@ -423,7 +423,7 @@
  \\
  )))
--=== {{id name="DigitaleMitgliederverwaltung-AblegenundVerarbeiten"/}}Ablegen und Verarbeiten ===
++=== Ablegen und Verarbeiten ===
  Egal welcher Prozess angewandt wird, das Dokument muss am Ende in Paperless eingelesen und mit den Metadaten (siehe unten) versehen werden. Hier gibt es drei verschiedene Varianten:
@@ -466,9 +466,9 @@
  In allen Fällen sollte das Dokument einen QR Code enthalten, der die automatische Zuordnung von Metadaten ermöglicht. Weiterhin wird vom Post-Consumption Script ein NATS Event für jedes erfolgreich erkannte Dokument erstellt, welches dann vom N8n verarbeitet werden kann. Darüber lassen sich beispielsweise Einweisungszettel im Backend erfassen.
--= {{id name="DigitaleMitgliederverwaltung-TechnischesDesign"/}}Technisches Design =
++= Technisches Design =
--== {{id name="DigitaleMitgliederverwaltung-VorhandeneKomponenten"/}}Vorhandene Komponenten ==
++== Vorhandene Komponenten ==
  Der Verein hat in den letzten Jahren bereits einige Systeme aufgebaut, die uns den Alltag erleichtern und eine gewisse Automatisierung ermöglichen. Dazu gehören:
@@ -480,17 +480,17 @@
  * [[DocuSeal>>url:http://docuseal.com||shape="rect"]] - Eine Open Source Lösung für das Signieren von Dokumenten. Wir betreiben unsere eigene Instanz unter [[https:~~/~~/sign.makerspace-darmstadt.de>>url:https://sign.makerspace-darmstadt.de||shape="rect"]]. DocuSeal ist für die Lagerverträge in die Homepage integriert - ein Mitglied kann die Unterschrift dort anfragen und erhält dann per Mail (=Authentifizierung) eine Einladung, den Vertrag zu unterschreiben. Der Vertrag wird anschließend kryptographisch gegen Veränderungen geschützt und per Mail an das Mitglied und die Mitgliederverwaltung geschickt.
  * [[Vikunja>>url:https://vikunja.io||shape="rect"]] - Ein Open Source System für die Todo-Verwaltung und einfaches Projekt-Tracking. Wir nutzen es stand heute ohne jegliche Integration für die Aufgabenverwaltung im Vorstand, in der Vereins-IT sowie in einigen Bereichen.
--== {{id name="DigitaleMitgliederverwaltung-NeueKomponenten"/}}Neue Komponenten ==
++== Neue Komponenten ==
--=== {{id name="DigitaleMitgliederverwaltung-PaperlessNGX"/}}Paperless NGX ===
++=== Paperless NGX ===
--(% 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.
++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.
--(% 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.
++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.
--(% 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.
++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.
--=== {{id name="DigitaleMitgliederverwaltung-N8n"/}}(% style="text-decoration: none;color:var(--ds-text,#333333);" %)N8n(%%) ===
++=== N8n ===
  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).
@@ -498,10 +498,8 @@
  In unserem Fall wird N8n auf der Infrastruktur im Makerspace betrieben damit, der Zugriff auch auf interne Systeme wie Paperless oder die MQTT Umgebung möglich ist. Das Setup und die Konfiguration von N8n ist auf einer eigenen Wiki-Seite beschrieben.
--\\
++=== NATS ===
--=== {{id name="DigitaleMitgliederverwaltung-NATS"/}}NATS ===
--
  Für den Transport von Events zwischen der Homepage (insbesondere dem Backend) und N8n wird **NATS** vorgeschlagen. **NATS** ist ein leichtgewichtiges, schnelles **Messaging-System** für Event-Streaming und -Queues, das auf dem **Publish/Subscribe-Prinzip** basiert. Es eignet sich besonders für verteilte Systeme, bei denen verschiedene Dienste über Events miteinander kommunizieren.
  Das Backend sendet Ereignisse (als JSON) an einen NATS-Subject (ähnlich einem MQTT Topic). NATS nimmt diese Events sofort entgegen und hält sie je nach Konfiguration im Speicher oder in einer persistierten Stream-Queue (JetStream). n8n kann dann über einen **NATS-Trigger**-Node diese Events abonnieren. Sobald ein Event eintrifft, startet n8n den zugehörigen Workflow automatisch und verarbeitet die enthaltenen Daten.
@@ -508,7 +508,7 @@
  NATS entkoppelt Backend und Automatisierungslogik, sorgt für sehr geringe Latenz, zuverlässige Zustellung und ermöglicht horizontale Skalierung, ohne dass FastAPI oder n8n direkt voneinander abhängig sind.
--== {{id name="DigitaleMitgliederverwaltung-Systemübersicht"/}}Systemübersicht ==
++== Systemübersicht ==
  Das folgende Kapitel gibt eine Übersicht über die vorgeschlagene Systemarchitektur basierend auf den oben vorgestellten Komponenten. Zusätzlich werden für die oben analysierten Dokumente und Workflows die technischen Ablaufdiagramme dargestellt.
@@ -517,13 +517,13 @@
  Im Wesentlichen teilt sich die Architektur in zwei Zonen, die **öffentliche** und die **interne** Zone:
  * **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.
--* 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.
++* 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.
  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.
  **In N8n** werden dann für die **verschiedenen Events Workflows** definiert. Jeder Workflow beginnt mit einem Trigger (genauer: ein NATS JetStream Trigger), der bei auf definierbare Events in der NATS Queue lauscht. Wird ein solches Event gefunden wird es konsumiert und die im Workflow definierten Aktionen werden abgearbeitet. Weiterhin kann auch **Paperless Events in N8n triggern**, dies passiert allerdings direkt über **Webhooks**. Hier nutzen wir NATS nicht, da der NATS Server in der öffentlichen Zone läuft und dann erneut eine Abhängigkeit zur Internet-Anbindung bestehen würde.
--== {{id name="DigitaleMitgliederverwaltung-Dokument-Workflows"/}}Dokument-Workflows ==
++== Dokument-Workflows ==
  Die beiden entscheidenden Faktoren für den Workflow:
@@ -573,7 +573,7 @@
  Lokal
  )))
--=== {{id name="DigitaleMitgliederverwaltung-Fall1:Digital+Remote"/}}Fall 1: Digital + Remote ===
++=== Fall 1: Digital + Remote ===
  Alle diese Fälle haben gemein, dass der Prozess **remote ausgelöst und abgeschlossen** wird. In diesem Fall wird nie ein ausgedrucktes Dokument erzeugt, das Dokument wird **ausschließlich digital** verwaltet.
@@ -600,7 +600,7 @@
 . Bei Bedarf (Konfiguration im QR Code) wird ein N8n Webhook ausgelöst
 . (Optional): Wurde im vorherigen Schritt über den Webhook ein N8n Workflow ausgelöst, kann dieser nun weitere Schritte unternehmen (beispielsweise Vikunja Tasks erzeugen, Mails verschicken, oder ähnlich)
--=== {{id name="DigitaleMitgliederverwaltung-Fall2:Digital+Makerspace"/}}Fall 2: Digital + Makerspace ===
++=== Fall 2: Digital + Makerspace ===
  In diesem Fall kann die Unterschrift digital erfolgen, allerdings findet die Unterschrift im Makerspace statt. Beispiel hier ist die Ausgabe eines Schlüssels und das Schlüsselausgabeformular.
@@ -654,7 +654,7 @@
 . Bei Bedarf (Konfiguration im QR Code) wird ein N8n Webhook ausgelöst
 . (Optional): Wurde im vorherigen Schritt über den Webhook ein N8n Workflow ausgelöst, kann dieser nun weitere Schritte unternehmen (beispielsweise Vikunja Tasks erzeugen, Mails verschicken, oder ähnlich)
--=== {{id name="DigitaleMitgliederverwaltung-Fall3:Handschriftlich+Remote"/}}Fall 3: Handschriftlich + Remote ===
++=== Fall 3: Handschriftlich + Remote ===
  In diesem Fall wird der Prozess durch einen Benutzer **remote ausgelöst, benötigt allerdings die Schriftform.** In diesem Fall wird dem Benutzer ein vorausgefülltes und mit QR Code versehenes Dokument zum Download angeboten, welches dann heruntergeladen, ausgedruckt, unterschrieben und eingereicht werden muss.
@@ -680,7 +680,7 @@
 . Als Teil des N8n Workflows informiert N8n das Backend darüber, dass das Dokument eingescannt und verarbeitet wurde. Der Vorgang wird entsprechend in der Datenbank als erledigt markiert.
 . (Optional): Wurde im vorherigen Schritt über den Webhook ein N8n Workflow ausgelöst, kann dieser nun weitere Schritte unternehmen (beispielsweise Vikunja Tasks erzeugen, Mails verschicken, oder ähnlich)
--=== {{id name="DigitaleMitgliederverwaltung-Fall4:Handschriftlich+Makerspace"/}}Fall 4: Handschriftlich + Makerspace ===
++=== Fall 4: Handschriftlich + Makerspace ===
  In diesem Fall wird der Prozess durch einen Benutzer **im Makerspace ausgelöst und benötigt Schriftform.** In diesem Fall wird das Dokument im Makerspace erzeugt (soweit wie möglich vorausgefüllt und mit QR Code versehen) und direkt vor Ort ausgedruckt. Dort wird es dann unterschrieben und eingeworfen.
@@ -704,11 +704,11 @@
 . Als Teil des N8n Workflows informiert N8n das Backend darüber, dass das Dokument eingescannt und verarbeitet wurde. Der Vorgang wird entsprechend in der Datenbank als erledigt markiert.
 . (Optional): Wurde im vorherigen Schritt über den Webhook ein N8n Workflow ausgelöst, kann dieser nun weitere Schritte unternehmen (beispielsweise Vikunja Tasks erzeugen, Mails verschicken, oder ähnlich)
--= {{id name="DigitaleMitgliederverwaltung-PaperlessNGX"/}}Paperless NGX =
++= Paperless NGX =
--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**.
++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**.
--== {{id name="DigitaleMitgliederverwaltung-PaperlessÜbersicht"/}}Paperless Übersicht ==
++== Paperless Übersicht ==
  **Dokumente** sind die primären Ressourcen in Paperless. Ein Dokument kann über mehrere Wege in Paperless aufgenommen werden (der Prozess wird **Ingestion** genannt):
@@ -727,7 +727,7 @@
  * **SCAN Vorstand** - Platziert das Dokument in dem Consumption Ordner für den Vorstand, Rechte und Tags werden dann automatisch gesetzt
  * **SCAN MV** - Platziert das Dokument in dem Consumption Ordner für die Mitgliederverwaltung, Rechte und Tags werden dann automatisch gesetzt
--== {{id name="DigitaleMitgliederverwaltung-ÜbersichtderMetadaten"/}}Übersicht der Metadaten ==
++== Übersicht der Metadaten ==
  Dokumente werden dann Meta-Daten zugeordnet, die eine spätere Suche und Zuordnung erleichtern. Diese Meta-Daten sind:
@@ -808,15 +808,15 @@
  )))
  )))
--== {{id name="DigitaleMitgliederverwaltung-AutomatischeZuordnungvonMetadaten"/}}Automatische Zuordnung von Metadaten ==
++== Automatische Zuordnung von Metadaten ==
  Paperless unterstützt die automatische Zuordnung von Metadaten basierend auf festen Strings. So kann man beispielsweise angeben, dass ein Dokumententyp "Haftungsausschluss" zugewiesen werden soll, wenn der String "Haftungsausschluss" irgendwo im Dokument vorkommt. Dies ist allerdings auf eine korrekte Funktion der Texterkennung angewiesen und funktioniert erfahrungsgemäß nur in manchen Fällen, sodass mindestens eine manuelle Überprüfung trotzdem notwendig kommt. Wenn beispielsweise ein Brief mit dem Satz "ich dachte, ich hätte den Haftungsausschluss bereits abgegeben, könntet ihr dies bitte prüfen" erfasst wird, würde der basierend auf der Regel ebenfalls kategorisiert werden.
  **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).**
--=== {{id name="DigitaleMitgliederverwaltung-Barcodeerzeugen"/}}(% style="color:var(--ds-text-accent-purple-bolder,#352c63);" %)Barcode erzeugen(%%) ===
++=== (% style="color:var(--ds-text-accent-purple-bolder,#352c63)" %)Barcode erzeugen(%%) ===
--(% style="color:var(--ds-text-accent-purple-bolder,#352c63);" %)Der Prozess zur Erzeugung eines QR Codes ist wie folgt:
++(% style="color:var(--ds-text-accent-purple-bolder,#352c63)" %)Der Prozess zur Erzeugung eines QR Codes ist wie folgt:
  * **Payload (Daten) festlegen**. Einige Werte sind verpflichtend, andere können nach Bedarf optional hinzugefügt werden.
  * JWT erzeugen und signieren. der JWT besteht aus drei Teilen:
@@ -825,13 +825,13 @@
  ** **Signature**: Mit Hilfe eines Secrets und wird die Signatur erzeugt und automatisch angehängt.
  * PDF417 code erzeugen: ein JWT ist per Definition URL safe und kann daher einfach in ein QR code umgewandelt werden.
--=== {{id name="DigitaleMitgliederverwaltung-Header"/}}Header ===
++=== Header ===
  Der Header enthält wichtige Meta-Daten, diese werden von der JWT Library automatisch erzeugt und beschreiben in der Regel den verwendeten Key-Typ.
--=== {{id name="DigitaleMitgliederverwaltung-Body"/}}Body ===
++=== Body ===
--Die folgenden Claims sind im Body verfügbar:
++Die folgenden Claims sind im Body verfügbar.
  |=(((
  Claim
@@ -931,29 +931,29 @@
  Für diesen Anwendungsfall nutzen wir (% style="text-decoration: none;color:var(--ds-text,#333333);" %)**HS256** (HMAC mit SHA-256 Algorithmus).
  {{/confluence_tip}}
--=== {{id name="DigitaleMitgliederverwaltung-AuswahlderLibrary"/}}Auswahl der Library ===
++=== Auswahl der Library ===
  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:
--|=(% scope="col" %)(((
++|=(((
  Name
--)))|=(% scope="col" %)(((
++)))|=(((
  CVE
--)))|=(% scope="col" %)(((
++)))|=(((
  Github
--)))|=(% scope="col" %)(((
++)))|=(((
  GH⭐
--)))|=(% scope="col" %)(((
++)))|=(((
  Letztes Release
--)))|=(% scope="col" %)(((
++)))|=(((
  Offene Issues
--)))|=(% scope="col" %)(((
++)))|=(((
  Dokumentation
--)))|=(% scope="col" %)(((
++)))|=(((
  Qualität Dokumentation
--)))|=(% scope="col" %)(((
++)))|=(((
  In Backend vorhanden?
--)))|=(% scope="col" %)(((
++)))|=(((
  In Paperless vorhanden?
  )))
  |(((
@@ -1024,27 +1024,27 @@
  Unsere bevorzugte Library ist **pyjwt**. Diese ist auch in **paperless nativ vorhanden**, sodass wir uns für die Implementierung mittels **pyjwt** entschieden haben.
--=== {{id name="DigitaleMitgliederverwaltung-PDF417Code"/}}PDF417 Code ===
++=== PDF417 Code ===
--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:
++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:
--(% style="text-decoration: none;color:var(--ds-text-accent-purple-bolder,#352c63);" %)[[image:attach:barcode.jpg||height="250"]]
++(% style="color:var(--ds-text-accent-purple-bolder,#352c63); text-decoration:none" %)[[image:attach:barcode.jpg||height="250"]]
--(% 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.
++(% 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.
--=== {{id name="DigitaleMitgliederverwaltung-Referenz-Implementierung"/}}Referenz-Implementierung ===
++=== Referenz-Implementierung ===
  Eine Referenz-Implementierung befindet sich im Makerspace Gitlab: [[https:~~/~~/git.makerspace-darmstadt.de/makerspace-it-infrastructure/mitgliederverwaltung/paperless-pdf417-reference>>url:https://git.makerspace-darmstadt.de/makerspace-it-infrastructure/mitgliederverwaltung/paperless-pdf417-reference||shape="rect"]]
--=== {{id name="DigitaleMitgliederverwaltung-PostConsumptionScript"/}}Post Consumption Script ===
++=== Post Consumption Script ===
  Die eigentliche Zuordnung der Meta-Daten erfolgt über ein so genanntes Post Consumption Script. Dieses befindet sich ebenfalls im Makerspace Gitlab: [[https:~~/~~/git.makerspace-darmstadt.de/makerspace-it-infrastructure/mitgliederverwaltung/paperless-post-consumption-script#>>url:https://git.makerspace-darmstadt.de/makerspace-it-infrastructure/mitgliederverwaltung/paperless-post-consumption-script||shape="rect"]]
--== {{id name="DigitaleMitgliederverwaltung-PaperlessBerechtigungen"/}}Paperless Berechtigungen ==
++== Paperless Berechtigungen ==
  Paperless NGX hat ein Berechtigungssystem, welches sich über fast alle Ressourcen erstreckt. Grundsätzlich gibt es **Benutzer** und **Gruppen**. Berechtigungen können dann global vergeben werden (Sichtbarkeit von Features) und zusätzlich auf Objektebene vergeben werden.
--=== {{id name="DigitaleMitgliederverwaltung-BenutzerundGruppen"/}}Benutzer und Gruppen ===
++=== Benutzer und Gruppen ===
  Paperless NGX ist so konfiguriert, dass sich Benutzer mit ihrem zentralen Makerspace Login anmelden können (OIDC über Keycloak). Eine Anmeldung mit lokalen Zugangsdaten ist nicht möglich. Bei der Anmeldung werden ebenfalls die Gruppen aus Keycloak übernommen, aber nur die folgenden:
@@ -1054,7 +1054,7 @@
  Nutzer, die keine dieser Gruppen angehören haben keine Rechte in Paperless. Sie können sich zwar anmelden, aber selbst die Willkommens-Seite erzeugt eine "Permission Denied" Fehlermeldung.
--=== {{id name="DigitaleMitgliederverwaltung-GlobaleBerechtigungen"/}}Globale Berechtigungen ===
++=== Globale Berechtigungen ===
  Berechtigungen werden grundsätzlich nicht auf Benutzerebene konfiguriert, sondern ausschließlich auf Gruppenebene. So wird sichergestellt, dass bei der Änderung einer Gruppenzugehörigkeit auch die damit verbundenen Rechte entzogen oder gewährt werden, ohne dass eine manuelle Änderung notwendig ist. Die folgende Tabelle gibt eine Übersicht der konfigurierten globalen Berechtigungen pro Gruppe:
@@ -1306,7 +1306,7 @@
  \\
  )))
--=== {{id name="DigitaleMitgliederverwaltung-Objekt-Berechtigungen"/}}Objekt-Berechtigungen ===
++=== Objekt-Berechtigungen ===
  Zusätzlich zu den globalen Berechtigungen können für alle Objekte noch Berechtigungen auf Objekt-Level konfiguriert werden. Dabei werden globale Regeln zuerst geprüft, danach zusätzlich die Objekt-Berechtigungen. Jedes Objekt (egal ob Dokument, Korrespondent, Tag, Dokumenten-Typ) hat zwei wichtige Einstellungen:
@@ -1371,7 +1371,7 @@
  Mit anderen Worten, um eine Aktion auszuführen, muss ein Benutzer (a) die globale Berechtigung haben **UND** (b) Owner sein **ODER** Objekt-Berechtigungen haben.
  {{/info}}
--=== {{id name="DigitaleMitgliederverwaltung-LokaleOwner"/}}Lokale Owner ===
++=== Lokale Owner ===
  Jedes Objekt in Paperless muss einen Owner haben. Damit der Owner nicht ein realer Benutzer ist, der gegebenenfalls den Vorstand / Mitgliederverwaltung oder Verein verlassen könnte, werden lokale Benutzer angelegt. Diese halten lediglich die Owner Rolle für die Ressourcen, können aber nicht für den Login verwendet werden.
@@ -1391,7 +1391,7 @@
  Alle Objekte (Dokumente, Dokumenttypen, Tags, Korrespondenten und Speicherpfade), die dem Use-Case **Vorstandspost** zugewiesen sind
  )))
--=== {{id name="DigitaleMitgliederverwaltung-Standard-Objekt-Berechtigungen"/}}Standard-Objekt-Berechtigungen ===
++=== Standard-Objekt-Berechtigungen ===
  Basierend auf den hier beschrieben Regeln werden für Objekte die folgenden Berechtigungen gesetzt:
@@ -1494,7 +1494,7 @@
  IT Admin
  )))
--== {{id name="DigitaleMitgliederverwaltung-Workflows"/}}Workflows ==
++== Workflows ==
  Paperless Workflows können zur Automatisierung verschiedener Tasks eingesetzt werden. In diesem Fall werden zwei Fälle damit abgedeckt:
@@ -1501,7 +1501,7 @@
  * Beim Hinzufügen der Dokumente via Webinterface **wird standardmäßig der angemeldete Nutzer als Owner des Dokuments festgelegt**. Damit haben andere Mitglieder der gleichen Gruppe (Beispielsweise Vorstand oder Mitgliederverwaltung) kein Zugriff auf die so hinzugefügten Dokumente. Aus diesem Grund setzt einer der Workflow die entsprechend notwendigen Berechtigungen.
  * Einscannen von Dokumenten soll sowohl für die Mitgliederverwaltung als auch für den Vorstand möglich sein und der richtigen Gruppe zugeordnet werden. Wir haben dafür zwei unterschiedliche Ordner aus dem NAS angelegt. Der Dokumentenscanner kann Dokumente in einen der beiden Ordner legen, wir nutzen Workflows um auch hier die richtigen Berechtigungen zu setzen.
--= {{id name="DigitaleMitgliederverwaltung-OffenePunkte"/}}Offene Punkte =
++= Offene Punkte =
  * Docuseal Logging + Monitoring
  * N8n Error Handling