Skip to content

Requirements

  • Docker Engine with Compose v2.
  • A host directory for persistent /data storage.
  • One reachable Plex server and a Plex account.
  • At least one AniList, TMDB, or Letterboxd target account.
  • A modern browser.
  • HTTPS and a stable public URL for remote Plex webhooks and production access.

The Compose file builds Brokerr from the checkout. Plan space for image layers, SQLite run/history state, AniBridge data, source observations, exports, and artwork cache.

  • Python 3.12.
  • Node.js 22.12 or newer with npm.
  • Dependencies from backend/requirements.txt and frontend/package-lock.json.
  • Separate backend and Vite terminals.

Hosted authorization needs only the provider account. AniList and TMDB custom mode require an operator-owned provider application. Letterboxd API access is provided through the hosted gateway. Plex account Sync Watch State & Ratings is required only for optional connected-account recorded-history features.

Brokerr may need the selected Plex server, Plex account services, provider APIs, AniBridge mapping data, and https://auth.brokerr.net. Do not expose Brokerr or its data directory directly without TLS and a correctly configured reverse proxy.