Brokerr documentation

This site documents Brokerr 0.2.0 (unreleased). Brokerr reads canonical media observations from plugin-like sources and applies capability-resolved features to plugin-like targets. A profile owns the scope, rules, run history, fingerprints, mappings, and managed-list bindings between one source and one target.

Install BrokerrPrepare persistent storage and start the supported Docker Compose deployment.

Complete the first syncConnect Plex and a target, create a profile, inspect a dry-run, and establish a live full baseline.

Build a providerUse SDK v5 manifests and public runtime contracts to add a source or target without changing core.

Documentation map

Understand Brokerr

Learn the source, target, profile, feature, mapping, operation, and state model.

Configure providers

Connect Plex, AniList, TMDB, or Letterboxd and understand every exposed option.

Operate safely

Analyze long imports, use dry-runs, inspect provider-attributed logs, and apply or revert changes.

Protect data

Understand local encryption, OAuth handoff, SQLite persistence, external data flows, and backups.

Extend providers

Follow the manifest, capability, source, target, feature, operation, and Revert contracts in SDK v5.

Review before writing

For every new profile, run a Full reconciliation in Dry-run mode first. Then inspect mappings and changes before starting the live run. A live run can change lists, ratings, progress, watched state, and diary entries in connected accounts.

Current scope

• Production source: Plex.
• Production targets: AniList, TMDB, and Letterboxd.
• Manual, scheduled, and webhook-triggered runs support full and incremental execution, dry-run, Apply, Revert, managed lists, history, and diagnostics.
• Discord notifications can be scoped globally or to one profile and report terminal run outcomes without exposing provider credentials.
• Source and target plugins are discovered from folders and validated against public SDK version 5.