Erfahrungsbericht: Dokumentation von Rechner-Konfiguration

Erstellt 01.06.2014  Kategorien  Software

Ich nenne zuhause eine kleines, bescheidenes Netzwerk mein Eigen. Da ist nichts weltbewegendes dabei, trotzdem steckt da eine Menge Arbeit und Nerven drin. Schon häufig habe ich Versuche gestartet, die Konfiguration zu dokumentieren. Aber immer haben sich diese Ansätze als praxisuntauglich erwiesen und sind versandet. Nun habe ich eine Lösung gefunden, die funktioniert, intuitiv ist und dazu führt, daß das Dokumentieren richtig Spaß macht. Davon möchte ich in diesem Artikel kurz berichten.

Anlaß, über eine Lösung zur Dokumentation von Rechner-Konfigurationen nachzudenken, war, daß ich Anfang diesen Jahres das kleine Firmennetz meiner Eltern komplett mit neuen Rechnern ausgestattet habe. Seither laufen da nun Linux-Server. Da ich in der Firma quasi der hauptamtliche Administrator bin und bei Problemen eine schnelle Fehlerbeseitigung erforderlich ist, habe ich die Konfiguration dokumentiert, um mich auch nach langer Zeit wieder schnell einfinden zu können. Im Vorfeld habe ich mehrere Möglichkeiten eroiert. In der Vergangenheit habe ich die Dokumentation häufig in einem Textdokument gemacht. Das wird aber schnell unübersichtlich. Später ist die Orientierung in dem Dokument sehr umständlich.

Viele der Informationen für die Konfiguration hole ich mir letztlich aus dem WWW. Deshalb hatte ich den Gedanken, die eigene Dokumentation in einem lokalen Wiki zu machen. Das habe ich dann erstmals für das Netzwerk meiner Eltern und von Anfang an sehr gute Erfahrungen gemacht. Es gibt eine große Anzahl sehr guter Wiki-Systeme da draußen. Meine Wahl fiel letztlich auf MoinMoinWiki. Die Free Software Foundation setzt dieses System ein, und ich war von der Benutzung recht angetan. Außerdem ist die Arbeit für das Aufsetzen und die Pflege des Wikis bspw. im Vergleich zu MediaWiki (das Wiki-System hinter z.B. Wikipedia) eher gering. MoinMoinWiki ist in der Programmiersprache Python geschrieben und benötigt keine Datenbank-Engine. Ein Backup kann durch eine Kopie der Konfigurationsdateien sowie des Datenverzeichnisse erfolgen.

Die Seiten in MoinMoinWiki lassen sich hierarchisch sortieren, was ich konsequent ausgenutzt habe. Es gibt eine übergeordnete Ebene "Computer/". Der folgende Screenshot zeigt die Seite "Computer", die eine Tabelle aller Maschinen enthält. Die Namen der Maschinen sind mit den entsprechenden Unterseiten verlinkt, also z.B. "Computer/Ymir" (mein Server).

Wiki-Seite Computer
Wiki: Übersichtsseite Computer

Die Seiten, die nun die Computer (und auch andere netzwerkfähige Maschinen) beschreiben, sind nun natürlich die Herzstücke. Alle diese Seiten haben die gleiche Grundstruktur mit nur geringen Abwandlungen:

Bei längeren Texten habe ich Unterseiten angelegt (z.B. "Computer/Ymir/Samba") und verlinkt. Jede dieser Seiten hat eigangs eine Inhaltsverzeichnis, um sich umständliches Scrollen zu sparen. Manche Konfigurationen einzelner Programme sind bei verschiedenen Computern identisch, z.B. SSH bei Linux-Maschinen. Hier habe ich einmalig eine Wiki-Seite "Computer/Linux/SSH" angelegt und bei den einzelnen Computern verlinkt, um keine unnötigen Redundanzen zu schaffen.

Bei den Texten habe ich mich stark an den üblichen HowTo-Seiten aus dem WWW orientiert. Sie sind daher in Kochrezept-Manier geschrieben. Wo immer nötig und sinnvoll, habe ich Verweise zu WWW-Seiten eingefügt.

Mit dem Wiki geht die "lästige" Dokumenation gut von der Hand und macht mir sogar richtig Spaß. Nun lasse ich mich deutlich häufiger dazu motivieren, auch spontane Konfigurations-Änderungen direkt im Wiki zu dokumentieren.

Daneben setze ich das Wiki auch zur Dokumentation anderer Sachen ein, bspw. meiner Bastelprojekte. Häufig steht ja am Anfang eine WWW-Recherche und Link-Sammlung. Anstelle, daß nun mein Browser vor geöffneten Tabs erstickt oder ich Links in meinen Bookmarks nur schwer wiederfinde, werden diese Links nun auf einer Projektseite im Wiki abgelegt. Später werden die ersten Gehversuche und Projektfortschritte sukzessive nachdokumentiert. Für die Projektdokumentation habe ich bislang keine Struktur entwickelt, bislang aber auch noch nicht die Notwendigkeit dazu verspürt.

Zu guter letzt: Das Wiki läuft lokal auf meinem Server zuhause. Ich habe mich dagegen entschieden, es öffentlich zu machen, da insbesondere die Dokumentation der Rechner-Konfiguration Sicherheitslücken offenbaren könnte. Das Wiki ist zwar auch von "außen" erreichbar, allerdings nur unter einer mir bekannten URL und nur mit Login.

Tags  computer,  dokumentation,  wiki,  konfiguration