mirror of
https://github.com/EstrellaXD/Auto_Bangumi.git
synced 2026-04-24 18:40:03 +08:00
docs: add i18n support with Chinese as default language
- Configure VitePress locales with zh-CN as root and en-US as /en/ - Translate all documentation to Chinese (31 files) - Create English documentation under /en/ directory - Add Chinese UI labels for navigation and pagination - Language switcher now available in site header Generated with [Claude Code](https://claude.ai/code) via [Happy](https://happy.engineering) Co-Authored-By: Claude <noreply@anthropic.com> Co-Authored-By: Happy <yesreply@happy.engineering>
This commit is contained in:
Estrella Pan
@@ -1,31 +1,31 @@
|
||||
# Deploy with Docker CLI
|
||||
# 使用 Docker CLI 部署
|
||||
|
||||
## Note on New Versions
|
||||
## 新版本说明
|
||||
|
||||
Since AutoBangumi 2.6, you can configure everything directly in the WebUI. You can start the container first and then configure it in the WebUI. Environment variable configuration from older versions will be automatically migrated. Environment variables still work but only take effect on the first startup.
|
||||
从 AutoBangumi 2.6 开始，您可以直接在 WebUI 中配置所有设置。您可以先启动容器，然后在 WebUI 中进行配置。旧版本的环境变量配置将自动迁移。环境变量仍然有效，但仅在首次启动时生效。
|
||||
|
||||
## Create Data and Configuration Directories
|
||||
## 创建数据和配置目录
|
||||
|
||||
To ensure AB's data and configuration persist across updates, we recommend using Docker volumes or bind mounts.
|
||||
为确保 AB 的数据和配置在更新时持久化，我们建议使用 Docker 卷或绑定挂载。
|
||||
|
||||
```shell
|
||||
# Using bind mount
|
||||
# 使用绑定挂载
|
||||
mkdir -p ${HOME}/AutoBangumi/{config,data}
|
||||
cd ${HOME}/AutoBangumi
|
||||
```
|
||||
|
||||
Choose either bind mount or Docker volume:
|
||||
选择绑定挂载或 Docker 卷：
|
||||
```shell
|
||||
# Using Docker volume
|
||||
# 使用 Docker 卷
|
||||
docker volume create AutoBangumi_config
|
||||
docker volume create AutoBangumi_data
|
||||
```
|
||||
|
||||
## Deploy AutoBangumi with Docker CLI
|
||||
## 使用 Docker CLI 部署 AutoBangumi
|
||||
|
||||
Copy and run the following command.
|
||||
复制并运行以下命令。
|
||||
|
||||
Make sure your working directory is AutoBangumi.
|
||||
请确保您的工作目录为 AutoBangumi。
|
||||
|
||||
```shell
|
||||
docker run -d \
|
||||
@@ -43,14 +43,14 @@ docker run -d \
|
||||
ghcr.io/estrellaxd/auto_bangumi:latest
|
||||
```
|
||||
|
||||
If using Docker volumes, replace the bind paths accordingly:
|
||||
如果使用 Docker 卷，请相应替换绑定路径：
|
||||
```shell
|
||||
-v AutoBangumi_config:/app/config \
|
||||
-v AutoBangumi_data:/app/data \
|
||||
```
|
||||
|
||||
The AB WebUI will start automatically, but the main program will be paused. Access `http://abhost:7892` to configure it.
|
||||
AB WebUI 将自动启动，但主程序处于暂停状态。访问 `http://abhost:7892` 进行配置。
|
||||
|
||||
AB will automatically write environment variables to `config.json` and start running.
|
||||
AB 会自动将环境变量写入 `config.json` 并开始运行。
|
||||
|
||||
We recommend using _[Portainer](https://www.portainer.io)_ or similar Docker management UIs for advanced deployment.
|
||||
我们建议使用 _[Portainer](https://www.portainer.io)_ 或类似的 Docker 管理界面进行高级部署。
|
||||
|
||||
@@ -1,32 +1,32 @@
|
||||
# Deploy with Docker Compose
|
||||
# 使用 Docker Compose 部署
|
||||
|
||||
A one-click deployment method for **AutoBangumi** using a `docker-compose.yml` file.
|
||||
使用 `docker-compose.yml` 文件一键部署 **AutoBangumi**。
|
||||
|
||||
## Install Docker Compose
|
||||
## 安装 Docker Compose
|
||||
|
||||
Docker Compose usually comes bundled with Docker. Check with:
|
||||
Docker Compose 通常与 Docker 捆绑安装。使用以下命令检查：
|
||||
|
||||
```bash
|
||||
docker compose -v
|
||||
```
|
||||
|
||||
If not installed, install it with:
|
||||
如果未安装，请使用以下命令安装：
|
||||
|
||||
```bash
|
||||
$ sudo apt-get update
|
||||
$ sudo apt-get install docker-compose-plugin
|
||||
```
|
||||
|
||||
## Deploy **AutoBangumi**
|
||||
## 部署 **AutoBangumi**
|
||||
|
||||
### Create AutoBangumi and Data Directories
|
||||
### 创建 AutoBangumi 和数据目录
|
||||
|
||||
```bash
|
||||
mkdir -p ${HOME}/AutoBangumi/{config,data}
|
||||
cd ${HOME}/AutoBangumi
|
||||
```
|
||||
|
||||
### Option 1: Custom Docker Compose Configuration
|
||||
### 方式一：自定义 Docker Compose 配置
|
||||
|
||||
```yaml
|
||||
version: "3.8"
|
||||
@@ -51,35 +51,35 @@ services:
|
||||
- UMASK=022
|
||||
```
|
||||
|
||||
Copy the above content into a `docker-compose.yml` file.
|
||||
将以上内容复制到 `docker-compose.yml` 文件中。
|
||||
|
||||
### Option 2: Download Docker Compose Configuration File
|
||||
### 方式二：下载 Docker Compose 配置文件
|
||||
|
||||
If you don't want to create the `docker-compose.yml` file manually, the project provides pre-made configurations:
|
||||
如果您不想手动创建 `docker-compose.yml` 文件，项目提供了预制的配置：
|
||||
|
||||
- Install **AutoBangumi** only:
|
||||
- 仅安装 **AutoBangumi**：
|
||||
```bash
|
||||
wget https://raw.githubusercontent.com/EstrellaXD/Auto_Bangumi/main/docs/resource/docker-compose/AutoBangumi/docker-compose.yml
|
||||
```
|
||||
- Install **qBittorrent** and **AutoBangumi**:
|
||||
- 安装 **qBittorrent** 和 **AutoBangumi**：
|
||||
```bash
|
||||
wget https://raw.githubusercontent.com/EstrellaXD/Auto_Bangumi/main/docs/resource/docker-compose/qBittorrent+AutoBangumi/docker-compose.yml
|
||||
```
|
||||
|
||||
Choose your installation method and run the command to download the `docker-compose.yml` file. You can customize parameters with a text editor if needed.
|
||||
选择您的安装方式并运行命令下载 `docker-compose.yml` 文件。如有需要，可以使用文本编辑器自定义参数。
|
||||
|
||||
### Define Environment Variables
|
||||
### 定义环境变量
|
||||
|
||||
If you're using the downloaded AB+QB Docker Compose file, you need to define the following environment variables:
|
||||
如果您使用的是下载的 AB+QB Docker Compose 文件，需要定义以下环境变量：
|
||||
|
||||
```shell
|
||||
export \
|
||||
QB_PORT=<YOUR_PORT>
|
||||
```
|
||||
|
||||
- `QB_PORT`: Enter your existing qBittorrent port or your desired custom port, e.g., `8080`
|
||||
- `QB_PORT`：输入您现有的 qBittorrent 端口或您想要的自定义端口，例如 `8080`
|
||||
|
||||
### Start Docker Compose
|
||||
### 启动 Docker Compose
|
||||
|
||||
```bash
|
||||
docker compose up -d
|
||||
|
||||
@@ -1,24 +1,24 @@
|
||||
# Synology NAS (DSM 7.2) Deployment (QNAP Similar)
|
||||
# 群晖 NAS（DSM 7.2）部署（威联通类似）
|
||||
|
||||
DSM 7.2 supports Docker Compose, so we recommend using Docker Compose for one-click deployment.
|
||||
DSM 7.2 支持 Docker Compose，因此我们建议使用 Docker Compose 进行一键部署。
|
||||
|
||||
## Create Configuration and Data Directories
|
||||
## 创建配置和数据目录
|
||||
|
||||
Create an `AutoBangumi` folder under `/volume1/docker/`, then create `config` and `data` subfolders inside it.
|
||||
在 `/volume1/docker/` 下创建 `AutoBangumi` 文件夹，然后在其中创建 `config` 和 `data` 子文件夹。
|
||||
|
||||
## Install Container Manager (Docker) Package
|
||||
## 安装 Container Manager（Docker）套件
|
||||
|
||||
Open Package Center and install the Container Manager (Docker) package.
|
||||
打开套件中心，安装 Container Manager（Docker）套件。
|
||||
|
||||
{data-zoomable}
|
||||
|
||||
## Install AB via Docker Compose
|
||||
## 通过 Docker Compose 安装 AB
|
||||
|
||||
Click **Project**, then click **Create**, and select **Docker Compose**.
|
||||
点击**项目**，然后点击**新增**，选择 **Docker Compose**。
|
||||
|
||||
{data-zoomable}
|
||||
|
||||
Copy and paste the following content into **Docker Compose**:
|
||||
将以下内容复制粘贴到 **Docker Compose** 中：
|
||||
```yaml
|
||||
version: "3.4"
|
||||
|
||||
@@ -41,19 +41,19 @@ services:
|
||||
- UMASK=022
|
||||
```
|
||||
|
||||
Click **Next**, then click **Done**.
|
||||
点击**下一步**，然后点击**完成**。
|
||||
|
||||
{data-zoomable}
|
||||
|
||||
After creation, access `http://<NAS IP>:7892` to enter AB and configure it.
|
||||
创建完成后，访问 `http://<NAS IP>:7892` 进入 AB 并进行配置。
|
||||
|
||||
## Install AB and qBittorrent via Docker Compose
|
||||
## 通过 Docker Compose 安装 AB 和 qBittorrent
|
||||
|
||||
When you have both a proxy and IPv6, configuring IPv6 in Docker on Synology NAS can be complex. We recommend installing both AB and qBittorrent on the host network to reduce complexity.
|
||||
当您同时拥有代理和 IPv6 时，在群晖 NAS 的 Docker 中配置 IPv6 可能比较复杂。我们建议将 AB 和 qBittorrent 都安装在主机网络上以降低复杂性。
|
||||
|
||||
The following configuration assumes you have a Clash proxy deployed in Docker that is accessible via a local IP at a specified port.
|
||||
以下配置假设您已在 Docker 中部署了 Clash 代理，可通过本地 IP 的指定端口访问。
|
||||
|
||||
Following the previous section, adjust and paste the following content into **Docker Compose**:
|
||||
按照上一节的方法，调整并将以下内容粘贴到 **Docker Compose** 中：
|
||||
|
||||
```yaml
|
||||
qbittorrent:
|
||||
@@ -61,13 +61,13 @@ Following the previous section, adjust and paste the following content into **Do
|
||||
image: linuxserver/qbittorrent
|
||||
hostname: qbittorrent
|
||||
environment:
|
||||
- PGID=1000 # Modify as needed
|
||||
- PUID=1000 # Modify as needed
|
||||
- PGID=1000 # 根据需要修改
|
||||
- PUID=1000 # 根据需要修改
|
||||
- WEBUI_PORT=8989
|
||||
- TZ=Asia/Shanghai
|
||||
volumes:
|
||||
- ./qb_config:/config
|
||||
- your_anime_path:/downloads # Change this to your anime storage directory. Set download path in AB as /downloads
|
||||
- your_anime_path:/downloads # 修改为您的番剧存储目录。在 AB 中将下载路径设置为 /downloads
|
||||
networks:
|
||||
- host
|
||||
restart: unless-stopped
|
||||
@@ -76,10 +76,10 @@ Following the previous section, adjust and paste the following content into **Do
|
||||
container_name: AutoBangumi
|
||||
environment:
|
||||
- TZ=Asia/Shanghai
|
||||
- PGID=1000 # Modify as needed
|
||||
- PUID=1000 # Modify as needed
|
||||
- PGID=1000 # 根据需要修改
|
||||
- PUID=1000 # 根据需要修改
|
||||
- UMASK=022
|
||||
- AB_DOWNLOADER_HOST=127.0.0.1:8989 # Modify port as needed
|
||||
- AB_DOWNLOADER_HOST=127.0.0.1:8989 # 根据需要修改端口
|
||||
volumes:
|
||||
- /volume1/docker/ab/config:/app/config
|
||||
- /volume1/docker/ab/data:/app/data
|
||||
@@ -95,27 +95,27 @@ Following the previous section, adjust and paste the following content into **Do
|
||||
|
||||
```
|
||||
|
||||
## Additional Notes
|
||||
## 附加说明
|
||||
|
||||
The PGID and PUID values need to be determined for your system. For newer Synology NAS devices, they are typically: `PUID=1026, PGID=100`. When modifying the qBittorrent port, make sure to update it in all locations.
|
||||
PGID 和 PUID 的值需要根据您的系统确定。对于较新的群晖 NAS 设备，通常为：`PUID=1026, PGID=100`。修改 qBittorrent 端口时，请确保在所有位置都进行更新。
|
||||
|
||||
For proxy setup, refer to: [Proxy Settings](../config/proxy)
|
||||
代理设置请参阅：[代理设置](../config/proxy)
|
||||
|
||||
On lower-performance machines, the default configuration may heavily use the CPU, causing AB to fail connecting to qB and the qB WebUI to become inaccessible.
|
||||
在性能较低的设备上，默认配置可能会大量占用 CPU，导致 AB 无法连接到 qB，qB WebUI 也无法访问。
|
||||
|
||||
For devices like the 220+, recommended qBittorrent settings to reduce CPU usage:
|
||||
对于 220+ 等设备，建议使用以下 qBittorrent 设置以降低 CPU 使用率：
|
||||
|
||||
- Settings -> Connections -> Connection Limits
|
||||
- Global maximum number of connections: 300
|
||||
- Maximum number of connections per torrent: 60
|
||||
- Global upload slots limit: 15
|
||||
- Upload slots per torrent: 4
|
||||
- 设置 -> 连接 -> 连接限制
|
||||
- 全局最大连接数：300
|
||||
- 每个种子最大连接数：60
|
||||
- 全局上传槽位限制：15
|
||||
- 每个种子上传槽位：4
|
||||
- BitTorrent
|
||||
- Maximum active checking torrents: 1
|
||||
- Torrent Queueing
|
||||
- Maximum active downloads: 3
|
||||
- Maximum active uploads: 5
|
||||
- Maximum active torrents: 10
|
||||
- 最大活动检查种子数：1
|
||||
- 种子队列
|
||||
- 最大活动下载数：3
|
||||
- 最大活动上传数：5
|
||||
- 最大活动种子数：10
|
||||
- RSS
|
||||
- RSS Reader
|
||||
- Maximum number of articles per feed: 50
|
||||
- RSS 阅读器
|
||||
- 每个订阅源最大文章数：50
|
||||
|
||||
@@ -1,21 +1,21 @@
|
||||
# Local Deployment
|
||||
# 本地部署
|
||||
|
||||
::: warning
|
||||
Local deployment may cause unexpected issues. We strongly recommend using Docker instead.
|
||||
本地部署可能会导致意外问题。我们强烈建议使用 Docker 代替。
|
||||
|
||||
This documentation may have update delays. If you have questions, please raise them in [Issues](https://github.com/EstrellaXD/Auto_Bangumi/issues).
|
||||
此文档可能存在更新延迟。如有问题，请在 [Issues](https://github.com/EstrellaXD/Auto_Bangumi/issues) 中提出。
|
||||
:::
|
||||
|
||||
## Download the Latest Release
|
||||
## 下载最新版本
|
||||
|
||||
```bash
|
||||
VERSION=$(curl -s "https://api.github.com/repos/EstrellaXD/Auto_Bangumi/releases/latest" | grep '"tag_name":' | sed -E 's/.*"([^"]+)".*/\1/')
|
||||
curl -L -O "https://github.com/EstrellaXD/Auto_Bangumi/releases/download/$VERSION/app-v$VERSION.zip"
|
||||
```
|
||||
|
||||
## Extract the Archive
|
||||
## 解压压缩包
|
||||
|
||||
On Unix/WSL systems, use the following command. On Windows, extract manually.
|
||||
在 Unix/WSL 系统上，使用以下命令。在 Windows 上，请手动解压。
|
||||
|
||||
```bash
|
||||
unzip app-v$VERSION.zip -d AutoBangumi
|
||||
@@ -23,9 +23,9 @@ cd AutoBangumi
|
||||
```
|
||||
|
||||
|
||||
## Create Virtual Environment and Install Dependencies
|
||||
## 创建虚拟环境并安装依赖
|
||||
|
||||
Ensure you have Python 3.10+ and pip installed locally.
|
||||
确保本地已安装 Python 3.10+ 和 pip。
|
||||
|
||||
```bash
|
||||
cd src
|
||||
@@ -33,23 +33,23 @@ python3 -m venv env
|
||||
python3 pip install -r requirements.txt
|
||||
```
|
||||
|
||||
## Create Configuration and Data Directories
|
||||
## 创建配置和数据目录
|
||||
|
||||
```bash
|
||||
mkdir config
|
||||
mkdir data
|
||||
```
|
||||
|
||||
## Run AutoBangumi
|
||||
## 运行 AutoBangumi
|
||||
|
||||
```bash
|
||||
python3 main.py
|
||||
```
|
||||
|
||||
|
||||
## Windows Auto-Start on Boot
|
||||
## Windows 开机自启
|
||||
|
||||
You can use `nssm` for auto-start on boot. Example with `nssm`:
|
||||
可以使用 `nssm` 实现开机自启。使用 `nssm` 的示例：
|
||||
|
||||
```powershell
|
||||
nssm install AutoBangumi (Get-Command python).Source
|
||||
|
||||
@@ -1,33 +1,33 @@
|
||||
# Quick Start
|
||||
# 快速开始
|
||||
|
||||
We recommend deploying AutoBangumi in Docker.
|
||||
Before deployment, make sure you have [Docker Engine][docker-engine] or [Docker Desktop][docker-desktop] installed.
|
||||
我们推荐使用 Docker 部署 AutoBangumi。
|
||||
部署前，请确保已安装 [Docker Engine][docker-engine] 或 [Docker Desktop][docker-desktop]。
|
||||
|
||||
## Create Data and Configuration Directories
|
||||
## 创建数据和配置目录
|
||||
|
||||
To ensure AB's data and configuration persist across updates, we recommend using bind mounts or Docker volumes.
|
||||
为确保 AB 的数据和配置在更新时持久化，我们建议使用绑定挂载或 Docker 卷。
|
||||
|
||||
```shell
|
||||
# Using bind mount
|
||||
# 使用绑定挂载
|
||||
mkdir -p ${HOME}/AutoBangumi/{config,data}
|
||||
cd ${HOME}/AutoBangumi
|
||||
```
|
||||
|
||||
Choose either bind mount or Docker volume:
|
||||
选择绑定挂载或 Docker 卷：
|
||||
|
||||
```shell
|
||||
# Using Docker volume
|
||||
# 使用 Docker 卷
|
||||
docker volume create AutoBangumi_config
|
||||
docker volume create AutoBangumi_data
|
||||
```
|
||||
|
||||
## Deploy AutoBangumi with Docker
|
||||
## 使用 Docker 部署 AutoBangumi
|
||||
|
||||
Make sure you are in the AutoBangumi directory when running these commands.
|
||||
运行这些命令时，请确保您在 AutoBangumi 目录中。
|
||||
|
||||
### Option 1: Deploy with Docker CLI
|
||||
### 方式一：使用 Docker CLI 部署
|
||||
|
||||
Copy and run the following command:
|
||||
复制并运行以下命令：
|
||||
|
||||
```shell
|
||||
docker run -d \
|
||||
@@ -45,9 +45,9 @@ docker run -d \
|
||||
ghcr.io/estrellaxd/auto_bangumi:latest
|
||||
```
|
||||
|
||||
### Option 2: Deploy with Docker Compose
|
||||
### 方式二：使用 Docker Compose 部署
|
||||
|
||||
Copy the following content into a `docker-compose.yml` file:
|
||||
将以下内容复制到 `docker-compose.yml` 文件中：
|
||||
|
||||
```yaml
|
||||
version: "3.8"
|
||||
@@ -72,53 +72,53 @@ services:
|
||||
- UMASK=022
|
||||
```
|
||||
|
||||
Run the following command to start the container:
|
||||
运行以下命令启动容器：
|
||||
|
||||
```shell
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
## Install qBittorrent
|
||||
## 安装 qBittorrent
|
||||
|
||||
If you haven't installed qBittorrent, please install it first:
|
||||
如果您尚未安装 qBittorrent，请先安装：
|
||||
|
||||
- [Install qBittorrent in Docker][qbittorrent-docker]
|
||||
- [Install qBittorrent on Windows/macOS][qbittorrent-desktop]
|
||||
- [Install qBittorrent-nox on Linux][qbittorrent-nox]
|
||||
- [在 Docker 中安装 qBittorrent][qbittorrent-docker]
|
||||
- [在 Windows/macOS 上安装 qBittorrent][qbittorrent-desktop]
|
||||
- [在 Linux 上安装 qBittorrent-nox][qbittorrent-nox]
|
||||
|
||||
## Get an Aggregated RSS Link (Using Mikan Project as an Example)
|
||||
## 获取聚合 RSS 链接（以 Mikan Project 为例）
|
||||
|
||||
Visit [Mikan Project][mikan-project], register an account and log in, then click the **RSS** button in the bottom right corner and copy the link.
|
||||
访问 [Mikan Project][mikan-project]，注册账号并登录，然后点击右下角的 **RSS** 按钮并复制链接。
|
||||
|
||||
{data-zoomable}
|
||||
|
||||
The RSS URL will look like:
|
||||
RSS 链接格式如下：
|
||||
|
||||
```txt
|
||||
https://mikanani.me/RSS/MyBangumi?token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
||||
# or
|
||||
# 或
|
||||
https://mikanime.tv/RSS/MyBangumi?token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
||||
```
|
||||
|
||||
For detailed steps, see [Mikan RSS Setup][config-rss].
|
||||
详细步骤请参阅 [Mikan RSS 设置][config-rss]。
|
||||
|
||||
|
||||
## Configure AutoBangumi
|
||||
## 配置 AutoBangumi
|
||||
|
||||
After installing AB, the WebUI will start automatically, but the main program will be paused. You can access `http://abhost:7892` to configure it.
|
||||
安装 AB 后，WebUI 将自动启动，但主程序处于暂停状态。您可以访问 `http://abhost:7892` 进行配置。
|
||||
|
||||
1. Open the webpage. The default username is `admin` and the default password is `adminadmin`. Change these immediately after first login.
|
||||
2. Enter your downloader's address, port, username, and password.
|
||||
1. 打开网页。默认用户名为 `admin`，默认密码为 `adminadmin`。首次登录后请立即修改。
|
||||
2. 输入下载器的地址、端口、用户名和密码。
|
||||
|
||||
{width=500}{class=ab-shadow-card}
|
||||
|
||||
3. Click **Apply** to save the configuration. AB will restart, and when the dot in the upper right corner turns green, it indicates AB is running normally.
|
||||
3. 点击**应用**保存配置。AB 将重启，当右上角的圆点变为绿色时，表示 AB 正常运行。
|
||||
|
||||
4. Click the **+** button in the upper right corner, check **Aggregated RSS**, select the parser type, and enter your Mikan RSS URL.
|
||||
4. 点击右上角的 **+** 按钮，勾选**聚合 RSS**，选择解析器类型，然后输入您的 Mikan RSS 链接。
|
||||
|
||||
{width=500}{class=ab-shadow-card}
|
||||
|
||||
Wait for AB to parse the aggregated RSS. Once parsing is complete, it will automatically add anime and manage downloads.
|
||||
等待 AB 解析聚合 RSS。解析完成后，将自动添加番剧并管理下载。
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user