Merge branch 'FEAT/Dashy-V3' into FEATURE/environment-variables
This commit is contained in:
Alicia Sykes
GitHub
@@ -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)
|
||||
@@ -703,6 +704,8 @@ Display current FX rates in your native currency. Hover over a row to view more
|
||||
|
||||
Counting down to the next day off work? This widget displays upcoming public holidays for your country. Data is fetched from [Enrico](http://kayaposoft.com/enrico/)
|
||||
|
||||
Note, config for this widget is case-sensetive (see [#1268](https://github.com/Lissy93/dashy/issues/1268))
|
||||
|
||||
<p align="center"><img width="400" src="https://i.ibb.co/VC6fZqn/public-holidays.png" /></p>
|
||||
|
||||
#### Options
|
||||
@@ -2124,7 +2127,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
|
||||
@@ -2141,6 +2146,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
|
||||
```
|
||||
|
||||
#### Info
|
||||
|
||||
- **CORS**: 🟠 Proxied
|
||||
@@ -2149,6 +2155,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
|
||||
@@ -2231,7 +2243,7 @@ Display the last builds from a [Drone CI](https://www.drone.ci) instance. A self
|
||||
**Field** | **Type** | **Required** | **Description**
|
||||
--- | --- | --- | ---
|
||||
**`host`** | `string` | Required | The hostname of the Drone CI instance.
|
||||
**`apiKey`** | `string` | Required | The API key (https://<your-drone-instance>/account).
|
||||
**`apiKey`** | `string` | Required | The API key (https://[your-drone-instance]/account).
|
||||
**`limit`** | `integer` | _Optional_ | Limit the amounts of listed builds.
|
||||
**`repo`** | `string` | _Optional_ | Show only builds of the specified repo
|
||||
|
||||
@@ -2265,7 +2277,7 @@ Linkding is a self-hosted bookmarking service, which has a clean interface and i
|
||||
**Field** | **Type** | **Required** | **Description**
|
||||
--- | --- | --- | ---
|
||||
**`host`** | `string` | Required | The hostname of the Drone CI instance.
|
||||
**`apiKey`** | `string` | Required | The API key (https://<your-linkding-instance>/settings/integrations).
|
||||
**`apiKey`** | `string` | Required | The API key (https://your-linkding-instance/settings/integrations).
|
||||
**`tags`** | `list of string` | _Optional_ | Filter the links by tag.
|
||||
|
||||
#### Example
|
||||
@@ -2291,6 +2303,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
|
||||
@@ -2300,8 +2343,28 @@ Glances is a cross-platform monitoring tool developed by [@nicolargo](https://gi
|
||||
|
||||
If you don't already have it installed, either follow the [Installation Guide](https://github.com/nicolargo/glances/blob/master/README.rst) for your system, or setup [with Docker](https://glances.readthedocs.io/en/latest/docker.html), or use the one-line install script: `curl -L https://bit.ly/glances | /bin/bash`.
|
||||
|
||||
If you are using Docker to run glances make sure to add the enviroment variable `-e TZ = {YourTimeZone}`. You can get a list of valid timezones by running `timedatectl list-timezones` on any linux system. This is needed so the graphs show the currect time.
|
||||
|
||||
Here an example for Docker
|
||||
```
|
||||
docker run -d \
|
||||
--name glances \
|
||||
--restart unless-stopped \
|
||||
-v /var/run/docker.sock:/var/run/docker.sock:ro \
|
||||
-p 61208:61208 \
|
||||
--pid host \
|
||||
--privileged \
|
||||
-e GLANCES_OPT=-w \
|
||||
-e PUID=1000 \
|
||||
-e PGID=1000 \
|
||||
-e TZ=Europe/Zurich \
|
||||
nicolargo/glances:latest
|
||||
```
|
||||
|
||||
Glances can be launched with the `glances` command. You'll need to run it in web server mode, using the `-w` option for the API to be reachable. If you don't plan on using the Web UI, then you can disable it using `--disable-webui`. See the [command reference docs](https://glances.readthedocs.io/en/latest/cmds.html) for more info.
|
||||
|
||||
If Glaces is running on a Windows system it is recommanded to add the following arguments ```--disable-plugin all --enable-plugin cpu,mem,diskio,ip,network,containers,quicklook,load,fs,alert -w``` This is due to Glances not being that stable on windows, so disabling all plugins that aren't used by Dashy widgets can save on ressources.
|
||||
|
||||
#### Options
|
||||
|
||||
All Glance's based widgets require a `hostname`. All other parameters are optional.
|
||||
|
||||
Reference in New Issue
Block a user