From 9021182c2cd7b6da2b07c980d01bb8cacaf898fa Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Mon, 20 Jan 2025 12:51:08 -0800 Subject: [PATCH 1/5] Documentation: add note about ping on underlying host --- docs/configs/services.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/configs/services.md b/docs/configs/services.md index b1883043..b0887bcc 100644 --- a/docs/configs/services.md +++ b/docs/configs/services.md @@ -178,6 +178,10 @@ To use a local icon, first create a Docker mount to `/app/public/icons` and then Services may have an optional `ping` property that allows you to monitor the availability of an external host. As of v0.8.0, the ping feature attempts to use a true (ICMP) ping command on the underlying host. Currently, only IPv4 is supported. +!!! note + + Because ping uses the ping command on the underlying host, in some cases you may need to install e.g. the `iputils-ping` package on the host system. + ```yaml - Group A: - Sonarr: From cd8c7d90169d4765c9de14013d3507802aeada99 Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Mon, 20 Jan 2025 21:25:45 -0800 Subject: [PATCH 2/5] Documentation: add note about multiwidget with k8s --- docs/configs/services.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/configs/services.md b/docs/configs/services.md index b0887bcc..86970b92 100644 --- a/docs/configs/services.md +++ b/docs/configs/services.md @@ -97,6 +97,10 @@ Each service can have multiple widgets attached to it, for example: slug: statuspageslug ``` +!!! note + + Multiple widgets per service are not yet supported with Kubernetes ingress annotations. + #### Field Visibility Each widget can optionally provide a list of which fields should be visible via the `fields` widget property. If no fields are specified, then all fields will be displayed. The `fields` property must be a valid YAML array of strings. As an example, here is the entry for Sonarr showing only a couple of fields. From ae500fd983fc3fbb4f152bd4653c231de1b34b63 Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Tue, 4 Feb 2025 09:32:53 -0800 Subject: [PATCH 3/5] Update getting-started.md --- docs/widgets/authoring/getting-started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/widgets/authoring/getting-started.md b/docs/widgets/authoring/getting-started.md index 8e16b915..8ce7e1b3 100644 --- a/docs/widgets/authoring/getting-started.md +++ b/docs/widgets/authoring/getting-started.md @@ -48,7 +48,7 @@ self-hosted / open-source alternative, we ask that any widgets, etc. are develop ## New Feature or Enhancement Guidelines {#new-feature-guidelines} -- New features or enhancements, **no matter how small**, must be linked to an existing feature request. The purpose of this requirement is to avoid the addition (and maintenance) of features that might only benefit a small number of users. +- New features or enhancements, **no matter how small**, must be linked to an existing feature request with some comments or 'up-votes' that demonstrate community interest. The purpose of this requirement is to avoid the addition (and maintenance) of features that might only benefit a small number of users. - If you have ideas for a larger feature you may want to open a discussion first. ## Service Widget Guidelines From 0a1265455b89ae5254d3c6c7a124afd4dc4b2596 Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Tue, 11 Feb 2025 23:40:36 -0800 Subject: [PATCH 4/5] Update index.md --- docs/troubleshooting/index.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/troubleshooting/index.md b/docs/troubleshooting/index.md index bbde4cf3..85726cfa 100644 --- a/docs/troubleshooting/index.md +++ b/docs/troubleshooting/index.md @@ -19,7 +19,9 @@ All service widgets work essentially the same, that is, homepage makes a proxied 1. **URLs should not end with a / or other API path. Each widget will handle the path on its own.**. Including a trailing slash can result in an error. -2. Verify the homepage installation can connect to the IP address or host you are using for the widget `url`. This is most simply achieved by pinging the server from the homepage machine, in Docker this means _from inside the container_ itself, e.g.: +2. All services with a widget require a unique name. + +3. Verify the homepage installation can connect to the IP address or host you are using for the widget `url`. This is most simply achieved by pinging the server from the homepage machine, in Docker this means _from inside the container_ itself, e.g.: ``` docker exec homepage ping SERVICEIPORDOMAIN @@ -27,7 +29,7 @@ All service widgets work essentially the same, that is, homepage makes a proxied If your homepage install (container) cannot reach the service then you need to figure out why, for example in Docker this can mean putting the two containers on the same network, checking firewall issues, etc. -3. If you have verified that homepage can in fact reach the service then you can also check the API output using e.g. `curl`, which is often helpful if you do need to file a bug report. Again, depending on your networking setup this may need to be run from _inside the container_ as IP / hostname resolution can differ inside vs outside. +4. If you have verified that homepage can in fact reach the service then you can also check the API output using e.g. `curl`, which is often helpful if you do need to file a bug report. Again, depending on your networking setup this may need to be run from _inside the container_ as IP / hostname resolution can differ inside vs outside. !!! note From 477392aa29e3bd049cec1a8f81619527025efa7d Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Wed, 12 Feb 2025 16:10:19 -0800 Subject: [PATCH 5/5] Documentation: add beszel superuser note --- docs/widgets/services/beszel.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/widgets/services/beszel.md b/docs/widgets/services/beszel.md index 99715191..5d8222c9 100644 --- a/docs/widgets/services/beszel.md +++ b/docs/widgets/services/beszel.md @@ -9,6 +9,8 @@ The widget has two modes, a single system with detailed info if `systemId` is pr The `systemID` is the `id` field on the collections page of Beszel under the PocketBase admin panel. You can also use the 'nice name' from the Beszel UI. +A "superuser" is currently required to access the data from tbe Beszel API. + Allowed fields for 'overview' mode: `["systems", "up"]` Allowed fields for a single system: `["name", "status", "updated", "cpu", "memory", "disk", "network"]`