跳到主要内容

部署插件

信息

插件的部署策略后续会进行优化,目前tailchat对部署时自定义插件还做的不够便利,因此可能会有些困惑。因此本文档仅代表现状,后续会不断改进

首先说一下 Tailchat 插件的分类,Tailchat 的插件分为 纯前端插件, 纯后端插件, 前后端插件

纯前端插件最为容易理解,表示插件仅运行在前端代码中,依赖已有的上下文进行沟通,无需Tailchat后端支持。(特别的,对于与自定义后端进行通信的也是前端插件,如com.msgbyte.ai-assistant插件)

纯后端插件为为与Tailchat网络进行通信的插件,无前端界面,通过rpc调用其他服务的action来实现一些目的。对于后端插件来说,意味着插件本身接入了Tailchat后端网络,拥有最高的权限,可以访问一些可见性为public的action(默认只有publish级别的action可以被外部访问,其他级别的都是只有内部服务才能访问),一个无前端的后端插件如com.msgbyte.simplenotify插件

前后端插件 表示既有前端又有后端的插件,是最复杂但是能力最完全的插件类型,通过前端插件与后端交互,通过后端插件与其他的服务进行交互,在不修改核心代码的前提下能完成大部分的开发工作

你可以在这个文档中查看对应的插件示例: 插件列表

部署流程

在不同的插件部署的流程是不一样的

纯前端插件

纯前端插件你可以将代码放置在项目内部client/web/plugins目录下或者使用单独的静态文件服务管理。确保项目的js文档都是能正常访问的。

如果这是一个个人使用的插件,你可以通过插件中心的手动安装来安装,输入manifest.json的json配置即可。注意确保配置文件中的地址都是可以正常访问的。

如果想让所有的用户都能够看见代码,你需要在client/web/registry.json中添加你自己的插件配置。

如果想要成为一个默认安装的内置插件,需要修改client/web/src/plugin/builtin.ts文件来让前端代码在启动时加载插件。

纯后端插件

为了让插件能够被自动加载,你可以将代码放置与 server/plugins 目录下或者独立部署,只需要确保能够连入同一个网络即可(共用同一个TRANSPORTER)

默认部署的插件服务会将该目录下的所有后端插件统一加载。需要确保插件服务的命名为*.service.ts/*.service.js

如果仅想在开发环境运行而在生产环境忽略,请将文件命名为 `.service.dev.ts`*

你可以访问后端 /health(如:http://localhost:11000/health) 路由或者使用tailchat connect工具查看已加载的微服务列表

前后端插件

前后端插件的部署与后端差不多,但是需要修改编译命令让构建时能够把前后端插件的前端代码部署到public/plugins目录下

具体方式是: 修改package.json, 在 build:server 命令中追加想要编译的插件名称

配置文件中的 {BACKEND} 指代后端地址,因为前后端分离的关系后端地址不一定和前端地址保持一致


所有操作完毕后记得重新构建 docker 镜像