快速开始

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 时序）见商城内的「完整文档」。