🔂 Merge master into branch
This commit is contained in:
Alicia Sykes
@@ -7,6 +7,7 @@
|
||||
|
||||
## Contents
|
||||
|
||||
- [Config not saving](#config-not-saving)
|
||||
- [Refused to Connect in Web Content View](#refused-to-connect-in-modal-or-workspace-view)
|
||||
- [404 On Static Hosting](#404-on-static-hosting)
|
||||
- [404 from Mobile Home Screen](#404-after-launch-from-mobile-home-screen)
|
||||
@@ -18,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)
|
||||
@@ -37,6 +39,7 @@
|
||||
- [Widget Displaying Inaccurate Data](#widget-displaying-inaccurate-data)
|
||||
- [Font Awesome Icons not Displaying](#font-awesome-icons-not-displaying)
|
||||
- [Copy to Clipboard not Working](#copy-to-clipboard-not-working)
|
||||
- [Unsupported Digital Envelope Routines](#unsupported-digital-envelope-routines)
|
||||
- [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)
|
||||
@@ -44,6 +47,25 @@
|
||||
|
||||
---
|
||||
|
||||
## Config not saving
|
||||
|
||||
### Possible Issue 1: Unable to call save endpoint from CDN/static server
|
||||
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.
|
||||
Look here for more information: [https://dashy.to/docs/deployment#deploy-to-cloud-service](https://dashy.to/docs/deployment#deploy-to-cloud-service)
|
||||
|
||||
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)
|
||||
|
||||
### Possible Issue 2: Unable to save
|
||||
In Docker, double check that the file isn't read-only, and that the container actually has permissions to modify it. You shouldn't really be running it as a root user, and I'm not sure if it will work if you do-
|
||||
|
||||
### Possible Issue 3: Saved but not updating
|
||||
After saving, the frontend will recompile, which may take a couple seconds (or a bit longer on a Pi or low-powered device). If it doesn't recompile, you can manually trigger a re-build.
|
||||
|
||||
---
|
||||
|
||||
## `Refused to Connect` in Modal or Workspace View
|
||||
|
||||
This is not an issue with Dashy, but instead caused by the target app preventing direct access through embedded elements.
|
||||
@@ -260,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".
|
||||
@@ -507,9 +540,11 @@ Usually, Font Awesome will be automatically enabled if one or more of your icons
|
||||
|
||||
If you are trying to use a premium icon, then you must have a [Pro License](https://fontawesome.com/plans). You'll then need to specify your Pro plan API key under `appConfig.fontAwesomeKey`. You can find this key, by logging into your FA account, navigate to Account → [Kits](https://fontawesome.com/kits) → New Kit → Copy Kit Code. The code is a 10-digit alpha-numeric code, and is also visible within the new kit's URL, for example: `81e48ce079`.
|
||||
|
||||
<p align="center"><img src="https://i.ibb.co/hZ0D9vs/where-do-i-find-my-font-awesome-key.png" width="600" /></p>
|
||||
|
||||
Be sure that you're specifying the icon category and name correctly. You're icon should look be `[category] fa-[icon-name]`. The following categories are supported: `far` _(regular)_, `fas` _(solid)_, `fal`_(light)_, `fad` _(duo-tone)_ and `fab`_(brands)_. With the exception of brands, you'll usually want all your icons to be in from same category, so they look uniform.
|
||||
|
||||
Ensure the icon you are trying to use, is available within [FontAwesome Version 5](https://fontawesome.com/v5/search).
|
||||
Ensure the icon you are trying to use, is available within [FontAwesome Version 5](https://fontawesome.com/v5/search) (we've not yet upgraded to V6, as it works a little differently).
|
||||
|
||||
Examples: `fab fa-raspberry-pi`, `fas fa-database`, `fas fa-server`, `fas fa-ethernet`
|
||||
|
||||
@@ -529,6 +564,19 @@ As a workaround, you could either:
|
||||
|
||||
---
|
||||
|
||||
## Unsupported Digital Envelope Routines
|
||||
|
||||
If you're running on GitHub Codespaces, and seeing: `Error: error:0308010C:digital envelope routines::unsupported` when using Node 17+, it can be resolved by adding the `--openssl-legacy-provider` flag to your `NODE_OPTIONS` environmental variable.
|
||||
For example:
|
||||
|
||||
```
|
||||
export NODE_OPTIONS=--openssl-legacy-provider
|
||||
```
|
||||
|
||||
This will be fixed once [webpack/webpack#17659](https://github.com/webpack/webpack/pull/17659) is merged.
|
||||
|
||||
---
|
||||
|
||||
## How to Reset Local Settings
|
||||
|
||||
Some settings are stored locally, in the browser's storage.
|
||||
|
||||
Reference in New Issue
Block a user