Skip to content

Docker

Requirements

  • Docker and Docker Compose
  • AMD64 or ARM64 CPU architecture (or build the image yourself for other architectures)

Setup

Docker Compose

Below is a PlexAniBridge Docker compose file with example values. Optional environment variables are commented out.

Tip

Have a look at the configuration page for a detailed list of configurable environment variables.

compose.yaml
services:
  plexanibridge:
    image: ghcr.io/eliasbenb/plexanibridge:latest
    environment:
      TZ: America/New_York
      ANILIST_TOKEN: eyJ...
      PLEX_TOKEN: 2Sb...
      PLEX_USER: username
      PLEX_URL: http://plex:32400
      PLEX_SECTIONS: '["Anime", "Anime Movies"]'
      # PLEX_GENRES: []
      # PLEX_METADATA_SOURCE: local
      # SYNC_INTERVAL: 3600
      # POLLING_SCAN: False
      # FULL_SCAN: False
      # DESTRUCTIVE_SYNC: False
      # EXCLUDED_SYNC_FIELDS: '["notes", "score"]'
      # DRY_RUN: False
      # LOG_LEVEL: INFO
      # SEARCH_FALLBACK_THRESHOLD=-1
      # DATA_PATH: ./data
    volumes:
      - ./data:/app/data
    restart: unless-stopped

To start the container, run:

docker compose -f compose.yaml up -d

Tip

You can pin the image to a specific version or branch by changing latest to a specific tag. Some available tags are:

  • latest: The latest stable release
  • beta: The latest beta release (may be unstable)
  • alpha: The latest alpha release (may be unstable)
  • vX.Y.Z: A specific version from the releases page (e.g. v0.4.0)
  • main: The latest commit on the main branch, which is usually tied to the latest release
  • develop: The latest commit on the develop branch (may be unstable)

Docker CLI

Below is a minimal example of a Docker run command with only the required variables.

docker run \
  --name plexanibridge \
  -e ANILIST_TOKEN \
  -e PLEX_TOKEN \
  -e PLEX_USER \
  -e PLEX_URL \
  -e PLEX_SECTIONS \
  -v ./data:/app/data \
  ghcr.io/eliasbenb/plexanibridge:latest