feat: add overseerr setup instructions. updated homepage to emphasize…

… on symlinks importance

docs/index.md

@@ -164,16 +164,16 @@ Grab the `docker-compose.yml` file from the [installation guide](#installation)
 
 For detailed information on the various services and configurations available in Riven, please refer to the [symlink](services/symlink/index.md) page. This page will help you understand how to configure and manage your media library using symlinks. It will help you understand why we map the Riven volumes to `/mnt` and how you can modify this in the `docker-compose.yml` file for the best outcome.
 
+---
+
+## Installation
+
 !!! danger "Setup Rclone & Symlink Paths First! :fire:"
 
     This is incredibly important and must be setup first! When configuring the rclone mount path and library path, you need to make sure that the paths are correct for your system. More information can be found at the [symlink](services/symlink/index.md) page.
 
     If your debrid files are found in your rclone path, and you can successfully `ls -lh /mnt/zurg` your rclone path, you can skip this step.
 
----
-
-## Installation
-
 `docker-compose.yml` file is used to run Riven in a containerized environment. It consists of three services:
 
 1. `riven`: The main application (backend).
@@ -253,19 +253,31 @@ Now this won't work as is, you need to modify the `docker-compose.yml` file to m
 5. Change `DIALECT` and `DATABASE_URL` to use the same database as the backend. This is not required here as we are running both backend and database in the same network (stack).
 6. Change `volumes` to match your setup. Riven requires access to the library folder and rclone mount path.
 
+---
+
 ## Running Riven
 
-To run Riven, execute the following command:
+Depending on how you installed Riven, execute the following command:
 
-```bash
-docker-compose up -d && docker-compose logs -f
-```
+=== "Docker"
+
+    ```bash
+    docker-compose up -d && docker-compose logs -f
+    ```
+
+=== "Local"
+
+    !!! warning "Python Version"
+        Riven requires Python 3.11 or higher and `poetry` to be installed.
 
-!!! note "Accessing the web interface"
+    ```bash
+    poetry install --without dev
+    poetry run python /src/main.py
+    ```
 
-    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.
+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.
 
-    - Example: `http://localhost:3000`
+- Example: `http://localhost:3000`
 
 --- 
 

docs/services/content/index.md

@@ -28,8 +28,29 @@ Overseerr is a request management and media discovery tool. It helps you manage
     - Example: `"http://localhost:5055"`
 - **api_key** (string): The API key for accessing Overseerr.
     - Example: `"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"`
-- **use_webhook** (boolean): Boolean value to enable or disable the use of webhooks. Default is true.
-    - Example: `true`
+- **use_webhook** (boolean): Boolean value to enable or disable the use of webhooks. Default is false.
+    - Example: `false`
+
+### Setting up Overseerr Webhook
+
+- Go to the settings page on Overseerr
+- Click on `Notifications`
+- Click on `Webhook` on the end
+- Toggle `Enable Agent` so that it's enabled
+- For the Webhook URL:
+  - Enter the FQDN, IP or `localhost` to your Riven instance, and then be sure to add `/webhook/overseerr` at the end of it
+- Leave the rest of the settings default, however you'll want to enable these Notification types:
+  - `Request Automatically Approved`
+  - `Request Approved`
+
+So that only approved requests will get sent from the webhook from Overseerr. Adjust this based on your needs. Any of the following examples might be correct depending on your setup.
+
+- Example 1: `http://localhost:8080/webhook/overseerr`
+- Example 2: `http://riven:8080/webhook/overseerr`
+
+After all that's setup, you should be good to go. If you experience any issues, double check the ip/port you're using to access the backend of Riven is correct. The backend port of Riven is `8080` by default. 
+
+![overseerr](../../images/overseerr.png)
 
 ---