diff --git a/docs/widgets.md b/docs/widgets.md index 940e3dd8..fabae2aa 100644 --- a/docs/widgets.md +++ b/docs/widgets.md @@ -66,6 +66,7 @@ Dashy has support for displaying dynamic content in the form of widgets. There a - [Gluetun VPN Info](#gluetun-vpn-info) - [Drone CI Build](#drone-ci-builds) - [Linkding](#linkding) + - [Uptime Kuma](£uptime-kuma) - **[System Resource Monitoring](#system-resource-monitoring)** - [CPU Usage Current](#current-cpu-usage) - [CPU Usage Per Core](#cpu-usage-per-core) @@ -2113,7 +2114,9 @@ This will show the list of nodes. token_name: dashy token_uuid: bfb152df-abcd-abcd-abcd-ccb95a472d01 ``` + This will show the list of VMs, with a title and a linked fotter, hiding VM templates. + ```yaml - type: proxmox-lists useProxy: true @@ -2130,11 +2133,7 @@ This will show the list of VMs, with a title and a linked fotter, hiding VM temp footer_as_link: true hide_templates: 1 ``` -#### Troubleshooting -- **404 Error in development mode**: The error might disappear in production mode `yarn start` -- **500 Error in production mode**: Try adding the certificate authority (CA) certificate of your Proxmox host to Node.js. - - Download the Proxmox CA certificate to your Dashy host. - - Export environment variable `NODE_EXTRA_CA_CERTS` and set its value to the path of the downloaded CA certificate. Example: `export NODE_EXTRA_CA_CERTS=/usr/local/share/ca-certificates/devlab_ca.pem` + #### Info - **CORS**: 🟠 Proxied @@ -2143,6 +2142,12 @@ This will show the list of VMs, with a title and a linked fotter, hiding VM temp - **Host**: Self-Hosted (see [Proxmox Virtual Environment](https://proxmox.com/en/proxmox-ve)) - **Privacy**: _See [Proxmox's Privacy Policy](https://proxmox.com/en/privacy-policy)_ +#### Troubleshooting +- **404 Error in development mode**: The error might disappear in production mode `yarn start` +- **500 Error in production mode**: Try adding the certificate authority (CA) certificate of your Proxmox host to Node.js. + - Download the Proxmox CA certificate to your Dashy host. + - Export environment variable `NODE_EXTRA_CA_CERTS` and set its value to the path of the downloaded CA certificate. Example: `export NODE_EXTRA_CA_CERTS=/usr/local/share/ca-certificates/devlab_ca.pem` + --- ### Sabnzbd @@ -2285,6 +2290,37 @@ Linkding is a self-hosted bookmarking service, which has a clean interface and i --- +### Uptime Kuma + +[Uptime Kuma](https://github.com/louislam/uptime-kuma) is an easy-to-use self-hosted monitoring tool. + +#### Options + +| **Field** | **Type** | **Required** | **Description** | +| ------------ | -------- | ------------ | ------------------------------------------------------------------------ | +| **`url`** | `string` | Required | The URL of the Uptime Kuma instance | +| **`apiKey`** | `string` | Required | The API key (see https://github.com/louislam/uptime-kuma/wiki/API-Keys). | + +#### Example + +```yaml +- type: uptime-kuma + useProxy: true + options: + apiKey: uk2_99H0Yd3I2pPNIRfn0TqBFu4g5q85R1Mh75yZzw6H + url: http://192.168.1.106:3691/metrics +``` + +#### Info + +- **CORS**: 🟢 Enabled +- **Auth**: 🟢 Required +- **Price**: 🟢 Free +- **Host**: Self-Hosted (see [Uptime Kuma](https://github.com/louislam/uptime-kuma) )) +- **Privacy**: _See [Uptime Kuma](https://github.com/louislam/uptime-kuma)_ + +--- + ## System Resource Monitoring ### Glances diff --git a/src/components/Widgets/UptimeKuma.vue b/src/components/Widgets/UptimeKuma.vue new file mode 100644 index 00000000..b58c1d08 --- /dev/null +++ b/src/components/Widgets/UptimeKuma.vue @@ -0,0 +1,242 @@ + + + + + diff --git a/src/components/Widgets/WidgetBase.vue b/src/components/Widgets/WidgetBase.vue index 3ab0c6c4..739388fa 100644 --- a/src/components/Widgets/WidgetBase.vue +++ b/src/components/Widgets/WidgetBase.vue @@ -115,6 +115,7 @@ const COMPAT = { 'synology-download': 'SynologyDownload', 'system-info': 'SystemInfo', 'tfl-status': 'TflStatus', + 'uptime-kuma': 'UptimeKuma', 'wallet-balance': 'WalletBalance', weather: 'Weather', 'weather-forecast': 'WeatherForecast', @@ -205,14 +206,16 @@ export default {