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

docs: add quickstart.md

Browse Source
This commit is contained in:
EstrellaXD
2023-07-05 13:12:42 +08:00
parent d221fa6782
commit 8663e524f5
4 changed files with 86 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files

78
docs/deploy/Docker-cli.md
View File

@@ -1,23 +1,23 @@
## 使用 Docker-cli 部署
### 设置环境变量
### 新版本提醒
添加环境变量（注意这里最好手动输入）详细内容请参考 [Docker Compose](https://github) 章节中同样内容
```shell
export \
DOWNLOAD_PATH=/path/downloads \
RSS=<RSS_LINK>
```
AutoBangumi 2.6 版本后支持直接在 WebUI 中配置，你可以选择直接拉起容器再在 WebUI 中配置。老版本的环境变量配置参数会自动迁移
### 创建数据和配置文件夹
为了保证 AB 在每次更新之后数据和配置不丢失，推荐使用 Docker volume 进行数据和配置的持久化。
为了保证 AB 在每次更新之后数据和配置不丢失，推荐使用 Docker volume 或者 bind mount 进行数据和配置的持久化。
```shell
# 创建数据文件夹
mkdir AutoBangumi
cd AutoBangumi
# 使用 Docker volume
docker volume create AutoBangumi_config
docker volume create AutoBangumi_data
# 使用 bind mount
mkdir "AutoBangumi"
cd "AutoBangumi"
mkdir -p $PWD/config
mkdir -p $PWD/data
```
### 使用 Docker-cli 部署 AutoBangumi
@@ -27,8 +27,8 @@ cd AutoBangumi
```shell
docker run -d \
--name=AutoBangumi \
-v $PWD/config:/app/config \
-v $PWD/data:/app/data \
-v AutoBangumi_config:/app/config \
-v AutoBangumi_data:/app/data \
-p 7892:7892 \
--network=bridge \
--dns=8.8.8.8 \
@@ -36,56 +36,10 @@ docker run -d \
estrellaxd/auto_bangumi:latest
```
如果使用 bind mount，可以自行替换绑定路径。
此时 AB 的 WebUI 会自动运行，但是主程序会处于暂停状态，可以进入 `http://abhost:7892` 进行配置。
当然也可以使用环境变量进行配置，具体内容请参考 [Docker Compose](/deploy/Docker-compose) 章节中同样内容
```shell
docker run -d \
--name=AutoBangumi \
-e TZ=Asia/Shanghai \ #optional
-e AB_DOWNLOADER_HOST=qbittorrent:8080 \ #optional
-e AB_DOWNLOADER_USERNAME=admin \ #optional
-e AB_DOWNLOADER_PASSWORD=adminadmin \ #optional
-e AB_DOWNLOAD_PATH=/path/downloads \
-e AB_RSS=<YOUR_RSS_ADDRESS> \
-v $PWD/config:/app/config \
-v $PWD/data:/app/data \
--network=host \
--dns=8.8.8.8 \
--restart unless-stopped \
estrellaxd/auto_bangumi:latest
```
此时 AB 会自动把环境变量写入 `config.json` 文件中然后自动运行。
推荐使用 _[Portainer](https://www.portainer.io)_ 等带有 UI 的 Docker 管理器进行进阶部署
## 部署结果：
```other
[2022-07-09 21:55:19,164] INFO: _ ____ _
[2022-07-09 21:55:19,165] INFO: /\ | | | _ \ (_)
[2022-07-09 21:55:19,166] INFO: / \ _ _| |_ ___ | |_) | __ _ _ __ __ _ _ _ _ __ ___ _
[2022-07-09 21:55:19,167] INFO: / /\ \| | | | __/ _ \| _ < / _` | '_ \ / _` | | | | '_ ` _ \| |
[2022-07-09 21:55:19,167] INFO: / ____ \ |_| | || (_) | |_) | (_| | | | | (_| | |_| | | | | | | |
[2022-07-09 21:55:19,168] INFO: /_/ \_\__,_|\__\___/|____/ \__,_|_| |_|\__, |\__,_|_| |_| |_|_|
[2022-07-09 21:55:19,169] INFO: __/ |
[2022-07-09 21:55:19,169] INFO: |___/
[2022-07-09 21:55:19,170] INFO: Version 2.6.3 Author: EstrellaXD Twitter: https://twitter.com/Estrella_Pan
[2022-07-09 21:55:19,171] INFO: GitHub: https://github.com/EstrellaXD/Auto_Bangumi/
[2022-07-09 21:55:19,172] INFO: Starting AutoBangumi...
[2022-07-09 21:55:20,717] INFO: Add RSS Feed successfully.
[2022-07-09 21:55:21,761] INFO: Start collecting RSS info.
[2022-07-09 21:55:23,431] INFO: Finished
[2022-07-09 21:55:23,432] INFO: Running....
[2022-07-09 22:01:24,534] INFO: [NC-Raws] 继母的拖油瓶是我的前女友 - 01 (B-Global 1920x1080 HEVC AAC MKV) [0B604F3A].mkv >> 继母的拖油瓶是我的前女友 S01E01.mkv
[2022-07-09 22:01:24,539] INFO: Finished checking 131 files' name, renamed 1 files.
[2022-07-09 23:55:31,843] INFO: Start collecting RSS info.
[2022-07-09 23:55:37,269] INFO: Finished
[2022-07-09 23:55:37,270] INFO: Running....
[2022-07-10 00:13:38,855] INFO: [NC-Raws] Lycoris Recoil 莉可麗絲 - 02 (Baha 1920x1080 AVC AAC MP4) [1160E633].mp4 >> Lycoris Recoil 莉可麗絲 S01E02.mp4
[2022-07-10 00:13:38,869] INFO: Finished checking 131 files' name, renamed 1 files.
[2022-07-10 00:43:40,777] INFO: [NC-Raws] Lycoris Recoil 莉可麗絲 - 01 (Baha 1920x1080 AVC AAC MP4) [7E742084].mp4 >> Lycoris Recoil 莉可麗絲 S01E01.mp4
[2022-07-10 00:43:40,811] INFO: Finished checking 132 files' name, renamed 1 files.
```

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

@@ -51,8 +51,7 @@ cd AutoBangumi
```shell
export \
QB_PORT=<YOUR_PORT> \
DOWNLOAD_PATH=<YOUR_DOWNLOAD_PATH>
QB_PORT=<YOUR_PORT>
```
- `QB_PORT`: 填写你的已经部署的 qBittorrent 端口号，或者想要自定义的端口号，比如: `8080`

63
docs/deploy/quickstart.md Normal file
View File

@@ -0,0 +1,63 @@
## 快速开始
我们推荐你在 Docker 中部署运行 AutoBangumi。
部署前请确认已经安装了 Docker Engine。
### 创建数据和配置文件夹
为了保证 AB 在每次更新之后数据和配置不丢失，推荐使用 Docker volume 进行数据和配置的持久化。
```shell
docker volume create AutoBangumi_config
docker volume create AutoBangumi_data
```
### 使用 Docker-cli 部署 AutoBangumi
复制以下命令运行即可。
```shell
docker run -d \
--name=AutoBangumi \
-v AutoBangumi_config:/app/config \
-v AutoBangumi_data:/app/data \
-p 7892:7892 \
--network=bridge \
--dns=8.8.8.8
--restart unless-stopped \
estrellaxd/auto_bangumi:latest
```
### 使用 Docker-compose 部署 AutoBangumi
复制以下内容到 `docker-compose.yml` 文件中，然后运行 `docker-compose up -d` 即可。
```yaml
version: "3.8"
services:
AutoBangumi:
image: estrellaxd/auto_bangumi:latest
container_name: AutoBangumi
volumes:
- AutoBangumi_config:/app/config
- AutoBangumi_data:/app/data
ports:
- 7892:7892
restart: unless-stopped
dns:
- 223.5.5.5
network_mode: bridge
volumes:
AutoBangumi_config:
name: AutoBangumi_config
AutoBangumi_data:
name: AutoBangumi_data
```
### 配置 AutoBangumi
此时 AB 的 WebUI 会自动运行，但是主程序会处于暂停状态，可以进入 `http://abhost:7892` 进行配置。

12
docs/index.md
View File

@@ -14,11 +14,11 @@ hero:
link: /changelog/3.0
features:
- title: Feature A
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
- title: Feature B
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
- title: Feature C
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
- title: 自动解析番剧名称
details: 从 Mikan Project 自动解析番剧名称，无需手动输入，仅需订阅即可自动创建下载规则。
- title: 自动番剧重命名
details: 自动管理下载的番剧，保证刮削成功率，保证目录结构统一。
- title: 手动式一键管理
details: 一键管理已有番剧，一键下载旧番，一键删除番剧。
---