快速入門

Service Status 為 WHMCS 提供面向客戶的公開狀態頁 + 後台事件管理 + Pro 端自動監控。本指南帶您 10 分鐘把狀態頁跑起來。

1. 安裝與啟用

1. 下載與 PHP 版本相符的 ZIP（如 service_status_v1.x.x_php8.1.zip）解壓到 WHMCS 根目錄。
2. WHMCS 後台：Setup → Apps & Integrations → Service Status → Activate。
3. 進入 Configuration → Addon Modules → Service Status → 設定： - 勾選允許存取的管理員角色 - 貼上 license key（僅 Pro 功能需要） - 儲存

啟用後頂部選單 Addons → Service Status 即為後台入口；公開頁地址預設為 https://yourdomain.com/index.php?m=service_status（頁面 slug 可在 Settings 頁修改）。

2. 新增第一個服務

後台「服務」（Services）頁面：

1. 點 Add Service → 填名稱（如「Web Hosting」）、選用分組（Web / Email / VPS 等）。
2. 選擇初始狀態（預設 Operational）。
3. 儲存。該服務立即出現在公開頁。

按相同步驟繼續新增您想暴露給客戶的服務條目。

3. 報告事件

某項服務出問題時，後台「事件」（Incidents）頁：

1. 點 Create Incident → 填標題、影響的服務（多選）、初始狀態（Investigating / Identified / Monitoring / Resolved）。
2. 寫第一條 Update（建議描述目前症狀與下一步動作）。
3. 提交後公開頁立即顯示「正在調查」。

後續進展用同一事件下的 Add Update 追加時間線條目；狀態切到 Resolved 時事件歸檔。

4. 計劃維護

Maintenance 頁與事件類似，但有起訖時間：

1. 點 Schedule Maintenance → 選影響服務、起訖時間、描述。
2. 公開頁會在該時間段顯示「計劃維護中」。
3. 時間到達後 hooks.php 內的 cron 自動切換狀態（要求 WHMCS cron 正常運行）。

5. 自動監控（Pro）

Pro license 啟用後服務編輯頁解鎖監控：

• HTTP — 輸入 URL，可設期望狀態碼與正文關鍵字
• TCP — host:port 探測
• ICMP — ping（要求 WHMCS 伺服器允許 ICMP）

監控間隔預設 5 分鐘，由 hooks.php 的 cron 觸發。監控失敗時自動建立事件並通知訂閱者。

6. 通知與訂閱（Pro）

Notifications 頁可設定：

• Email subscribers：內部告警郵箱列表
• Webhook endpoints：POST JSON payload 到 Slack / Discord / 自建系統
• 公開訂閱：客戶在公開頁留電子郵件，通過雙重確認後接收事件通知

每個訂閱者可單獨篩選事件類型（incidents / maintenance / monitor down 等）。

7. REST API（Pro）

Pro 解鎖唯讀 API（帶內建文件）：

• GET /index.php?m=service_status&action=api&endpoint=services — 服務列表
• GET ...&endpoint=incidents&status=open — 目前事件
• API key 在 Settings 頁產生；要求 X-API-Key header

完整文件在 Settings → REST API 頁。

8. 常見問題

Q：公開頁顯示 404？ A：檢查 Settings 頁的 page_slug 是否已設定（首次啟用會自動寫 index.php 路由 hook）；如未生效，重新 Save Settings 一次。

Q：監控不觸發？ A：確認 WHMCS cron 在跑（crontab -l | grep cron.php），且 hooks.php 已被 WHMCS 載入（addon 啟用即載入）。

Q：能否多語言？ A：外掛後台支援英 / 簡中 / 繁中，按 admin 目前語言渲染。公開頁跟隨 WHMCS 站點語言。

更多深入文件（架構、API 全欄位、cron 時序）見商城內的「完整文件」。