From f5f82d5b9be71163dd4a08442f282f1e07506427 Mon Sep 17 00:00:00 2001 From: liss-bot Date: Sun, 20 Jul 2025 01:34:00 +0000 Subject: [PATCH] Auto Publish new pages --- configuring.md | 6 +- credits.md | 408 ++++++++++++++++++++++++++++++------------------- icons.md | 15 +- widgets.md | 149 ++++++++++++++++++ 4 files changed, 421 insertions(+), 157 deletions(-) diff --git a/configuring.md b/configuring.md index c10088f..a058d07 100644 --- a/configuring.md +++ b/configuring.md @@ -93,7 +93,9 @@ The following file provides a reference of all supported configuration options. **Field** | **Type** | **Required**| **Description** --- | --- | --- | --- **`name`** | `string` | Required | A unique name for that page -**`path`** | `string` | Required | The path (local or remote) to the config file to use.
For files located within `/public`, you only need to specify filename, for externally hosted files you must include the full URL +**`path`** | `string` | Required | The path (local or remote) to the config file to use.
For files located within `/user-data`, you only need to specify filename, for externally hosted files you must include the full URL + +For more info, see the[Multi-Page docs](/docs/pages-and-sections.md#multi-page-support) **[⬆️ Back to Top](#configuring)** @@ -320,7 +322,7 @@ For more info, see the **[Authentication Docs](/docs/authentication.md)** **Field** | **Type** | **Required**| **Description** --- | --- | --- | --- -**`icon`** | `string` | _Optional_ | The icon for a given item or section.
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 +**`icon`** | `string` | _Optional_ | The icon for a given item or section.
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 **[⬆️ Back to Top](#configuring)** diff --git a/credits.md b/credits.md index 107fdf2..490a6d0 100644 --- a/credits.md +++ b/credits.md @@ -232,6 +232,13 @@ Josua Blejeru + + + ThrustVector +
+ Johan Bengtsson + + evroon @@ -259,15 +266,15 @@
Kristian Brasel - + + albcp
Alberto - - + alhazmy13 @@ -282,6 +289,13 @@ Chris Nielsen + + + LinuxSBC +
+ LinuxSBC + + UrekD @@ -289,6 +303,21 @@ UrekD + + + hockwill +
+ Null + + + + + + z3r0l1nk +
+ Mihai + + zcq100 @@ -296,21 +325,6 @@ Null - - - hockwill -
- Null - - - - - z3r0l1nk -
- Mihai - - - wozboz @@ -325,13 +339,21 @@ Null + + + dasunsrule32 +
+ Aaron Echols + + aviolaris
Andreas Violaris - + + Tracreed @@ -339,21 +361,13 @@ David Alasow - - - dasunsrule32 -
- Aaron Echols - - Totto16
Totto16 - - + toddejohnson @@ -381,7 +395,8 @@
Rtm516 - + + onedr0p @@ -389,47 +404,32 @@ ᗪєνιη ᗷυнʟ + + + he0119 +
+ Uy/sun + + stanly0726
Stanly0726 - - + - - kt-alt + + alayham
- Null + Al-Ayham Saleh - - Bogyie + + alucarddelta
- Bogyeong Kim - - - - - webysther -
- Webysther Sperandio - - - - - jtuzar -
- Jakub Tuzar - - - - - lucolvin -
- Luke + Brent @@ -441,17 +441,53 @@ - - alucarddelta + + Kf637
- Brent + Kf637 - - BySempron + + lucolvin
- Sergio + Luke + + + + + jtuzar +
+ Jakub Tuzar + + + + + webysther +
+ Webysther Sperandio + + + + + Bogyie +
+ Bogyeong Kim + + + + + kt-alt +
+ Null + + + + + + zigotica +
+ Sergi Meseguer @@ -462,10 +498,10 @@ - - zigotica + + BySempron
- Sergi Meseguer + Sergio @@ -481,15 +517,15 @@
Patrick Heeney - - + mmihaly
Null - + + m42cel @@ -511,21 +547,13 @@ Joey Miller - - - alayham -
- Al-Ayham Saleh - - alexdelprete
Alessandro Del Prete - - + a-mnich @@ -539,7 +567,8 @@
Stephen Rigney - + + moemoeq @@ -567,15 +596,22 @@
GuilhermeLCS - - + + + + kit494way +
+ KITAGAWA Yasutaka + + TJonesy
Taylor Jones - + + twsouthwick @@ -590,6 +626,13 @@ Thomas Wienecke + + + armageddon421 +
+ Armageddon421 + + hockeymikey @@ -597,28 +640,21 @@ Null - - - turnrye -
- Ryan Turner - - sachahjkl
Sacha - - + shazzx
Shazz - + + ThinkSalat @@ -653,15 +689,15 @@
Stavros Kois - - + XenonR
Steffen Schmidt - + + StevKast @@ -669,6 +705,27 @@ Steven Kast + + + ThibautSnoeijs +
+ Thibaut + + + + + vishwamartur +
+ Vishwanath Martur + + + + + turnrye +
+ Ryan Turner + + rubjo @@ -676,6 +733,21 @@ Null + + + RoubenRehman +
+ Rouben Rehman + + + + + + RobLoach +
+ Rob Loach + + PrynsTag @@ -696,8 +768,7 @@
OKAMOTO Shigehiro - - + bubylou @@ -711,7 +782,8 @@
Michael Feinbier - + + stinkybernie @@ -726,21 +798,6 @@ Michael Lavaire - - - imsakg -
- Mert Sefa AKGUN - - - - - maximemoreillon -
- Maxime Moreillon - - - AmadeusGraves @@ -748,6 +805,13 @@ Ángel Fernández Sánchez + + + click0 +
+ Vladyslav V. Prodan + + tazboyz16 @@ -761,7 +825,8 @@
José Ignacio - + + soaibsafi @@ -769,6 +834,20 @@ Soaibuzzaman + + + sasetz +
+ Kirill Putiatin + + + + + s-weigand +
+ Sebastian Weigand + + pablomalo @@ -782,15 +861,15 @@
Noé Busson - - + markxoe
Mark Oude Elberink - + + ivyturner @@ -825,15 +904,15 @@
Imlonghao - - + icy-comet
Aniket Teredesai - + + huangshaohuai @@ -868,27 +947,34 @@
Xert - - + willbrowningme
Will Browning - + + - - ThibautSnoeijs + + imsakg
- Thibaut + Mert Sefa AKGUN - - Glitch3dPenguin + + pvillaverde
- Max Kulik + Fedello + + + + + emiran-orange +
+ Null @@ -1034,14 +1120,35 @@ 0n1cOn3 + + + maximemoreillon +
+ Maxime Moreillon + + + + + + Glitch3dPenguin +
+ Max Kulik + + + + + pho3nixf1re +
+ Matthew Turney + + markusdd
Markus Krause - - + asenov @@ -1062,7 +1169,8 @@
Leonardo Colman Lopes - + + KierenConnell @@ -1077,14 +1185,20 @@ Kieran + + + SharpCoder +
+ Josh Cole + + johnhorton2010
John Horton - - + Singebob @@ -1098,7 +1212,8 @@
Jemy SCHNEPP - + + jjmung @@ -1126,8 +1241,7 @@
Ian Neal - - + ip2location @@ -1141,7 +1255,8 @@
Hendrik Strydom - + + hubortje @@ -1162,21 +1277,6 @@
FormatToday - - - - pvillaverde -
- Fedello - - - - - - emiran-orange -
- Null - diff --git a/icons.md b/icons.md index 4a592d9..67ef94f 100644 --- a/icons.md +++ b/icons.md @@ -7,6 +7,7 @@ Both sections and items can have an icon, which is specified using the `icon` at - [Simple Icons](#simple-icons) - [Generative Icons](#generative-icons) - [Emoji Icons](#emoji-icons) +- [selfh.st Icons](#selfhst-icons) - [Home-Lab Icons](#home-lab-icons) - [Material Icons](#material-design-icons) - [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 ## Simple Icons -[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-`. +[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 --- +## selfh.st Icons + +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`. + +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. + +

+ +

+ +--- + ## Home-Lab Icons 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. diff --git a/widgets.md b/widgets.md index 878cf8d..b1a4c47 100644 --- a/widgets.md +++ b/widgets.md @@ -1298,6 +1298,155 @@ In other words: Private, noncomercial, moderate use of the API is tolerated. The --- +### Custom List + +Renders custom schema-compliant JOSN in a list. + +#### Options +**Field** | **Type** | **Required** | **Description** +--- | --- | --- | --- +**`url`** | `text` | Required | A string containing the url of a json file. +**`title`** | `text` | optional | A title for the widget. Can be helpful if stacking multiple lists in the same section. +**`daysForNew`** | `number` | Optional | Used to highlight new items. + +#### Json Schema +The input file should comply with the following schema: +```json +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "array", + "items": [ + { + "type": "object", + "properties": { + "link": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "url": { + "type": "string" + }, + "title": { + "type": "string" + } + }, + "required": [ + "text", + "url", + "title" + ] + }, + "value": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "title": { + "type": "string" + } + }, + "required": [ + "text", + "title" + ] + }, + "date": { + "type": "string" + } + }, + "required": [ + "link", + "value", + "date" + ] + } + ] +} +``` + +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. + +```json +[ + { + "link": { + "text": "jellyfin/jellyfin", + "url": "https://github.com/jellyfin/jellyfin/releases/tag/v10.10.7", + "title": "" + }, + "value": { + "text": "v10.10.7", + "title": "2025-04-05" + }, + "date": "2025-04-05T19:14:59Z" + }, + { + "link": { + "text": "jellyfin/jellyfin-web", + "url": "https://github.com/jellyfin/jellyfin-web/releases/tag/v10.10.7", + "title": "" + }, + "value": { + "text": "v10.10.7", + "title": "2025-04-05" + }, + "date": "2025-04-05T19:15:00Z" + }, + { + "link": { + "text": "lissy93/dashy", + "url": "https://github.com/Lissy93/dashy/releases/tag/3.1.1", + "title": "" + }, + "value": { + "text": "3.1.1", + "title": "2024-05-30" + }, + "date": "2024-05-30T17:20:53Z" + }, + { + "link": { + "text": "VSCodium/vscodium", + "url": "https://github.com/VSCodium/vscodium/releases/tag/1.102.14746", + "title": "" + }, + "value": { + "text": "1.102.14746", + "title": "2025-07-16" + }, + "date": "2025-07-16T18:27:49Z" + } +] +``` +#### Notes +- 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. +- 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. +- 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. + +#### Example + +This widget renders a json file that from a `json-data` directory inside the `user-data` directory on the Dashy server. +```yaml + - type: custom-list + options: + url: /json-data/github-releases.json + title: 'Github Releases' + daysForNew: 5 +``` + +#### Info + +- **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. +- **Auth**: 🟢 Not Required +- **Price**: 🟢 Free +- **Host**: user defined +- **Privacy**: depends on the user defined host. + +--- + ### Custom search Allows web search using multiple user-defined search engines and other websites.