本页包含已获 Google 文档季 计划接受的技术写作项目的详细信息。
项目摘要
- 开源组织:
- Whonix
- 技术文档工程师:
- 0brand
- 项目名称:
- 记录以安全为中心的新型强化 Debian Linux 发行版的安装和设置。
- 项目时长:
- 标准时长(3 个月)
Project description
Hardened Debian 是一个以安全性为中心的新 Linux 发行版,目前正由 Whonix 开发者积极开发。此项目从头开始记录了在 Windows/VirtualBox 中安装和设置强化版 Debian 的过程,重点在于让初次使用 Linux 的用户掌握在 Linux 发行版中独立操作所需的技能。
项目目标
创建核心文档
此项目的初始阶段将重点关注 Hardened Debian 的核心文档。其中包括全面的项目概览、安装和设置强化版 Debian 的教程,以及安装后建议和提示。
为新的 Linux 用户创建学习区
教导新的 Linux 用户并非只是编写一些手册页,然后就称之为教育领域。许多初学者不习惯与命令提示符互动,也不习惯自行排查问题。这些页面将重点介绍 CLI 技能、实用问题解决技巧和问题排查最佳实践。
清晰区分强化版 Debian 与 Whonix(匿名操作系统)文档:
虽然 Whonix.org 将同时托管 Whonix 和 Hardened Debian,但这两个操作系统有非常不同的使用场景,如果用户混淆了两者,可能会导致严重后果。例如,Whonix 以匿名性而闻名,但对 Whonix 不熟悉的新用户可能会设置强化版 Debian,并认为自己是在匿名浏览网页。为防止此类错误,Hardened Debian 文档将限制在 Whonix.org 的单独区域内,并使用与 Whonix 操作系统文档格式不同的全新图书式格式。我们还会在关键区域(例如 Hardened Debian 下载页面)中添加警告,以防止用户犯下这些错误。
便于用户使用的文档
即使对于经验丰富的用户来说,安装和设置 Linux 发行版也可能是一项艰巨的任务。虽然易于使用且直观的界面可以提升用户体验,但编写清晰易懂的用户友好型文档也同样重要。由于 Hardened Debian 用户群涵盖了从初学者到高级 Linux 用户的广泛范围,因此必须注意,文档的编写不能仅基于技术撰稿人的专业知识和理解。相反,Hardened Debian 将从 Linux 初学者的角度进行记录,这些初学者可能难以完成经验丰富的用户认为简单且容易完成的任务。
鼓励社区参与/贡献
强化版 Debian 是一项极具挑战性的项目,只有确保社区在整个项目期间保持参与,才能完全完成该项目。只有当社区成员的反馈得到热烈响应,并且他们的好点子被用于改进文档时,他们才会继续参与进来。在整个 GSoD 期间,我将继续积极参与 Whonix 论坛,鼓励社区提供反馈和贡献,以改进文档。
重命名了强化版 Debian 操作系统
虽然此操作系统基于安全强化型 Debian,但必须找到一个新名称,以免违反商标侵权规定。为了实现这一目标,我们将鼓励 Whonix 社区提交朗朗上口的名称,供 Whonix 开发者选择。虽然我仍处于头脑风暴模式,但我的前两个选择是“Sentient Linux”和“Sentinel Linux”。
项目时间表
此项目的时间表将分为 7 个小型里程碑,可用于衡量进度并进行调整,以确保每个部分都能按时完成。如果我在文档季期间遇到任何困难,会立即通知我的导师,以便制定行动方案来解决问题。
9 月 2 日(开始文档季项目)
首页将提供 Hardened Debian 的概览,详细说明该操作系统的关键点。
初始文档将包含在 Windows/VirtualBox 中安装 Hardened Debian 的相关信息。这会限制本章的初始范围。不过,我们鼓励社区成员在 Linux 主机以及 KVM Hypervisor 中测试 Hardened Debian,并记录他们的发现。
详细说明了支持的主机操作
详细说明硬件要求的表格。
- 最低要求
- 推荐
- 为了获得最佳性能
内容将包含一个概述,详细说明 Hardened Debian 的开发目标和用途,然后是一个概述各个组件的表格。
Hardened Debian 的目标。
- 注重安全的 Linux 发行版
- 免费且开源
- 用户可配置
- 默认强化
构成强化版 Debian 的组件表。
- VirtualBox Hypervisor
- Windows
- 安全强化型基于 Debian 的操作系统
- 术语(宿主、虚拟机、客户机操作系统等)
安全强化版 Debian 默认配置了许多高级安全功能。这样一来,用户就不必费力处理通常很复杂的配置。所有安全增强功能都将详细列在一张表格中,并附有简要的优势说明。
- 默认安装了 Haveged,以提高熵。
- 使用安全分布式网络时间同步 (sdwdate) 而不是保险 NTP。
- 停用 Dolphin、Nautilus 中的预览。
- 停用 TCP 时间戳和 Netfilter 的连接跟踪帮助程序。
- open-link-confirmation.
- 默认情况下,Apparmor 已启用并带有配置文件。
- 安全强化型浏览器(不含 Tor 的 Tor 浏览器)
改进的 Linux 内核
桌面环境;KDE(仅在 CLI 中提供)。
其他…
里程碑 9 月 15 日(完成系统要求、功能和优势、设计和目标)
“常见问题解答”页面将用于回答社区成员经常提出的问题。在整个项目期间,我们会根据需要添加内容。
下载和安装强化版 Debian 将包含以下步骤。
- 下载表,其中包含强化版 Debian 映像、OpenGPG 签名、sha512 哈希和开发者 GPG 签名密钥。
- 验证开发者签名密钥和操作系统映像(教程)。
- 下载和验证 VirtualBox Hypervisor(教程)。
- 在 VirtualBox 中导入强化版 Debian(教程)
- 启动强化版 Debian
里程碑 9 月 29 日(完成下载并验证 Debian 映像、Debian 安装)
用户可能不熟悉自定义桌面环境和分配系统资源所需的步骤。我们将针对以下各项记录“快速配置”提示。
- 更改键盘布局
- 分配额外的系统资源 (RAM)
- 更改屏幕分辨率
- 桌面快捷方式
- 窗口样式管理器
在测试操作系统和教程期间发现的 bug 和问题将清楚地记录下来,并提供相应的解决方法和/或修复。本页还将介绍在虚拟机监控程序中运行操作系统时遇到的常见问题。
- 低 RAM 问题
- BIOS 配置错误(Intel VT-d、AMD-V)
- 连接问题
里程碑 10 月 6 日(完成第一步,强化 Debian bug)
新用户可能不熟悉 Linux 终端/CLI。如果他们需要的信息不易查找或访问,他们最终会直接提交支持请求,而不会尝试寻找解决方案。本部分将介绍常用命令和实用的命令语法。每个 man 都会简要介绍相应命令、如何使用该命令以及实用示例。用户需要一段时间才能记住必须使用哪些命令来完成不同的任务。通过重复练习,用户会逐渐记住命令语法。
- 终端/CLI
- sudo(提权)
- 文本编辑器
- 目录结构
- 文件系统导航
- 文件权限
- man 页面
- 创建文件/目录
- 其他(ls、cat、less)
里程碑 10 月 22 日(完成学习区、man 页面)
经验丰富的 Linux 用户具备良好的问题解决能力,这是他们随着时间的推移而获得的。当出现问题时,他们会自动开始寻找解决方案,并不断搜索,直到找到答案或所有可能的资源都已用尽。当新的 Linux 用户遇到问题时,系统会自动打开支持请求。从一开始就强化良好实践至关重要。
问题解决模板:如果用户按照分步说明进行问题排查,则更有可能成功解决问题。本课程将重点介绍如何收集相关信息,以及如何利用这些信息找到问题的解决方案。这会很相似。
监控日志文件:系统日志的位置(每种日志的用途)以及缩小 CLI 输出范围所需的命令。(journalctl、dmesg 等)
systemd:状态、启动和停止服务。
排查常见问题:连接问题、损坏的软件包等
bug 和/或问题报告准则。
里程碑 11 月 5 日(完成学习领域、问题解决)
在 Summer of Docs 的剩余时间里,我将专注于为 Hardened Debian 重构 Whonix 文档,并进行质量控制。
重构了 Whonix 文档,以便与强化版 Debian 搭配使用
- 安全地安装软件。
- 操作系统更新