You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Welcome to Riven! This guide will help you get up and running quickly with your all-in-one media management solution.
12
12
13
-
<Callouttype="info">
14
-
**What is Riven?**
15
-
16
-
Riven is a powerful media management and streaming solution that automates the entire process of discovering, downloading, and organizing media content. It integrates with debrid services and media servers to provide instant streaming access to your media library.
17
-
</Callout>
18
-
19
13
<Callouttype="tip">
20
14
**Quick Configuration**
21
15
@@ -24,19 +18,6 @@ Want to skip manual editing? Use our [**Docker Compose Generator**](/generator)
24
18
25
19
---
26
20
27
-
## What Riven Does
28
-
29
-
Riven streamlines your media experience by:
30
-
31
-
1.**Discovering Content** - Automatically finds new content from your watchlists and requests
32
-
2.**Smart Searching** - Searches for high-quality torrents using multiple scrapers
33
-
3.**Debrid Integration** - Downloads media instantly via debrid services (Real-Debrid, TorBox)
34
-
4.**Virtual Filesystem** - Organizes media using RivenVFS for on-demand streaming
35
-
5.**Media Server Integration** - Seamlessly integrates with Plex, Jellyfin, or Emby
36
-
6.**Easy Management** - Provides a beautiful web interface for configuration and monitoring
37
-
38
-
---
39
-
40
21
## Prerequisites
41
22
42
23
Before you begin, ensure you have:
@@ -218,217 +199,13 @@ Or use the custom URL you configured in the `ORIGIN` variable.
218
199
219
200
---
220
201
221
-
## Configuration & Onboarding
222
-
223
-
When you first access Riven, you'll be guided through a 4-step onboarding process:
224
-
225
-
### Step 1: General Settings
226
-
227
-
Configure your core settings:
228
-
229
-
- **Downloader**: Select your debrid service (Real-Debrid or TorBox) and enter your API key
230
-
- **Mount Path**: Set to `/mount` (the container path, NOT the host path)
231
-
- **Library Path**: Usually same as mount path (`/mount`)
232
-
- **Subtitles**: Enable subtitle downloading if desired
233
-
234
-

235
-
236
-
<Callout type="info">
237
-
The mount path should always be the **container** path (`/mount`), not your host path (`/mnt/riven`). The docker-compose.yml handles the mapping between host and container.
238
-
</Callout>
239
-
240
-
---
241
-
242
-
### Step 2: Media Server
243
-
244
-
Configure your media server integration:
245
-
246
-
- **Server Type**: Select Plex, Jellyfin, or Emby
247
-
- **URL**: Enter your media server URL (e.g., `http://plex:32400`)
248
-
- **API Token/Key**: Provide authentication credentials
249
-
- **Update Interval**: How often to notify the media server of changes (default: 120 seconds)
250
-
251
-

252
-
253
-
<Callout type="tip">
254
-
For detailed media server configuration, including how to obtain API tokens, see:
- **[Post-Processing](/docs/services/post-processing)**: Media analysis and enhancement
326
-
- **[Notifications](/docs/services/notifications)**: Get notified of new content
327
-
328
-
### Integrate with Your Media Server
329
-
330
-
Make sure your media server can access the Riven mount:
331
-
332
-
<Tabs items={['Plex', 'Jellyfin', 'Emby']}>
333
-
<Tab value="Plex">
334
-
If running Plex in Docker, add this volume to your Plex container:
335
-
336
-
```yaml
337
-
volumes:
338
-
- /mnt/riven:/mount:rslave,z
339
-
```
340
-
341
-
Then add `/mount` as a library in Plex.
342
-
343
-
**Note**: Use `:rslave` for Plex (not `:rshared`).
344
-
</Tab>
345
-
346
-
<Tab value="Jellyfin">
347
-
If running Jellyfin in Docker, add this volume:
348
-
349
-
```yaml
350
-
volumes:
351
-
- /mnt/riven:/mount:rslave,z
352
-
```
353
-
354
-
Then add `/mount` as a library in Jellyfin.
355
-
</Tab>
356
-
357
-
<Tab value="Emby">
358
-
If running Emby in Docker, add this volume:
359
-
360
-
```yaml
361
-
volumes:
362
-
- /mnt/riven:/mount:rslave,z
363
-
```
364
-
365
-
Then add `/mount` as a library in Emby.
366
-
</Tab>
367
-
</Tabs>
368
-
369
-
---
370
-
371
-
## Common Issues
372
-
373
-
### CORS Errors in Browser
374
-
375
-
**Problem**: Seeing CORS errors in browser console
376
-
377
-
**Solution**: Ensure `ORIGIN` environment variable matches the URL you're accessing. If behind a reverse proxy, remove the `ORIGIN` variable entirely.
378
-
379
-
---
380
-
381
-
### Stuck in Onboarding Loop
382
-
383
-
**Problem**: Can't complete onboarding, keeps returning to setup
384
-
385
-
**Solution**: Check your library path and mount path settings. Verify mount propagation is set correctly (`findmnt -T /mnt/riven`). Check Riven logs for specific errors.
386
-
387
-
---
388
-
389
-
### No Media Appearing
390
-
391
-
**Problem**: Requested media but nothing shows up in media server
392
-
393
-
**Solution**:
394
-
1. Check Riven dashboard to see item status
395
-
2. Verify VFS mount is working: `ls /mnt/riven`
396
-
3. Check media server library path matches mount path
397
-
4. Review Riven logs for errors
398
-
399
-
---
400
-
401
-
### Container Won't Start
402
-
403
-
**Problem**: Riven container exits immediately
404
-
405
-
**Solution**:
406
-
1. Check logs: `docker logs riven`
407
-
2. Verify `/dev/fuse` exists: `ls -l /dev/fuse`
408
-
3. Load fuse module if missing: `sudo modprobe fuse`
409
-
4. Check mount propagation is configured
410
-
411
-
For more troubleshooting help, see the [Troubleshooting Guide](/docs/troubleshooting).
412
-
413
-
---
414
-
415
-
## Additional Resources
416
-
417
-
- **[Architecture](/docs/architecture)**: Understand how Riven works under the hood
418
-
- **[Deployment Guide](/docs/deployment)**: Production deployment with reverse proxies
419
-
- **[Services Overview](/docs/services)**: Detailed documentation for all services
420
-
- **[Contributing](/docs/contribute)**: Help improve Riven
421
-
- **[Discord Community](https://discord.gg/rivenmedia)**: Get help and connect with other users
422
-
423
-
---
424
-
425
202
<Callout type="info">
426
203
**Need Help?**
427
204
428
205
If you encounter issues not covered in this guide:
429
206
1. Check the [Troubleshooting Guide](/docs/troubleshooting)
430
207
2. Review the logs: `docker-compose logs -f riven`
431
-
3. Join the [Discord community](https://discord.gg/rivenmedia) for support
208
+
3. Join the [Discord community](https://discord.riven.tv) for support
432
209
4. Search or create an issue on [GitHub](https://github.com/rivenmedia/riven)
0 commit comments