Skip to content

Commit

Permalink
Merge pull request EstrellaXD#545 from EstrellaXD/3.1-dev
Browse files Browse the repository at this point in the history
docs: fix docs issue.
  • Loading branch information
EstrellaXD authored Oct 8, 2023
2 parents 0106488 + 9a9613d commit 0473521
Show file tree
Hide file tree
Showing 50 changed files with 974 additions and 915 deletions.
29 changes: 19 additions & 10 deletions docs/deploy/docker-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,35 +8,44 @@ AutoBangumi 2.6 版本后支持直接在 WebUI 中配置,你可以选择直接

为了保证 AB 在每次更新之后数据和配置不丢失,推荐使用 Docker volume 或者 bind mount 进行数据和配置的持久化。

```shell
# 使用 bind mount
mkdir -p AutoBangumi
cd AutoBangumi
mkdir -p ./config
mkdir -p ./data
```

Bind mount 与 Docker volume 二选一
```shell
# 使用 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

复制以下命令运行即可。

请确保运行时目录处于AutoBangumi。

```shell
docker run -d \
--name=AutoBangumi \
-v AutoBangumi_config:/app/config \
-v AutoBangumi_data:/app/data \
-v ./config:/app/config \
-v ./data:/app/data \
-p 7892:7892 \
--network=bridge \
--dns=8.8.8.8 \
--restart unless-stopped \
estrellaxd/auto_bangumi:latest
ghcr.io/estrellaxd/auto_bangumi:latest
```

如果使用 bind mount,可以自行替换绑定路径。
如果使用 Docker volume,可以自行替换绑定路径。
```shell
-v AutoBangumi_config:/app/config \
-v AutoBangumi_data:/app/data \
```

此时 AB 的 WebUI 会自动运行,但是主程序会处于暂停状态,可以进入 `http://abhost:7892` 进行配置。

Expand Down
17 changes: 8 additions & 9 deletions docs/deploy/docker-compose.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,13 @@ docker compose -v

## 部署 **AutoBangumi**

### 创建 AutoBangumi 文件夹
### 创建 AutoBangumi及数据 文件夹

```bash
mkdir AutoBangumi
mkdir -p AutoBangumi
cd AutoBangumi
mkdir -p config # 如果不存在则会报错
mkdir -p data
```

### 选项1: 自定义 Docker Compose 配置文件
Expand All @@ -35,7 +37,7 @@ version: "3.8"

services:
AutoBangumi:
image: estrellaxd/auto_bangumi:latest
image: "ghcr.io/estrellaxd/auto_bangumi:latest"
container_name: AutoBangumi
volumes:
- ./config:/app/config
Expand All @@ -45,12 +47,9 @@ services:
restart: unless-stopped
dns:
- 223.5.5.5

volumes:
AutoBangumi_config:
name: AutoBangumi_config
AutoBangumi_data:
name: AutoBangumi_data
network_mode: bridge
environment:
- AB_METHOD=Advance
```
复制上面的内容到 `docker-compose.yml` 文件中。
Expand Down
47 changes: 21 additions & 26 deletions docs/deploy/dsm.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## 创建配置和数据存储文件夹

‼️在 `/volume1/docker/` 下创建 `ab` 文件夹,然后在 `ab` 文件夹下创建 `config``data` 文件夹。
`/volume1/docker/` 下创建 `AutoBangumi` 文件夹,然后在 `AutoBangumi` 文件夹下创建 `config``data` 文件夹。

## 安装 Container Manager (Docker) 套件

Expand All @@ -20,7 +20,7 @@

复制以下内容填入 **Docker Compose** 中。
```yaml
version: "3.8"
version: "3.4"

services:
ab:
Expand All @@ -30,8 +30,11 @@ services:
ports:
- "7892:7892"
volumes:
- "/volume1/docker/ab/config:/app/config"
- "/volume1/docker/ab/data:/app/data"
- "./config:/app/config"
- "./data:/app/data"
network_mode: bridge
environment:
- AB_METHOD=Advance
```
点击 **下一步**,然后点击 **完成**。
Expand All @@ -49,48 +52,40 @@ services:
参考上一节的内容,将以下内容经过调整填入 **Docker Compose** 中。

```yaml
version: "3.2"
services:
qbittorrent:
container_name: qBittorrent
container_name: qbittorrent
image: linuxserver/qbittorrent
hostname: qbittorrent
environment:
- TZ=Asia/Shanghai
- TemPath=/downloads
- SavePath=/downloads
- PGID=1000 #需要自行修改填入
- PUID=1000 #需要自行修改填入
- WEBUI_PORT=8080 #建议自行修改端口号
- WEBUI_PORT=8989
- TZ=Asia/Shanghai
volumes:
- /volume1/docker/qb/config:/config
- /volume1/docker/qb/downloads:/downloads # 填入下载路径
ports:
- 8080:8080 # 建议自行修改端口号
- "6881:6881"
- "6881:6881/udp"
network_mode:
host
- ./qb_config:/config
- your_anime_path:/downloads # 注意 修改此处为自己存放动漫的目录,ab 内下载路径填写downloads
networks:
- host
restart: unless-stopped
image: superng6/qbittorrent
auto_bangumi:
container_name: AutoBangumi
environment:
- TZ=Asia/Shanghai
- PGID=1000 #需要自行修改填入
- PUID=1000 #需要自行修改填入
- AB_DOWNLOADER_HOST=127.0.0.1:8080 #建议自行修改端口号
- AB_DOWNLOADER_HOST=127.0.0.1:8989 #建议自行修改端口号
volumes:
- /volume1/docker/ab/config:/app/config
- /volume1/docker/ab/data:/app/data
network_mode:
host
ports:
- '7892:7892'
network_mode: host
environment:
- AB_METHOD=Advance
dns:
- 8.8.8.8
- 223.5.5.5
restart: unless-stopped
image: estrellaxd/auto_bangumi:latest
image: "ghcr.io/estrellaxd/auto_bangumi:latest"
depends_on:
- qbittorrent
Expand Down
42 changes: 26 additions & 16 deletions docs/deploy/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,29 +5,43 @@

## 创建数据和配置文件夹

为了保证 AB 在每次更新之后数据和配置不丢失,推荐使用 Docker volume 进行数据和配置的持久化。
为了保证 AB 在每次更新之后数据和配置不丢失,推荐使用 bind mount 或者 Docker volume 进行数据和配置的持久化。


```shell
# 使用 bind mount
mkdir "AutoBangumi"
cd "AutoBangumi"
mkdir -p ./config
mkdir -p ./data
```

bind mount 与 Docker volume 二选一

```shell
# 使用 Docker volume
docker volume create AutoBangumi_config
docker volume create AutoBangumi_data
```

## 使用 Docker 部署 AutoBangumi

使用以下命令时请确保处于AutoBangumi目录下。

### 选项1: 使用 Docker-cli 部署

复制以下命令运行即可。

```shell
docker run -d \
--name=AutoBangumi \
-v AutoBangumi_config:/app/config \
-v AutoBangumi_data:/app/data \
-v ./config:/app/config \
-v ./data:/app/data \
-p 7892:7892 \
--network=bridge \
--dns=8.8.8.8 \
--restart unless-stopped \
estrellaxd/auto_bangumi:latest

ghcr.io/estrellaxd/auto_bangumi:latest
```

### 选项2: 使用 Docker-compose 部署
Expand All @@ -39,23 +53,19 @@ version: "3.8"

services:
AutoBangumi:
image: estrellaxd/auto_bangumi:latest
image: "ghcr.io/estrellaxd/auto_bangumi:latest"
container_name: AutoBangumi
volumes:
- AutoBangumi_config:/app/config
- AutoBangumi_data:/app/data
- ./config:/app/config
- ./data:/app/data
ports:
- "7892:7892"
network_mode: bridge
restart: unless-stopped
dns:
- 223.5.5.5
network_mode: bridge

volumes:
AutoBangumi_config:
name: AutoBangumi_config
AutoBangumi_data:
name: AutoBangumi_data
environment:
- AB_METHOD=Advance
```
运行以下命令启动容器。
Expand Down Expand Up @@ -113,4 +123,4 @@ https://mikanime.tv/RSS/MyBangumi?token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
[mikan-project]: https://mikanani.me/
[qbittorrent-docker]: https://hub.docker.com/r/superng6/qbittorrent
[qbittorrent-desktop]: https://www.qbittorrent.org/download
[qbittorrent-nox]: https://www.qbittorrent.org/download-nox
[qbittorrent-nox]: https://www.qbittorrent.org/download-nox
6 changes: 5 additions & 1 deletion docs/deploy/windows.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Windows 本地部署

::: warning 警告
本地部署可能会产生一些不可预料的问题,我们强烈推荐您使用 Docker 部署。
:::


1. 克隆并进入 AutoBangumi 的 `git` 仓库:

Expand All @@ -8,7 +12,7 @@
cd Auto_Bangumi
```

2.`backend\src` 目录下创建 `__version__.py` 文件并写入 `VERSION='local', 请注意文件编码格式为 `UTF-8`:
2.`backend\src\module` 目录下创建 `__version__.py` 文件并写入 `VERSION='local', 请注意文件编码格式为 `UTF-8`:

3. 新建 `python` 虚拟环境、激活并安装依赖(需保证 `python -V` 打印的版本符合 `Dockerfile` 中的要求,如 `FROM python:3.11-alpine AS APP`

Expand Down
4 changes: 2 additions & 2 deletions docs/deploy/wsl.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ services:
restart: unless-stopped

AutoBangumi:
image: estrellaxd/auto_bangumi:latest
image: "ghcr.io/estrellaxd/auto_bangumi:latest"
container_name: AutoBangumi
ports:
- 7892:7892
Expand Down Expand Up @@ -58,4 +58,4 @@ volumes:
external: false
auto_bangumi:
external: false
```
```
17 changes: 17 additions & 0 deletions docs/docker-compose/AutoBangumi/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
version: "3.4"

services:
AutoBangumi:
image: "ghcr.io/estrellaxd/auto_bangumi:latest"
container_name: AutoBangumi
volumes:
- ./config:/app/config
- ./data:/app/data
network_mode: bridge
ports:
- "7892:7892"
restart: unless-stopped
dns:
- 223.5.5.5
environment:
- AB_METHOD=Advance
37 changes: 37 additions & 0 deletions docs/docker-compose/qBittorrent+AutoBangumi/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
version: "3.4"
services:
qbittorrent:
container_name: qbittorrent
image: linuxserver/qbittorrent
hostname: qbittorrent
environment:
- PGID=1000 #需要自行修改填入
- PUID=1000 #需要自行修改填入
- WEBUI_PORT=8989
- TZ=Asia/Shanghai
volumes:
- ./qb_config:/config
- your_anime_path:/downloads # 注意 修改此处为自己存放动漫的目录,ab 内下载路径填写downloads
networks:
- host
restart: unless-stopped

AutoBangumi:
image: "ghcr.io/estrellaxd/auto_bangumi:latest"
container_name: AutoBangumi
depends_on:
- qbittorrent
volumes:
- ./config:/app/config
- ./data:/app/data
networks:
- host
dns:
- 223.5.5.5
restart: unless-stopped
environment:
- AB_METHOD=Advance
- AB_DOWNLOADER_HOST=127.0.0.1:8989 #如8989被修改,请修改为相应端口
- AB_DOWNLOADER_USERNAME=admin
- AB_DOWNLOADER_PASSWORD=adminadmin
- AB_DOWNLOAD_PATH=/downloads #qbittorrent 映射的地址,否者可能提示下载失败
1 change: 1 addition & 0 deletions webui/.eslintignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
/build
/dist
/dev-dist
1 change: 1 addition & 0 deletions webui/.prettierignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/build
/dist
/dev-dist
/pnpm-lock.yaml
auto-imports.d.ts
components.d.ts
Expand Down
1 change: 0 additions & 1 deletion webui/src/App.vue
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ import {
NMessageProvider,
} from 'naive-ui';
const theme: GlobalThemeOverrides = {
Spin: {
color: '#fff',
Expand Down
Loading

0 comments on commit 0473521

Please sign in to comment.