> For the complete documentation index, see [llms.txt](https://wiki.crosswatch.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wiki.crosswatch.app/crosswatch.md). # CrossWatch - [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. - [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. - [Playlists](https://wiki.crosswatch.app/crosswatch/main-dashboard/navigation/playlists.md): Configure playlist endpoints, rulesets, and mappings between supported providers. - [Editor](https://wiki.crosswatch.app/crosswatch/main-dashboard/navigation/editor.md): Inspect provider data, correct item mappings, edit dates, ratings and progress, manage blocks, and send or remove selected records on your providers. - [Profile](https://wiki.crosswatch.app/crosswatch/main-dashboard/navigation/profile.md): View your CrossWatch activity and manage your account, security, and preferences. - [Watchlist](https://wiki.crosswatch.app/crosswatch/main-dashboard/navigation/profile/watchlist.md): Unified watchlist view across configured providers, with filters and provider-aware deletes. - [History](https://wiki.crosswatch.app/crosswatch/main-dashboard/navigation/profile/history.md) - [Playback](https://wiki.crosswatch.app/crosswatch/main-dashboard/navigation/profile/playback.md): The Progress tab shows unfinished playback read live from connected players and playback providers. - [Ratings](https://wiki.crosswatch.app/crosswatch/main-dashboard/navigation/profile/ratings.md): The Ratings tab combines scores read back from your connected providers after synchronization. It helps you see both your ratings and differences between providers. - [Collections](https://wiki.crosswatch.app/crosswatch/main-dashboard/navigation/profile/collections.md): Browse owned and collected media from connected providers. - [Settings](https://wiki.crosswatch.app/crosswatch/main-dashboard/navigation/profile/settings.md): Manage personal profile, security, linked accounts, sessions, and display preferences. - [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. - [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 - [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. - [Interactive Sync](https://wiki.crosswatch.app/crosswatch/main-dashboard/interactive-sync.md): Review a sync plan, resolve conflicts, and apply only selected changes. - [Tools](https://wiki.crosswatch.app/crosswatch/main-dashboard/tools.md): Inspect sync topology, debug matching, edit local state, and export CSVs. - [Analyzer](https://wiki.crosswatch.app/crosswatch/main-dashboard/tools/analyzer.md) - [Events](https://wiki.crosswatch.app/crosswatch/main-dashboard/tools/events.md): Search sync history and diagnose failed, unresolved, or blackboxed operations. - [Import / Export](https://wiki.crosswatch.app/crosswatch/main-dashboard/tools/import-export.md): Import media data into CrossWatch or export it for other services. - [Recover Plex history](https://wiki.crosswatch.app/crosswatch/main-dashboard/tools/import-export/recover-plex-history.md): Recover older Plex watch events for movies and episodes no longer in your libraries. - [Logs](https://wiki.crosswatch.app/crosswatch/main-dashboard/tools/logs.md): Inspect live and saved CrossWatch logs, filter diagnostics, export results, and manage retention. - [Sync topology advisor](https://wiki.crosswatch.app/crosswatch/main-dashboard/tools/sync-topology-advisor.md): Visualize enabled sync routes and identify potential conflicts, loops, and redundant paths. - [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. - [Emby](https://wiki.crosswatch.app/crosswatch/settings/connections/media-servers/emby.md) - [Jellyfin](https://wiki.crosswatch.app/crosswatch/settings/connections/media-servers/jellyfin.md) - [Plex](https://wiki.crosswatch.app/crosswatch/settings/connections/media-servers/plex.md) - [Media clients](https://wiki.crosswatch.app/crosswatch/settings/connections/media-clients.md): Connect supported media clients to synchronize library, history, and playback progress. - [Kodi](https://wiki.crosswatch.app/crosswatch/settings/connections/media-clients/kodi.md): Connect Kodi through HTTP JSON-RPC for library sync and playback scrobbling. - [Nuvio](https://wiki.crosswatch.app/crosswatch/settings/connections/media-clients/nuvio.md) - [Stremio](https://wiki.crosswatch.app/crosswatch/settings/connections/media-clients/stremio.md): Connect Stremio to synchronize History, Progress, Watchlist, and supported Ratings. - [Trackers](https://wiki.crosswatch.app/crosswatch/settings/connections/trackers.md): Connect tracker providers, including CW Local Tracker and Floppy, for synchronization and scrobbling. - [AniList](https://wiki.crosswatch.app/crosswatch/settings/connections/trackers/anilist.md) - [BingeBase](https://wiki.crosswatch.app/crosswatch/settings/connections/trackers/bingebase.md): Connect BingeBase for realtime movie and TV scrobbling. - [CrossWatch](https://wiki.crosswatch.app/crosswatch/settings/connections/trackers/crosswatch.md) - [FlickList](https://wiki.crosswatch.app/crosswatch/settings/connections/trackers/flicklist.md): Connect FlickList to sync watch activity, playlists, and scrobbles. - [Floppy](https://wiki.crosswatch.app/crosswatch/settings/connections/trackers/floppy.md) - [MDBList](https://wiki.crosswatch.app/crosswatch/settings/connections/trackers/mdblist.md) - [PublicMetaDB](https://wiki.crosswatch.app/crosswatch/settings/connections/trackers/publicmetadb.md) - [PunchPlay](https://wiki.crosswatch.app/crosswatch/settings/connections/trackers/punchplay.md) - [Scrob](https://wiki.crosswatch.app/crosswatch/settings/connections/trackers/scrob.md) - [SIMKL](https://wiki.crosswatch.app/crosswatch/settings/connections/trackers/simkl.md) - [TMDb](https://wiki.crosswatch.app/crosswatch/settings/connections/trackers/tmdb.md) - [Trakt](https://wiki.crosswatch.app/crosswatch/settings/connections/trackers/trakt.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) - [Tracearr](https://wiki.crosswatch.app/crosswatch/settings/connections/others/tracearr.md): Import watch history from Tracearr. - [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): Match anime across services with different IDs and episode numbering. - [Profiles](https://wiki.crosswatch.app/crosswatch/settings/connections/profiles.md) - [Managed users](https://wiki.crosswatch.app/crosswatch/settings/connections/managed-users.md): Delegate provider connections and synchronization resources to managed-user accounts. - [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. - [Media clients](https://wiki.crosswatch.app/crosswatch/settings/synchronization/media-clients.md): Adapter reference for supported media clients. - [Kodi](https://wiki.crosswatch.app/crosswatch/settings/synchronization/media-clients/kodi.md): Kodi synchronization reference. - [Nuvio](https://wiki.crosswatch.app/crosswatch/settings/synchronization/media-clients/nuvio.md): Nuvio synchronization reference. - [Stremio](https://wiki.crosswatch.app/crosswatch/settings/synchronization/media-clients/stremio.md): Stremio synchronization reference. - [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. - [CrossWatch](https://wiki.crosswatch.app/crosswatch/settings/synchronization/trackers/crosswatch.md): Local Tracker adapter notes for syncing watchlist, ratings, history, and progress. - [FlickList](https://wiki.crosswatch.app/crosswatch/settings/synchronization/trackers/flicklist.md): FlickList adapter notes for syncing watchlist, ratings, history, progress, and playlists. - [Floppy](https://wiki.crosswatch.app/crosswatch/settings/synchronization/trackers/floppy.md): Floppy adapter notes for syncing watchlist, ratings, history, and progress. - [MDBList](https://wiki.crosswatch.app/crosswatch/settings/synchronization/trackers/mdblist.md): MDBList adapter notes for syncing watchlist, history, ratings, and progress. - [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. - [PunchPlay](https://wiki.crosswatch.app/crosswatch/settings/synchronization/trackers/punchplay.md): PunchPlay adapter notes for syncing watchlist, ratings, history, and progress. - [Scrob](https://wiki.crosswatch.app/crosswatch/settings/synchronization/trackers/scrob.md): Scrob adapter notes for syncing watchlist, ratings, history, and progress. - [SIMKL](https://wiki.crosswatch.app/crosswatch/settings/synchronization/trackers/simkl.md): SIMKL adapter notes for syncing watchlist, history, ratings, and progress. - [TMDb](https://wiki.crosswatch.app/crosswatch/settings/synchronization/trackers/tmdb.md): TMDb adapter notes for syncing TMDb account data (watchlist/ratings) via TMDb (Sync). - [Trakt](https://wiki.crosswatch.app/crosswatch/settings/synchronization/trackers/trakt.md): Trakt adapter notes for syncing watchlist, history, ratings, and progress. - [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. - [Tracearr](https://wiki.crosswatch.app/crosswatch/settings/synchronization/others/tracearr.md): Tracearr adapter notes for importing 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. - [Rewatches](https://wiki.crosswatch.app/crosswatch/settings/configure-pairs/features/history/rewatches.md): Preserve separate watch events for repeated plays. - [Playlists](https://wiki.crosswatch.app/crosswatch/settings/configure-pairs/features/playlists.md): Configure playlist and collection mappings, membership safety, and ordering where supported. - [Progress](https://wiki.crosswatch.app/crosswatch/settings/configure-pairs/features/progress.md): Sync resume position (“Continue Watching”) between supported providers. - [Collection](https://wiki.crosswatch.app/crosswatch/settings/configure-pairs/features/collection.md): Sync a source library or tracker collection into a target collection. - [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 CW receives playback activity from your media server. - [Watcher](https://wiki.crosswatch.app/crosswatch/settings/scrobbler/watcher.md): Real-time scrobbling between supported media servers, trackers, and Scrob. - [Webhooks](https://wiki.crosswatch.app/crosswatch/settings/scrobbler/webhooks.md): Configure webhook-based scrobbling from Plex, Jellyfin, or Emby to supported sinks. - [Destination Library](https://wiki.crosswatch.app/crosswatch/settings/scrobbler/destination-library.md): Control which destination libraries each scrobble route can update. - [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. - [Scheduler Webhooks](https://wiki.crosswatch.app/crosswatch/settings/scheduling/scheduler-webhooks.md) - [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, and HTTPS mode. - [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, managed users, two-factor authentication, external 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 CW web app. - [OIDC sign-in](https://wiki.crosswatch.app/crosswatch/settings/ui-settings/security/oidc-sign-in.md): Sign in with an OpenID Connect provider through linked CrossWatch accounts. - [Google OIDC sign-in](https://wiki.crosswatch.app/crosswatch/settings/ui-settings/security/oidc-sign-in/google-oidc-sign-in.md): Connect Google accounts to CrossWatch through OpenID Connect. - [Two-factor authentication](https://wiki.crosswatch.app/crosswatch/settings/ui-settings/security/two-factor-authentication.md): Protect CrossWatch accounts with six-digit TOTP authenticator codes. - [Reset administrator access](https://wiki.crosswatch.app/crosswatch/settings/ui-settings/security/reset-administrator-access.md): Recover local administrator access with the CLI or a one-time Docker environment variable. - [CW Tracker](https://wiki.crosswatch.app/crosswatch/settings/ui-settings/cw-tracker.md): CW Tracker is configured through its dedicated CrossWatch connection. - [Command-Line Interface (CLI)](https://wiki.crosswatch.app/crosswatch/command-line-interface-cli.md): Manage CrossWatch from a terminal with the cw command. - [Container Run Once Mode](https://wiki.crosswatch.app/crosswatch/command-line-interface-cli/container-run-once-mode.md): Run a local sync that waits for completion and returns an exit code. - [Advanced & API](https://wiki.crosswatch.app/crosswatch/advanced-and-api.md): Low-level configuration, networking, automation, tuning, and API docs for power users. - [API reference](https://wiki.crosswatch.app/crosswatch/advanced-and-api/api-reference.md): API overview and endpoint reference, organized by functional area. - [API foundations](https://wiki.crosswatch.app/crosswatch/advanced-and-api/api-reference/api-foundations.md): Base URLs, sessions, response conventions, and runtime schema endpoints. - [Connections and profiles](https://wiki.crosswatch.app/crosswatch/advanced-and-api/api-reference/connections-and-profiles.md): Provider authentication, connection status, and profile management endpoints. - [Synchronization and scheduling](https://wiki.crosswatch.app/crosswatch/advanced-and-api/api-reference/synchronization-and-scheduling.md): Pair configuration, sync runs, progress streams, and scheduler endpoints. - [Scrobbling and webhooks](https://wiki.crosswatch.app/crosswatch/advanced-and-api/api-reference/scrobbling-and-webhooks.md): Watcher configuration, runtime control, webhook delivery, and activity endpoints. - [Data, insights, and tools](https://wiki.crosswatch.app/crosswatch/advanced-and-api/api-reference/data-insights-and-tools.md): Dashboards, metadata, events, playlists, editing, analysis, and exports. - [Storage and operations](https://wiki.crosswatch.app/crosswatch/advanced-and-api/api-reference/storage-and-operations.md): Files, logs, captures, backups, maintenance, and destructive API operations. - [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 CW 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. - [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. --- # 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 that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://wiki.crosswatch.app/crosswatch.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.