migrate badge documentation from pull into wiki (#83)

* migrate badge documentation from pull into wiki

from this pull https://github.com/louislam/uptime-kuma/pull/1119

* Update badges documentation

resolve comments from CommanderStorm

* Update Badge.md

* Apply suggestions from code review

Co-authored-by: Frank Elsinga <frank@elsinga.de>

* delete counting badges

Co-authored-by: Frank Elsinga <frank@elsinga.de>

* Tip Open Badge Generator

Co-authored-by: Frank Elsinga <frank@elsinga.de>

* Delete Screenshots

* Reorder whole content

* Delete Example Image

* Update Badge.md

delete ref pull

Co-authored-by: Frank Elsinga <frank@elsinga.de>

* Update Badge.md

delete headline open Badge Generator

Co-authored-by: Frank Elsinga <frank@elsinga.de>

* Update Badge.md

Change Sentence about the predefined or custom color

Co-authored-by: Frank Elsinga <frank@elsinga.de>

* Update Badge.mf

Change the appearance of all examples

Co-authored-by: Frank Elsinga <frank@elsinga.de>

* Update Badge.md

delete file inline Table of content

Co-authored-by: Frank Elsinga <frank@elsinga.de>

* Update Badge.md

Correction of the tables with examples

* Update Badge.md

Correct Markdown Typo

Co-authored-by: Frank Elsinga <frank@elsinga.de>

---------

Co-authored-by: Frank Elsinga <frank@elsinga.de>
Marcel Debray 2024-04-05 06:28:05 +02:00 committed by GitHub
parent 37a519b865
commit bdb2bc6b37
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
18 changed files with 123 additions and 1 deletions

124
Badge.md

@ -1,3 +1,125 @@
(Version >= 1.16.0)
Please read: https://github.com/louislam/uptime-kuma/pull/1119
# Description
`status`, `ping`, `uptime`, `avg-response`, `cert-exp` and `response`-badges are generated locally.
The server does this for all monitors which have been added to status pages and have thus been published.
The design is based on [badge-maker](https://www.npmjs.com/package/badge-maker) aka. [shields.io](http://shields.io/).
These are the endpoints that return an SVG graphic for a given (public) monitor:
| Badge Type | URL scheme | URL example | Graphic example |
|----------------|---------------------------------------------------------|---------------------------------------|----------------------------------------------|
| `status` | `<kuma-url>/api/badge/:monitorID/status` | `<kuma-url>/api/badge/1/status` | ![image](img/badge/status-example.png) |
| `uptime` | `<kuma-url>/api/badge/:monitorID/uptime:duration` | `<kuma-url>/api/badge/1/uptime` | ![image](img/badge/uptime-example.png) |
| `ping` | `<kuma-url>/api/badge/:monitorID/ping:duration` | `<kuma-url>/api/badge/1/ping` | ![image](img/badge/ping-example.png) |
| `avg-response` | `<kuma-url>/api/badge/:monitorID/avg-response:duration` | `<kuma-url>/api/badge/1/avg-response` | ![image](img/badge/avg-response-example.png) |
| `cert-exp` | `<kuma-url>/api/badge/:monitorID/cert-exp` | `<kuma-url>/api/badge/1/cert-exp` | ![image](img/badge/cert-exp-example.png) |
| `response` | `<kuma-url>/api/badge/:monitorID/response` | `<kuma-url>/api/badge/1/response` | ![image](img/badge/response-example.png) |
> [!TIP]
> We have an Badge Generator integrated which makes this configuration more interactive.
>
> You can use said generator via:
> - navigating to a status page in edit mode
> - <details><summary>Clicking on the settings icon</summary>
> <p>
>
> ![image](img/badge/settings-button.png)
>
> </p>
> </details>
> - <details><summary>Clicking on the <code>Open Badge Maker</code>-button</summary>
> <p>
>
> ![image](img/badge/settings.png)
>
> </p>
> </details>
> - <details><summary>filling out the form to create your own badge</summary>
> <p>
>
> ![image](img/badge/open-badge-generator.png)
>
> </p>
> </details>
# Badge Type Options
## Status badge
There are options to customize the **status** badge's appearance:
- `upLabel`,Default value: Up
- `downLabel`, Default value: Down
- `upColor`
- `downColor`
**Examples**
| Badge | Url |
|-------|-----|
| ![image](img/badge/status-label.png) | `<kuma-url>/api/badge/<monitorId>/status?upLabel=<upLabel>&downLabel=<downLabel>` |
| ![image](img/badge/status-bw.png) | `<kuma-url>/api/badge/<monitorId>/status?upColor=white&downColor=black` |
## Ping, uptime, avg-response and response badge
There are options to customize the **ping**, **uptime**, **avg-response** and **response** badge's text:
- `labelPrefix`
- `label`
- `labelSuffix`, Default: value: uptime, ping & avg-response image= `h`
- `prefix`
- `suffix`, Default value: uptime= `%`, ping, avg-response & response= `ms`
- `color`
- `labelColor`
**Examples**
| Badge | Url |
|-------|-----|
| ![image](img/badge/ping-label.png) | `<kuma-url>/api/badge/<monitorId>/ping/24?labelPrefix=<labelPrefix>&label=<label>&labelSuffix=<labelSuffix>&prefix=<prefix>&suffix=<suffix>` |
| ![image](img/badge/uptime-label.png) | `<kuma-url>/api/badge/<monitorId>/uptime/24?labelPrefix=<labelPrefix>&label=<label>&labelSuffix=<labelSuffix>&prefix=<prefix>&suffix=<suffix>` |
| | `<kuma-url>/api/badge/<monitorId>/avg-response/24?labelPrefix=<labelPrefix>&label=<label>&labelSuffix=<labelSuffix>&prefix=<prefix>&suffix=<suffix>` |
The default uptime badge's color is based on the uptime percentage:
![image](img/badge/uptime-color.png)
but can be overwritten with [predefined color](https://www.npmjs.com/package/badge-maker#colors) or any other color in HEX code:
![image](img/badge/custom-colours.png)
### Badge Duration at ping, uptime and avg-response
The given time interval at `Badge Duration (in hours)` has to be in 'hours', but customizing options allow for a different display:
**Example**
| Badge | Url |
|-------|-----|
| ![image](img/badge/duration.png) | `<kuma-url>/api/badge/1/uptime/720?label=30&labelSuffix=d` |
## Certificate Expire badge
There are the same options like **ping**, **uptime** and **avg-response** and additional to customize the **cert-exp** badge's text:
- `upColor`
- `downColor`
- `warnDays`
- `downDays`
# Badge Styles
The different badge styles as defined by https://shields.io/#styles. (thx @throwabird / [comment](https://github.com/louislam/uptime-kuma/pull/1119#issuecomment-1004760533) )
- `flat` (default)
- `flat-square`
- `plastic`
- `for-the-badge`
- `social`
**Example**
| Badge | Url |
|-------|-----|
| ![image](img/badge/badge-style.png) | `<kuma-url>/api/badge/<monitorId>/status?style=flat-square` |

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.6 KiB

BIN
img/badge/badge-style.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.4 KiB

BIN
img/badge/duration.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

BIN
img/badge/ping-example.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.2 KiB

BIN
img/badge/ping-label.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.2 KiB

BIN
img/badge/settings.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

BIN
img/badge/status-bw.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.7 KiB

BIN
img/badge/status-label.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.9 KiB

BIN
img/badge/uptime-color.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.4 KiB

BIN
img/badge/uptime-label.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.2 KiB