Na tej stronie znajdziesz szczegóły projektu dotyczącego pisania tekstów technicznych, który został zaakceptowany w ramach programu Google Season of Docs.
Podsumowanie projektu
- Organizacja open source:
- Whonix
- Pisarz techniczny:
- 0brand
- Nazwa projektu:
- Dokumentacja instalacji i konfiguracji nowej dystrybucji Linuksa Hardened Debian, która jest zorientowana na bezpieczeństwo.
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Hardened Debian to nowa dystrybucja Linuksa zorientowana na bezpieczeństwo, która jest aktywnie rozwijana przez deweloperów Whonix. Ten projekt dokumentuje instalację i konfigurację Hardened Debian w systemie Windows/VirtualBox od podstaw. Skupia się na przekazaniu początkującym użytkownikom Linuksa umiejętności, które pozwolą im samodzielnie korzystać z dystrybucji Linuksa.
Cele projektu
Utworzenie podstawowej dokumentacji
Początkowa faza tego projektu będzie się koncentrować na podstawowej dokumentacji Hardened Debian. Będzie ona obejmować kompleksowe omówienie projektu, samouczki dotyczące instalacji i konfiguracji Hardened Debian oraz porady i wskazówki dotyczące konfiguracji po instalacji.
Utworzenie obszarów szkoleniowych dla nowych użytkowników Linuksa
Uczenie nowych użytkowników Linuksa nie polega na napisaniu kilku stron podręcznika i nazwaniu ich obszarem edukacyjnym. Wielu początkujących użytkowników nie jest przyzwyczajonych do interakcji z wierszem poleceń i samodzielnego rozwiązywania problemów. Te strony będą się koncentrować na umiejętnościach związanych z wierszem poleceń, praktycznym rozwiązywaniu problemów i sprawdzonych metodach rozwiązywania problemów.
Wyraźne oddzielenie dokumentacji Hardened Debian od dokumentacji Whonix (system operacyjny zapewniający anonimowość):
Chociaż witryna Whonix.org będzie zawierać informacje zarówno o Whonix, jak i Hardened Debian, każdy z tych systemów operacyjnych ma bardzo różne przypadki użycia, co może prowadzić do poważnych konsekwencji, jeśli użytkownik pomyli jeden z nich z drugim. Na przykład Whonix jest dobrze znany z anonimowości, ale nowy użytkownik, który nie zna Whonix, może skonfigurować Hardened Debian i założyć, że surfuje po internecie anonimowo. Aby zapobiec takim błędom, dokumentacja Hardened Debian będzie ograniczona do oddzielnego obszaru witryny Whonix.org, w którym będzie używany nowy styl formatowania przypominający książkę, odmienny od stylu formatowania dokumentacji systemu operacyjnego Whonix. W kluczowych obszarach, takich jak strona pobierania Hardened Debian, będą też umieszczane ostrzeżenia, aby zapobiec popełnianiu tych błędów przez użytkowników.
Dokumentacja przyjazna dla użytkownika
Instalacja i konfiguracja dystrybucji Linuksa może być trudna nawet dla doświadczonych użytkowników. Chociaż łatwy w użyciu i intuicyjny interfejs użytkownika może poprawić komfort użytkowania, równie ważne jest napisanie jasnej i łatwej do zrozumienia dokumentacji – przyjaznej dla użytkownika. Ponieważ baza użytkowników Hardened Debian obejmuje zarówno początkujących, jak i zaawansowanych użytkowników Linuksa, należy zadbać o to, aby dokumentacja nie była pisana wyłącznie na podstawie wiedzy technicznej i zrozumienia pisarza technicznego. Zamiast tego Hardened Debian będzie dokumentowany z perspektywy początkującego użytkownika Linuksa, który może mieć trudności z wykonywaniem zadań, które doświadczeni użytkownicy uważają za proste i łatwe do wykonania.
Zachęcanie do zaangażowania i udziału społeczności
Hardened Debian to trudny projekt, który można w całości zrealizować tylko wtedy, gdy społeczność będzie zaangażowana przez cały czas trwania projektu. Członkowie społeczności będą zaangażowani tylko wtedy, gdy ich opinie spotkają się z entuzjazmem, a ich dobre pomysły zostaną wykorzystane do ulepszenia dokumentacji. Przez cały okres trwania programu GSoD będę aktywny na forum Whonix, zachęcając społeczność do przekazywania opinii i udziału w ulepszaniu dokumentacji.
Zmiana nazwy systemu operacyjnego Hardened Debian
Chociaż ten system operacyjny jest oparty na Hardened Debian, należy znaleźć nową nazwę, aby uniknąć naruszenia znaku towarowego. Aby osiągnąć ten cel, społeczność Whonix będzie zachęcana do przesyłania chwytliwych nazw, z których deweloperzy Whonix będą mogli wybrać odpowiednią. Chociaż nadal trwa burza mózgów, moje 2 najlepsze propozycje to „Sentient Linux” i „Sentinel Linux”.
Oś czasu projektu
Oś czasu tego projektu zostanie podzielona na 7 mini-kamieni milowych, które można wykorzystać do oceny postępów i wprowadzenia zmian, aby zapewnić terminowe ukończenie każdej sekcji. Jeśli w dowolnym momencie programu Season of Docs pojawią się trudności, natychmiast powiadomię o tym mentora, aby można było opracować plan działania w celu rozwiązania problemu.
2 września ( rozpoczęcie projektu Season of Docs)
Na stronie głównej znajdzie się omówienie Hardened Debian z wyszczególnieniem kluczowych punktów systemu operacyjnego.
Początkowa dokumentacja będzie obejmować instalację Hardened Debian w systemie Windows/VirtualBox. Ograniczy to początkowy zakres tego rozdziału. Członkowie społeczności będą jednak zachęcani do testowania Hardened Debian na hostach z Linuksem oraz na hipernadzorcy KVM i dokumentowania swoich ustaleń.
Tabela ze szczegółowymi informacjami o obsługiwanych systemach operacyjnych hosta
Tabela ze szczegółowymi informacjami o wymaganiach sprzętowych.
- Wymagania minimalne
- Zalecane
- Aby uzyskać najlepszą wydajność
Treść będzie obejmować omówienie celów rozwojowych i zastosowań Hardened Debian, a następnie tabelę z wyszczególnieniem poszczególnych komponentów.
Cele Hardened Debian.
- Dystrybucja Linuksa zorientowana na bezpieczeństwo
- Bezpłatna i open source
- Konfigurowana przez użytkownika
- Domyślnie wzmocniona
Tabela komponentów, z których składa się Hardened Debian.
- Hipernadzorca VirtualBox
- Windows
- System operacyjny oparty na Hardened Debian
- Terminologia (host, maszyna wirtualna, system operacyjny gościa itp.)
Hardened Debian jest domyślnie skonfigurowany z wieloma zaawansowanymi funkcjami zabezpieczeń. Eliminuje to konieczność ręcznego konfigurowania często skomplikowanych ustawień przez użytkowników. Wszystkie ulepszenia zabezpieczeń zostaną szczegółowo opisane w tabeli z krótkim wyjaśnieniem korzyści.
- Haveged jest domyślnie zainstalowany, aby zapewnić lepszą entropię.
- Zamiast NTP używany jest bezpieczny rozproszony protokół synchronizacji czasu (sdwdate).
- Wyłącza podgląd w Dolphin i Nautilus.
- Wyłącza sygnatury czasowe TCP i pomocnika śledzenia połączeń Netfilter.
- open-link-confirmation.
- Apparmor jest domyślnie włączony z profilami.
- Przeglądarka o wzmocnionych zabezpieczeniach (Tor Browser bez Tor).
Ulepszone jądro Linuksa.
Środowisko graficzne: KDE (dostępne tylko w wierszu poleceń).
Inne…
Kamień milowy 15 września (wymagania systemowe, funkcje i zalety, projekty i cele)
Strona z najczęstszymi pytaniami będzie służyć do odpowiadania na pytania często zadawane przez członków społeczności. Treść będzie dodawana w razie potrzeby przez cały czas trwania projektu.
Pobieranie i instalacja Hardened Debian będzie obejmować te czynności:
- Tabela pobierania, która zawiera obraz Hardened Debian, podpis OpenGPG, skrót sha512 i klucz podpisywania GPG deweloperów.
- Weryfikacja klucza podpisywania deweloperów i obrazu systemu operacyjnego (samouczek).
- Pobieranie i weryfikacja hipernadzorcy VirtualBox (samouczek).
- Importowanie Hardened Debian do VirtualBox (samouczek).
- Uruchamianie Hardened Debian.
Kamień milowy 29 września (pobieranie i weryfikacja obrazów Debiana, instalacja Debiana)
Użytkownicy mogą nie znać kroków potrzebnych do dostosowania środowiska graficznego i przydzielenia zasobów systemowych. Wskazówki dotyczące szybkiej konfiguracji zostaną udokumentowane dla każdego z tych elementów:
- Zmiana układu klawiatury.
- Przydzielanie dodatkowych zasobów systemowych (pamięci RAM).
- Zmiana rozdzielczości ekranu.
- Skróty na pulpicie.
- Menedżer stylu okien.
Błędy i problemy znalezione podczas testowania systemu operacyjnego i samouczków zostaną wyraźnie udokumentowane wraz z obejściami lub poprawkami. Ta strona będzie też zawierać informacje o problemach, które często występują podczas uruchamiania systemów operacyjnych w hipernadzorcach.
- Problemy z małą ilością pamięci RAM.
- Nieprawidłowa konfiguracja BIOS-u (Intel VT-d, AMD-V).
- Problemy z łącznością.
Kamień milowy 6 października (pierwsze kroki, błędy Hardened Debian)
Nowi użytkownicy mogą nie znać terminali/wiersza poleceń Linuksa. Jeśli potrzebne im informacje nie są łatwe do znalezienia lub dostępne, otworzą zgłoszenie do pomocy, nawet nie próbując znaleźć rozwiązania. Ta sekcja będzie zawierać informacje o często używanych poleceniach i praktycznej składni poleceń. Każda strona podręcznika będzie zawierać krótki opis polecenia, sposób jego użycia oraz praktyczne przykłady.man Użytkownicy potrzebują trochę czasu, aby zapamiętać polecenia, których muszą używać do różnych zadań. Dzięki powtarzaniu użytkownicy z czasem zapamiętają składnię poleceń.
- Terminal/wiersz poleceń.
- sudo
- Edytory tekstu.
- Struktura katalogu.
- Nawigacja w systemie plików.
- Uprawnienia do plików.
- Strony podręcznika.
- Tworzenie plików i katalogów.
- Różne (ls, cat, less).
Kamień milowy 22 października (obszar szkoleniowy, strony podręcznika)
Doświadczeni użytkownicy Linuksa mają dobre umiejętności rozwiązywania problemów, które zdobywają z czasem. Gdy pojawi się problem, automatycznie zaczynają szukać rozwiązania i kontynuują wyszukiwanie, dopóki nie znajdą odpowiedzi lub nie wyczerpią wszystkich możliwych zasobów. Gdy nowy użytkownik Linuksa napotka problem, automatycznie otwiera zgłoszenie do pomocy. Ważne jest, aby od samego początku utrwalać dobre praktyki.
Szablon rozwiązywania problemów : użytkownicy mają większe szanse na rozwiązanie problemu, jeśli będą postępować zgodnie z instrukcjami krok po kroku. Ta sekcja będzie się koncentrować na tym, jak zbierać odpowiednie informacje i jak ich używać do znajdowania rozwiązania problemu. Będzie to podobne.
Monitorowanie plików dziennika: lokalizacja dzienników systemowych (do czego służy każdy z nich) i polecenia potrzebne do zawężenia danych wyjściowych wiersza poleceń. (journalctl, dmesg itp.).
systemd: stan, uruchamianie i zatrzymywanie usług.
Rozwiązywanie typowych problemów: problemy z połączeniem, uszkodzone pakiety oprogramowania itp.
Wytyczne dotyczące zgłaszania błędów lub problemów.
Kamień milowy 5 listopada (obszar szkoleniowy, rozwiązywanie problemów)
Pozostała część programu Summer of Docs będzie się koncentrować na refaktoryzacji dokumentacji Whonix na potrzeby Hardened Debian i kontroli jakości.
Refaktoryzacja dokumentacji Whonix na potrzeby Hardened Debian
- Bezpieczna instalacja oprogramowania.
- Aktualizacje systemu operacyjnego.