# WIKI ## WIKI - [Help Center](https://wiki.crosswatch.app/help-center.md): CrossWatch documentation - [About CrossWatch](https://wiki.crosswatch.app/getting-started/about-crosswatch.md): Self-hosted watchlist, history, ratings, and resume progress sync plus real-time scrobbling - [Limitations](https://wiki.crosswatch.app/getting-started/limitations.md): Soft size guidance, provider plan limits, and request-throttling limits that affect CrossWatch behavior. - [Installation](https://wiki.crosswatch.app/getting-started/installation.md): Choose an installation path for Docker or Unraid. - [Docker setup](https://wiki.crosswatch.app/getting-started/installation/docker-setup.md): Run CW in Docker and persist state by mounting /config. - [Unraid Apps](https://wiki.crosswatch.app/getting-started/installation/unraid-apps.md): Install CrossWatch from the Unraid Community Apps catalog. - [First-time setup](https://wiki.crosswatch.app/getting-started/first-time-setup.md): Connect providers, add TMDb metadata, create your first pair, then (optionally) enable Watcher for real-time scrobbling. - [Best practices](https://wiki.crosswatch.app/getting-started/best-practices.md): Recommended defaults for safe syncing, conflict handling, and operational hygiene. - [Support matrix](https://wiki.crosswatch.app/getting-started/support-matrix.md): Provider and feature compatibility across syncing, scrobbling, playback, and tooling. - [Providers](https://wiki.crosswatch.app/getting-started/support-matrix/providers.md): Provider capabilities, entity support, watchlist mapping, and authentication methods. - [Pair synchronization](https://wiki.crosswatch.app/getting-started/support-matrix/pair-synchronization.md): Feature compatibility, matching rules, and sync controls for standard pairs. - [Scrobbling](https://wiki.crosswatch.app/getting-started/support-matrix/scrobbling.md): Real-time Watcher and webhook support, routes, and playback rules. - [Playback Progress Manager](https://wiki.crosswatch.app/getting-started/support-matrix/playback-progress-manager.md): Resume-item provider support, bulk actions, and live playback visibility. - [Tooling and workflows](https://wiki.crosswatch.app/getting-started/support-matrix/tooling-and-workflows.md): App tooling, Quick Add, captures, backups, exports, scheduler, dashboard, analyzer, editor, and maintenance. - [Operations and limits](https://wiki.crosswatch.app/getting-started/support-matrix/operations-and-limits.md): Security, storage, runtime behavior, limitations, and repository source paths. - [Main dashboard](https://wiki.crosswatch.app/crosswatch/main-dashboard.md): Overview of the Main page, its actions, layout, and linked dashboard sections. - [Navigation](https://wiki.crosswatch.app/crosswatch/main-dashboard/navigation.md): Map the CrossWatch web UI and find the main settings and tools. - [Playback](https://wiki.crosswatch.app/crosswatch/main-dashboard/navigation/playback.md): View and manage unfinished playback records across connected providers. - [Captures](https://wiki.crosswatch.app/crosswatch/main-dashboard/navigation/captures.md): Create point-in-time captures for restore, compare, and scheduled retention workflows. - [Capture Compare](https://wiki.crosswatch.app/crosswatch/main-dashboard/navigation/captures/capture-compare.md): Run a read-only diff between two same-provider captures to see added, removed, updated, and unchanged items. - [Capture Compare (Advanced)](https://wiki.crosswatch.app/crosswatch/main-dashboard/navigation/captures/capture-compare-advanced.md): Advanced capture diff viewer with raw JSON and field-level changes. - [Editor](https://wiki.crosswatch.app/crosswatch/main-dashboard/navigation/editor.md): Inspect and edit CW local data in CW Tracker or Current State, including imports, blocks, manual adds, and save behavior. - [Quick Add](https://wiki.crosswatch.app/crosswatch/main-dashboard/navigation/quick-add.md): Manually send history, ratings, and watchlist actions to one or more providers for titles watched outside your usual media server flow. - [Watchlist](https://wiki.crosswatch.app/crosswatch/main-dashboard/navigation/watchlist.md): Unified watchlist view across configured providers, with filters, local hiding, and provider-aware deletes. - [Insights](https://wiki.crosswatch.app/crosswatch/main-dashboard/insights.md): Filter the Insights dashboard by feature and provider profile. - [Status dashboard](https://wiki.crosswatch.app/crosswatch/main-dashboard/status-dashboard.md): Live status row on the Main page for monitoring, provider health, and updates. - [Dashboard widgets](https://wiki.crosswatch.app/crosswatch/main-dashboard/dashboard-widgets.md): Media widgets on the Main page for watchlist, history, ratings, and scrobble activity. - [Output panel](https://wiki.crosswatch.app/crosswatch/main-dashboard/output-panel.md): Inspect Sync, Watcher, and Debug output from the Main page. - [Sync statuses](https://wiki.crosswatch.app/crosswatch/main-dashboard/output-panel/sync-statuses.md): Meaning of added, removed, updated, skipped, blocked, unresolved, errors, and sync summary counters. - [Tools](https://wiki.crosswatch.app/crosswatch/main-dashboard/tools.md): Debug matching, edit local state, and export CSVs. - [Analyzer](https://wiki.crosswatch.app/crosswatch/main-dashboard/tools/analyzer.md): Inspect sync gaps, blocked items, scope exclusions, weak identifiers, provider limits, and local state diagnostics. - [Events](https://wiki.crosswatch.app/crosswatch/main-dashboard/tools/events.md): Search sync history and diagnose failed, unresolved, or blackboxed operations. - [Exporter](https://wiki.crosswatch.app/crosswatch/main-dashboard/tools/exporter.md): Export watchlist, history, and ratings from state.json to import-friendly CSV files. - [Mobile devices](https://wiki.crosswatch.app/crosswatch/main-dashboard/mobile-devices.md): Use CW on phones, switch compact/full UI, and install it as a PWA over HTTPS. - [Settings](https://wiki.crosswatch.app/crosswatch/settings.md): Configure providers, pairs, scheduling, UI options, and maintenance. - [Connections](https://wiki.crosswatch.app/crosswatch/settings/connections.md): Connect services media servers, trackers, helpers and metadata - [Media servers](https://wiki.crosswatch.app/crosswatch/settings/connections/media-servers.md): Supported media servers (Plex, Jellyfin, Emby) and setup notes for authentication, whitelisting, and matching. - [Plex](https://wiki.crosswatch.app/crosswatch/settings/connections/media-servers/plex.md) - [Jellyfin](https://wiki.crosswatch.app/crosswatch/settings/connections/media-servers/jellyfin.md) - [Emby](https://wiki.crosswatch.app/crosswatch/settings/connections/media-servers/emby.md) - [Trackers](https://wiki.crosswatch.app/crosswatch/settings/connections/trackers.md): Connect tracker providers (Trakt, SIMKL, MDBList, PublicMetaDB, AniList, TMDb) for syncing and scrobbling. - [AniList](https://wiki.crosswatch.app/crosswatch/settings/connections/trackers/anilist.md) - [MDBList](https://wiki.crosswatch.app/crosswatch/settings/connections/trackers/mdblist.md) - [PublicMetaDB](https://wiki.crosswatch.app/crosswatch/settings/connections/trackers/publicmetadb.md) - [SIMKL](https://wiki.crosswatch.app/crosswatch/settings/connections/trackers/simkl.md) - [Trakt](https://wiki.crosswatch.app/crosswatch/settings/connections/trackers/trakt.md) - [TMDb](https://wiki.crosswatch.app/crosswatch/settings/connections/trackers/tmdb.md) - [Others](https://wiki.crosswatch.app/crosswatch/settings/connections/others.md): Connect helper providers used for imports and utility workflows. - [Tautulli](https://wiki.crosswatch.app/crosswatch/settings/connections/others/tautulli.md) - [Metadata](https://wiki.crosswatch.app/crosswatch/settings/connections/metadata.md): Configure TMDb metadata and Anime ID Mapping to improve matching and stabilize IDs across services. - [TMDb Metadata](https://wiki.crosswatch.app/crosswatch/settings/connections/metadata/tmdb-metadata.md): Configure TMDb metadata to improve matching and stabilize IDs across providers. - [Anime ID Mapping](https://wiki.crosswatch.app/crosswatch/settings/connections/metadata/anime-id-mapping.md) - [Profiles](https://wiki.crosswatch.app/crosswatch/settings/connections/profiles.md) - [Library Whitelisting](https://wiki.crosswatch.app/crosswatch/settings/connections/library-whitelisting.md): Limit which Plex/Jellyfin/Emby libraries CrossWatch reads, writes, or scrobbles. - [Synchronization](https://wiki.crosswatch.app/crosswatch/settings/synchronization.md): Adapter reference for how CW reads/writes provider data during syncing. - [Media servers](https://wiki.crosswatch.app/crosswatch/settings/synchronization/media-servers.md): Adapter reference for Plex, Jellyfin, and Emby. - [Emby](https://wiki.crosswatch.app/crosswatch/settings/synchronization/media-servers/emby.md): Emby adapter notes for syncing watchlist/history/ratings and handling ID/matching quirks. - [Jellyfin](https://wiki.crosswatch.app/crosswatch/settings/synchronization/media-servers/jellyfin.md): Jellyfin adapter notes for syncing watchlist/history/ratings and handling missing external IDs. - [Plex](https://wiki.crosswatch.app/crosswatch/settings/synchronization/media-servers/plex.md): Plex adapter notes for syncing watchlist/history/ratings with stable external IDs. - [Trackers](https://wiki.crosswatch.app/crosswatch/settings/synchronization/trackers.md): Adapter reference for tracker services. - [AniList](https://wiki.crosswatch.app/crosswatch/settings/synchronization/trackers/anilist.md): Sync anime watchlists and ratings with AniList. - [MDBList](https://wiki.crosswatch.app/crosswatch/settings/synchronization/trackers/mdblist.md): MDBList adapter notes for syncing watchlist/history/ratings and handling rate limits. - [PublicMetaDB](https://wiki.crosswatch.app/crosswatch/settings/synchronization/trackers/publicmetadb.md): PublicMetaDB adapter notes for syncing watchlist, history, ratings, and progress with TMDb-based matching. - [SIMKL](https://wiki.crosswatch.app/crosswatch/settings/synchronization/trackers/simkl.md): SIMKL adapter notes for syncing watchlist/history/ratings using activity watermarks and batching. - [Trakt](https://wiki.crosswatch.app/crosswatch/settings/synchronization/trackers/trakt.md): Trakt adapter notes for syncing watchlist/history/ratings, including ETag caching and batching. - [TMDb](https://wiki.crosswatch.app/crosswatch/settings/synchronization/trackers/tmdb.md): TMDb adapter notes for syncing TMDb account data (watchlist/ratings) via TMDb (Sync). - [Others](https://wiki.crosswatch.app/crosswatch/settings/synchronization/others.md): Adapter reference for CW and Tautulli. - [CW](https://wiki.crosswatch.app/crosswatch/settings/synchronization/others/cw.md): Local backup adapter that stores watchlist/history/ratings on disk for rollback and restore. - [Tautulli](https://wiki.crosswatch.app/crosswatch/settings/synchronization/others/tautulli.md): Tautulli adapter notes for importing Plex watch history into CW. - [Configure Pairs](https://wiki.crosswatch.app/crosswatch/settings/configure-pairs.md): How to configure a sync pair, feature toggles, and safety controls. - [Global settings](https://wiki.crosswatch.app/crosswatch/settings/configure-pairs/global-settings.md): Pair-wide safety switches and advanced guardrails. - [Provider settings](https://wiki.crosswatch.app/crosswatch/settings/configure-pairs/provider-settings.md): Pair-scoped provider behavior (matching, watched-state quirks, and more). - [Pair-level Whitelisting](https://wiki.crosswatch.app/crosswatch/settings/configure-pairs/provider-settings/pair-level-whitelisting.md): Limit libraries for a single pair and keep other pairs unaffected. - [Features](https://wiki.crosswatch.app/crosswatch/settings/configure-pairs/features.md): Choose a sync feature and start with the lowest-risk setup. - [Watchlist](https://wiki.crosswatch.app/crosswatch/settings/configure-pairs/features/watchlist.md): Configure watchlist syncing (adds, removes, and Jellyfin/Emby modes). - [Ratings](https://wiki.crosswatch.app/crosswatch/settings/configure-pairs/features/ratings.md): Configure ratings sync, scope, and backfill windows. - [History](https://wiki.crosswatch.app/crosswatch/settings/configure-pairs/features/history.md): Configure watched-state syncing and safety limitations. - [Playlists](https://wiki.crosswatch.app/crosswatch/settings/configure-pairs/features/playlists.md): Playlist syncing isn’t supported. The UI has placeholders, but no provider adapters enable playlist read/write. - [Progress](https://wiki.crosswatch.app/crosswatch/settings/configure-pairs/features/progress.md): Sync resume position (“Continue Watching”) between supported providers. - [AniList pair options](https://wiki.crosswatch.app/crosswatch/settings/configure-pairs/anilist-pair-options.md): Pair-level AniList options for Watchlist and Ratings connections. - [Scrobbler](https://wiki.crosswatch.app/crosswatch/settings/scrobbler.md): Configure real-time playback scrobbling from your media server to a tracker. - [Webhook or Watcher](https://wiki.crosswatch.app/crosswatch/settings/scrobbler/webhook-or-watcher.md): Choose how CrossWatch receives playback activity from your media server. - [Webhooks](https://wiki.crosswatch.app/crosswatch/settings/scrobbler/webhooks.md): Configure webhook-based scrobbling from Plex, Jellyfin, or Emby to Trakt, SIMKL, or MDBList. - [Watcher](https://wiki.crosswatch.app/crosswatch/settings/scrobbler/watcher.md): Real-time scrobbling from Plex, Emby, or Jellyfin to Trakt, SIMKL, and MDBList. - [Filters](https://wiki.crosswatch.app/crosswatch/settings/scrobbler/filters.md): Limit which playback events Watcher routes and webhook profiles accept. - [Playing Card](https://wiki.crosswatch.app/crosswatch/settings/scrobbler/playing-card.md): Footer card showing active playback sessions, live progress, and metadata. - [Recent Activity](https://wiki.crosswatch.app/crosswatch/settings/scrobbler/recent-activity.md): Local scrobble history on the Main page and in the full activity view. - [Scheduling](https://wiki.crosswatch.app/crosswatch/settings/scheduling.md): Configure standard recurring syncs or advanced plans with timed steps, automated captures, and event triggers. - [Maintenance](https://wiki.crosswatch.app/crosswatch/settings/maintenance.md): Manage local state, caches, tracker data, playback state, captures, and recovery actions. - [Backup & Restore](https://wiki.crosswatch.app/crosswatch/settings/maintenance/backup-and-restore.md): Create, import, validate, restore, schedule, and delete CW backups. - [UI settings](https://wiki.crosswatch.app/crosswatch/settings/ui-settings.md): Control theme, dashboard cards, sign-in behavior, HTTPS mode, and CW Tracker defaults. - [User interface](https://wiki.crosswatch.app/crosswatch/settings/ui-settings/user-interface.md): Control theme, widget visibility, and UI protocol settings. - [Security](https://wiki.crosswatch.app/crosswatch/settings/ui-settings/security.md): Configure local login, session duration, session cleanup, Plex sign-in, and trusted reverse proxies. - [Plex SSO](https://wiki.crosswatch.app/crosswatch/settings/ui-settings/security/plex-sso.md): Link one Plex account as an optional sign-in method for the CrossWatch web app. - [CW Tracker](https://wiki.crosswatch.app/crosswatch/settings/ui-settings/cw-tracker.md): Configure CW Tracker retention, auto snapshots, and tracker snapshot selectors. - [FAQ](https://wiki.crosswatch.app/crosswatch/faq.md): Common questions about installation, setup, syncing, scrobbling, and troubleshooting. - [Advanced & API](https://wiki.crosswatch.app/crosswatch/advanced-and-api.md): Low-level configuration, networking, automation, tuning, and API docs for power users. - [Configuration reference](https://wiki.crosswatch.app/crosswatch/advanced-and-api/configuration-reference.md): File location, load rules, normalization, and key reference for config.json. - [Default config values](https://wiki.crosswatch.app/crosswatch/advanced-and-api/configuration-reference/default-config-values.md): Reference defaults for the most-used CrossWatch config.json settings. - [Config encryption](https://wiki.crosswatch.app/crosswatch/advanced-and-api/configuration-reference/config-encryption.md): How CrossWatch encrypts secret values in config.json, where the master key comes from, and what to back up. - [HTTPS and TLS](https://wiki.crosswatch.app/crosswatch/advanced-and-api/https-and-tls.md): Serve the UI over HTTPS, use self-signed or custom certificates, and know when to prefer a reverse proxy. - [Reverse proxy setup](https://wiki.crosswatch.app/crosswatch/advanced-and-api/reverse-proxy-setup.md): Put CW behind NGINX or another proxy with correct TLS, webhook, and WebSocket handling. - [Advanced Scheduling](https://wiki.crosswatch.app/crosswatch/advanced-and-api/advanced-scheduling.md): Build timed sync plans, scheduled captures, and event triggers for precise automation. - [Rate limiting and retries](https://wiki.crosswatch.app/crosswatch/advanced-and-api/rate-limiting-and-retries.md): Tune provider pacing, retries, chunking, and write delays when APIs return 429s, 5xx errors, or timeouts. - [API reference](https://wiki.crosswatch.app/crosswatch/advanced-and-api/api-reference.md): Use the CW REST API from your own instance, with base URL guidance and the OpenAPI reference. - [Community](https://wiki.crosswatch.app/related-information/community.md): Community guides and install helpers for unsupported setups. - [Install scripts](https://wiki.crosswatch.app/related-information/community/install-scripts.md): Community-built install helpers and setup wrappers for CrossWatch. - [Proxmox LXC installer](https://wiki.crosswatch.app/related-information/community/install-scripts/proxmox-lxc-installer.md): Deploy CrossWatch in an unprivileged Proxmox Debian 12 LXC with automated setup, persistent /config storage, and a built-in update command. - [Synology with Portainer or Dockhand](https://wiki.crosswatch.app/related-information/community/install-scripts/synology-with-portainer-or-dockhand.md): Community guide for running CrossWatch on Synology with Portainer or Dockhand. - [Trackers vs. Media Servers](https://wiki.crosswatch.app/related-information/trackers-vs.-media-servers.md): How to choose a source of truth between trackers and media servers. - [Media Server to Media Server](https://wiki.crosswatch.app/related-information/media-server-to-media-server.md) - [Tracker to Media Server](https://wiki.crosswatch.app/related-information/tracker-to-media-server.md): Why syncing from a tracker into a media server is risky, and safer defaults for history and ratings. - [Trakt vs SIMKL (Free plans)](https://wiki.crosswatch.app/related-information/trakt-vs-simkl-free-plans.md): Quick comparison of common free-plan limits that affect watchlists and lists. - [Overview](https://wiki.crosswatch.app/blueprint-architecture/overview.md): Big-picture map of how Auth, Meta, Sync, Scrobble, and the Orchestrator fit together. - [Orchestrator](https://wiki.crosswatch.app/blueprint-architecture/orchestrator.md): How the orchestrator runtime loads providers, plans changes, applies writes, and persists state safely. - [Snapshots](https://wiki.crosswatch.app/blueprint-architecture/orchestrator/snapshots.md) - [Blackbox](https://wiki.crosswatch.app/blueprint-architecture/orchestrator/blackbox.md) - [One-way sync](https://wiki.crosswatch.app/blueprint-architecture/orchestrator/one-way-sync.md) - [Two-way sync](https://wiki.crosswatch.app/blueprint-architecture/orchestrator/two-way-sync.md) - [Guardrails](https://wiki.crosswatch.app/blueprint-architecture/orchestrator/guardrails.md) - [State](https://wiki.crosswatch.app/blueprint-architecture/orchestrator/state.md) - [Applier](https://wiki.crosswatch.app/blueprint-architecture/orchestrator/applier.md) - [Planner](https://wiki.crosswatch.app/blueprint-architecture/orchestrator/planner.md) - [Tombstones](https://wiki.crosswatch.app/blueprint-architecture/orchestrator/tombstones.md) - [Unresolved](https://wiki.crosswatch.app/blueprint-architecture/orchestrator/unresolved.md) - [Phantom Guard](https://wiki.crosswatch.app/blueprint-architecture/orchestrator/phantom-guard.md) - [Scope](https://wiki.crosswatch.app/blueprint-architecture/orchestrator/scope.md) - [Eventing](https://wiki.crosswatch.app/blueprint-architecture/orchestrator/eventing.md) - [Runtime](https://wiki.crosswatch.app/blueprint-architecture/orchestrator/runtime.md) - [Conflicts](https://wiki.crosswatch.app/blueprint-architecture/orchestrator/conflicts.md) - [Blocklists](https://wiki.crosswatch.app/blueprint-architecture/orchestrator/blocklists.md) - [Health](https://wiki.crosswatch.app/blueprint-architecture/orchestrator/health.md) - [Chunking](https://wiki.crosswatch.app/blueprint-architecture/orchestrator/chunking.md) - [Caching layers](https://wiki.crosswatch.app/blueprint-architecture/orchestrator/caching-layers.md) - [State.json](https://wiki.crosswatch.app/blueprint-architecture/orchestrator/state-json.md) - [Provider contract](https://wiki.crosswatch.app/blueprint-architecture/orchestrator/provider-contract.md) - [Provider specifics](https://wiki.crosswatch.app/blueprint-architecture/orchestrator/provider-specifics.md) - [Auth](https://wiki.crosswatch.app/blueprint-architecture/auth.md): Internal docs for auth provider modules used by Settings → Connections. - [Registry](https://wiki.crosswatch.app/blueprint-architecture/auth/registry.md) - [Provider auth modules](https://wiki.crosswatch.app/blueprint-architecture/auth/provider-auth-modules.md) - [Meta](https://wiki.crosswatch.app/blueprint-architecture/meta.md): Internal docs for metadata modules that resolve IDs and enrich items. - [Registry](https://wiki.crosswatch.app/blueprint-architecture/meta/registry.md) - [TMDb metadata](https://wiki.crosswatch.app/blueprint-architecture/meta/tmdb-metadata.md) - [Sync](https://wiki.crosswatch.app/blueprint-architecture/sync.md): Low-level sync provider modules used by the Orchestrator. - [Engine-level features](https://wiki.crosswatch.app/blueprint-architecture/sync/engine-level-features.md) - [Media server modules](https://wiki.crosswatch.app/blueprint-architecture/sync/media-server-modules.md) - [Tracker modules](https://wiki.crosswatch.app/blueprint-architecture/sync/tracker-modules.md) - [Local and utility modules](https://wiki.crosswatch.app/blueprint-architecture/sync/local-and-utility-modules.md) - [Scrobble](https://wiki.crosswatch.app/blueprint-architecture/scrobble.md): Internal blueprint for the scrobble pipeline. - [Sink](https://wiki.crosswatch.app/blueprint-architecture/scrobble/sink.md) - [Providers](https://wiki.crosswatch.app/blueprint-architecture/scrobble/providers.md) - [Webhooks](https://wiki.crosswatch.app/blueprint-architecture/scrobble/webhooks.md) - [Services](https://wiki.crosswatch.app/blueprint-architecture/scrobble/services.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://wiki.crosswatch.app/help-center.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.