Skip to content
Kellerman81 edited this page Dec 21, 2025 · 2 revisions

Indexer Configuration

Indexers are used to search for and discover media releases. Currently, go_media_downloader supports Newznab/Torznab indexers, which includes most popular Usenet and torrent indexers.

General Parameters

All indexers require these parameters:

  • name: Unique identifier for the indexer
  • type: Indexer protocol type (currently only newznab)
  • enabled: Enable or disable this indexer (true/false)

Newznab/Torznab Indexers

The Newznab protocol is used by both Usenet (Newznab) and torrent (Torznab) indexers. This single configuration type works for both.

Required Parameters

[[indexers]]
name = "indexer_name"        # Unique indexer name
type = "newznab"             # Always "newznab" for Newznab/Torznab
url = "https://..."          # Base URL of the indexer
apikey = "your_api_key"      # API key from the indexer
enabled = true               # Enable this indexer
rss_enabled = true           # Enable RSS feed monitoring

Connection & Authentication

  • url: Base URL of your indexer (e.g., https://api.nzbgeek.info)
  • apikey: API authentication key provided by the indexer
  • userid: Optional user ID for RSS queries (default: "0")
  • custom_api: Custom API parameter name if indexer doesn't use apikey (e.g., NZBFinder uses api_token)
  • custom_url: Custom API path if not using /api (include the apikey parameter)
  • custom_rss_url: Custom RSS path if not using /rss
  • custom_rss_category: Custom RSS category parameter if not using t (e.g., NZBFinder uses id)

Search Settings

  • max_entries: Maximum number of results per search (default: 100)
  • max_age: Maximum age of releases in days (0 = no limit)
  • add_quotes_for_title_query: Wrap title searches in quotes for exact matching (true/false)
  • output_as_json: Request JSON format instead of XML (true/false)
    • Note: Some indexers like Jackett don't support JSON output
    • JSON can be faster and less resource-intensive when supported

Rate Limiting

  • limiter_calls: Number of API calls allowed within limiter_seconds
  • limiter_seconds: Time window in seconds for rate limiting
  • limiter_calls_daily: Maximum API calls per 24-hour period (0 = unlimited)
  • timeout_seconds: Request timeout in seconds (default: 60)

Example: limiter_calls=5 and limiter_seconds=20 allows 5 calls every 20 seconds.

RSS Feed Configuration

  • rss_enabled: Enable RSS feed monitoring for this indexer
  • rss_entries_loop: Number of RSS pages to fetch before stopping (searches until finding last processed release ID)

Advanced Options

  • disable_tls_verify: Skip SSL certificate verification (true/false)
  • disable_compression: Disable HTTP compression (true/false)
  • trust_with_imdb_ids: Trust IMDB IDs provided by this indexer (true/false)
  • trust_with_tvdb_ids: Trust TVDB IDs provided by this indexer (true/false)
  • check_title_on_id_search: Verify release titles match during ID-based searches (true/false)

Example Configurations

NZBGeek (Newznab)

[[indexers]]
name = "nzbgeek"
type = "newznab"
url = "https://api.nzbgeek.info"
apikey = "your_api_key_here"
userid = "0"
enabled = true
rss_enabled = true
custom_api = ""
custom_url = ""
custom_rss_url = ""
custom_rss_category = ""
add_quotes_for_title_query = false
max_rss_entries = 100
rss_entries_loop = 5
limiter_seconds = 20
limiter_calls = 5
limiter_calls_daily = 0
max_age = 2300
timeout_seconds = 60
output_as_json = true
disable_tls_verify = false
disable_compression = false
trust_with_imdb_ids = true
trust_with_tvdb_ids = true
check_title_on_id_search = false

NZBFinder (Custom Parameters)

NZBFinder uses different parameter names:

[[indexers]]
name = "nzbfinder"
type = "newznab"
url = "https://nzbfinder.ws"
apikey = "your_api_token_here"
userid = "0"
enabled = true
rss_enabled = true
custom_api = "api_token"              # NZBFinder uses "api_token" instead of "apikey"
custom_rss_category = "id"            # NZBFinder uses "id" instead of "t" for category
add_quotes_for_title_query = false
max_rss_entries = 100
rss_entries_loop = 5
limiter_seconds = 20
limiter_calls = 5
limiter_calls_daily = 100             # Free tier has daily limits
max_age = 0
timeout_seconds = 60
output_as_json = true

Jackett (Torznab Proxy)

Jackett provides Torznab-compatible endpoints for many trackers:

[[indexers]]
name = "jackett_tracker"
type = "newznab"
url = "http://localhost:9117/api/v2.0/indexers/tracker_id"
apikey = "jackett_api_key"
userid = "0"
enabled = true
rss_enabled = true
add_quotes_for_title_query = false
max_rss_entries = 100
rss_entries_loop = 3
limiter_seconds = 10
limiter_calls = 3
max_age = 0
timeout_seconds = 60
output_as_json = false                # Jackett doesn't support JSON output

Prowlarr (Unified Indexer Manager)

Prowlarr provides Newznab/Torznab endpoints for configured indexers:

[[indexers]]
name = "prowlarr"
type = "newznab"
url = "http://localhost:9696/1/api"   # The "1" is the indexer ID from Prowlarr
apikey = "prowlarr_api_key"
userid = "0"
enabled = true
rss_enabled = true
add_quotes_for_title_query = false
max_rss_entries = 100
rss_entries_loop = 5
limiter_seconds = 10
limiter_calls = 5
max_age = 0
timeout_seconds = 60
output_as_json = true

Tips

  1. Rate Limiting: Always respect your indexer's rate limits to avoid being blocked
  2. JSON vs XML: Try JSON output first for better performance, fall back to XML if not supported
  3. RSS Monitoring: Use RSS for automated discovery of new releases
  4. Multiple Indexers: Configure multiple indexers for better coverage
  5. Daily Limits: Set limiter_calls_daily for indexers with API quotas (e.g., free tier indexers)
  6. Trusted IDs: Enable trust_with_imdb_ids and trust_with_tvdb_ids for well-maintained indexers to improve matching accuracy

Supported Indexers

Any Newznab or Torznab compatible indexer should work, including:

Popular Usenet Indexers (Newznab):

  • NZBGeek
  • NZBFinder
  • DrunkenSlug
  • DOGnzb
  • NZBPlanet
  • And many others

Torrent Indexer Proxies (Torznab):

  • Jackett (proxy for 100+ torrent trackers)
  • Prowlarr (unified indexer management)
  • Cardigann (additional tracker support)

Note: Private trackers accessed through Jackett or Prowlarr require configuration in those applications first.

Clone this wiki locally