Configuring Ombi - thomst08/requestrr GitHub Wiki

Configuring Ombi

Ombi can be used as a download client for both Movies and TV Shows.



Connecting Requestrr to Ombi

#1 Check your Ombi Version

Check your version of Ombi, currently version 4 is recommended, however, Requestrr supports version 3 and 4. To find your Ombi version go in to Ombi, then click on "Settings" on the menu. (Note: If you do not see your version, you may need to click on "System" and "About")


#2 Copy your Ombi API Key

Open Ombi in your browser, once you have logged in, go into "Settings", click on "Configuration" and then "General".
Copy the API key in the "API Key" text-box.


#3 Paste API Key into Requestrr

Open Requstrr, go into the section you would like to connect Ombi to ("Movie" or "TV Show"), select "Ombi" in the "Download Client", paste the API key in the "API Key" field.


#4 Enter your Ombi Servers IP

Enter the host or IP address for Ombi Server (without the http://).
Note: If you are using Requestrr in a docker container, any localhost addresses will not work, you should use your servers local IP address in this situation (e.g. 192.168.0.10)


#5 Enter Ombi base URL

If you use a base URL for Ombi, you will need to specify this in Requestrr. To find this setting in Ombi, go into Settings->Configuration->General.

Go back into your Requestrr window and make sure that the base url is exactly the same in Requestrr as it is in Ombi. This setting can be blank if this is not used.


#6 Test your Settings

Now click on the Test Settings button, it should say that everything is good.

images/ombi/step6.png

If not, then the error message will tell you what to do.


#7 Save your Settings

Click on the "Save Changes" button at the bottom of the page to save the work we've done so far.

images/ombi/step7.png

That's it, the bot should now be correctly connected to Ombi!



Configuring Permissions

Default API User

Requestrr supports per user permission and roles coming from Ombi, this means that you can link all of your discord users to Ombi users in order to manage your quotas/roles/etc in Ombi, and the bot will respect those settings.

Whenever a request is made through the bot and the bot is unable to find a "linked" user, it will then use permissions from the Default Api User configured in Requestrr's web portal.

If you don't manually specify a default api user, then the bot will auto-approve all requests.


How to link a discord user to an Ombi user

#1 Enable Developer Mode in Discord

Go into Discord and enable developer mode, to do this, go into "User Settings", "Advanced" under the "App Settings" section, from here, you can enable "Developer Mode":


#2 Copy Discord User ID

Find the Discord user that you wish to link to Ombi, right click their name in Discord and click "Copy User ID":


#3 Paste User ID into Ombi

Now go in Ombi, create or go into "Edit" for the user you want to connect, paste the User ID that you got from Discord in the "Discord" field under "Notification Preferences":


#4 Save the user

Click the "Update" or "Create" (for a new user) button down the bottom.
That's it, now whenever that discord user makes a request through the bot, the permissions/quotas you set for the Ombi user will be applied.


Enabling Issues submissions

Before enabling issues, make sure to enable issues in Ombi and create categories for issues to be submitted to.

This can be done by going into Setting -> Configuration -> Issues.
Make sure Issues is "Enabled" and add your custom categories in the "Add Category" section.

Requestrr allows for the submission of "Issues" to Ombi, this enables users to report issues with linked media.
To do this simple enable "Use Issues" in the "Movies" or "TV Shows" section/s.

Users will be able to submit issues using the /issue command. Users will need to enter the category they wish to submit to with the media's name, e.g. /issue movie deadpool or /issue tv south park.
Upon submitting, the user will need to select from already managed media for any matching names to make sure the correct media is selected, then chose the type of issue, the user can make a submission and fill in a report of the issue.

Issues will be reported in Ombi and can be viewed there.
Note: Due to an issue, some movies or TV shows may not link correctly in Ombi, this is due to movies or shows not being linked correctly in Ombi, this appears to only effect TV shows, and does not stop the issue showing in "Issues" section, it may however, not be on the show/movie page when viewing the media.

⚠️ **GitHub.com Fallback** ⚠️