README

Craft CMS 3 的更新检查插件

自动更新检查器，通知您任何待更新内容。

支持开源

此插件采用MIT许可证，这意味着它是一个完全免费的开放源代码软件，您可以随意使用。如果您觉得这个插件很有用，请考虑通过给我买一杯啤酒来支持我的工作 🍻😊

要求

此插件需要Craft CMS 3.0.0或更高版本。

安装

要安装此插件，可以通过插件商店安装或遵循以下说明。

打开您的终端并转到您的Craft项目
```
 cd /path/to/project
```

然后让Composer加载插件

 composer require lukeyouell/craft-updatechecker

在控制面板中，转到设置 → 插件，并点击“安装”按钮以安装更新检查器。

通知方法

您可以从以下组合通知方法中选择

电子邮件

将发送电子邮件到以逗号分隔的电子邮件地址列表。

Slack

通知将被发送到您选择的Slack频道。

这需要创建一个Slack Webhook，您可以在这里完成。

端点

端点URL

您可以在插件设置页面找到您的端点URL，看起来如下所示

https://www.yoursite.co.uk/actions/update-checker/check

保护您的端点

您可以使用在插件设置中设置的访问密钥来保护您的端点。

在定义了访问密钥后，您需要在请求中包含以下头信息

头部名称	头部值
`访问密钥`	`access-key-value`

定时任务

更新检查器依赖于定期触发的端点，这需要定时任务。如果您不熟悉设置定时任务，我强烈推荐使用SetCronJob等服务。

HTTP请求头部

头部名称	头部值	必需
`Accept`	`application/json`	必需
`访问密钥`	`access-key-value`	可选

您可以自由设置定时任务，以检查更新的频率。

覆盖插件设置

如果您在 config 文件夹中创建一个名为 update-checker.php 的配置文件，则可以覆盖控制面板中的插件设置。由于该配置文件完全支持多环境，因此这是在不同环境中使用不同设置的一个方便方法。

以下是该配置文件可能的样子以及您可以覆盖的所有可能值列表。

<?php

return [
    'accessKey' => '6AIXCV7FoF5pvN4BiNE9xANtFUcy3CUr',
    'email' => true,
    'toEmail' => 'joe.bloggs@email.co.uk, jane.bloggs@email.co.uk',
    'slack' => true,
    'slackWebhook' => 'https://hooks.slack.com/services/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w',
];

更新检查器路线图

一些待办事项和潜在功能的想法

定义要发布更新到的 Slack 频道的功能

由 Luke Youell 提供

lukeyouell / craft-updatechecker

维护者

详细信息