插件
插件是编译为 WebAssembly 的程序,可以提供模块、响应站内事件、在个人主页上显示内容。插件在沙箱中运行,仅能使用其声明的权限。
插件目前仍处于 Beta 测试阶段。如需开放更多可调用的功能,或遇到其他问题,请单独联系 WikitTeam。
安装插件
将插件放入数据目录下 plugins/ 中以插件名命名的目录:
plugins/
scpper/
plugin.json
plugin.wasm
config.json插件需要配置时,在同一目录中创建 config.json:
{
"config": { "scpper_url": "http://127.0.0.1:8100" },
"allowed_hosts": ["127.0.0.1"]
}config 中的键值将原样传给插件。allowed_hosts 指定插件可以访问的主机,仅对具有 http 权限的插件有效。
添加、更新或删除插件后,请重启 pwikit。新安装的插件在所有站点上均为停用状态,请在各站点管理后台的「插件」中启用。
编写插件
插件可以使用任何能编译为 WASI 的语言编写,通过 Extism PDK 与 pwikit 交互。使用 Go 时:
GOOS=wasip1 GOARCH=wasm go build -buildmode=c-shared -o plugin.wasm .plugin.json
| 字段 | 说明 |
|---|---|
name | 插件名,与目录名相同 |
version | 版本号 |
api | 接口版本,目前为 1 |
title、description | 管理后台中显示的名称与描述 |
modules | 提供的模块,如 [{"name": "coinrank"}]。需要正文的模块加 "content": true |
events | 订阅的事件:page.created、page.edited、page.deleted、vote.changed、post.created |
permissions | kv、pages.read、http |
allowed_hosts | 可以访问的主机 |
profile_title | 设置后,个人主页底部将显示以此为标题的区块 |
profile_badge | 为 true 时,个人主页用户名旁将显示徽章 |
memory_pages | 内存上限,单位为 64 KB,默认 256,最大 1024 |
timeout_ms | 单次调用时限,默认 1000,最大 5000 |
导出函数
各函数的输入为 JSON 对象,输出按维基语法渲染。
| 函数 | 调用时机 |
|---|---|
module | 页面中使用该插件的模块 |
event | 发生订阅的事件 |
profile | 显示个人主页底部区块 |
badge | 显示个人主页徽章 |
宿主函数
| 函数 | 权限 | 作用 |
|---|---|---|
kv_get、kv_set、kv_delete | kv | 读写插件在当前站点的键值存储 |
page_get | pages.read | 获取公开页面的标题、标签、作者与评分 |
示例:安装 scpper 插件
scpper 插件在个人主页的用户名旁显示云币财富榜名次与持有量,并提供财富榜模块与打赏按钮。安装前请先部署 scpper,见挂载外部程序。以下步骤假定 pwikit 安装于 /opt/pwikit。
从 pwikit-plugins 的 Releases 下载
scpper.zip,解压到插件目录:shsudo apt install unzip sudo wget -O /tmp/scpper.zip https://github.com/scpwikicloud/pwikit-plugins/releases/latest/download/scpper.zip sudo mkdir -p /opt/pwikit/plugins/scpper sudo unzip -o /tmp/scpper.zip -d /opt/pwikit/plugins/scpper创建配置文件:
shsudo cp /opt/pwikit/plugins/scpper/config.example.json /opt/pwikit/plugins/scpper/config.jsonscpper_url为 pwikit 访问 scpper 的地址,与[[mount]]的upstream相同;scpper_path为[[mount]]的path,不含末尾的/;allowed_hosts填写scpper_url中的主机。按挂载外部程序部署时无需修改。重启 pwikit:
shsudo /opt/pwikit/pwikit service restart在站点管理后台的「插件」中勾选 scpper 一行的「本站启用」,然后点击「保存」。
启用后,个人主页的用户名旁将显示云币徽章。在页面中可以使用以下模块:
[[module CoinRank limit="10"]]
[[module Tip]]CoinRank 显示财富榜,limit 为显示的人数,默认 10,最多 100。Tip 显示当前页面的打赏按钮与已收到的打赏。
更新插件时,按第 1 步下载并覆盖解压,然后重启 pwikit。config.json 不会被覆盖。
