README

Craft CMS 3的更新检查器插件

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

支持开源

此插件受MIT许可证的许可，这意味着它是完全免费的开源软件，您可以使用它来做什么和如何使用它。如果您认为这个插件很有用，请考虑通过为我买一杯啤酒来支持我的工作 🍻😊

要求

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

安装

要安装插件，可以通过插件商店安装，或者按照以下说明操作。

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

然后告诉Composer加载插件

 composer require jalendport/craft-updatechecker

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

通知方法

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

电子邮件

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

Slack

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

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

端点

端点URL

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

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

保护您的端点

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

在定义了访问密钥之后，您需要在请求中包含它，如下所示的头信息

Cron Job

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

HTTP请求头

您可以将cron作业设置为按需检查更新。

覆盖插件设置

如果您在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提供

jalendport / craft-updatechecker

维护者

详细信息