Auf dieser Seite finden Sie die Details eines Projekts zum technischen Schreiben, das für Google Season of Docs angenommen wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- Whonix
- Technical Writer:
- 0brand
- Projektname:
- Installation und Einrichtung der neuen sicherheitsorientierten gehärteten Debian-Linux-Distribution dokumentieren
- Projektlänge:
- Standardlänge (3 Monate)
Projektbeschreibung
Hardened Debian ist eine neue sicherheitsorientierte Linux-Distribution, die von Whonix-Entwicklern aktiv weiterentwickelt wird. In diesem Projekt wird die Installation und Einrichtung von Hardened Debian in Windows/VirtualBox von Grund auf dokumentiert. Dabei liegt der Schwerpunkt darauf, Linux-Neulingen die Fähigkeiten zu vermitteln, die sie benötigen, um eine Linux-Distribution selbstständig zu verwenden.
Projektziele
Kerndokumentation erstellen
In der Anfangsphase dieses Projekts liegt der Fokus auf der Kerndokumentation für Hardened Debian. Diese besteht aus einer umfassenden Projektübersicht, Anleitungen zur Installation und Einrichtung von Hardened Debian sowie Ratschlägen und Tipps nach der Installation.
Lernbereiche für neue Linux-Nutzer erstellen
Es reicht nicht aus, ein paar Manpages zu schreiben und sie als Lernbereich zu bezeichnen. Viele Anfänger sind es nicht gewohnt, mit Eingabeaufforderungen zu interagieren und ihre eigenen Probleme zu beheben. Auf diesen Seiten geht es um CLI-Kenntnisse, praktische Problemlösung und Best Practices für die Fehlerbehebung.
Klare Trennung der Dokumentation von Hardened Debian und Whonix (Anonymitäts-Betriebssystem):
Auf Whonix.org werden sowohl Whonix als auch Hardened Debian gehostet. Die beiden Betriebssysteme haben jedoch sehr unterschiedliche Anwendungsfälle, was zu schwerwiegenden Folgen führen kann, wenn ein Nutzer sie verwechselt. Whonix ist beispielsweise für seine Anonymität bekannt. Ein neuer Nutzer, der mit Whonix nicht vertraut ist, könnte Hardened Debian einrichten und annehmen, dass er anonym im Web surft. Um solche Fehler zu vermeiden, wird die Dokumentation von Hardened Debian in einem separaten Bereich von Whonix.org mit einem neuen buchähnlichen Formatierungsstil untergebracht, der sich vom Formatierungsstil der Whonix-Betriebssystemdokumentation unterscheidet. Warnungen werden auch in wichtigen Bereichen wie der Downloadseite von Hardened Debian eingefügt, um Nutzer vor diesen Fehlern zu bewahren.
Nutzerfreundliche Dokumentation
Die Installation und Einrichtung einer Linux-Distribution kann selbst für erfahrene Nutzer eine Herausforderung sein. Eine benutzerfreundliche und intuitive Benutzeroberfläche kann die Nutzerfreundlichkeit verbessern. Genauso wichtig ist es jedoch, eine klare und leicht verständliche Dokumentation zu erstellen. Da die Nutzerbasis von Hardened Debian von Anfängern bis hin zu fortgeschrittenen Linux-Nutzern reicht, muss darauf geachtet werden, dass die Dokumentation nicht ausschließlich auf dem technischen Fachwissen und dem Verständnis des Technical Writers basiert. Stattdessen wird Hardened Debian aus der Sicht eines Linux-Anfängers dokumentiert, der möglicherweise Schwierigkeiten hat, Aufgaben auszuführen, die für erfahrene Nutzer einfach und schnell erledigt sind.
Community-Einbindung und -Beiträge fördern
Hardened Debian ist ein anspruchsvolles Projekt, das nur vollständig abgeschlossen werden kann, wenn die Community während der gesamten Projektlaufzeit eingebunden bleibt. Community-Mitglieder bleiben nur dann eingebunden, wenn ihr Feedback mit Begeisterung aufgenommen wird und ihre guten Ideen zur Verbesserung der Dokumentation genutzt werden. Während des gesamten GSoD bin ich im Whonix-Forum aktiv und ermutige sowohl zu Community-Feedback als auch zu Beiträgen zur Verbesserung der Dokumentation.
Betriebssystem Hardened Debian umbenennen
Dieses Betriebssystem basiert zwar auf Hardened Debian, es muss jedoch ein neuer Name gefunden werden, um Markenrechtsverletzungen zu vermeiden. Um dieses Ziel zu erreichen, wird die Whonix-Community aufgefordert, einprägsame Namen einzureichen, aus denen die Whonix-Entwickler auswählen können. Obwohl wir uns noch in der Brainstorming-Phase befinden, sind meine beiden Favoriten „Sentient Linux“ und „Sentinel Linux“.
Zeitplan des Projekts
Der Zeitplan für dieses Projekt wird in sieben Mini-Meilensteine unterteilt, mit denen der Fortschritt gemessen und Anpassungen vorgenommen werden können, um sicherzustellen, dass jeder Abschnitt pünktlich abgeschlossen wird. Wenn während des Season of Docs Schwierigkeiten auftreten, benachrichtige ich meinen Mentor sofort, damit ein Aktionsplan zur Lösung des Problems erstellt werden kann.
2. September ( Start des Season of Docs-Projekts)
Auf der Startseite wird eine Übersicht über Hardened Debian mit den wichtigsten Punkten des Betriebssystems gegeben.
Die erste Dokumentation umfasst die Installation von Hardened Debian in Windows/VirtualBox. Dadurch wird der anfängliche Umfang dieses Kapitels begrenzt. Community-Mitglieder werden jedoch aufgefordert, Hardened Debian auch auf Linux-Hosts sowie auf dem KVM-Hypervisor zu testen und ihre Ergebnisse zu dokumentieren.
Tabelle mit unterstützten Host-Betriebssystemen
Tabelle mit Hardwareanforderungen.
- Mindestanforderungen
- Empfohlen
- Für optimale Leistung
Der Inhalt besteht aus einer Übersicht mit den Entwicklungszielen und Anwendungsfällen von Hardened Debian, gefolgt von einer Tabelle mit den einzelnen Komponenten.
Ziele von Hardened Debian:
- Sicherheitsorientierte Linux-Distribution
- Kostenlos und Open Source
- Vom Nutzer konfigurierbar
- Standardmäßig gehärtet
Tabelle der Komponenten von Hardened Debian.
- VirtualBox-Hypervisor
- Windows
- Auf Hardened Debian basierendes Betriebssystem
- Terminologie (Host, virtuelle Maschine, Gastbetriebssystem usw.)
Hardened Debian ist standardmäßig mit vielen erweiterten Sicherheitsfunktionen konfiguriert. Dadurch müssen sich Nutzer nicht mit oft komplizierten Konfigurationen herumschlagen. Alle Sicherheitsverbesserungen werden in einer Tabelle mit einer kurzen Erläuterung der Vorteile aufgeführt.
- Haveged ist standardmäßig für eine bessere Entropie installiert.
- Anstelle von NTP wird die sichere verteilte Netzwerksynchronisierung (sdwdate) verwendet.
- Deaktiviert die Vorschau in Dolphin und Nautilus.
- Deaktiviert TCP-Zeitstempel und den Helfer für die Verbindungsnachverfolgung von Netfilter.
- open-link-confirmation.
- Apparmor ist standardmäßig mit Profilen aktiviert.
- Sicherheitsgehärteter Browser (Tor Browser ohne Tor)
Verbesserter Linux-Kernel
Desktopumgebung: KDE (nur in der CLI verfügbar).
Weitere ...
Meilenstein 15. September (Systemanforderungen, Funktionen und Vorteile, Designs und Ziele abgeschlossen)
Auf der Seite mit häufig gestellten Fragen werden Fragen beantwortet, die häufig von Community-Mitgliedern gestellt werden. Die Inhalte werden nach Bedarf während der gesamten Projektlaufzeit hinzugefügt.
Der Download und die Installation von Hardened Debian bestehen aus den folgenden Schritten.
- Downloadtabelle mit dem Hardened Debian-Image, der OpenGPG-Signatur, dem SHA512-Hash und dem GPG-Signaturschlüssel des Entwicklers.
- Signaturschlüssel des Entwicklers und Betriebssystem-Image überprüfen (Anleitung).
- VirtualBox-Hypervisor herunterladen und überprüfen (Anleitung).
- Hardened Debian in VirtualBox importieren (Anleitung)
- Hardened Debian starten
Meilenstein 29. September (Download und Überprüfung von Debian-Images, Debian-Installation abgeschlossen)
Nutzer sind möglicherweise nicht mit den Schritten vertraut, die erforderlich sind, um die Desktopumgebung anzupassen und Systemressourcen zuzuweisen. Für jeden der folgenden Schritte werden Tipps zur Schnellkonfiguration dokumentiert.
- Tastaturlayout ändern
- Zusätzliche Systemressourcen zuweisen (RAM)
- Bildschirmauflösung ändern
- Desktopverknüpfungen
- Fensterstilmanager
Fehler und Probleme, die beim Testen des Betriebssystems und der Anleitungen gefunden wurden, werden zusammen mit Problemumgehungen und/oder Korrekturen klar dokumentiert. Auf dieser Seite werden auch Probleme behandelt, die häufig beim Ausführen von Betriebssystemen in Hypervisoren auftreten.
- Probleme mit wenig RAM
- Fehlkonfiguration des BIOS (Intel VT-d, AMD-V)
- Verbindungsprobleme
Meilenstein 6. Oktober (Erste Schritte, Hardened Debian-Fehler abgeschlossen)
Neue Nutzer sind möglicherweise nicht mit Linux-Terminals/der CLI vertraut. Wenn die benötigten Informationen nicht leicht zu finden oder zugänglich sind, öffnen sie eine Supportanfrage, ohne überhaupt nach einer Lösung zu suchen. In diesem Abschnitt werden häufig verwendete Befehle und die praktische Befehlssyntax dokumentiert. Jede man enthält eine kurze Beschreibung des Befehls, eine Anleitung zur Verwendung und praktische Beispiele. Es dauert eine Weile, bis sich Nutzer die Befehle merken, die sie für verschiedene Aufgaben verwenden müssen. Durch Wiederholung merken sich Nutzer die Befehlssyntax mit der Zeit.
- Terminal/CLI
- sudo
- Texteditoren
- Verzeichnisstruktur
- Dateisystemnavigation
- Dateiberechtigungen
- Man pages
- Dateien/Verzeichnisse erstellen
- Sonstiges (ls, cat, less)
Meilenstein 22. Oktober (Lernbereich, Manpages abgeschlossen)
Erfahrene Linux-Nutzer verfügen über gute Problemlösungsfähigkeiten, die sie im Laufe der Zeit erwerben. Wenn ein Problem auftritt, suchen sie automatisch nach einer Lösung und suchen so lange, bis sie eine Antwort finden oder alle möglichen Ressourcen ausgeschöpft sind. Wenn ein neuer Linux-Nutzer auf ein Problem stößt, öffnet er automatisch eine Supportanfrage. Es ist wichtig, dass gute Praktiken von Anfang an gefördert werden.
Vorlage zur Problemlösung : Nutzer haben eine höhere Wahrscheinlichkeit, Probleme zu beheben, wenn sie einer Schritt-für-Schritt-Anleitung folgen. Hier geht es darum, wie man relevante Informationen sammelt und wie man diese Informationen nutzt, um eine Lösung für das Problem zu finden. Das wird ähnlich sein.
Monitoring von Protokolldateien: Speicherort von Systemprotokollen (Verwendungszweck) und Befehle, die erforderlich sind, um die CLI-Ausgabe einzugrenzen. (journalctl, dmesg usw.)
systemd: Status, Starten und Beenden von Diensten.
Häufige Probleme beheben: Verbindungsprobleme, beschädigte Softwarepakete usw.
Richtlinien für die Meldung von Fehlern und/oder Problemen.
Meilenstein 5. November (Lernbereich, Problemlösung abgeschlossen)
Der Rest des Summer of Docs wird auf die Umgestaltung der Whonix-Dokumentation für Hardened Debian und die Qualitätskontrolle konzentriert.
Whonix-Dokumentation für die Verwendung mit Hardened Debian umgestalten
- Software sicher installieren.
- Betriebssystemupdates