BookStack

Letztes Wochenende war ich auf der Suche nach einer OpenSource Software welche mir eine einfache Möglichkeit gibt ein Smart Home System und all ihre angeschlossenen Komponenten zu dokumentieren. Auf einfache Textfiles wollte ich dieses Mal nicht zurückgreifen und hab mich deshalb nach Docker-verpackten Systemen umgeschaut. Dabei bin ich auf BookStack gestoßen und erzähle hier jetz ein klein bisschen darüber.

Struktur

BookStack ist jetzt kein komplettes Wiki-System mit hochkomplexen Features, allerdings braucht man das vor allem im Privaten oft nicht. Grundsätzlich ist die Dokumentstruktur in 3 Bereiche geteilt:

  • Ein Buchregal enthält mehrere Bücher
  • Ein Buch enthält verschiedene Kapitel
  • Ein Kapitel enthält mehrere Seiten.

Und das wars. In Verbindung mit einem einfachen WYSIWYG oder Markdown Editor lässt sich damit schon einiges erschlagen. Es ist zudem möglich auch Tags für Seiten zu vergeben um die Volltextsuche zu verbessern. Zwischen den Seiten kann verlinkt werden und Bilder werden in einem eigenen Media-Manager verwaltet.

Eine Seite der Dokumentation
Eine Seite der Dokumentation

Authentifizierung

Das Bücherregal ist standardmäßig ohne Authentifizierung, kann aber aktiviert werden. BookStack wartet dann mit einem vollständigen Benutzersystem inklusive Registrierung mit Mail-Versand auf. Auch ist eine Anbindung an LDAP oder einen OAuth Provider mit in der Installation enthalten.

Systemanforderungen

BookStack arbeitet mit PHP und MySQL was in heutiger Zeit keine hohen Anforderungen sind. Theoretisch könnte man es damit so gar auf einem Webspace hosten. Für mein Einsatzgebiet läuft es in einem Docker-Container auf einem Raspberry Pi.

Fazit

Für ein kleines, privates Wiki finde ich BookStack mehr als ausreichend. Durch die einfach gehaltene Benutzeroberfläche kommen auch weniger versierte Anwender schnell an die richtige Dokumentation. Für alle Benutzer von Home Assistant gibt es hier auch noch einen Tipp: BookStack gibt es auch als Supervisor Addon.