Getting Started
Praxrr v2 is under active development. Use these pages to install the app, link a configuration database, connect Arr instances, and sync quality profiles.
Install and Run
Section titled “Install and Run”- Installation — Docker, binary, and from-source setup
- Quick Start — link a PCD, bridge Arr, and sync end-to-end
- Docker — compose files, volumes, networking, parser opt-in
Guides
Section titled “Guides”- Configuration — environment variables and auth modes
- Connecting Arr Instances — URLs, API keys, external links
- Syncing Profiles — preview, triggers, user ops
- Custom Formats — formats and shared regex entities
- Quality Profiles — qualities and scoring
- Upgrading — release channels and migrations
- Troubleshooting — common errors
Contributor Docs
Section titled “Contributor Docs”- Application architecture — runtime modules and sync pipeline
- Development setup — Deno tasks, env vars, and local workflows
- Testing guide — unit test aliases and e2e prerequisites
- Startup sequence — server initialization order
- PCD schema structure — portable database contracts
- API reference —
/api/v1OpenAPI endpoints
Build the Docs Site
Section titled “Build the Docs Site”From the repository root:
deno task docs:buildThe build imports schema and database mirror docs, renders Starlight pages,
generates the OpenAPI reference, and emits static output to docs/site/dist.