iOS-Widgets/Webservices-Health-Check/README.md
2020-11-28 17:12:49 +01:00

57 lines
2.2 KiB
Markdown

# Health Check of webservices
![Widget Preview](https://raw.githubusercontent.com/ThisIsBenny/iOS-Widgets/main/Webservices-Health-Check/previewLight.jpeg)
![Widget Preview](https://raw.githubusercontent.com/ThisIsBenny/iOS-Widgets/main/Webservices-Health-Check/previewDark.jpeg)
![Widget Preview](https://raw.githubusercontent.com/ThisIsBenny/iOS-Widgets/main/Webservices-Health-Check/previewLight2.jpeg)
![Widget Preview](https://raw.githubusercontent.com/ThisIsBenny/iOS-Widgets/main/Webservices-Health-Check/previewDark2.jpeg)
![Widget Preview](https://raw.githubusercontent.com/ThisIsBenny/iOS-Widgets/main/Webservices-Health-Check/previewLight3.jpeg)
![Widget Preview](https://raw.githubusercontent.com/ThisIsBenny/iOS-Widgets/main/Webservices-Health-Check/previewDark3.jpeg)
This widget checks the status of your webservices.
Feature:
* History
* Push Notification
* Custom Header
* Custom Timeout Interval
The small and medium widget will show 4 services at once and the large one 8. If you have defined more service, the list of displayed services will be random.
Notice: The widget will be updated about every 5-10 min. The update interval of the widget is controlled by iOS and can't change.
[[Download]](https://raw.githubusercontent.com/ThisIsBenny/iOS-Widgets/main/Webservices-Health-Check/Webservices-Health-Check.js)
## Setup
Run the script from the Scriptable App. After this, you will find an example configuration in your scriptable folder (iCloud or local) with the name `health-check-settings.example.json`.
Rename the json file to `health-check-settings.json` and add your configuration to the json file. Example:
```json
[
{
"name": "Service 1",
"endpoint": "https://example.com/api/health",
"expectedContentType": "application/json",
"timeoutInterval": 1,
"notification": true,
"headers": [
{
"key": "x-api-key",
"value": "12345678"
}
]
},
{
"name": "Service 2",
"endpoint": "https://hello.com/api/health",
"expectedContentType": "application/json",
"timeoutInterval": 5,
"notification": false,
"headers": [
{
"key": "x-api-key",
"value": "098765"
}
]
}
]
```