dknauss/wordpress-runbook-template

GitHub: dknauss/wordpress-runbook-template

一份 WordPress 运维手册模板,提供部署、维护、备份、事件响应和灾难恢复的标准化流程文档框架。

Stars: 3 | Forks: 0

# WordPress 运维手册模板 这是一份为运行于标准 LEMP (Nginx) 或 LAMP (Apache) 技术栈的 WordPress 站点准备的综合运维手册模板。本模板提供了创建针对特定站点手册的结构和流程 —— 填入您的配置详情,移除不适用的部分,重命名/替换 [TEMPLATE/CUSTOMIZE] 标记,即可为您的团队提供一份完整的运维参考文档。 注意:版本历史表(§1.4)和变更日志(附录 C)是指本文档作为模板的历史。请重置/删除此信息,并在您的运维文档中添加您自己的修订历史。 ## 文档目的 这是一个用于创建**运维参考**的模板和模型 —— 它回答了针对特定 WordPress 安装的**“我该如何做?”**这一问题。 每个流程都包含编号步骤、预期结果、回滚说明以及可复制粘贴的代码。目标读者是正在响应事件、部署更新或搭建新环境,并需要确切命令和配置以供遵循的系统管理员或工程师。 本文档**不是**审计清单(请使用 [Security Benchmark](https://github.com/dknauss/wp-security-benchmark)),**不是**架构指南(请使用 [Hardening Guide](https://github.com/dknauss/wp-security-hardening-guide)),也**不是**写作参考(请使用 [Style Guide](https://github.com/dknauss/wp-security-style-guide))。 ## 读者对象 本模板面向负责 WordPress 部署正常运行时间、安全和运维完整性的系统管理员、DevOps 工程师、站点可靠性团队和 WordPress 开发人员。它假设环境为自托管或基于 VPS 且具有服务器级访问权限,尽管大部分内容也适用于任何 WordPress 安装。 该模板旨在针对单个 WordPress 站点或实例进行调整。管理多个站点的组织应为每个环境创建单独的手册,因为服务器配置、凭据、上报联系人和恢复流程因部署而异。 ## 包含内容 手册模板提供四种格式: | 文件 | 格式 | 最适用于 | |------|--------|----------| | `WP-Operations-Runbook.md` | Markdown | Git 仓库、Wiki、版本控制文档 | | `WP-Operations-Runbook.docx` | Microsoft Word | 企业内网、SharePoint、协同编辑 | | `WP-Operations-Runbook.epub` | EPUB | 电子书阅读器 | | `WP-Operations-Runbook.pdf` | PDF | 打印、只读分发、归档 | 构建流水线:`WP-Operations-Runbook.md` -> `WP-Operations-Runbook.docx` -> `WP-Operations-Runbook.pdf` 和 `WP-Operations-Runbook.epub`。 所有文档均包含相同的内容,组织为 11 个章节及附录: 1. **文档信息** —— 所有权、读者、文档约定 2. **站点概览** —— 站点标识、凭据库、团队联系人 3. **环境参考** —— LEMP/LAMP 架构、服务路径、缓存层、SSL/TLS 配置 4. **开发工作流** —— 版本控制、Staging 环境、Staging 到生产环境的同步 5. **安全加固** —— 防火墙配置、SSH 访问、WordPress 应用加固、HTTP 安全标头、REST API 限制 6. **日常维护** —— 更新日历、Core/Plugin/Theme 更新、数据库优化、PHP 升级、WP-Cron 配置、事务性邮件、日志轮转、正常运行时间监控 7. **备份流程** —— 备份策略、验证、恢复测试 8. **部署流程** —— 代码部署、数据库迁移、回滚流程 9. **内容操作** —— 媒体管理(包括 WebP)、编辑工作流、固定链接、搜索配置 10. **事件响应** —— 严重性分类、站点宕机诊断、安全漏洞响应、上报路径、事件后审查、性能故障排查 11. **灾难恢复** —— RTO/RPO 目标、全站恢复、数据库恢复、服务器迁移 **附录:** 文件权限参考、`wp-config.php` 关键设置、变更日志、已弃用和无效常量防护栏、流程所有权和验证矩阵。 前部的**紧急快速参考卡**提供了常见故障场景的一目了然的诊断步骤。 ## 如何使用此模板 1. **选择您的格式。** 使用 Markdown 文件进行基于 Git 的文档工作流。使用 Word 或 Pages 文件在企业环境中进行协同编辑。使用 PDF 作为打印参考或只读交付。 2. **搜索 `[CUSTOMIZE]` 占位符。** 每个特定于站点的值都以此标记。将每个占位符替换为您的实际配置:服务器地址、域名、文件路径、备份计划、上报联系人和凭据库引用。 3. **移除不适用的部分。** 运行 Nginx?移除 Apache 相关内容。不使用 Multisite?从附录 B 中删除该部分。该模板力求全面 —— 删除不需要的内容比在事件发生时发现缺口要容易得多。 4. **分配所有权并安排审查。** 指定一名负责保持文档更新的手册所有者。每当环境发生变化时更新变更日志(附录 C),并安排季度审查以确保手册反映站点的实际状态。 ## 设计原则 本模板遵循 Atlassian、Google SRE 和 PagerDuty 的行业手册惯例: - 每个流程都包含**编号步骤**、**预期结果**和**时间估算** - 警告和关键说明在视觉上突出显示,以免在压力下被忽视 - 回滚步骤伴随每个变更流程 - 在事件响应工作流中定义了上报路径 - 紧急快速参考卡提供直达正确流程的即时指引 ## 相关:Ops Runbook (Lite) WordPress 插件 对于希望直接在 WordPress Dashboard 中访问运维流程和诊断信息的团队,[Ops Runbook (Lite)](https://wordpress.org/plugins/ops-runbook-lite/) 插件在 `wp-admin` 中提供了三个功能: - **Runbook entries** —— 一种自定义文章类型,包含症状、快速检查、缓解步骤、上报联系人和回滚流程的结构化字段。 - **Incident notes** —— 一种用于事件时间线文档记录和事件后审查的自定义文章类型。 - **Diagnostics page** —— 一个只读状态页面(位于 Tools 下),显示 WordPress 和插件更新状态、WP-Cron 计划任务、磁盘存储指标、数据库大小以及调试日志的尾部。 该插件是对此模板的补充:使用本文档作为综合运维参考,使用该插件在 Dashboard 中快速访问关键流程和系统状态。 ## 相关文档 本手册是从不同角度涵盖 WordPress 安全的四份互补文档之一: | 文档 | 目的 | |---|---| | **[WordPress Security Benchmark](https://github.com/dknauss/wp-security-benchmark)** | 审计清单 —— “验证什么”。用于合规性验证的规定性、可审计加固控制。 | | **[WordPress Security Hardening Guide](https://github.com/dknauss/wp-security-hardening-guide)** | 顾问指南 —— “实施什么”。专注于企业的安全架构和威胁缓解。 | | **[WordPress Security Style Guide](https://github.com/dknauss/wp-security-style-guide)** | 编辑指南 —— “如何撰写”。用于安全沟通的术语、语调和格式约定。 | ## AI 辅助编辑流程 本文档及本系列中的三份相关文档是在前沿 LLM 的协助下修订的。多个模型依据 WordPress Advanced Administration Handbook 作为主要权威,独立审查所有四份文档是否存在事实错误、过时指导和跨文档不一致之处。人类编辑在应用每项建议更改之前进行审查、批准或拒绝。有关完整方法论,请参阅 **[AI-Assisted Documentation Processes](https://github.com/dknauss/ai-assisted-docs)**。机器可读的编辑代理技能和跨文档一致性规则位于 [skills directory](https://github.com/dknauss/ai-assisted-docs/tree/main/wp-docs-skills) 中。 ## 项目健康状况 - 贡献:请参阅 **[CONTRIBUTING.md](CONTRIBUTING.md)**。 - 安全报告:请参阅 **[SECURITY.md](SECURITY.md)**。 - 社区期望:请参阅 **[CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)**。 - 支持边界:请参阅 **[SUPPORT.md](SUPPORT.md)**。 - 许可证:**[LICENSE](LICENSE)**。 ## 许可证 本模板根据 [Creative Commons Attribution-ShareAlike 4.0 International License (CC-BY-SA-4.0)](https://creativecommons.org/licenses/by-sa/4.0/) 授权。您可以出于任何目的(包括商业用途)复制、重新分发、混音、转换和基于本材料进行构建,前提是您给予适当的署名并在相同的许可下分发您的贡献。
标签:Apache, IT运维, LAMP栈, LEMP栈, Linux运维, Nginx, OpenVAS, PB级数据处理, PHP, Runbook, Socks5代理, SRE, Syscall, Web开发, WordPress, 偏差过滤, 安全运维, 开源, 技术文档, 故障排除, 数据备份, 文件完整性监控, 服务器管理, 模板, 灾难恢复, 生产环境, 站点可靠性, 系统管理员, 系统维护, 运维手册, 部署流程, 防御加固