Home

indexarr wiki

Documentation for indexarr 2: installation, sources, apps, APIs and the internals.

The source code lives in the repository; this wiki holds the documentation.

Start here

• User manual (English) — from the first start to everyday use.
• Manuale utente (italiano) — dall'avvio all'uso quotidiano.

Guides

• Configuration — indexarr.json and every setting with its default.
• Sources — catalog, RSS, Torznab, Usenet, eD2k, cookies and FlareSolverr.
• Connecting apps and clients — Torznab endpoint, *arr sync, API keys, live search.
• Web interface — pages, search syntax, saved searches, rules and notifications.
• Operations — backup, maintenance, statistics, logs and security.
• Installation — systemd installer, upgrades and Docker.

APIs

• Torznab API — endpoints, parameters, downloads, errors.
• Admin JSON API — definitions, indexers, proxies, applications.

Sources

• Definitions — native v1 format, fixtures and indexarr-def.
• Catalog — sites, families, states and live evidence.
• MirCrew — native definition, Smartfeed and FlareSolverr.
• Compatibility — MirCrew, Torznab, RSS and native sources.
• Replacing Jackett and Prowlarr — no import, native catalog, queue and checks.

Operations

• Architecture — packages, flow, database and design choices.
• Vault — master key, resolution order, CLI, backup, Docker secrets.
• QA and tests — test suite, smoke tests and mobile checklist.
• Development — build, test, pprof and the definitions CLI.

Project

• Backlog — open work, evidence and how to verify it.
• UI rules — page rules, menu structure and components.