From c7f165273fe6e055a31ee23dcc180b91ab8119ec Mon Sep 17 00:00:00 2001 From: Alicia Sykes Date: Sun, 27 Jun 2021 09:05:05 +0100 Subject: [PATCH] :memo: Documents 2 new statusCheck properties --- docs/configuring.md | 2 ++ src/utils/ConfigSchema.json | 8 ++++++++ 2 files changed, 10 insertions(+) diff --git a/docs/configuring.md b/docs/configuring.md index 1467a114..47bc101a 100644 --- a/docs/configuring.md +++ b/docs/configuring.md @@ -106,6 +106,8 @@ All fields are optional, unless otherwise stated. **`icon`** | `string` | _Optional_ | The icon for a given item. Can be a font-awesome icon, favicon, remote URL or local URL. See [`item.icon`](#sectionicon-and-sectionitemicon) **`target`** | `string` | _Optional_ | The opening method for when the item is clicked, either `newtab`, `sametab`, `modal` or `workspace`. Where `newtab` will open the link in a new tab, `sametab` will open it in the current tab, and `modal` will open a pop-up modal with the content displayed within that iframe. Note that for the iframe to load, you must have set the CORS headers to either allow `*` ot allow the domain that you are hosting Dashy on, for some websites and self-hosted services, this is already set. **`statusCheck`** | `boolean` | _Optional_ | When set to `true`, Dashy will ping the URL associated with the current service, and display its status as a dot next to the item. The value here will override `appConfig.statusCheck` so you can turn off or on checks for a given service. Defaults to `appConfig.statusCheck`, falls back to `false` +**`statusCheckUrl`** | `string` | _Optional_ | If you've enabled `statusCheck`, and want to use a different URL to what is defined under the item, then specify it here +**`statusCheckHeaders`** | `object` | _Optional_ | If you're endpoint requires any specific headers for the status checking, then define them here **`color`** | `string` | _Optional_ | An optional color for the text and font-awesome icon to be displayed in. Note that this will override the current theme and so may not display well **`backgroundColor`** | `string` | _Optional_ | An optional background fill color for the that given item. Again, this will override the current theme and so might not display well against the background diff --git a/src/utils/ConfigSchema.json b/src/utils/ConfigSchema.json index da0e69e8..b47d82c5 100644 --- a/src/utils/ConfigSchema.json +++ b/src/utils/ConfigSchema.json @@ -341,6 +341,14 @@ "type": "boolean", "default": false, "description": "Whether or not to display online/ offline status for this service. Will override appConfig.statusCheck" + }, + "statusCheckUrl": { + "type": "string", + "description": "If you've enabled statusCheck, and want to use a different URL to what is defined under the item, then specify it here" + }, + "statusCheckHeaders": { + "type": "object", + "description": " If you're endpoint requires any specific headers for the status checking, then define them here" } } }