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