Skip to content

Indexers

Indexers provide search capabilities for finding media releases. Mydia supports Prowlarr, Jackett, Newznab, and built-in Cardigann indexers.

See Indexers for the full list of supported indexer types.

Prowlarr is an indexer manager that aggregates multiple indexers into a single API.

Setup

  1. Navigate to Admin > Configuration > Indexers
  2. Click Add Indexer
  3. Select Prowlarr
  4. Enter connection details:
  5. Base URL: http://prowlarr:9696
  6. API Key: Your Prowlarr API key
  7. Test connection
  8. Save

Environment Variables

Every indexer variable is listed in Environment variables.

Jackett

Jackett is an alternative indexer proxy.

Setup

  1. Navigate to Admin > Configuration > Indexers
  2. Click Add Indexer
  3. Select Jackett
  4. Enter connection details:
  5. Base URL: http://jackett:9117
  6. API Key: Your Jackett API key
  7. Test connection
  8. Save

Environment Variables

Every indexer variable is listed in Environment variables.

Newznab

Newznab is the API protocol Usenet indexers expose. Any Newznab-compatible service works here, including meta search aggregators such as NZBHydra2.

Setup

  1. Navigate to Admin > Configuration > Indexers
  2. Click Add Indexer
  3. Select Newznab
  4. Enter connection details:
  5. Base URL: https://indexer.example, or the deployment prefix your provider publishes, such as https://indexer.example/proxy
  6. API Path: /api by default. Change it only if your provider serves the Newznab endpoint at another path, such as /newznab/api.
  7. API Key: Your provider's Newznab API key
  8. Test connection
  9. Save

The Base URL identifies the service, and the API Path identifies the Newznab endpoint on it. Mydia joins the two, so a base URL of https://indexer.example/proxy with the default API Path requests https://indexer.example/proxy/api.

Environment Variables

Every indexer variable is listed in Environment variables.

Mydia also includes built-in Cardigann indexer support for connecting to indexers directly, without Prowlarr or Jackett.

See Indexers Reference for the full list of Admin UI configuration fields.

Indexer Priority

Every enabled indexer is searched concurrently on every query, and the results are aggregated and deduplicated into one pool. The Priority field on an indexer orders the indexer list; it does not make an indexer's results rank higher or arrive sooner.

To stop an indexer influencing results, disable it. To change which release wins, adjust the quality profile. See How a Title Becomes a File for the details.

Categories

Restrict an indexer to particular content categories with INDEXER_<N>_CATEGORIES. There is no field for this in the admin form.

  • movies - Movie content
  • tv - TV show content
  • music - Torznab Audio categories
  • books - Torznab Books categories

music and books still map to the Torznab categories the protocol defines, so an indexer can be restricted to them. Mydia no longer has a library to put those results in, though: a result in an Audio, Books or XXX category does not auto-assign a library and prompts you to pick one instead.

Rate Limiting

Set INDEXER_<N>_RATE_LIMIT to cap how hard Mydia hits an indexer. There is no field for this in the admin form either.

The limit is per minute

The number is requests per minute, counted in a sliding one-minute window. INDEXER_1_RATE_LIMIT=30 allows thirty searches a minute. Once the window is full, Mydia refuses further searches against that indexer until it drains, rather than queueing them.

Leave it unset and there is no limit at all. If your indexer publishes an API rate limit, set this below it. Getting the unit wrong by reading it as per-second is a good way to earn a ban.

Next Steps