Skip to content

sleeyax/stremio-nzb-addon

Repository files navigation

Stremio NZB(Hydra 2) Addon

Usenet streaming from NZBHydra 2 or your own indexers (Drunken Slug, NZBGeek, nzbplanet, etc.) and NNTP servers for Stremio.

Warning

Usenet support is still experimental in Stremio. Please read the official announcement for details.

Usage

New to usenet? See the The Basics section below.

Configuration

The addon requires the following configuration parameters:

1. indexerUrl (text)

  • Title: Indexer URL
  • Description: The base URL of your indexer or NZBHydra 2 instance.
  • Required: Yes
  • Example: https://nzbhydra2.example.com or https://api.example.com

2. indexerApiKey (password)

  • Title: Indexer API key
  • Description: Your indexer or NZBHydra 2 API key.
  • Required: Yes
  • Example: abcd1234efgh5678ijkl9012mnop3456

3. nntpServers (text)

  • Title: NNTP Servers (comma separated)
  • Description: A list of NNTP server addresses to use for downloading NZB files. Format: nntp(s)://{user}:{pass}@{nntpDomain}:{nntpPort}/{nntpConnections}. See the stremio addon SDK docs for details.
  • Required: Yes
  • Example: nntps://username:password@news.eu.easynews.com/4

The Basics

Usenet is a global distributed discussion system that also serves as a source for binary files and media content. To download content from Usenet, you need access to:

  1. An indexer – This is a service (a multi-indexer like NZBHydra 2 or a standalone indexer like Drunken Slug) that lets you search for NZB files, which describe the content you want to download.
  2. A provider – This is a Usenet service (NNTP server) that actually stores and delivers the files. You connect to it using the server address, and often a username and password.

Where to get NNTP servers

  • Commercial Usenet providers: Most users get NNTP server access by subscribing to a Usenet provider. Popular options include Easynews, Newshosting, UsenetServer, Eweka, and many others. These providers offer paid plans with high retention and speed.
  • Free servers: Some ISPs or universities may offer free NNTP access, but these are rare and often limited.

What you need to use this addon: When you sign up, you’ll receive server addresses, a username, and a password. Enter the server addresses (comma separated if you have multiple servers) in the addon configuration.

More Usenet info

  • Usenet is not the same as torrents or direct downloads. You need a provider and usually a subscription.
  • Retention refers to how long files are kept on the server. Higher retention means more available content.
  • For more details, see guides like Usenet 101 or your provider’s help pages.

Developers

Requirements

  • Node.js (v24 or higher is recommended)
  • PNPM package manager v9

Installation

  1. Clone the repository:
    git clone https://github.com/sleeyax/stremio-nzb-addon.git
    cd stremio-nzb-addon
  2. Install dependencies:
    pnpm install
  3. Run the addon:
    npm run dev
    The addon will start a local server. Add the manifest URL to Stremio to use the addon.

License

MIT

About

Provides usenet streams from your own indexers or NZBHydra2 instance

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Contributors