Mit Bookstack erstellen auch unerfahrene Anwender Dokumentationen oder andere Informationssammlungen im Handumdrehen.

Mit der steigenden Flut an Wissen in allen Bereichen des Lebens wächst der Bedarf, Informationen gut zugänglich zu strukturieren, zu organisieren und zu speichern. Das gilt gleichermaßen im beruflichen wie im privaten Umfeld. Das seit rund zehn Jahren unter der MIT-Lizenz entwickelte Open-Source-Wiki Bookstack [1] hat sich dieser Aufgabe angenommen. Es eignet sich nicht nur für Einzelbenutzer und Haushalte, sondern ebenso für kleine Teams und Unternehmen.

Obliegt Ihnen beispielsweise die IT-Verwaltung Ihres Haushalts oder Ihrer Familie, kennen Sie das Problem: Die Zahl der zu verwaltenden Geräte vergrößert sich ständig. Es fällt immer schwerer, den Überblick zu behalten, und Sie suchen oft nach verstreuten Informationen zu einzelnen Systemen. Bookstack bietet sich hier als ebenso benutzerfreundliches wie leistungsstarkes Wiki an, um alle Informationen rund um den IT-Bestand des Haushalts zu organisieren. Das reicht von der Spezifikation der Geräte über die IP-Adressen der Dienste auf dem Homeserver bis hin zur Dokumentation der Einrichtung der Anwendungen und Services. So lässt sich selbst nach Jahren der Aufbau der hauseigenen IT detailliert nachvollziehen. Ein weiteres Beispiel aus den unzähligen Anwendungsmöglichkeiten von Bookstack ist das gleichzeitige Arbeiten an Dokumenten in einem Team aus Entwicklern und technischen Autoren.

Nach der Installation des Wikis genügen grundlegende Textverarbeitungskenntnisse, um mit dem Erstellen von Inhalten auf Bookstack zu beginnen. Gleichzeitig stellt die Software fortgeschrittene Leistungsmerkmale bereit, die jedoch die einfache Nutzung nicht verkomplizieren.

Zum Strukturieren des Bücherstapels, wie Bookstack ins Deutsche übersetzt heißt, stehen Ihnen verschiedene Wege offen. Sie erstrecken sich von der Loseblattsammlung, die Sie über Kapitel und Bücher thematisch zusammenfassen, bis hin zu unbegrenzt vielen Bücherregalen als höchste Stufe der Organisation. Dabei kann ein Buch in beliebig vielen Regalen stehen. Um zu entscheiden, ob die Organisationsoptionen von Bookstack Ihren Ansprüchen genügen, sehen Sie sich am besten die Demo [2] auf der Projektwebseite an.

Gut strukturierte GUI

Beim Design haben die Entwickler darauf geachtet, dass Sie als Benutzer mit minimaler Einarbeitung und ohne umfangreiche technische Kenntnisse beliebige Sammlungen erstellen und verwalten können. Klare Strukturen stehen bei der Benutzeroberfläche im Vordergrund. Sie ermöglichen für Autoren und Leser die intuitive Navigation in den angelegten Büchern, Kapiteln und Seiten.

Mit einer Reihe von Funktionen hebt sich Bookstack von anderen Wikis und Dokumentationswerkzeugen ab. Die hierarchische Struktur gestattet es, komplexe Dokumentationen in übersichtliche und gut gegliederte Einheiten zu unterteilen, sodass Sie die gewünschten Informationen im Handumdrehen finden.

WYSIWYG-Editor

Mithilfe des benutzerfreundlichen, auf TinyMCE basierenden WYSIWYG-Editors erstellen Sie Inhalte, ohne dazu über Kenntnisse in HTML oder Markdown verfügen zu müssen. Der Editor unterstützt gängige Formatierungen wie Überschriften, Listen, Links, Bilder und Tabellen. Zusätzlich lassen sich zur erweiterten Formatierung einfache HTML-Tags einfügen. Überdies integriert der Editor den Webdienst von Draw.io, über den Sie die Dokumente schnell und einfach mit Diagrammen anreichern.

Bookstack stellt als Mehrbenutzersystem eine ausgefeilte Rechtevergabe bereit. Den vom Administrator eingerichteten Benutzerkonten lassen sich verschiedene Rollen zuweisen. Dabei kann jede Rolle unterschiedliche Berechtigungen erhalten, beispielsweise hinsichtlich des Erstellens, Bearbeitens und Löschens von Inhalten. So steuern Sie präzise, wer in der Familie oder im Team auf welche Inhalte zugreifen und sie bearbeiten darf. Die Berechtigungen lassen sich auf Buch-, Kapitel- oder Seitenebene festlegen.

Ein weiterer Vorteil von Bookstack gegenüber ähnlichen Anwendungen zeigt sich in den vielfältigen Möglichkeiten, die Anwendung selbst gehostet zu installieren. Was dabei für Sie infrage kommt, hängt von den konkreten Gegebenheiten ab. Als Basis braucht Bookstack PHP und eine Datenbank wie MySQL oder MariaDB. Lassen Sie sich davon nicht abschrecken – im einfachsten Fall übernimmt ein Skript die gesamte Installation. Bookstack-Hosting von Drittanbietern gibt es zudem im Netz ab rund 5 Euro pro Monat. Falls Sie das Wiki auf einem gemieteten Server installieren möchten, erleichtert das der kommerzielle Dienst Laravel Forge [3].

Die englische Dokumentation beschreibt die Möglichkeiten ausführlich. Das reicht von der manuellen Installation über verschiedene Docker-Varianten bis hin zur skriptgesteuerten Installation auf verschiedenen Ubuntu-LTS-Versionen, für die jeweils zusätzlich eine Videoanleitung [4] bereitsteht. Für die Installation in einem Docker-Container finden Sie auf Github eine Docker-Compose-Datei [5]. In Unraid binden Sie die Anwendung mit wenigen Klicks in einen bestehenden Datenbank-Container ein.

Per Skript installiert

Wir nutzen für diesen Artikel die einfachste Methode und installieren die Software skriptgesteuert auf einem frisch in einer virtuellen Maschine (VM) installierten Ubuntu LTS 24.04 (Abbildung 1). Dabei richten wir neben Bookstack selbst noch Apache 2.4.58, MySQL 8.0 und PHP 8.3 mit ein. Sie sollten die verwendete Ubuntu-Instanz nicht für andere Zwecke nutzen, da sonst bestehende Webkonfigurationen überschrieben werden könnten.

Abbildung 1: Das Installationsskript richtet neben Bookstack auch PHP und MySQL ein, sodass Sie anschließend sofort loslegen können.

Zunächst laden Sie das Installationsskript mithilfe des Kommandos aus der ersten Zeile von Listing 1 in das Home-Verzeichnis des Rechners herunter. Anschließend machen Sie es ausführbar (zweite Zeile) und rufen es auf (dritte Zeile). Bei Problemen finden Sie ein Protokoll in dem Verzeichnis, in dem Sie die Installation angestoßen haben.

$ wget https://codeberg.org/bookstack/devops/raw/branch/main/scripts/installation-ubuntu-24.04.sh
$ chmod a+x installation-ubuntu-24.04.sh
$ sudo ./installation-ubuntu-24.04.sh

Es spielt dabei keine Rolle, ob Ubuntu wie im Beispiel in einer virtuellen Maschine auf Unraid läuft, in einer VM direkt auf einem Host oder direkt auf der Hardware. Nach dem Start des Skripts haben Sie die Wahl, eine eigene Domain oder eine vom Skript vorgegebene IP-Adresse anzugeben, die später zum Start von Bookstack im Browser dient. Danach kümmern Sie sich um die notwendigen Grundlagen wie PHP mitsamt dem Web-Framework Laravel und MariaDB als Datenbank. Das dauert je nach Hardware drei bis fünf Minuten.

Nach dem Abschluss der Installation geben Sie die gewählte Domain oder IP-Adresse in einem Webbrowser Ihrer Wahl ein und landen in der Anmeldemaske von Bookstack. Die Standard-E-Mail-Adresse und das Passwort lauten mailto:admin@admin.com und password. Nach der Anmeldung ändern Sie über die Konteneinstellungen rechts oben die Zugangsdaten und richten bei Bedarf eine Multifaktorauthentifizierung ein.

Für Entwickler und erfahrene Nutzer offeriert Bookstack die Möglichkeit, ein API-Token zu erstellen. Es ermöglicht, Integrationen und Automatisierungen mit Drittsoftware umzusetzen. Unter Ihrem Account definieren Sie darüber hinaus Tastaturkürzel und Benachrichtigungseinstellungen, entscheiden sich für den hellen oder dunklen Modus und modifizieren das Farbschema der Anwendung. Die Darstellung im Editor lässt sich von WYSIWYG (Abbildung 2) auf Markdown (Abbildung 3) umstellen.

Abbildung 2: Der gut ausgestattete WYSIWYG-Editor unterstützt Sie bei der Formatierung von Texten. Auch LanguageTool, eine freie Software zur Rechtschreib- und Grammatikprüfung, verrichtet unter Bookstack ihren Dienst.

Abbildung 3: In der optionalen Markdown-Ansicht des Editors erscheint rechts neben der Markdown-Notation eine Live-Vorschau des bearbeiteten Dokuments.

Personalisierung

In den Einstellungen (Abbildung 4) lässt sich Bookstack weiter personalisieren. Planen Sie einen Mehrbenutzerbetrieb, legen Sie dort entsprechende Nutzer an und weisen ihnen Rollen zu. Im letzten Reiter der Einstellungen definieren Sie Webhooks, um bei bestimmten Aktionen und Ereignissen im System externe Plattformen wie Messaging- oder Benachrichtigungssysteme einzubeziehen. Außerdem reihen sich in der Kopfleiste Schalter für Bücher und Regale aneinander, die anfangs freilich noch leer stehen.

Abbildung 4: Jedem im System angelegten User teilen Sie eine Rolle zu und legen die korrespondierenden Berechtigungen fest. Die verfügbaren Rollen heißen Admin, Editor, Public und Viewer.

Bevor Sie damit beginnen, den eigentlichen Content einzupflegen, sollten Sie eine klare Struktur dafür entwerfen. Eine gut durchdachte Struktur hilft später dabei, die Inhalte in einer übersichtlichen und leicht navigierbaren Weise zu organisieren.

Bücher anlegen

Für den Einstieg empfiehlt es sich, Bücher anzulegen, die jeweils ein Thema abdecken. Darin ergänzen Sie dann Kapitel und Seiten. Wir haben im Test solche Bücher für den Hardwarebestand des Haushalts, für Artikelideen, für die Dokumentation von Software sowie für Tools, Tipps und Tricks angelegt. Ein Buch für den Hardwarebestand enthält beispielsweise Kategorien für die Hardware sowie die darauf laufenden Programme oder Dienste. Die Informationen finden auf den entsprechenden Seiten Platz. Anschließend sortieren Sie die Bücher in ein Regal mit passendem Namen ein.

In den Einstellungen wählen Sie eine Startseite (Abbildung 5) aus, zum Beispiel die Ansicht der zuletzt erstellten Bücher. Die Oberfläche von Bookstack zeigt daraufhin in der linken Seitenleiste Informationen zur Navigation. Die Inhalte dieser Leiste und auch der rechten ändern sich, je nachdem, ob Sie sich in einem Regal (Abbildung 6), einem Buch, einem Kapitel oder auf einer Seite befinden. In der rechten Seitenleiste listet die Anwendung unter Bücher mögliche Aktionen auf.

Abbildung 5: Unsere ausgewählte Startseite zeigt die Bücheransicht. Sie können jedoch in den Einstellungen jedes andere Element von Bookstack zur Startseite machen.

Abbildung 6: In der Regalansicht sehen Sie die erstellten Regale und deren Inhalt in Form von Büchern standardmäßig als Liste. Rechts schalten Sie gegebenenfalls zur Gitteransicht um.

Die Volltextsuche von Bookstack verwendet Elasticsearch oder MySQL Full-Text Search, was Sie selbst in umfangreichen Sammlungen schnell zum gesuchten Objekt bringt. Sie können direkt auf jeden beliebigen Absatz verlinken, was die Dokumentation zusammenhängend hält. Zusätzlich zu den leistungsstarken Such- und Verlinkungsfunktionen gibt es eine buchübergreifende Sortierung, Seitenüberarbeitungen und eine Bildverwaltung.

Über den Schalter Version in den Details am rechten Rand einer Seite (Abbildung 7) sehen Sie sämtliche Versionen der Seite ein und stellen bei Bedarf ältere Versionen wieder her. In den generellen Einstellungen hinterlegen Sie, wie viele Revisionen erhalten bleiben sollen.

Abbildung 7: Das Verfolgen der Versionen erleichtert den Überblick über die Änderungen an einer Seite. Sie können wie von Git gewohnt jederzeit zu einer älteren Version zurückkehren.

Die Details (Abbildung 8) gewähren Einblick in die letzten Bearbeitungsstände und die Versionierung, während sich bei den Aktionen in der Rubrik Bücher neue Kapitel oder Seiten anlegen lassen. Darunter finden Sie Schalter für Aktionen wie Bearbeiten, Sortieren, Kopieren, Berechtigungen, Löschen, Beobachten, Favoriten und Exportieren. Letzteres bietet Bookstack für die Formate HTML, PDF, Text und Markdown an.

Abbildung 8: In der Seitenansicht haben Sie rechts die Möglichkeiten, ein Dokument zu bearbeiten. Links sehen Sie zuoberst die Absätze der Seite und darunter die Navigation. Am Seitenkopf finden Sie eine Brotkrümelnavigation.

Einige Funktionen von Bookstack lassen sich sogar über die Kommandozeile ausführen. Mit init richten Sie eine neue Bookstack-Installation in einem Ordner ein. Mit backup sichern Sie eine bestehende Bookstack-Installation in einer ZIP-Datei. Umgekehrt stellen Sie ein solches Backup mit restore in einer Instanz von Bookstack wieder her. Eine Aktualisierung auf eine neue Bookstack-Version leiten Sie mit update ein [6]. Zur Erweiterung der Funktionalität gibt es auf der Webseite diverse inoffizielle Bookstack-Hacks [7].

Fazit und Ausblick

Bookstack wurde entwickelt, um Benutzern mit grundlegenden Textverarbeitungskenntnissen den Einstieg in das Erstellen von Inhalten zu ermöglichen. Als Sahnehäubchen bietet das Wiki zudem fortgeschrittene Funktionen. Die englischsprachige Dokumentation unterteilt sich in Kapitel für Administratoren und Anwender. Zusätzlich gibt es eine Rubrik mit Videoanleitungen [8]; auf Discord [9] können Sie sich mit Entwicklern und anderen Anwendern austauschen.

Im Vergleich mit Alternativen wie Dokuwiki, Mediawiki oder Tiddlywiki macht Bookstack mit seiner einfachen Installation und Handhabung eine gute Figur. Anders als etwa Dokuwiki oder das Desktop-Wiki Zim speichert es seine Inhalte allerdings nicht als einfache Textdateien ab, sondern lagert sie in einer Datenbank. Die Entwicklung von Bookstack hat auch nach zehn Jahren nicht an Schwung verloren. In der voraussichtlich zu Weihnachten 2024 erscheinenden nächsten Version wird das Wiki unter anderem auch einen Export von Seiten, Kapiteln und Büchern als ZIP-Archiv unterstützen. (csi)