|
30 | 30 | - [Diagnosing Widget Errors](#widget-errors)
|
31 | 31 | - [Fixing Widget CORS Errors](#widget-cors-errors)
|
32 | 32 | - [Weather Forecast Widget 401](#weather-forecast-widget-401)
|
33 |
| -- [Keycloak Redirect Error](#keycloak-redirect-error) |
| 33 | +- [Font Awesome Icons not Displaying](#font-awesome-icons-not-displaying) |
34 | 34 | - [How-To Open Browser Console](#how-to-open-browser-console)
|
35 | 35 | - [Git Contributions not Displaying](#git-contributions-not-displaying)
|
36 | 36 |
|
37 | 37 |
|
38 | 38 | ---
|
| 39 | + |
39 | 40 | ## `Refused to Connect` in Modal or Workspace View
|
40 | 41 |
|
41 | 42 | This is not an issue with Dashy, but instead caused by the target app preventing direct access through embedded elements.
|
@@ -214,6 +215,13 @@ You should also ensure that Keycloak is correctly configured, with a user, realm
|
214 | 215 |
|
215 | 216 | For more details on how to set headers, see the [Example Headers](/docs/management.md#setting-headers) in the management docs, or reference the documentation for your proxy.
|
216 | 217 |
|
| 218 | +If you're running in Kubernetes, you will need to enable CORS ingress rules, see [docs](https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/annotations/#enable-cors), e.g: |
| 219 | + |
| 220 | +``` |
| 221 | +nginx.ingress.kubernetes.io/cors-allow-origin: "https://dashy.example.com" |
| 222 | +nginx.ingress.kubernetes.io/enable-cors: "true" |
| 223 | +``` |
| 224 | +
|
217 | 225 | See also: #479, #409, #507, #491, #341, #520
|
218 | 226 |
|
219 | 227 | ---
|
@@ -412,22 +420,19 @@ A future update will be pushed out, to use a free weather forecasting API.
|
412 | 420 |
|
413 | 421 | ---
|
414 | 422 |
|
415 |
| -## Keycloak Redirect Error |
| 423 | +## Font Awesome Icons not Displaying |
416 | 424 |
|
417 |
| -Firstly, ensure that in your Keycloak instance you have populated the Valid Redirect URIs field ([screenshot](https://user-images.githubusercontent.com/1862727/148599768-db4ee4f8-72c5-402d-8f00-051d999e6267.png)) with the URL to your Dashy instance. |
| 425 | +Usually, Font Awesome will be automatically enabled if one or more of your icons are using Font-Awesome. If this is not happening, then you can always manually enable (or disable) Font Awesome by setting: [`appConfig`](/docs/configuring.md#appconfig-optional).`enableFontAwesome` to `true`. |
418 | 426 |
|
419 |
| -You may need to specify CORS headers on your Keycloak instance, to allow requests coming from Dashy, e.g: |
| 427 | +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`. |
420 | 428 |
|
421 |
| -``` |
422 |
| -Access-Control-Allow-Origin: https://dashy.example.com |
423 |
| -``` |
| 429 | +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. |
424 | 430 |
|
425 |
| -If you're running in Kubernetes, you will need to enable CORS ingress rules, see [docs](https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/annotations/#enable-cors), e.g: |
| 431 | +Ensure the icon you are trying to use, is available within [FontAwesome Version 5](https://fontawesome.com/v5/search). |
426 | 432 |
|
427 |
| -``` |
428 |
| -nginx.ingress.kubernetes.io/cors-allow-origin: "https://dashy.example.com" |
429 |
| -nginx.ingress.kubernetes.io/enable-cors: "true" |
430 |
| -``` |
| 433 | +Examples: `fab fa-raspberry-pi`, `fas fa-database`, `fas fa-server`, `fas fa-ethernet` |
| 434 | +
|
| 435 | +Finally, check the [browser console](#how-to-open-browser-console) for any error messages, and raise a ticket if the issue persists. |
431 | 436 |
|
432 | 437 | ---
|
433 | 438 |
|
|
0 commit comments