Dockery/Homer
1
0
Fork 0
mirror of https://github.com/bastienwirtz/homer.git synced 2026-03-14 16:10:16 +01:00
Code Issues Packages Projects Releases Activity

update smart cards documentation

Browse Source
This commit is contained in:
Bastien Wirtz
2026-01-25 17:06:52 +01:00
parent e33f188267
commit 90dd2d06cd
1 changed files with 65 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
docs/customservices.md
View File

@@ -85,6 +85,10 @@ Available services are located in `src/components/`:
If a subtitle is provided, (using the `subtitle` configuration key), **it will override (hide)** any custom information displayed on the subtitle line by the custom integration.
> [!TIP]
> **Auto refresh of the card data**: Some cards support periodic update (see indication in detail below). It can be enabled or disabled globally for all service, or individually for each service using the `updateIntervalMs` configuration option.
## AdGuard Home
Displays AdGuard Home protection status and blocked query statistics.
@@ -103,6 +107,8 @@ Displays AdGuard Home protection status and blocked query statistics.
> Authorization: "Basic <base64-encoded for username:password>"
> ```
Auto refresh is supported by this integration.
## Copy to Clipboard
Displays a service card with a copy button that copies the specified text to your clipboard when clicked.
@@ -127,6 +133,8 @@ Displays counts of running, stopped, and error containers from Docker Socket Pro
endpoint: "https://my-service-api.url:port"
```
Auto refresh is supported by this integration.
## Docuseal
Displays the Docuseal version.
@@ -152,6 +160,8 @@ The `libraryType` configuration let you choose which stats to show.
libraryType: "music" # Choose which stats to show. Can be one of: music, series or movies.
```
Auto refresh is supported by this integration.
## FreshRSS
Displays unread article count and total subscriptions from your FreshRSS server.
@@ -164,6 +174,8 @@ Displays unread article count and total subscriptions from your FreshRSS server.
password: "<---your-password--->"
```
Auto refresh is supported by this integration.
## Gatus
The Gatus service displays information about the configured services from the defined Gatus server.
@@ -187,6 +199,8 @@ The average times can be hidden (saves their calculation also) by setting the fo
hideaverages: true
```
Auto refresh is supported by this integration.
## Gitea / Forgejo
Displays a Gitea / Forgejo version.
@@ -210,6 +224,8 @@ Displays system metrics (CPU, memory, swap, load) from a Glances server.
stats: [cpu, mem] # Options: load, cpu, mem, swap
```
Auto refresh is supported by this integration.
If you don't already have a glances server up and running, here is a sample Docker compose file to get you started:
```yml
@@ -237,6 +253,8 @@ Displays the number of outstanding messages and system health status.
apikey: "<---insert-client-token-here--->"
```
Auto refresh is supported by this integration.
**API Token**: Use a **client token** (not an app token).
## Healthchecks
@@ -250,6 +268,8 @@ Displays status counts (up/down/grace) from your Healthchecks monitoring service
apikey: "<---insert-api-key-here--->"
```
Auto refresh is supported by this integration.
**API Key**: Found in Healthchecks web interface under **Settings > API Access > API key (read-only)**.
## Home Assistant
@@ -290,6 +310,8 @@ Displays user count, photo/video counts, and storage usage from your Immich serv
apikey: "<---insert-api-key-here--->"
```
Auto refresh is supported by this integration.
**Requirements**: Immich server version `1.118.0` or later
**API Key**: Create an API key in Immich web interface under **Administration > API Keys**
@@ -305,6 +327,8 @@ Display the number of concurrent streams on your Jellyfin server.
apikey: "<---insert-api-key-here--->"
```
Auto refresh is supported by this integration.
**API Key**: You can create an API key in the dashboard of you Jellystat server: settings/API Keys -> Add Key
@@ -321,6 +345,8 @@ Two lines are needed in the `config.yml`:
apikey: "<---insert-api-key-here--->"
```
Auto refresh is supported by this integration.
The url must be the root url of Lidarr, Prowlarr, Readarr, Radarr or Sonarr application.
**API Key**: The Lidarr, Prowlarr, Readarr, Radarr or Sonarr API key can be found in `Settings` > `General`. It is needed to access the API.
@@ -343,6 +369,8 @@ This integration supports at max 15 results from Linkding, but you can add it mu
query: "#ToDo #Homer" # query to do on Linkding. Use #tagname to search for tags
```
Auto refresh is supported by this integration.
## Matrix
Displays a Matrix version, and shows if the server is online.
@@ -398,6 +426,8 @@ Displays the number of unread articles from your Miniflux RSS reader.
style: "status" # Either "status" or "counter"
```
Auto refresh is supported by this integration.
**API Key**: Generate an API key in Miniflux web interface under **Settings > API Keys > Create a new API key**
## Nextcloud
@@ -424,9 +454,10 @@ Moonraker's API mimics a few of OctoPrint's endpoints which makes these services
endpoint: "https://my-service-api.url:port"
apikey: "<---insert-api-key-here--->"
display: "text" # 'text' or 'bar'. Default to `text`.
```
Auto refresh is supported by this integration.
## Olivetin
Displays a Olivetin version.
@@ -505,6 +536,8 @@ Displays current status and UPS load of the UPS device.
# device: "ups" # The ID of the device
```
Auto refresh is supported by this integration.
## PiAlert
Displays stats from your PiAlert server.
@@ -516,6 +549,8 @@ Displays stats from your PiAlert server.
url: https://my-service.url
```
Auto refresh is supported by this integration.
## PiHole
Displays info about your local PiHole instance right on your Homer dashboard.
@@ -530,6 +565,8 @@ Displays info about your local PiHole instance right on your Homer dashboard.
apiVersion: 5 # optional, defaults to 5. Use 6 if your PiHole instance uses API v6
```
Auto refresh is supported by this integration.
**API Key**: Required only if Pi-hole web interface is password protected. Go to **Settings > API/Web Interface > Show API token**
**API Versions**:
@@ -554,6 +591,8 @@ Optionally, use `successCodes` to define which HTTP response status codes should
# subtitle: "Bookmark example" # By default, request round trip time is displayed when subtitle is not set
```
Auto refresh is supported by this integration.
## Plex
Displays active streams, total movies, and total TV series from your Plex server.
@@ -567,6 +606,8 @@ Displays active streams, total movies, and total TV series from your Plex server
token: "<---insert-plex-token-here--->"
```
Auto refresh is supported by this integration.
**Plex Token**: See [How to find your Plex token](https://www.plexopedia.com/plex-media-server/general/plex-token/)
## Portainer
@@ -584,6 +625,8 @@ Displays container counts (running/dead/misc), version, and online status from y
- "local"
```
Auto refresh is supported by this integration.
**Requirements**: Portainer version 1.11 or later
**API Key**: Generate an access token in Portainer UI. See [Creating an Access Token](https://docs.portainer.io/api/access#creating-an-access-token)
@@ -597,6 +640,8 @@ Displays container counts (running/dead/misc), version, and online status from y
url: https://my-service.url
```
Auto refresh is supported by this integration.
## Proxmox
Displays status information of a Proxmox node (VMs running and disk, memory and cpu used).
@@ -617,6 +662,8 @@ Displays status information of a Proxmox node (VMs running and disk, memory and
small_font_on_desktop: true # uses small font on desktops (just in case you're showing much info)
```
Auto refresh is supported by this integration.
**API Key**: You can set it up in Proxmox under Permissions > API Tokens. You also need to know the realm the user of the API Token is assigned to (by default pam).
The API Token (or the user assigned to that token if not separated permissions is checked) are this:
@@ -643,6 +690,8 @@ for setting up qBittorrent.
url: https://my-service.url # Your rTorrent web UI, f.e. ruTorrent or Flood.
```
Auto refresh is supported by this integration.
## rTorrent
Displays the global upload and download rates, as well as the number of torrents
@@ -661,6 +710,8 @@ for setting up rTorrent.
password: "password" # Password for logging into rTorrent (if applicable).
```
Auto refresh is supported by this integration.
## SABnzbd
Displays the number of currently active downloads on your SABnzbd instance.
@@ -673,6 +724,8 @@ Displays the number of currently active downloads on your SABnzbd instance.
apikey: "<---insert-api-key-here--->"
```
Auto refresh is supported by this integration.
**API Key**: An API key is required, and can be obtained from the "Config" > "General" section of the SABnzbd config in the web UI.
## Scrutiny
@@ -686,6 +739,8 @@ Displays info about the total number of disk passed and failed S.M.A.R.T and scr
url: https://my-service.url
```
Auto refresh is supported by this integration.
## SpeedtestTracker
Displays the download and upload speeds in Mbit/s and the ping in ms.
@@ -709,6 +764,8 @@ Displays the number of currently active streams on you Plex instance.
apikey: "<---insert-api-key-here--->"
```
Auto refresh is supported by this integration.
**API Key**: An API key is required, and can be obtained from the "Web Interface" section of settings on the Tautulli web UI.
Because the service type and link don't necessarily have to match, you could
@@ -735,6 +792,8 @@ Displays the number of currently queued items for transcoding on your Tdarr inst
url: https://my-service.url
```
Auto refresh is supported by this integration.
## Traefik
Displays Traefik.
@@ -763,6 +822,7 @@ The service communicates with the Transmission RPC interface which needs to be a
target: "_blank" # Optional: HTML a tag target attribute
```
Auto refresh is supported by this integration.
The service automatically handles Transmission's session management and CSRF protection.
## Truenas Scale
@@ -789,6 +849,8 @@ Displays overall status, uptime percentage, and incident information from your U
slug: "default" # status page slug, defaults to "default"
```
Auto refresh is supported by this integration.
**Requirements**: Uptime Kuma version `1.13.1` or later (for [multiple status pages support](https://github.com/louislam/uptime-kuma/releases/tag/1.13.1))
## Vaultwarden
@@ -824,3 +886,5 @@ Display info about the number of container running and the number for which an u
url: https://my-service.url
subtitle: "Docker image update notifier"
```
Auto refresh is supported by this integration.