docs: refactor, update docs to 3.0

2026-04-24 02:20:38 +08:00 · 2023-07-06 22:15:28 +08:00
parent 2e0a66f566
commit 8622ed3afd
31 changed files with 368 additions and 211 deletions
--- a/docs/config/downloader.md
+++ b/docs/config/downloader.md
@@ -0,0 +1,25 @@
+# 下载器设置
+
+## WebUI 设置
+
+![downloader](../image/config/downloader.png)
+
+- `type` 为下载器类型，目前支持 `qbittorrent` 下载器，目前暂不支持修改。
+- `host` 为下载器地址。[下载器链接问题][1]
+- `path` 为映射的下载器下载路径。[下载器路径问题][2]
+- `ssl` 为下载器是否使用 SSL。
+
+## `config.json` 中的配置选项
+
+在配置文件中对应选项如下：
+
+配置文件部分：`downloader`
+
+| 参数名      | 参数说明        | 参数类型 | WebUI 对应选项  | 默认值                |
+|----------|-------------|------|-------------|--------------------|
+| type     | 下载器类型       | 字符串  | 下载器类型       | qbittorrent        |
+| host     | 下载器地址       | 字符串  | 下载器地址       | 172.17.0.1:8080    |
+| username | 下载器用户名      | 字符串  | 下载器用户名      | admin              |
+| password | 下载器密码       | 字符串  | 下载器密码       | adminadmin         |
+| path     | 下载器下载路径     | 字符串  | 下载器下载路径     | /downloads/Bangumi |
+| ssl      | 下载器是否使用 SSL | 布尔值  | 下载器是否使用 SSL | false              |
--- a/docs/config/notifier.md
+++ b/docs/config/notifier.md
@@ -0,0 +1,25 @@
+# 通知配置
+
+## WebUI 配置
+
+![notification](../image/config/notifier.png)
+
+- `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]
+
+
+## `config.json` 中的配置选项
+
+在配置文件中对应选项如下：
+
+配置文件部分：`notification`
+
+| 参数名     | 参数说明       | 参数类型 | WebUI 对应选项 | 默认值      |
+|---------|------------|------|------------|----------|
+| enable  | 是否启用通知     | 布尔值  | 通知         | false    |
+| type    | 通知类型       | 字符串  | 通知类型       | telegram |
+| token   | 通知 Token   | 字符串  | 通知 Token   |
+| chat_id | 通知 Chat ID | 字符串  | 通知 Chat ID |
+
--- a/docs/config/parser.md
+++ b/docs/config/parser.md
@@ -0,0 +1,39 @@
+# 解析器设置
+
+AB 的解析器用于解析聚合 RSS 链接，如果 RSS 有新条目更新，AB 就会解析标题并且生成自动下载规则。
+
+## Webui 中的解析器设置
+
+![parser](../image/config/parser.png)
+
+- Enable: 是否启用 RSS 解析器。
+- Source 为 RSS 解析器类型，目前支持 `mikan` 。
+- Token 为蜜柑计划的 Token。[蜜柑计划 Token 获取][rss_token]
+- Custom_url 为自定义蜜柑计划地址。[自定义反代地址][reproxy]
+- Language 为 RSS 解析器语言，目前支持 `zh` 、 `jp` 、 `en` 三种语言。
+- Parser_type 为 **官方标题** 解析器解析类型，支持类型如下：
+  - parser 为正则表达式解析器，使用正则表达式解析标题。
+  - mikan 为蜜柑计划解析器，使用蜜柑计划解析标题。
+  - tmdb 为 TMDB 解析器，使用 TMDB 解析标题。
+- Exclude 为全局 RSS 解析器过滤器，可以填入字符串或者正则表达式，AB 在解析 RSS 时会过滤掉符合过滤器的条目。
+
+
+## `config.json` 中的配置选项
+
+在配置文件中对应选项如下：
+
+配置文件部分：`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            |
+
+
+[rss_token]: rss
+[reproxy]: proxy##反向代理设置
--- a/docs/config/program.md
+++ b/docs/config/program.md
@@ -0,0 +1,23 @@
+# 主程序运行配置
+
+## WebUI 配置
+
+![program](../image/config/program.png)
+
+
+## `config.json` 中的配置选项
+
+在配置文件中对应选项如下：
+
+配置文件部分：`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 端口，请修改此参数。
--- a/docs/config/proxy.md
+++ b/docs/config/proxy.md
@@ -0,0 +1,28 @@
+# 代理和反向代理
+
+AB 支持 HTTP 代理和 SOCKS5 代理，通过设置代理可以解决一些网络问题。
+
+## 代理
+
+
+## 反向代理设置
+
+
+## `config.json` 中的配置选项
+
+在配置文件中对应选项如下：
+
+配置文件部分：`proxy`
+
+| 参数名      | 参数说明   | 参数类型 | WebUI 对应选项 | 默认值   |
+|----------|--------|------|------------|-------|
+| enable   | 是否启用代理 | 布尔值  | 代理         | false |
+| type     | 代理类型   | 字符串  | 代理类型       | http  |
+| host     | 代理地址   | 字符串  | 代理地址       |
+| port     | 代理端口   | 整数   | 代理端口       |
+| username | 代理用户名  | 字符串  | 代理用户名      |
+| password | 代理密码   | 字符串  | 代理密码       |
+
+
+- `type` 为代理类型，目前支持 `http` 、 `socks5` 两种类型。
+- `username` 与 `password` 仅支持 `socks5` 代理。
--- a/docs/config/rss.md
+++ b/docs/config/rss.md
@@ -0,0 +1,36 @@
+# 准备 Mikan RSS 订阅链接
+
+AutoBangumi 可以自动解析 [Mikan Project][mikan-site] 的 RSS 订阅地址，根据字幕组以及番剧名称生成下载规则， 从而实现自动追番。
+因此在开始自动追番之前，你需要准备好 [Mikan Project][mikan-site] 的 RSS 订阅地址。
+
+需要注意的是，目前 Mikan Project 主站已经被墙，当你不知道如何使用代理时请使用如下链接进行访问订阅：
+
+[Mikan Project CN][mikan-cn-site]
+
+## 获取订阅地址
+
+本项目基于解析 Mikan Project 提供的 RSS 地址，因此如果要实现自动追番，需要注册并且获得 Mikan Project 的 RSS 地址：
+
+![image](../image/rss/rss-token.png)
+
+获取的 RSS 地址如下：
+
+```txt
+https://mikanani.me/RSS/MyBangumi?token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+# 或者
+https://mikanime.tv/RSS/MyBangumi?token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+```
+
+AB 中需要填入的 `token` 为以上 url 中 `token=` 后面的一串字符。
+
+## Mikan Project 订阅贴士
+
+由于 AutoBangumi 会解析所有获得的 RSS 信息，因此在订阅番剧的时候需要注意以下几点：
+
+![image](../image/rss/advanced-subscription.png)
+
+- 在个人设置中打开高级设置。
+- 一部番剧只订阅一个字幕组，点击 Mikan Project 的番剧图片即可呼出二级菜单，选择一个字幕组订阅即可。
+- 如果字幕组有简体繁体不同的字幕，Mikan Project 大多时候提供了选择订阅的方式，选择一种字幕订阅。
+- 如果不提供简繁选择，那么可以在 AutoBangumi 中设置 `filter` 进行过滤，也可以在规则生成之后进入 qBittorrent 中手动过滤。
+- 目前不支持 OVA 以及 剧场版 的订阅解析。