README

客户端库

此模块旨在与监控服务器系统协同工作。然而，它也可以作为安装在其上的网站上的独立信息页面运行。
没有配置，一个简单的报告屏幕被添加到网站配置中，以便可以在CMS中查看包含模块的值。

监控系统集成

通过添加以下环境变量，可以将系统集成到监控服务器系统以提供集中式报告（有关更多信息，请参阅服务器存储库）

MONITORING_ENC_SECRET
MONITORING_ENC_SALT
MONITORING_API_KEY
MONITORING_VALID_IP

除了有效的IP值外，上述所有变量将由服务器系统在添加客户端时生成。这些变量确保客户端与服务器之间的通信加密。

如果设置，有效的IP变量将限制对监控系统的访问仅限于指定的地址。IP地址可以指定为单个地址或CIDR表示法。

监控客户端对报告路由的传入请求实现了速率限制，以帮助减轻暴力攻击或DoS攻击。客户端软件每分钟最多允许1次请求。

包含的报告模块

系统附带一组默认报告模块

Silverstripe配置

此模块列出了Silverstripe安装的各种参数，包括

站点名称
环境类型
基础URL
默认管理员凭证的存在

系统信息

此模块列出了关于服务器环境的信息，包括

PHP版本
主机IP地址
文件上传限制
脚本最大执行时间
数据库引擎
数据库版本
数据库名称

该模块将尝试使用ipify服务发现客户端的公共IP地址。这可以通过yml配置禁用，例如

---
Name: bbp-client-monitor
---

BiffBangPow\SSMonitor\Client\Module\SystemInfo:
  discover_public_ip: false

此外，该模块可以报告已设置的环境变量的值。这些可以通过向项目中添加yml配置来指定，例如

---
Name: bbp-client-monitor
---

BiffBangPow\SSMonitor\Client\Module\SystemInfo:
  env_variables:
    - APP_SMTP_USERNAME
    - APP_SMTP_PASSWORD
    - CAPTCHA_SITE_KEY
    - CAPTCHA_SECRET_KEY

核心包版本

此模块报告了一组核心包的安装版本。此报告中包含的包在默认yml文件中配置，与模块捆绑在一起，但可以按需覆盖，例如

BiffBangPow\SSMonitor\Client\Module\CorePackageVersions:
  included_modules:
    - 'silverstripe/framework'
    - 'silverstripe/cms'
    - 'dnadesign/silverstripe-elemental'
    - 'biffbangpow/silverstripe-monitoring-client'

所有包版本

此模块列出了系统上安装的所有由composer管理的包。

biffbangpow / silverstripe-monitoring-client

维护者

详细信息