На этой странице представлена информация о проекте по написанию технических текстов, принятом для участия в конкурсе Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- Уникс
- Технический писатель:
- 0brand
- Название проекта:
- Документация по установке и настройке нового, ориентированного на безопасность, защищенного дистрибутива Debian Linux.
- Длительность проекта:
- Стандартная продолжительность (3 месяца)
Описание проекта
Hardened Debian — это новый дистрибутив Linux, ориентированный на безопасность, который активно разрабатывается разработчиками Whonix. В этом проекте описывается установка и настройка Hardened Debian в Windows/VirtualBox с нуля, с акцентом на обучение начинающих пользователей Linux необходимым навыкам для самостоятельной работы с дистрибутивом Linux.
Цели проекта
Создать основную документацию
Начальный этап этого проекта будет сосредоточен на основной документации для Hardened Debian. Она будет включать в себя подробный обзор проекта, руководства по установке и настройке Hardened Debian, а также советы и рекомендации после установки.
Создайте учебные разделы для новых пользователей Linux.
Обучение новых пользователей Linux — это не просто написание нескольких страниц руководства и объявление их образовательным разделом. Многие новички не привыкли взаимодействовать с командной строкой и самостоятельно устранять неполадки. Эти страницы будут посвящены навыкам работы с командной строкой, практическому решению проблем и лучшим практикам устранения неполадок.
Четко разграничьте документацию по защищенной версии Debian и Whonix (анонимной ОС):
Хотя на Whonix.org будут размещены как Whonix, так и Hardened Debian, каждая операционная система имеет совершенно разные сценарии использования, что может привести к серьезным последствиям, если пользователь перепутает одну с другой. Например, Whonix хорошо известен своей анонимностью, но новый пользователь, незнакомый с Whonix, может установить Hardened Debian и предположить, что он анонимно пользуется Интернетом. Чтобы предотвратить подобные ошибки, документация по Hardened Debian будет размещена в отдельном разделе Whonix.org с использованием нового, книжного стиля форматирования, отличающегося от стиля форматирования документации по ОС Whonix. Предупреждения также будут включены в ключевые разделы, такие как страница загрузки Hardened Debian, чтобы предотвратить подобные ошибки.
Удобная для пользователя документация
Установка и настройка дистрибутива Linux могут быть сложными даже для опытных пользователей. Хотя простой и интуитивно понятный пользовательский интерфейс может улучшить пользовательский опыт, не менее важно писать четкую и понятную — удобную для пользователя — документацию. Поскольку пользовательская база Hardened Debian включает в себя как новичков, так и продвинутых пользователей Linux, необходимо позаботиться о том, чтобы документация не писалась исключительно на основе технических знаний и понимания технического автора. Вместо этого документация Hardened Debian будет написана с точки зрения начинающего пользователя Linux, которому может быть сложно выполнять задачи, которые опытные пользователи считают простыми и легко выполнимыми.
Поощряйте участие и вклад в жизнь общества.
Hardened Debian — это сложный проект, который можно полностью завершить только при условии постоянного участия сообщества на протяжении всего его существования. Члены сообщества будут вовлечены только в том случае, если их отзывы будут встречены с энтузиазмом, а их ценные идеи будут использованы для улучшения документации. В течение всего GSoD я буду оставаться активным на форуме Whonix, поощряя как отзывы сообщества, так и вклад в улучшение документации.
Переименовать защищенную ОС Debian
Хотя эта операционная система основана на Hardened Debian, необходимо придумать новое название, чтобы избежать нарушений прав на товарный знак. Для достижения этой цели сообществу Whonix будет предложено представить запоминающиеся названия, из которых разработчики Whonix смогут выбрать. Хотя, пока я еще нахожусь в стадии мозгового штурма, мои два главных варианта — «Sentient Linux» и «Sentinel Linux».
Сроки реализации проекта
График выполнения этого проекта будет разбит на 7 мини-этапов, которые позволят оценить прогресс и внести корректировки для обеспечения своевременного завершения каждого этапа. Если в ходе работы над проектом «Season of Docs» возникнут трудности, я немедленно уведомлю своего наставника, чтобы можно было разработать план действий для решения проблемы.
2 сентября (Начало проекта «Сезон документов»)
На главной странице будет представлен обзор Hardened Debian с подробным описанием ключевых особенностей операционной системы.
Первоначальная документация будет посвящена установке Hardened Debian в Windows/VirtualBox. Это ограничит первоначальный объем данной главы. Однако участникам сообщества будет рекомендовано протестировать Hardened Debian на хостах Linux, а также на гипервизоре KVM и задокументировать свои результаты.
Подробная информация о поддерживаемых операционных системах хоста в таблице.
Таблица с подробным описанием требований к оборудованию.
- Минимальные требования
- Рекомендуется
- Для достижения наилучших результатов
Содержание будет состоять из обзора, подробно описывающего цели разработки и области применения Hardened Debian, за которым последует таблица с описанием каждого отдельного компонента.
Усиленные цели Debian.
- Дистрибутив Linux, ориентированный на безопасность
- Бесплатное программное обеспечение с открытым исходным кодом
- Настраивается пользователем
- По умолчанию повышенная степень защиты.
Таблица компонентов, входящих в состав Hardened Debian.
- гипервизор VirtualBox
- Windows
- Защищенная ОС на основе Debian
- Терминология (хост, виртуальная машина, гостевая ОС и т. д.)
В Debian с расширенными функциями безопасности по умолчанию включено множество дополнительных функций. Это избавляет пользователей от необходимости возиться со сложными настройками. Все улучшения безопасности будут подробно описаны в таблице с кратким объяснением преимуществ.
- Haveged установлен по умолчанию для повышения энтропии.
- Вместо протокола NTP используется защищенная распределенная синхронизация времени по сети (sdwdate).
- Отключает предварительный просмотр в Dolphin и Nautilus.
- Отключает метки времени TCP и вспомогательную функцию отслеживания соединений Netfilter.
- open-link-confirmation.
- AppArmor включен по умолчанию в профилях.
- Защищенный браузер (браузер Tor без Tor)
Улучшенное ядро Linux
Рабочая среда: KDE (доступна только через командную строку).
Другой ...
Этап 15 сентября (Полные системные требования, функции и преимущества, дизайн и цели)
Страница часто задаваемых вопросов (FAQ) будет использоваться для ответов на вопросы, которые часто задают участники сообщества. Контент будет добавляться по мере необходимости на протяжении всего проекта.
Загрузка и установка Hardened Debian будут включать в себя следующие действия.
- В таблице для скачивания содержится защищенный образ Debian, подпись OpenGPG, хеш sha512 и ключ подписи GPG для разработчиков.
- Проверка ключа подписи разработчиков и образа операционной системы (руководство).
- Загрузка и проверка гипервизора VirtualBox (инструкция).
- Импорт усиленной версии Debian в VirtualBox (руководство)
- Запуск защищенной версии Debian
Этап 29 сентября (Завершение загрузки и проверки образов Debian, установка Debian)
Пользователи могут быть незнакомы с шагами, необходимыми для настройки среды рабочего стола и распределения системных ресурсов. Для каждого из следующих пунктов будут приведены краткие советы по настройке.
- Изменение раскладки клавиатуры
- Выделение дополнительных системных ресурсов (ОЗУ)
- Изменить разрешение экрана
- Ярлыки на рабочем столе
- Менеджер стилей окон
Обнаруженные в ходе тестирования ОС и обучающих материалов ошибки и проблемы будут четко документированы, а также будут предложены способы их устранения и/или исправления. На этой странице также будут указаны проблемы, часто встречающиеся при запуске операционных систем в гипервизорах.
- Проблемы с нехваткой оперативной памяти
- Неправильная настройка BIOS (Intel VT-d, AMD-V)
- Проблемы с подключением
Этап 6 октября (Завершены первые шаги, устранены уязвимости Debian)
Новые пользователи могут быть незнакомы с терминалами/командной строкой Linux. Если необходимую информацию трудно найти или она недоступна, они в конечном итоге откроют запрос в службу поддержки, даже не пытаясь найти решение. В этом разделе будут описаны часто используемые команды и практический синтаксис команд. Каждая man будет кратко описана, покажет, как её использовать, и приведет к практическим примерам. Пользователям требуется время, чтобы запомнить команды, которые им нужно использовать для разных задач. Благодаря повторению пользователи со временем запомнят синтаксис команд.
- Терминал/CLI
- судо
- Текстовые редакторы
- Структура каталогов
- Навигация по файловой системе
- Права доступа к файлам
- Справочные страницы
- Создание файлов/каталогов
- Разное (ls, cat, less)
Этап 22 октября (Завершение раздела «Обучение», страницы руководства)
Опытные пользователи Linux обладают хорошими навыками решения проблем, которые они приобретают со временем. Когда возникает проблема, они автоматически начинают искать решение и продолжают поиск, пока не найдут ответ или пока не будут исчерпаны все возможные ресурсы. Когда новый пользователь Linux сталкивается с проблемой, он автоматически открывает запрос в службу поддержки. Крайне важно, чтобы передовые методы работы внедрялись с самого начала.
Шаблон решения проблем: Пользователи с большей вероятностью добьются успеха при устранении неполадок, если будут следовать пошаговым инструкциям. В этом шаблоне основное внимание будет уделено сбору необходимой информации и ее использованию для поиска решения проблемы. Аналогичный подход будет применен и здесь.
Мониторинг файлов журналов: расположение системных журналов (для чего используется каждый из них) и команды, необходимые для сужения вывода командной строки (journalctl, dmesg и т. д.).
systemd: состояние, запуск и остановка служб.
Устранение распространенных проблем: проблемы с подключением, неработающие программные пакеты и т. д.
Рекомендации по сообщению об ошибках и/или проблемах.
Этап 5 ноября (Завершение изучения раздела «Решение проблем»)
Оставшаяся часть «Лета документации» будет посвящена рефакторингу документации Whonix для Hardened Debian и контролю качества.
Переработал документацию Whonix для использования с защищенной версией Debian.
- Устанавливайте программное обеспечение безопасно.
- Обновления операционной системы