Help & Reference

Plain-English explanations of every part of UsenetStreamer — what each option does and when to use it.

← Back to Control Panel

How it works

When you click a title in Stremio, UsenetStreamer looks it up on your Usenet indexers, fetches matching NZB files, scores and sorts them, then hands the best results back to Stremio as stream links. The whole flow looks like this:

Stremio UsenetStreamer Indexer(s) NZB files Sorted results Stremio stream list

When you pick a stream, the NZB is sent to your download client (NZBDav or directly to your NNTP provider in Native Mode), which downloads and decodes the file so Stremio can play it.


Streaming Mode

There are two ways the addon can send content to Stremio:

NZBDav Mode All platforms The addon pushes each NZB to NZBDav, which downloads and exposes the file over WebDAV. Stremio then streams from that WebDAV URL. Works on every platform — web, mobile, TV.
Desktop Native Mode Desktop / Android TV only The addon streams the NZB content directly using your NNTP credentials — no NZBDav required. Only works with Stremio v5 on Windows, Mac, Linux, and Android TV. Does not work with Prowlarr/NZBHydra — use Direct Newznab indexers only.
Not sure which to pick? Use NZBDav Mode — it works everywhere and requires less setup on the Stremio side.

Indexer Manager

An indexer manager is an app you run separately (Prowlarr or NZBHydra) that sits between UsenetStreamer and your indexers. Instead of configuring each indexer inside UsenetStreamer, you configure them once in Prowlarr or NZBHydra and point the addon at the manager.

Prowlarr A modern indexer manager that integrates tightly with Sonarr/Radarr. Use numeric Prowlarr indexer IDs (or -1 to query all your Usenet indexers).
NZBHydra2 A multi-indexer proxy with its own dedup and stats. Use exact indexer names as shown inside Hydra (case-sensitive).
Direct Newznab Recommended Add indexers directly inside UsenetStreamer using their Newznab API URL and key. No Prowlarr or NZBHydra needed.

Manager URL — the address of your Prowlarr or NZBHydra instance (e.g. http://localhost:9696). Must be reachable from wherever UsenetStreamer is running.

API Key — found in your Prowlarr or NZBHydra settings. Used to authenticate every search request the addon sends to the manager.

Indexer IDs / Names — controls which indexers inside your manager the addon is allowed to query. For Prowlarr, use the numeric indexer IDs shown in Prowlarr's indexer list, or -1 to query all Usenet indexers. For NZBHydra, type the indexer names exactly as they appear in Hydra (case-sensitive).

I have paid subscriptions with — enter the names or IDs of indexers where you have an active paid plan. This tells the addon which results to prioritise during health checks — only these indexers are checked, so your check slots are never wasted on free sources.

Grab limits per indexer — controls how many results from each paid indexer are used for health checks. Enter the limits in the same order as the indexer list, comma-separated (e.g. 2,2 means 2 results from the first indexer and 2 from the second). Default is 6 per indexer if left empty.

Strict ID match — when enabled, the addon only searches by IMDB/TVDB/TMDb IDs and skips text-based fallback searches. This reduces noise from irrelevant results but may miss content that isn't in the ID databases.


Direct Newznab Indexers

Instead of routing through a manager app, you can add up to 20 Usenet indexers directly. Each indexer needs its Newznab API endpoint and API key — both available from your indexer's website under API settings.

  • Endpoint — the base URL of the indexer's Newznab API (e.g. https://indexer.example.com)
  • API Key — your personal key from the indexer's account settings
  • Paid — mark this if the indexer is a paid subscription. This affects two things: (1) during deduplication, results from paid indexers are kept over free ones for the same release; (2) during health checks, paid indexer results are moved to the front of the verification queue so your limited check slots (2, 4, or 6) are used on the most reliable sources first. If you only health-check 2 candidates, you want those 2 to come from your paid indexers — not random free ones.
Tip: Direct Newznab and an indexer manager can be active at the same time — results from both are merged and scored together.

Easynews

Easynews is a Usenet provider with its own built-in web search. When enabled, UsenetStreamer queries Easynews directly using your account credentials alongside your normal indexers. Results are merged into the same sorted list.

  • Requires an active Easynews subscription
  • Treat as indexer — when on, Easynews results are scored and sorted together with NZB results from your other indexers

Sorting

You build your own sort order by checking the dimensions you care about and numbering them in priority order. The addon sorts results by your first checked dimension, then breaks ties using the second, and so on.

Language Results matching your preferred language(s) appear first. You must check this AND set Preferred Languages below — without both, language has no effect on the order.
Resolution Higher resolution ranks first (4K → 1080p → 720p …). If no resolution is parsed from a title, it falls to the bottom of this tier.
Quality Ranks by release quality type (Remux → BluRay → WEB-DL → WEBRip …). Set Preferred Qualities below to pin specific types to the top within this dimension.
Encode Ranks by video codec (e.g. HEVC, AVC). Set Preferred Encodes below to specify which codec you want at the top.
Visual Tag Ranks by HDR format (e.g. Dolby Vision, HDR10+, HDR). Set Preferred Visual Tags to favour specific formats.
Audio Tag Ranks by audio format (e.g. Atmos, TrueHD, DTS). Set Preferred Audio Tags to favour specific formats.
Release Group Ranks results from specific release groups higher. Set Preferred Release Groups to list the groups you trust.
Size Larger files rank higher within the same tier — usually means better quality for the same encode type.
Date (newest first) More recently posted NZBs rank higher. Useful for content where newer posts are more likely to be complete.
File Count (fewest first) NZBs with fewer files rank higher. Fewer files usually means a single clean post rather than a multi-part split set that's more likely to be incomplete.
Keyword Results whose titles contain your preferred keywords rank higher. Set Preferred Keywords to a comma-separated list (e.g. extended, proper, repack).
Preferred Language only works if Language is checked in the sort order. Setting a preferred language without also enabling the Language sort dimension has no effect — the addon won't know to use it.

Preferred settings — each "Preferred X" field only has an effect when its matching sort dimension is checked. For example: Preferred Qualities does nothing unless Quality is in your sort order. This lets you keep a dimension active without personal preferences, or disable a dimension entirely while keeping your preferences saved for later.


Filtering

Filters remove unwanted results before they reach Stremio.

Allowed Resolutions Only show results at the resolutions you tick. Uncheck 4K to avoid large files when you only have a 1080p display.
Resolution Cap per Quality Limit how many results appear per resolution. Set to 4 to show at most 4 results for each resolution tier, keeping the list manageable.
Max File Size Results larger than this are hidden. Default is 30 GB. Lower it if you have limited storage or a slow connection.
Min File Size Results smaller than this are hidden. Default is 45 MB. Keeps out tiny corrupt or incomplete posts that would fail to play.
Release Exclusions Comma-separated keywords — any result whose title contains one of these words is removed. Use this to block cam rips, screeners, or other releases you never want (e.g. cam, ts, screener).
Hide Blocked Results When health checks are enabled, this hides any NZB that the health check marked as incomplete or corrupt. Off by default.

Deduplication

The same NZB post is often indexed by multiple indexers. Deduplication keeps only one copy so your stream list isn't full of identical entries from different sources.

Two results are considered the same release if they share the same normalised title, the same Usenet group, and were posted within 14 days of each other. When duplicates are found, the addon keeps the best one:

  1. A result from a paid indexer beats a result from a free one.
  2. If both are paid (or both free), the one with fewer files wins — fewer files usually means it's a single clean NZB rather than a split set.

Turn deduplication off if you want to see every copy from every indexer — useful for debugging or if you have indexers with different retention.


Cache

The addon caches search results for 72 hours by default. When the same title is requested again within that window, the cached results are returned immediately instead of hitting your indexers again — making repeat searches much faster.

Saving your settings clears the cache. Every time you click Save Changes in the Control Panel, all cached results are wiped. This means your next search will always fetch fresh results with your updated settings applied.


Stream Names & Display

You can customise the label that appears for each stream in Stremio using template tokens. The admin panel has a live preview so you can see exactly what your pattern produces before saving.

Common tokens: resolution, size, indexer, encode, language, age, files.

Example: resolution · size · indexer produces 1080p · 8.4 GB · NZBGeek

Health Checks (NNTP Triage)

Before showing you a stream link, UsenetStreamer can verify the NZB is actually available and complete on your Usenet provider's servers. It does this by connecting directly to your provider over NNTP and checking whether the article headers still exist — an expired or corrupt post will fail this check.

You need to supply your NNTP server credentials (host, port, TLS on/off, username, password) — the same ones you use in SABnzbd or NZBGet.

Max Candidates (2 / 4 / 6) — your sorted result list can have dozens of entries, but checking all of them would be slow. This setting controls how many of the top results actually get health-checked. The addon picks from that pool and only verifies up to this many NZBs per request.

The key insight: results from paid indexers are always moved to the front of that pool, so your limited check slots are used on the most reliable sources first. If you set Max Candidates to 2 and have results from a paid indexer and several free ones, the 2 paid results are checked — not random free ones.

Max Connections — how many simultaneous NNTP connections to open when running checks. More connections = faster parallel checking, but uses more of your provider's connection allowance. Keep this at or below your provider's connection limit.


Stream Protection

Stream Protection controls what happens when you click a stream link — specifically, how the addon guards against playing a result that will fail mid-download.

None No protection. The NZB is sent directly to your download client when you click it.
Auto-Advance If the current NZB fails (download errors, wrong content), the addon automatically tries the next result in the list without you having to go back and pick another one.
Health Check Before sending the NZB to your download client, the addon verifies it's available. If it fails the check, a different result is used instead.
Health Check + Auto-Advance Both — health-checks first, and auto-advances if something still goes wrong during playback.
Smart Play The most thorough mode — see Smart Play below.

Prefetch First Verified — when enabled, as soon as the first candidate passes its health check the addon starts downloading it in the background, even before you click. This shaves off the initial buffering delay when you do click that stream.


Smart Play

Smart Play is the highest level of stream protection. When you click a result, the addon runs a full health check across the top candidates, picks the one most likely to play successfully, and sends that to your download client.

Fastest Picks the first candidate that passes the health check. Minimises wait time — starts download as soon as one good result is found.
Top Ranked Checks all candidates first, then picks the highest-scored one that passed. May take slightly longer but gives you the best quality that's actually available.
Smart Play needs NNTP credentials — it uses the same NNTP triage settings to perform its checks. Make sure your NNTP host, port, username, and password are filled in under Health Checks.

NZBDav

NZBDav is a separate application you run alongside UsenetStreamer. It receives NZB files from the addon, downloads them from Usenet, and exposes the decoded video file over WebDAV so Stremio can stream it directly.

  • NZBDav URL — the address of your NZBDav instance (e.g. http://localhost:3000). This is used by the addon to push NZB files to NZBDav.
  • API Key — from NZBDav's settings, used to authenticate push requests from the addon
  • WebDAV URL / User / Pass — how Stremio connects to NZBDav to stream the file after it's downloaded. In most setups this is the same URL as the NZBDav URL above — only change it if you've configured NZBDav to serve WebDAV on a different address or port.
  • Category — optional label applied to downloads inside NZBDav, used to organise them. The addon appends _MOVIE or _TV automatically based on content type
  • History Catalog Limit — controls how many recently completed NZBDav downloads appear in your Stremio catalog for instant playback. Raising this shows more of your download history directly in Stremio without re-downloading.

Metadata Services (TMDb & TVDB)

By default the addon searches Usenet using the title Stremio provides. Enabling metadata services lets it also search by the content's database IDs (e.g. TMDb ID, TVDB ID), which produces more accurate results — especially for content with common titles or non-English names.

TMDb Movies & TV The Movie Database. Provides additional title variants, release year, original-language title, and alternative titles for non-English content. Requires a free TMDb API key.
TVDB TV only TheTVDB. Provides TVDB episode IDs used by some indexers — particularly useful for anime. Requires a free TVDB API key.

TMDb Search Mode — controls which title variants are used for searches. All tries every known title (English + regional). Primary only uses just the main title — faster but may miss regional releases.

TMDb Additional Languages — lets the addon search using titles in additional languages. Useful if you watch content where the native-language title returns better results on your indexers.

Note: Metadata API keys are free but you must register on each site to get one. Without them the addon still searches using the IDs Stremio provides, but it won't fetch additional title variants or localized titles — meaning some indexers may return fewer or no results for that content.

Tokens & Security

UsenetStreamer uses two separate tokens to control access:

Admin Token ADDON_SHARED_SECRET Protects the Control Panel. Set this in your Docker/environment config before starting the addon. It cannot be changed through the UI. Anyone with this token can read and change all your settings.
Stream Token ADDON_STREAM_TOKEN Included in your Stremio manifest URL. Anyone with this token can trigger searches and receive stream links — but cannot open the admin panel. Share this token only with Stremio clients you trust.

Your manifest URL is the URL you paste into Stremio to install the addon. It contains the stream token as part of the path. If you ever need to revoke access, change the stream token and reinstall the addon in Stremio with the new URL.

Keep both tokens private. If your addon is publicly reachable, anyone who finds the stream token can use your indexers and download client. Use a long random string for both tokens.