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

docs: move resource. Add rename feature explain.

Browse Source
This commit is contained in:
EstrellaXD
2023-10-10 13:03:42 +08:00
parent e966f0d435
commit e3281a6fca
7 changed files with 54 additions and 156 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/deploy/docker-compose.md
View File

@@ -61,15 +61,11 @@ services:
- 只安装 **AutoBangumi**
```bash
wget https://raw.githubusercontent.com/EstrellaXD/Auto_Bangumi/main/docs/docker-compose/AutoBangumi/docker-compose.yml
wget https://raw.githubusercontent.com/EstrellaXD/Auto_Bangumi/main/docs/resource/docker-compose/AutoBangumi/docker-compose.yml
```
- 安装 **qBittorrent** 与 **AutoBangumi**
```bash
wget https://raw.githubusercontent.com/EstrellaXD/Auto_Bangumi/main/docs/docker-compose/qBittorrent+AutoBangumi/docker-compose.yml
```
- **qBittorrent** + **AutoBangumi** + **Plex**
```bash
wget https://raw.githubusercontent.com/EstrellaXD/Auto_Bangumi/main/docs/docker-compose/All-in-one/docker-compose.yml
wget https://raw.githubusercontent.com/EstrellaXD/Auto_Bangumi/main/docs/resource/docker-compose/qBittorrent+AutoBangumi/docker-compose.yml
```
首先选择你要安装的方式，**拷贝上面的命令运行即可**，这一步是下载 `docker-compose.yml` 配置文件，如果需要自定义可以使用文本编辑器对其中的参数进行自定义。

39
docs/feature/rename.md
View File

@@ -1,2 +1,41 @@
# 重命名使用说明
AB 现在提供了三种重命名方式，分别为 `pn`、`advance` 和 `none`。
### pn
全称为 `pure name`，即纯番剧名，这种方式会把番剧名作为文件名，不会添加任何前缀。
pn 根据种子文件的下载名称进行重命名。
如：
```
[Lilith-Raws] 86 - Eighty Six - 01 [Baha][WEB-DL][1080p][AVC AAC][CHT][MKV].mkv
>>
86 - Eighty Six S01E01.mkv
```
### advance
高级重命名，这种方式会把文件夹名用于重命名。
```
/downloads/Bangumi/86 - Eighty Six(2023)/Season 1/[Lilith-Raws] 86 - Eighty Six - 01 [Baha][WEB-DL][1080p][AVC AAC][CHT][MKV].mkv
>>
86 - Eighty Six(2023) S01E01.mkv
```
### none
不重命名，这种方式不会对文件进行重命名。
## 合集重命名
AB 支持对合集进行重命名，合集重命名需要满足以下条件：
- 剧集都在合集的一级目录下
- 可以解析出剧集的集数
同时 AB 也可以对在一级目录下的字幕文件进行重命名。
重命名之后的剧集和目录都会被放到 `Season` 文件夹下。
重命名的合集会被移动分类至 `BangumiCollection`。

8
docs/feature/rss.md
View File

@@ -1,3 +1,7 @@
---
title: RSS 管理
---
# RSS 管理使用说明
## 添加合集
@@ -34,7 +38,9 @@ AB 支持解析所有资源站的合集 RSS 链接，在对应的资源站找到
在 3.0 之后 AB 可以手动删除番剧，点击番剧海报，进入番剧信息页面，点击 **Delete** 即可删除番剧。
⚠️删除番剧之后，如果 RSS 中没有取消订阅，AB 仍然会重新解析，如果想禁用下载规则请使用[禁用番剧](#禁用番剧)
::: warning
删除番剧之后，如果 RSS 中没有取消订阅，AB 仍然会重新解析，如果想禁用下载规则请使用[禁用番剧](#禁用番剧)
:::
### 禁用番剧

8
docs/feature/search.md
View File

@@ -4,13 +4,17 @@
## 使用搜索功能
::: warning
搜索功能依赖主程序的解析器，当前版本不允许解析合集。解析合集提示 `warning` 为正常现象。
:::
搜索栏位于 AB 顶栏，可以在搜索栏右侧选择想要搜索的源站，比如：蜜柑计划、nyaa 等
选择对应的源站输入关键词，AB 即可自动解析搜索结果并展示。如果想要添加对应的番剧，点击卡片右侧的添加按钮即可。
## ⚠️注意
::: tip
源站为 **Mikan** 是 AB 默认使用 `mikan` 解析器，如果使用其他源站，默认使用 TMDB 解析器。
:::
## 增加源站

147
docs/feature/配置选项说明.md
View File

@@ -1,147 +0,0 @@
# 配置选项说明
从 `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

0
docs/docker-compose/AutoBangumi/docker-compose.yml → docs/resource/docker-compose/AutoBangumi/docker-compose.yml
View File

0
docs/docker-compose/qBittorrent+AutoBangumi/docker-compose.yml → docs/resource/docker-compose/qBittorrent+AutoBangumi/docker-compose.yml
View File