diff --git a/configuring.md b/configuring.md index 0e8f9a6..72558e7 100644 --- a/configuring.md +++ b/configuring.md @@ -228,6 +228,7 @@ For more info, see the **[Authentication Docs](/docs/authentication.md)** **`statusCheckAcceptCodes`** | `string` | _Optional_ | If your service's response code is anything other than 2xx, then you can opt to specify an alternative success code. E.g. if you expect your server to return 403, but still want the status indicator to be green, set this value to `403` **`statusCheckMaxRedirects`** | `number` | _Optional_ | If your service redirects to another page, and you would like status checks to follow redirects, then specify the maximum number of redirects here. Defaults to `0` / will not follow redirects **`color`** | `string` | _Optional_ | An optional color for the text and font-awesome icon to be displayed in. Note that this will override the current theme and so may not display well +**`rel`** | `string` | _Optional_ | The value of the `rel` attribute for the link. Useful for specifying the relationship between the target link/document and Dashy. Defaults to `noopener noreferrer` **`backgroundColor`** | `string` | _Optional_ | An optional background fill color for the that given item. Again, this will override the current theme and so might not display well against the background **`provider`** | `string` | _Optional_ | The name of the provider for a given service, useful for when including hosted apps. In some themes, this is visible under the item name **`displayData`** | `object` | _Optional_ | Meta-data to optionally override display settings for a given item. See [`displayData`](#itemdisplaydata-optional) diff --git a/contributing.md b/contributing.md index b57cc41..0e7fe55 100644 --- a/contributing.md +++ b/contributing.md @@ -130,7 +130,7 @@ If you like, you could also consider [subscribing to my mailing list](https://no For a full list of Dashy's contributors, see the [Credits Page](/docs/credits.md) -[![Auto-generated contributors](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/CONTRIBUTORS.svg)](/docs/credits.md) +[![Auto-generated contributors](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/CONTRIBUTORS.svg)](https://github.com/Lissy93/dashy/blob/master/docs/credits.md) ### Star-Gazers Over Time diff --git a/credits.md b/credits.md index 8533ee0..65a2ed0 100644 --- a/credits.md +++ b/credits.md @@ -27,7 +27,7 @@ - bgadrian + bgadrian
B.G.Adrian @@ -84,7 +84,7 @@ - InDieTasten + InDieTasten
Null @@ -111,6 +111,13 @@ HeliXZz + + + mryesiller +
+ Göksel Yeşiller + + forwardemail @@ -124,15 +131,15 @@
Null - + + frankdez93
Null - - + ratty222 @@ -225,6 +232,13 @@ Matthias Bilger + + + CrazyWolf13 +
+ Tobias + + pinarruiz @@ -233,10 +247,10 @@ - - CrazyWolf13 + + imjimmeh
- Tobias + Null @@ -246,13 +260,6 @@ Kashif Sohail - - - josuablejeru -
- Josua Blejeru - - walkxcode @@ -261,6 +268,13 @@ + + + josuablejeru +
+ Josua Blejeru + + evroon @@ -295,15 +309,15 @@
Alberto - + + altearius
Chris Nielsen - - + UrekD @@ -338,15 +352,15 @@
Dimitri - + + Tracreed
David Alasow - - + aviolaris @@ -381,15 +395,15 @@
ᗪєνιη ᗷυнʟ - + + stanly0726
Stanly0726 - - + Bogyie @@ -424,15 +438,15 @@
Null - + + kt-alt
Null - - + mmihaly @@ -467,15 +481,15 @@
Sergio - + + itsmejoeeey
Joey Miller - - + hockeymikey @@ -510,15 +524,15 @@
CHAIYEON CHO - + + BOZG
Stephen Rigney - - + a-mnich @@ -553,15 +567,15 @@
Shazz - + + ThinkSalat
Shawn Salat - - + royshreyaa @@ -596,15 +610,15 @@
Steven Kast - + + AmadeusGraves
Ángel Fernández Sánchez - - + turnrye @@ -639,15 +653,15 @@
OKAMOTO Shigehiro - + + bubylou
Nicholas Malcolm - - + miclav @@ -682,15 +696,15 @@
José Ignacio - + + soaibsafi
Soaibuzzaman - - + pablomalo @@ -725,15 +739,15 @@
Null - + + jnach
Jnach - - + imlonghao @@ -768,15 +782,15 @@
Nico - + + baifengheixi
Null - - + allozavrr @@ -811,15 +825,15 @@
Dylan Bersans - + + dougaldhub
Doug Lock - - + dkyeremeh @@ -854,15 +868,15 @@
Celestial.y - + + bskim45
Bumsoo Kim - - + BhasherBEL @@ -897,15 +911,15 @@
Aly Mohamed - + + 5idereal
5idereal - - + 0n1cOn3 @@ -940,15 +954,15 @@
Мирослав Асенов - + + luispabon
Luis Pabon - - + LeoColman @@ -983,15 +997,15 @@
Jemy SCHNEPP - + + jjmung
JJ Munguia - - + b1thunt3r @@ -1026,15 +1040,15 @@
Harald Töpfer - + + gbrown09
Garrett Brown - - + FormatToday diff --git a/deployment.md b/deployment.md index a780808..175a44b 100644 --- a/deployment.md +++ b/deployment.md @@ -198,7 +198,6 @@ Some hosting providers required a bit of extra configuration, which was why I've > [!NOTE] > If you use a static hosting provider, then status checks, writing new config changes to disk from the UI, and triggering a rebuild through the UI will not be available. This is because these features need endpoints provided by Dashy's local Node server. Everything else should work just the same though. - ### Netlify [![Deploy to Netlify](https://i.ibb.co/GtKMysT/deploy-netlify-button.png)](https://app.netlify.com/start/deploy?repository=https://github.com/lissy93/dashy) diff --git a/showcase.md b/showcase.md index 14ce1ec..bbeb8de 100644 --- a/showcase.md +++ b/showcase.md @@ -3,6 +3,14 @@ | 💗 Got a sweet dashboard? Submit it to the showcase! 👉 [See How](#submitting-your-dashboard) | |-| +## MNDashboard + +> By [@mahrnet](https://github.com/mahrnet) Re: [#1491](https://github.com/Lissy93/dashy/issues/1491) + +![screenshot-MNDashboard](https://i.ibb.co/mCJRZgp/d2-At-QO4c-PT4u.png) + +--- + ## Home Lab 2.0 ![screenshot-homelab](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/1-home-lab-material.png) diff --git a/troubleshooting.md b/troubleshooting.md index 82abffb..44fcfcb 100644 --- a/troubleshooting.md +++ b/troubleshooting.md @@ -19,6 +19,7 @@ - [App Not Starting After Update to 2.0.4](#app-not-starting-after-update-to-204) - [Keycloak Redirect Error](#keycloak-redirect-error) - [Docker Directory Error](#docker-directory) +- [Config not Saving on Vercel / Netlify / CDN](#user-content-config-not-saving-on-vercel--netlify--cdn) - [Config Not Updating](#config-not-updating) - [Config Still not Updating](#config-still-not-updating) - [Styles and Assets not Updating](#styles-and-assets-not-updating) @@ -281,6 +282,17 @@ If you get an error similar to the one above, you are mounting a directory to th --- +## Config not Saving on Vercel / Netlify / CDN + +If you're running Dashy using a static hosting provider (like Vercel), then there is no Node server, and so the save config action will not work via the UI. +You'll instead need to copy the YAML after making your changes, and paste that into your `conf.yml` directly. If you've connected Vercel to git, then these changes will take effect automatically, once you commit your changes. + +If you're running on Netlify, there are some cloud functions which take care of all the server endpoints (like status checking), so these will work as expected. + +See also [#1465](https://github.com/Lissy93/dashy/issues/1465) + +--- + ## Config Not Updating Dashy has the option to save settings and config locally, in browser storage. Anything here will take precedence over whatever is in your config file, sometimes with unintended consequences. If you've updated the config file manually, and are not seeing changes reflected in the UI, then try visiting the site in Incognito mode. If that works, then the solution is just to clear local storage. This can be done from the config menu, under "Clear Local Settings". @@ -557,8 +569,7 @@ For example: export NODE_OPTIONS=--openssl-legacy-provider ``` -For more info, see [webpack/webpack#14532](https://github.com/webpack/webpack/issues/14532) and [nodejs/node#40455](https://github.com/nodejs/node/issues/40455). -This occurs because [Node 17+](https://medium.com/the-node-js-collection/node-js-17-is-here-8dba1e14e382) no longer supports MD4 as hash function, we're in the process of upgrading Dashy dependencies to all use SHA1 for hashing bundle IDs. +This will be fixed once [webpack/webpack#17659](https://github.com/webpack/webpack/pull/17659) is merged. --- diff --git a/widgets.md b/widgets.md index 84d5eea..fabae2a 100644 --- a/widgets.md +++ b/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 @@ -2225,7 +2230,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:///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 @@ -2259,7 +2264,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:///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 @@ -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