An open API service indexing awesome lists of open source software.

https://github.com/benleb/ad-healthcheck

🏥 AppDaemon healthcheck app. Can be used as a docker-compose healthcheck.
https://github.com/benleb/ad-healthcheck

app appdaemon appdaemon-apps hacs healthcheck home-assistant python

Last synced: 2 months ago
JSON representation

🏥 AppDaemon healthcheck app. Can be used as a docker-compose healthcheck.

Awesome Lists containing this project

README

        

# healthcheck

[![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg)](https://github.com/custom-components/hacs)

*Simple [AppDaemon](https://github.com/home-assistant/appdaemon) healthcheck app. Can be used as a docker-compose healthcheck.*

## Installation

Use [HACS](https://github.com/custom-components/hacs) or [download](https://github.com/benleb/ad-healthcheck/releases) the `healthcheck` directory from inside the `apps` directory here to your local `apps` directory, then add the configuration to enable the `healthcheck` module.

## App configuration

```yaml
healthcheck:
module: healthcheck
class: Healthcheck
endpoint: healthcheck
```

key | optional | type | default | description
-- | -- | -- | -- | --
`module` | False | string | | The module name of the app.
`class` | False | string | | The name of the Class.
`endpoint` | True | string | `healthcheck`| The endpoint URL which will be registered.

## docker-compose configuration

```yaml
healthcheck:
test: ["CMD", "curl", "-X", "POST", "-H", "Content-Type: application/json", "-d", "{}", "https://:5050/api/appdaemon/"]
interval: 45s
timeout: 3s
retries: 5
```