astrbot_plugin_jmdowloads/docs/DEPLOYMENT.md
2026-07-07 01:35:42 +08:00

5.8 KiB

JMDownload 归档器部署说明

1. 安装插件

将仓库放到 AstrBot 的插件目录:

AstrBot/
  data/
    plugins/
      astrbot_plugin_jmdownload/
        main.py
        metadata.yaml
        requirements.txt

如果使用 Git:

cd AstrBot/data/plugins
git clone http://192.168.31.210:18085/YokiiroBW/astrbot_plugin_jmdowloads.git astrbot_plugin_jmdownload

然后在 AstrBot WebUI 的插件管理中安装依赖并重载插件。依赖来自 requirements.txt:

jmcomic
PyYAML
Pillow
httpx
PyPDF2

2. 推荐配置

在 AstrBot WebUI 的插件配置中设置:

archive_root: D:\KomgaLibrary\JM
archive_format: cbz
send_archive_file: false
delete_work_dir_after_archive: true
cleanup_retention_days: 7
max_concurrent_tasks: 1

archive_root 建议直接填写 Komga 某个 library 的根目录。插件会生成:

D:\KomgaLibrary\JM\
  系列名\
    系列名 [JMID].cbz

3. Komga 联动

在 Komga 中创建或选择一个 Library,并让它指向同一个 archive_root。

插件配置:

komga.enabled: true
komga.base_url: http://127.0.0.1:25600
komga.library_id: <Komga Library ID>
komga.api_key: <API Key>

如果不用 API Key,也可以填:

komga.username
komga.password

归档完成后插件会请求:

POST /api/v1/libraries/{libraryId}/scan

4. 访问控制

插件默认启用访问控制,并且要求命令来源命中白名单:

access_control.enabled: true
access_control.require_whitelist: true

OneBot v11 / aiocqhttp 的 ID 识别方式:

群聊消息:event.get_group_id() 是群号,event.get_sender_id() 是发送者 QQ 号
私聊消息:event.get_group_id() 为空,event.get_sender_id() 是对方 QQ 号
机器人自身 ID:event.get_self_id() 是机器人 QQ 号
平台 ID:event.get_platform_id() 是 AstrBot 平台实例 ID
UMO:event.unified_msg_origin,格式为 平台ID:消息类型:会话ID

允许某个群触发:

access_control.allow_group_ids:
  - 123456789

允许某个私聊账号触发:

access_control.allow_private_user_ids:
  - 10001

允许某个 OneBot 机器人账号下的全部会话触发:

access_control.allow_self_ids:
  - 30003

多个 OneBot / aiocqhttp 实例并存时,建议带上平台 ID:

access_control.allow_group_ids:
  - qq-main:123456789
access_control.allow_private_user_ids:
  - qq-main:10001
access_control.allow_self_ids:
  - qq-main:30003

也可以使用完整 UMO:

access_control.allow_unified_origins:
  - qq-main:GroupMessage:123456789
  - qq-main:FriendMessage:10001

黑名单优先于白名单:

access_control.deny_group_ids:
  - 987654321
access_control.deny_private_user_ids:
  - 20002
access_control.deny_self_ids:
  - 30003

如果想只使用黑名单,不要求白名单:

access_control.require_whitelist: false

拒绝时默认静默处理。需要提示时可配置:

access_control.deny_message: 当前会话不在 JMDownload 白名单内。

首次配置时如果不知道 ID,可以临时设置 access_control.require_whitelist: false,执行 /jm status 查看当前事件的 平台 ID、机器人自身 ID、群聊 ID、发送者 ID 和 UMO,复制完成后再重新开启白名单。

5. JM 代理与登录

jmcomic 的代理配置位于 client.postman.meta_data.proxies。本插件在 WebUI 中提供 jm_proxy:

jm_proxy.mode: inherit

可选值:

inherit  不写入代理配置,沿用 jmcomic 默认行为
none     写入 proxies: null,禁用代理
system   使用系统代理
clash    使用 jmcomic 内置 clash 快捷代理
v2ray    使用 jmcomic 内置 v2ray 快捷代理
custom   使用自定义代理

自定义代理示例:

jm_proxy.mode: custom
jm_proxy.proxy_url: 127.0.0.1:7890

如果 HTTP 和 HTTPS 代理不同:

jm_proxy.mode: custom
jm_proxy.http_proxy: 127.0.0.1:7890
jm_proxy.https_proxy: 127.0.0.1:7890

JM 下载大部分本子不需要登录。少部分敏感题材可能需要登录态,可以选择账号密码登录或手动 Cookie。

账号密码登录:

jm_login.enabled: true
jm_login.username: <JM 用户名>
jm_login.password: <JM 密码>
jm_login.impl: api

插件会把账号密码写入本次下载的临时 jmcomic.yml,通过 jmcomic 的 login 插件自动获取 Cookie。jmcomic 初始化完成后,本插件会尽量删除该临时配置文件,减少密码残留。

如果 api 登录异常,可尝试:

jm_login.impl: html

不想保存账号密码时,也可以只配置 jm_avs_cookie,填写浏览器 Cookie 中 AVS 的值即可。

注意:AVS Cookie 和访问域名有关,使用的 JM 域名要和 Cookie 来源域名一致。

6. 命令

/jm download <id>
/jm 下载 <id>
/jm status
/jm scan
/jm cleanup

7. 故障排查

  • 插件无法加载:检查 requirements.txt 是否安装成功。
  • 命令没有反应:默认需要命中 access_control 白名单;先确认当前群号、QQ 号或 UMO 已配置。
  • 下载后没有文件:检查 jm_domains 是否可用,或降低 jm_batch_count。
  • 代理未生效:检查 jm_proxy.mode,custom 模式下确认代理端口可用。
  • 登录后仍不可下载:账号密码方式可切换 jm_login.impl 为 html 试试;手动 Cookie 方式需确认 jm_avs_cookie 来自当前实际访问的 JM 域名。
  • Komga 没有识别:确认 archive_root 是 Komga library 根目录,并手动执行 /jm scan。
  • 文件发送失败:不同平台对文件消息支持不同;归档仍会保存在 archive_root。
  • PDF 转换失败:确认 PyPDF2 已安装,或改用默认 cbz。

8. 本地测试

python -m unittest discover -s tests