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