diff --git a/README.md b/README.md index 0dde47e..6d5e948 100644 --- a/README.md +++ b/README.md @@ -21,13 +21,12 @@ ### Caveats I wanted a clean app for the sole purpose of requesting movies/TV shows. -I personally didn't need Siri, Overseerr, or Ombi integration - so those are missing in this bot (for now). +I personally didn't need Siri or Ombi integration - so those are missing in this +bot. If you need Ombi support, I suggest you check out Overseerr instead. There is only a boolean permission (role gated) for who has access to the bot, nothing fancy. If any of these don't suit your fancy, check out [Requestrr](https://github.com/darkalfx/requestrr) -Please consider this software "beta enough" as some of the error handling is pretty rough around the edges - however I've been using this for a bit now on my own server without any issues, but of course your mileage may vary. - ### Screenshots @@ -56,6 +55,9 @@ To do this: 1. Enable Developer Mode (User Settings -> Advanced -> Developer Mode) 2. Under your server settings, go to Roles, find the role and "Copy ID" +Every user that you wish to have access to the slash commands needs to be +assigned this role (even the server owner/admins). + ### Sonarr/Radarr 1. Copy out your API keys from Settings -> General @@ -66,6 +68,13 @@ Sonarr/Radarr and Overseerr are mutually exclusive - you only need to configure one. If you are using Overseerr, your users must have associated discord IDs, or the request will fail. +This bot isn't meant to wrap the entirety of what Overseerr can do, just the +necessary bits for requesting with optional 4K and quota support. Just use the +web interface to Overseerr if you need more features. + +In the config, you replace `SONARR_URL`, `SONARR_API`, `RADARR_URL`, +`RADARR_API` with `OVERSEERR_URL` and `OVERSEERR_API`. + ## Running with Docker Simply run with @@ -79,7 +88,6 @@ docker run \ -e BOT_TOKEN='bot_token' \ -e ROLE_ID='role_id' \ --name doplarr ghcr.io/kiranshila/doplarr:latest - ``` ## Building and Running Locally