Quick start
1. Install and sign in
Section titled “1. Install and sign in”Complete the Docker Compose installation and
initial setup. Keep the database, config.yml,
master key, and artwork cache on persistent storage.
2. Add a Plex source
Section titled “2. Add a Plex source”Open Sources, choose Plex, and sign in. Select one discovered server URL, save it, choose the default libraries, and run Check connection. Each Plex server is currently a separate source instance even when multiple servers belong to the same Plex account.
3. Add a target
Section titled “3. Add a target”Open Targets and add one of:
- AniList for anime list status, progress, ratings, rewatch count, and custom lists.
- TMDB for watchlist, ratings, and custom lists.
- Letterboxd for movie watchlist, ratings, Watched state, diary history, and ordered lists.
Hosted authorization through https://auth.brokerr.net is the recommended mode
where offered. After connection, run the target’s API tester connection action.
4. Create a profile
Section titled “4. Create a profile”Open Profiles, choose the source and target instances, select libraries, and review every available feature panel. Feature availability is the capability intersection; unsupported rules are not silently executed.
Save the profile. The saved defaults are materialized into that profile. A feature added or upgraded later remains disabled with Needs review until the profile is opened and saved again.
5. Review a full dry-run
Section titled “5. Review a full dry-run”Select Full reconciliation, keep the mode on Dry-run, and start the run. Inspect:
- source and target titles;
- mapping provenance and identifiers;
- before/after values for every feature;
- unmatched and ignored items;
- provider-attributed source, target, and core logs;
- long-import write estimate and minimum duration when shown.
Fix incorrect mappings before applying changes. Dry-run operations can be applied individually, but the safest first baseline is a reviewed full live run.
6. Establish the baseline
Section titled “6. Establish the baseline”Switch to Live, start Full reconciliation, confirm the safety dialog, and let the run finish. A successful live full run establishes the profile baseline. Incremental runs remain disabled until that baseline exists.
7. Use incremental runs or webhooks
Section titled “7. Use incremental runs or webhooks”Incremental runs compare source fingerprints, reuse cached mappings, and avoid unnecessary target reads. Enable Process source webhooks on the profile and configure the displayed Plex webhook URL for event-driven updates.
Run another full reconciliation when you need authoritative target-side drift repair, after significant mapping changes, or after resetting profile data.
8. Optional automation
Section titled “8. Optional automation”Enable scheduled full or incremental execution for the profile, then place it in a scheduler group under Settings → Scheduling. Configure Discord under Settings → Notifications if terminal run messages are useful for the deployment.