tyler.durden/dashy
1
0
Fork 0
mirror of https://github.com/Lissy93/dashy.git synced 2025-07-27 15:44:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

Auto Publish new pages

liss-bot 2022-07-03 01:34:24 +00:00
parent 55bdd67d56
commit c749e92d7a
5 changed files with 187 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
configuring.md

@ -253,6 +253,8 @@ For more info, see the **[Authentication Docs](/docs/authentication.md)**
**`updateInterval`** | `number` | _Optional_ | You can keep a widget constantly updated by specifying an update interval, in seconds. See [Continuous Updates Docs](/docs/widgets.md#continuous-updates) for more info
**`useProxy`** | `boolean` | _Optional_ | Some widgets make API requests to services that are not CORS-enabled. For these instances, you will need to route requests through a proxy, Dashy has a built in CORS-proxy, which you can use by setting this option to `true`. Defaults to `false`. See the [Proxying Requests Docs](/docs/widgets.md#proxying-requests) for more info
**`timeout`** | `number` | _Optional_ | Request timeout in milliseconds, defaults to ½ a second (`500`)
**`ignoreErrors`** | `boolean` | _Optional_ | Prevent an error message being displayed, if a network request or something else fails. Useful for false-positives
**`label`** | `string` | _Optional_ | Add custom label to a given widget. Useful for identification, if there are multiple of the same type of widget in a single section
**[⬆️ Back to Top](#configuring)**

98
credits.md

@ -104,13 +104,6 @@
<sub><b>Kieren Connell</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/Antiz96">
<img src="https://avatars.githubusercontent.com/u/53110319?u=a4fad84fed8fb2fd9ca7c507d303fd6048b3e497&v=4" width="80;" alt="Antiz96"/>
<br />
<sub><b>Robin Candau</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/ced4568">
<img src="https://avatars.githubusercontent.com/u/60725859?v=4" width="80;" alt="ced4568"/>
@ -131,8 +124,7 @@
<br />
<sub><b>Undefined</b></sub>
</a>
</td></tr>
<tr>
</td>
<td align="center">
<a href="https://github.com/jtfinley72">
<img src="https://avatars.githubusercontent.com/u/96497997?v=4" width="80;" alt="jtfinley72"/>
@ -140,6 +132,14 @@
<sub><b>Jtfinley72</b></sub>
</a>
</td></tr>
<tr>
<td align="center">
<a href="https://github.com/zacharyraber">
<img src="https://avatars.githubusercontent.com/u/105998568?v=4" width="80;" alt="zacharyraber"/>
<br />
<sub><b>Zachary Raber</b></sub>
</a>
</td></tr>
</table>
<!-- readme: sponsors -end -->
@ -161,6 +161,13 @@
<sub><b>Alicia Bot</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/marekful">
<img src="https://avatars.githubusercontent.com/u/10281476?v=4" width="80;" alt="marekful"/>
<br />
<sub><b>Marcell Fülöp</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/EVOTk">
<img src="https://avatars.githubusercontent.com/u/45015615?v=4" width="80;" alt="EVOTk"/>
@ -181,15 +188,15 @@
<br />
<sub><b>Snyk Bot</b></sub>
</a>
</td>
</td></tr>
<tr>
<td align="center">
<a href="https://github.com/pinarruiz">
<img src="https://avatars.githubusercontent.com/u/37040888?v=4" width="80;" alt="pinarruiz"/>
<br />
<sub><b>Alejandro Pinar Ruiz</b></sub>
</a>
</td></tr>
<tr>
</td>
<td align="center">
<a href="https://github.com/kashif-se">
<img src="https://avatars.githubusercontent.com/u/5568138?v=4" width="80;" alt="kashif-se"/>
@ -224,15 +231,15 @@
<br />
<sub><b>Remygrandin</b></sub>
</a>
</td>
</td></tr>
<tr>
<td align="center">
<a href="https://github.com/boggy-cs">
<img src="https://avatars.githubusercontent.com/u/82003678?v=4" width="80;" alt="boggy-cs"/>
<br />
<sub><b>Bogyeong Kim</b></sub>
</a>
</td></tr>
<tr>
</td>
<td align="center">
<a href="https://github.com/stanly0726">
<img src="https://avatars.githubusercontent.com/u/37040069?v=4" width="80;" alt="stanly0726"/>
@ -267,15 +274,15 @@
<br />
<sub><b>CHAIYEON CHO</b></sub>
</a>
</td>
</td></tr>
<tr>
<td align="center">
<a href="https://github.com/daentech">
<img src="https://avatars.githubusercontent.com/u/358678?v=4" width="80;" alt="daentech"/>
<br />
<sub><b>Dan Gilbert</b></sub>
</a>
</td></tr>
<tr>
</td>
<td align="center">
<a href="https://github.com/rubenandre">
<img src="https://avatars.githubusercontent.com/u/9402773?v=4" width="80;" alt="rubenandre"/>
@ -283,6 +290,20 @@
<sub><b>Rúben Silva</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/k073l">
<img src="https://avatars.githubusercontent.com/u/21180271?v=4" width="80;" alt="k073l"/>
<br />
<sub><b>k073l</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/patrickheeney">
<img src="https://avatars.githubusercontent.com/u/1407228?v=4" width="80;" alt="patrickheeney"/>
<br />
<sub><b>Patrick Heeney</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/Singebob">
<img src="https://avatars.githubusercontent.com/u/24290044?v=4" width="80;" alt="Singebob"/>
@ -296,7 +317,8 @@
<br />
<sub><b>0n1cOn3</b></sub>
</a>
</td>
</td></tr>
<tr>
<td align="center">
<a href="https://github.com/BeginCI">
<img src="https://avatars.githubusercontent.com/u/57495754?v=4" width="80;" alt="BeginCI"/>
@ -317,42 +339,20 @@
<br />
<sub><b>DeepSource Bot</b></sub>
</a>
</td></tr>
<tr>
</td>
<td align="center">
<a href="https://github.com/dougaldhub">
<img src="https://avatars.githubusercontent.com/u/25713235?v=4" width="80;" alt="dougaldhub"/>
<br />
<sub><b>Doug Lock</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/emiran-orange">
<img src="https://avatars.githubusercontent.com/u/71817149?v=4" width="80;" alt="emiran-orange"/>
<br />
<sub><b>Emiran-orange</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/FormatToday">
<img src="https://avatars.githubusercontent.com/u/20515769?v=4" width="80;" alt="FormatToday"/>
<br />
<sub><b>FormatToday</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/Compunctus">
<img src="https://avatars.githubusercontent.com/u/5058853?v=4" width="80;" alt="Compunctus"/>
<br />
<sub><b>Iaroslav Dronskii</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/b1thunt3r">
<img src="https://avatars.githubusercontent.com/u/791091?v=4" width="80;" alt="b1thunt3r"/>
<br />
<sub><b>Ishan Jain</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/Hellhium">
<img src="https://avatars.githubusercontent.com/u/11504877?v=4" width="80;" alt="Hellhium"/>
<br />
<sub><b>Jemy SCHNEPP</b></sub>
</a>
</td></tr>
</table>
<!-- readme: contributors -end -->

36
showcase.md

@ -9,6 +9,17 @@
---
### Dipan's Dash
> By [@Dipanghosh](https://github.com/dipanghosh) - [dipan.de](https://dipan.de/) <sup>Re: [#777](https://github.com/Lissy93/dashy/discussions/777)</sup>
> With the option of embedding iframes, it becomes possible to combine and conquer. I have set up Dashy to include graphs from grafana, and set them so that they update automatically. I also have uptime monitors from uptime Kuma, panels from homeasistant are also possible to be included.<br>
> Dashy is awesome!
![screenshot-dipanghosh-dashboard](https://i.ibb.co/bPC6w2n/dipanghosh-dashboard.png)
---
### Ratty222
> By [@ratty222](https://github.com/ratty222) <sup>Re: [#384](https://github.com/Lissy93/dashy/discussions/384)</sup>
@ -38,11 +49,13 @@
---
### The Private Dashboard
> By [@DylanBeMe](https://github.com/DylanBeMe) <sup>Re: [#419](https://github.com/Lissy93/dashy/issues/419)</sup>
### The Dragons Lair
> By [dr460nf1r3](https://github.com/dr460nf1r3) <sup>via [#684](https://github.com/Lissy93/dashy/issues/684)</sup>
![screenshot-private-dashboard](https://i.ibb.co/hKS483T/private-dashboard-Dylan-Be-Me.png)
> My new startpage featuring the stuff I use most. And of course dragons!
![screenshot-dragons-lair](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/13-dragons-lair.png)
---
@ -78,6 +91,14 @@
---
### The Private Dashboard
> By [@DylanBeMe](https://github.com/DylanBeMe) <sup>Re: [#419](https://github.com/Lissy93/dashy/issues/419)</sup>
![screenshot-private-dashboard](https://i.ibb.co/hKS483T/private-dashboard-Dylan-Be-Me.png)
---
### Networking Services
> By [@Lissy93](https://github.com/lissy93)
@ -185,15 +206,6 @@
---
### The Dragons Lair
> By [dr460nf1r3](https://github.com/dr460nf1r3) <sup>via [#684](https://github.com/Lissy93/dashy/issues/684)</sup>
> My new startpage featuring the stuff I use most. And of course dragons!
![screenshot-dragons-lair](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/13-dragons-lair.png)
---
## Submitting your Dashboard
#### How to Submit

70
troubleshooting.md

@ -3,7 +3,7 @@
> _**This document contains common problems and their solutions.**_<br>
> Please ensure your issue isn't listed here, before opening a new ticket.
>
> _If you come across an issue not listed below, consider adding it, to help other users._
> _Found something not listed here? Consider adding it, to help other users._
### Contents
- [Refused to Connect in Web Content View](#refused-to-connect-in-modal-or-workspace-view)
@ -30,9 +30,12 @@
- [Status Checks Failing](#status-checks-failing)
- [Diagnosing Widget Errors](#widget-errors)
- [Fixing Widget CORS Errors](#widget-cors-errors)
- [Widget Shows Error Incorrectly](#widget-shows-error-incorrectly)
- [Weather Forecast Widget 401](#weather-forecast-widget-401)
- [Font Awesome Icons not Displaying](#font-awesome-icons-not-displaying)
- [Copy to Clipboard not Working](#copy-to-clipboard-not-working)
- [How to Reset Local Settings](#how-to-reset-local-settings)
- [How to make a bug report](#how-to-make-a-bug-report)
- [How-To Open Browser Console](#how-to-open-browser-console)
- [Git Contributions not Displaying](#git-contributions-not-displaying)
@ -420,6 +423,15 @@ For testing purposes, you can use an addon, which will disable the CORS checks.
---
## Widget Shows Error Incorrectly
When there's an error fetching or displaying a widgets data, then it will be highlighted in yellow, and a message displayed on the UI.
In some instances, this is a false positive, and the widget is actually functioning correctly.
If this is the case, you can disable the UI error message of a given widget by setting: `ignoreErrors: true`
---
## Weather Forecast Widget 401
[Weather widget](/docs/widgets.md#weather-forecast) is working fine, but you are getting a `401` for the [Weather Forecast widget](/docs/widgets.md#weather-forecast), then this is most likely an OWM API key issue.
@ -457,6 +469,62 @@ As a workaround, you could either:
---
## How to Reset Local Settings
Some settings are stored locally, in the browser's storage.
In some instances cached assets can prevent your settings from being updated, in which case you may wish to reset local data.
To clear all local data from the UI, head to the Config Menu, then click "Reset Local Settings", and Confirm when prompted.
This will not affect your config file. But be sure that you keep a backup of your config, if you've not written changes it to disk.
You can also view any and all data that Dashy is storing, using the developer tools. Open your browser's dev tools (usually <kbd>F12</kbd>), in Chromium head to the Application tab, or in Firefox go to the Storage tab. Select Local Storage, then scroll down the the URL Dashy is running on. You should now see all data being stored, and you can select and delete any fields you wish.
For a full list of all data that may be cached, see the [Privacy Docs](/docs/privacy.md#browser-storage).
---
## How to make a bug report
#### Step 1 - Where to open issues
You will need a GitHub account in order to raise a ticket. You can then [click here](https://github.com/Lissy93/dashy/issues/new?assignees=lissy93&labels=%F0%9F%90%9B+Bug&template=bug.yml&title=%5BBUG%5D+%3Ctitle%3E) to open a new bug report.
#### Step 2 - Checking it's not already covered
Before submitting, please check that:
- A similar ticket has not previously been opened
- The issue is not covered in the [troubleshooting guide](https://github.com/Lissy93/dashy/blob/master/docs/troubleshooting.md) or [docs](https://github.com/Lissy93/dashy/tree/master/docs#readme)
#### Step 3 - Describe the Issue
Your ticket will likely be dealt with more effectively if you can explain the issue clearly, and provide all relevant supporting material.
Complete the fields, asking for your environment info and version of Dashy.
Then describe the issue, briefly explaining the steps to reproduce, expected outcome and actual outcome.
#### Step 4 - Provide Supporting Info
Where relevant please also include:
- A screenshot of the issue
- The relevant parts of your config file
- Logs
- If client-side issue, then include the browser logs ([see how](#how-to-open-browser-console))
- If server-side / during deployment, include the terminal output
_Take care to redact any personal info, (like IP addresses, auth hashes or API keys)_
#### Step 5 - Fix Released
A maintainer will aim to respond within 48 hours.
The timeframe for resolving your issue, will vary depending on severity of the bug and the complexity of the fix.
You will be notified on your ticket, when a fix has been released.
Finally, be sure to remain respectful to other users and project maintainers, in line with the [Contributor Covenant Code of Conduct](https://github.com/Lissy93/dashy/blob/master/.github/CODE_OF_CONDUCT.md#contributor-covenant-code-of-conduct).
---
## How-To Open Browser Console
When raising a bug, one crucial piece of info needed is the browser's console output. This will help the developer diagnose and fix the issue.

43
widgets.md

@ -80,6 +80,8 @@ Dashy has support for displaying dynamic content in the form of widgets. There a
- [Continuous Updates](#continuous-updates)
- [Proxying Requests](#proxying-requests)
- [Setting Timeout](#setting-timeout)
- [Adding Labels](#adding-labels)
- [Ignoring Errors](#ignoring-errors)
- [Custom CSS Styling](#widget-styling)
- [Customizing Charts](#customizing-charts)
- [Language Translations](#language-translations)
@ -2264,6 +2266,47 @@ For example:
---
### Adding Labels
If you have multiple widgets of the same type in a single section, it may not be clear what each one is. To overcome this, you can add a custom label to any given widget, using the `label` property.
For example:
```yaml
- name: CPU Usage
icon: fas fa-tachometer
widgets:
- type: gl-current-cpu
label: Meida Server
options:
hostname: http://media-server.lan:61208
- type: gl-current-cpu
label: Firewall
options:
hostname: http://firewall.lan:61208
- type: gl-current-cpu
label: File Sync Server
options:
hostname: http://file-sync.lan:61208
```
---
### Ignoring Errors
When there's an error fetching or displaying a widgets data, then it will be highlighted in yellow, and a message displayed on the UI.
In some instances, this is a false positive, and the widget is actually functioning correctly. If this is the case, you can disable the UI error message of a given widget by setting: `ignoreErrors: true`
```yaml
- type: gl-disk-io
ignoreErrors: true
options:
hostname: https://glances.dns-device.local
```
---
### Widget Styling
Like elsewhere in Dashy, all colours can be easily modified with CSS variables.