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
@@ -59,10 +62,11 @@ description: All in one media management solution
59
62
</a>
60
63
</div>
61
64
62
-
!!! riven "Riven"
65
+
<Callouttype="info">
63
66
**Riven** is a powerful media management and streaming solution designed to integrate with various media servers and third-party services. It automates the process of finding, downloading, and organizing media content, making it instantly available for streaming through your preferred media server.
@@ -93,8 +97,9 @@ description: All in one media management solution
93
97
94
98

95
99
96
-
!!! warning "**Beta**"
97
-
Riven is under active development, we are constantly working on new features and fixing bugs.
100
+
<Callouttype="warning">
101
+
Riven is under active development, we are constantly working on new features and fixing bugs.
102
+
</Callout>
98
103
99
104
Riven streamlines your media consumption experience by:
100
105
@@ -115,32 +120,34 @@ Before we begin, we need to set up the required folders and files for Riven.
115
120
116
121
Grab the `docker-compose.yml` file from the [installation guide](#installation) and then `docker-compose up -d` to start the services.
117
122
118
-
!!! note
123
+
<Callouttype="info">
119
124
***Linux**: Riven only supports Linux-based operating systems.
120
125
***Windows**: Riven only supports Windows Subsystem for Linux (WSL) in Windows.
121
126
***Rclone**: Required to mount debrid service. Additionally, Zurg is preferred for Real-Debrid users. [Learn more](https://rclone.org/)
122
127
***Media Server**: Plex, Jellyfin, and Emby are supported.
123
128
***Docker**: Required to run Riven in a containerized environment. [Learn more](https://www.docker.com/)
129
+
</Callout>
124
130
125
-
!!! tip"Debrid Support"
126
-
Currently only **Real-Debrid**, **All-Debrid** and **Torbox** are supported. More
131
+
<Callouttype="tip"title="Debrid Support">
132
+
Currently only **Real-Debrid** and **Torbox** are supported. More
127
133
services will be added in the future!
134
+
</Callout>
128
135
129
136
---
130
137
131
138
### Setup Directories
132
139
133
-
For detailed information on the filesystem and VFS configuration, please refer to the [Filesystem (VFS)](services/filesystem/index.md) page. This page will help you understand how to configure and manage your media library using Riven's virtual filesystem. It will help you understand the mount path configuration and how to properly set up volume mounts in the `docker-compose.yml` file.
140
+
For detailed information on the filesystem and VFS configuration, please refer to the [Filesystem (VFS)](docs/services/filesystem/) page. This page will help you understand how to configure and manage your media library using Riven's virtual filesystem. It will help you understand the mount path configuration and how to properly set up volume mounts in the `docker-compose.yml` file.
134
141
135
142
---
136
143
137
144
## Installation
138
145
139
-
!!! danger "Setup VFS Mount Path First! :fire:"
140
-
141
-
This is incredibly important and must be setup first! When configuring the mount path and library path, you need to make sure that the mount propagation is set up correctly for your system. More information can be found at the [Filesystem (VFS)](services/filesystem/index.md) page.
146
+
<Callouttype="error"title="Setup VFS Mount Path First! 🔥">
147
+
This is incredibly important and must be setup first! When configuring the mount path and library path, you need to make sure that the mount propagation is set up correctly for your system. More information can be found at the [Filesystem (VFS)](docs/services/filesystem) page.
142
148
143
149
The VFS mount path should be set to the container path (e.g., `/mount`), and proper mount propagation must be configured on the host.
150
+
</Callout>
144
151
145
152
`docker-compose.yml` file is used to run Riven in a containerized environment. It consists of three services:
146
153
@@ -237,21 +244,23 @@ Now this won't work as is, you need to modify the `docker-compose.yml` file to m
237
244
238
245
Depending on how you installed Riven, execute the following command:
239
246
240
-
=== "Docker"
241
-
247
+
<Tabs items={['Docker', 'Local']}>
248
+
<Tab value="Docker">
242
249
```bash
243
250
docker-compose up -d && docker-compose logs -f
244
251
```
245
-
246
-
=== "Local"
247
-
248
-
!!! warning "Python Version"
252
+
</Tab>
253
+
<Tab value="Local">
254
+
<Callout type="warning" title="Python Version">
249
255
Riven requires Python 3.11 or higher and `poetry` to be installed.
256
+
</Callout>
250
257
251
258
```bash
252
259
poetry install --without dev
253
260
poetry run python /src/main.py
254
261
```
262
+
</Tab>
263
+
</Tabs>
255
264
256
265
You can access the Riven web interface by navigating to the specified `ORIGIN` URL you entered in the `docker-compose.yml` file or your reverse proxy URL.
257
266
@@ -309,17 +318,17 @@ At this point you can take a look at the [services](services/index.md) page to l
309
318
310
319
## Frequently Asked Questions
311
320
312
-
!!! warning "Cross-site POST form submissions are forbidden"
313
-
The most common reason for this is that you may not have set up `ORIGIN`
314
-
correctly in the `docker-compose.yml` file. If you are running Riven
315
-
behind a reverse proxy, you can remove the `ORIGIN` environment variable
316
-
from the `riven-frontend` service.
321
+
<Callout type="warn" title="I am seeing CORS errors in the browser console">
322
+
Make sure that the `ORIGIN` environment variable in the `riven-frontend` service is set to the correct URL you are accessing the web interface from. If you are running Riven behind a reverse proxy, you can remove the `ORIGIN` environment variable from the `riven-frontend` service.
323
+
</Callout>
317
324
318
-
!!! warning "I am seeing an error when trying to save changes"
325
+
<Callout type="warn" title="I am seeing an error when trying to save changes">
319
326
If you are seeing an error when trying to save changes, it is most likely due to incorrect configuration or backend failure. Please check the logs of the Riven service to see the error message. If you are unable to resolve the issue, feel free to ask for help in the Riven Discord server.
327
+
</Callout>
320
328
321
-
!!! warning "I am stuck in an onboarding loop"
329
+
<Callout type="warn" title="I am stuck in an onboarding loop">
322
330
If you are stuck in the onboarding loop, it is most likely due to incorrect symlink settings. Check your library path and rclone mount path. If they are correct, check the logs of the Riven service. If you are unable to resolve the issue, feel free to ask for help in the Riven Discord server.
0 commit comments