> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.

# 安装与启用

> 适用版本 1.0.0 ｜ Halo ≥ 2.27.0 ｜ 后台路径：插件 / 应用市场

插件安装后不会自动生成内容，需要先完成收款设置，再把 `/reward` 挂到菜单或页面入口上。

## 环境要求

| 项目   | 要求                                           |
| ---- | -------------------------------------------- |
| Halo | ≥ 2.27.0（前台页面依赖 2.26.0 起提供的 `layout` 契约）     |
| 主题   | 提供 `layout` 契约，能套用页头与页脚；不提供时页面仍可访问，但只有插件自身内容 |
| 路径   | `/reward` 未被自定义页面占用                          |

## 安装

### 应用市场（推荐）

1. 后台「应用市场」搜索 **打赏插件**
2. 点击安装，安装完成后启用

### 手动上传

1. 从 [Releases](https://github.com/AloneNanNan/halo-plugin-reward/releases) 下载最新的插件 JAR
2. 后台「插件 → 安装」，上传该 JAR
3. 安装完成后启用

## 启用后的配置顺序

1. [基础设置](/reward/settings.md)：确认标题、简介、货币符号，「启用打赏页面」保持开启
2. [收款设置](/reward/settings.md)：上传微信 / 支付宝收款码，填写收款提示
3. [记录与展示](/reward/settings.md)：决定是否收集记录、是否校验验证码、赞助者墙如何展示
4. [爱发电](/reward/afdian.md)：需要平台订单时再配置
5. 挂入口：后台「菜单」新增自定义链接指向 `/reward`，或在文章、关于页里加入口

> 主题侧不需要改代码；主题提供 `layout` 契约时会自动套用页头与页脚。

## 验证

1. 打开 `https://你的域名/reward`，确认页面套用了主题页头页脚
2. 检查收款码是否显示、点击能否放大
3. 点击提交按钮，确认模态框能打开、字段与后台开关一致
4. 提交一条测试记录，到「内容 → 打赏」确认能看到（默认状态为「待确认」）

## 升级

- 后台「插件」页面提示有新版本时直接升级，插件设置与已产生的记录都会保留
- 手动升级时上传新版本 JAR 覆盖安装，效果相同
- 升级后强刷一次前台页面，避免旧的前台 CSS / JS 缓存

## 卸载

- 卸载插件**不会删除**已产生的打赏记录，数据保留在 Halo 扩展存储中，重新安装后可继续访问
- Halo 卸载时可选「卸载」或「卸载并删除配置」：前者保留插件设置，后者连设置一起清除
- 需要彻底清理记录时，请在卸载前于「内容 → 打赏」逐条或批量删除

## 注意事项

- 关闭「启用打赏页面」后 `/reward` 返回 404，提交与验证码接口也会拒绝服务；`/public/wall`、`/public/stats` 只读接口不受影响
- 站点已存在占用 `/reward` 的自定义页面时，先改掉该页面的固定链接，否则路由会冲突
- 插件停用后前台入口立即失效，但已入库的记录仍在，重新启用即可恢复
- 插件不启动后台任务、定时任务或常驻线程，禁用后不会残留运行中的任务