🔀 Merge branch 'master' of github.com:Lissy93/dashy into REFACTOR/widget-and-docs-improvments

2022-06-30 15:00:51 +01:00
parent 4172512e88 2daabed9dd
commit 9235123f10
30 changed files with 2174 additions and 626 deletions
--- a/docs/assets/CONTRIBUTORS.svg
+++ b/docs/assets/CONTRIBUTORS.svg
--- a/docs/assets/repo-visualization.svg
+++ b/docs/assets/repo-visualization.svg
--- a/docs/credits.md
+++ b/docs/credits.md
@@ -18,6 +18,13 @@
            <sub><b>Eddy Lazzarin</b></sub>
        </a>
    </td>
+    <td align="center">
+        <a href="https://github.com/UlisesGascon">
+            <img src="https://avatars.githubusercontent.com/u/5110813?u=3c41facd8aa26154b9451de237c34b0f78d672a5&v=4" width="80;" alt="UlisesGascon"/>
+            <br />
+            <sub><b>Ulises Gascón</b></sub>
+        </a>
+    </td>
    <td align="center">
        <a href="https://github.com/BOZG">
            <img src="https://avatars.githubusercontent.com/u/6022344?u=a52f42b946a1e1156f7bb9d7f65e9e28bb2da89f&v=4" width="80;" alt="BOZG"/>
@@ -25,13 +32,21 @@
            <sub><b>Stephen Rigney</b></sub>
        </a>
    </td>
+    <td align="center">
+        <a href="https://github.com/bmcgonag">
+            <img src="https://avatars.githubusercontent.com/u/7346620?u=2a0f9284f3e12ac1cc15288c254d1ec68a5081e8&v=4" width="80;" alt="bmcgonag"/>
+            <br />
+            <sub><b>Brian McGonagill</b></sub>
+        </a>
+    </td>
    <td align="center">
        <a href="https://github.com/Robert-Ernst">
            <img src="https://avatars.githubusercontent.com/u/9050259?u=7253b4063f1ffe3b5a894263c8b2056151802508&v=4" width="80;" alt="Robert-Ernst"/>
            <br />
            <sub><b>Robert Ernst</b></sub>
        </a>
-    </td>
+    </td></tr>
+<tr>
    <td align="center">
        <a href="https://github.com/vlad-timofeev">
            <img src="https://avatars.githubusercontent.com/u/11474041?v=4" width="80;" alt="vlad-timofeev"/>
@@ -45,8 +60,14 @@
            <br />
            <sub><b>Kit L.</b></sub>
        </a>
-    </td></tr>
-<tr>
+    </td>
+    <td align="center">
+        <a href="https://github.com/mDafox">
+            <img src="https://avatars.githubusercontent.com/u/21359974?v=4" width="80;" alt="mDafox"/>
+            <br />
+            <sub><b>Manu Devos</b></sub>
+        </a>
+    </td>
    <td align="center">
        <a href="https://github.com/Byolock">
            <img src="https://avatars.githubusercontent.com/u/25748003?v=4" width="80;" alt="Byolock"/>
@@ -67,7 +88,8 @@
            <br />
            <sub><b>Hugalafutro</b></sub>
        </a>
-    </td>
+    </td></tr>
+<tr>
    <td align="center">
        <a href="https://github.com/shadowking001">
            <img src="https://avatars.githubusercontent.com/u/43928955?u=a00b44f22e5a82234d9b406ac048def1fbc16e31&v=4" width="80;" alt="shadowking001"/>
@@ -88,8 +110,7 @@
            <br />
            <sub><b>Robin Candau</b></sub>
        </a>
-    </td></tr>
-<tr>
+    </td>
    <td align="center">
        <a href="https://github.com/ced4568">
            <img src="https://avatars.githubusercontent.com/u/60725859?v=4" width="80;" alt="ced4568"/>
@@ -110,7 +131,8 @@
            <br />
            <sub><b>Undefined</b></sub>
        </a>
-    </td>
+    </td></tr>
+<tr>
    <td align="center">
        <a href="https://github.com/jtfinley72">
            <img src="https://avatars.githubusercontent.com/u/96497997?v=4" width="80;" alt="jtfinley72"/>
@@ -203,14 +225,21 @@
            <sub><b>Remygrandin</b></sub>
        </a>
    </td>
+    <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 align="center">
        <a href="https://github.com/stanly0726">
            <img src="https://avatars.githubusercontent.com/u/37040069?v=4" width="80;" alt="stanly0726"/>
            <br />
            <sub><b>Stanly0726</b></sub>
        </a>
-    </td></tr>
-<tr>
+    </td>
    <td align="center">
        <a href="https://github.com/onedr0p">
            <img src="https://avatars.githubusercontent.com/u/213795?v=4" width="80;" alt="onedr0p"/>
@@ -245,15 +274,15 @@
            <br />
            <sub><b>Dan Gilbert</b></sub>
        </a>
-    </td>
+    </td></tr>
+<tr>
    <td align="center">
        <a href="https://github.com/rubenandre">
            <img src="https://avatars.githubusercontent.com/u/9402773?v=4" width="80;" alt="rubenandre"/>
            <br />
            <sub><b>Rúben Silva</b></sub>
        </a>
-    </td></tr>
-<tr>
+    </td>
    <td align="center">
        <a href="https://github.com/Singebob">
            <img src="https://avatars.githubusercontent.com/u/24290044?v=4" width="80;" alt="Singebob"/>
@@ -288,15 +317,15 @@
            <br />
            <sub><b>DeepSource Bot</b></sub>
        </a>
-    </td>
+    </td></tr>
+<tr>
    <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></tr>
-<tr>
+    </td>
    <td align="center">
        <a href="https://github.com/FormatToday">
            <img src="https://avatars.githubusercontent.com/u/20515769?v=4" width="80;" alt="FormatToday"/>
@@ -324,13 +353,6 @@
            <br />
            <sub><b>Jemy SCHNEPP</b></sub>
        </a>
-    </td>
-    <td align="center">
-        <a href="https://github.com/KierenConnell">
-            <img src="https://avatars.githubusercontent.com/u/46445781?v=4" width="80;" alt="KierenConnell"/>
-            <br />
-            <sub><b>Kieren Connell</b></sub>
-        </a>
    </td></tr>
 </table>
 <!-- readme: contributors -end -->
--- a/docs/readme.md
+++ b/docs/readme.md
@@ -1,7 +1,7 @@
 ![Dashy Docs](https://i.ibb.co/4mdNf7M/heading-docs.png)

 ### Running Dashy
- [Quick Start](/docs/quick-start.md) - TDLR guide on getting Dashy up and running
+- [Quick Start](/docs/quick-start.md) - TLDR guide on getting Dashy up and running
 - [Deployment](/docs/deployment.md) - Full guide on deploying Dashy either locally or online
 - [Configuring](/docs/configuring.md) - Complete list of all available options in the config file
 - [App Management](/docs/management.md) - Managing your app, updating, security, web server configuration, etc
--- a/docs/troubleshooting.md
+++ b/docs/troubleshooting.md
@@ -1,8 +1,9 @@
 # Troubleshooting

-> _**This document contains common problems and their solutions.**_
+> _**This document contains common problems and their solutions.**_<br>
+> Please ensure your issue isn't listed here, before opening a new ticket.
 >
-> _If you came across an issue where the solution was not immediately obvious, consider adding it to this list to help other users._
+> _If you come across an issue not listed below, consider adding it, to help other users._

 ### Contents
 - [Refused to Connect in Web Content View](#refused-to-connect-in-modal-or-workspace-view)
@@ -32,6 +33,7 @@
 - [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 Open Browser Console](#how-to-open-browser-console)
 - [Git Contributions not Displaying](#git-contributions-not-displaying)

@@ -94,10 +96,18 @@ If this works, but you wish to continue using HTML5 history mode, then a bit of

 ## 404 after Launch from Mobile Home Screen

-Similar to the above issue, if you get a 404 after using iOS's “add to Home Screen” feature, then this is caused by Vue router.
+Similar to the above issue, if you get a 404 after using iOS and Android's “Add to Home Screen” feature, then this is caused by Vue router.
 It can be fixed by setting `appConfig.routingMode` to `hash`

-See also: [#628](https://github.com/Lissy93/dashy/issues/628)
+See also: [#628](https://github.com/Lissy93/dashy/issues/628), [#762](https://github.com/Lissy93/dashy/issues/762)
+
+---
+
+## 404 On Multi-Page Apps
+
+Similar to above, if you get a 404 error when visiting a page directly on multi-page apps, then this can be fixed under `appConfig`, by setting `routingMode` to `hash`. Then rebuilding, and refreshing the page.
+
+See also: [#670](https://github.com/Lissy93/dashy/issues/670), [#763](https://github.com/Lissy93/dashy/issues/763)

 ---

@@ -448,6 +458,21 @@ 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 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.

--- a/docs/widgets.md
+++ b/docs/widgets.md
@@ -48,6 +48,12 @@ Dashy has support for displaying dynamic content in the form of widgets. There a
  - [AdGuard Home Filters](#adguard-home-filters)
  - [AdGuard Home DNS Info](#adguard-home-dns-info)
  - [AdGuard Home Top Domains](#adguard-home-top-domains)
+  - [Nextcloud User](#nextcloud-user)
+  - [Nextcloud User Statuses](#nextcloud-user-statuses)
+  - [Nextcloud Notifications](#nextcloud-notifications)
+  - [Nextcloud System](#nextcloud-system)
+  - [Nextcloud Stats](#nextcloud-stats)
+  - [Nextcloud PHP Opcache](#nextcloud-php-opcache-stats)
 - **[System Resource Monitoring](#system-resource-monitoring)**
  - [CPU Usage Current](#current-cpu-usage)
  - [CPU Usage Per Core](#cpu-usage-per-core)
@@ -1565,6 +1571,224 @@ Fetches data from your [AdGuard Home](https://adguard.com/en/adguard-home/overvi

 ---

+### Nextcloud User
+
+Nextcloud is a [self hosted](https://nextcloud.com/install/#instructions-server) productivity platform, it can also be used free of charge with [hundreds of existing hosting providers](https://nextcloud.com/sign-up/) that offer a free Nextcloud account.
+
+Displays branding information of a Nextcloud server (logo, url, slogan) and some user details (name, login name, last login, disk space or quota). Use with regular or admin user.
+
+Shows quota usage when quota is enabled for the user or disk usage when not enabled.
+
+Known issues: the User API incorrectly reports available disk space as total for admin users when quota is not enabled (which usually is the case for admins).
+
+<p align="center"><img width="450" src="https://i.ibb.co/F8Fdm3t/nextcloud-user.png" alt="nextcloud-user" /></p>
+
+##### Options
+
+**Field** | **Type** | **Required** | **Description**
+--- | --- | --- | ---
+**`hostname`** | `string` |  Required | The URL of the Nextcloud server
+**`username`** | `string` |  Required | Nextcloud username
+**`password`** | `string` |  Required | Nextcloud app-password (create one in Settings -> Security)
+
+
+##### Example 
+
+```yaml
+- type: nextcloud-user
+  useProxy: true
+  options:
+    hostname: https://nextcloud.example.com
+    username: alice
+    password: xxxxx-xxxxx-xxxxx-xxxxx
+```
+
+##### Info
+- **CORS**: 🟠 Proxied
+- **Auth**: 🟢 Required
+- **Price**: 🟢 Free
+- **Host**: Self-Hosted (see [Nextcloud](https://nextcloud.com))
+- **Privacy**: _See [Nextcloud Privacy Policy](https://nextcloud.com/privacy)_
+
+---
+
+### Nextcloud User Statuses
+
+Show user statuses for selected users.
+
+<p align="center"><img width="450" src="https://i.ibb.co/Lk4DFT5/nextcloud-userstatus.png" alt="nextcloud-userstatus" /></p>
+
+##### Options
+
+**Field** | **Type** | **Required** | **Description**
+--- | --- | --- | ---
+**`hostname`** | `string` |  Required | The URL of the Nextcloud server
+**`username`** | `string` |  Required | Nextcloud username
+**`password`** | `string` |  Required | Nextcloud app-password (create one in Settings -> Security)
+**`users`** | `array` |  Required | Nextcloud User IDs to show statuses for, list size between `1` and `100`
+**`showEmpty`** | `boolean` |  _Optional_ | Show statuses without a message, defaults to `true`
+
+
+##### Example 
+
+```yaml
+- type: nextcloud-userstatus
+  useProxy: true
+  options:
+    hostname: https://nextcloud.example.com
+    username: alice
+    password: xxxxx-xxxxx-xxxxx-xxxxx
+    users: ['bob', 'alice']
+```
+
+##### Info
+- **CORS**: 🟠 Proxied
+- **Auth**: 🟢 Required
+- **Price**: 🟢 Free
+- **Host**: Self-Hosted (see [Nextcloud](https://nextcloud.com))
+- **Privacy**: _See [Nextcloud Privacy Policy](https://nextcloud.com/privacy)_
+
+---
+
+### Nextcloud Notifications
+
+Displays your notifications and allows deleting them.
+
+<p align="center"><img width="450" src="https://i.ibb.co/yQCS51k/nextcloud-notifications.png" alt="nextcloud-notifications" /></p>
+
+##### Options
+
+**Field** | **Type** | **Required** | **Description**
+--- | --- | --- | ---
+**`hostname`** | `string` |  Required | The URL of the Nextcloud server
+**`username`** | `string` |  Required | Nextcloud username
+**`password`** | `string` |  Required | Nextcloud app-password (create one in Settings -> Security)
+**`limit`** | `number\|string` |  _Optional_ | Limit displayed notifications either by count, e.g. `5` to show the 5 most recent, or by age, e.g. `1d` to only show notifications not older than a day. Accepted suffixes for age limit are `m`, `h` and `d`. 
+
+
+##### Example 
+
+```yaml
+- type: nextcloud-userstatus
+  useProxy: true
+  options:
+    hostname: https://nextcloud.example.com
+    username: alice
+    password: xxxxx-xxxxx-xxxxx-xxxxx
+    limit: 6h
+```
+
+##### Info
+- **CORS**: 🟠 Proxied
+- **Auth**: 🟢 Required
+- **Price**: 🟢 Free
+- **Host**: Self-Hosted (see [Nextcloud](https://nextcloud.com))
+- **Privacy**: _See [Nextcloud Privacy Policy](https://nextcloud.com/privacy)_
+
+---
+
+### Nextcloud System
+
+Visualises overall memory utilisation and CPU load averages, shows server versions.
+
+<p align="center"><img width="450" src="https://i.ibb.co/KW4t6nG/nextcloud-system.png" alt="nextcloud-system" /></p>
+
+##### Options
+
+**Field** | **Type** | **Required** | **Description**
+--- | --- | --- | ---
+**`hostname`** | `string` |  Required | The URL of the Nextcloud server
+**`username`** | `string` |  Required | Must be a Nextcloud admin user
+**`password`** | `string` |  Required | Nextcloud app-password (create one in Settings -> Security)
+
+##### Example 
+
+```yaml
+- type: nextcloud-system
+  useProxy: true
+  options:
+    hostname: https://nextcloud.example.com
+    username: alice
+    password: xxxxx-xxxxx-xxxxx-xxxxx
+```
+
+##### Info
+- **CORS**: 🟠 Proxied
+- **Auth**: 🟢 Required
+- **Price**: 🟢 Free
+- **Host**: Self-Hosted (see [Nextcloud](https://nextcloud.com))
+- **Privacy**: _See [Nextcloud Privacy Policy](https://nextcloud.com/privacy)_
+
+---
+
+### Nextcloud Stats
+
+Shows key usage statistics about your Nextcloud server.
+
+<p align="center"><img width="450" src="https://i.ibb.co/pPXPQFB/nextcloud-stats.png" alt="nextcloud-stats" /></p>
+
+##### Options
+
+**Field** | **Type** | **Required** | **Description**
+--- | --- | --- | ---
+**`hostname`** | `string` |  Required | The URL of the Nextcloud server
+**`username`** | `string` |  Required | Must be a Nextcloud admin user
+**`password`** | `string` |  Required | Nextcloud app-password (create one in Settings -> Security)
+
+##### Example 
+
+```yaml
+- type: nextcloud-stats
+  useProxy: true
+  options:
+    hostname: https://nextcloud.example.com
+    username: alice
+    password: xxxxx-xxxxx-xxxxx-xxxxx
+```
+
+##### Info
+- **CORS**: 🟠 Proxied
+- **Auth**: 🟢 Required
+- **Price**: 🟢 Free
+- **Host**: Self-Hosted (see [Nextcloud](https://nextcloud.com))
+- **Privacy**: _See [Nextcloud Privacy Policy](https://nextcloud.com/privacy)_
+
+---
+
+### Nextcloud PHP Opcache Stats
+
+Shows statistics about PHP Opcache perforamnce on your Nextcloud server.
+
+<p align="center"><img width="450" src="https://i.ibb.co/xf6M4J2/nextcloud-phpopcache.png" alt="nextcloud-phpopcache" /></p>
+
+##### Options
+
+**Field** | **Type** | **Required** | **Description**
+--- | --- | --- | ---
+**`hostname`** | `string` |  Required | The URL of the Nextcloud server
+**`username`** | `string` |  Required | Must be a Nextcloud admin user
+**`password`** | `string` |  Required | Nextcloud app-password (create one in Settings -> Security)
+
+##### Example 
+
+```yaml
+- type: nextcloud-stats
+  useProxy: true
+  options:
+    hostname: https://nextcloud.example.com
+    username: alice
+    password: xxxxx-xxxxx-xxxxx-xxxxx
+```
+
+##### Info
+- **CORS**: 🟠 Proxied
+- **Auth**: 🟢 Required
+- **Price**: 🟢 Free
+- **Host**: Self-Hosted (see [Nextcloud](https://nextcloud.com))
+- **Privacy**: _See [Nextcloud Privacy Policy](https://nextcloud.com/privacy)_
+
+---
+
 ## System Resource Monitoring

 The easiest method for displaying system info and resource usage in Dashy is with [Glances](https://nicolargo.github.io/glances/).