Skip to content

Prowlarr - Config - Indexers

Configuration options for prowlarr config indexers.

Available Options

This page documents 9 configuration options.

nixflix.prowlarr.config.indexers

List of indexers to configure in Prowlarr. Prowlarr supports many indexers in addition to any indexer that uses the Newznab/Torznab standard using 'Generic Newznab' (for usenet) or 'Generic Torznab' (for torrents).

Any additional attributes beyond name, apiKey, apikey, username, password, passkey, and appProfileId will be applied as field values to the indexer schema.

The apiKey or apikey value is automatically applied to whichever field name the indexer schema uses — some schemas use apiKey (camelCase) and others use apikey (all-lowercase).

You can run the following command to get the field names for a particular indexer:

curl -s -H "X-Api-Key: $(sudo cat </path/to/prowlarr/apiKey>)" "http://127.0.0.1:9696/api/v1/indexer/schema" | jq '.[] | select(.name=="<indexerName>") | .fields'
Typelist of (open submodule of attribute set of anything)
Default
[ ]
Declared inmodules/prowlarr/indexers.nix

nixflix.prowlarr.config.indexers.*.apiKey

API key for the indexer. Applied to schema fields named apikey or apiKey.

Warning

Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use { _secret = path; } for sensitive data.

Typenull or string or (submodule)
Default
null
Example
{ _secret = "/run/secrets/secret-file"; }
Declared inmodules/prowlarr/indexers.nix

nixflix.prowlarr.config.indexers.*.apikey

API key for the indexer (lowercase variant). Applied to schema fields named apikey or apiKey.

Warning

Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use { _secret = path; } for sensitive data.

Typenull or string or (submodule)
Default
null
Example
{ _secret = "/run/secrets/secret-file"; }
Declared inmodules/prowlarr/indexers.nix

nixflix.prowlarr.config.indexers.*.appProfileId

Application profile ID for the indexer (default: 1).

Typesigned integer
Default
1
Declared inmodules/prowlarr/indexers.nix

nixflix.prowlarr.config.indexers.*.name

Name of the Prowlarr Indexer Schema

Typestring
Declared inmodules/prowlarr/indexers.nix

nixflix.prowlarr.config.indexers.*.passkey

Passkey for the indexer.

Warning

Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use { _secret = path; } for sensitive data.

Typenull or string or (submodule)
Default
null
Example
{ _secret = "/run/secrets/secret-file"; }
Declared inmodules/prowlarr/indexers.nix

nixflix.prowlarr.config.indexers.*.password

Password for the indexer.

Warning

Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use { _secret = path; } for sensitive data.

Typenull or string or (submodule)
Default
null
Example
{ _secret = "/run/secrets/secret-file"; }
Declared inmodules/prowlarr/indexers.nix

nixflix.prowlarr.config.indexers.*.tags

Use tags to specify Indexer Proxies or which apps the indexer is synced to.

Tags should be used with caution, they can have unintended effects. An indexer with a tag will only sync to apps with the same tag.

Typelist of string
Default
[ ]
Declared inmodules/prowlarr/indexers.nix

nixflix.prowlarr.config.indexers.*.username

Username for the indexer.

Warning

Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use { _secret = path; } for sensitive data.

Typenull or string or (submodule)
Default
null
Example
{ _secret = "/run/secrets/secret-file"; }
Declared inmodules/prowlarr/indexers.nix