n8n-nodes-workflow-documenter

n8n-Community-Node, der bestehende Workflows analysiert und dokumentiert. Ausgabeformate:

• Detailtabelle / Übersichtstabelle – ein Datensatz je Node
• Markdown – Markdown-Dokumentation
• HTML-Bericht (Audit, Standard) und drei SAP-Fiori-Designs (Klassisch, KPI-Dashboard, Object Page) – prüfungsfertige Berichte mit:
  • Workflow-Diagramm (berechnetes Layout: Eleganter Graph oder Swimlanes, überlappungsfrei, druckbar)
  • fachlicher Beschreibung, vollständiger Node-Konfiguration, Credential-Liste
  • Zugriffsanalyse auf Datenquellen/externe Systeme inkl. Port und Richtung (eingehend/ausgehend/lokal)
  • Metadaten (Ersteller, erstellt/geändert, zuletzt ausgeführt)

Der erzeugte HTML-Code steht im Output als json.html für Folge-Nodes bereit (z. B. „Respond to Webhook", E-Mail, Datei) und zusätzlich als Binary report_html.

Eigene Beschreibung: Enthält der Workflow eine Notiz (Sticky Note), deren Inhalt mit dem Wort „Beschreibung" beginnt, wird dieser Text in den HTML-Berichten oben in der Sektion „Was dieser Workflow tut" vor dem automatisch erzeugten Text angezeigt (und nicht zusätzlich unter „Notizen" wiederholt).

Voraussetzungen

• Nur self-hosted: Community-Nodes können nicht auf n8n Cloud installiert werden.
• Die Node.js-Version wird durch die installierte n8n-Version vorgegeben (n8n 2.x → Node ≥ 22.22, n8n 1.x → Node 18/20+).
• Der Node nutzt die Standard-Node-API (n8nNodesApiVersion 1) und die Public REST API v1 (Cursor-Pagination). Technische Untergrenze ist daher n8n 1.x; belastbar getestet wurde n8n 2.23.2 mit Node.js 24.
• Ein n8n-API-Key (Einstellungen → n8n API → API-Key erstellen) wird für die Credential „Workflow Documenter API" benötigt.

Installation

Das Paket wird als Datei n8n-nodes-workflow-documenter-1.2.3.tgz ausgeliefert. Es wird in das Custom-Nodes-Verzeichnis der Ziel-n8n-Instanz installiert (<N8N_USER_FOLDER>/.n8n/nodes, Standard: ~/.n8n/nodes).

Nach der Installation n8n neu starten, damit der Node geladen wird.

Windows (n8n nativ)

# .tgz z. B. nach C:\temp kopiert
cd C:\n8n\n8n-inst\.n8n\nodes        # Custom-Nodes-Verzeichnis der Instanz
npm install C:\temp\n8n-nodes-workflow-documenter-1.2.3.tgz
# n8n neu starten

Gibt es das Verzeichnis nodes noch nicht:

mkdir C:\n8n\n8n-inst\.n8n\nodes
cd C:\n8n\n8n-inst\.n8n\nodes
npm init -y
npm install C:\temp\n8n-nodes-workflow-documenter-1.2.3.tgz

WSL (Ubuntu unter Windows)

Die .tgz liegt z. B. unter Windows in C:\temp – aus WSL erreichbar über /mnt/c/temp:

cd ~/.n8n/nodes                       # ggf. anlegen: mkdir -p ~/.n8n/nodes && (cd ~/.n8n/nodes && npm init -y)
npm install /mnt/c/temp/n8n-nodes-workflow-documenter-1.2.3.tgz
# n8n neu starten

Linux

mkdir -p ~/.n8n/nodes
cd ~/.n8n/nodes
npm init -y                           # nur falls noch keine package.json existiert
npm install /pfad/zu/n8n-nodes-workflow-documenter-1.2.3.tgz
# n8n neu starten (z. B. systemctl restart n8n  oder  pm2 restart n8n)

Docker

# .tgz in ein gemountetes Volume legen, dann im Container:
docker exec -it <n8n-container> sh
cd /home/node/.n8n/nodes              # ggf. anlegen + npm init -y
npm install /data/n8n-nodes-workflow-documenter-1.2.3.tgz
exit
docker restart <n8n-container>

Alternative: GUI-Installation (n8n „Community Nodes")

Diese Funktion installiert nur aus der npm-Registry. Solange das Paket nicht veröffentlicht ist, die Datei-Installation oben verwenden.

Einrichtung in n8n

1. Credential anlegen: Node „Workflow Documenter" einfügen → Credential „Workflow Documenter API" → Base URL (z. B. http://localhost:5678) und API-Key eintragen.
2. Operation wählen: „List Workflows" oder „Document Workflow".
3. Bei „Document Workflow": Workflow auswählen, Ausgabeformat und (bei HTML) Diagramm-Layout wählen.

Browser-Vorschau (am Arbeitsplatz, nicht am Server)

Für eine sofort gerenderte Vorschau im eigenen Browser den Node hinter einen Webhook-Trigger hängen und mit Respond to Webhook antworten:

Webhook (GET)  →  Workflow Documenter (Format HTML…)  →  Respond to Webhook
                                                          Content-Type: text/html
                                                          Body: {{ $json.html }}

Webhook-URL im Browser öffnen, z. B.:
http://<n8n-host>:5678/webhook/<pfad>?wf=<WORKFLOW-ID>&layout=swimlanes

Build aus dem Quellcode (optional)

npm install
npm run build           # erzeugt dist/ (unobfusziert, für Entwicklung)
npm run build:release   # erzeugt dist/ obfusziert (für Auslieferung)
npm pack                # erzeugt die .tgz

Lizenz / Markenschutz

Proprietär — © 2026 Thomas Braun. Siehe LICENSE.

Die Hersteller-/Urheberkennzeichnung (u. a. „Powered by Thomas Braun" in den
Berichten sowie die Copyright-Hinweise in Node und Credential) darf nicht
entfernt oder verändert werden. Schutzmechanismen:

• Lizenz: Entfernen/Verändern der Kennzeichnung ist untersagt; das
  Nutzungsrecht erlischt bei Verstoß.
• Integritätsprüfung: Die Kennzeichnung ist kodiert hinterlegt und wird
  zur Laufzeit per SHA-256 geprüft. Bei Manipulation ersetzt der Bericht die
  Kennzeichnung durch einen sichtbaren „manipuliert"-Hinweis.
• Obfuscation: Der ausgelieferte Code ist verschleiert, sodass die
  Kennzeichnung nicht per Textsuche auffindbar/änderbar ist.