nas/Auto_Bangumi
1
0
Fork 0
mirror of https://github.com/EstrellaXD/Auto_Bangumi.git synced 2026-04-14 02:20:53 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: refactor, update docs to 3.0

Browse Source
This commit is contained in:
EstrellaXD
2023-07-06 22:15:28 +08:00
parent 2e0a66f566
commit 8622ed3afd
31 changed files with 368 additions and 211 deletions
Download Patch File Download Diff File Expand all files Collapse all files

101
docs/deploy/Docker-compose.md
View File

@@ -1,101 +0,0 @@
## 安装 **Docker Compose**
现在提供了一键部署的 **AutoBangumi** 的方法，可以使用 `docker-compose.yml` 文件进行部署。
正常来说安装完 Docker 之后都会自带 `docker-compose`，使用命令：
```bash
docker compose -v
```
检查版本即可
如果没有安装，可以使用以下命令安装：
```bash
$ sudo apt-get update
$ sudo apt-get install docker-compose-plugin
```
## 部署 **AutoBangumi**
### 创建 AutoBangumi 文件夹
```bash
mkdir AutoBangumi
cd AutoBangumi
```
### 下载 Docker Compose 配置文件
项目中提供了三种安装方式：
- 只安装 **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
```
首先选择你要安装的方式，**拷贝上面的命令运行即可**，这一步是下载 `docker-compose.yml` 配置文件，如果需要自定义可以使用文本编辑器对其中的参数进行自定义。
### 定义环境变量
如果你是用上面下载的 AB+QB / AB+QB+Plex 的 Docker-Compose 文件，那么你需要定义以下环境变量：
```shell
export \
QB_PORT=<YOUR_PORT>
```
- `QB_PORT`: 填写你的已经部署的 qBittorrent 端口号，或者想要自定义的端口号，比如: `8080`
- `DOWNLOAD_PATH`: 填写你的文件下载路径
如果你不想使用环境变量，也可以拉起 Docker-Compose 后在 WebUI 中进行配置。
### 拉起 Docker-Compose
```bash
# 如果配置过了上面的环境变量，请使用下面的方式拉起
docker compose up -d
# 如果没有手动配置上面的环境变量，请使用下面的方式拉起
QB_PORT=<QB_PORT> DOWNLOAD_PATH=<YOUR_DOWNLOAD_PATH> docker compose up -d
```
## 部署结果：
```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.
```

0
docs/deploy/Docker-cli.md → docs/deploy/docker-cli.md
View File

95
docs/deploy/docker-compose.md Normal file
View File

@@ -0,0 +1,95 @@
# 通过 Docker Compose 部署 AutoBangumi
现在提供了一键部署的 **AutoBangumi** 的方法，可以使用 `docker-compose.yml` 文件进行部署。
## 安装 Docker Compose
正常来说安装完 Docker 之后都会自带 `docker-compose`，使用命令：
```bash
docker compose -v
```
检查版本即可
如果没有安装，可以使用以下命令安装：
```bash
$ sudo apt-get update
$ sudo apt-get install docker-compose-plugin
```
## 部署 **AutoBangumi**
### 创建 AutoBangumi 文件夹
```bash
mkdir AutoBangumi
cd AutoBangumi
```
### 选项1: 自定义 Docker Compose 配置文件
```yaml
version: "3.8"
services:
AutoBangumi:
image: estrellaxd/auto_bangumi:latest
container_name: AutoBangumi
volumes:
- ./config:/app/config
- ./data:/app/data
ports:
- "7892:7892"
restart: unless-stopped
dns:
- 223.5.5.5
volumes:
AutoBangumi_config:
name: AutoBangumi_config
AutoBangumi_data:
name: AutoBangumi_data
```
复制上面的内容到 `docker-compose.yml` 文件中。
### 选项2: 下载 Docker Compose 配置文件
当你不想自己创建 `docker-compose.yml` 文件时，
项目中提供了三种安装方式：
- 只安装 **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
```
首先选择你要安装的方式，**拷贝上面的命令运行即可**，这一步是下载 `docker-compose.yml` 配置文件，如果需要自定义可以使用文本编辑器对其中的参数进行自定义。
### 定义环境变量
如果你是用上面下载的 AB+QB / AB+QB+Plex 的 Docker-Compose 文件，那么你需要定义以下环境变量：
```shell
export \
QB_PORT=<YOUR_PORT>
```
- `QB_PORT`: 填写你的已经部署的 qBittorrent 端口号，或者想要自定义的端口号，比如: `8080`
### 拉起 Docker-Compose
```bash
# 如果配置过了上面的环境变量，请使用下面的方式拉起
docker compose up -d
```

44
docs/deploy/dsm.md Normal file
View File

@@ -0,0 +1,44 @@
# 群晖 (DSM 7.2) 部署说明（ QNAP 同理）
在 DSM 7.2 中，已经支持了 Docker Compose，推荐使用 Docker Compose 一键部署本项目。
## 创建配置和数据存储文件夹
## 安装 Container Manager (Docker) 套件
进入套件中心，安装 Container Manager (Docker) 套件。
![install-docker](../image/dsm/install-docker.png)
## 通过 Docker compose 安装配置 AB
点击 **项目**，然后点击 **新建**，选择 **Docker Compose**。
![new-compose](../image/dsm/new-compose.png)
复制以下内容填入 **Docker Compose** 中。
```yaml
version: "3.8"
services:
ab:
image: "ghcr.io/estrellaxd/auto_bangumi:latest"
container_name: "auto_bangumi"
restart: unless-stopped
ports:
- "7892:7892"
volumes:
- "/volume1/docker/ab/config:/app/config"
- "/volume1/docker/ab/data:/app/data"
- "/volume1/docker/ab/log:/app/log"
```
点击 **下一步**，然后点击 **完成**。
![create](../image/dsm/create.png)
完成创建之后进入 `http://<NAS IP>:7892` 即可进入 AB 并进行配置。

5
docs/deploy/quickstart.md → docs/deploy/quick-start.md
View File

@@ -1,7 +1,7 @@
## 快速开始
我们推荐你在 Docker 中部署运行 AutoBangumi。
部署前请确认已经安装了 Docker Engine。
部署前请确认已经安装了 [Docker Engine][docker-engine] 或者 [Docker Desktop][docker-desktop]。
### 创建数据和配置文件夹
@@ -61,3 +61,6 @@ volumes:
此时 AB 的 WebUI 会自动运行，但是主程序会处于暂停状态，可以进入 `http://abhost:7892` 进行配置。
[docker-engine]: https://docs.docker.com/engine/install/
[docker-desktop]: https://www.docker.com/products/docker-desktop

0
docs/deploy/local-run.md → docs/deploy/unix.md
View File

3
docs/deploy/Windows-本地部署.md → docs/deploy/windows.md
View File

@@ -1,3 +1,6 @@
# Windows 本地部署
1. 克隆并进入 AutoBangumi 的 `git` 仓库：
```powershell

11
docs/deploy/wsl.md
View File

@@ -17,9 +17,9 @@ services:
- GID=1000
- QB_WEBUI_PORT=8989
ports:
- 6881:6881
- 6881:6881/udp
- 8989:8989
- "6881:6881"
- "6881:6881/udp"
- "8989:8989"
volumes:
- qb_config:/config
- /mnt/g/animation:/Downloads #下载路径，对应 Windows上目录是 G:\animation
@@ -42,8 +42,8 @@ services:
- PGID=1000
- TZ=Asia/Shanghai
- AB_DOWNLOADER_HOST=qbittorrent:8989
- AB_DOWNLOADER_USERNAME=admin
- AB_DOWNLOADER_PASSWORD=adminadmin
- AB_DOWNLOADER_USERNAME=admin
- AB_DOWNLOADER_PASSWORD=adminadmin
- AB_NOT_CONTAIN=720|繁体|CHT|JPTC|繁日|BIG5
- AB_DOWNLOAD_PATH=/Downloads #qbittorrent 映射的地址，否者可能提示下载失败
- AB_RSS=https://mikanani.me/RSS/MyBangumi?token=xxxxxxxx%3d%3d #订阅地址，改成自己的
@@ -58,5 +58,4 @@ volumes:
external: false
auto_bangumi:
external: false
```

26
docs/deploy/群晖.md
View File

@@ -1,26 +0,0 @@
## 群晖部署说明（ QNAP 同理）
1. 安装 Docker 套件
![docker.png](https://tva1.sinaimg.cn/large/e6c9d24ely1h47zd8accwj20zc0u0wh4.jpg) 2. 在 Docker 中搜索 AutoBangumi 并且拉取
![ab.png](https://tva1.sinaimg.cn/large/e6c9d24ely1h47zd8zrv1j20zc0u0dka.jpg) 3. 配置 AutoBangumi
![conf1.png](https://tva1.sinaimg.cn/large/e6c9d24ely1h47zd8ludwj20wt0u0tam.jpg)
![conf1.png](https://tva1.sinaimg.cn/large/e6c9d24ely1h47zd8fxvyj20zj0u078i.jpg)
![conf1.png](https://tva1.sinaimg.cn/large/e6c9d24ely1h47zd7u8x6j20wm0u0mzy.jpg)
4. 如果你还没有安装 qBittorrent
配置如下：
![conf1.png](https://tva1.sinaimg.cn/large/e6c9d24ely1h47zd7ohctj20zh0u0mzq.jpg)
![conf1.png](https://tva1.sinaimg.cn/large/e6c9d24ely1h47zd7h8bsj20wp0u040n.jpg)
![conf1.png](https://tva1.sinaimg.cn/large/e6c9d24ely1h47zd6cgovj20wt0u00uj.jpg)
## 运行结果
![conf1.png](https://tva1.sinaimg.cn/large/e6c9d24ely1h47zd65jcbj21bx0u07bf.jpg)

50
docs/deploy/部署说明.md
View File

@@ -1,50 +0,0 @@
# 开始前的准备
**AutoBangumi** 可以使用 Docker 运行，也可以直接从源代码运行，鉴于追番是一个 7x24 小时的过程，**推荐**在 NAS 或者 Linux 服务器中使用 Docker 运行。
## 获取 Mikan Project RSS 订阅地址
本项目基于解析 Mikan Project 提供的 RSS 地址，因此如果要实现自动追番，需要注册并且获得 Mikan Project 的 RSS 地址：
![image](https://raw.githubusercontent.com/EstrellaXD/ab_resource/main/resource/image/订阅地址.png)
获取的 RSS 地址如下：
```angular2html
https://mikanani.me/RSS/MyBangumi?token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
# 或者
https://mikanime.tv/RSS/MyBangumi?token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
```
AB 中需要填入的 `token` 为以上 url 中 `token=` 后面的一串字符。
## Mikan Project 订阅贴士
由于 AutoBangumi 会解析所有获得的 RSS 信息，因此在订阅番剧的时候需要注意以下几点：
![image](https://raw.githubusercontent.com/EstrellaXD/ab_resource/main/resource/image/高级订阅.png)
- 在个人设置中打开高级设置。
- 一部番剧只订阅一个字幕组，点击 Mikan Project 的番剧图片即可呼出二级菜单，选择一个字幕组订阅即可。
- 如果字幕组有简体繁体不同的字幕，Mikan Project 大多时候提供了选择订阅的方式，选择一种字幕订阅。
- 如果不提供简繁选择，那么可以在 AutoBangumi 中设置 `filter` 进行过滤，也可以在规则生成之后进入 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/)