# Sonarr Homepage Item

{% tabs %}
{% tab title="About" %}
![](https://4256712066-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MhZdNSL6M8X_fZlyG10%2F-MjlIgqrH05yXGUBjNW7%2F-MjlIpFXXP0AeLnLWBlX%2Fimage.png?alt=media\&token=b5a08865-0d01-4e57-b60f-4710b28a6551)

Sonarr is a PVR for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new episodes of your favorite shows and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available.
{% endtab %}

{% tab title="Links" %}
{% embed url="<https://sonarr.tv/>" %}
Main site
{% endembed %}

{% embed url="<https://github.com/Sonarr/Sonarr>" %}
GitHub
{% endembed %}
{% endtab %}
{% endtabs %}

## Summary

This homepage item allows you to have the following items displayed on the homepage:

* Calendar (Upcoming and Past TV Shows)
* Queue (Current Downloading Items)
* API Socks (Access to API without needing to Reverse Proxy Sonarr)

## Setting up

### Enable Tab

When setting up the homepage item, the first option is to enable it, do that by toggling the `Enable` Switch.  After that you need to set the `Minimum Authentication` group that will be able to use this item.

{% hint style="info" %}
&#x20;Please make sure not to set the `Minimum Authentication` to at least the same or lower than the homepage's `Tab Group`
{% endhint %}

![](https://4256712066-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MhZdNSL6M8X_fZlyG10%2F-Mjf5G0_KEb5PGICz9Zf%2F-Mjkct3whM8YCY35bvKt%2Fimage.png?alt=media\&token=24b0a54d-c791-4429-a40e-b43dd819997b)

| **Field**                          | **Value**                                 |
| ---------------------------------- | ----------------------------------------- |
| Enable                             | Enable the Module                         |
| Main Module Minimum Authentication | Minimum Group needed to see Entire Module |

### Connection

Enter the connection details of your Sonarr server.  This homepage item allows multiple Sonarr server connections.

![](https://4256712066-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MhZdNSL6M8X_fZlyG10%2F-Mjf5G0_KEb5PGICz9Zf%2F-MjkdBiNo1iZGEUZi-Wd%2Fimage.png?alt=media\&token=ccb5645f-855e-45d8-a1e2-56638177d55b)

| **Field**                 | **Value**                                                                   |
| ------------------------- | --------------------------------------------------------------------------- |
| Multiple URL's            | URL to your Sonarr Servers - LAN preferred                                  |
| Multiple API Key/Token's  | API Keys to your Sonarr Servers                                             |
| Disable Certificate Check | Disables the Certificate of the URL provided if https                       |
| Use Custom Certificate    | Uses a Custom Certificate for the verification of the URL provided if https |

### API Socks

Organizr's API Socks allows you to access Sonarr's API without needing to Reverse Proxy it.

#### API Socks URL

{% tabs %}
{% tab title="Settings" %}
![](https://4256712066-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MhZdNSL6M8X_fZlyG10%2F-Mjf5G0_KEb5PGICz9Zf%2F-MjkdqL-Pv7DnFWWbc6n%2Fimage.png?alt=media\&token=3baa1bae-a44f-4fb3-8f98-fd74d4cebe6d)

| **Field**                     | **Value**                                             |
| ----------------------------- | ----------------------------------------------------- |
| Enable                        | Enable the Module                                     |
| Module Minimum Authentication | Minimum Group needed to use Module                    |
| Disable Certificate Check     | Disables the Certificate of the URL provided if https |
| {% endtab %}                  |                                                       |

{% tab title="Preview" %}
![](https://4256712066-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MhZdNSL6M8X_fZlyG10%2F-Mjf5G0_KEb5PGICz9Zf%2F-Mjkhopul-t-CypXeatB%2Fimage.png?alt=media\&token=225da125-98cd-4a4d-ae32-2187b83a2a1b)
{% endtab %}
{% endtabs %}

Depending on if you entered either one Sonarr Connection or multiple will determine which URL you will use.

{% tabs %}
{% tab title="One Sonarr Connection" %}
URL for Socks Connection:

{% hint style="info" %}
Replace `docker:8000` with the address to your actual Organizr Server
{% endhint %}

```
http://docker:8000/api/v2/socks/sonarr/
```

I.E.

```
http://demo.organizr.app/api/v2/socks/sonarr/
```

{% endtab %}

{% tab title="Multiple Sonarr Connections" %}
Depending on how many connections you setup, replace {#} with which server you are connecting to.

URL for Socks Connection:

{% hint style="info" %}
Replace `docker:8000` with the address to your actual Organizr Server and `{#}` with the number of the connection
{% endhint %}

```
http://docker:8000/api/v2/multiple/socks/sonarr/{#}
```

I.E.

```
http://demo.organizr.app/api/v2/multiple/socks/sonarr/1
http://demo.organizr.app/api/v2/multiple/socks/sonarr/2
http://demo.organizr.app/api/v2/multiple/socks/sonarr/3
```

{% endtab %}
{% endtabs %}

### Queue

Enabling this module will output Sonarr's Download Queue on the homepage.

{% tabs %}
{% tab title="Settings" %}
![](https://4256712066-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MhZdNSL6M8X_fZlyG10%2F-Mjf5G0_KEb5PGICz9Zf%2F-MjkgVv2eRvklVc4zZrg%2Fimage.png?alt=media\&token=ded82658-d646-40a1-a96c-63ff22d0d406)

| **Field**                     | **Value**                                            |
| ----------------------------- | ---------------------------------------------------- |
| Enable                        | Enable the Module                                    |
| Module Minimum Authentication | Minimum Group needed to use Module                   |
| Add to Combined Downloader    | Adds this downloader to a combined downloader module |
| Refresh Seconds               | Sets the time in between data being refreshed        |
| {% endtab %}                  |                                                      |

{% tab title="Homepage Preview" %}
Better preview coming soon...

![](https://4256712066-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MhZdNSL6M8X_fZlyG10%2F-Mjf5G0_KEb5PGICz9Zf%2F-MjkiEPfVSRrBUc1dLFn%2Fimage.png?alt=media\&token=bf345bf6-85da-451a-b4fb-724abdcf03dc)
{% endtab %}
{% endtabs %}

### Calendar

This module adds past and future TV Shows on the homepage Calendar

{% tabs %}
{% tab title="Settings" %}
![](https://4256712066-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MhZdNSL6M8X_fZlyG10%2F-Mjf5G0_KEb5PGICz9Zf%2F-MjkiZtIRfcUCVYW-_6e%2Fimage.png?alt=media\&token=54111853-0b99-4700-a191-f6548066bc14)

| **Field**        | **Value**                                      |
| ---------------- | ---------------------------------------------- |
| Days Before      | Amount of days to grab before todays date      |
| Days After       | Amount of days to grab after todays date       |
| Start Day        | First Day of Calendar for Week View            |
| Default View     | Which view to display on page load             |
| Time Format      | Format for the time of TV Showing              |
| Locale           | Region format for date                         |
| Items Per Day    | Amount of items to show pre day before cut-off |
| Refresh Seconds  | Sets the time in between data being refreshed  |
| Show Unmonitored | Display shows that are unmonitored             |
| {% endtab %}     |                                                |

{% tab title="Homepage Preview" %}
![](https://4256712066-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MhZdNSL6M8X_fZlyG10%2F-Mjf5G0_KEb5PGICz9Zf%2F-MjkkJXvixecQ4z4lbTF%2Fimage.png?alt=media\&token=e5adf48f-2f49-42cf-858e-4a9e0451e9ca)
{% endtab %}
{% endtabs %}

### Test Connection

{% hint style="info" %}
&#x20;Make sure to save before hitting the `Test Connection` button
{% endhint %}

![](https://4256712066-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MhZdNSL6M8X_fZlyG10%2F-Mjf5G0_KEb5PGICz9Zf%2F-Mjkjjc_wwz4598GvrYM%2Fimage.png?alt=media\&token=38f43937-22fc-47e2-910f-329e7100c84d)
