docs: update index, update ci.

2026-07-17 12:11:14 +08:00 · 2023-10-02 15:59:08 +08:00
parent cb628cfe8c
commit 77e50edf65
5 changed files with 27 additions and 1 deletions
--- a/docs/feature/rename.md
+++ b/docs/feature/rename.md
@@ -0,0 +1,2 @@
+# 重命名使用说明
+
--- a/docs/feature/rss.md
+++ b/docs/feature/rss.md
@@ -0,0 +1,44 @@
+# RSS 管理使用说明
+
+## 添加合集
+
+AB 提供了两种手动下载的方式：
+**Collect** 和 **Subscribe**。
+其中 **Collect** 为手动下载全部剧集，适用于下载已经完结的番剧。
+**Subscribe** 为手动添加自动下载规则以及对应的 RSS 链接，适用于下载尚未完结的番剧。
+
+### 解析 RSS 链接
+
+AB 支持解析所有资源站的合集 RSS 链接，在对应的资源站找到对应番剧合集 RSS，点击 AB 右上角的 **+** 号，在弹出的窗口中粘贴 RSS 链接即可。
+
+### 添加下载
+
+如果正常解析，则会弹出一个窗口，显示解析到的番剧信息，点击 **Collect** 或者 **Subscribe** 即可添加到下载队列。
+
+### 常见问题
+
+如果出现解析错误，可能是由于 RSS 链接不正确，或者 RSS 中字幕组的命名不支持解析。
+
+## 管理番剧
+
+3.0 版本之后 AB 在 WebUI 中提供了手动管理番剧的功能，可以手动调整解析不正确的番剧信息。
+
+### 修改番剧信息
+
+在番剧列表中，点击番剧海报，即可进入番剧信息页面。
+修改番剧信息后，点击 **Apply** 即可。
+此时 AB 会根据你修改的信息重新调整目录并自动重命名。
+
+
+### 删除番剧
+
+在 3.0 之后 AB 可以手动删除番剧，点击番剧海报，进入番剧信息页面，点击 **Delete** 即可删除番剧。
+
+⚠️删除番剧之后，如果 RSS 中没有取消订阅，AB 仍然会重新解析，如果想禁用下载规则请使用[禁用番剧](#禁用番剧)
+
+### 禁用番剧
+
+在 3.0 之后 AB 可以手动禁用番剧，点击番剧海报，进入番剧信息页面，点击 **Disable** 即可禁用番剧。
+
+禁用之后番剧海报会变灰，并且排列在最后。如果想要重新启用下载规则，请点击 **Enable**。
+
--- a/docs/feature/search.md
+++ b/docs/feature/search.md
@@ -0,0 +1,26 @@
+# 搜索功能
+
+在 3.1 版本之后 AB 添加了搜索功能，可以通过搜索功能快速找到想要的番剧。
+
+## 使用搜索功能
+
+搜索栏位于 AB 顶栏，可以在搜索栏右侧选择想要搜索的源站，比如：蜜柑计划、nyaa 等
+
+选择对应的源站输入关键词，AB 即可自动解析搜索结果并展示。如果想要添加对应的番剧，点击卡片右侧的添加按钮即可。
+
+## ⚠️注意
+
+源站为 **Mikan** 是 AB 默认使用 `mikan` 解析器，如果使用其他源站，默认使用 TMDB 解析器。
+
+## 增加源站
+
+用户可以手动增加源站列表，只需要更改 `config/search_provider.json` 即可。
+默认为
+```json
+{
+  "mikan": "https://mikanani.me/RSS/Search?searchstr=%s",
+  "nyaa": "https://nyaa.si/?page=rss&q=%s&c=0_0&f=0",
+  "dmhy": "http://dmhy.org/topics/rss/rss.xml?keyword=%s",
+  "bangumi.moe": "https://bangumi.moe/rss/search/%s"
+}
+```
--- a/docs/feature/配置选项说明.md
+++ b/docs/feature/配置选项说明.md
@@ -0,0 +1,147 @@
+# 配置选项说明
+
+从 `2.6` 版本之后，AutoBangumi 使用 `config.json` 来配置系统设置。
+初次运行 AutoBangumi 时会自动生成 `config.json` 文件，如果需要修改配置，可以直接修改 `config.json` 文件，也可以在 Web 界面中修改。
+
+## 升级
+
+如果你是从 `2.5` 版本升级到 `2.6` 版本，AB 会自动迁移你的配置文件，在首次升级完成之后，修改环境变量将对 AB 运行不生效。
+后续配置修改请直接修改 `config.json` 文件，或者在 Web 界面中修改。
+
+## 配置文件参数说明：
+
+### 程序运行参数
+
+配置文件部分：`program`
+
+| 参数名         | 参数说明       | 参数类型     | WebUI 对应选项 | 默认值  |
+|-------------|------------|----------|------------|------|
+| ｜rss_time   | RSS 检查时间间隔 | 以秒为单位的整数 | RSS 检查时间间隔 | 7200 |
+| rename_time | 重命名检查时间间隔  | 以秒为单位的整数 | 重命名检查时间间隔  | 60   |
+| webui_port  | WebUI 端口   | 以整数为单位   | WebUI 端口   | 7892 |
+
+- `rss_time` 和 `rename_time` 两个参数的单位为秒，如果你需要设置为分钟，请自行转换为秒。
+- `rss_time` 为 RSS 检查时间间隔，如果你需要修改 RSS 检查时间间隔，请修改此参数。
+- `rename_time` 为重命名检查时间间隔，如果你需要修改重命名检查时间间隔，请修改此参数。
+- `webui_port` 为 WebUI 端口，如果你需要修改 WebUI 端口，请修改此参数。
+
+### 下载器参数
+
+配置文件部分：`downloader`
+
+| 参数名      | 参数说明        | 参数类型 | WebUI 对应选项  | 默认值                |
+|----------|-------------|------|-------------|--------------------|
+| type     | 下载器类型       | 字符串  | 下载器类型       | qbittorrent        |
+| host     | 下载器地址       | 字符串  | 下载器地址       | 172.17.0.1:8080    |
+| username | 下载器用户名      | 字符串  | 下载器用户名      | admin              |
+| password | 下载器密码       | 字符串  | 下载器密码       | adminadmin         |
+| path     | 下载器下载路径     | 字符串  | 下载器下载路径     | /downloads/Bangumi |
+| ssl      | 下载器是否使用 SSL | 布尔值  | 下载器是否使用 SSL | false              |
+
+- `type` 为下载器类型，目前支持 `qbittorrent` 下载器，目前暂不支持修改。
+- `host` 为下载器地址。[下载器链接问题][1]
+- `path` 为映射的下载器下载路径。[下载器路径问题][2]
+- `ssl` 为下载器是否使用 SSL。
+
+### RSS 解析器参数
+
+配置文件部分：`rss_parser`
+
+| 参数名         | 参数说明           | 参数类型 | WebUI 对应选项     | 默认值           |
+|-------------|----------------|------|----------------|---------------|
+| enable      | RSS 解析器是否启用    | 布尔值  | RSS 解析器是否启用    | true          |
+| type        | RSS 解析器类型      | 字符串  | RSS 解析器类型      | mikan         |
+| token       | RSS 解析器 Token  | 字符串  | RSS 解析器 Token  | token         |
+| custom_url  | RSS 解析器自定义 URL | 字符串  | RSS 解析器自定义 URL | mikanime.tv   |
+| parser_type | RSS 解析器解析类型    | 字符串  | RSS 解析器解析类型    | parser        |
+| filter      | RSS 解析器过滤器     | 数组   | 过滤器            | [720,\d+-\d+] |
+| language    | RSS 解析器语言      | 字符串  | RSS 解析器语言      | zh            |
+
+
+- `type` 为 RSS 解析器类型，目前支持 `mikan` 。
+- `token` 为蜜柑计划的 Token。[蜜柑计划 Token 获取][3]
+- `custom_url` 为自定义蜜柑计划地址。[自定义反代地址][4]
+- `parser_type` 为 **官方标题** 解析器解析类型，支持类型如下：
+  - `parser` 为正则表达式解析器，使用正则表达式解析标题。
+  - `mikan` 为蜜柑计划解析器，使用蜜柑计划解析标题。
+  - `tmdb` 为 TMDB 解析器，使用 TMDB 解析标题。
+- `filter` 为 RSS 解析器过滤器，过滤器为数组，数组中的每一项为一个过滤器，过滤器为正则表达式，如果标题匹配正则表达式，则不会下载。
+- `language` 为 RSS 解析器语言，目前支持 `zh` 、 `jp` 、 `en` 三种语言。
+
+### 番剧管理参数
+
+配置文件部分：`bangumi_manager`
+
+| 参数名                | 参数说明            | 参数类型 | WebUI 对应选项 | 默认值   |
+|--------------------|-----------------|------|------------|-------|
+| enable             | 番剧管理是否启用        | 布尔值  | 番剧管理是否启用   | true  |
+| eps_complete       | 是否补全当季番剧        | 布尔值  | 番剧补全       | false |
+| rename_method      | 重命名方式           | 字符串  | 重命名方式      | pn    |
+| group_tag          | 是否在下载规则中添加番剧组标签 | 布尔值  | 番剧组标签      | false |
+| remove_bad_torrent | 是否删除错误的种子       | 布尔值  | 种子删除       | false |
+
+
+- `eps_complete` 为是否补全当季番剧，如果开启，则会补全当季番剧，如果关闭，则不会补全当季番剧。
+- `rename_method` 为重命名方式，目前支持：
+  - `pn` 为 `Torrent Title S0XE0X.mp4` 的方式。
+  - `advance` 为 `Official Title S0XE0X.mp4` 的方式。
+  - `none` 为不重命名。
+- `group_tag` 为是否在下载规则中添加番剧组标签，如果开启，则会在下载规则中添加番剧组标签。
+- `remove_bad_torrent` 为是否删除错误的种子，如果开启，则会删除错误的种子。
+
+### 日志参数
+
+配置文件部分：`log`
+
+| 参数名          | 参数说明     | 参数类型 | WebUI 对应选项 | 默认值   |
+|--------------|----------|------|------------|-------|
+| debug_enable | 是否启用调试模式 | 布尔值  | 调试模式       | false |
+
+
+### 代理参数
+
+配置文件部分：`proxy`
+
+| 参数名      | 参数说明   | 参数类型 | WebUI 对应选项 | 默认值   |
+|----------|--------|------|------------|-------|
+| enable   | 是否启用代理 | 布尔值  | 代理         | false |
+| type     | 代理类型   | 字符串  | 代理类型       | http  |
+| host     | 代理地址   | 字符串  | 代理地址       |
+| port     | 代理端口   | 整数   | 代理端口       |
+| username | 代理用户名  | 字符串  | 代理用户名      |
+| password | 代理密码   | 字符串  | 代理密码       |
+
+
+- `type` 为代理类型，目前支持 `http` 、 `socks5` 两种类型。
+- `username` 与 `password` 仅支持 `socks5` 代理。
+
+
+### 通知参数
+
+配置文件部分：`notification`
+
+| 参数名     | 参数说明       | 参数类型 | WebUI 对应选项 | 默认值      |
+|---------|------------|------|------------|----------|
+| enable  | 是否启用通知     | 布尔值  | 通知         | false    |
+| type    | 通知类型       | 字符串  | 通知类型       | telegram |
+| token   | 通知 Token   | 字符串  | 通知 Token   |
+| chat_id | 通知 Chat ID | 字符串  | 通知 Chat ID |
+
+
+- `type` 为通知类型，目前支持 `telegram` 、 `serverchan` 、 `bark`、 `wecom` 四种类型。
+- `token` 为通知 Token，目前支持 `telegram` 、 `serverchan` 、 `bark`、 `wecom` 四种类型。
+- `chat_id` 为通知 Chat ID，仅在使用 `telegram` 通知时需要填写。[Telegram Bot 获取 Chat ID][5]
+- 使用`wecom`时，chat_id参数框填写自建推送的url地址，同时需要在服务端增加[图文消息][6]类型。[Wecom酱配置说明][7]
+
+
+
+[1]: https://github.com/EstrellaXD/Auto_Bangumi/wiki
+[2]: https://github.com/EstrellaXD/Auto_Bangumi/wiki
+[3]: https://github.com/EstrellaXD/Auto_Bangumi/wiki/部署说明/#开始前准备
+[4]: https://github.com/EstrellaXD/Auto_Bangumi/wiki
+[5]: https://github.com/EstrellaXD/Auto_Bangumi/wiki
+[6]: https://github.com/umbors/wecomchan-alifun
+[7]: https://github.com/easychen/wecomchan
+
+
+