thisisbd / silverstripe-maintenance-mode
SilverStripe 维护模式模块。允许管理员将网站设置为离线模式,显示“即将推出”、“建设中”或“维护中”页面,同时允许登录的管理员浏览和修改网站。
Requires
- silverstripe/cms: ~4.0
- silverstripe/vendor-plugin: ^1.0
This package is not auto-updated.
Last update: 2024-09-14 17:06:00 UTC
README
SilverStripe 维护模式/离线模式模块。允许管理员将网站设置为离线模式,显示“即将推出”、“建设中”或“维护中”页面,同时允许登录的管理员浏览和修改网站。
维护者联系方式
- Dynamic
<dev (at) dynamicagency (dot) com>
需求
本分支将努力实现与 SilverStripe 4.x 的兼容性。
对于 SilverStripe 3.x,请参阅兼容分支。
安装说明
安装可以通过 composer 或手动下载发行版来完成。
通过 composer
composer require "dljoseph/silverstripe-maintenance-mode:*"
手动
- 从发行版页面下载模块。
- 解压文件(如果你在 Windows 上,尝试使用 7-zip 解压 tar.gz 文件
- 确保解压后的文件夹命名为 'maintenance-mode'
- 将此目录放置在网站根目录中。这个目录包含框架和 CMS。
- 访问
<yoursite.com>/dev/build/?flush
重建数据库。
使用概述
将“维护模式”复选框添加到“站点配置”访问设置中;从那里您可以激活维护模式使网站离线,并在 CMS 的“页面”部分中添加一个新的“工具页面”。您可以编辑工具页面的内容,或手动覆盖 SilverStripe 使用以显示页面的主题模板。
模板
要覆盖默认的 UtilityPage 模板,在主题的模板文件夹中(在 Layouts 之上)添加一个名为 UtilityPage.ss 的模板,然后刷新模板缓存。
如果您希望为 UtilityPage 使用不同的模板,没有任何限制,只需创建一个新的 SilverStripe 模板文件,确保将其直接放置在模板文件夹中(在 Layouts 之上),然后访问 /?flush 以刷新模板缓存。之后,您必须转到 CMS 中的 UtilityPage 并从下拉菜单手动选择模板,以告诉 SilverStripe 要使用哪个模板来显示页面。
重定向与在任何 URL 上显示
默认情况下,当前功能是将用户重定向到单独的 URL,您可以在 CMS 中配置该 URL(例如 /offline/
),但是您可能希望在任何用户可能访问的 URL 上显示维护消息(以确保用户不会失去他们当前所在的页面,如果维护窗口非常短)。
要禁用重定向,将以下行放入您的站点 config.yaml
文件中
UtilityPage: DisableRedirect: true
命令行
您可以通过简单地运行 MaintenanceMode
任务来轻松地在命令行中切换维护模式 on
或 off
。例如
# Via Sake: sake dev/tasks/MaintenanceMode on # Via the CLI script directly: php framework/cli-script.php dev/tasks/MaintenanceMode on
允许特定的 IP 地址
您可以将模块配置为允许特定的IP地址通过维护页面。要添加IP地址,请将以下行添加到您网站的 config.yaml
文件中
Page_Controller: allowed_ips: - '127.0.0.1' - '::1'