astrbot_plugin_jmdowloads/docs/DEPLOYMENT.md
2026-07-07 00:55:08 +08:00

3.1 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. 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 下载大部分本子不需要登录。少部分敏感题材可能需要登录态,此时只需要配置 jm_avs_cookie,填写浏览器 Cookie 中 AVS 的值即可。

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

5. 命令

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

6. 故障排查

  • 插件无法加载:检查 requirements.txt 是否安装成功。
  • 下载后没有文件:检查 jm_domains 是否可用,或降低 jm_batch_count。
  • 代理未生效:检查 jm_proxy.mode,custom 模式下确认代理端口可用。
  • 登录后仍不可下载:确认 jm_avs_cookie 来自当前实际访问的 JM 域名。
  • Komga 没有识别:确认 archive_root 是 Komga library 根目录,并手动执行 /jm scan。
  • 文件发送失败:不同平台对文件消息支持不同;归档仍会保存在 archive_root。
  • PDF 转换失败:确认 PyPDF2 已安装,或改用默认 cbz。

7. 本地测试

python -m unittest discover -s tests