> For the complete documentation index, see [llms.txt](https://docs.organizr.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.organizr.app/features/homepage/healthchecks-homepage-item.md).

# HealthChecks Homepage Item

![](https://4256712066-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MhZdNSL6M8X_fZlyG10%2F-MibKpcRR0XPVY2LZHmC%2F-MibLF_lpyQBcnIPd2Ak%2Fimage.png?alt=media\&token=a129ae51-9fa9-4f2f-a5c7-ab82e034ce03)

## Summary

The HealthChecks Homepage item allows you to see all your health checks on your page at a quick glance.

## Setting up

### Enable

&#x20;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 %}

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

![](https://4256712066-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MhZdNSL6M8X_fZlyG10%2F-MibKpcRR0XPVY2LZHmC%2F-MibLmKUWPL79ypkPglL%2Fimage.png?alt=media\&token=32498fb7-a67e-459c-a626-a302925e916e)

### Connection

If you already went through the [Plex SSO](https://docs.organizr.app/books/setup-features/page/sso) or [Plex Authentication](https://docs.organizr.app/books/setup-features/page/plex-authentication) setup you will have these next fields already saved, if not, you can hit set those values using the provided buttons.&#x20;

| **Field**                 | **Value**                                                                   |
| ------------------------- | --------------------------------------------------------------------------- |
| URL                       | URL to the HealthCheck API (Local or Main API Site)                         |
| 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 |

![](https://4256712066-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MhZdNSL6M8X_fZlyG10%2F-MibKpcRR0XPVY2LZHmC%2F-MibLwQjFLLXLugsnbdb%2Fimage.png?alt=media\&token=db61a689-5abc-4e75-8c4e-7afd834aed65)

### Misc Options

| **Field**        | **Value**                                                   |
| ---------------- | ----------------------------------------------------------- |
| Tags             | Pull only checks with this tag                              |
| Refresh Seconds  | How many seconds to update the healthchecks on the homepage |
| Show Description | Show description on the healthchecks item                   |
| Show Tags        | Show tags on the healthchecks item                          |

![](https://4256712066-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MhZdNSL6M8X_fZlyG10%2F-MibKpcRR0XPVY2LZHmC%2F-MibMf0BalfDDG5BqV6V%2Fimage.png?alt=media\&token=21337c9c-a552-47bb-b5b6-e83c8c856b3f)

## Signing up at HealthChecks.io

Head over to [https://healthchecks.io](https://healthchecks.io/) and create an account.  Once created head over to User Menu and select Project Settings to copy your API Key.

![](https://4256712066-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MhZdNSL6M8X_fZlyG10%2F-MibMkqFopgQQIMHMUEI%2F-MibUfq0yE-oqyiD92qn%2Fimage.png?alt=media\&token=cde04006-dc95-40c0-8fd5-8a85cd399b62)

Enable the API and once enabled click on Show API Keys

<div align="left"><img src="https://4256712066-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MhZdNSL6M8X_fZlyG10%2F-Min-VEdluKrJW6JGLDF%2F-Min0OARfnghDF2kZsc8%2Fimage.png?alt=media&amp;token=f427031a-74af-41ac-a6dd-263b978d1ff7" alt=""></div>

Copy the API key (Top one) and paste into Organizr

<div align="left"><img src="https://4256712066-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MhZdNSL6M8X_fZlyG10%2F-Min-VEdluKrJW6JGLDF%2F-Min09dwswUdyttr-Mk2%2Fimage.png?alt=media&amp;token=50c16b5a-7eb5-413e-926c-0591baefdc2b" alt=""></div>

### **Tips**

You can setup logo/images for the checks if you add an images URL to the tags section for that check

![](https://4256712066-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MhZdNSL6M8X_fZlyG10%2F-Min-VEdluKrJW6JGLDF%2F-Min0bOdHSegM_CM_3FZ%2Fimage.png?alt=media\&token=5c5ffc7b-943b-4523-a196-185f20b4c6e8)
