- 重构目录
- 完成 repath 模块
This commit is contained in:
EstrellaXD
2022-07-15 22:29:31 +08:00
parent 20d7241da8
commit a5cd0e6537
16 changed files with 0 additions and 235 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.7 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 113 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 183 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.7 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 159 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 120 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 114 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 101 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 372 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 166 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 132 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.6 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.8 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.5 MiB

View File

@@ -1,14 +0,0 @@
# 常见 bug 以及解决方式
## 无法连接到 qBittorrent
- 检查 HOST 是否正确,正确格式为 `<IP_ADDR>:<PORT>` `127.0.0.1:8080`
- 检查容器 `network` 是否为 `host`, 如果是 `bridge` 需要填入 qb 容器的实际地址。
## 无法连接 `mikanani.me`
- 检查宿主机器是否可以 `ping` 通蜜柑计划
- 更改宿主机器或者容器的 `DNS` 选项设置
- 订阅番组太多mikanani 无法快速解析,推荐一个番组只订阅一个字幕组。
## 下载错误番剧,重命名失败
- 目前不支持合集剧场版OVA 等订阅。
- 检查订阅是否错误。
- 订阅时请遵循:一个番剧订阅一个字幕组的一种语言

View File

@@ -1,221 +0,0 @@
# 部署说明
## 开始前的准备
**AutoBangumi** 可以使用 Docker 运行,也可以直接从源代码运行,鉴于追番是一个 7x24 小时的过程,**推荐**在 NAS 或者 Linux 服务器中使用 Docker 运行。
## 获取 Mikan Project RSS 订阅地址
本项目基于解析 Mikan Project 提供的 RSS 地址,因此如果要实现自动追番,需要注册并且获得 Mikan Project 的 RSS 地址:
![image.png](https://github.com/EstrellaXD/Auto_Bangumi/blob/main/docs/image/截屏2022-06-05%2018.13.31.png?raw=true)
### Mikan Project 订阅提醒
由于 AutoBangumi 会解析所有获得的 RSS 信息,因此在订阅番剧的时候需要注意以下几点:
- 一部番剧只订阅一个字幕组,点击 Mikan Project 的番剧图片即可呼出二级菜单,选择一个字幕组订阅即可。
- 如果字幕组有简体繁体不同的字幕Mikan Project 大多时候提供了选择订阅的方式,选择一种字幕订阅。
- 如果不提供简繁选择,那么可以在 AutoBangumi 中设置 `AB_NOT_CONTAIN` 进行过滤,也可以在规则生成之后进入 qBittorrent 中手动过滤。
- 目前不支持 OVA 以及 剧场版 的订阅解析。
## 安装 Docker 以及 Docker Compose
- [安装 Docker 英文](https://docs.docker.com/get-docker/)
- [安装 Docker-Compose 英文](https://docs.docker.com/compose/)
- [安装 Docker 中文](https://sspai.com/post/56893)
- [Docker Compose教程](https://sspai.com/post/66013)
推荐使用 Docker Compose 一键部署本项目
## 安装 qBittorrent 和媒体库
如果你选择使用 Docker Compose 的方式安装,可以跳过这一步。
如果你已经配置好已有的 qBittorrent 也可以跳过这一步。
### 使用 Docker 安装 qBittorrent
- [安装说明](https://github.com/linuxserver/docker-qbittorrent)
- [群晖安装 qBittorrent](https://post.smzdm.com/p/a5k64587/)
-----
# 部署 AutoBangumi
## 在 Linux 主机中使用 **Docker Compose** 一键部署
现在提供了一键部署的 **AutoBangumi** 的方法,可以使用 `docker-compose.yml` 文件进行部署。
正常来说安装完 Docker 之后都会自带 `docker-compose`,使用命令:
```bash
docker-compose -v
```
检查版本即可
### 部署 **AutoBangumi**
项目中提供了三种安装方式:
- 只安装 **AutoBangumi**
```bash
wget https://raw.githubusercontent.com/EstrellaXD/Auto_Bangumi/main/docs/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
```
1. 首先选择你要安装的方式,**拷贝上面的命令运行即可**,这一步是下载 `docker-compose` 配置文件,如果需要自定义可以使用文本编辑器对其中的参数进行自定义。
2. **定义环境变量**
```shell
export \
DOWNLOAD_PATH=/path/downloads \
RSS=<RSS_LINK> \
QB_PORT=<YOUR_PORT>
```
- `DOWNLOAD_PATH`: 写你的下载文件保存的地方:
- 如果已经在 Docker 中部署过 qBittorrent 这里请填写相对路径,比如:`/downloads/Bangumi`
- 如果是部署合集,或者直接不在 Docker 安装 qBittorrent 请填写想要下载的绝对路径,比如: `/home/NAS/downloads`
- `RSS`: 填写你的[蜜柑计划](https://mikanani.me)订阅地址,在最开始已经说明了如何获取。
- `QB_PORT`: 填写你的已经部署的 qBittorrent 端口号,或者想要自定义的端口号,比如: `8080`
3. **拉起 Docker-Compose**
```bash
docker-compose up
```
4. 如果想要自定义参数,可以参考文章最开头的说明进行自定义
## 使用 Docker-cli 部署
添加环境变量(注意这里最好手动输入)详细内容请参考 [Docker Compose]() 章节中同样内容
```shell
export \
DOWNLOAD_PATH=/path/downloads \
RSS=<RSS_LINK> \
```
复制以下命令运行即可。
```shell
docker run -d \
--name=AutoBangumi \
-e AB_DOWNLOAD_PATH=$DOWNLOAD_PATH \
-e AB_RSS=$RSS \
--network=host \
--dns=8.8.8.8 \
--restart unless-stopped \
estrellaxd/auto_bangumi:latest
```
注意如果你的 qBittorrent 的 WebUI 不是默认端口,还需要按照完成的配置方式进行配置。
```shell
docker run -d \
--name=AutoBangumi \
-e TZ=Asia/Shanghai \ #optional
-e AB_INTERVAL_TIME=7200 \ #optional
-e AB_DOWNLOADER_HOST=localhost:8080 \ #optional
-e AB_DOWNLOADER_USERNAME=admin \ #optional
-e AB_DOWNLOADER_PASSWORD=adminadmin \ #optional
-e AB_METHOD=pn \ #optional
-e AB_GROUP_TAG=True \ #optional
-e AB_DOWNLOAD_PATH=/path/downloads \
-e AB_NOT_CONTAIN=720 \ #optional
-e AB_RSS=<YOUR_RSS_ADDRESS> \
--network=host \
--dns=8.8.8.8 \
--restart unless-stopped \
estrellaxd/auto_bangumi:latest
```
推荐使用 *[Portainer](https://www.portainer.io)* 等带有 UI 的 Docker 管理器进行进阶部署
## 群晖部署说明( QNAP 同理)
### 安装 Docker 套件
![docker.png](https://github.com/EstrellaXD/Auto_Bangumi/blob/main/docs/image/synology/docker.png)
### 在 Docker 中搜索 AutoBangumi 并且拉取
![ab.png](https://github.com/EstrellaXD/Auto_Bangumi/blob/main/docs/image/synology/auto_bangumi.png)
### 配置 AutoBangumi
![conf1.png](https://github.com/EstrellaXD/Auto_Bangumi/blob/main/docs/image/synology/config1.png)
![conf1.png](https://github.com/EstrellaXD/Auto_Bangumi/blob/main/docs/image/synology/config2.png)
![conf1.png](https://github.com/EstrellaXD/Auto_Bangumi/blob/main/docs/image/synology/config3.png)
![conf1.png](https://github.com/EstrellaXD/Auto_Bangumi/blob/main/docs/image/synology/finished.png)
### 如果你还没有安装 qBittorrent
配置如下:
![conf1.png](https://github.com/EstrellaXD/Auto_Bangumi/blob/main/docs/image/synology/qbconf1.png)
![conf1.png](https://github.com/EstrellaXD/Auto_Bangumi/blob/main/docs/image/synology/qbconf2.png)
![conf1.png](https://github.com/EstrellaXD/Auto_Bangumi/blob/main/docs/image/synology/qbconf3.png)
### 运行结果
![conf1.png](https://github.com/EstrellaXD/Auto_Bangumi/blob/main/docs/image/synology/run.png)
## 部署结果:
```other
2022-06-05 16:38:49 INFO: Add RSS Feed successfully.
2022-06-05 16:38:50 INFO: Adding Kawaii dake ja Nai Shikimori-san Season 1
2022-06-05 16:38:50 INFO: Adding Kakkou no Iinazuke Season 1
2022-06-05 16:38:50 INFO: Adding SPYxFAMILY Season 1
2022-06-05 16:38:50 INFO: Adding Love Live虹咲学园 学园偶像同好会 Season 2
2022-06-05 16:38:50 INFO: Adding CUE! Season 1
2022-06-05 16:38:50 INFO: Adding Kaguya-sama wa Kokurasetai Season 3
2022-06-05 16:38:50 INFO: Adding Shokei Shoujo no Virgin Road Season 1
2022-06-05 16:38:50 INFO: Adding Kakkou no Iikagen Season 1
2022-06-05 16:38:50 INFO: Adding Summer Time Rendering Season 1
2022-06-05 16:38:50 INFO: Adding Mahoutsukai Reimeiki Season 1
2022-06-05 16:38:50 INFO: Adding Paripi Koumei Season 1
2022-06-05 16:38:50 INFO: Adding Komi-san wa, Komyushou Desu. Season 1
2022-06-05 16:38:50 INFO: Adding Deaimon Season 1
2022-06-05 16:38:50 INFO: Adding Tate no Yuusha no Nariagari Season 2
2022-06-05 16:38:50 INFO: Adding Shijou Saikyou no Daimaou Season 1
2022-06-05 16:38:50 INFO: Adding Yuusha, Yamemasu Season 1
2022-06-05 16:38:50 INFO: Adding Tomodachi Game Season 1
2022-06-05 16:38:50 INFO: Adding Machikado Mazoku: 2-choume Season 1
2022-06-05 16:38:50 INFO: Start collecting past episodes.
2022-06-05 16:39:32 INFO: Start adding rules.
2022-06-05 16:39:32 INFO: Finished.
2022-06-05 16:39:32 INFO: Waiting for downloading torrents...
2022-06-05 16:49:32 INFO: Finished checking 185 file's name.
2022-06-05 16:49:32 INFO: Renamed 0 files.
2022-06-05 16:49:32 INFO: Finished rename process.
```
## `AutoBangumi` 环境变量说明
| 环境变量 | 作用 | 参数 |
|--------------------------|---------------------------------------|----------------------|
| `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` |
- RENAME 模式:
- `pn`
- `normal`
- `advance`
# FAQ
- `AB_DOWNLOADER_PATH` 到底写什么?
- 这个参数只要和你 qBittorrent 中的参数保持一致即可。
- Docker比如 qB 中是 `/downloads` 那就写 `/downloads/Bangumi``Bangumi`可以任意更改。
- Linux/macOS如果是 `/home/usr/downloads` 或者 `/User/UserName/Downloads` 只要在最后再加一行 `Bangumi` 就行。
- Windows`D:\Media\`, 改为 `D:\Media\Bangumi`
- 没有开始自动下载怎么办:
- 检查 AutoBangumi 的日志,如果日志一切正常,说明是 qBittorrent 的问题,检查:
- 设置 >> RSS >> 启用 RSS Torrent 自动下载
- Options >> RSS >> Enable auto downloading of RSS torrents
- 设置 >> RSS >> 启用获取 RSS 订阅
- Options >> RSS >> Enable fetching RSS feeds
- 检查 qb 配置,看是否有权限新建文件夹
- 没有自动重命名怎么办:
- 首次运行会等待十分钟等待下载完成才会开始重命名。
- 如果 `Finished checking` 后有文件个数,但是无法重命名请重新部署。
- `rename failed` 通常是碰到带有文件夹的合集,目前并不支持这类重命名
- [错误排查](https://github.com/EstrellaXD/Auto_Bangumi/blob/main/docs/常见错误解决.md)
**出现错误请先检查文档再提问!!!!!!**