Files
Auto_Bangumi/docs/deploy/docker-compose.md
Estrella Pan f42a5296e7 docs: translate to English, upgrade VitePress 1.6.4, add API reference
- Upgrade VitePress from 1.0.0-rc.4 to 1.6.4 (stable)
- Update all dependencies (vue 3.5, typescript 5.6, @vue/tsconfig 0.5)
- Remove defunct Documate AI integration and google-analytics plugin
- Add Google Analytics via head config instead
- Translate all 25+ documentation pages from Chinese to English
- Add comprehensive REST API reference (docs/api/index.md)
- Add v3.2 changelog to sidebar navigation (fixes dead link)
- Update version string from v3.1 to v3.2
- Fix homepage changelog link to point to v3.2
- Update all WebUI screenshots with current v3.2 UI
- Add new screenshots: calendar view, bangumi poster wall
- Remove obsolete files: documate.json, deploy/windows.md, deploy/unix.md
- Update CSS variables for VitePress 1.6.x compatibility

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>
2026-01-24 09:04:10 +01:00

87 lines
2.0 KiB
Markdown

# Deploy with Docker Compose
A one-click deployment method for **AutoBangumi** using a `docker-compose.yml` file.
## Install Docker Compose
Docker Compose usually comes bundled with Docker. Check with:
```bash
docker compose -v
```
If not installed, install it with:
```bash
$ sudo apt-get update
$ sudo apt-get install docker-compose-plugin
```
## Deploy **AutoBangumi**
### Create AutoBangumi and Data Directories
```bash
mkdir -p ${HOME}/AutoBangumi/{config,data}
cd ${HOME}/AutoBangumi
```
### Option 1: Custom Docker Compose Configuration
```yaml
version: "3.8"
services:
AutoBangumi:
image: "ghcr.io/estrellaxd/auto_bangumi:latest"
container_name: AutoBangumi
volumes:
- ./config:/app/config
- ./data:/app/data
ports:
- "7892:7892"
restart: unless-stopped
dns:
- 8.8.8.8
network_mode: bridge
environment:
- TZ=Asia/Shanghai
- PGID=$(id -g)
- PUID=$(id -u)
- UMASK=022
```
Copy the above content into a `docker-compose.yml` file.
### Option 2: Download Docker Compose Configuration File
If you don't want to create the `docker-compose.yml` file manually, the project provides pre-made configurations:
- Install **AutoBangumi** only:
```bash
wget https://raw.githubusercontent.com/EstrellaXD/Auto_Bangumi/main/docs/resource/docker-compose/AutoBangumi/docker-compose.yml
```
- Install **qBittorrent** and **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.
### Define Environment Variables
If you're using the downloaded AB+QB Docker Compose file, you need to define the following environment variables:
```shell
export \
QB_PORT=<YOUR_PORT>
```
- `QB_PORT`: Enter your existing qBittorrent port or your desired custom port, e.g., `8080`
### Start Docker Compose
```bash
docker compose up -d
```