Configure services.yaml for Homepage dashboard - service definitions, widgets, Docker integration, icons, and monitoring
Reference for configuring services in Homepage dashboard.
---
- GroupName:
- ServiceName:
href: http://service.url
# Additional properties...
| Property | Type | Required | Description |
|---|---|---|---|
href | string | Yes | URL to open when clicking |
description | string | No | Text under service name |
icon | string | No | Icon name or URL |
server |
| string |
| No |
| Docker server from docker.yaml |
container | string | No | Docker container name |
ping | string | No | Hostname for ICMP ping |
siteMonitor | string | No | URL for HTTP monitoring |
statusStyle | string | No | dot, basic, or empty |
showStats | boolean | No | Show Docker stats expanded |
target | string | No | _blank, _self, _top |
id | string | No | Custom ID for CSS/JS |
widget | object | No | Widget configuration |
widgets | array | No | Multiple widgets |
---
- Parent Group:
- Parent Service:
href: http://service.url
- Child Group:
- Child Service:
href: http://child.url
- Jellyfin:
icon: jellyfin.png
href: http://jellyfin.host:8096
server: my-docker
container: jellyfin
widget:
type: jellyfin
url: http://jellyfin.host:8096
key: { { HOMEPAGE_VAR_JELLYFIN_API_KEY } }
fields: ["activeStreams", "totalMovies"]
- Jellyfin:
widgets:
- type: jellyfin
url: http://jellyfin.host:8096
key: { { HOMEPAGE_VAR_JELLYFIN_API_KEY } }
- type: uptimekuma
url: http://uptimekuma.host
slug: jellyfin-status
| Property | Type | Description |
|---|---|---|
type | string | Widget type (see homepage-widgets skill) |
url | string | Service API URL |
key | string | API key using {{HOMEPAGE_VAR_*}} |
fields | array | Fields to display |
headers | object | Custom HTTP headers |
hideErrors | boolean | Hide error messages |
- Sonarr:
widget:
type: sonarr
fields: ["wanted", "queued"]
url: http://sonarr.host
key: { { HOMEPAGE_VAR_SONARR_API_KEY } }
- Sonarr:
widget:
type: sonarr
url: http://sonarr.host
key: { { HOMEPAGE_VAR_SONARR_API_KEY } }
highlight:
queued:
numeric:
- level: danger
when: gte
value: 20
- level: warn
when: gte
value: 5
- level: good
when: eq
value: 0
Numeric operators: gt, gte, lt, lte, eq, ne, between, outside
String operators: equals, includes, startsWith, endsWith, regex