Auto_Bangumi/docs/en/deploy/quick-start.md

Quick Start

We recommend deploying AutoBangumi in Docker. Before deployment, make sure you have Docker Engine or Docker Desktop installed.

::: tip 4.0 beta The commands on this page use the latest tag, which installs the 3.3 stable release. To use the 4.0 beta, change the image tag to 4.0.0-beta.N (for example 4.0.0-beta.1). The volumes and the environment variables do not change. Before you upgrade from 3.3, read Upgrade from 3.3 to 4.0. The 4.0 hard link plugin also needs the media library directory mounted into the container. Refer to Bangumi Manager. :::

Create Data and Configuration Directories

To ensure AB's data and configuration persist across updates, we recommend using bind mounts or Docker volumes.

# Using bind mount
mkdir -p ${HOME}/AutoBangumi/{config,data}
cd ${HOME}/AutoBangumi

Choose either bind mount or Docker volume:

# Using Docker volume
docker volume create AutoBangumi_config
docker volume create AutoBangumi_data

Deploy AutoBangumi with Docker

Make sure you are in the AutoBangumi directory when running these commands.

Option 1: Deploy with Docker CLI

Copy and run the following command:

docker run -d \
  --name=AutoBangumi \
  -v ${HOME}/AutoBangumi/config:/app/config \
  -v ${HOME}/AutoBangumi/data:/app/data \
  -p 7892:7892 \
  -e TZ=Asia/Shanghai \
  -e PUID=$(id -u) \
  -e PGID=$(id -g) \
  -e UMASK=022 \
  --network=bridge \
  --dns=8.8.8.8 \
  --restart unless-stopped \
  --log-opt max-size=10m \
  --log-opt max-file=3 \
  ghcr.io/estrellaxd/auto_bangumi:latest

Option 2: Deploy with Docker Compose

Copy the following content into a docker-compose.yml file:

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"
    network_mode: bridge
    restart: unless-stopped
    dns:
      - 8.8.8.8
    environment:
      - TZ=Asia/Shanghai
      - PGID=$(id -g)
      - PUID=$(id -u)
      - UMASK=022

Run the following command to start the container:

docker compose up -d

Install qBittorrent

If you haven't installed qBittorrent, please install it first:

• Install qBittorrent in Docker
• Install qBittorrent on Windows/macOS
• Install qBittorrent-nox on Linux

Get an Aggregated RSS Link (Using Mikan Project as an Example)

Visit Mikan Project, register an account and log in, then click the RSS button in the bottom right corner and copy the link.

{data-zoomable}

The RSS URL will look like:

https://mikanani.me/RSS/MyBangumi?token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
# or
https://mikanime.tv/RSS/MyBangumi?token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

For detailed steps, see Mikan RSS Setup.

Configure 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.

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.

{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.

4. Click the + button in the upper right corner, check Aggregated RSS, select the parser type, and enter your Mikan RSS URL.

{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.