> ## Documentation Index
> Fetch the complete documentation index at: https://docs.questarr.app/llms.txt
> Use this file to discover all available pages before exploring further.

# GITHUB DOCUMENTATION

# GitHub Documentation Map (Canonical)

This file is the single entry point for GitHub-facing documentation in this repository.

* Product overview and setup: [`README.md`](../README.md)
* Contribution guide: [`.github/CONTRIBUTING.md`](../.github/CONTRIBUTING.md)
* Security policy and reporting: [`docs/SECURITY.md`](SECURITY.md)
* API reference: [`docs/API.md`](./API.md), for the REST/Socket.io interface reference
* Architecture: [`docs/ARCHITECTURE.md`](./ARCHITECTURE.md), for a system architecture and actor overview
* Changelog: [`docs/CHANGELOG.md`](./CHANGELOG.md)
* Migration notes: [`docs/MIGRATION.md`](./MIGRATION.md), for migration from PostgreSQL to SQLite in v1.1
* Database: [`docs/DATABASE.md`](./DATABASE.md), for running Questarr on the optional PostgreSQL backend instead of SQLite
* Reverse proxy / subdirectory deployment: [`docs/REVERSE_PROXY.md`](./REVERSE_PROXY.md), for serving Questarr from a path like `/Questarr` behind nginx/Traefik/Caddy
* Proxmox VE deployment: [`docs/PROXMOX.md`](./PROXMOX.md), for deploying Questarr into a Proxmox LXC container without Docker
* Home server app definitions: [`docs/HOME_SERVER_APPS.md`](./HOME_SERVER_APPS.md), for the UNRAID/CasaOS/Umbrel/Cosmos Cloud/Home Assistant install definitions
* Playnite extension: [`extensions/playnite-questarr/README.md`](../extensions/playnite-questarr/README.md), for syncing your Playnite library and requesting games from the couch
* Security model and operations:
  * [`docs/THREAT_MODEL.md`](./THREAT_MODEL.md), for the attack surface analysis and security architecture
  * [`docs/SECURITY_ASSESSMENT.md`](./SECURITY_ASSESSMENT.md), security risk assessment.
  * [`docs/VULNERABILITY_MANAGEMENT.md`](./VULNERABILITY_MANAGEMENT.md), for the SCA/SAST remediation policy and release gates
  * [`docs/SECRETS.md`](./SECRETS.md), for details on how API keys, indexer/downloader credentials, and other secrets are stored and managed.
  * [`docs/SBOM.md`](./SBOM.md): Every published image ships with a Software Bill of Materials.
  * [`docs/VEX.md`](./VEX.md), for details on the Questar's Vulnerability Exploitability Exchange feed
  * [`docs/DEPENDENCIES.md`](./DEPENDENCIES.md), for how dependencies are selected, obtained, and tracked.
* `docs/CODE_OF_CONDUCT.md` (community health file)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.