Skip to content

Commit 52fc7fb

Browse files
committed
fix: update homepage
1 parent bbc51f9 commit 52fc7fb

File tree

1 file changed

+26
-87
lines changed

1 file changed

+26
-87
lines changed

docs/index.md

Lines changed: 26 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: Riven
33
description: Handle your media library with ease
44
---
55

6-
import { File, Folder, Files } from "fumadocs-ui/components/files";
7-
86
<div align="center">
97
<a href="https://github.com/rivenmedia/riven">
108
<picture>
@@ -67,9 +65,8 @@ import { File, Folder, Files } from "fumadocs-ui/components/files";
6765

6866
## Overview
6967

70-
<Callout type="warn">
68+
!!! warning "Under Development"
7169
Riven is under active development, expect breaking changes and bugs.
72-
</Callout>
7370

7471
Riven is an advanced 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.
7572

@@ -87,33 +84,15 @@ Whether you're a casual viewer or a media enthusiast, Riven offers a powerful, a
8784

8885
Before installing Riven, ensure you have the following prerequisites:
8986

90-
<Cards>
91-
<Card
92-
href="/404"
93-
title="Linux"
94-
description="Riven only supports Linux-based operating systems and Windows Subsystem for Linux (WSL) in Windows"
95-
/>
96-
<Card
97-
href="/docs/rclone"
98-
title="Rclone"
99-
description="Required to mount debrid service. Additionally Zurg is preferred for Real-Debrid users"
100-
/>
101-
<Card
102-
href="/404"
103-
title="Media Server"
104-
description="Currently only Plex Media Server is supported"
105-
/>
106-
<Card
107-
href="/docs/docker"
108-
title="Docker"
109-
description="Required to run Riven in a containerized environment"
110-
/>
111-
</Cards>
112-
113-
<Callout type="info">
114-
Currently only Real-Debrid, All-Debrid and Torbox are supported. More
115-
services will be added in the future.
116-
</Callout>
87+
!!! note
88+
* **Linux**: Riven only supports Linux-based operating systems and Windows Subsystem for Linux (WSL) in Windows.
89+
* **Rclone**: Required to mount debrid service. Additionally, Zurg is preferred for Real-Debrid users. [Learn more](/docs/rclone)
90+
* **Media Server**: Currently only Plex Media Server is supported.
91+
* **Docker**: Required to run Riven in a containerized environment. [Learn more](/docs/docker)
92+
93+
!!! warning "Debrid Support"
94+
Currently only **Real-Debrid**, **All-Debrid** and **Torbox** are supported. More
95+
services will be added in the future!
11796

11897
## Setup
11998

@@ -256,84 +235,44 @@ There are 4 steps in the onboarding process:
256235

257236
In this step you configure the downloaders (debrid services), rclone mount path, library path, subtitles, etc. See the image below for an example.
258237

259-
<ImageSection
260-
width={700}
261-
height={600}
262-
className="mx-auto"
263-
alt="step-1"
264-
src="/img/riven/step1.png"
265-
/>
238+
![step-1](/images/onboard/step1.png)
266239

267240
### Media Server
268241

269242
In this step you configure the media server and updater settings. See the image below for an example.
270243

271-
<ImageSection
272-
width={700}
273-
height={600}
274-
className="mx-auto"
275-
alt="step-2"
276-
src="/img/riven/step2.png"
277-
/>
244+
![step-2](/images/onboard/step2.png)
278245

279246
### Content Services
280247

281248
In this step you configure the content services like trakt, overseerr, etc. See the image below for an example.
282249

283-
<ImageSection
284-
width={700}
285-
height={600}
286-
className="mx-auto"
287-
alt="step-3"
288-
src="/img/riven/step3.png"
289-
/>
250+
![step-3](/images/onboard/step3.png)
290251

291252
### Scraper Services
292253

293254
In this step you configure the scraper services like torrentio, zilean, prowlarr, jackett, etc. See the image below for an example.
294255

295-
<ImageSection
296-
width={700}
297-
height={600}
298-
className="mx-auto"
299-
alt="step-4"
300-
src="/img/riven/step4.png"
301-
/>
256+
![step-4](/images/onboard/step4.png)
302257

303258
---
304259

305260
Once you have completed the onboarding process, you will be greeted with a beautiful dashboard where you can manage your media library, request items, settings and many more in the future.
306261

307-
<ImageSection
308-
width={700}
309-
height={600}
310-
className="mx-auto"
311-
alt="dashboard"
312-
src="/img/riven/homepage.png"
313-
/>
262+
![step-5](/images/onboard/final.png)
314263

315264
---
316265

317266
## Frequently Asked Questions
318267

319-
<Accordions>
320-
<Accordion title="Cross-site POST form submissions are forbidden" id="cross-site-post-form-submission-are-forbidden">
321-
The most common reason for this is that you may have not setup `ORIGIN`
322-
correctly in the `docker-compose.yml` file. If you are running Riven
323-
behind a reverse proxy, you can remove the `ORIGIN` environment variable
324-
from the `riven-frontend` service.
325-
</Accordion>
326-
327-
<Accordion title="I am seeing error when trying to save changes" id="save-error">
328-
If you are seeing an error when trying to save changes, it is most likely
329-
due to incorrect configuration or backend failure. Please check the logs of the `riven` service
330-
to see the error message. If you are unable to resolve the issue, feel free
331-
to ask for help in the [Riven Discord server](https://discord.gg/wDgVdH8vNM).
332-
</Accordion>
333-
334-
<Accordion title="I am stuck in onboarding loop" id="onboarding-loop">
335-
If you are stuck in the onboarding loop, it is most likely due to `symlink` settings being wrong.
336-
Check your `library` path and `rclone` mount path. If they are correct, check the logs of the `riven` service.
337-
If you are unable to resolve the issue, feel free to ask for help in the [Riven Discord server](https://discord.gg/wDgVdH8vNM).
338-
</Accordion>
339-
</Accordions>
268+
!!! tip "Cross-site POST form submissions are forbidden"
269+
The most common reason for this is that you may have not setup `ORIGIN`
270+
correctly in the `docker-compose.yml` file. If you are running Riven
271+
behind a reverse proxy, you can remove the `ORIGIN` environment variable
272+
from the `riven-frontend` service.
273+
274+
!!! tip "I am seeing error when trying to save changes"
275+
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.
276+
277+
!!! tip "I am stuck in onboarding loop"
278+
If you are stuck in the onboarding loop, it is most likely due to symlink settings being wrong. 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

Comments
 (0)