Homepage has two types of widgets: info and service. Below we'll cover each type and how to configure them.

The left navigation of this site contains links to all available widgets.

Service Widgets#

Service widgets are used to display the status of a service, often a web service or API. Services (and their widgets) are defined in your services.yaml file. Here's an example:

- Plex:
    icon: plex.png
    href: https://plex.my.host
    description: Watch movies and TV shows.
    server: localhost
    container: plex
    widgets:
      - type: tautulli
        url: http://172.16.1.1:8181
        key: aabbccddeeffgghhiijjkkllmmnnoo
      - type: uptimekuma
        url: http://172.16.1.2:8080
        slug: aaaaaaabbbbb

More detail on configuring service widgets can be found in the Service Widgets Config section.

Info Widgets#

Info widgets are used to display information in the header, often about your system or environment. Info widgets are defined in your widgets.yaml file. Here's an example:

- openmeteo:
    label: Current
    latitude: 36.66
    longitude: -117.51
    cache: 5

More detail on configuring info widgets can be found in the Info Widgets Config section.