Skip to content

KarinJS/karin-plugin-adapter-milky

Repository files navigation

Karin Milky 适配器

基于 Milky 协议 的 Karin 适配器插件实现。

安装

可通过Karin WebUI安装该插件或者在 Karin 项目根目录下执行:

pnpm add @karinjs/plugin-adapter-milky -w

使用说明

第一次使用

  1. 启动 Karin 首次启动时,插件会自动创建配置文件:

    • 配置目录:@karinjs/@karinjs/plugin-adapter-milky/config/
    • 配置文件:config.json
  2. 修改配置 可前往Karin 的Webui 查看配置 或者手动编辑配置文件,且修改配置后无需重启

{
  "webhookToken": "Fvuo0TRH",
  "bots": [
    {
      "protocol": "websocket",
      "url": "https://example.com",
      "token": "abcd"
    }
  ]
}

配置项说明

webhookToken WebHook的鉴权密钥,设置后会验证Milky协议请求时的请求头的Authorization字段

protocol 连接协议,支持 websocket,ssewebhook ,websocketsse

url 接口请求地址,必须以 http://https:// 开头的链接,例如 http://127.0.0.1:8080

token url 的鉴权密钥,请求接口或主动连接到 Milky 协议时使用

本地开发

# 克隆仓库
git clone https://github.com/KarinJS/karin-plugin-adapter-milky.git
cd karin-plugin-adapter-milky

# 安装依赖
pnpm install

# 开发模式
pnpm dev

# 构建
pnpm build

参考资料


贡献

欢迎提交 Issue 和 Pull Request!

许可证

MIT License

About

基于Karin编写的milky协议适配器

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors