mirror/kener
1
0
Fork 0
mirror of https://github.com/rajnandan1/kener.git synced 2026-01-06 09:30:21 -06:00
Code Issues Packages Projects Releases Wiki Activity

updated docs

Browse Source
This commit is contained in:
Raj Nandan Sharma
2024-01-21 15:44:04 +05:30
parent 5c527cdec8
commit 80958a4710
1 changed files with 27 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
docs.md
View File

@@ -269,8 +269,21 @@ nav:
url: "/home"
```
## categories
You can define categories for your monitors. Each category can have a description. The monitors can be grouped by categories.
`name=home` will be shown in the home page. Categories are shown in the order they are defined in the yaml file. A dropdown will appear in the nav bar to select the category.
```yaml
categories:
- name: API
description: "Kener provides a simple API for you to use to update your status page."
- name: home
description: "lroem ipsum lorem ipsum"
```
## scripts
You can include any script in the app.html file like google analytics etc
You can include any script in the `app.html` file like google analytics etc
---
# Add Monitors
@@ -322,6 +335,7 @@ Sample
| api.eval | Optional | Evaluator written in JS, to parse HTTP response and calculate uptime and latency |
| defaultStatus | Optional | If no API is given this will be the default status. can be UP/DOWN/DEGRADED |
| hidden | Optional | If set to `true` will not show the monitor in the UI |
| category | Optional | Use this group your monitors. Make sure you have defined category in `site.yaml` and use the `name` attribute here |
## cron
@@ -463,7 +477,7 @@ Assuming `ORDER_ID` is present in env
```
## With defaultStatus UP
This will not make any API call, each minute it will set the status as UP
Each minute it will set the status as UP
```yaml
- name: Earth
@@ -472,6 +486,17 @@ This will not make any API call, each minute it will set the status as UP
defaultStatus: UP
```
## With Category
Add this monitor to the API category instead of the default home category
```yaml
- name: Earth
description: Our Planent
tag: "earth"
category: API
```
---
# Incident Management
Kener uses Github to power incident management using labels