jamorin / Sonarr.bundle

A Sonarr channel plugin for the Plex Media Server.
94 stars 14 forks source link

Sonarr.bundle

A plugin for Plex Media Server that is a client for Sonarr (formally NzbDrone).

Screenshot

Install

  1. Download "Source Code (zip)" from the Latest Release.
  2. Unzip Sonarr.bundle-VERSION.zip
  3. Rename Sonar.bundle-VERSION to Sonarr.bundle
  4. Move Sonarr.bundle folder to "<PMS Installation>/Library/Application Support/Plex Media Server/Plug-ins" along with the rest of your plugins.
  5. Might need to restart Plex Media Server to detect the new plugin.
  6. Change the plugin's settings by adding your endpoint, API Key, etc...
  7. Profit.

Configuration

Key Default Value Required Description
Endpoint http://127.0.0.1:8989 Yes Sonarr's URL endpoint including the URL base. Example behind a reverse proxy: https://sub.mydomain.com/sonarr
API Key empty Yes Found in Sonarr's General Settings
Username empty No Username for Basic Auth. This is NOT the Username in Sonarr's settings. This is for cases where Plex has to access Sonarr behind a nginx proxy configured with basic auth.
Password empty No Optional - See Username.

Note - If datetimes appear wrong, please check the timezone of your server and set it to your desired timezone. If you're running Plex in a Docker container, it's probably UTC. You can set the timezone with an environment variable such as TZ=America/Phoenix. There is an example docker-compose.yml file in the docker folder.

Notes on upgrading from version 0.x to 1.0

This is a non-backwards compatible change as the Preferences have changed. Previously you had to define the protocol, hostname, and port separately. This is now conslidated to one endpoint configuration. This means you will lose your settings.

The plugin identifier has changed from com.plexapp.plugins.sonarr to com.github.jamorin.sonarr. The com.plexapp.plugins namespace seems to be reserved for official plugins.

It's recommended now to install from the zip file as explained above. Previously recommended that you could install the plugin by cloning the repo. However, going forward you should be able to update the plugin from within the plugin now.