You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**`icon`** | `string` | _Optional_ | The icon for a given item or section. <br>See [Icon Docs](/docs/icons.md) for all available supported icon types, including: auto-fetched favicons, generative icons, emoji icons, home-lab service logos, font-awesome, simple-icons, material icons, and icons specified by URL
327
+
**`icon`** | `string` | _Optional_ | The icon for a given item or section. <br>See [Icon Docs](/docs/icons.md) for all available supported icon types, including: auto-fetched favicons, generative icons, emoji icons, home-lab service logos, font-awesome, simple-icons, material icons, selfh.st icons, and icons specified by URL
Copy file name to clipboardExpand all lines: docs/icons.md
+14-1Lines changed: 14 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,6 +7,7 @@ Both sections and items can have an icon, which is specified using the `icon` at
7
7
-[Simple Icons](#simple-icons)
8
8
-[Generative Icons](#generative-icons)
9
9
-[Emoji Icons](#emoji-icons)
10
+
-[selfh.st Icons](#selfhst-icons)
10
11
-[Home-Lab Icons](#home-lab-icons)
11
12
-[Material Icons](#material-design-icons)
12
13
-[Icons by URL](#icons-by-url)
@@ -63,7 +64,7 @@ Font-Awesome has a wide variety of free icons, but you can also use their pro ic
63
64
64
65
## Simple Icons
65
66
66
-
[SimpleIcons.org](https://simpleicons.org/) is a collection of 2000+ high quality, free and open source brand and logo SVG icons. Usage of which is very similar to font-awesome icons. First find the glyph you want to use on the [website](https://simpleicons.org/), then just set your icon the the simple icon slug, prefixed with `si-`.
67
+
[SimpleIcons.org](https://simpleicons.org/) is a collection of 2000+ high quality, free and open source brand and logo SVG icons. Usage of which is very similar to font-awesome icons. First find the glyph you want to use on the [website](https://simpleicons.org/), then just set your icon to the simple icon slug, prefixed with `si-`.
@@ -109,6 +110,18 @@ For example, these will all render the same rocket (🚀) emoji: `icon: ':rocket
109
110
110
111
---
111
112
113
+
## selfh.st Icons
114
+
115
+
The [selfh.st](https://selfh.st/) project provides a set of icons, originally for self-hosted services, but now expanded to include a wide variety of services. These icons can be used by specifying the icon name (without extension and with all spaces replaced with -) preceded by `sh-`. See https://selfh.st/icons/ for a full list of all available icons. For example, the Home Assistant icon is `sh-home-assistant`.
116
+
117
+
Note: These icons are fetched from the jsdelivr CDN, so if you require offline access, the [Local Icons](#local-icons) method may be a better option for you.
The [dashboard-icons](https://github.com/walkxcode/Dashboard-Icons) repo by [@WalkxCode](https://github.com/WalkxCode) provides a comprehensive collection of 360+ high-quality PNG icons for commonly self-hosted services. Dashy natively supports these icons, and you can use them just by specifying the icon name (without extension) preceded by `hl-`. See [here](https://github.com/walkxcode/Dashboard-Icons/tree/main/png) for a full list of all available icons. Note that these are fetched and cached straight from GitHub, so if you require offline access, the [Local Icons](#local-icons) method may be a better option for you.
Example: This json data was generated by a data worflow that gets the new releases of a few projects from GitHub. The system used to build the data workflow is n8n.
- This widget is designed to render data generated by another system that complies with the schema. The example JSON data above was generated using a n8n workflow, and other ETL or workflow systems can generate similar results.
1426
+
- To avoid requests to a different system in each refresh, you can save the input files locally in the user-data folder inside your Dashy installation.
1427
+
- To use json files from a different domain, remember to add `useProxy: true` to the widget configuration. I have not tested this use case because I save all my input data locally on the Dashy server. Please open a ticket if you have an issue in this use case.
1428
+
1429
+
#### Example
1430
+
1431
+
This widget renders a json file that from a `json-data` directory inside the `user-data` directory on the Dashy server.
1432
+
```yaml
1433
+
- type: custom-list
1434
+
options:
1435
+
url: /json-data/github-releases.json
1436
+
title: 'Github Releases'
1437
+
daysForNew: 5
1438
+
```
1439
+
1440
+
#### Info
1441
+
1442
+
- **CORS**: 🟢 Not needed for files hosted inside the `user-data` directory. Use `useProxy: true` to bypass CORS restrictions when using data from a different server.
1443
+
- **Auth**: 🟢 Not Required
1444
+
- **Price**: 🟢 Free
1445
+
- **Host**: user defined
1446
+
- **Privacy**: depends on the user defined host.
1447
+
1448
+
---
1449
+
1301
1450
### Custom search
1302
1451
1303
1452
Allows web search using multiple user-defined search engines and other websites.
0 commit comments