Requirements
Docker deployment
Section titled “Docker deployment”- Docker Engine with Compose v2.
- A host directory for persistent
/datastorage. - At least one reachable Plex, Jellyfin, or Emby server with the required account or API credentials.
- A modern browser.
- HTTPS and a stable public URL when using custom OAuth callbacks or remote source webhooks.
The current Compose file builds Brokerr locally from the checkout. Plan enough disk for the source checkout, image layers, SQLite history, AniBridge cache, and optional artwork cache.
Source development
Section titled “Source development”- Python 3.12.
- Node.js 22.12 or newer with npm.
- The Python dependencies in
backend/requirements.txt. - Separate terminals for Uvicorn and Vite.
Provider accounts
Section titled “Provider accounts”Hosted OAuth requires only a provider account. Custom OAuth requires your own provider application and its credentials. TMDB additionally uses an API read access token/API key for metadata and account authorization.
Network access
Section titled “Network access”Brokerr must reach each configured source server, the configured provider APIs, AniBridge mapping data, and the hosted OAuth gateway when that mode is selected. Do not expose the service directly to the internet without TLS and a correctly configured reverse proxy.