@@ -49,10 +49,80 @@ koishi-plugin-chathub 是一个由 [LangChain](https://github.com/hwchase17/lang
4949
5050（这只是测试环境，我们推荐你在配置好任何插件后先在沙盒环境里测试插件是否正常运行）
5151
52- ### 安装插件
52+ ### 安装前置插件
5353
54- 当你成功的安装了 Koishi 并且成功的接入了聊天平台后，你可以开始安装此插件了 。
54+ 当你成功的安装了 Koishi 并且成功的接入了聊天平台后，你还不能立即开始安装此插件 。
5555
56- 打开 Koishi 的控制台，在插件市场里搜索 ` @dingyi222666/chathub ` ，然后安装列表上的第一个插件 。
56+ 由于 Koishi 丰富的 API 与生态，一个插件为了实现一个功能，并不总是自己全部实现，而是通过调用其他插件的 API 来实现。这样做的好处是，插件开发者可以专注于自己的功能，而不用去实现一些基础的功能 。
5757
58- ![ 插件市场] ( /images/plugin_market_1.png )
58+ 接下来就是安装此插件的前置插件。
59+
60+ #### 安装提供了 database 服务的插件 (必须)
61+
62+ database 服务是此插件的必须服务依赖，它提供了对数据库的相关操作。
63+
64+ 打开 Koishi 控制台，前往插件市场搜索` impl:database ` ，然后安装你偏好的数据库平台支持插件。
65+
66+ ![ 搜索后的结果] ( /images/plugin_market_2.png )
67+
68+ 对于大部分场景，我们推荐你使用` database-sqlite ` ，它轻量，并且无需额外配置，几乎是安装后开箱即用。
69+
70+ 如果你需要使用其他的数据平台支持插件，并且你安装插件后不知道如何配置的话，你可能需要前往 [ Koishi 论坛] ( https://forum.koishi.xyz/ ) 寻求如何配置相关的插件。
71+
72+ ::: tip
73+ 在大部分的安装 Koishi 方式中，安装 Koishi 后很可能会内置` database-sqlite ` 插件，如果你不需要配置其他数据库的话，你可以跳过这一步。
74+ :::
75+
76+ #### 安装提供了 cache 服务的插件 （必须）
77+
78+ cache 服务是此插件的必须服务依赖，它提供了对缓存kv键值对的相关操作。
79+
80+ 打开 Koishi 控制台，前往插件市场搜索` impl:cache ` ，然后安装你偏好的缓存平台支持插件。
81+
82+ ![ 搜索后的结果] ( /images/plugin_market_3.png )
83+
84+ 对于大部分场景，我们推荐你使用` cache-data ` ，它几乎无需额外配置，只需要你按照上面的要求安装了提供 database 服务的插件，然后完全可以安装后开箱即用。
85+
86+ 如果你需要使用其他的数据平台支持插件，并且你安装插件后不知道如何配置的话，你可能需要前往 [ Koishi 论坛] ( https://forum.koishi.xyz/ ) 寻求如何配置相关的插件。
87+
88+ ::: tip
89+ 我们需求的 cache 服务的相关版本为 ` 2.0.0.alpha.0 ` +，请不要安装 ` 1.x ` 版本，目前插件已不再兼容该版本。
90+ :::
91+
92+ #### 安装 puppeteer 插件 （可选）
93+
94+ puppetter 插件是此插件的可选服务依赖，它提供了 puppeteer 的相关服务，使得插件可以调用浏览器，实现很多操作。（如网页截图实现本地html渲染）
95+
96+ 打开 Koishi 控制台，前往插件市场搜索 ` impl:puppeteer ` ，然后安装puppeteer 插件。
97+
98+ 安装完成后你需要配置此插件，具体的插件配置项可以查看[ 这里] ( https://puppeteer.koishi.chat/ ) ，我们不在这里赘述。
99+
100+ #### 安装提供了 censor 服务的插件（可选）
101+
102+ censor 服务是此插件的可选服务依赖，它提供了内容安全过滤的服务。
103+
104+ 打开 Koishi 控制台，前往插件市场搜索` category:censor ` ，然后安装你偏好的内容安全过滤平台支持插件。
105+
106+ 安装完成后你需要配置相关插件才能使用，具体的插件配置项可以查看[ 这里] ( https://censor.koishi.chat/ ) ，我们不在这里赘述。
107+
108+ ::: tip
109+ 需要注意的是，有的插件虽然也提供 censor 服务， 但是它只对图像做审核，不会对文本内容做审核！因此你需要确保你安装的插件支持对文本内容的审核。
110+ :::
111+
112+ #### 安装提供了 vits 服务的插件（可选）
113+
114+ vits 服务是此插件的可选服务依赖，它提供了文本转语音的相关服务。
115+
116+ 打开 Koishi 控制台，前往插件市场搜索` impl:vits ` ，然后安装你偏好的文本转语音平台支持插件。
117+
118+ ![ 搜索后的结果] ( /images/plugin_market_5.png )
119+
120+ 安装后你可能还需要配置相关插件才能使用，具体怎么使用可以查看插件的配置项的描述，或插件主页。（当然你也可以直接联系插件的作者问）
121+
122+ ::: tip
123+ 我们推荐安装` open-vits ` 插件，这是可开箱即用的提供了 vits 服务的插件，插件由[ initialencounter] ( https://github.com/initialencounter ) 编写，并且后端是由[ t4wefan] ( https://github.com/t4wefan ) 免费提供的公益 vits 后端，感谢他们的插件和后端提供能让 vits 服务的使用没有门槛！
124+ :::
125+
126+ ### 安装 ` chathub ` 主插件
127+
128+ 在安装和配置了这么多前置插件后，终于可以开始安装 chathub 的主插件了！
0 commit comments