# HealthChecks Homepage Item

![](/files/-MibLF_lpyQBcnIPd2Ak)

## 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 |

![](/files/-MibLmKUWPL79ypkPglL)

### 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 |

![](/files/-MibLwQjFLLXLugsnbdb)

### 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                          |

![](/files/-MibMf0BalfDDG5BqV6V)

## 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.

![](/files/-MibUfq0yE-oqyiD92qn)

Enable the API and once enabled click on Show API Keys

<div align="left"><img src="/files/-Min0OARfnghDF2kZsc8" alt=""></div>

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

<div align="left"><img src="/files/-Min09dwswUdyttr-Mk2" alt=""></div>

### **Tips**

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

![](/files/-Min0bOdHSegM_CM_3FZ)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.organizr.app/features/homepage/healthchecks-homepage-item.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
