diff --git a/docs/deploy/docker-cli.md b/docs/deploy/docker-cli.md index 05508281..deb119b1 100644 --- a/docs/deploy/docker-cli.md +++ b/docs/deploy/docker-cli.md @@ -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` 进行配置。 diff --git a/docs/deploy/docker-compose.md b/docs/deploy/docker-compose.md index 58b6390c..9e230b67 100644 --- a/docs/deploy/docker-compose.md +++ b/docs/deploy/docker-compose.md @@ -24,10 +24,10 @@ docker compose -v ### 创建 AutoBangumi及数据 文件夹 ```bash -mkdir AutoBangumi +mkdir -p AutoBangumi cd AutoBangumi -mkdir config # 如果不存在则会报错 -mkdir data +mkdir -p config # 如果不存在则会报错 +mkdir -p data ``` ### 选项1: 自定义 Docker Compose 配置文件 @@ -37,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 @@ -47,6 +47,9 @@ services: restart: unless-stopped dns: - 223.5.5.5 + network_mode: bridge + environment: + - AB_METHOD=Advance ``` 复制上面的内容到 `docker-compose.yml` 文件中。 diff --git a/docs/deploy/dsm.md b/docs/deploy/dsm.md index 1c075a18..3ba36ef4 100644 --- a/docs/deploy/dsm.md +++ b/docs/deploy/dsm.md @@ -4,7 +4,7 @@ ## 创建配置和数据存储文件夹 -‼️在 `/volume1/docker/` 下创建 `ab` 文件夹，然后在 `ab` 文件夹下创建 `config` 和 `data` 文件夹。 +在 `/volume1/docker/` 下创建 `AutoBangumi` 文件夹，然后在 `AutoBangumi` 文件夹下创建 `config` 和 `data` 文件夹。 ## 安装 Container Manager (Docker) 套件 @@ -20,7 +20,7 @@ 复制以下内容填入 **Docker Compose** 中。 ```yaml -version: "3.8" +version: "3.4" services: ab: @@ -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 ``` 点击 **下一步**，然后点击 **完成**。 @@ -49,28 +52,21 @@ 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 @@ -78,19 +74,18 @@ services: - 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 diff --git a/docs/deploy/quick-start.md b/docs/deploy/quick-start.md index d8cc8285..ad1dc471 100644 --- a/docs/deploy/quick-start.md +++ b/docs/deploy/quick-start.md @@ -5,14 +5,29 @@ ## 创建数据和配置文件夹 -为了保证 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 部署 复制以下命令运行即可。 @@ -20,14 +35,13 @@ docker volume create AutoBangumi_data ```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 部署 @@ -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 ``` 运行以下命令启动容器。 @@ -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 \ No newline at end of file +[qbittorrent-nox]: https://www.qbittorrent.org/download-nox diff --git a/docs/deploy/wsl.md b/docs/deploy/wsl.md index 38bc327c..a3a14478 100644 --- a/docs/deploy/wsl.md +++ b/docs/deploy/wsl.md @@ -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 @@ -58,4 +58,4 @@ volumes: external: false auto_bangumi: external: false -``` \ No newline at end of file +``` diff --git a/docs/docker-compose/AutoBangumi/docker-compose.yml b/docs/docker-compose/AutoBangumi/docker-compose.yml new file mode 100644 index 00000000..72e56944 --- /dev/null +++ b/docs/docker-compose/AutoBangumi/docker-compose.yml @@ -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 diff --git a/docs/docker-compose/qBittorrent+AutoBangumi/docker-compose.yml b/docs/docker-compose/qBittorrent+AutoBangumi/docker-compose.yml new file mode 100644 index 00000000..b5f5dc36 --- /dev/null +++ b/docs/docker-compose/qBittorrent+AutoBangumi/docker-compose.yml @@ -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 映射的地址，否者可能提示下载失败