Self-Hosting

Hold My Docs speichert Wiki-Seiten als Git-Commits für einfache Wiederherstellung

Ein neues selbst gehostetes Wiki namens Hold My Docs speichert jede Seitenbearbeitung als Git-Commit und hält die Dokumentation auch dann zugänglich, wenn die Anwendung ausfällt.

Illustration von Papierdokumenten, die sich in Git-Branches innerhalb eines Serverracks verwandeln
Für diesen Artikel erstellte Illustration

Automatisch aus dem englischen Original übersetzt.

Hold My Docs ist ein neues Open-Source-Tool, das entwickelt wurde, um das häufige Problem verlorener oder unzugänglicher Serverdokumentation zu lösen. Ende Oktober 2026 veröffentlicht, speichert dieses selbst gehostete Wiki alle Inhalte als Standard-Markdown-Dateien in einem Git-Repository, anstatt sie in einer proprietären Datenbank zu verstecken. Dieser Ansatz stellt sicher, dass technische Notizen lesbar und versionskontrolliert bleiben, selbst wenn die Weboberfläche nicht mehr verfügbar ist.

Was passiert ist

Die Kerninnovation von Hold My Docs liegt im Speichermechanismus. Anstatt sich auf ein komplexes Datenbankschema zur Verwaltung der Inhalte zu verlassen, schreibt die Anwendung jeden Speichervorgang direkt in ein Git-Repository. Das bedeutet, dass jede Bearbeitung einen neuen Commit erzeugt und so eine vollständige Änderungshistorie bereitstellt, ohne dass zusätzliche Backup-Tools erforderlich sind. Benutzer können diese Historie über die Weboberfläche durchsuchen oder direkt auf die Rohdateien im Dateisystem des Servers zugreifen.

Dieses Design adressiert einen häufigen Schmerzpunkt für Homelab-Enthusiasten und kleine IT-Teams: die Veraltung von Dokumentation. Wenn Server geändert werden, Konfigurationen sich verschieben und alte Notizen obsolet werden, können Administratoren mit Hold My Docs auf vorherige Versionen einer Seite zurückgreifen, falls eine neue Konfiguration fehlschlägt oder sie sich daran erinnern müssen, warum eine bestimmte Einstellung vor Monaten gewählt wurde. Die Anwendung unterstützt zudem die Synchronisation mit entfernten Git-Repositories, sodass Teams automatisch eine Off-Site-Kopie ihrer Wissensbasis pflegen können.

Neben der einfachen Textspeicherung bietet das Tool einen browserbasierten Markdown-Editor mit Live-Vorschau. Es unterstützt interne Verlinkungen und Backlinks, was Nutzern hilft, verwandte Themen miteinander zu verbinden. Eine bemerkenswerte Funktion ist die Unterstützung von Mermaid-Diagrammen, die es Ingenieuren ermöglicht, Netzwerktopologien oder Service-Architekturen direkt innerhalb ihrer Notizen zu zeichnen. Dies eliminiert die Notwendigkeit separater Diagrammsoftware und hält visuelle Dokumentation neben den textlichen Anweisungen.

Wichtige Details

  • Speicher-Backend: Alle Wiki-Seiten werden als reine Markdown-Dateien in einem lokalen Git-Repository gespeichert.
  • Versionskontrolle: Jeder Speichervorgang generiert einen Git-Commit, was eine vollständige Nachverfolgung der Historie und Rollback-Fähigkeiten ermöglicht.
  • Bereitstellungsoptionen: Die Anwendung ist in Go geschrieben und kann als eigenständige Binary oder über eine offizielle Docker Compose-Konfiguration ausgeführt werden.
  • Authentifizierung: Unterstützt lokale Benutzerkonten und OpenID Connect (OIDC) zur Integration mit bestehenden Identitätsanbietern.
  • Suchfunktionen: Enthält eine Volltextsuche für Wiki-Seiten, mit optionaler Apache-Tika-Integration zur Indexierung von PDF- und Office-Dokumenten.
  • Exportfunktionen: Benutzer können gesamte Namespaces als statische Websites exportieren, um sie öffentlich zu teilen, ohne die Wiki-Anwendung preiszugeben.

Hintergrund

Um den Wert von Hold My Docs zu verstehen, ist es hilfreich, die Einschränkungen traditioneller Wiki-Software zu erkennen. Viele selbst gehostete Wikis speichern Inhalte in Datenbanken wie SQLite oder PostgreSQL. Zwar effizient für Abfragen, macht dies den Datenzugriff außerhalb der Anwendung schwierig. Wenn die Wiki-Software abstürzt oder nicht mehr unterstützt wird, kann die Extraktion der Inhalte herausfordernd sein. Durch die Nutzung von Git greift Hold My Docs auf eine Technologie zurück, der die meisten Entwickler und Systemadministratoren bereits vertrauen und die sie verstehen.

Git ist ein verteiltes Versionskontrollsystem, das weit verbreitet in der Softwareentwicklung eingesetzt wird. Es verfolgt Änderungen an Dateien über die Zeit hinweg und ermöglicht Benutzern zu sehen, wer wann was geändert hat. Indem Dokumentation als Code behandelt wird, stellt Hold My Docs sicher, dass die Daten portabel bleiben. Markdown ist eine leichte Markup-Sprache, die im reinen Textformat leicht lesbar ist. Die Kombination dieser beiden Technologien schafft ein Dokumentationssystem, das robust und zukunftssicher ist und das Risiko eines Vendor-Lock-ins reduziert.

Warum es wichtig ist

Für Teams, die ihre eigene Software betreiben, ist Zugänglichkeit während Ausfällen kritisch. Wenn Ihr Dokumentationsserver ausfällt, benötigen Sie oft genau diese Dokumentation, um den Server zu reparieren. Hold My Docs entschärft dieses Catch-22, indem die zugrunde liegenden Dateien in einem Standardformat gehalten werden. Selbst wenn die Weboberfläche unerreichbar ist, kann ein Administrator per SSH auf den Server zugreifen, zum Git-Repository navigieren und die Markdown-Dateien direkt lesen. Diese Resilienz ist ein erheblicher Vorteil gegenüber datenbankgesteuerten Lösungen.

Zudem wird die Trennung zwischen privaten und öffentlichen Informationen durch Namespaces vereinfacht. Administratoren können sensible Server-Zugangsdaten und interne Netzwerkkarten in einem privaten Namespace halten, während nicht-sensible Haushalts- oder allgemeine Projektnotizen als statische Website exportiert werden. Diese Flexibilität ermöglicht es Organisationen, Wissen extern zu teilen, ohne die Sicherheit zu gefährden oder separate Systeme warten zu müssen.

Die optionale MCP-Server-Integration (Model Context Protocol) weist auch auf zukünftige Workflows hin, in denen KI-Assistenten Dokumentation sicher abfragen können. Dies erfordert jedoch ein sorgfältiges Berechtigungsmanagement, um zu verhindern, dass KI-Tools auf sensible Infrastrukturdetails zugreifen. Das Design des Tools fördert einen disziplinierten Ansatz bei der Dokumentation und erleichtert es, genaue Aufzeichnungen über die Zeit hinweg zu führen.

Was Sie tun können

  • Docker-Bereitstellung testen: Verwenden Sie die offizielle Docker Compose-Datei, um eine lokale Instanz hochzufahren und die Oberfläche zu evaluieren, ohne sich auf ein langfristiges Setup festzulegen.
  • Lokalen Speicher sorgfältig konfigurieren: Stellen Sie sicher, dass das Datenverzeichnis der Anwendung auf lokalem Speicher liegt und nicht auf NFS, um Leistungsprobleme zu vermeiden, obwohl das Git-Repo mit Netzwerkspeicher synchronisiert werden kann.
  • OIDC frühzeitig einrichten: Integrieren Sie Ihren bestehenden Identitätsanbieter während der initialen Einrichtung, um das Benutzermanagement zu rationalisieren und die Verwaltung separater lokaler Konten zu vermeiden.
  • Mermaid-Diagramme aktivieren: Beginnen Sie damit, Netzwerkstrukturen unter Verwendung der Mermaid-Syntax innerhalb Ihrer Seiten zu dokumentieren, um visuelle Hilfen mit dem Text synchron zu halten.
  • Regelmäßige Backups planen: Obwohl Git Historie bietet, sollten Sie externe Backups des Repositories pflegen, um gegen physischen Hardwareausfall geschützt zu sein.
  • Berechtigungen vor Aktivierung von MCP prüfen: Wenn Sie die KI-Integration nutzen möchten, schränken Sie den Zugriff streng auf nicht-sensible Namespaces ein, um private Infrastrukturdaten zu schützen.

Weitere News

Alle News