nas/Auto_Bangumi
1
0
Fork 0
mirror of https://github.com/EstrellaXD/Auto_Bangumi.git synced 2026-04-13 09:59:45 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: 更新文档站结构，减少一层 src/ 目录嵌套

Browse Source
This commit is contained in:
zthxxx
2023-06-30 23:12:00 +08:00
parent 6ee81e3080
commit 877f29f995
23 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

171
docs/use/使用说明.md Normal file
View File

@@ -0,0 +1,171 @@
# API
## 与 AutoBangumi 数据相关的 API
### `api/v1/log`
查看日志
```bash
curl -X GET http://ab_host:7892/api/v1/log
```
### `api/v1/data`
获得当前 AB 中的存储信息
```bash
curl --request GET -sL \
--url 'http://ab_host:7892/api/v1/data'\
```
### `api/v1/resetRule`
重置 AB 的数据，程序会在下一轮检索中重新添加 RSS 订阅信息。
```bash
curl --request GET -sL \
--url 'http://ab_host:7892/api/v1/resetRule'\
```
### `api/v1/removeRule/{name}`
删除规则
```bash
curl --request GET -sL \
--url 'http://ab_host:7892/api/v1/removeRule/{name}'\
```
## 订阅相关的 API
如果番剧还在更新，请使用 subscribe 来订阅，如果番剧已经完结，请使用 collection 来下载。
### `api/v1/subscribe`
添加全集订阅
```bash
curl --request POST -sL \
--url 'http://host:7892/api/v1/subscribe'\
--data '{"rss_link":"link"}'\
--header 'Content-Type: application/json'
```
### `api/v1/collection/`
```bash
curl --request POST -sL \
--url 'http://host:7892/api/v1/collection/'\
--data '{"rss_link":"link"}'\
--header 'Content-Type: application/json'
```
# 环境变量说明
## 注意
环境变量相关配置在 `2.6` 以后的版本中已经移除，现在使用 `config.json` 来配置系统设置。
## 环境列表
| 环境变量 | 作用 | 参数 |
| ------------------------ | ---------------------------------------------------- | -------------------- |
| `TZ` | 时区 | `Asia/Shanghai` |
| `AB_INTERVAL_TIME` | 间隔时间 | `7200` |
| `AB_RENAME_FREQ` | 在一个运行周期内重命名频率 | `20` |
| `AB_DOWNLOADER_HOST` | qBittorrent 的地址和端口号 | `localhost:8080` |
| `AB_DOWNLOADER_USERNAME` | qBittorrent 的用户名 | `admin` |
| `AB_DOWNLOADER_PASSWORD` | qBittorrent 的密码 | `adminadmin` |
| `AB_METHOD` | 重命名方法 `normal` 保留字幕组信息， `pn` 为纯净模式 | `pn` |
| `AB_GROUP_TAG` | 是否在下载规则中添加组名 | `False` |
| `AB_DOWNLOAD_PATH` | qBittorrent 中的下载路径 | `/downloads/Bangumi` |
| `AB_RSS` | RSS 订阅地址 | 必填项 |
| `AB_ENABLE_TMDB` | 启动 TMDB 解析 | `False` |
| `AB_LANGUAGE` | 选择语言 | `zh` |
| `AB_NOT_CONTAIN` | 输入想要过滤的元素 | `720` |
| `AB_DEBUG_MODE` | 调试模式 | `False` |
| `AB_EP_COMPLETE` | 历史番剧下载 | `False` |
| `AB_REMOVE_BAD_BT` | 碰到无法重命名的合集等，自动删除种子 | `False` |
| `AB_WEBUI_PORT` | Web API | `7892 ` |
| `AB_HTTP_PROXY` | HTTP 代理 | `127.0.0.1:6352` |
| `AB_SOCKS` | SOCKS5 代理 | `HOST,PORT,USR,PWD` |
| `AB_RENAME` | RENAME 开关 | `True` |
| `AB_RSS_COLLECTOR` | RSS 解析器开关 | `True` |
| `AB_RESET_FOLDER` | 修复错误命名文件夹 | `False` |
## 进阶参数说明
### 与 qBittorrent 连接
- `AB_DOWNLOADER_HOST`: qBittorrent 的地址和端口号，如果开启 HTTPS 请使用 `https://` 开头。
### 运行相关
`AB_INTERVAL_TIME`: 解析器的运行间隔时间，单位为秒，默认为 7200 秒，即两个小时检查一次 RSS 更新。
`AB_RENAME_FREQ`: 在一个运行周期内重命名频率，默认为 20，即 6 分钟运行一次。
### 文件路径以及重命名相关
`AB_METHOD`: 重命名方法
- `normal` 保留字幕组
- `pn` 为纯净模式，不保留字幕组，不保留其他信息，只保留名称，会根据 `Season` 文件夹的名称重命名。
- `advance` 为高级模式，基于文件夹名称重命名，不保留其他信息。
- 源文件路径：`/downloads/Bangumi/约会大作战/Season 4/DATE A LIVE - 1.mp4` >> `/downloads/Bangumi/约会大作战/Season 1/约会大作战 S04E01.mp4`
- `none` 为空模式，不重命名。
`AB_ENABLE_TMDB`: 启动 TMDB 解析, 建议同时启用代理。
`AB_LANGUAGE`: TMDB 解析后选择语言，仅在 `TMDB` 开启时有效。
- `zh` 中文
- `jp` 日语
### 下载和过滤相关
`AB_GROUP_TAG`: 是否在下载规则中添加组名，方便查看。开启后规则命名为 [组名]规则名，关闭后规则命名为 [规则名]
`AB_NOT_CONTAIN`: 输入想要过滤的元素，如 720，1080，等。
- 不同的元素用 `|` 分隔，例如 `720|CHT`
- 可以使用正则表达式，但是需要注意，特殊符号需要转义，例如 `\(` 表示 `(`。
- 这个选项建议填写：`720|\d+-\d+`，如果过滤选项添加过多，会影响到正常的 RSS 识别。对于番剧单独的自定义可以在 qBitorrent 中自定义。
`AB_EP_COMPLETE`: 历史番剧下载，开启后，将会下载已加入时之前的剧集。
`AB_REMOVE_BAD_BT`: 碰到无法重命名的合集等，自动删除种子
`AB_RESET_FOLDER`: 修复错误命名文件夹，如 S01 >> Season 1
### 网络代理相关
`AB_WEBUI_PORT`: HTTP API Port
`AB_HTTP_PROXY`: 开启 HTTP 代理，填入 HTTP 代理服务器地址和端口号
`AB_SOCKS`:开启 SOCKS5 代理
- `HOST,PORT,USR,PWD`
### 调试模式
`AB_DEBUG_MODE`: 调试模式
### 功能开关
`AB_RENAME`: RENAME 开关
`AB_RSS_COLLECTOR`: RSS 解析器开关
# 如何正确的使用 AutoBangumi 以及 qBittorrent
## 如何使用 AB 重命名其他番剧
- 只需要在 QB 中将种子类型设置为 Bangumi 即可被 AB 识别并重命名。
## 以下操作不影响程序正常运行
- 在 QB 中更改自动下载规则，更改自动下载路径
- 在 QB 中按照规范更改文件路径

147
docs/use/配置选项说明.md Normal file
View File

@@ -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