快速入門
快速入門
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、狀態頁客製化、通知範本)見商城內的「完整文件」。