-
-
Notifications
You must be signed in to change notification settings - Fork 825
Usenet
This guide serves as a reference for using Usenet with AIOStreams with your own indexers. It assumes you have a basic understanding of both AIOStreams and Usenet concepts.
AIOStreams integrates with Usenet through several built-in addons, which require a "service" to fetch and download content. This guide will walk you through the two primary methods for setting this up.
AIOStreams offers the following addons to source content from Usenet:
- Newznab: Connect your Usenet indexers directly using their API URL and Key.
- NZBHydra2: Connect your NZBHydra2 instance to have AIOStreams query it for results.
- Prowlarr: Connect your Prowlarr instance to query both torrent and Usenet indexers (configurable in the Prowlarr addon settings).
- TorBox Search: Utilizes the TorBox Search API, which searches both torrents and Usenet content using TorBox's internal indexers.
To use these addons, you must configure one of the following services in AIOStreams.
Tip
With the Newznab addon, it is recommended to enable the Force query search option. You can install two instances of the addon per indexer (one with QS on, one with it off), if you have API hits to spare. This is because you can get vastly different results and possibly even only get results via QS with some indexers.
There is also the Easynews addons, these are not "built-in" addons, and as they are not specific to AIO, it won't be discussed in detail here - but they are an option. It uses Easynews' API to both search for content, and stream them to you. You would simply install one of these addons - either in Stremio or via AIOStreams by adding Easynews as a service and installing them via the marketplace.
The easiest way to get started with Usenet on AIOStreams is by using a TorBox Pro plan. This approach is highly recommended for users who want a straightforward, "it-just-works" experience.
How it Works: TorBox Pro ($10/mo) gives you access to their Usenet download capabilities. TorBox manages its own private indexers and Usenet providers, so you don't need to subscribe to or configure your own.
You can access these internal indexers results via either the official TorBox addon or TorBox Search. You don't even need to use AIOStreams' built-in addons to connect your own indexers.
With TorBox, Usenet files function similarly to torrents on debrid services: they are first downloaded to TorBox's servers and then streamed to you. The key advantage is that Usenet downloads are generally much faster and more reliable than torrents.
Setup:
- Obtain a TorBox Pro account.
- In AIOStreams, navigate to the
Servicesmenu. - Add your TorBox API Key.
- The Usenet addons will now be functional.
Warning
With TorBox, when using your own indexers (and not their internal indexers either via the TorBox or built-in TorBox Search addon), all results will appear as uncached unless you've cached them yourself. If someone else had added the same NZB, that file may start instantly but it would still appear as uncached. Results from their internal indexers, however, will show up as cached if somebody else has added that NZB before and can be streamed instantly.
To enhance the experience with uncached Usenet files, AIOStreams offers a feature called Cache & Play.
- Without Cache & Play: Playing an uncached file returns a short video telling you to try again later while the file downloads in the background.
- With Cache & Play: The video player will buffer until the Usenet download on TorBox is complete, and then it will start playing automatically. This is especially effective for smaller files that download quickly.
Warning
The effectiveness of Cache & Play depends on your video player's timeout settings. For example, the Stremio player on iOS has a short timeout (around 30 seconds). If the download takes longer than this, the player will error out, and you'll need to manually restart the stream.
This method offers more control and allows you to stream Usenet directly - rather than waiting for it to be downloaded—but it requires self-hosting additional software and managing your own Usenet provider and indexer subscriptions.
Note
Acknowledgements: The native integration of nzbDAV and AltMount was inspired by the work of the UsenetStreamer addon, which was first to serve nzbDAV streams through a Stremio addon. Full credit goes to its developer for the original concept. If you prefer it, you can skip adding the service to AIOStreams, and simply add UsenetStreamer to AIOStreams using the addon in the Marketplace.
To get started, you will need to set up one of the following applications:
These applications act as a bridge, mounting NZB files as a virtual file system and allowing you to stream content directly from your Usenet provider via a WebDAV server. Our integration merely acts as a wrapper around these apps.
Warning
Both nzbDAV and AltMount are considered alpha software and are in early stages of development. You may encounter bugs, instability, or breaking changes.
You must set up and run one of these applications, typically via Docker. Please refer to their respective GitHub repositories for the most up-to-date installation instructions.
Note
For use with AIOStreams, you do not need to configure rclone.
Once your chosen application is running, follow the configuration steps below.
- Create Admin User: Register your admin user upon first launch.
-
Usenet Provider: Go to
Settings->Usenetand enter your Usenet provider's details. nzbDAV currently supports one provider. -
SABnzbd API Key: Navigate to the
SABnzbdtab. You don't need to change anything here, but note the API key for use in AIOStreams later. -
WebDAV Credentials: In the
WebDAVtab, set a WebDAV username and password. These are the credentials you will provide to AIOStreams, not your admin login.
- Create Admin User: Complete the onboarding process to create your admin user.
-
WebDAV Credentials: Go to
Configuration->WebDAVand set your desired username and password. These are the credentials you will provide to AIOStreams. -
NNTP Providers: In the
NNTP Providerstab, add the details for your Usenet provider(s). AltMount supports multiple providers. -
Enable SABnzbd API: Navigate to the
SABnzbd APItab and ensureEnable SABnzbd APIis turned ON.-
Important: Do not change the
Completedirectory. It must be set to/complete.
-
Important: Do not change the
-
System API Key: Go to the
Systemtab and find your API key. You will need this for the AIOStreams setup.
Warning
While you can run both services, it's not recommended. If you do, be mindful of your Usenet provider's connection limits. For example, if your provider allows 60 connections, ensure the combined usage of nzbDAV and AltMount does not exceed this limit.
After setting up nzbDAV or AltMount, you can add it as a service in AIOStreams.
- In AIOStreams, go to the
Servicesmenu and select either nzbDAV or AltMount. - Enter the required details: API Key, WebDAV User, and WebDAV Password.
- Configure the URL and Public URL fields based on your setup.
This is the most critical part of the setup. These fields determine how AIOStreams communicates with your nzbDAV/AltMount instance and how stream links are generated.
-
URL(Required): The address AIOStreams uses to talk to the nzbDAV/AltMount API. -
Public URL(Optional): The publicly accessible address used to construct the final streaming URL that your video player will use (after being redirected to it from AIOStreams)
Here are the common scenarios:
Scenario 1: AIOStreams and nzbDAV/AltMount are on the Same Local Network (Recommended for Self-Hosters)
-
URL: Use the internal Docker/local network address (e.g.,http://nzbdav:3000orhttp://altmount:8080). This ensures fast, local communication. -
Public URL:-
Option A (Proxy - Recommended): Leave this field blank and provide the AIOStreams Auth Token below to use the built-in proxy. AIOStreams will generate a proxy link that you can access, and then serve the stream to your player. This is the most reliable method and can avoid playback issues. Simply provide the
AIOStreams Auth Tokenat the bottom of the service configuration. -
Option B (Public Address): If you don't use the proxy, you must enter the publicly accessible URL for your nzbDAV/AltMount instance (e.g.,
https://nzbdav.yourdomain.com). If you don't, your player will receive an inaccessible local URL (likehttp://nzbdav:3000) and fail to play.
-
Option A (Proxy - Recommended): Leave this field blank and provide the AIOStreams Auth Token below to use the built-in proxy. AIOStreams will generate a proxy link that you can access, and then serve the stream to your player. This is the most reliable method and can avoid playback issues. Simply provide the
Scenario 2: AIOStreams is Hosted Remotely (Not Self-Hosted)
-
URL: Enter the public URL of your nzbDAV/AltMount instance (e.g.,https://altmount.yourdomain.com). -
Public URL: Leave this blank.
Warning
When not using the built-in proxy, playback on external players and devices/apps without a Stremio server (e.g. Stremio Web) will likely not work. If you are encountering issues, try providing the Auth Token (this is not possible if you don't self-host AIOStreams, but it is recommended you self-host both as it will make debugging easier.
Important
Mismatched protocols (HTTP vs. HTTPS) can cause playback to fail on certain devices. For instance, if you access AIOStreams via https but your nzbDAV/AltMount instance is on http, the redirect might be blocked by your player. Using the built-in proxy is the best way to avoid these issues.
Important
The Wiki has moved to docs.aiostreams.viren070.me