本文将详细介绍该插件的核心功能及配置方法，帮助您优雅地管理站点维护期。

核心功能概览

Site Maintenance 旨在为 Halo 2.x 站点提供灵活的“维护模式”管控能力。启用该模式后，前台访客将被重定向至友好的维护提示页，而后台管理功能不受影响。

其主要特性包括：

  • 一键维护开关：支持手动开启或关闭维护模式，即时生效。

  • 智能定时维护：支持预设维护的开始与结束日期，系统将在指定时间段内自动切换至维护状态，过期自动恢复。

  • 访问白名单机制：支持指定特定用户（如管理员）绕过维护页。在维护期间，白名单用户登录后仍可正常访问前台进行预览和调试。

  • 高度自定义页面：内置极简维护页，同时支持通过 HTML 代码完全自定义维护页面的视觉风格，以匹配您的品牌形象。

  • 智能路由排除：维护模式仅拦截前台页面，Console 管理面板（/console）及 API 接口（/api）等核心路径不受影响，确保管理员始终可以操作后台。

安装指南

请确保您的 Halo 版本为 2.22.0 或更高版本。

  1. 下载插件的 .jar 安装包。

  2. 登录 Halo 后台管理面板（Console）。

  3. 点击左侧菜单 插件 -> 我的插件。

  4. 点击右上角 安装插件，选择上传下载好的 jar 包。

  5. 安装完成后，确保插件状态为“已启用”。

Halo站点维护插件
来源：123网盘分享
plugin-site-maintenance-1.0.0.jar
28.84KB
download-circle

配置详解

插件安装完成后，请前往 插件 -> 站点维护 -> 设置 进入配置页面。

基础设置 (Basic Settings)

在此区域，您可以控制维护模式的触发逻辑。

  • 启用维护模式 (Enable)

    • 这是一个全局手动开关。勾选后，站点即刻进入维护状态。

    • 注意：如果您希望完全手动控制，请开启此项；如果您希望使用定时功能，可保持此项关闭并配置下方的时间。

  • 定时维护 (Scheduled Maintenance)

    • 开启此选项后，您可以设置 开始日期 和 结束日期。

    • 逻辑：只有当前时间处于设定的时间范围内时，维护模式才会生效。一旦时间过期，站点将自动恢复对外开放。

  • 白名单配置 (Whitelist)

    • 启用白名单：开启后，您可以从下拉菜单中选择特定的 Halo 用户。

    • 放行机制：被选中的用户在已登录的状态下访问前台，将不会看到维护页，而是正常浏览站点。这对于管理员在维护期间进行线上测试非常有用。

    • 提示：如果发现白名单未生效，请检查您前台是否处于登录状态。

维护页面设置 (Maintenance Page)

在此区域，您可以定义访客看到的页面样式。

  • 自定义维护页 HTML

    • 默认样式：如果留空，插件将展示内置的默认维护页，风格简洁大方。

    • 自定义样式：您可以在此输入完整的 HTML 代码（包含 <style> 样式）。这允许您设计倒计时、公告信息或品牌 Logo。

    • 应用场景：您可以编写一段居中的 HTML 代码，提示访客“系统升级中，预计将于 XX:XX 恢复”。

常见使用场景

场景一：紧急临时维护

操作：直接在设置中勾选“启用维护模式”并保存。
效果：所有访客（非白名单）立即看到维护页。

场景二：计划内的系统升级

操作：

  1. 关闭“启用维护模式”手动开关。

  2. 开启“定时维护”。

  3. 设置预计开始时间和预计结束时间。
    效果：系统将在自动挂起维护页，升级完成后自动恢复，无需人工守候。

场景三：改版调试

操作：

  1. 开启维护模式。

  2. 在“白名单”中添加管理员账号。
    效果：普通访客看到“网站改版中”，而管理员登录后可实时查看新主题的效果，确认无误后再关闭维护模式。

结语

通过合理使用 Site Maintenance 插件，您可以将站点维护对用户体验的影响降至最低，展现更专业的站点运营形象。