Files
Auto_Bangumi/docs/changelog/2.6.md
2023-07-06 22:15:28 +08:00

139 lines
5.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 2.6 版本更新说明
## 如何从老版本更新的注意事项
从 2.6 版本开始AutoBangumi (以下简称 AB的配置文件将会从环境变量更改为 `config.json` 升级之前需要注意以下事项。
### 环境变量继承
老的环境变量会在升级到 2.6 版本后第一次启动时自动转换为 `config.json`,生成的 `config.json` 会放在 `/app/config` 文件夹内。
当你已经映射了 `/app/config` 文件夹之后,老的环境变量将不对 AB 运行产生影响,但是你可以通过删除 `config.json` 来重新使用环境变量生成配置。
### 容器 Volume 映射
2.6 版本之后需要映射的文件夹有:
- `/app/config`:配置文件夹,包含 `config.json`
- `/app/data`:数据文件夹,包含 `bangumi.json`
### 数据文件
新版本进行了大规模更新因此我们不建议你使用老的数据文件AB 会自动生成新的数据文件 `bangumi.json` 保存在 `/app/data` 中。
但是不用担心QB 不会重复下载已经下载过的番剧。
### 后续配置更改
现在 AB 可以在 WebUI 中直接编辑配置了,编辑完成之后只需要重启容器就可以立刻生效。
## 如何升级
### Docker compose
你可以用老的 docker-compose.yml 文件升级。
```bash
docker compose stop autobangumi
docker compose pull autobangumi
```
然后修改 docker-compose.yml 文件,添加 `volumes` 映射。
```yaml
version: "3.8"
services:
autobangumi:
image: estrellaxd/auto_bangumi:latest
container_name: autobangumi
restart: unless-stopped
environment:
- PUID=1000
- PGID=1000
- TZ=Asia/Shanghai
volumes:
- /path/to/config:/app/config
- /path/to/data:/app/data
networks:
- bridge
dns:
- 223.5.5.5
```
然后拉起 AB 即可
```bash
docker compose up -d autobangumi
```
### Portainer
你可以在 `Portainer` 中修改映射文件地址之后点击 `Recreate` 即可完成升级
### 如果升级出现了问题需要怎么做
由于每个人配置可能不尽相同,现在升级可能会出现程序无法运行的问题,此时删除掉所有以前的数据以及生成的配置文件后重启容器。
然后在 WebUI 中重新配置一下即可。
## 新版本特性
### 配置方式更改
2.6 版本之后配置程序的方式从修改 Docker 中的环境变量更改为修改 `config.json`
新版 WebUI 也提供了网页版修改配置的功能。可以访问 AB 地址,在左侧边栏找到 `配置` 即可修改。
修改完成之后重启容器即可。
### 自定义反向代理 URL 和 AB 作为反代中转
为了应对 [蜜柑计划](https://mikanani.me) 无法访问的情况AB 增加了三种应对的方式。
1. HTTP 以及 Socks 代理
老版本的 AB 就有这项功能,升级到 2.6 版本之后只需要在 WebUI 中检查代理配置即可正常访问蜜柑计划。
不过这时候 qBittorrent 无法正常访问蜜柑计划的 RSS 和种子地址,因此需要在 qBittorrent 中添加代理。详情可以查看 #198
2. 自定义反向代理 URL
2.6 版本的 AB 在配置中增加了 `custom_url` 选项,可以自定义反向代理的 URL。
可以在配置中设置为自己正确设置的反代 URL。这样 AB 就会使用自定义的 URL 来访问蜜柑计划。并且 QB 也可以正常下载。
3. AB 作为反代中转
在 AB 配置代理之后AB 自身可以作为本地的反代中转。不过目前仅开放 RSS 相关功能的反代。
这时候只需要把 `custom_url` 设置为 `http://abhost:abport` 即可。 `abhost` 为 AB 的 IP 地址,`abport` 为 AB 的端口。
此时 AB 会把自身地址推送给 qBittorrentqBittorrent 会使用 AB 的地址作为反代来访问蜜柑计划。
请注意,此时如果你没有用 NGINX 等工具对 AB 进行反代,请填入 `http://` 来保证程序正常运行。
**注意事项**
需要注意的是,如果 AB 和 QB 在同一个容器中,请不要用 `127.0.0.1` 或者 `localhost`,因为这样会导致 AB QB 无法互相访问。
如果在同一个网络中,可以使用容器名寻址的方式来访问。如 `http://autobangumi:7892`
也可以使用 Docker 路由地址访问如 `http://172.17.0.1:7892`
如果在不同宿主机中,可以使用宿主机 IP 地址访问。
### 合集以及文件夹重命名
AB 现在可以对合集以及文件夹内的文件进行重命名了,此时 AB 会把文件夹内的媒体文件重新放置到根目录中。
需要注意的是,目前 AB 还依赖保存路径来判断季度信息和剧集信息,所以请按照 AB 的标准放置合集文件。
**2.6.4** 版本后AB 可以对文件夹内的字幕进行重命名,不过该功能暂时在适配中。合集和字幕默认以 `pn` 格式重命名,暂时不提供调整选项。
**标准路径**
```
/downloads/Bangumi/剧集信息/Season 1/xxx
```
### 通知推送功能
AB 现在可以通过 `Telegram``ServerChan` 推送重命名完成的通知了。
在 WebUI 中,打开推送开关,并且填入所需的参数即可完成推送。
- Telegram 需要填入 Bot Token 和 Chat ID具体如何获取请参看各类教程。
- ServerChan 需要填入 Token具体如何获取请参看各类教程。