快速开始
快速开始
Incident Commander 给 WHMCS 加一层完整的事件(incident)管理工作流:声明事件 / 实时更新 / 通知客户 / 维护窗口 / 事后复盘。本指南覆盖安装、第一条事件、Pro 端通知/复盘。
适用对象:WHMCS 主机商,需要给客户呈现服务可用性透明度。
1. 安装与启用
- 下载 ZIP 并解压到 WHMCS 根目录。
- WHMCS 后台 → Setup → Apps & Integrations → Incident Commander → Activate。
- Configuration → Addon Modules → 勾选 admin role + license key + 保存。
- Addons → Incident Commander 进入控制台。
2. 8 页面后台
- 仪表盘:当前整体状态(operational / degraded / major_outage)+ 最近事件 5 条
- 组件:定义你的服务组件(API、Web、DB、Email...)每个组件有独立状态
- 事件列表:所有事件分页表
- 事件详情:单一事件的时间线、状态更新、通知发送记录
- 维护:计划维护窗口(提前通知 + 自动开始/结束)
- 通知:邮件/webhook 收件人配置(Pro)
- 复盘:post-mortem 报告(Pro)— RCA / 时间线 / 改进项
- 设置:状态页、品牌、retention
3. 创建第一条事件
「事件列表」→「新建事件」:
- 标题 + 严重级别(minor / major / critical)
- 受影响组件(多选)
- 描述
- 保存即记录在
mod_incident_commander_incidents,触发通知
事件创建后进「详情页」→ 不断「Post Update」推进状态:identified / investigating / monitoring / resolved。
4. 状态页同步
每次事件状态更新自动写入「状态页」(公开 URL,客户可看到):
- 显示当前 4 个组件状态
- 历史 90 天事件
- RSS / Atom 订阅(Pro)
5. 通知(Pro)
「通知」页:
- 邮件:选择收件人列表(按组件订阅 / 按 client / 全员)
- Webhook:每次事件状态变更 POST JSON 到外部
- Slack incoming webhook
- Status page badge 自动更新
6. 维护窗口
「维护」页:
- 创建未来维护(开始 / 结束时间 + 受影响组件 + 说明)
- 提前 24/12/1 小时自动通知客户
- 维护期间组件状态自动设为 "under_maintenance"
- 结束后状态恢复
7. 事后复盘(Pro)
每条 resolved 事件可以创建复盘报告:
- RCA(根本原因分析)
- 时间线(机器可读 ISO 时间戳 + 事件描述)
- 影响(受影响客户数、停机时长)
- 改进项 follow-up
复盘报告可对外公开 URL 或仅内部。
8. 自动更新
Dashboard 「检查更新」面板拉最新版本号,「安装更新」走 WHMCS 标准更新流程。
更多深入文档(API endpoint、状态页定制、通知模板)见商城内的「完整文档」。