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

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

139
docs/changelog/2.6.md Normal file
View File

@@ -0,0 +1,139 @@
# 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` 格式重命名,暂时不提供调整选项。
**标准路径**
```text
/downloads/Bangumi/剧集信息/Season 1/xxx
```
### 通知推送功能
AB 现在可以通过 `Telegram``ServerChan` 推送重命名完成的通知了。
在 WebUI 中,打开推送开关,并且填入所需的参数即可完成推送。
- Telegram 需要填入 Bot Token 和 Chat ID具体如何获取请参看各类教程。
- ServerChan 需要填入 Token具体如何获取请参看各类教程。

46
docs/changelog/3.0.md Normal file
View File

@@ -0,0 +1,46 @@
# 3.0 更新说明
### 全新的 WebUI
- 登陆功能,现在 AB 可以设定用户名和密码进行登陆。部分操作需要在登陆后才可以进行。
- 全新的海报墙
- 番剧管理功能
- 可以对番剧的季度信息名称进行修改,修改完成之后会自动修改**自动下载规则**/**已经下载完成的文件路径** 并重命名。
- 全新的链接解析器,解析完成链接之后可以手动更改下载信息,选择下载季度或者增加自动下载规则。
- 删除番剧,可以一键删除番剧以及其种子文件。
- 可以对单独番剧自定义下载规则,此规则与全局规则不冲突。
- 全新的配置界面,可以更方便的配置应用程序规则。
- 新增初始化启动页面,在第一次启动 AB 时会引导填入相关配置。
- 下载器链接检查器,可以检查与 qBittorrent 的连通性
- RSS 地址检查器,可以检查 RSS 是否有效。
- 新增程序管理按钮,可以在 WebUI 中启动停止程序。且可以重启容器。
### 解析器
- 全新的解析器,可以选择不同类型来源获取官方标题和海报地址。
- 支持更换 RSS 订阅源而不用重新生成数据库。
### 通知模块
- 新增 `Bark` 通知模块.
- 全新的通知方式,现在可以给 Telegram 推送海报,番剧名称,更新集数。
### 数据迁移
- 现在从旧版本升级可以自动迁移数据。
- 从旧版本迁移的数据也可以自动匹配海报。
## Fix
- 针对 Windows 路径可能出现的重命名 Bug。
## Change
-`json` 迁移至 `sqlite` 存储数据
- 从多进程迁移至多线程
- 重构主程序
- 加速启动关闭时间
- 重构解析器模块
- 重构重命名模块
- 暂时移除 `normal` 模式
- 增加 `ghcr.io` 镜像