Skip to content

Commit 14f8dbf

Browse files
committed
docs: update
1 parent 621ef09 commit 14f8dbf

2 files changed

Lines changed: 54 additions & 22 deletions

File tree

packages/docs/content/docs/guides/usenet.mdx

Lines changed: 49 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -121,19 +121,29 @@ These apps mount NZBs as a virtual filesystem and expose a WebDAV server (or equ
121121
changes. StremThru is also actively developed.
122122
</Callout>
123123

124+
<Callout type="info">
125+
The nzbDAV and AltMount integrations were inspired by the
126+
[UsenetStreamer](https://github.com/Sanket9225/UsenetStreamer) addon, which
127+
was the first to serve nzbDAV streams through a Stremio addon.
128+
</Callout>
129+
124130
### Initial Application Setup
125131

126132
#### StremThru
127133

128134
<Steps>
129135
<Step>
130-
Install and run StremThru following the [official
131-
documentation](https://github.com/stremthru/stremthru).
136+
Install and run StremThru following the
137+
[official documentation](https://docs.stremthru.13377001.xyz/getting-started/installation).
138+
Set
139+
[`STREMTHRU_AUTH`](https://docs.stremthru.13377001.xyz/configuration/#stremthru-auth)
140+
and
141+
[`STREMTHRU_VAULT_SECRET`](https://docs.stremthru.13377001.xyz/configuration/#stremthru-vault-secret)
142+
in your environment.
132143
</Step>
133-
<Step>Configure your Usenet provider inside StremThru's settings.</Step>
134144
<Step>
135-
Note your **StremThru URL** and **API password** — you'll need these for
136-
AIOStreams.
145+
Configure your Usenet providers in the StremThru dashboard (`/dash`) under
146+
**Usenet → Servers**.
137147
</Step>
138148
</Steps>
139149

@@ -176,10 +186,10 @@ These apps mount NZBs as a virtual filesystem and expose a WebDAV server (or equ
176186
In AIOStreams, go to **Services** and select nzbDAV, AltMount, or StremThru.
177187
</Step>
178188
<Step>
179-
Enter the required details:
180-
- **nzbDAV / AltMount:** API Key, WebDAV User,
181-
WebDAV Password
182-
- **StremThru:** StremThru URL, Store Password
189+
Enter the required details.
190+
- **nzbDAV / AltMount:** API Key, WebDAV User, WebDAV Password.
191+
- **StremThru:** StremThru URL and Auth Token — a `user:password` string (optionally base64-encoded) from your `STREMTHRU_AUTH`
192+
value.
183193
</Step>
184194
<Step>Configure the **URL** and **Public URL** fields (see below).</Step>
185195
</Steps>
@@ -193,18 +203,32 @@ This is the most critical configuration step.
193203
| **URL** | Address AIOStreams uses to talk to the API |
194204
| **Public URL** | Publicly accessible address used to construct streaming URLs for your player |
195205

206+
<Callout type="info">
207+
The **Public URL** field does not apply to StremThru. Use the
208+
[`STREMTHRU_BASE_URL`](https://docs.stremthru.13377001.xyz/configuration/#stremthru-base-url)
209+
environment variable instead, and set **URL** to your local StremThru address
210+
(e.g. `http://stremthru:8080`).
211+
</Callout>
212+
196213
<Tabs items={['Same local network', 'AIOStreams remote']}>
197214
<Tab value="Same local network">
198-
- **URL:** Internal Docker/local address (e.g. `http://nzbdav:3000`) -
199-
**Public URL (Option A — Proxy, recommended):** Leave blank and provide your
200-
`AIOStreams Auth Token`. AIOStreams proxies the stream — most reliable
201-
method. - **Public URL (Option B — Direct):** Enter the publicly accessible
202-
URL (e.g. `https://nzbdav.yourdomain.com`). Without it, your player receives
203-
an inaccessible local URL.
215+
**URL:** Internal Docker/local address (e.g. `http://nzbdav:3000`)
216+
217+
**Public URL — Option A (Proxy, recommended):** Leave blank and provide your
218+
`AIOStreams Auth Token` in the service settings. AIOStreams proxies the stream
219+
— most reliable method.
220+
221+
**Public URL — Option B (Direct):** Enter the publicly accessible URL (e.g.
222+
`https://nzbdav.yourdomain.com`). Without it your player receives an
223+
inaccessible local address.
224+
204225
</Tab>
205226
<Tab value="AIOStreams remote">
206-
- **URL:** Public URL of your instance (e.g.
207-
`https://altmount.yourdomain.com`) - **Public URL:** Leave blank
227+
**URL:** Public URL of your instance (e.g.
228+
`https://altmount.yourdomain.com`)
229+
230+
**Public URL:** Leave blank.
231+
208232
</Tab>
209233
</Tabs>
210234

@@ -231,5 +255,12 @@ Some indexers flag mismatched IPs between the search request and the NZB grab as
231255

232256
**Indexer managers:**
233257

234-
- **NZBHydra2:** Proxies grabs by default (preferred behaviour).
258+
- **NZBHydra2:** Proxies grabs by default (preferred behaviour), unless the redirect option is enabled.
235259
- **Prowlarr:** Only redirects NZB grabs — this will cause an IP mismatch.
260+
261+
### Indexer Policies
262+
263+
Indexer rules vary — always check with your indexer directly. Some known policies:
264+
265+
- **NinjaCentral:** Compatible with public AIOStreams instances, as long as you are not sharing your account.
266+
- **SceneNZBs:** Explicitly disallows use with Stremio. This is likely detected via the IP mismatch — self-hosting AIOStreams with the proxy feature or NZBHydra2 may resolve it.

packages/docs/content/docs/reference/stream-expressions.mdx

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -516,10 +516,11 @@ regexScore(streams, 50)
516516

517517
#### `passthrough()`
518518

519-
Flags streams to bypass specific pipeline stages. Best used in **Included** or **Excluded Stream Expressions**.
519+
Flags streams to bypass specific pipeline stages. Best used in **Included Stream Expressions** or rarely in **Excluded Stream Expressions**.
520520

521-
- In an **Included Stream Expression**: extends bypass to additional stages beyond the normal filter bypass.
522-
- In an **Excluded Stream Expression**: flagged streams won't be removed by _subsequent_ excluded expressions.
521+
While any stream selected by an Included Stream Expression (ISE) is already protected from normal filters, it still passes through stages like deduplication and result limiting. Wrapping your ISE with `passthrough()` expands which stages those streams skip.
522+
523+
When used in an **Excluded Stream Expression**: flagged streams won't be removed by _subsequent_ excluded expressions. Since ESE filters run last, most stage values are not applicable here — only `excluded` is relevant.
523524

524525
| Parameter | Type | Description |
525526
| ----------- | ---------------- | ------------------------------------------ |
@@ -537,7 +538,7 @@ passthrough(streams) // bypass all stages
537538

538539
#### `pin()`
539540

540-
Pins streams to the very top or bottom of the final results list, overriding sort order. Typically used in **Precompute Expressions**.
541+
Pins streams to the very top or bottom of the final results list, overriding sort order. Typically used in **Excluded Stream Expressions**. Can also be used in **Required Stream Expressions** — but since unselected streams get filtered out, set `returnMatched: true` when doing so.
541542

542543
| Parameter | Type | Default | Description |
543544
| --------------- | ------------------- | ------- | ---------------------------------------------------------------------------------- |

0 commit comments

Comments
 (0)