> 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/getting-started.md).

# Getting Started

- [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.


---

# 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/getting-started.md?ask=<question>&goal=<endgoal>
```

`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.