Skip to content

可选服务

本页面介绍 GitHub 适配器依赖的可选服务。

Assets 服务

GitHub 适配器需要 Assets 服务来支持富媒体消息的发送。

为什么需要 Assets 服务?

GitHub 通过 Markdown 进行交流,当你需要发送图片、文件等富媒体内容时,需要先将这些内容上传到可访问的 URL,然后在 Markdown 中引用。

Assets 服务就是用来处理这些富媒体内容的上传和托管。

使用场景

以下场景需要 Assets 服务:

  • 📷 发送图片 - 在 Issue/PR/Discussion 中发送图片
  • 📁 发送文件 - 分享文档、压缩包等文件
  • 🎵 发送音频 - 分享音频文件
  • 🎬 发送视频 - 分享视频内容

提示

如果你只需要接收 GitHub 事件,不需要发送富媒体消息,可以不配置 Assets 服务。

配置建议

1. 关闭默认的 assets-local 服务

Koishi 默认启用 assets-local 服务,但该服务仅适用于本地开发,不适合生产环境使用。

建议在插件配置中关闭 assets-local 服务。

2. 选择合适的 Assets 服务

前往 Koishi 插件市场,搜索 assets,选择适合你的 Assets 服务

3. 安装和配置

  1. 在插件市场中找到你选择的 Assets 服务
  2. 点击安装
  3. 根据服务要求配置相关参数(如 API Key、存储桶等)
  4. 启用服务

验证配置

配置完成后,可以通过以下方式验证:

  1. 在 Koishi 控制台中查看 Assets 服务是否正常启动
  2. 尝试向 GitHub 发送一条包含图片的消息
  3. 检查图片是否正常显示

常见问题

Q: 不配置 Assets 服务会怎样?

A: 如果不配置 Assets 服务:

  • ✅ 可以正常接收 GitHub 事件
  • ✅ 可以发送纯文本消息
  • ❌ 无法发送图片、文件等富媒体内容

Q: 可以同时启用多个 Assets 服务吗?

A: 不可以。同类服务只可以开启一个。

Q: Assets 服务上传失败怎么办?

A: 请检查:

  1. Assets 服务是否正常启动
  2. 配置的凭证是否正确
  3. 网络连接是否正常
  4. 文件大小是否超过限制

详见各 Assets 服务的文档说明。

下一步