From 1e27c186931057439a6dafd43176e601ba385d19 Mon Sep 17 00:00:00 2001 From: EstrellaXD Date: Sun, 5 Jun 2022 18:10:48 +0800 Subject: [PATCH] update README.md --- Docs/部署说明.md | 22 --- README.md | 148 ++---------------- .../All-in-one/docker-compose.yml | 0 .../AutoBangumi/docker-compose.yml | 2 +- .../docker-compose.yml | 0 .../image/auto_bangumi_icon_v2-dark.png | Bin {Docs => docs}/image/auto_bangumi_v2.png | Bin {Docs => docs}/image/workthrough-1.0.png | Bin {Docs => docs}/image/workthrough-2.0.png | Bin .../image/截屏2022-05-23 20.47.39.png | Bin .../image/截屏2022-05-23 20.48.02.png | Bin {Docs => docs}/常见错误解决.md | 0 docs/部署说明.md | 108 +++++++++++++ 13 files changed, 119 insertions(+), 161 deletions(-) delete mode 100644 Docs/部署说明.md rename {docker-compose => docs/docker-compose}/All-in-one/docker-compose.yml (100%) rename {docker-compose => docs/docker-compose}/AutoBangumi/docker-compose.yml (93%) rename {docker-compose => docs/docker-compose}/qBittorrent+AutoBangumi/docker-compose.yml (100%) rename {Docs => docs}/image/auto_bangumi_icon_v2-dark.png (100%) rename {Docs => docs}/image/auto_bangumi_v2.png (100%) rename {Docs => docs}/image/workthrough-1.0.png (100%) rename {Docs => docs}/image/workthrough-2.0.png (100%) rename {Docs => docs}/image/截屏2022-05-23 20.47.39.png (100%) rename {Docs => docs}/image/截屏2022-05-23 20.48.02.png (100%) rename {Docs => docs}/常见错误解决.md (100%) create mode 100644 docs/部署说明.md diff --git a/Docs/部署说明.md b/Docs/部署说明.md deleted file mode 100644 index cd2366f1..00000000 --- a/Docs/部署说明.md +++ /dev/null @@ -1,22 +0,0 @@ -# 部署说明 - -## Docker-Compose 一键部署 -现在提供了一键部署的 qBittorrent+AutoBangumi 的方法，可以使用 `ABQB.yml` 文件进行部署。 -1. 安装 Docker -2. 安装 Docker-Compose -3. 部署： -复制以下命令执行即可 -```bash -export DOWNLOAD_PATH=/path/downloads # 这里写你的下载文件保存的地方 -``` -```bash -docker volume create qb_config -``` -```bash -wget "ABQB.yml" -``` -```bash -docker-compose up docker-compose.yml -``` -- 对于已经安装 qb 的朋友可以使用 `AB.yml` 进行部署，只需要更改变量为自己的变量即可。 - diff --git a/README.md b/README.md index c0f79252..fe4f2e57 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

- - + +

@@ -21,7 +21,9 @@ 基于 [infuse](https://firecore.com/infuse) 与 [Plex](https://plex.tv) 的效果如下： - + + +## [部署说明](https://github.com/EstrellaXD/Auto_Bangumi/blob/main/Docs/部署说明.md) / [常见错误说明](https://github.com/EstrellaXD/Auto_Bangumi/blob/main/Docs/常见错误解决.md) ## AutoBangumi 好在哪 @@ -29,149 +31,18 @@ - 修改文件名但是不破坏作种 - 傻瓜式文件整理 -## 相关文档和群组 +## 相关群组 -- [AutoBangumi V2 简易说明](https://www.craft.do/s/4viN6M3tBqigLp) -- [常见 bug 和解决方法](https://github.com/EstrellaXD/Auto_Bangumi/blob/main/Docs/常见错误解决.md) - 更新推送：[Telegram Channel](https://t.me/autobangumi_update) - Bug 反馈群：[Telegram](https://t.me/+yNisOnDGaX5jMTM9) -# 部署说明 - -1. 安装 qBittorrent: - -2. 用 Docker 部署 `AutoBangumi` : - -最简部署方法 - -```dash -docker run -d \ - --name=AutoBangumi \ - -e AB_DOWNLOAD_PATH=/path/downloads \ - -e AB_RSS= \ - --network=host \ - --dns=8.8.8.8 \ - --restart unless-stopped \ - estrellaxd/auto_bangumi:latest -``` - -**进阶部署:** - -Docker-Compose（推荐） - -```yaml -version: '3.3' -services: - auto_bangumi: - container_name: AutoBangumi - environment: - - TZ=Asia/Shanghai - - AB_INTERVAL_TIME=1800 - - AB_DOWNLOADER_HOST=localhost:8080 - - AB_DOWNLOADER_USERNAME=admin - - AB_DOWNLOADER_PASSWORD=adminadmin - - AB_METHOD=pn - - AB_GROUP_TAG=True - - AB_NOT_CONTAIN=720 - - AB_DOWNLOAD_PATH=${DOWNLOAD_PATH} - - AB_RSS=${RSS} - - AB_RULE_DEBUG=False - - AB_DEBUG_MODE=False - - AB_EP_COMPLETE=True - - AB_SEASON_ONE=True - network_mode: host - dns: - - 8.8.8.8 - - 223.5.5.5 - restart: unless-stopped - image: estrellaxd/auto_bangumi:latest -``` - -Docker-cli - -```dash -docker run -d \ - --name=AutoBangumi \ - -e TZ=Asia/Shanghai \ #optional - -e AB_INTERVAL_TIME=1800 \ #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_COTAIN=720 \ - -e AB_RSS= \ - --network=host \ - --dns=8.8.8.8 \ - --restart unless-stopped \ - estrellaxd/auto_bangumi:latest -``` - -### 参数说明 - -| 环境变量 | 作用 | 参数 | -| --------------- |---------------------|------------------| -| `TZ` | 时区 | `Asia/Shanghai` | -| `TIME` | 间隔时间 | `1800` | -| `HOST` | qBittorrent 的地址和端口号 | `localhost:8080` | -| `USER` | qBittorrent 的用户名 | `admin` | -| `PASSWORD` | qBittorrent 的密码 | `adminadmin` | -| `METHOD` | 重命名方法 | `pn` | -| `GROUP_TAG` | 是否在下载规则中添加组名 | `False` | -| `NOT_CONTAIN` | 正则表达式过滤器 | `720` | -| `DOWNLOAD_PATH` | qBittorrent 中的下载路径 | 必填项 | -| `RSS` | RSS 订阅地址 | 必填项 | - -- `TIME` : 程序运行的间隔时间，默认为 `1800` 也就是 30 分钟，如果更新时间要求比较高可以适当降低该值。 -- `HOST`, `USER`, `PASSWORD`: qBittorrent 的地址，用户名，密码。 -- `METHOD`: 重命名规则 - - `pn`: Pure Name 模式，去掉所有字幕组以及番剧额外信息，只保留名称、季度和集数。 - - `normal`: 正常模式，仅重命名会影响搜刮的非正常字符。 -- `GROUP_TAG`: 开启后自动在自动下载规则中创建组名，方便管理。 -- `DOWNLOAD_PATH`: qBittorrent 的下载地址。 -- `RSS`: Mikan Project 的个人 RSS 订阅链接 -- `NOT_CONTAIN`: 可以自行添加过滤的正则表达式 - -3. 检查 Docker 运行日志，出现： - -```other -[2022-05-20 12:47:47] RSS Already exists. -[2022-05-20 12:47:47] add Summer Time Rendering -[2022-05-20 12:47:47] add Paripi Koumei -[2022-05-20 12:47:47] add Tomodachi Game -[2022-05-20 12:47:47] add Tate no Yuusha no Nariagari S02 -[2022-05-20 12:47:47] add Shijou Saikyou no Daimaou -[2022-05-20 12:47:47] add Yuusha, Yamemasu -[2022-05-20 12:47:47] add Aharen-san wa Hakarenai -[2022-05-20 12:47:47] add Kawaii dake ja Nai Shikimori-san -[2022-05-20 12:47:47] add Kakkou no Iinazuke -[2022-05-20 12:47:47] add SPYxFAMILY -[2022-05-20 12:47:47] add Love Live S02 -[2022-05-20 12:47:47] add BUILD-DIVIDE -[2022-05-20 12:47:47] add Machikado Mazoku:-choume -[2022-05-20 12:47:47] add CUE! -[2022-05-20 12:47:47] add Kaguya-sama wa Kokurasetai S03 -[2022-05-20 12:47:47] add Shokei Shoujo no Virgin Road -[2022-05-20 12:47:47] add Kakkou no Iikagen -[2022-05-20 12:47:47] Start adding rules. -[2022-05-20 12:47:47] Finished. -[2022-05-20 12:47:47] 已完成对0个文件的检查 -[2022-05-20 12:47:47] 已对其中0个文件进行重命名 -[2022-05-20 12:47:47] 完成 -``` - -说明运行成功。之后可以检查 qb 中是否建立自动下载规则。 - -4. 安装媒体库软件 - ## Roadmap ***开发中的功能：*** -- RSS 解析器：AutoBangumi 可以自行解析分析种子无需依赖下载器。 +- ✅ RSS 解析器：AutoBangumi 可以自行解析分析种子无需依赖下载器。 - Transmission & Aria2 的支持。 -- 遗漏番剧下载：中间开始追番可以补全之前的剧集。 +- ✅ 遗漏番剧下载：中间开始追番可以补全之前的剧集。 ***计划开发的功能：*** @@ -179,5 +50,6 @@ docker run -d \ - 更为智能细致的分类预设。 # 声明 +感谢 [Sean](https://github.com/findix) 提供的大量帮助 + -本项目的自动改名规则根据 [miracleyoo/anime_renamer](https://github.com/miracleyoo/anime_renamer) 项目 diff --git a/docker-compose/All-in-one/docker-compose.yml b/docs/docker-compose/All-in-one/docker-compose.yml similarity index 100% rename from docker-compose/All-in-one/docker-compose.yml rename to docs/docker-compose/All-in-one/docker-compose.yml diff --git a/docker-compose/AutoBangumi/docker-compose.yml b/docs/docker-compose/AutoBangumi/docker-compose.yml similarity index 93% rename from docker-compose/AutoBangumi/docker-compose.yml rename to docs/docker-compose/AutoBangumi/docker-compose.yml index ce1d66a4..1d7c3a09 100644 --- a/docker-compose/AutoBangumi/docker-compose.yml +++ b/docs/docker-compose/AutoBangumi/docker-compose.yml @@ -5,7 +5,7 @@ services: environment: - TZ=Asia/Shanghai - AB_INTERVAL_TIME=1800 - - AB_DOWNLOADER_HOST=localhost:8080 + - AB_DOWNLOADER_HOST=localhost:${QB_PORT} - AB_DOWNLOADER_USERNAME=admin - AB_DOWNLOADER_PASSWORD=adminadmin - AB_METHOD=pn diff --git a/docker-compose/qBittorrent+AutoBangumi/docker-compose.yml b/docs/docker-compose/qBittorrent+AutoBangumi/docker-compose.yml similarity index 100% rename from docker-compose/qBittorrent+AutoBangumi/docker-compose.yml rename to docs/docker-compose/qBittorrent+AutoBangumi/docker-compose.yml diff --git a/Docs/image/auto_bangumi_icon_v2-dark.png b/docs/image/auto_bangumi_icon_v2-dark.png similarity index 100% rename from Docs/image/auto_bangumi_icon_v2-dark.png rename to docs/image/auto_bangumi_icon_v2-dark.png diff --git a/Docs/image/auto_bangumi_v2.png b/docs/image/auto_bangumi_v2.png similarity index 100% rename from Docs/image/auto_bangumi_v2.png rename to docs/image/auto_bangumi_v2.png diff --git a/Docs/image/workthrough-1.0.png b/docs/image/workthrough-1.0.png similarity index 100% rename from Docs/image/workthrough-1.0.png rename to docs/image/workthrough-1.0.png diff --git a/Docs/image/workthrough-2.0.png b/docs/image/workthrough-2.0.png similarity index 100% rename from Docs/image/workthrough-2.0.png rename to docs/image/workthrough-2.0.png diff --git a/Docs/image/截屏2022-05-23 20.47.39.png b/docs/image/截屏2022-05-23 20.47.39.png similarity index 100% rename from Docs/image/截屏2022-05-23 20.47.39.png rename to docs/image/截屏2022-05-23 20.47.39.png diff --git a/Docs/image/截屏2022-05-23 20.48.02.png b/docs/image/截屏2022-05-23 20.48.02.png similarity index 100% rename from Docs/image/截屏2022-05-23 20.48.02.png rename to docs/image/截屏2022-05-23 20.48.02.png diff --git a/Docs/常见错误解决.md b/docs/常见错误解决.md similarity index 100% rename from Docs/常见错误解决.md rename to docs/常见错误解决.md diff --git a/docs/部署说明.md b/docs/部署说明.md new file mode 100644 index 00000000..592d314c --- /dev/null +++ b/docs/部署说明.md @@ -0,0 +1,108 @@ +# 部署说明 +## `AutoBangumi` 环境变量说明 +| 环境变量 | 作用 | 参数 | +| ------------------------ |----------------------------|------------------| +| `TZ` | 时区 | `Asia/Shanghai` | +| `AB_INTERVAL_TIME` | 间隔时间 | `1800` | +| `AB_DOWNLOADER_HOST` | qBittorrent 的地址和端口号 | `localhost:8080` | +| `AB_DOWNLOADER_USERNAME` | qBittorrent 的用户名 | `admin` | +| `AB_DOWNLOADER_PASSWORD` | qBittorrent 的密码 | `adminadmin` | +| `AB_METHOD` | 重命名方法 | `pn` | +| `AB_GROUP_TAG` | 是否在下载规则中添加组名 | `False` | +| `AB_DOWNLOAD_PATH` | qBittorrent 中的下载路径 | 必填项 | +| `AB_RSS` | RSS 订阅地址 | 必填项 | +| `AB_NOT_CONTAIN` | 输入想要过滤的元素 | `720` | +| `AB_RULE_DEBUG` | RSS 解析器 debug 模式 | `False` | +| `AB_DEBUG_MODE` | | `Fasle` | +| `AB_EP_COMPLETE` | 历史番剧下载 | `False` | +| `AB_SEASON_ONE`| 开启后如果没有 Season 信息自动添加为 S01 | `True` | +| `AB_REMOVE_BAD_BT`| 碰到无法重命名的合集等，自动删除种子 | `False` | +## 在 Linux 主机中使用 Docker-Compose 一键部署 +现在提供了一键部署的 qBittorrent+AutoBangumi 的方法，可以使用 `ABQB.yml` 文件进行部署。 +### [安装 Docker](https://docs.docker.com/get-docker/) +### [安装 Docker-Compose](https://docs.docker.com/compose/) + +正常来说安装完 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= \ +QB_PORT= +``` +- `DOWNLOAD_PATH`: 写你的下载文件保存的地方： + - 如果已经部署过 qBittorrent 这里请填写相对路径，比如：`/downloads/Bangumi` + - 如果是部署合集，请填写想要下载的绝对路径： `/home/NAS/downloads` +- `RSS`: 填写你的[蜜柑计划](https://mikanani.me)订阅地址: + 图片 +- `QB_PORT`: 填写你的已经部署的 qBittorrent 端口号，或者想要自定义的端口号，比如: `8080` + +3. **拉起 Docker-Compose** + ```bash + docker-compose up + ``` +4. 如果想要自定义参数，可以参考文章最开头的说明进行自定义 + +## 使用 `Docker-cli` 部署 +```shell +docker run -d \ + --name=AutoBangumi \ + -e AB_DOWNLOAD_PATH=/path/downloads \ + -e AB_RSS= \ + --network=host \ + --dns=8.8.8.8 \ + --restart unless-stopped \ + estrellaxd/auto_bangumi:latest +``` +推荐使用 *[Portainer](https://www.portainer.io)* 等带有 UI 的 Docker 管理器进行进阶部署 + +## 群晖部署说明（ QNAP 同理） + +## 部署结果： +```other +[2022-05-20 12:47:47] RSS Already exists. +[2022-05-20 12:47:47] add Summer Time Rendering +[2022-05-20 12:47:47] add Paripi Koumei +[2022-05-20 12:47:47] add Tomodachi Game +[2022-05-20 12:47:47] add Tate no Yuusha no Nariagari S02 +[2022-05-20 12:47:47] add Shijou Saikyou no Daimaou +[2022-05-20 12:47:47] add Yuusha, Yamemasu +[2022-05-20 12:47:47] add Aharen-san wa Hakarenai +[2022-05-20 12:47:47] add Kawaii dake ja Nai Shikimori-san +[2022-05-20 12:47:47] add Kakkou no Iinazuke +[2022-05-20 12:47:47] add SPYxFAMILY +[2022-05-20 12:47:47] add Love Live S02 +[2022-05-20 12:47:47] add BUILD-DIVIDE +[2022-05-20 12:47:47] add Machikado Mazoku:-choume +[2022-05-20 12:47:47] add CUE! +[2022-05-20 12:47:47] add Kaguya-sama wa Kokurasetai S03 +[2022-05-20 12:47:47] add Shokei Shoujo no Virgin Road +[2022-05-20 12:47:47] add Kakkou no Iikagen +[2022-05-20 12:47:47] Start adding rules. +[2022-05-20 12:47:47] Finished. +[2022-05-20 12:47:47] 已完成对0个文件的检查 +[2022-05-20 12:47:47] 已对其中0个文件进行重命名 +[2022-05-20 12:47:47] 完成 +``` \ No newline at end of file