README

该插件提供工具帮助您维护Craft CMS网站

当网站进行计划性维护时，在控制面板中显示“维护中”覆盖层
在仪表板和通知横幅中宣布即将进行的维护
在仪表板小部件上留下您的用户(维护相关)消息
使用提供的模板变量从模板访问维护相关信息

安装

该插件在Packagist上可用，可以使用Composer安装。您还可以下载最新版本并将其文件复制到craft/plugins/maintenance/。

$ composer require carlcs/craft-maintenance

维护公告

在插件设置页面设置维护公告或消息。您可以使用Markdown添加链接或格式化消息。要配置计划性维护，您必须在公告设置中设置开始日期，并启用 “后端维护”和/或“前端维护”。

创建一个新的“维护公告”小部件以在用户仪表板上显示所有通知。即将进行的维护也将通过横幅通知进行公告。

维护模式

当后端维护模式激活时，正在导航控制面板的用户将看到一个全屏的“维护中”覆盖层。这会通知他们正在进行维护，以防止无用的数据输入。

前端维护模式将所有（前端）请求重定向到/503，您的“服务不可用”页面。您可以在插件设置中排除URL的重定向并允许访客IP地址。

注意：该插件不会以阻止数据在数据库中保存或更改的方式来执行“内容冻结”。话虽如此，提供了模板变量和插件API。

设置

可以从craft/config/maintenance.php配置文件或从设置/维护进行配置。

在设置/用户中，您可以分配用户权限以配置“维护中”覆盖层或在前端维护执行时授予个别用户组的访问权限。

模板变量

该插件提供模板变量以获取活动的公告模型或检查网站是否目前正在维护中。

`isCpMaintenance`

返回控制面板是否目前正在维护。

{{ isCpMaintenance ? 'Shop closed' : '<a href="/shop">Shop</a>' }}

`isSiteMaintenance`

返回网站是否目前正在维护。

{% set reason = isSiteMaintenance ? 'scheduled' : 'unscheduled' %}

`getAnnouncement( timeInAdvance )`

返回最新的维护公告，无论是当前活动的还是即将激活的。

{% set announcement = craft.maintenance.getAnnouncement('2 hours') %}

{% if announcement and announcement.blockSite %}
    <span>{{ announcement.message }}</span>
{% endif %}

计划中的功能

通过环境变量快速设置维护

carlcs / craft-maintenance

维护者

详细信息