Homepage has been covered by quite a few YouTube channels, here are some of them. If you have a video you'd like to add, please open a PR!
+
+
First, clone the homepage repository.
For installing NPM packages, this project uses pnpm (and so should you!):
diff --git a/main/more/homepage-move/index.html b/main/more/homepage-move/index.html index 142fba5d2c5..ebb9406a291 100644 --- a/main/more/homepage-move/index.html +++ b/main/more/homepage-move/index.html @@ -13,7 +13,7 @@ - + @@ -100,13 +100,14 @@A modern, fully static, fast, secure fully proxied, highly customizable application dashboard with integrations for over 100 services and translations into multiple languages. Easily configured via YAML files or through docker label discovery.
Homepage builds are kindly powered by DigitalOcean.
"},{"location":"configs/","title":"Configuration","text":"Homepage uses YAML for configuration, YAML stands for \"YAML Ain't Markup Language.\". It's a human-readable data serialization format that's a superset of JSON. Great for config files, easy to read and write. Supports complex data types like lists and objects. Indentation matters. If you already use Docker Compose, you already use YAML.
Here are some tips when writing YAML:
You can find tons of online YAML validators, here's one: https://codebeautify.org/yaml-validator, heres another: https://jsonformatter.org/yaml-validator.
"},{"location":"configs/bookmarks/","title":"Bookmarks","text":"Bookmarks are configured in the bookmarks.yaml file. They function much the same as Services, in how groups and lists work. They're just much simpler, smaller, and contain no extra features other than being a link out.
The design of homepage expects abbr to be 2 letters, but is not otherwise forced.
You can also use an icon for bookmarks similar to the options for service icons. If both icon and abbreviation are supplied, the icon takes precedence.
By default, the description will use the hostname of the link, but you can override it with a custom description.
---\n- Developer:\n - Github:\n - abbr: GH\n href: https://github.com/\n\n- Social:\n - Reddit:\n - icon: reddit.png\n href: https://reddit.com/\n description: The front page of the internet\n\n- Entertainment:\n - YouTube:\n - abbr: YT\n href: https://youtube.com/\nwhich renders to (depending on your theme, etc.):
The default bookmarks.yaml is a working example.
"},{"location":"configs/custom-css-js/","title":"Custom CSS & JS","text":"As of version v0.6.30 homepage supports adding your own custom css & javascript. Please do so at your own risk.
To add custom css simply edit the custom.css file under your config directory, similarly for javascript you would edit custom.js. You can then target elements in homepage with various classes / ids to customize things to your liking.
You can also set a specific id for a service or bookmark to target with your custom css or javascript, e.g.
Service:\n id: myserviceid\n icon: icon.png\n ...\nDocker instances are configured inside the docker.yaml file. Both IP:PORT and Socket connections are supported.
For IP:PORT, simply make sure your Docker instance has been configured to accept API traffic over the HTTP API.
my-remote-docker:\n host: 192.168.0.101\n port: 2375\nSince Docker supports connecting with TLS and client certificate authentication, you can include TLS details when connecting to the HTTP API. Further details of setting up Docker to accept TLS connections, and generation of the keys and certs can be found in the Docker documentation. The file entries are relative to the config directory (location of docker.yaml file).
my-remote-docker:\n host: 192.168.0.101\n port: 275\n tls:\n keyFile: tls/key.pem\n caFile: tls/ca.pem\n certFile: tls/cert.pem\nDue to security concerns with exposing the docker socket directly, you can use a docker-socket-proxy container to expose the docker socket on a more restricted and secure API.
Here is an example docker-compose file that will expose the docker socket, and then connect to it from the homepage container:
dockerproxy:\n image: ghcr.io/tecnativa/docker-socket-proxy:latest\n container_name: dockerproxy\n environment:\n - CONTAINERS=1 # Allow access to viewing containers\n - SERVICES=1 # Allow access to viewing services (necessary when using Docker Swarm)\n - TASKS=1 # Allow access to viewing tasks (necessary when using Docker Swarm)\n - POST=0 # Disallow any POST operations (effectively read-only)\n ports:\n - 127.0.0.1:2375:2375\n volumes:\n - /var/run/docker.sock:/var/run/docker.sock:ro # Mounted as read-only\n restart: unless-stopped\n\nhomepage:\n image: ghcr.io/gethomepage/homepage:latest\n container_name: homepage\n volumes:\n - /path/to/config:/app/config\n ports:\n - 3000:3000\n restart: unless-stopped\nThen, inside of your docker.yaml settings file, you'd configure the docker instance like so:
my-docker:\n host: dockerproxy\n port: 2375\nIf you'd rather use the socket directly, first make sure that you're passing the local socket into the Docker container.
Note
In order to use the socket directly homepage must be running as root
homepage:\n image: ghcr.io/gethomepage/homepage:latest\n container_name: homepage\n volumes:\n - /path/to/config:/app/config\n - /var/run/docker.sock:/var/run/docker.sock # pass local proxy\n ports:\n - 3000:3000\n restart: unless-stopped\nIf you're using docker run, this would be -v /var/run/docker.sock:/var/run/docker.sock.
Then, inside of your docker.yaml settings file, you'd configure the docker instance like so:
my-docker:\n socket: /var/run/docker.sock\nOnce you've configured your docker instances, you can then apply them to your services, to get stats and status reporting shown.
Inside of the service you'd like to connect to docker:
- Emby:\n icon: emby.png\n href: \"http://emby.home/\"\n description: Media server\n server: my-docker # The docker server that was configured\n container: emby # The name of the container you'd like to connect\nHomepage features automatic service discovery for containers with the proper labels attached, all configuration options can be applied using dot notation, beginning with homepage.
Below is an example of the same service entry shown above, as docker labels.
services:\n emby:\n image: lscr.io/linuxserver/emby:latest\n container_name: emby\n ports:\n - 8096:8096\n restart: unless-stopped\n labels:\n - homepage.group=Media\n - homepage.name=Emby\n - homepage.icon=emby.png\n - homepage.href=http://emby.home/\n - homepage.description=Media server\nWhen your Docker instance has been properly configured, this service will be automatically discovered and added to your Homepage. You do not need to specify the server or container values, as they will be automatically inferred.
When using docker swarm use deploy/labels
"},{"location":"configs/docker/#widgets","title":"Widgets","text":"You may also configure widgets, along with the standard service entry, again, using dot notation.
labels:\n - homepage.group=Media\n - homepage.name=Emby\n - homepage.icon=emby.png\n - homepage.href=http://emby.home/\n - homepage.description=Media server\n - homepage.widget.type=emby\n - homepage.widget.url=http://emby.home\n - homepage.widget.key=yourembyapikeyhere\n - homepage.widget.fields=[\"field1\",\"field2\"] # optional\nYou can add specify fields for e.g. the CustomAPI widget by using array-style dot notation:
labels:\n - homepage.group=Media\n - homepage.name=Emby\n - homepage.icon=emby.png\n - homepage.href=http://emby.home/\n - homepage.description=Media server\n - homepage.widget.type=customapi\n - homepage.widget.url=http://argus.service/api/v1/service/summary/emby\n - homepage.widget.mappings[0].label=Deployed Version\n - homepage.widget.mappings[0].field.status=deployed_version\n - homepage.widget.mappings[1].label=Latest Version\n - homepage.widget.mappings[1].field.status=latest_version\nDocker swarm is supported and Docker services are specified with the same server and container notation. To enable swarm support you will need to include a swarm setting in your docker.yaml, e.g.
my-docker:\n socket: /var/run/docker.sock\n swarm: true\nFor the automatic service discovery to discover all services it is important that homepage should be deployed on a manager node. Set deploy requirements to the master node in your stack yaml config, e.g.
....\n deploy:\n placement:\n constraints:\n - node.role == manager\n...\nIn order to detect every service within the Docker swarm it is necessary that service labels should be used and not container labels. Specify the homepage labels as:
....\n deploy:\n labels:\n - homepage.icon=foobar\n...\nThe optional field instanceName can be configured in settings.md to differentiate between multiple homepage instances.
To limit a label to an instance, insert .instance.{{instanceName}} after the homepage prefix.
labels:\n - homepage.group=Media\n - homepage.name=Emby\n - homepage.icon=emby.png\n - homepage.instance.internal.href=http://emby.lan/\n - homepage.instance.public.href=https://emby.mydomain.com/\n - homepage.description=Media server\nAs of v0.6.4 discovered services can include an optional weight field to determine sorting such that:
You can show the docker stats by clicking the status indicator but this can also be controlled per-service with:
- Example Service:\n ...\n showStats: true\nAlso see the settings for show docker stats.
"},{"location":"configs/kubernetes/","title":"Kubernetes","text":"The Kubernetes connectivity has the following requirements:
The Kubernetes connection is configured in the kubernetes.yaml file. There are 3 modes to choose from:
mode: default\nOnce the Kubernetes connection is configured, individual services can be configured to pull statistics. Only CPU and Memory are currently supported.
Inside of the service you'd like to connect to a pod:
- Emby:\n icon: emby.png\n href: \"http://emby.home/\"\n description: Media server\n namespace: media # The kubernetes namespace the app resides in\n app: emby # The name of the deployed app\nThe app field is used to create a label selector, in this example case it would match pods with the label: app.kubernetes.io/name=emby.
Sometimes this is insufficient for complex or atypical application deployments. In these cases, the pod-selector field can be used. Any field selector can be used with it, so it allows for some very powerful selection capabilities.
For instance, it can be utilized to roll multiple underlying deployments under one application to see a high-level aggregate:
- Element Chat:\n icon: matrix-light.png\n href: https://chat.example.com\n description: Matrix Synapse Powered Chat\n app: matrix-element\n namespace: comms\n pod-selector: >-\n app.kubernetes.io/instance in (\n matrix-element,\n matrix-media-repo,\n matrix-media-repo-postgresql,\n matrix-synapse\n )\nNote
A blank string as a pod-selector does not deactivate it, but will actually select all pods in the namespace. This is a useful way to capture the resource usage of a complex application siloed to a single namespace, like Longhorn.
"},{"location":"configs/kubernetes/#automatic-service-discovery","title":"Automatic Service Discovery","text":"Homepage features automatic service discovery by Ingress annotations. All configuration options can be applied using typical annotation syntax, beginning with gethomepage.dev/.
apiVersion: networking.k8s.io/v1\nkind: Ingress\nmetadata:\n name: emby\n annotations:\n gethomepage.dev/enabled: \"true\"\n gethomepage.dev/description: Media Server\n gethomepage.dev/group: Media\n gethomepage.dev/icon: emby.png\n gethomepage.dev/name: Emby\n gethomepage.dev/widget.type: \"emby\"\n gethomepage.dev/widget.url: \"https://emby.example.com\"\n gethomepage.dev/pod-selector: \"\"\n gethomepage.dev/weight: 10 # optional\n gethomepage.dev/instance: \"public\" # optional\nspec:\n rules:\n - host: emby.example.com\n http:\n paths:\n - backend:\n service:\n name: emby\n port:\n number: 8080\n path: /\n pathType: Prefix\nWhen the Kubernetes cluster connection has been properly configured, this service will be automatically discovered and added to your Homepage. You do not need to specify the namespace or app values, as they will be automatically inferred.
If you are using multiple instances of homepage, an instance annotation can be specified to limit services to a specific instance. If no instance is provided, the service will be visible on all instances.
If you have a single service that needs to be shown on multiple specific instances of homepage (but not on all of them), the service can be annotated by multiple instance.name annotations, where name can be the names of your specific multiple homepage instances. For example, a service that is annotated with gethomepage.dev/instance.public: \"\" and gethomepage.dev/instance.internal: \"\" will be shown on public and internal homepage instances.
Homepage can also read ingresses defined using the Traefik IngressRoute custom resource definition. Due to the complex nature of Traefik routing rules, it is required for the gethomepage.dev/href annotation to be set:
apiVersion: traefik.io/v1alpha1\nkind: IngressRoute\nmetadata:\n name: emby\n annotations:\n gethomepage.dev/href: \"https://emby.example.com\"\n gethomepage.dev/enabled: \"true\"\n gethomepage.dev/description: Media Server\n gethomepage.dev/group: Media\n gethomepage.dev/icon: emby.png\n gethomepage.dev/app: emby-app # optional, may be needed if app.kubernetes.io/name != ingress metadata.name\n gethomepage.dev/name: Emby\n gethomepage.dev/widget.type: \"emby\"\n gethomepage.dev/widget.url: \"https://emby.example.com\"\n gethomepage.dev/pod-selector: \"\"\n gethomepage.dev/weight: 10 # optional\n gethomepage.dev/instance: \"public\" # optional\nspec:\n entryPoints:\n - websecure\n routes:\n - kind: Rule\n match: Host(`emby.example.com`)\n services:\n - kind: Service\n name: emby\n namespace: emby\n port: 8080\n scheme: http\n strategy: RoundRobin\n weight: 10\nIf the href attribute is not present, Homepage will ignore the specific IngressRoute.
Similarly to Docker service discovery, there currently is no rigid ordering to discovered services and discovered services will be displayed above those specified in the services.yaml.
Unless otherwise noted, URLs should not end with a / or other API path. Each widget will handle the path on its own.
Each service can have one widget attached to it (often matching the service type, but that's not forced).
In addition to the href of the service, you can also specify the target location in which to open that link. See Link Target for more details.
Using Emby as an example, this is how you would attach the Emby service widget.
- Emby:\n icon: emby.png\n href: http://emby.host.or.ip/\n description: Movies & TV Shows\n widget:\n type: emby\n url: http://emby.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\nEach 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.
In all cases a widget will work and display all fields without specifying the fields property.
- Sonarr:\n icon: sonarr.png\n href: http://sonarr.host.or.ip\n widget:\n type: sonarr\n fields: [\"wanted\", \"queued\"]\n url: http://sonarr.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\nServices are configured inside the services.yaml file. You can have any number of groups, and any number of services per group.
Groups are defined as top-level array entries.
- Group A:\n - Service A:\n href: http://localhost/\n\n- Group B:\n - Service B:\n href: http://localhost/\nServices are defined as array entries on groups,
- Group A:\n - Service A:\n href: http://localhost/\n\n - Service B:\n href: http://localhost/\n\n - Service C:\n href: http://localhost/\n\n- Group B:\n - Service D:\n href: http://localhost/\nServices may have descriptions,
- Group A:\n - Service A:\n href: http://localhost/\n description: This is my service\n\n- Group B:\n - Service B:\n href: http://localhost/\n description: This is another service\nServices may have an icon attached to them, you can use icons from Dashboard Icons automatically, by passing the name of the icon, with, or without .png or with .svg to use the svg version.
You can also specify prefixed icons from Material Design Icons with mdi-XX or Simple Icons with si-XX.
You can specify a custom color by adding a hex color code as suffix e.g. mdi-XX-#f0d453 or si-XX-#a712a2.
To use a remote icon, use the absolute URL (e.g. https://...).
To use a local icon, first create a Docker mount to /app/public/icons and then reference your icon as /icons/myicon.png. You will need to restart the container when adding new icons.
Warning
Material Design Icons for brands were deprecated and may be removed in the future. Using Simple Icons for brand icons will prevent any issues if / when the Material Design Icons are removed.
- Group A:\n - Sonarr:\n icon: sonarr.png\n href: http://sonarr.host/\n description: Series management\n\n- Group B:\n - Radarr:\n icon: radarr.png\n href: http://radarr.host/\n description: Movie management\n\n- Group C:\n - Service:\n icon: mdi-flask-outline\n href: http://service.host/\n description: My cool service\nServices 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.
- Group A:\n - Sonarr:\n icon: sonarr.png\n href: http://sonarr.host/\n ping: sonarr.host\n\n- Group B:\n - Radarr:\n icon: radarr.png\n href: http://radarr.host/\n ping: some.other.host\nYou can also apply different styles to the ping indicator by using the statusStyle property, see settings.
Services may have an optional siteMonitor property (formerly ping) that allows you to monitor the availability of a URL you chose and have the response time displayed. You do not need to set your monitor URL equal to your href or ping URL.
Note
The site monitor feature works by making an http HEAD request to the URL, and falls back to GET in case that fails. It will not, for example, login if the URL requires auth or is behind e.g. Authelia. In the case of a reverse proxy and/or auth this usually requires the use of an 'internal' URL to make the site monitor feature correctly display status.
- Group A:\n - Sonarr:\n icon: sonarr.png\n href: http://sonarr.host/\n siteMonitor: http://sonarr.host/\n\n- Group B:\n - Radarr:\n icon: radarr.png\n href: http://radarr.host/\n siteMonitor: http://some.other.host/\nYou can also apply different styles to the site monitor indicator by using the statusStyle property, see settings.
Services may be connected to a Docker container, either running on the local machine, or a remote machine.
- Group A:\n - Service A:\n href: http://localhost/\n description: This is my service\n server: my-server\n container: my-container\n\n- Group B:\n - Service B:\n href: http://localhost/\n description: This is another service\n server: other-server\n container: other-container\nClicking on the status label of a service with Docker integration enabled will expand the container stats, where you can see CPU, Memory, and Network activity.
Note
This can also be controlled with showStats. See show docker stats for more information
Services may also have a service widget (or integration) attached to them, this works independently of the Docker integration.
You can find information and configuration for each of the supported integrations on the Widgets page.
Here is an example of a Radarr & Sonarr service, with their respective integrations.
- Group A:\n - Sonarr:\n icon: sonarr.png\n href: http://sonarr.host/\n description: Series management\n widget:\n type: sonarr\n url: http://sonarr.host\n key: apikeyapikeyapikeyapikeyapikey\n\n- Group B:\n - Radarr:\n icon: radarr.png\n href: http://radarr.host/\n description: Movie management\n widget:\n type: radarr\n url: http://radarr.host\n key: apikeyapikeyapikeyapikeyapikey\nThe settings.yaml file allows you to define application level options. For changes made to this file to take effect, you will need to regenerate the static HTML, this can be done by clicking the refresh icon in the bottom right of the page.
You can customize the title of the page if you'd like.
title: My Awesome Homepage\nYou can customize the start_url as required for installable apps. The default is \"/\".
startUrl: https://custom.url\nHeads Up!
You will need to restart the container any time you add new images, this is a limitation of the Next.js static site server.
Heads Up!
Do not create a bind mount to the entire /app/public/ directory.
If you'd like to use a background image instead of the solid theme color, you may provide a full URL to an image of your choice.
background: https://images.unsplash.com/photo-1502790671504-542ad42d5189?auto=format&fit=crop&w=2560&q=80\nOr you may pass the path to a local image relative to e.g. /app/public/images directory.
For example, inside of your Docker Compose file, mount a path to where your images are kept:
volumes:\n - /my/homepage/images:/app/public/images\nand then reference that image:
background: /images/background.png\nYou can specify filters to apply over your background image for blur, saturation and brightness as well as opacity to blend with the background color. The first three filter settings use tailwind CSS classes, see notes below regarding the options for each. You do not need to specify all options.
background:\n image: /images/background.png\n blur: sm # sm, \"\", md, xl... see https://tailwindcss.com/docs/backdrop-blur\n saturate: 50 # 0, 50, 100... see https://tailwindcss.com/docs/backdrop-saturate\n brightness: 50 # 0, 50, 75... see https://tailwindcss.com/docs/backdrop-brightness\n opacity: 50 # 0-100\nYou can apply a blur filter to the service & bookmark cards. Note this option is incompatible with the background blur, saturate and brightness filters.
cardBlur: sm # sm, \"\", md, etc... see https://tailwindcss.com/docs/backdrop-blur\nIf you'd like to use a custom favicon instead of the included one, you may provide a full URL to an image of your choice.
favicon: https://www.google.com/favicon.ico\nOr you may pass the path to a local image relative to the /app/public directory. See Background Image for more detailed information on how to provide your own files.
You can configure a fixed theme (and disable the theme switcher) by passing the theme option, like so:
theme: dark # or light\nYou can configured a fixed color palette (and disable the palette switcher) by passing the color option, like so:
color: slate\nSupported colors are: slate, gray, zinc, neutral, stone, amber, yellow, lime, green, emerald, teal, cyan, sky, blue, indigo, violet, purple, fuchsia, pink, rose, red, white
You can configure service and bookmarks sections to be either \"column\" or \"row\" based layouts, like so:
Assuming you have a group named Media in your services.yaml or bookmarks.yaml file,
layout:\n Media:\n style: row\n columns: 4\nAs an example, this would produce the following layout:
"},{"location":"configs/settings/#sorting","title":"Sorting","text":"Service groups and bookmark groups can be mixed in order, but should use different group names. If you do not specify any bookmark groups they will all show at the bottom of the page.
Using the same name for a service and bookmark group can cause unexpected behavior like a bookmark group being hidden
Groups will sort based on the order in the layout block. You can also mix in groups defined by docker labels, e.g.
layout:\n - Auto-Discovered1:\n - Configured1:\n - Configured2:\n - Auto-Discovered2:\n - Configured3:\n style: row\n columns: 3\nYou can hide headers for each section in the layout as well by passing header as false, like so:
layout:\n Section A:\n header: false\n Section B:\n style: row\n columns: 3\n header: false\nYou can also add an icon to a category under the layout setting similar to the options for service icons, e.g.
Home Management & Info:\n icon: home-assistant.png\n Server Tools:\n icon: https://cdn-icons-png.flaticon.com/512/252/252035.png\n ...\nThe default style for icons (e.g. icon: mdi-XXXX) is a gradient, or you can specify that prefixed icons match your theme with a 'flat' style using the setting below. More information about prefixed icons can be found in options for service icons.
iconStyle: theme # optional, defaults to gradient\nVersion 0.6.30 introduced a tabbed view to layouts which can be optionally specified in the layout. Tabs is only active if you set the tab field on at least one layout group.
Tabs are sorted based on the order in the layout block. If a group has no tab specified (and tabs are set on other groups), services and bookmarks will be shown on all tabs.
Every tab can be accessed directly by visiting Homepage URL with #Group (name lowercase and URI-encoded) at the end of the URL.
For example, the following would create four tabs:
layout:\n ...\n Bookmark Group on First Tab:\n tab: First\n\n First Service Group:\n tab: First\n style: row\n columns: 4\n\n Second Service Group:\n tab: Second\n columns: 4\n\n Third Service Group:\n tab: Third\n style: row\n\n Bookmark Group on Fourth Tab:\n tab: Fourth\n\n Service Group on every Tab:\n style: row\n columns: 4\nYou can add a fifth column to services (when style: columns which is default) by adding:
fiveColumns: true\nBy default homepage will max out at 4 columns for services with columns style
You can disable the collapsible feature of services & bookmarks by adding:
disableCollapse: true\nBy default the feature is enabled.
"},{"location":"configs/settings/#initially-collapsed-sections","title":"Initially collapsed sections","text":"You can initially collapse sections by adding the initiallyCollapsed option to the layout group.
layout:\n Section A:\n initiallyCollapsed: true\nThis can also be set globaly using the groupsInitiallyCollapsed option.
groupsInitiallyCollapsed: true\nThe value set on a group will overwrite the global setting.
By default the feature is disabled.
"},{"location":"configs/settings/#use-equal-height-cards","title":"Use Equal Height Cards","text":"You can enable equal height cards for groups of services, this will make all cards in a row the same height.
Global setting in settings.yaml:
useEqualHeights: true\nPer layout group in settings.yaml:
useEqualHeights: false\nlayout:\n ...\n Group Name:\n useEqualHeights: true # overrides global setting\nBy default the feature is disabled
"},{"location":"configs/settings/#header-style","title":"Header Style","text":"There are currently 4 options for header styles, you can see each one below.
headerStyle: underlined # default style\nheaderStyle: boxed\nheaderStyle: clean\nheaderStyle: boxedWidgets\nIn some proxy configurations, it may be necessary to set the documents base URL. You can do this by providing a base value, like so:
base: http://host.local/homepage\nThe URL must be a full, absolute URL, or it will be ignored by the browser.
"},{"location":"configs/settings/#language","title":"Language","text":"Set your desired language using:
language: fr\nCurrently supported languages: ca, de, en, es, fr, he, hr, hu, it, nb-NO, nl, pt, ru, sv, vi, zh-CN, zh-Hant
You can also specify locales e.g. for the DateTime widget, e.g. en-AU, en-GB, etc.
"},{"location":"configs/settings/#link-target","title":"Link Target","text":"Changes the behaviour of links on the homepage,
target: _blank # Possible options include _blank, _self, and _top\nUse _blank to open links in a new tab, _self to open links in the same tab, and _top to open links in a new window.
This can also be set for individual services. Note setting this at the service level overrides any setting in settings.json, e.g.:
- Example Service:\n href: https://example.com/\n ...\n target: _self\nThe providers section allows you to define shared API provider options and secrets. Currently this allows you to define your weather API keys in secret and is also the location of the Longhorn URL and credentials.
providers:\n openweathermap: openweathermapapikey\n weatherapi: weatherapiapikey\n longhorn:\n url: https://longhorn.example.com\n username: admin\n password: LonghornPassword\nYou can then pass provider instead of apiKey in your widget configuration.
- weatherapi:\n latitude: 50.449684\n longitude: 30.525026\n provider: weatherapi\nYou can use the 'Quick Launch' feature to search services, perform a web search or open a URL. To use Quick Launch, just start typing while on your homepage (as long as the search widget doesn't have focus).
There are a few optional settings for the Quick Launch feature:
searchDescriptions: which lets you control whether item descriptions are included in searches. This is false by default. When enabled, results that match the item name will be placed above those that only match the description.hideInternetSearch: disable automatically including the currently-selected web search (e.g. from the widget) as a Quick Launch option. This is false by default, enabling the feature.showSearchSuggestions: show search suggestions for the internet search. If this is not specified then the setting will be inherited from the search widget. If it is not specified there either, it will default to false. For custom providers the suggestionUrl needs to be set in order for this to work.provider: search engine provider. If none is specified it will try to use the provider set for the Search Widget, if neither are present then internet search will be disabled.hideVisitURL: disable detecting and offering an option to open URLs. This is false by default, enabling the feature.quicklaunch:\n searchDescriptions: true\n hideInternetSearch: true\n showSearchSuggestions: true\n hideVisitURL: true\n provider: google # google, duckduckgo, bing, baidu, brave or custom\nor for a custom search:
quicklaunch:\n provider: custom\n url: https://www.ecosia.org/search?q=\n target: _blank\n suggestionUrl: https://ac.ecosia.org/autocomplete?type=list&q=\nBy default the release version is displayed at the bottom of the page. To hide this, use the hideVersion setting, like so:
hideVersion: true\nBy default the homepage logfile is written to the a logs subdirectory of the config folder. In order to customize this path, you can set the logpath setting. A logs folder will be created in that location where the logfile will be written.
logpath: /logfile/path\nBy default, logs are sent both to stdout and to a file at the path specified. This can be changed by setting the LOG_TARGETS environment variable to one of both (default), stdout or file.
You can show all docker stats expanded in settings.yaml:
showStats: true\nor per-service (services.yaml) with:
- Example Service:\n ...\n showStats: true\nIf you have both set the per-service settings take precedence.
"},{"location":"configs/settings/#status-style","title":"Status Style","text":"You can choose from the following styles for docker or k8s status, site monitor and ping: dot or basic
dot shows a green dot for a successful monitor ping or healthy status.basic shows either UP or DOWN for monitor & pingFor example:
statusStyle: \"dot\"\nor per-service (services.yaml) with:
- Example Service:\n ...\n statusStyle: 'dot'\nIf you have both set, the per-service settings take precedence.
"},{"location":"configs/settings/#instance-name","title":"Instance Name","text":"Name used by automatic docker service discovery to differentiate between multiple homepage instances.
For example:
instanceName: public\nHide the visible API error messages either globally in settings.yaml:
hideErrors: true\nor per service widget (services.yaml) with:
- Example Service:\n ...\n widget:\n ...\n hideErrors: true\nIf either value is set to true, the error message will be hidden.
"},{"location":"installation/","title":"Installation","text":"You have a few options for deploying homepage, depending on your needs. We offer docker images for a majority of platforms. You can also install and run homepage from source if Docker is not your thing. It can even be installed on Kubernetes with Helm.
Danger
Please note that when using features such as widgets, Homepage can access personal information (for example from your home automation system) and Homepage currently does not (and is not planned to) include any authentication layer itself. Thus, we recommend homepage be deployed behind a reverse proxy including authentication, SSL etc, and / or behind a VPN.
\u00a0 Install on Docker
\u00a0 Install on Kubernetes
\u00a0 Install on UNRAID
\u00a0 Building from source
"},{"location":"installation/docker/","title":"Docker Installation","text":"Using docker compose:
version: \"3.3\"\nservices:\n homepage:\n image: ghcr.io/gethomepage/homepage:latest\n container_name: homepage\n ports:\n - 3000:3000\n volumes:\n - /path/to/config:/app/config # Make sure your local config directory exists\n - /var/run/docker.sock:/var/run/docker.sock # (optional) For docker integrations\nBy default, the Homepage container runs as root. Homepage also supports running your container as non-root via the standard PUID and PGID environment variables. When using these variables, make sure that any volumes mounted in to the container have the correct ownership and permissions set.
Using the docker socket directly is not the recommended method of integration and requires either running homepage as root or that the user be part of the docker group
In the docker compose example below, the environment variables $PUID and $PGID are set in a .env file.
version: \"3.3\"\nservices:\n homepage:\n image: ghcr.io/gethomepage/homepage:latest\n container_name: homepage\n ports:\n - 3000:3000\n volumes:\n - /path/to/config:/app/config # Make sure your local config directory exists\n - /var/run/docker.sock:/var/run/docker.sock # (optional) For docker integrations, see alternative methods\n environment:\n PUID: $PUID\n PGID: $PGID\ndocker run -p 3000:3000 -v /path/to/config:/app/config -v /var/run/docker.sock:/var/run/docker.sock ghcr.io/gethomepage/homepage:latest\nYou can also include environment variables in your config files to protect sensitive information. Note:
HOMEPAGE_VAR_ or HOMEPAGE_FILE_HOMEPAGE_VAR_XXX will replace {{HOMEPAGE_VAR_XXX}} in any configHOMEPAGE_FILE_XXX must be a file path, the contents of which will be used to replace {{HOMEPAGE_FILE_XXX}} in any configThere is an unofficial helm chart that creates all the necessary manifests, including the service account and RBAC entities necessary for service discovery.
helm repo add jameswynn https://jameswynn.github.io/helm-charts\nhelm install homepage jameswynn/homepage -f values.yaml\nThe helm chart allows for all the configurations to be inlined directly in your values.yaml:
config:\n bookmarks:\n - Developer:\n - Github:\n - abbr: GH\n href: https://github.com/\n services:\n - My First Group:\n - My First Service:\n href: http://localhost/\n description: Homepage is awesome\n\n - My Second Group:\n - My Second Service:\n href: http://localhost/\n description: Homepage is the best\n\n - My Third Group:\n - My Third Service:\n href: http://localhost/\n description: Homepage is \ud83d\ude0e\n widgets:\n # show the kubernetes widget, with the cluster summary and individual nodes\n - kubernetes:\n cluster:\n show: true\n cpu: true\n memory: true\n showLabel: true\n label: \"cluster\"\n nodes:\n show: true\n cpu: true\n memory: true\n showLabel: true\n - search:\n provider: duckduckgo\n target: _blank\n kubernetes:\n mode: cluster\n settings:\n\n# The service account is necessary to allow discovery of other services\nserviceAccount:\n create: true\n name: homepage\n\n# This enables the service account to access the necessary resources\nenableRbac: true\n\ningress:\n main:\n enabled: true\n annotations:\n # Example annotations to add Homepage to your Homepage!\n gethomepage.dev/enabled: \"true\"\n gethomepage.dev/name: \"Homepage\"\n gethomepage.dev/description: \"Dynamically Detected Homepage\"\n gethomepage.dev/group: \"Dynamic\"\n gethomepage.dev/icon: \"homepage.png\"\n hosts:\n - host: homepage.example.com\n paths:\n - path: /\n pathType: Prefix\nIf you don't want to use the unofficial Helm chart, you can also create your own Kubernetes manifest(s) and apply them with kubectl apply -f filename.yaml.
Here's a working example of the resources you need:
"},{"location":"installation/k8s/#serviceaccount","title":"ServiceAccount","text":"apiVersion: v1\nkind: ServiceAccount\nmetadata:\n name: homepage\n namespace: default\n labels:\n app.kubernetes.io/name: homepage\nsecrets:\n - name: homepage\napiVersion: v1\nkind: Secret\ntype: kubernetes.io/service-account-token\nmetadata:\n name: homepage\n namespace: default\n labels:\n app.kubernetes.io/name: homepage\n annotations:\n kubernetes.io/service-account.name: homepage\napiVersion: v1\nkind: ConfigMap\nmetadata:\n name: homepage\n namespace: default\n labels:\n app.kubernetes.io/name: homepage\ndata:\n kubernetes.yaml: |\n mode: cluster\n settings.yaml: \"\"\n #settings.yaml: |\n # providers:\n # longhorn:\n # url: https://longhorn.my.network\n custom.css: \"\"\n custom.js: \"\"\n bookmarks.yaml: |\n - Developer:\n - Github:\n - abbr: GH\n href: https://github.com/\n services.yaml: |\n - My First Group:\n - My First Service:\n href: http://localhost/\n description: Homepage is awesome\n\n - My Second Group:\n - My Second Service:\n href: http://localhost/\n description: Homepage is the best\n\n - My Third Group:\n - My Third Service:\n href: http://localhost/\n description: Homepage is \ud83d\ude0e\n widgets.yaml: |\n - kubernetes:\n cluster:\n show: true\n cpu: true\n memory: true\n showLabel: true\n label: \"cluster\"\n nodes:\n show: true\n cpu: true\n memory: true\n showLabel: true\n - resources:\n backend: resources\n expanded: true\n cpu: true\n memory: true\n - search:\n provider: duckduckgo\n target: _blank\n docker.yaml: \"\"\napiVersion: rbac.authorization.k8s.io/v1\nkind: ClusterRole\nmetadata:\n name: homepage\n labels:\n app.kubernetes.io/name: homepage\nrules:\n - apiGroups:\n - \"\"\n resources:\n - namespaces\n - pods\n - nodes\n verbs:\n - get\n - list\n - apiGroups:\n - extensions\n - networking.k8s.io\n resources:\n - ingresses\n verbs:\n - get\n - list\n - apiGroups:\n - traefik.containo.us\n resources:\n - ingressroutes\n verbs:\n - get\n - list\n - apiGroups:\n - metrics.k8s.io\n resources:\n - nodes\n - pods\n verbs:\n - get\n - list\n---\napiVersion: rbac.authorization.k8s.io/v1\nkind: ClusterRoleBinding\nmetadata:\n name: homepage\n labels:\n app.kubernetes.io/name: homepage\nroleRef:\n apiGroup: rbac.authorization.k8s.io\n kind: ClusterRole\n name: homepage\nsubjects:\n - kind: ServiceAccount\n name: homepage\n namespace: default\napiVersion: v1\nkind: Service\nmetadata:\n name: homepage\n namespace: default\n labels:\n app.kubernetes.io/name: homepage\n annotations:\nspec:\n type: ClusterIP\n ports:\n - port: 3000\n targetPort: http\n protocol: TCP\n name: http\n selector:\n app.kubernetes.io/name: homepage\napiVersion: apps/v1\nkind: Deployment\nmetadata:\n name: homepage\n namespace: default\n labels:\n app.kubernetes.io/name: homepage\nspec:\n revisionHistoryLimit: 3\n replicas: 1\n strategy:\n type: RollingUpdate\n selector:\n matchLabels:\n app.kubernetes.io/name: homepage\n template:\n metadata:\n labels:\n app.kubernetes.io/name: homepage\n spec:\n serviceAccountName: homepage\n automountServiceAccountToken: true\n dnsPolicy: ClusterFirst\n enableServiceLinks: true\n containers:\n - name: homepage\n image: \"ghcr.io/gethomepage/homepage:latest\"\n imagePullPolicy: Always\n ports:\n - name: http\n containerPort: 3000\n protocol: TCP\n volumeMounts:\n - mountPath: /app/config/custom.js\n name: homepage-config\n subPath: custom.js\n - mountPath: /app/config/custom.css\n name: homepage-config\n subPath: custom.css\n - mountPath: /app/config/bookmarks.yaml\n name: homepage-config\n subPath: bookmarks.yaml\n - mountPath: /app/config/docker.yaml\n name: homepage-config\n subPath: docker.yaml\n - mountPath: /app/config/kubernetes.yaml\n name: homepage-config\n subPath: kubernetes.yaml\n - mountPath: /app/config/services.yaml\n name: homepage-config\n subPath: services.yaml\n - mountPath: /app/config/settings.yaml\n name: homepage-config\n subPath: settings.yaml\n - mountPath: /app/config/widgets.yaml\n name: homepage-config\n subPath: widgets.yaml\n - mountPath: /app/config/logs\n name: logs\n volumes:\n - name: homepage-config\n configMap:\n name: homepage\n - name: logs\n emptyDir: {}\napiVersion: networking.k8s.io/v1\nkind: Ingress\nmetadata:\n name: homepage\n namespace: default\n labels:\n app.kubernetes.io/name: homepage\n annotations:\n gethomepage.dev/description: Dynamically Detected Homepage\n gethomepage.dev/enabled: \"true\"\n gethomepage.dev/group: Cluster Management\n gethomepage.dev/icon: homepage.png\n gethomepage.dev/name: Homepage\nspec:\n rules:\n - host: \"homepage.my.network\"\n http:\n paths:\n - path: \"/\"\n pathType: Prefix\n backend:\n service:\n name: homepage\n port:\n number: 3000\nIf you plan to deploy homepage with a replica count greater than 1, you may want to consider enabling sticky sessions on the homepage route. This will prevent unnecessary re-renders on page loads and window / tab focusing. The procedure for enabling sticky sessions depends on your Ingress controller. Below is an example using Traefik as the Ingress controller.
apiVersion: traefik.io/v1alpha1\nkind: IngressRoute\nmetadata:\n name: homepage.example.com\nspec:\n entryPoints:\n - websecure\n routes:\n - kind: Rule\n match: Host(`homepage.example.com`)\n services:\n - kind: Service\n name: homepage\n port: 3000\n sticky:\n cookie:\n httpOnly: true\n secure: true\n sameSite: none\nFirst, clone the repository:
git clone https://github.com/gethomepage/homepage.git\nThen install dependencies and build the production bundle (I'm using pnpm here, you can use npm or yarn if you like):
pnpm install\npnpm build\nIf this is your first time starting, copy the src/skeleton directory to config/ to populate initial example config files.
Finally, run the server:
pnpm start\nHomepage has an UNRAID community package that you may use to install homepage. This is the easiest way to get started with homepage on UNRAID.
"},{"location":"installation/unraid/#install-the-plugin","title":"Install the Plugin","text":"homepage.You may need to set the permissions of the folders to be able to edit the files.
chmod -R u-x,go-rwx,go+u,ugo+X /app/config and press Enter.chmod -R u-x,go-rwx,go+u,ugo+X /app/public/icons and press Enter.chown -R nobody:users /app/config and press Enter.chown -R nobody:users /app/public/icons and press Enter.container: parameter. There is no need to set the server.!!! note
To view detailed container statistics (CPU, RAM, etc.), or if you use a remote docker socket, `container:` will still need to be set. For example:\n - Plex:\n icon: /icons/plex.png\n href: https://app.plex.com\n container: plex\nHere you'll find resources and guides for Homepage, troubleshooting tips, and more.
"},{"location":"more/development/","title":"Development","text":""},{"location":"more/development/#development-overview","title":"Development Overview","text":"First, clone the homepage repository.
For installing NPM packages, this project uses pnpm (and so should you!):
pnpm install\nStart the development server:
pnpm dev\nOpen http://localhost:3000 to start.
This is a Next.js application, see their documentation for more information.
"},{"location":"more/development/#code-linting","title":"Code Linting","text":"Once dependencies have been installed you can lint your code with
pnpm lint\nTo ensure a consistent style and formatting across the project source, the project utilizes Git pre-commit hooks to perform some formatting and linting before a commit is allowed.
Once installed, hooks will run when you commit. If the formatting isn't quite right, the commit will be rejected and you'll need to look at the output and fix the issue. Most hooks will automatically format failing files, so all you need to do is git add those files again and retry your commit.
See the pre-commit documentation to get started.
"},{"location":"more/development/#preferring-self-hosted-open-source-software","title":"Preferring self-hosted open-source software","text":"In general, homepage is meant to be a dashboard for 'self-hosted' services and we believe it is a small way we can help showcase this kind of software. While exceptions are made, mostly when there is no viable self-hosted / open-source alternative, we ask that any widgets, etc. are developed primarily for a self-hosted tool.
"},{"location":"more/development/#new-feature-guidelines","title":"New Feature Guidelines","text":"To ensure cohesiveness of various widgets, the following should be used as a guide for developing new widgets:
As of v0.7.2 homepage migrated from benphelps/homepage to an \"organization\" repository located at gethomepage/homepage. The reason for this was to setup the project for longevity and allow for community maintenance.
Migrating your installation should be as simple as changing image: ghcr.io/benphelps/homepage:latest to image: ghcr.io/gethomepage/homepage:latest.
Homepage is developed in English, component contributions must be in English. All translations are community provided, so a huge thanks go out to all those who have helped out so far!
"},{"location":"more/translations/#support-translations","title":"Support Translations","text":"If you'd like to lend a hand in translating Homepage into more languages, or to improve existing translations, the process is very simple:
If you'd like to add a new language, please create a new Discussion on Crowdin, and we'll add it to the project.
"},{"location":"troubleshooting/","title":"Troubleshooting","text":""},{"location":"troubleshooting/#introducing-the-homepage-ai-bot","title":"Introducing the Homepage AI Bot","text":"Thanks to the generous folks at Glime, Homepage is now equipped with a pretty clever AI-powered bot. The bot has full knowledge of our docs, GitHub issues and discussions and is great at answering specific questions about setting up your Homepage. To use the bot, just hit the 'Ask AI' button on any page in our docs, open a GitHub discussion or check out the #ai-support channel on Discord!
"},{"location":"troubleshooting/#general-troubleshooting-tips","title":"General Troubleshooting Tips","text":"docker logs homepage. This may provide some insight into the reason for an error.ENV variable LOG_LEVEL to debug.All service widgets work essentially the same, that is, homepage makes a proxied call to an API made available by that service. The majority of the time widgets don't work it is a configuration issue. Of course, sometimes things do break. Some basic steps to try:
Ensure that you follow the rule mentioned on https://gethomepage.dev/latest/configs/service-widgets/. Unless otherwise noted, URLs should not end with a / or other API path. Each widget will handle the path on its own.. This is very important as including a trailing slash can result in an error.
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\nIf 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.
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
curl is not installed in the base image by default but can be added inside the container with apk add curl.
The exact API endpoints and authentication vary of course, but in many cases instructions can be found by searching the web or if you feel comfortable looking at the homepage source code (e.g. src/widgets/{widget}/widget.js).
It is out of the scope of this to go into full detail about how to , but an example for PiHole would be:
curl -L -k http://PIHOLEIPORHOST/admin/api.php\nOr for AdGuard:
curl -L -k -u 'username:password' http://ADGUARDIPORHOST/control/stats\nOr for Portainer:
curl -L -k -H 'X-Api-Key:YOURKEY' 'https://PORTAINERIPORHOST:PORT/api/endpoints/2/docker/containers/json'\nSonarr:
curl -L -k 'http://SONARRIPORHOST:PORT/api/v3/queue?apikey=YOURAPIKEY'\nThis will return some data which may reveal an issue causing a true bug in the service widget.
If, after correctly adding and mapping your custom icons via the Icons instructions, you are still unable to see your icons please try recreating your container.
"},{"location":"widgets/","title":"Widgets","text":"Homepage has two types of widgets: info and service. Below we'll cover each type and how to configure them.
"},{"location":"widgets/#service-widgets","title":"Service Widgets","text":"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:\n icon: plex.png\n href: https://plex.my.host\n description: Watch movies and TV shows.\n server: localhost\n container: plex\n widget:\n type: tautulli\n url: http://172.16.1.1:8181\n key: aabbccddeeffgghhiijjkkllmmnnoo\nInfo widgets are used to display information in the header, often about your system or environment. Info widgets are defined your widgets.yaml file. Here's an example:
- openmeteo:\n label: Current\n latitude: 36.66\n longitude: -117.51\n cache: 5\nWidgets are a core component of Homepage. They are used to display information about your system, services, and environment.
"},{"location":"widgets/authoring/#overview","title":"Overview","text":"If you are new to Homepage widgets, and are looking to create a new widget, please follow along with the guide here: Widget Tutorial.
"},{"location":"widgets/authoring/#translations","title":"Translations","text":"All text and numerical content in widgets should be translated and localized. English is the default language, and other languages can be added via Crowdin.
The Homepage community prides itself on being multilingual, and we strongly encourage you to add translations for your widgets.
If you are looking to learn more about translations, please refer to the guide here: Translations Guide.
"},{"location":"widgets/authoring/#widget-component","title":"Widget Component","text":"The widget component is the core of the widget. It is responsible for fetching data from the API and rendering the widget UI. Homepage provides a set of hooks and utilities to help you build your widget component.
If you are looking to learn more about widget components, please refer to the guide here: Component Guide.
"},{"location":"widgets/authoring/#widget-metadata","title":"Widget Metadata","text":"Widget metadata defines the configuration of the widget. It defines the API endpoint to fetch data from, the proxy handler to use, and any data mappings.
If you are looking to learn more about widget metadata, endpoint and data mapping, please refer to the guide here: Metadata Guide.
If you are looking to learn more about proxy handlers, please refer to the guide here: Proxies Guide.
If you are looking to learn more making API calls from inside your widget, please refer to the guide here: API Guide.
"},{"location":"widgets/authoring/api/","title":"API Guide","text":"Homepage provides the useWidgetAPI hook to help you fetch data from an API. This hook insures that the data is fetched using a proxy, and is critical for security.
Here is an example of how the useWidgetAPI hook looks:
import useWidgetAPI from \"utils/proxy/use-widget-api\";\n\nexport default function Component({ service }) {\n const { data, error } = useWidgetAPI(widget, \"stats\");\n}\nuseWidgetAPI","text":"useWidgetAPI takes three possible arguments:
widget: The widget metadata object.endpoint: The name of the endpoint to fetch data from.params: An optional object containing query parameters to pass to the API.widget","text":"The widget argument is the metadata object for the widget. It contains information about the API endpoint, proxy handler, and mappings. This object is used by the useWidgetAPI hook to fetch data from the API. This is generally passed in as a prop from the parent component.
endpoint","text":"The endpoint argument is the name of the endpoint to fetch data from. This is defined in the widget metadata object. The useWidgetAPI hook uses this argument to determine which endpoint to fetch data from.
If no endpoint is provided, the useWidgetAPI hook will call the API endpoint defined in the widget metadata object directly.
params","text":"The params argument is an optional object containing query parameters to pass to the API. This is useful for filtering data or passing additional information to the API. This object is passed directly to the API endpoint as query parameters.
Here is an example of how to use the params argument:
import useWidgetAPI from \"utils/proxy/use-widget-api\";\n\nexport default function Component({ service }) {\n const { data, error } = useWidgetAPI(widget, \"stats\", { start: \"2021-01-01\", end: \"2021-12-31\" });\n}\nThe params must be whitelisted in the widget metadata object. This is done to prevent arbitrary query parameters from being passed to the API.
Homepage widgets are built using React components. These components are responsible for fetching data from the API and rendering the widget UI. Homepage provides a set of hooks and utilities to help you build your widget component.
"},{"location":"widgets/authoring/component/#a-basic-widget-component","title":"A Basic Widget Component","text":"Here is an example of a basic widget component:
import { useTranslation } from \"next-i18next\";\n\nimport Container from \"components/services/widget/container\";\nimport Block from \"components/services/widget/block\";\nimport useWidgetAPI from \"utils/proxy/use-widget-api\";\n\nexport default function Component({ service }) {\n const { t } = useTranslation();\n const { widget } = service;\n const { data, error } = useWidgetAPI(widget, \"info\");\n\n if (error) {\n return <Container service={service} error={error} />;\n }\n\n if (!data) {\n return (\n <Container service={service}>\n <Block label=\"yourwidget.key1\" />\n <Block label=\"yourwidget.key2\" />\n <Block label=\"yourwidget.key3\" />\n </Container>\n );\n }\n\n return (\n <Container service={service}>\n <Block label=\"yourwidget.key1\" value={t(\"common.number\", { value: data.key1 })} />\n <Block label=\"yourwidget.key2\" value={t(\"common.number\", { value: data.key2 })} />\n <Block label=\"yourwidget.key3\" value={t(\"common.number\", { value: data.key3 })} />\n </Container>\n );\n}\nWe'll cover two sections of the widget component: hooks and components.
"},{"location":"widgets/authoring/component/#hooks","title":"Hooks","text":"useTranslation
This hook is used to translate text and numerical content in widgets. Homepage provides a set of helpers to help you localize your widgets. You can learn more about translations in the Translations Guide.
useWidgetAPI
This hook is used to fetch data from the API. We cover this hook in more detail in the API Guide.
"},{"location":"widgets/authoring/component/#components","title":"Components","text":"Homepage provides a set of components to help you build your widget UI. These components are designed to provide a consistent layout, and all widgets are expected to use these components.
<Container>
This component is a wrapper for the widget. It provides a consistent layout for all widgets.
<Container service={service}></Container>\nservice is a prop that is passed to the widget component. It contains information about the service that the widget is displaying.
If there is an error fetching data from the API, the error prop can be passed to the Container component.
<Container service={service} error={error}></Container>\n<Block>
This component is used to display a key-value pair. It takes a label and value as props.
<Block label=\"yourwidget.key1\" value={t(\"common.number\", { value: data.key1 })} />\nThe label prop is used to look up the translation key in the translation files. The value prop is used to display the value of the block. To learn more about translations, please refer to the Translations Guide.
If there is no data available, the Block component can be used to display a placeholder layout.
<Container service={service}>\n <Block label=\"yourwidget.key1\" />\n <Block label=\"yourwidget.key2\" />\n <Block label=\"yourwidget.key3\" />\n</Container>\nHere, we will go over how to create and configure Homepage widget metadata. Metadata is a JS object that contains information about the widget, such as the API endpoint, proxy handler, and mappings. This metadata is used by Homepage to fetch data from the API and pass it to the widget.
"},{"location":"widgets/authoring/metadata/#widgets-configuration","title":"Widgets Configuration","text":"Here are some examples of how to configure a widget's metadata object.
Basic ExampleAdvanced Exampleimport genericProxyHandler from \"utils/proxy/handlers/generic\";\n\nconst widgetExample = {\n api: \"{url}/api/{endpoint}\",\n proxyHandler: genericProxyHandler,\n\n mappings: {\n stats: { endpoint: \"stats\" }\n },\n};\nimport credentialedProxyHandler from \"utils/proxy/handlers/credentialed\";\nimport { asJson, jsonArrayFilter } from \"utils/proxy/api-helpers\";\n\nconst widgetExample = {\n api: \"{url}/api/{endpoint}\",\n proxyHandler: credentialedProxyHandler,\n\n mappings: {\n stats: {\n endpoint: \"stats\",\n validate: [\"total\", \"average\"],\n params: [\"start\", \"end\"],\n },\n notices: {\n endpoint: \"notices\",\n map: (data) => {\n total: asJson(data).length;\n },\n },\n warnings: {\n endpoint: \"notices\",\n map: (data) => {\n total: jsonArrayFilter(data, (alert) => alert.type === \"warning\").length;\n },\n },\n },\n};\nA widgets metadata is quite powerful and can be configured in many different ways.
"},{"location":"widgets/authoring/metadata/#configuration-properties","title":"Configuration Properties","text":""},{"location":"widgets/authoring/metadata/#api","title":"api","text":"The api property is a string that represents the URL of the API endpoint that the widget will use to fetch data. The URL can contain placeholders that will be replaced with actual values at runtime. For example, the {url} placeholder will be replaced with the URL of the configured widget, and the {endpoint} placeholder will be replaced with the value of the endpoint property in the mappings object.
const widgetExample = {\n api: \"{url}/api/{endpoint}\",\n};\nproxyHandler","text":"The proxyHandler property is a function that will be used to make the API request. Homepage includes some built-in proxy handlers that can be used out of the box:
Here is an example of the generic proxy handler that makes unauthenticated requests to the specified API endpoint.
widget.jsservices.yamlconst widgetExample = {\n api: \"{url}/api/{endpoint}\",\n proxyHandler: genericProxyHandler,\n};\n- Services:\n - Your Widget:\n icon: yourwidget.svg\n href: https://example.com/\n widget:\n type: yourwidget\n url: http://127.0.0.1:1337\nIf you are looking to learn more about proxy handlers, please refer to the guide here: Proxies Guide.
"},{"location":"widgets/authoring/metadata/#mappings","title":"mappings","text":"The mappings property is an object that contains information about the API endpoint, such as the endpoint name, validation rules, and parameter names. The mappings object can contain multiple endpoints, each with its own configuration.
Security Note
The mappings or allowedEndpoints property is required for the widget to fetch data from more than a static URL. Homepage uses a whitelist approach to ensure that widgets only access allowed endpoints.
import { asJson } from \"utils/proxy/api-helpers\";\n\nconst widgetExample = {\n api: \"{url}/api/{endpoint}\",\n mappings: {\n // `/api/stats?start=...&end=...`\n stats: {\n endpoint: \"stats\",\n validate: [\"total\", \"average\"],\n params: [\"start\", \"end\"],\n },\n // `/api/notices`\n notices: {\n endpoint: \"notices\",\n map: (data) => {\n total: asJson(data).length;\n },\n },\n },\n};\nendpoint","text":"The endpoint property is a string that represents the name of the API endpoint that the widget will use to fetch data. This value will be used to replace the {endpoint} placeholder in the api property.
const widgetExample = {\n api: \"{url}/api/{endpoint}\",\n mappings: {\n // `/api/stats`\n stats: {\n endpoint: \"stats\",\n },\n },\n};\nvalidate","text":"The validate property is an array of strings that represent the keys that should be validated in the API response. If the response does not contain all of the specified keys, the widget will not render.
const widgetExample = {\n api: \"{url}/api/{endpoint}\",\n mappings: {\n // `/api/stats`\n stats: {\n endpoint: \"stats\",\n validate: [\"total\", \"average\"],\n },\n },\n};\nThis configuration will ensure that the API response contains the total and average keys before the widget is rendered.
params","text":"The params property is an array of strings that represent the keys that should be passed as parameters to the API endpoint. These keys will be replaced with the actual values at runtime.
const widgetExample = {\n api: \"{url}/api/{endpoint}\",\n mappings: {\n // `/api/stats?start=...&end=...`\n stats: {\n endpoint: \"stats\",\n params: [\"start\", \"end\"],\n },\n },\n};\nconst { data: statsData, error: statsError } = useWidgetAPI(widget, \"stats\", {\n start: new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),\n end: new Date(),\n});\nThis configuration will pass the start and end keys as parameters to the API endpoint. The values are passed as an object to the useWidgetAPI hook.
map","text":"The map property is a function that will be used to transform the API response before it is passed to the widget. This function is passed the raw API response and should return the transformed data.
import { asJson } from \"utils/proxy/api-helpers\";\n\nconst widgetExample = {\n api: \"{url}/api/{endpoint}\",\n mappings: {\n // `/api/notices`\n notices: {\n endpoint: \"notices\",\n map: (data) => {\n total: asJson(data).length;\n },\n },\n // `/api/notices`\n warnings: {\n endpoint: \"notices\",\n map: (data) => {\n total: asJson(data).filter((alert) => alert.type === \"warning\").length;\n },\n },\n },\n};\nmethod","text":"The method property is a string that represents the HTTP method that should be used to make the API request. The default value is GET.
const widgetExample = {\n api: \"{url}/api/{endpoint}\",\n mappings: {\n // `/api/stats`\n stats: {\n endpoint: \"stats\",\n method: \"POST\",\n },\n },\n};\nheaders","text":"The headers property is an object that contains additional headers that should be included in the API request. If your endpoint requires specific headers, you can include them here.
const widgetExample = {\n api: \"{url}/api/{endpoint}\",\n mappings: {\n // `/api/stats`\n stats: {\n endpoint: \"stats\",\n method: \"POST\",\n headers: {\n \"Content-Type\": \"application/json\",\n },\n },\n },\n};\nbody","text":"The body property is an object that contains the data that should be sent in the request body. This property is only used when the method property is set to POST or PUT.
const widgetExample = {\n api: \"{url}/api/{endpoint}\",\n mappings: {\n // `/api/graphql`\n stats: {\n endpoint: \"graphql\",\n method: \"POST\",\n body: {\n query: `\n query {\n stats {\n total\n average\n }\n }\n `,\n },\n headers: {\n \"Content-Type\": \"application/json\",\n },\n },\n },\n};\nallowedEndpoints","text":"The allowedEndpoints property is a RegExp that represents the allowed endpoints that the widget can use. If the widget tries to access an endpoint that is not allowed, the request will be blocked.
allowedEndpoints can be used when endpoint validation is simple and can be done using a regular expression, and more control is not required.
Security Note
The mappings or allowedEndpoints property is required for the widget to fetch data from more than a static URL. Homepage uses a whitelist approach to ensure that widgets only access allowed endpoints.
const widgetExample = {\n api: \"{url}/api/{endpoint}\",\n allowedEndpoints: /^stats|notices$/,\n};\nThis configuration will only allow the widget to access the stats and notices endpoints.
Homepage includes a set of built-in proxy handlers that can be used to fetch data from an API. We will go over how to use these proxy handlers and briefly cover how to create your own.
"},{"location":"widgets/authoring/proxies/#available-proxy-handlers","title":"Available Proxy Handlers","text":"Homepage comes with a few built-in proxy handlers that can be used to fetch data from an API. These handlers are located in the utils/proxy/handlers directory.
genericProxyHandler","text":"A proxy handler that makes generally unauthenticated requests to the specified API endpoint.
import genericProxyHandler from \"utils/proxy/handlers/generic\";\n\nconst widgetExample = {\n api: \"{url}/api/{endpoint}\",\n proxyHandler: genericProxyHandler,\n};\nYou can also pass API keys from the widget configuration to the proxy handler, for authenticated requests.
widget.jsservices.yamlimport genericProxyHandler from \"utils/proxy/handlers/generic\";\n\nconst widgetExample = {\n api: \"{url}/api/{endpoint}?key={key}\",\n proxyHandler: genericProxyHandler,\n};\n# Widget Configuration\n- Your Widget:\n icon: yourwidget.svg\n href: https://example.com/\n widget:\n type: yourwidget\n url: http://example.com\n key: your-api-key\ncredentialedProxyHandler","text":"A proxy handler that makes authenticated by setting request headers. Credentials are pulled from the widgets configuration.
By default the key is passed as an X-API-Key header. If you need to pass the key as something else, either add a case to the credentialedProxyHandler or create a new proxy handler.
import credentialedProxyHandler from \"utils/proxy/handlers/credentialed\";\n\nconst widgetExample = {\n api: \"{url}/api/{endpoint}?key={key}\",\n proxyHandler: credentialedProxyHandler,\n};\n- Your Widget:\n icon: yourwidget.svg\n href: https://example.com/\n widget:\n type: yourwidget\n url: http://127.0.0.1:1337\n key: your-api-key\njsonrpcProxyHandler","text":"A proxy handler that makes authenticated JSON-RPC requests to the specified API endpoint. Where the endpoint is the method to call.
widget.jsservices.yamlimport jsonrpcProxyHandler from \"utils/proxy/handlers/jsonrpc\";\n\nconst widgetExample = {\n api: \"{url}/api/jsonrpc\",\n proxyHandler: jsonrpcProxyHandler,\n\n mappings: {\n total: { endpoint: \"total\" },\n average: { endpoint: \"average\" },\n },\n};\n- Your Widget:\n icon: yourwidget.svg\n href: https://example.com/\n widget:\n type: yourwidget\n url: http://127.0.0.1:1337\n username: your-username\n password: your-password\nsynologyProxyHandler","text":"A proxy handler that makes authenticated requests to the specified Synology API endpoint. This is used exclusively for Synology DSM services.
widget.jsservices.yamlimport synologyProxyHandler from \"utils/proxy/handlers/synology\";\n\nconst widgetExample = {\n api: \"{url}/webapi/{cgiPath}?api={apiName}&version={maxVersion}&method={apiMethod}\",\n proxyHandler: synologyProxyHandler,\n\n mappings: {\n system_storage: {\n apiName: \"SYNO.Core.System\",\n apiMethod: 'info&type=\"storage\"',\n endpoint: \"system_storage\",\n }\n },\n};\n- Your Widget:\n icon: yourwidget.svg\n href: https://example.com/\n widget:\n type: yourwidget\n url: http://127.0.0.1:1337\n username: your-username\n password: your-password\nYou can create your own proxy handler to fetch data from an API. A proxy handler is a function that takes a configuration object and returns a function that makes the API request.
The proxy handler function takes three arguments:
req: The request object.res: The response object.map: A function that maps the API response to the widget data.The proxy handler function should return a promise that resolves to the API response.
Here is an example of a simple proxy handler that fetches data from an API and passes it to the widget:
import createLogger from \"utils/logger\";\nimport { httpProxy } from \"utils/proxy/http\";\n\nconst logger = createLogger(\"customProxyHandler\");\n\nexport default async function customProxyHandler(req, res, map) {\n const { url } = req.query;\n\n const [status, contentType, data] = await httpProxy(url);\n\n return res.status(status).send(data);\n}\nProxy handlers are a complex topic and require a good understanding of JavaScript and the Homepage codebase. If you are new to Homepage, we recommend using the built-in proxy handlers.
"},{"location":"widgets/authoring/translations/","title":"Translations Guide","text":"All text and numerical content in widgets should be translated and localized. English is the default language, and other languages can be added via Crowdin.
The Homepage community prides itself on being multilingual, and we strongly encourage you to add translations for your widgets.
"},{"location":"widgets/authoring/translations/#translations","title":"Translations","text":"Homepage uses the next-i18next library to handle translations. This library provides a set of hooks and utilities to help you localize your widgets, and Homepage has extended this library to support additional features.
component.jsxen.jsonimport { useTranslation } from \"next-i18next\";\n\nimport Container from \"components/services/widget/container\";\nimport Block from \"components/services/widget/block\";\n\nexport default function Component() {\n const { t } = useTranslation();\n\n return (\n <Container service={service}>\n <Block label=\"yourwidget.key1\" />\n <Block label=\"yourwidget.key2\" />\n <Block label=\"yourwidget.key3\" />\n </Container>\n );\n}\n\"yourwidget\": {\n \"key1\": \"Value 1\",\n \"key2\": \"Value 2\",\n \"key3\": \"Value 3\"\n}\nHomepage provides a set of common translations that you can use in your widgets. These translations are used to format numerical content, dates, and other common elements.
"},{"location":"widgets/authoring/translations/#numbers","title":"Numbers","text":"Key Translation Descriptioncommon.bytes 1,000 B Format a number in bytes. common.bits 1,000 bit Format a number in bits. common.bbytes 1 KiB Format a number in binary bytes. common.bbits 1 Kibit Format a number in binary bits. common.byterate 1,000 B/s Format a byte rate. common.bibyterate 1 KiB/s Format a binary byte rate. common.bitrate 1,000 bit/s Format a bit rate. common.bibitrate 1 Kibit/s Format a binary bit rate. common.percent 50% Format a percentage. common.number 1,000 Format a number. common.ms 1,000 ms Format a number in milliseconds. common.date 2024-01-01 Format a date. common.relativeDate 1 day ago Format a relative date. common.uptime 1 day, 1 hour Format an uptime."},{"location":"widgets/authoring/translations/#text","title":"Text","text":"Key Translation Description resources.cpu CPU CPU usage. resources.mem MEM Memory usage. resources.total Total Total resource. resources.free Free Free resource. resources.used Used Used resource. resources.load Load Load value. resources.temp TEMP Temperature value. resources.max Max Maximum value. resources.uptime UP Uptime."},{"location":"widgets/authoring/tutorial/","title":"Widget Tutorial","text":"In this guide, we'll walk through the process of creating a custom widget for Homepage. We'll cover the basic structure of a widget, how to use translations, and how to fetch data from an API. By the end of this guide, you'll have a solid understanding of how to build your own custom widget.
Prerequisites:
Throughout this guide, we'll use yourwidget as a placeholder for the unique name of your custom widget. Replace yourwidget with the actual name of your widget. It should contain only lowercase letters and no spaces.
This guide makes use of a fake API, which would return a JSON response as such, when called with the v1/info endpoint:
{ \"key1\": 123, \"key2\": 456, \"key3\": 789 }\nCreate a new folder for your widget in the src/widgets directory. Name the folder yourwidget.
Inside the yourwidget folder, create a new file named widget.js. This file will contain the metadata for your widget.
Open the widget.js file and add the following code:
import genericProxyHandler from \"utils/proxy/handlers/generic\"; // (1)!\n\nconst widget = /* (2)! */ {\n api: \"{url}/{endpoint}\" /* (3)! */,\n proxyHandler: genericProxyHandler /* (1)! */,\n\n mappings: /* (4)! */ {\n info: /* (5)! */ {\n endpoint: \"v1/info\" /* (6)! */,\n },\n },\n};\n\nexport default widget;\ngenericProxyHandler from the utils/proxy/handlers/generic module. The genericProxyHandler is a generic handler that can be used to fetch data from an API. We then assign the genericProxyHandler to the proxyHandler property of the widget object. There are other handlers available that you can use depending on your requirements. You can also create custom handlers if needed.widget object that contains the metadata for the widget.{url} and {endpoint} to dynamically generate the API endpoint based on the widget configuration.endpoint property that specifies the endpoint to fetch data from.info that specifies the v1/info endpoint to fetch data from. This would be called from the component as such: useWidgetAPI(widget, \"info\");endpoint property of the info mapping specifies the endpoint to fetch data from. There are other properties you can pass to the mapping, such as method, headers, and body.Important
All widgets that fetch data from dynamic endpoints should have either mappings or an allowedEndpoints property.
Homepage uses translated and localized strings for all text and numerical content in widgets. English is the default language, and other languages can be added via Crowdin. To add the English translations for your widget, follow these steps:
Open the public/locales/en/common.js file.
Add a new object for your widget to the bottom of the list, like this:
\"yourwidget\": {\n \"key1\": \"Value 1\",\n \"key2\": \"Value 2\",\n \"key3\": \"Value 3\"\n}\nNote
Even if you nativly speak another language, you should only add English translations. You can then add translations in your native language via Crowdin, once your widget is merged.
"},{"location":"widgets/authoring/tutorial/#create-the-widget-component","title":"Create the widget component","text":"Create a new file for your widgets component, named component.jsx, in the src/widgets/yourwidget directory. We'll build the contents of the component.jsx file step by step.
First, we'll import the necessary dependencies:
src/widgets/yourwidget/component.jsximport { useTranslation } from \"next-i18next\"; // (1)!\n\nimport Container from \"components/services/widget/container\"; // (2)!\nimport Block from \"components/services/widget/block\"; // (3)!\nimport useWidgetAPI from \"utils/proxy/use-widget-api\"; // (4)!\nuseTranslation() is a hook provided by next-i18next that allows us to access the translation strings<Container> and <Block> are custom components that we'll use to structure our widget.<Container> and <Block> are custom components that we'll use to structure our widget.useWidgetAPI(widget, endpoint) is a custom hook that we'll use to fetch data from an API.Next, we'll define a functional component named Component that takes a service prop.
export default function Component({ service }) {}\nWe grab the helper functions from the useTranslation hook.
const { t } = useTranslation();\nWe destructure the widget object from the service prop. The widget object contains the metadata for the widget, such as the API endpoint to fetch data from.
const { widget } = service;\nNow, the fun part! We use the useWidgetAPI hook to fetch data from an API. The useWidgetAPI hook takes two arguments: the widget object and the API endpoint to fetch data from. The useWidgetAPI hook returns an object with data and error properties.
const { data, error } = useWidgetAPI(widget, \"info\");\nAPI Tips
You'll see here how part of the API url is built using the url and endpoint properties from the widget definition.
In this case, we're fetching data from the info endpoint. The info endpoint is defined in the mappings object. So the full API endpoint will be \"{url}/v1/info\".
The mapping and endpoint are often the same, but must be defined regardless.
Next, we check if there's an error or no data.
If there's an error, we return a Container and pass it the service and error as props. The Container component will handle displaying the error message.
if (error) {\n return <Container service={service} error={error} />;\n}\nIf there's no data, we return a Container component with three Block components, each with a label.
if (!data) {\n return (\n <Container service={service}>\n <Block label=\"yourwidget.key1\" />\n <Block label=\"yourwidget.key2\" />\n <Block label=\"yourwidget.key3\" />\n </Container>\n );\n}\nThis will render the widget with placeholders for the data, i.e., a skeleton view.
Translation Tips
The label prop in the Block component corresponds to the translation key we defined earlier in the common.js file. All text and numerical content should be translated.
If there is data, we return a Container component with three Block components, each with a label and a value.
Here we use the t function from the useTranslation hook to translate the data values. The t function takes the translation key and an object with variables to interpolate into the translation string.
We're using the common.number translation key to format the data values as numbers. This allows for easy localization of numbers, such as using commas or periods as decimal separators.
There are a large number of common numerical translation keys available, which you can learn more about in the Translation Guide.
return (\n <Container service={service}>\n <Block label=\"yourwidget.key1\" value={t(\"common.number\", { value: data.key1 })} />\n <Block label=\"yourwidget.key2\" value={t(\"common.number\", { value: data.key2 })} />\n <Block label=\"yourwidget.key3\" value={t(\"common.number\", { value: data.key3 })} />\n </Container>\n);\nHere's the complete component.jsx file:
import { useTranslation } from \"next-i18next\";\n\nimport Container from \"components/services/widget/container\";\nimport Block from \"components/services/widget/block\";\nimport useWidgetAPI from \"utils/proxy/use-widget-api\";\n\nexport default function Component({ service }) {\n const { t } = useTranslation();\n const { widget } = service;\n const { data, error } = useWidgetAPI(widget, \"info\");\n\n if (error) {\n return <Container service={service} error={error} />;\n }\n\n if (!data) {\n return (\n <Container service={service}>\n <Block label=\"yourwidget.key1\" />\n <Block label=\"yourwidget.key2\" />\n <Block label=\"yourwidget.key3\" />\n </Container>\n );\n }\n\n return (\n <Container service={service}>\n <Block label=\"yourwidget.key1\" value={t(\"common.number\", { value: data.key1 })} />\n <Block label=\"yourwidget.key2\" value={t(\"common.number\", { value: data.key2 })} />\n <Block label=\"yourwidget.key3\" value={t(\"common.number\", { value: data.key3 })} />\n </Container>\n );\n}\nTo add your widget to the Homepage, you need to register it in the src/widgets/widgets.js file.
Open the src/widgets/widgets.js file and import the Component from your widget's component.jsx file. Please keep the alphabetical order.
// ...\nimport yourwidget from \"./yourwidget/widget\";\n// ...\nAdd yourwidget to the widgets object. Please keep the alphabetical order.
const widgets = {\n // ...\n yourwidget: yourwidget,\n // ...\n};\nYou also need to add the widget to the components object in the src/widgets/components.js file.
Open the src/widgets/components.js file and import the Component from your widget's component.jsx file.
Please keep the alphabetical order.
const components = {\n // ...\n yourwidget: dynamic(() => import(\"./yourwidget/component\")),\n // ...\n};\nYou can now use your custom widget in your Homepage. Open your services.yaml file and add a new service with the yourwidget widget.
- Services:\n - Your Widget:\n icon: yourwidget.svg\n href: https://example.com/\n widget:\n type: yourwidget\n url: http://127.0.0.1:1337\nAPI Tips
You'll see here how part of the API url is built using the url and endpoint properties from the widget definition.
We defined the api endpoint as \"{url}/{endpoint}\". This is where the url is defined. So the full API endpoint will be http://127.0.0.1:1337/{endpoint}.
That's it! You've successfully created a custom widget for Homepage. If you have any questions or need help, feel free to reach out to the Homepage community for assistance. Happy coding!
"},{"location":"widgets/info/datetime/","title":"Date & Time","text":"This allows you to display the date and/or time, can be heavily configured using Intl.DateTimeFormat.
Formatting is locale aware and will present your date in the regional format you expect, for example, 9/16/22, 3:03 PM for locale en and 16.09.22, 15:03 for de. You can also specify a locale just for the datetime widget with the locale option (see below).
- datetime:\n text_size: xl\n format:\n timeStyle: short\nAny options passed to format are passed directly to Intl.DateTimeFormat, please reference the MDN documentation for all available options.
Valid text sizes are 4xl, 3xl, 2xl, xl, md, sm, xs.
A few examples,
# 13:37\nformat:\n timeStyle: short\n hourCycle: h23\n# 1:37 PM\nformat:\n timeStyle: short\n hour12: true\n# 1/23/22, 1:37 PM\nformat:\n dateStyle: short\n timeStyle: short\n hour12: true\n# 4 januari 2023 om 13:51:25 PST\nlocale: nl\nformat:\n dateStyle: long\n timeStyle: long\n(Find the Glances service widget here)
The Glances widget allows you to monitor the resources (CPU, memory, storage, temp & uptime) of host or another machine, and is designed to match the resources info widget. You can have multiple instances by adding another configuration block. The cputemp, uptime & disk states require separate API calls and thus are not enabled by default. Glances needs to be running in \"web server\" mode to enable the API, see the glances docs.
- glances:\n url: http://host.or.ip:port\n username: user # optional if auth enabled in Glances\n password: pass # optional if auth enabled in Glances\n version: 4 # required only if running glances v4 or higher, defaults to 3\n cpu: true # optional, enabled by default, disable by setting to false\n mem: true # optional, enabled by default, disable by setting to false\n cputemp: true # disabled by default\n uptime: true # disabled by default\n disk: / # disabled by default, use mount point of disk(s) in glances. Can also be a list (see below)\n diskUnits: bytes # optional, bytes (default) or bbytes. Only applies to disk\n expanded: true # show the expanded view\n label: MyMachine # optional\nMultiple disks can be specified as:
disk:\n - /\n - /boot\n ...\nAdded in v0.4.18, updated in v0.6.11, v0.6.21
"},{"location":"widgets/info/greeting/","title":"Greeting","text":"This allows you to display simple text, can be configured like so:
- greeting:\n text_size: xl\n text: Greeting Text\nValid text sizes are 4xl, 3xl, 2xl, xl, md, sm, xs.
This is very similar to the Resources widget, but provides resource information about a Kubernetes cluster.
It provides CPU and Memory usage, by node and/or at the cluster level.
- kubernetes:\n cluster:\n # Shows cluster-wide statistics\n show: true\n # Shows the aggregate CPU stats\n cpu: true\n # Shows the aggregate memory stats\n memory: true\n # Shows a custom label\n showLabel: true\n label: \"cluster\"\n nodes:\n # Shows node-specific statistics\n show: true\n # Shows the CPU for each node\n cpu: true\n # Shows the memory for each node\n memory: true\n # Shows the label, which is always the node name\n showLabel: true\nThis allows you to display the homepage logo, you can optionally specify your own icon using similar options as other icons, see service icons.
- logo:\n icon: https://upload.wikimedia.org/wikipedia/commons/thumb/d/d5/I_Love_New_York.svg/1101px-I_Love_New_York.svg.png # optional\nAdded in v0.4.18, updated in 0.X.X
"},{"location":"widgets/info/longhorn/","title":"Longhorn","text":"The Longhorn widget pulls storage utilization metrics from the Longhorn storage driver on Kubernetes. It is designed to appear similar to the Resource widget's disk representation.
The exact metrics should be very similar to what is seen on the Longhorn dashboard itself.
It can show the aggregate metrics and/or the individual node metrics.
- longhorn:\n # Show the expanded view\n expanded: true\n # Shows a node representing the aggregate values\n total: true\n # Shows the node names as labels\n labels: true\n # Show the nodes\n nodes: true\n # An explicit list of nodes to show. All are shown by default if \"nodes\" is true\n include:\n - node1\n - node2\nThe Longhorn URL and credentials are stored in the providers section of the settings.yaml. e.g.:
providers:\n longhorn:\n username: \"longhorn-username\" # optional\n password: \"very-secret-longhorn-password\" # optional\n url: https://longhorn.aesop.network\nNo registration is required at all! See https://open-meteo.com/en/docs
- openmeteo:\n label: Kyiv # optional\n latitude: 50.449684\n longitude: 30.525026\n timezone: Europe/Kiev # optional\n units: metric # or imperial\n cache: 5 # Time in minutes to cache API responses, to stay within limits\n format: # optional, Intl.NumberFormat options\n maximumFractionDigits: 1\nYou can optionally not pass a latitude and longitude and the widget will use your current location (requires a secure context, eg. HTTPS).
The free tier \"One Call API\" is all that's required, you will need to subscribe and grab your API key.
- openweathermap:\n label: Kyiv #optional\n latitude: 50.449684\n longitude: 30.525026\n units: metric # or imperial\n provider: openweathermap\n apiKey: youropenweathermapkey # required only if not using provider, this reveals api key in requests\n cache: 5 # Time in minutes to cache API responses, to stay within limits\n format: # optional, Intl.NumberFormat options\n maximumFractionDigits: 1\nYou can optionally not pass a latitude and longitude and the widget will use your current location (requires a secure context, eg. HTTPS).
You can include all or some of the available resources. If you do not want to see that resource, simply pass false.
The disk path is the path reported by df (Mounted On), or the mount point of the disk.
The cpu and memory resource information are the container's usage while glances displays statistics for the host machine on which it is installed.
Note: unfortunately, the package used for getting CPU temp (systeminformation) is not compatible with some setups and will not report any value(s) for CPU temp.
Any disk you wish to access must be mounted to your container as a volume.
- resources:\n cpu: true\n memory: true\n disk: /disk/mount/path\n cputemp: true\n tempmin: 0 # optional, minimum cpu temp\n tempmax: 100 # optional, maximum cpu temp\n uptime: true\n units: imperial # only used by cpu temp\n refresh: 3000 # optional, in ms\n diskUnits: bytes # optional, bytes (default) or bbytes. Only applies to disk\nYou can also pass a label option, which allows you to group resources under named sections,
- resources:\n label: System\n cpu: true\n memory: true\n\n- resources:\n label: Storage\n disk: /mnt/storage\nWhich produces something like this,
If you have more than a single disk and would like to group them together under the same label, you can pass an array of paths instead,
- resources:\n label: Storage\n disk:\n - /mnt/storage\n - /mnt/backup\n - /mnt/media\nTo produce something like this,
You can additionally supply an optional expanded property set to true in order to show additional details about the resources. By default the expanded property is set to false when not supplied.
- resources:\n label: Array Disks\n expanded: true\n disk:\n - /disk1\n - /disk2\n - /disk3\nYou can add a search bar to your top widget area that can search using Google, Duckduckgo, Bing, Baidu, Brave or any other custom provider that supports the basic ?q= search query param.
- search:\n provider: google # google, duckduckgo, bing, baidu, brave or custom\n focus: true # Optional, will set focus to the search bar on page load\n showSearchSuggestions: true # Optional, will show search suggestions. Defaults to false\n target: _blank # One of _self, _blank, _parent or _top\nor for a custom search:
- search:\n provider: custom\n url: https://www.ecosia.org/search?q=\n target: _blank\n suggestionUrl: https://ac.ecosia.org/autocomplete?type=list&q= # Optional\n showSearchSuggestions: true # Optional\nmultiple providers is also supported via a dropdown (excluding custom):
- search:\n provider: [brave, google, duckduckgo]\nThe response body for the URL provided with the suggestionUrl option should look like this:
[\n \"home\",\n [\n \"home depot\",\n \"home depot near me\",\n \"home equity loan\",\n \"homeworkify\",\n \"homedepot.com\",\n \"homebase login\",\n \"home depot credit card\",\n \"home goods\"\n ]\n]\nThe first entry of the array contains the search query, the second one is an array of the suggestions. In the example above, the search query was home.
Added in v0.1.6, updated in 0.6.0
"},{"location":"widgets/info/unifi_controller/","title":"Unifi Controller","text":"(Find the Unifi Controller service widget here)
You can display general connectivity status from your Unifi (Network) Controller. When authenticating you will want to use a local account that has at least read privileges.
An optional 'site' parameter can be supplied, if it is not the widget will use the default site for the controller.
Note: If you enter e.g. incorrect credentials and receive an \"API Error\", you may need to recreate the container to clear the cache.
- unifi_console:\n url: https://unifi.host.or.ip:port\n username: user\n password: pass\n site: Site Name # optional\nAdded in v0.4.18, updated in 0.6.7
"},{"location":"widgets/info/weather/","title":"Weather API","text":"Note: this widget is considered 'deprecated' since there is no longer a free Weather API tier for new members. See the openmeteo or openweathermap widgets for alternatives.
The free tier is all that's required, you will need to register and grab your API key.
- weatherapi:\n label: Kyiv # optional\n latitude: 50.449684\n longitude: 30.525026\n units: metric # or imperial\n apiKey: yourweatherapikey\n cache: 5 # Time in minutes to cache API responses, to stay within limits\n format: # optional, Intl.NumberFormat options\n maximumFractionDigits: 1\nYou can optionally not pass a latitude and longitude and the widget will use your current location (requires a secure context, eg. HTTPS).
Learn more about Adguard Home.
The username and password are the same as used to login to the web interface.
Allowed fields: [\"queries\", \"blocked\", \"filtered\", \"latency\"].
widget:\n type: adguard\n url: http://adguard.host.or.ip\n username: admin\n password: password\nLearn more about Atsumeru.
Define same username and password that is used for login from web or supported apps
Allowed fields: [\"series\", \"archives\", \"chapters\", \"categories\"].
widget:\n type: atsumeru\n url: http://atsumeru.host.or.ip:port\n username: username\n password: password\nLearn more about Audiobookshelf.
You can find your API token by logging into the Audiobookshelf web app as an admin, go to the config \u2192 users page, and click on your account.
Allowed fields: [\"podcasts\", \"podcastsDuration\", \"books\", \"booksDuration\"]
widget:\n type: audiobookshelf\n url: http://audiobookshelf.host.or.ip:port\n key: audiobookshelflapikey\nLearn more about Authentik.
This widget reads the number of active users in the system, as well as logins for the last 24 hours.
You will need to generate an API token for an existing user under Admin Portal > Directory > Tokens & App passwords. Make sure to set Intent to \"API Token\".
The account you made the API token for also needs the following Assigned global permissions in Authentik:
Allowed fields: [\"users\", \"loginsLast24H\", \"failedLoginsLast24H\"].
widget:\n type: authentik\n url: http://authentik.host.or.ip:22070\n key: api_token\nLearn more about Autobrr.
Find your API key under Settings > API Keys.
Allowed fields: [\"approvedPushes\", \"rejectedPushes\", \"filters\", \"indexers\"].
widget:\n type: autobrr\n url: http://autobrr.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\nLearn more about Azure DevOps.
This widget has 2 functions:
Pipelines: checks if the relevant pipeline is running or not, and if not, reports the last status. Allowed fields: [\"result\", \"status\"].
Pull Requests: returns the amount of open PRs, the amount of the PRs you have open, and how many PRs that you open are marked as 'Approved' by at least 1 person and not yet completed. Allowed fields: [\"totalPrs\", \"myPrs\", \"approved\"].
You will need to generate a personal access token for an existing user, see the azure documentation
widget:\n type: azuredevops\n organization: myOrganization\n project: myProject\n definitionId: pipelineDefinitionId # required for pipelines\n branchName: branchName # optional for pipelines, leave empty for all\n userEmail: email # required for pull requests\n repositoryId: prRepositoryId # required for pull requests\n key: personalaccesstoken\nLearn more about Bazarr.
Find your API key under Settings > General.
Allowed fields: [\"missingEpisodes\", \"missingMovies\"].
widget:\n type: bazarr\n url: http://bazarr.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\nLearn more about Caddy.
Allowed fields: [\"upstreams\", \"requests\", \"requests_failed\"].
widget:\n type: caddy\n url: http://caddy.host.or.ip:adminport # default admin port is 2019\nThis widget shows monthly calendar, with optional integrations to show events from supported widgets.
widget:\n type: calendar\n firstDayInWeek: sunday # optional - defaults to monday\n view: monthly # optional - possible values monthly, agenda\n maxEvents: 10 # optional - defaults to 10\n showTime: true # optional - show time for event happening today - defaults to false\n timezone: America/Los_Angeles # optional and only when timezone is not detected properly (slightly slower performance) - force timezone for ical events (if it's the same - no change, if missing or different in ical - will be converted to this timezone)\n integrations: # optional\n - type: sonarr # active widget type that is currently enabled on homepage - possible values: radarr, sonarr, lidarr, readarr, ical\n service_group: Media # group name where widget exists\n service_name: Sonarr # service name for that widget\n color: teal # optional - defaults to pre-defined color for the service (teal for sonarr)\n params: # optional - additional params for the service\n unmonitored: true # optional - defaults to false, used with *arr stack\n - type: ical # Show calendar events from another service\n url: https://domain.url/with/link/to.ics # URL with calendar events\n name: My Events # required - name for these calendar events\n color: zinc # optional - defaults to pre-defined color for the service (zinc for ical)\n params: # optional - additional params for the service\n showName: true # optional - show name before event title in event line - defaults to false\nThis view shows only list of events from configured integrations
widget:\n type: calendar\n view: agenda\n maxEvents: 10 # optional - defaults to 10\n showTime: true # optional - show time for event happening today - defaults to false\n previousDays: 3 # optional - shows events since three days ago - defaults to 0\n integrations: # same as in Monthly view example\nCurrently integrated widgets are sonarr, radarr, lidarr and readarr.
Supported colors can be found on color palette.
"},{"location":"widgets/services/calendar/#ical","title":"iCal","text":"This custom integration allows you to show events from any calendar that supports iCal format, for example, Google Calendar (go to Settings, select specific calendar, go to Integrate calendar, copy URL from Public Address in iCal format).
Learn more about Calibre-web.
Note: widget requires calibre-web \u2265 v0.6.21.
Allowed fields: [\"books\", \"authors\", \"categories\", \"series\"].
widget:\n type: calibreweb\n url: http://your.calibreweb.host:port\n username: username\n password: password\nLearn more about Changedetection.io.
Find your API key under Settings > API.
widget:\n type: changedetectionio\n url: http://changedetection.host.or.ip:port\n key: apikeyapikeyapikeyapikeyapikey\nLearn more about Channels DVR Server.
widget:\n type: channelsdvrserver\n url: http://server.host.or.ip:port\nLearn more about Cloudflare Tunnels.
As of v0.6.10 this widget no longer accepts a Cloudflare global API key (or account email) due to security concerns. Instead, you should setup an API token which only requires the permissions Account.Cloudflare Tunnel:Read.
Allowed fields: [\"status\", \"origin_ip\"].
widget:\n type: cloudflared\n accountid: accountid # from zero trust dashboard url e.g. https://one.dash.cloudflare.com/<accountid>/home/quick-start\n tunnelid: tunnelid # found in tunnels dashboard under the tunnel name\n key: cloudflareapitoken # api token with `Account.Cloudflare Tunnel:Read` https://dash.cloudflare.com/profile/api-tokens\nLearn more about Coin Market Cap.
Get your API key from your CoinMarketCap Pro Dashboard.
Allowed fields: no configurable fields for this widget.
widget:\n type: coinmarketcap\n currency: GBP # Optional\n symbols: [BTC, LTC, ETH]\n key: apikeyapikeyapikeyapikeyapikey\n defaultinterval: 7d # Optional\nYou can also specify slugs instead of symbols (since symbols aren't guaranteed to be unique). If you supply both, slugs will be used. For example:
widget:\n type: coinmarketcap\n slugs: [chia-network, uniswap]\n key: apikeyapikeyapikeyapikeyapikey\nLearn more about Crowdsec.
See the crowdsec docs for information about registering a machine, in most instances you can use the default credentials (/etc/crowdsec/local_api_credentials.yaml).
Allowed fields: [\"alerts\", \"bans\"].
widget:\n type: crowdsec\n url: http://crowdsechostorip:port\n username: localhost # machine_id in crowdsec\n password: password\nThis widget can show information from custom self-hosted or third party API.
Fields need to be defined in the mappings section YAML object to correlate with the value in the APIs JSON object. Final field definition needs to be the key with the desired value information.
widget:\n type: customapi\n url: http://custom.api.host.or.ip:port/path/to/exact/api/endpoint\n refreshInterval: 10000 # optional - in milliseconds, defaults to 10s\n username: username # auth - optional\n password: password # auth - optional\n method: GET # optional, e.g. POST\n headers: # optional, must be object, see below\n requestBody: # optional, can be string or object, see below\n display: # optional, default to block, see below\n mappings:\n - field: key # needs to be YAML string or object\n label: Field 1\n format: text # optional - defaults to text\n - field: # needs to be YAML string or object\n path:\n to: key2\n format: number # optional - defaults to text\n label: Field 2\n - field: # needs to be YAML string or object\n path:\n to:\n another: key3\n label: Field 3\n format: percent # optional - defaults to text\n - field: key # needs to be YAML string or object\n label: Field 4\n format: date # optional - defaults to text\n locale: nl # optional\n dateStyle: long # optional - defaults to \"long\". Allowed values: `[\"full\", \"long\", \"medium\", \"short\"]`.\n timeStyle: medium # optional - Allowed values: `[\"full\", \"long\", \"medium\", \"short\"]`.\n - field: key # needs to be YAML string or object\n label: Field 5\n format: relativeDate # optional - defaults to text\n locale: nl # optional\n style: short # optional - defaults to \"long\". Allowed values: `[\"long\", \"short\", \"narrow\"]`.\n numeric: auto # optional - defaults to \"always\". Allowed values `[\"always\", \"auto\"]`.\n - field: key\n label: Field 6\n format: text\n additionalField: # optional\n field:\n hourly:\n time: other key\n color: theme # optional - defaults to \"\". Allowed values: `[\"theme\", \"adaptive\", \"black\", \"white\"]`.\n format: date # optional\nSupported formats for the values are text, number, float, percent, bytes, bitrate, date and relativeDate.
The dateStyle and timeStyle options of the date format are passed directly to Intl.DateTimeFormat and the style and numeric options of relativeDate are passed to Intl.RelativeTimeFormat.
For the following JSON object from the API:
{\n \"id\": 1,\n \"name\": \"Rick Sanchez\",\n \"status\": \"Alive\",\n \"species\": \"Human\",\n \"gender\": \"Male\",\n \"origin\": {\n \"name\": \"Earth (C-137)\"\n },\n \"locations\": [\n {\n \"name\": \"Earth (C-137)\"\n },\n {\n \"name\": \"Citadel of Ricks\"\n }\n ]\n}\nDefine the mappings section as an array, for example:
mappings:\n - field: name # Rick Sanchez\n label: Name\n - field: status # Alive\n label: Status\n - field:\n origin: name # Earth (C-137)\n label: Origin\n - field:\n locations:\n 1: name # Citadel of Ricks\n label: Location\nYou can manipulate data with the following tools remap, scale, prefix and suffix, for example:
- field: key4\n label: Field 4\n format: text\n remap:\n - value: 0\n to: None\n - value: 1\n to: Connected\n - any: true # will map all other values\n to: Unknown\n- field: key5\n label: Power\n format: float\n scale: 0.001 # can be number or string e.g. 1/16\n suffix: \"kW\"\n- field: key6\n label: Price\n format: float\n prefix: \"$\"\nYou can change the default block view to a list view by setting the display option to list.
The list view can optionally display an additional field next to the primary field.
additionalField: Similar to field, but only used in list view. Displays additional information for the mapping object on the right.
field: Defined the same way as other custom api widget fields.
color: Allowed options: \"theme\", \"adaptive\", \"black\", \"white\". The option adaptive will apply a color using the value of the additionalField, green for positive numbers, red for negative numbers.
- field: key\n label: Field\n format: text\n remap:\n - value: 0\n to: None\n - value: 1\n to: Connected\n - any: true # will map all other values\n to: Unknown\n additionalField:\n field:\n hourly:\n time: key\n color: theme\n format: date\nPass custom headers using the headers option, for example:
headers:\n X-API-Token: token\nPass custom request body using the requestBody option in either a string or object format. Objects will automatically be converted to a JSON string.
requestBody:\n foo: bar\n# or\nrequestBody: \"{\\\"foo\\\":\\\"bar\\\"}\"\nBoth formats result in {\"foo\":\"bar\"} being sent as the request body. Don't forget to set your Content-Type headers!
Learn more about Deluge.
Uses the same password used to login to the webui, see the deluge FAQ.
Allowed fields: [\"leech\", \"download\", \"seed\", \"upload\"].
widget:\n type: deluge\n url: http://deluge.host.or.ip\n password: password # webui password\nLearn more about Synology Disk Station.
Note: the widget is not compatible with 2FA.
An optional 'volume' parameter can be supplied to specify which volume's free space to display when more than one volume exists. The value of the parameter must be in form of volume_N, e.g. to display free space for volume2, volume_2 should be set as 'volume' value. If omitted, first returned volume's free space will be shown (not guaranteed to be volume1).
Allowed fields: [\"uptime\", \"volumeAvailable\", \"resources.cpu\", \"resources.mem\"].
To access these system metrics you need to connect to the DiskStation (DSM) with an account that is a member of the default Administrators group. That is because these metrics are requested from the API's SYNO.Core.System part that is only available to admin users. In order to keep the security impact as small as possible we can set the account in DSM up to limit the user's permissions inside the Synology system. In DSM 7.x, for instance, follow these steps:
remote_stats.User Groups tab of the user config dialogue check the box for Administrators.Permissions tab check the top box for No Access, effectively prohibiting the user from accessing anything in the shared folders.Applications check the box next to Deny in the header to explicitly prohibit login to all applications.DSM application, either byDeny in the respective row, or (if inheriting permission doesn't work because of other group settings)Allow for this app, orBy IP for this app to limit the source of login attempts to one or more IP addresses/subnets.Preview column shows Allow in the DSM row, click Save.Now configure the widget with the correct login information and test it.
If you encounter issues during testing:
Control Panel > Security > Protection.widget:\n type: diskstation\n url: http://diskstation.host.or.ip:port\n username: username\n password: password\n volume: volume_N # optional\nLearn more about Synology Download Station.
Note: the widget is not compatible with 2FA.
Allowed fields: [\"leech\", \"download\", \"seed\", \"upload\"].
widget:\n type: downloadstation\n url: http://downloadstation.host.or.ip:port\n username: username\n password: password\nLearn more about Emby.
You can create an API key from inside Emby at Settings > Advanced > Api Keys.
As of v0.6.11 the widget supports fields [\"movies\", \"series\", \"episodes\", \"songs\"]. These blocks are disabled by default but can be enabled with the enableBlocks option, and the \"Now Playing\" feature (enabled by default) can be disabled with the enableNowPlaying option.
widget:\n type: emby\n url: http://emby.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\n enableBlocks: true # optional, defaults to false\n enableNowPlaying: true # optional, defaults to true\n enableUser: true # optional, defaults to false\n showEpisodeNumber: true # optional, defaults to false\n expandOneStreamToTwoRows: false # optional, defaults to true\nLearn more about ESPHome.
Show the number of ESPHome devices based on their state.
Allowed fields: [\"total\", \"online\", \"offline\", \"offline_alt\", \"unknown\"] (maximum of 4).
By default ESPHome will only mark devices as offline if their address cannot be pinged. If it has an invalid config or its name cannot be resolved (by DNS) its status will be marked as unknown. To group both offline and unknown devices together, users should use the offline_alt field instead. This sums all devices that are not online together.
widget:\n type: esphome\n url: http://esphome.host.or.ip:port\nLearn more about EVSS.
Allowed fields: [\"pv_power\", \"grid_power\", \"home_power\", \"charge_power].
widget:\n type: evcc\n url: http://evcc.host.or.ip:port\nLearn more about FileFlows.
Allowed fields: [\"queue\", \"processing\", \"processed\", \"time\"].
widget:\n type: fileflows\n url: http://your.fileflows.host:port\nLearn more about Flood.
Allowed fields: [\"leech\", \"download\", \"seed\", \"upload\"].
widget:\n type: flood\n url: http://flood.host.or.ip\n username: username # if set\n password: password # if set\nLearn more about FreshRSS.
Please refer to Enable the API in FreshRSS for the \"API password\" to be entered in the password field.
Allowed fields: [\"subscriptions\", \"unread\"].
widget:\n type: freshrss\n url: http://freshrss.host.or.ip:port\n username: username\n password: password\nApplication access & UPnP must be activated on your device:
Home Network > Network > Network Settings > Access Settings in the Home Network\n[x] Allow access for applications\n[x] Transmit status information over UPnP\nCredentials are not needed and, as such, you may want to consider using http instead of https as those requests are significantly faster.
Allowed fields (limited to a max of 4): [\"connectionStatus\", \"uptime\", \"maxDown\", \"maxUp\", \"down\", \"up\", \"received\", \"sent\", \"externalIPAddress\"].
widget:\n type: fritzbox\n url: http://192.168.178.1\nLearn more about GameDig.
Uses the GameDig library to get game server information for any supported server type.
Allowed fields (limited to a max of 4): [\"status\", \"name\", \"map\", \"currentPlayers\", \"players\", \"maxPlayers\", \"bots\", \"ping\"].
widget:\n type: gamedig\n serverType: csgo # see https://github.com/gamedig/node-gamedig#games-list\n url: udp://server.host.or.ip:port\nAllowed fields: [\"up\", \"down\", \"uptime\"].
widget:\n type: gatus\n url: http://gatus.host.or.ip:port\nLearn more about Ghostfolio.
Authentication requires manually obtaining a Bearer token which can be obtained by make a POST request to the API e.g.
curl -X POST http://localhost:3333/api/v1/auth/anonymous -H 'Content-Type: application/json' -d '{ \"accessToken\": \"SECURITY_TOKEN_OF_ACCOUNT\" }'\nSee the official docs.
Note that the Bearer token is valid for 6 months, after which a new one must be generated.
Allowed fields: [\"gross_percent_today\", \"gross_percent_1y\", \"gross_percent_max\"]
widget:\n type: ghostfolio\n url: http://ghostfoliohost:port\n key: ghostfoliobearertoken\nLearn more about Gitea.
API token requires notifications, repository and issue permissions. See the gitea documentation for details on generating tokens.
Allowed fields: [\"notifications\", \"issues\", \"pulls\"].
widget:\n type: gitea\n url: http://gitea.host.or.ip:port\n key: giteaapitoken\nLearn more about Glances.
(Find the Glances information widget here)
The Glances widget allows you to monitor the resources (cpu, memory, diskio, sensors & processes) of host or another machine. You can have multiple instances by adding another service block.
widget:\n type: glances\n url: http://glances.host.or.ip:port\n username: user # optional if auth enabled in Glances\n password: pass # optional if auth enabled in Glances\n version: 4 # required only if running glances v4 or higher, defaults to 3\n metric: cpu\n diskUnits: bytes # optional, bytes (default) or bbytes. Only applies to disk\n refreshInterval: 5000 # optional - in milliseconds, defaults to 1000 or more, depending on the metric\n pointsLimit: 15 # optional, defaults to 15\nPlease note, this widget does not need an href, icon or description on its parent service. To achieve the same effect as the examples above, see as an example:
- CPU Usage:\n widget:\n type: glances\n url: http://glances.host.or.ip:port\n metric: cpu\n- Network Usage:\n widget:\n type: glances\n url: http://glances.host.or.ip:port\n metric: network:enp0s25\nThe metric field in the configuration determines the type of system monitoring data to be displayed. Here are the supported metrics:
info: System information. Shows the system's hostname, OS, kernel version, CPU type, CPU usage, RAM usage and SWAP usage.
cpu: CPU usage. Shows how much of the system's computational resources are currently being used.
memory: Memory usage. Shows how much of the system's RAM is currently being used.
process: Top 5 processes based on CPU usage. Gives an overview of which processes are consuming the most resources.
network:<interface_name>: Network data usage for the specified interface. Replace <interface_name> with the name of your network interface, e.g., network:enp0s25, as specified in glances.
sensor:<sensor_id>: Temperature of the specified sensor, typically used to monitor CPU temperature. Replace <sensor_id> with the name of your sensor, e.g., sensor:Package id 0 as specified in glances.
disk:<disk_id>: Disk I/O data for the specified disk. Replace <disk_id> with the id of your disk, e.g., disk:sdb, as specified in glances.
gpu:<gpu_id>: GPU usage for the specified GPU. Replace <gpu_id> with the id of your GPU, e.g., gpu:0, as specified in glances.
fs:<mnt_point>: Disk usage for the specified mount point. Replace <mnt_point> with the path of your disk, e.g., /mnt/storage, as specified in glances.
All widgets offer an alternative to the full or \"graph\" view, which is the compact, or \"graphless\" view.
To switch to the alternative \"graphless\" view, simply pass chart: false as an option to the widget, like so:
- Network Usage:\n widget:\n type: glances\n url: http://glances.host.or.ip:port\n metric: network:enp0s25\n chart: false\nLearn more about Gluetun.
Note
Requires HTTP control server options to be enabled. By default this runs on port 8000.
Allowed fields: [\"public_ip\", \"region\", \"country\"].
widget:\n type: gluetun\n url: http://gluetun.host.or.ip:port\nLearn more about Gotify.
Get a Gotify client token from an existing client or create a new one on your Gotify admin page.
Allowed fields: [\"apps\", \"clients\", \"messages\"].
widget:\n type: gotify\n url: http://gotify.host.or.ip\n key: clientoken\nLearn more about Grafana.
Allowed fields: [\"dashboards\", \"datasources\", \"totalalerts\", \"alertstriggered\"].
widget:\n type: grafana\n url: http://grafana.host.or.ip:port\n username: username\n password: password\nLearn more about HDHomerun.
Allowed fields: [\"channels\", \"hd\", \"tunerCount\", \"channelNumber\", \"channelNetwork\", \"signalStrength\", \"signalQuality\", \"symbolQuality\", \"networkRate\", \"clientIP\" ].
If more than 4 fields are provided, only the first 4 are displayed.
widget:\n type: hdhomerun\n url: http://hdhomerun.host.or.ip\n tuner: 0 # optional - defaults to 0, used for tuner-specific fields\n fields: [\"channels\", \"hd\"] # optional - default fields shown\nLearn more about Health Checks.
Specify a single check by including the uuid field or show the total 'up' and 'down' for all checks by leaving off the uuid field.
To use the Health Checks widget, you first need to generate an API key.
Allowed fields: [\"status\", \"last_ping\"] for single checks, [\"up\", \"down\"] for total stats.
widget:\n type: healthchecks\n url: http://healthchecks.host.or.ip:port\n key: <YOUR_API_KEY>\n uuid: <CHECK_UUID> # optional, if not included total statistics for all checks is shown\nLearn more about Home Assistant.
You will need to generate a long-lived access token for an existing Home Assistant user in its profile.
Allowed fields: [\"people_home\", \"lights_on\", \"switches_on\"].
Up to a maximum of four custom states and/or templates can be queried via the custom property like in the example below. The custom property will have no effect as long as the fields property is defined.
state will query the state of the specified entity_id\"{attributes.friendly_name}\"\"{state} {attributes.unit_of_measurement}\"template will query the specified template, see Home Assistant Templatingwidget:\n type: homeassistant\n url: http://homeassistant.host.or.ip:port\n key: access_token\n custom:\n - state: sensor.total_power\n - state: sensor.total_energy_today\n label: energy today\n - template: \"{{ states.switch|selectattr('state','equalto','on')|list|length }}\"\n label: switches on\n - state: weather.forecast_home\n label: wind speed\n value: \"{attributes.wind_speed} {attributes.wind_speed_unit}\"\nLearn more about Homebox.
Uses the same username and password used to login from the web.
The totalValue field will attempt to format using the currency you have configured in Homebox.
Allowed fields: [\"items\", \"totalWithWarranty\", \"locations\", \"labels\", \"users\", \"totalValue\"].
If more than 4 fields are provided, only the first 4 are displayed.
widget:\n type: homebox\n url: http://homebox.host.or.ip:port\n username: username\n password: password\n fields: [\"items\", \"locations\", \"totalValue\"] # optional - default fields shown\nLearn more about Homebridge.
The Homebridge API is actually provided by the Config UI X plugin that has been included with Homebridge for a while, still it is required to be installed for this widget to work.
Allowed fields: [\"updates\", \"child_bridges\"].
widget:\n type: homebridge\n url: http://homebridge.host.or.ip:port\n username: username\n password: password\nA basic iFrame widget to show external content, see the MDN docs for more details about some of the options.
Warning
Requests made via the iFrame widget are inherently not proxied as they are made from the browser itself.
"},{"location":"widgets/services/iframe/#basic-example","title":"Basic Example","text":"widget:\n type: iframe\n name: myIframe\n src: http://example.com\nwidget:\n type: iframe\n name: myIframe\n src: http://example.com\n classes: h-60 sm:h-60 md:h-60 lg:h-60 xl:h-60 2xl:h-72 # optional, use tailwind height classes, see https://tailwindcss.com/docs/height\n referrerPolicy: same-origin # optional, no default\n allowPolicy: autoplay; fullscreen; gamepad # optional, no default\n allowFullscreen: false # optional, default: true\n loadingStrategy: eager # optional, default: eager\n allowScrolling: no # optional, default: yes\n refreshInterval: 2000 # optional, no default\nLearn more about Immich.
Find your API key under Account Settings > API Keys.
Allowed fields: [\"users\" ,\"photos\", \"videos\", \"storage\"].
Note that API key must be from admin user.
widget:\n type: immich\n url: http://immich.host.or.ip\n key: adminapikeyadminapikeyadminapikey\nLearn more about Jackett.
If Jackett has an admin password set, you must set the password field for the widget to work.
Allowed fields: [\"configured\", \"errored\"].
widget:\n type: jackett\n url: http://jackett.host.or.ip\n password: jackettadminpassword # optional\nLearn more about JDownloader.
Basic widget to show number of items in download queue, along with the queue size and current download speed.
Allowed fields: [\"downloadCount\", \"downloadTotalBytes\",\"downloadBytesRemaining\", \"downloadSpeed\"].
widget:\n type: jdownloader\n username: JDownloader Username\n password: JDownloader Password\n client: Name of JDownloader Instance\nLearn more about Jellyfin.
You can create an API key from inside Jellyfin at Settings > Advanced > Api Keys.
As of v0.6.11 the widget supports fields [\"movies\", \"series\", \"episodes\", \"songs\"]. These blocks are disabled by default but can be enabled with the enableBlocks option, and the \"Now Playing\" feature (enabled by default) can be disabled with the enableNowPlaying option.
widget:\n type: jellyfin\n url: http://jellyfin.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\n enableBlocks: true # optional, defaults to false\n enableNowPlaying: true # optional, defaults to true\n enableUser: true # optional, defaults to false\n showEpisodeNumber: true # optional, defaults to false\n expandOneStreamToTwoRows: false # optional, defaults to true\nLearn more about Jellyseerr.
Find your API key under Settings > General > API Key.
Allowed fields: [\"pending\", \"approved\", \"available\"].
widget:\n type: jellyseerr\n url: http://jellyseerr.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\nLearn more about Kavita.
Uses the same admin role username and password used to login from the web.
Allowed fields: [\"seriesCount\", \"totalFiles\"].
widget:\n type: kavita\n url: http://kavita.host.or.ip:port\n username: username\n password: password\nLearn more about Komga.
Uses the same username and password used to login from the web.
Allowed fields: [\"libraries\", \"series\", \"books\"].
widget:\n type: komga\n url: http://komga.host.or.ip:port\n username: username\n password: password\nLearn more about Kopia.
Allowed fields: [\"status\", \"size\", \"lastrun\", \"nextrun\"].
You may optionally pass values for snapshotHost and / or snapshotPath to select a specific backup source for the widget.
widget:\n type: kopia\n url: http://kopia.host.or.ip:port\n username: username\n password: password\n snapshotHost: hostname # optional\n snapshotPath: path # optional\nLearn more about Lidarr.
Find your API key under Settings > General.
Allowed fields: [\"wanted\", \"queued\", \"artists\"].
widget:\n type: lidarr\n url: http://lidarr.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\nLearn more about Mastodon.
Use the base URL of the Mastodon instance you'd like to pull stats for. Does not require authentication as the stats are part of the public API endpoints.
Allowed fields: [\"user_count\", \"status_count\", \"domain_count\"].
widget:\n type: mastodon\n url: https://mastodon.host.name\nLearn more about Mealie.
Generate a user API key under Profile > Manage Your API Tokens > Generate.
Allowed fields: [\"recipes\", \"users\", \"categories\", \"tags\"].
widget:\n type: mealie\n url: http://mealie-frontend.host.or.ip\n key: mealieapitoken\nLearn more about Medusa.
Allowed fields: [\"wanted\", \"queued\", \"series\"].
widget:\n type: medusa\n url: http://medusa.host.or.ip:port\n key: medusaapikeyapikeyapikeyapikeyapikey\nHTTPS may be required, per the documentation
Allowed fields: [\"uptime\", \"cpuLoad\", \"memoryUsed\", \"numberOfLeases\"].
widget:\n type: mikrotik\n url: https://mikrotik.host.or.ip\n username: username\n password: password\nAllowed fields: [\"players\", \"version\", \"status\"].
widget:\n type: minecraft\n url: udp://minecraftserveripordomain:port\nLearn more about Miniflux.
Api key is found under Settings > API keys
Allowed fields: [\"unread\", \"read\"].
widget:\n type: miniflux\n url: http://miniflux.host.or.ip:port\n key: minifluxapikey\nPass the stream URL from a service like \u00b5Streamer or camera-streamer.
widget:\n type: mjpeg\n stream: http://mjpeg.host.or.ip/webcam/stream\nLearn more about Moonraker.
Allowed fields: [\"printer_state\", \"print_status\", \"print_progress\", \"layers\"].
widget:\n type: moonraker\n url: http://moonraker.host.or.ip:port\nIf your moonraker instance has an active authorization and your homepage ip isn't whitelisted you need to add your api key (Authorization Documentation).
widget:\n type: moonraker\n url: http://moonraker.host.or.ip:port\n key: api_keymoonraker\nLearn more about Mylar3.
API must be enabled in Mylar3 settings.
Allowed fields: [\"series\", \"issues\", \"wanted\"].
widget:\n type: mylar\n url: http://mylar3.host.or.ip:port\n key: yourmylar3apikey\nLearn more about Navidrome.
For detailed information about how to generate the token see http://www.subsonic.org/pages/api.jsp.
Allowed fields: no configurable fields for this widget.
widget:\n type: navidrome\n url: http://navidrome.host.or.ip:port\n user: username\n token: token #md5(password + salt)\n salt: randomsalt\nLearn more about NetAlertX.
Note that the project was renamed from PiAlert to NetAlertX.
Allowed fields: [\"total\", \"connected\", \"new_devices\", \"down_alerts\"].
widget:\n type: netalertx\n url: http://ip:port\nLearn more about Netdata.
Allowed fields: [\"warnings\", \"criticals\"].
widget:\n type: netdata\n url: http://netdata.host.or.ip\nLearn more about Nextcloud.
Use username & password, or the NC-Token key. Information about the token can be found under Settings > System. If both are provided, NC-Token will be used.
Allowed fields: [\"cpuload\", \"memoryusage\", \"freespace\", \"activeusers\", \"numfiles\", \"numshares\"].
Note \"cpuload\" and \"memoryusage\" were deprecated in v0.6.18 and a maximum of 4 fields can be displayed.
widget:\n type: nextcloud\n url: https://nextcloud.host.or.ip:port\n key: token\nwidget:\n type: nextcloud\n url: https://nextcloud.host.or.ip:port\n username: username\n password: password\nLearn more about NextDNS.
Api key is found under Account > API, profile ID is found under Setup > Endpoints > ID
widget:\n type: nextdns\n profile: profileid\n key: yourapikeyhere\nLearn more about Nginx Proxy Manager.
Login with the same admin username and password used to access the web UI.
Allowed fields: [\"enabled\", \"disabled\", \"total\"].
widget:\n type: npm\n url: http://npm.host.or.ip\n username: admin_username\n password: admin_password\nLearn more about NZBget.
This widget uses the same authentication method as your browser when logging in (HTTP Basic Auth), and is often referred to as the ControlUsername and ControlPassword inside of Nzbget documentation.
Allowed fields: [\"rate\", \"remaining\", \"downloaded\"].
widget:\n type: nzbget\n url: http://nzbget.host.or.ip\n username: controlusername\n password: controlpassword\nLearn more about OctoPrint.
Allowed fields: [\"printer_state\", \"temp_tool\", \"temp_bed\", \"job_completion\"].
widget:\n type: octoprint\n url: http://octoprint.host.or.ip:port\n key: youroctoprintapikey\nThe widget supports controller versions 3, 4 and 5.
Allowed fields: [\"connectedAp\", \"activeUser\", \"alerts\", \"connectedGateways\", \"connectedSwitches\"].
widget:\n type: omada\n url: http://omada.host.or.ip:port\n username: username\n password: password\n site: sitename\nLearn more about Ombi.
Find your API key under Settings > Configuration > General.
Allowed fields: [\"pending\", \"approved\", \"available\"].
widget:\n type: ombi\n url: http://ombi.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\nLearn more about OpenDTU.
Allowed fields: [\"yieldDay\", \"relativePower\", \"absolutePower\", \"limit\"].
widget:\n type: opendtu\n url: http://opendtu.host.or.ip\nLearn more about OpenMediaVault.
Provides useful information from your OpenMediaVault
widget:\n type: openmediavault\n url: http://omv.host.or.ip\n username: admin\n password: pass\n method: services.getStatus # required\nThe method field determines the type of data to be displayed and is required. Supported methods:
services.getStatus: Shows status of running services. Allowed fields: [\"running\", \"stopped\", \"total\"]
smart.getListBg: Shows S.M.A.R.T. status from disks. Allowed fields: [\"passed\", \"failed\"]
downloader.getDownloadList: Displays the number of tasks from the Downloader plugin currently being downloaded and total. Allowed fields: [\"downloading\", \"total\"]
Learn more about OpenWRT.
Provides information from OpenWRT
widget:\n type: openwrt\n url: http://host.or.ip\n username: homepage\n password: pass\n interfaceName: eth0 # optional\nSetting interfaceName (e.g. eth0) will display information for that particular device, otherwise the widget will display general system info.
In order for homepage to access the OpenWRT RPC endpoints you will need to create an ACL and new user in OpenWRT.
Create an ACL named homepage.json in /usr/share/rpcd/acl.d/, the following permissions will suffice:
{\n \"homepage\": {\n \"description\": \"Homepage widget\",\n \"read\": {\n \"ubus\": {\n \"network.interface.wan\": [\"status\"],\n \"network.interface.lan\": [\"status\"],\n \"network.device\": [\"status\"],\n \"system\": [\"info\"]\n }\n }\n }\n}\nCreate a crypt(5) password hash using the following command in the OpenWRT shell:
uhttpd -m \"<somepassphrase>\"\nThen add a user that will use the ACL and hashed password in /etc/config/rpcd:
config login\n option username 'homepage'\n option password '<hashedpassword>'\n list read homepage\nThis username and password will be used in Homepage's services.yaml to grant access.
"},{"location":"widgets/services/opnsense/","title":"OPNSense","text":"Learn more about OPNSense.
The API key & secret can be generated via the webui by creating a new user at System/Access/Users. Ensure \"Generate a scrambled password to prevent local database logins for this user\" is checked and then edit the effective privileges selecting only:
Finally, create a new API key which will download an apikey.txt file with your key and secret in it. Use the values as the username and password fields, respectively, in your homepage config.
Allowed fields: [\"cpu\", \"memory\", \"wanUpload\", \"wanDownload\"].
widget:\n type: opnsense\n url: http://opnsense.host.or.ip\n username: key\n password: secret\nLearn more about Overseerr.
Find your API key under Settings > General.
Allowed fields: [\"pending\", \"approved\", \"available\", \"processing\"].
widget:\n type: overseerr\n url: http://overseerr.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\nLearn more about Paperless-ngx.
Use username & password, or the token key. Information about the token can be found in the Paperless-ngx API documentation. If both are provided, the token will be used.
Allowed fields: [\"total\", \"inbox\"].
widget:\n type: paperlessngx\n url: http://paperlessngx.host.or.ip:port\n username: username\n password: password\nwidget:\n type: paperlessngx\n url: http://paperlessngx.host.or.ip:port\n key: token\nLearn more about PeaNUT.
This widget adds support for Network UPS Tools via a third party tool, PeaNUT.
The default ups name is ups. To configure more than one ups, you must create multiple peanut services.
Allowed fields: [\"battery_charge\", \"ups_load\", \"ups_status\"].
Note
This widget requires an additional tool, PeaNUT, as noted. Other projects exist to achieve similar results using a customapi widget, for example NUTCase.
widget:\n type: peanut\n url: http://peanut.host.or.ip:port\n key: nameofyourups\nLearn more about pfSense.
This widget requires the installation of the pfsense-api which is a 3rd party package for pfSense routers.
Once pfSense API is installed, you can set the API to be read-only in System > API > Settings.
There are two currently supported authentication modes: 'Local Database' and 'API Token'. For 'Local Database', use username and password with the credentials of an admin user. For 'API Token', utilize the headers parameter with client_token and client_id obtained from pfSense as shown below. Do not use both headers and username / password.
The interface to monitor is defined by updating the wan parameter. It should be referenced as it is shown under Interfaces > Assignments in pfSense.
Load is returned instead of cpu utilization. This is a limitation in the pfSense API due to the complexity of this calculation. This may become available in future versions.
Allowed fields: [\"load\", \"memory\", \"temp\", \"wanStatus\", \"wanIP\", \"disk\"] (maximum of 4)
widget:\n type: pfsense\n url: http://pfsense.host.or.ip:port\n username: user # optional, or API token\n password: pass # optional, or API token\n headers: # optional, or username/password\n Authorization: client_id client_token\n wan: igb0\n fields: [\"load\", \"memory\", \"temp\", \"wanStatus\"] # optional\nLearn more about PhotoPrism..
Allowed fields: [\"albums\", \"photos\", \"videos\", \"people\"].
widget:\n type: photoprism\n url: http://photoprism.host.or.ip:port\n username: admin\n password: password\nLearn more about PiHole.
As of v2022.12 PiHole requires the use of an API key if an admin password is set. Older versions do not require any authentication even if the admin uses a password.
Allowed fields: [\"queries\", \"blocked\", \"blocked_percent\", \"gravity\"].
Note: by default the \"blocked\" and \"blocked_percent\" fields are merged e.g. \"1,234 (15%)\" but explicitly including the \"blocked_percent\" field will change them to display separately.
widget:\n type: pihole\n url: http://pi.hole.or.ip\n version: 6 # required if running v6 or higher, defaults to 5\n key: yourpiholeapikey # optional\nAdded in v0.1.0, updated in v0.8.9
"},{"location":"widgets/services/plantit/","title":"Plant-it","text":"Learn more about Plantit.
API key can be created from the REST API.
Allowed fields: [\"events\", \"plants\", \"photos\", \"species\"].
widget:\n type: plantit\n url: http://plant-it.host.or.ip:port # api port\n key: plantit-api-key\nLearn more about Tautulli.
Provides detailed information about currently active streams. You can find the API key from inside Tautulli at Settings > Web Interface > API.
Allowed fields: no configurable fields for this widget.
widget:\n type: tautulli\n url: http://tautulli.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\n enableUser: true # optional, defaults to false\n showEpisodeNumber: true # optional, defaults to false\n expandOneStreamToTwoRows: false # optional, defaults to true\nLearn more about Plex.
The core Plex API is somewhat limited but basic info regarding library sizes and the number of active streams is supported. For more detailed info regarding active streams see the Plex Tautulli widget.
Allowed fields: [\"streams\", \"albums\", \"movies\", \"tv\"].
widget:\n type: plex\n url: http://plex.host.or.ip:32400\n key: mytokenhere # see https://www.plexopedia.com/plex-media-server/general/plex-token/\nLearn more about Portainer.
You'll need to make sure you have the correct environment set for the integration to work properly. From the Environments section inside of Portainer, click the one you'd like to connect to and observe the ID at the end of the URL (should be), something like #!/endpoints/1, here 1 is the value to set as the env value. In order to generate an API key, please follow the steps outlined here https://docs.portainer.io/api/access.
Allowed fields: [\"running\", \"stopped\", \"total\"].
widget:\n type: portainer\n url: https://portainer.host.or.ip:9443\n env: 1\n key: ptr_accesskeyaccesskeyaccesskeyaccesskey\nLearn more about Prometheus.
Allowed fields: [\"targets_up\", \"targets_down\", \"targets_total\"].
widget:\n type: prometheus\n url: http://prometheushost:port\nLearn more about Prowlarr.
Find your API key under Settings > General.
Allowed fields: [\"numberOfGrabs\", \"numberOfQueries\", \"numberOfFailGrabs\", \"numberOfFailQueries\"].
widget:\n type: prowlarr\n url: http://prowlarr.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\nLearn more about Proxmox.
This widget shows the running and total counts of both QEMU VMs and LX Containers in the Proxmox cluster. It also shows the CPU and memory usage of the first node in the cluster.
You will need to generate an API Token for new or an existing user. Here is an example of how to do this for a new user.
apihomepageUse username@pam!Token ID as the username (e.g api@pam!homepage) setting and Secret as the password setting.
Allowed fields: [\"vms\", \"lxc\", \"resources.cpu\", \"resources.mem\"].
You can set the optional node setting when you want to show metrics for a single node. By default it will show the average for the complete cluster.
widget:\n type: proxmox\n url: https://proxmox.host.or.ip:8006\n username: api_token_id\n password: api_token_secret\n node: pve-1 # optional\nLearn more about Proxmox Backup Server.
Allowed fields: [\"datastore_usage\", \"failed_tasks_24h\", \"cpu_usage\", \"memory_usage\"].
widget:\n type: proxmoxbackupserver\n url: https://proxmoxbackupserver.host:port\n username: api_token_id\n password: api_token_secret\nLearn more about Pterodactyl.
Allowed fields: [\"nodes\", \"servers\"].
widget:\n type: pterodactyl\n url: http://pterodactylhost:port\n key: pterodactylapikey\nLearn more about Pyload.
Allowed fields: [\"speed\", \"active\", \"queue\", \"total\"].
widget:\n type: pyload\n url: http://pyload.host.or.ip:port\n username: username\n password: password # only needed if set\nLearn more about qBittorrent.
Uses the same username and password used to login from the web.
Allowed fields: [\"leech\", \"download\", \"seed\", \"upload\"].
widget:\n type: qbittorrent\n url: http://qbittorrent.host.or.ip\n username: username\n password: password\nLearn more about QNAP.
Allowed fields: [\"cpuUsage\", \"memUsage\", \"systemTempC\", \"poolUsage\", \"volumeUsage\"].
widget:\n type: qnap\n url: http://qnap.host.or.ip:port\n username: user\n password: pass\nIf the QNAP device has multiple volumes, the poolUsage will be a sum of all volumes.
If only a single volume needs to be tracked, add the following to your configuration and the Widget will track this as volumeUsage:
volume: Volume Name From QNAP\nLearn more about Radarr.
Find your API key under Settings > General.
Allowed fields: [\"wanted\", \"missing\", \"queued\", \"movies\"].
A detailed queue listing is disabled by default, but can be enabled with the enableQueue option.
widget:\n type: radarr\n url: http://radarr.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\n enableQueue: true # optional, defaults to false\nLearn more about Readarr.
Find your API key under Settings > General.
Allowed fields: [\"wanted\", \"queued\", \"books\"].
widget:\n type: readarr\n url: http://readarr.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\nAllowed fields: [\"platforms\", \"totalRoms\"].
widget:\n type: romm\n url: http://romm.host.or.ip\n username: username # optional\n password: password # optional\nLearn more about ruTorrent.
This requires the httprpc plugin to be installed and enabled, and is part of the default ruTorrent plugins. If you have not explicitly removed or disable this plugin, it should be available.
Allowed fields: [\"active\", \"upload\", \"download\"].
widget:\n type: rutorrent\n url: http://rutorrent.host.or.ip\n username: username # optional, false if not used\n password: password # optional, false if not used\nLearn more about SABnzbd.
Find your API key under Config > General.
Allowed fields: [\"rate\", \"queue\", \"timeleft\"].
widget:\n type: sabnzbd\n url: http://sabnzbd.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\nLearn more about Scrutiny.
Allowed fields: [\"passed\", \"failed\", \"unknown\"].
widget:\n type: scrutiny\n url: http://scrutiny.host.or.ip\nLearn more about Sonarr.
Find your API key under Settings > General.
Allowed fields: [\"wanted\", \"queued\", \"series\"].
A detailed queue listing is disabled by default, but can be enabled with the enableQueue option.
widget:\n type: sonarr\n url: http://sonarr.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\n enableQueue: true # optional, defaults to false\nLearn more about Speedtest Tracker. or Speedtest Tracker
No extra configuration is required.
This widget is compatible with both alexjustesen/speedtest-tracker and henrywhitaker3/Speedtest-Tracker.
Allowed fields: [\"download\", \"upload\", \"ping\"].
widget:\n type: speedtest\n url: http://speedtest.host.or.ip\n bitratePrecision: 3 # optional, default is 0\nLearn more about Stash.
Find your API key from inside Stash at Settings > Security > API Key. Note that the API key is only required if your Stash instance has login credentials.
Allowed fields: [\"scenes\", \"scenesPlayed\", \"playCount\", \"playDuration\", \"sceneSize\", \"sceneDuration\", \"images\", \"imageSize\", \"galleries\", \"performers\", \"studios\", \"movies\", \"tags\", \"oCount\"].
If more than 4 fields are provided, only the first 4 are displayed.
widget:\n type: stash\n url: http://stash.host.or.ip\n key: stashapikey\n fields: [\"scenes\", \"images\"] # optional - default fields shown\nLearn more about SWAG Dashboard.
Allowed fields: [\"proxied\", \"auth\", \"outdated\", \"banned\"].
widget:\n type: swagdashboard\n url: http://swagdashboard.host.or.ip:adminport # default port is 81\nLearn more about Syncthing Relay Server.
Pulls stats from the relay server. See here for more information on configuration.
Allowed fields: [\"numActiveSessions\", \"numConnections\", \"bytesProxied\"].
widget:\n type: strelaysrv\n url: http://syncthing.host.or.ip:22070\nLearn more about Tailscale.
You will need to generate an API access token from the keys page on the Tailscale dashboard.
To find your device ID, go to the machine overview page and select your machine. In the \"Machine Details\" section, copy your ID. It will end with CNTRL.
Allowed fields: [\"address\", \"last_seen\", \"expires\"].
widget:\n type: tailscale\n deviceid: deviceid\n key: tailscalekey\nGenerate a user API key under Settings > API > Generate. For the token's scope, use read.
Allowed fields: [\"users\", \"recipes\", \"keywords\"].
widget:\n type: tandoor\n url: http://tandoor-frontend.host.or.ip\n key: tandoor-api-token\nLearn more about Tdarr.
Allowed fields: [\"queue\", \"processed\", \"errored\", \"saved\"].
widget:\n type: tdarr\n url: http://tdarr.host.or.ip\nLearn more about Traefik.
No extra configuration is required. If your traefik install requires authentication, include the username and password used to login to the web interface.
Allowed fields: [\"routers\", \"services\", \"middleware\"].
widget:\n type: traefik\n url: http://traefik.host.or.ip\n username: username # optional\n password: password # optional\nLearn more about Transmission.
Uses the same username and password used to login from the web.
Allowed fields: [\"leech\", \"download\", \"seed\", \"upload\"].
widget:\n type: transmission\n url: http://transmission.host.or.ip\n username: username\n password: password\n rpcUrl: /transmission/ # Optional. Matches the value of \"rpc-url\" in your Transmission's settings.json file\nLearn more about TrueNas.
Allowed fields: [\"load\", \"uptime\", \"alerts\"].
To create an API Key, follow the official TrueNAS documentation.
A detailed pool listing is disabled by default, but can be enabled with the enablePools option.
To use the enablePools option with TrueNAS Core, the nasType parameter is required.
widget:\n type: truenas\n url: http://truenas.host.or.ip\n username: user # not required if using api key\n password: pass # not required if using api key\n key: yourtruenasapikey # not required if using username / password\n enablePools: true # optional, defaults to false\n nasType: scale # defaults to scale, must be set to 'core' if using enablePools with TrueNAS Core\nLearn more about Tube Archivist.
Requires API key.
Allowed fields: [\"downloads\", \"videos\", \"channels\", \"playlists\"].
widget:\n type: tubearchivist\n url: http://tubearchivist.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\nLearn more about Unifi Controller.
(Find the Unifi Controller information widget here)
You can display general connectivity status from your Unifi (Network) Controller. When authenticating you will want to use an account that has at least read privileges.
An optional 'site' parameter can be supplied, if it is not the widget will use the default site for the controller.
Allowed fields: [\"uptime\", \"wan\", \"lan\", \"lan_users\", \"lan_devices\", \"wlan\", \"wlan_users\", \"wlan_devices\"] (maximum of four).
Note that fields unsupported by the unifi device will not be shown.
widget:\n type: unifi\n url: https://unifi.host.or.ip:port\n username: username\n password: password\n site: Site Name # optional\nAdded in v0.4.18, updated in 0.6.7
"},{"location":"widgets/services/unmanic/","title":"Unmanic","text":"Learn more about Unmanic.
Allowed fields: [\"active_workers\", \"total_workers\", \"records_total\"].
widget:\n type: unmanic\n url: http://unmanic.host.or.ip:port\nLearn more about Uptime Kuma.
As Uptime Kuma does not yet have a full API the widget uses data from a single \"status page\". As such you will need a status page setup with a group of monitored sites, which is where you get the slug (the url without the /status/ portion). E.g. if your status page is URL http://uptimekuma.host/status/statuspageslug, insert slug: statuspageslug.
Allowed fields: [\"up\", \"down\", \"uptime\", \"incident\"].
widget:\n type: uptimekuma\n url: http://uptimekuma.host.or.ip:port\n slug: statuspageslug\nLearn more about UptimeRobot.
To generate an API key, select My Settings, and either Monitor-Specific API Key or Read-Only API Key.
A Monitor-Specific API Key will provide the following detailed information for the selected monitor:
Allowed fields: [\"status\", \"uptime\", \"lastDown\", \"downDuration\"].
A Read-Only API Key will provide a summary of all monitors in your account:
Allowed fields: [\"sitesUp\", \"sitesDown\"].
widget:\n type: uptimerobot\n url: https://api.uptimerobot.com\n key: uptimerobotapitoken\nLearn more about UrBackup.
The UrBackup widget retrieves the total number of clients that currently have no errors, have errors, or haven't backed up recently. Clients are considered \"Errored\" or \"Out of Date\" if either the file or image backups for that client have errors/are out of date, unless the client does not support image backups.
The default number of days that can elapse before a client is marked Out of Date is 3, but this value can be customized by setting the maxDays value in the config.
Optionally, the widget can also report the total amount of disk space consumed by backups. This is disabled by default, because it requires a second API call.
Note: client status is only shown for backups that the specified user has access to. Disk Usage shown is the total for all backups, regardless of permissions.
Allowed fields: [\"ok\", \"errored\", \"noRecent\", \"totalUsed\"]. Note that totalUsed will not be shown unless explicitly included in fields.
widget:\n type: urbackup\n username: urbackupUsername\n password: urbackupPassword\n url: http://urbackupUrl:55414\n maxDays: 5 # optional\nLearn more about Watchtower.
To use this widget, Watchtower needs to be configured to to enable metrics.
Allowed fields: [\"containers_scanned\", \"containers_updated\", \"containers_failed\"].
widget:\n type: watchtower\n url: http://your-ip-address:8080\n key: demotoken\nLearn more about Wg-Easy.
Allowed fields: [\"connected\", \"enabled\", \"disabled\", \"total\"].
Note: by default [\"connected\", \"enabled\", \"total\"] are displayed.
To detect if a device is connected the time since the last handshake is queried. threshold is the time to wait in minutes since the last handshake to consider a device connected. Default is 2 minutes.
widget:\n type: wgeasy\n url: http://wg.easy.or.ip\n password: yourwgeasypassword\n threshold: 2 # optional\nLearn more about What's Up Docker.
Allowed fields: [\"monitoring\", \"updates\"].
widget:\n type: whatsupdocker\n url: http://whatsupdocker:port\n username: username # optional\n password: password # optional\nLearn more about Xteve.
Allowed fields: [\"streams_all\", \"streams_active\", \"streams_xepg\"].
widget:\n type: xteve\n url: http://xteve.host.or.ip\n username: username # optional\n password: password # optional\nA modern, fully static, fast, secure fully proxied, highly customizable application dashboard with integrations for over 100 services and translations into multiple languages. Easily configured via YAML files or through docker label discovery.
"},{"location":"configs/","title":"Configuration","text":"Homepage uses YAML for configuration, YAML stands for \"YAML Ain't Markup Language.\". It's a human-readable data serialization format that's a superset of JSON. Great for config files, easy to read and write. Supports complex data types like lists and objects. Indentation matters. If you already use Docker Compose, you already use YAML.
Here are some tips when writing YAML:
You can find tons of online YAML validators, here's one: https://codebeautify.org/yaml-validator, heres another: https://jsonformatter.org/yaml-validator.
"},{"location":"configs/bookmarks/","title":"Bookmarks","text":"Bookmarks are configured in the bookmarks.yaml file. They function much the same as Services, in how groups and lists work. They're just much simpler, smaller, and contain no extra features other than being a link out.
The design of homepage expects abbr to be 2 letters, but is not otherwise forced.
You can also use an icon for bookmarks similar to the options for service icons. If both icon and abbreviation are supplied, the icon takes precedence.
By default, the description will use the hostname of the link, but you can override it with a custom description.
---\n- Developer:\n - Github:\n - abbr: GH\n href: https://github.com/\n\n- Social:\n - Reddit:\n - icon: reddit.png\n href: https://reddit.com/\n description: The front page of the internet\n\n- Entertainment:\n - YouTube:\n - abbr: YT\n href: https://youtube.com/\nwhich renders to (depending on your theme, etc.):
The default bookmarks.yaml is a working example.
"},{"location":"configs/custom-css-js/","title":"Custom CSS & JS","text":"As of version v0.6.30 homepage supports adding your own custom css & javascript. Please do so at your own risk.
To add custom css simply edit the custom.css file under your config directory, similarly for javascript you would edit custom.js. You can then target elements in homepage with various classes / ids to customize things to your liking.
You can also set a specific id for a service or bookmark to target with your custom css or javascript, e.g.
Service:\n id: myserviceid\n icon: icon.png\n ...\nDocker instances are configured inside the docker.yaml file. Both IP:PORT and Socket connections are supported.
For IP:PORT, simply make sure your Docker instance has been configured to accept API traffic over the HTTP API.
my-remote-docker:\n host: 192.168.0.101\n port: 2375\nSince Docker supports connecting with TLS and client certificate authentication, you can include TLS details when connecting to the HTTP API. Further details of setting up Docker to accept TLS connections, and generation of the keys and certs can be found in the Docker documentation. The file entries are relative to the config directory (location of docker.yaml file).
my-remote-docker:\n host: 192.168.0.101\n port: 275\n tls:\n keyFile: tls/key.pem\n caFile: tls/ca.pem\n certFile: tls/cert.pem\nDue to security concerns with exposing the docker socket directly, you can use a docker-socket-proxy container to expose the docker socket on a more restricted and secure API.
Here is an example docker-compose file that will expose the docker socket, and then connect to it from the homepage container:
dockerproxy:\n image: ghcr.io/tecnativa/docker-socket-proxy:latest\n container_name: dockerproxy\n environment:\n - CONTAINERS=1 # Allow access to viewing containers\n - SERVICES=1 # Allow access to viewing services (necessary when using Docker Swarm)\n - TASKS=1 # Allow access to viewing tasks (necessary when using Docker Swarm)\n - POST=0 # Disallow any POST operations (effectively read-only)\n ports:\n - 127.0.0.1:2375:2375\n volumes:\n - /var/run/docker.sock:/var/run/docker.sock:ro # Mounted as read-only\n restart: unless-stopped\n\nhomepage:\n image: ghcr.io/gethomepage/homepage:latest\n container_name: homepage\n volumes:\n - /path/to/config:/app/config\n ports:\n - 3000:3000\n restart: unless-stopped\nThen, inside of your docker.yaml settings file, you'd configure the docker instance like so:
my-docker:\n host: dockerproxy\n port: 2375\nIf you'd rather use the socket directly, first make sure that you're passing the local socket into the Docker container.
Note
In order to use the socket directly homepage must be running as root
homepage:\n image: ghcr.io/gethomepage/homepage:latest\n container_name: homepage\n volumes:\n - /path/to/config:/app/config\n - /var/run/docker.sock:/var/run/docker.sock # pass local proxy\n ports:\n - 3000:3000\n restart: unless-stopped\nIf you're using docker run, this would be -v /var/run/docker.sock:/var/run/docker.sock.
Then, inside of your docker.yaml settings file, you'd configure the docker instance like so:
my-docker:\n socket: /var/run/docker.sock\nOnce you've configured your docker instances, you can then apply them to your services, to get stats and status reporting shown.
Inside of the service you'd like to connect to docker:
- Emby:\n icon: emby.png\n href: \"http://emby.home/\"\n description: Media server\n server: my-docker # The docker server that was configured\n container: emby # The name of the container you'd like to connect\nHomepage features automatic service discovery for containers with the proper labels attached, all configuration options can be applied using dot notation, beginning with homepage.
Below is an example of the same service entry shown above, as docker labels.
services:\n emby:\n image: lscr.io/linuxserver/emby:latest\n container_name: emby\n ports:\n - 8096:8096\n restart: unless-stopped\n labels:\n - homepage.group=Media\n - homepage.name=Emby\n - homepage.icon=emby.png\n - homepage.href=http://emby.home/\n - homepage.description=Media server\nWhen your Docker instance has been properly configured, this service will be automatically discovered and added to your Homepage. You do not need to specify the server or container values, as they will be automatically inferred.
When using docker swarm use deploy/labels
"},{"location":"configs/docker/#widgets","title":"Widgets","text":"You may also configure widgets, along with the standard service entry, again, using dot notation.
labels:\n - homepage.group=Media\n - homepage.name=Emby\n - homepage.icon=emby.png\n - homepage.href=http://emby.home/\n - homepage.description=Media server\n - homepage.widget.type=emby\n - homepage.widget.url=http://emby.home\n - homepage.widget.key=yourembyapikeyhere\n - homepage.widget.fields=[\"field1\",\"field2\"] # optional\nYou can add specify fields for e.g. the CustomAPI widget by using array-style dot notation:
labels:\n - homepage.group=Media\n - homepage.name=Emby\n - homepage.icon=emby.png\n - homepage.href=http://emby.home/\n - homepage.description=Media server\n - homepage.widget.type=customapi\n - homepage.widget.url=http://argus.service/api/v1/service/summary/emby\n - homepage.widget.mappings[0].label=Deployed Version\n - homepage.widget.mappings[0].field.status=deployed_version\n - homepage.widget.mappings[1].label=Latest Version\n - homepage.widget.mappings[1].field.status=latest_version\nDocker swarm is supported and Docker services are specified with the same server and container notation. To enable swarm support you will need to include a swarm setting in your docker.yaml, e.g.
my-docker:\n socket: /var/run/docker.sock\n swarm: true\nFor the automatic service discovery to discover all services it is important that homepage should be deployed on a manager node. Set deploy requirements to the master node in your stack yaml config, e.g.
....\n deploy:\n placement:\n constraints:\n - node.role == manager\n...\nIn order to detect every service within the Docker swarm it is necessary that service labels should be used and not container labels. Specify the homepage labels as:
....\n deploy:\n labels:\n - homepage.icon=foobar\n...\nThe optional field instanceName can be configured in settings.md to differentiate between multiple homepage instances.
To limit a label to an instance, insert .instance.{{instanceName}} after the homepage prefix.
labels:\n - homepage.group=Media\n - homepage.name=Emby\n - homepage.icon=emby.png\n - homepage.instance.internal.href=http://emby.lan/\n - homepage.instance.public.href=https://emby.mydomain.com/\n - homepage.description=Media server\nAs of v0.6.4 discovered services can include an optional weight field to determine sorting such that:
You can show the docker stats by clicking the status indicator but this can also be controlled per-service with:
- Example Service:\n ...\n showStats: true\nAlso see the settings for show docker stats.
"},{"location":"configs/kubernetes/","title":"Kubernetes","text":"The Kubernetes connectivity has the following requirements:
The Kubernetes connection is configured in the kubernetes.yaml file. There are 3 modes to choose from:
mode: default\nOnce the Kubernetes connection is configured, individual services can be configured to pull statistics. Only CPU and Memory are currently supported.
Inside of the service you'd like to connect to a pod:
- Emby:\n icon: emby.png\n href: \"http://emby.home/\"\n description: Media server\n namespace: media # The kubernetes namespace the app resides in\n app: emby # The name of the deployed app\nThe app field is used to create a label selector, in this example case it would match pods with the label: app.kubernetes.io/name=emby.
Sometimes this is insufficient for complex or atypical application deployments. In these cases, the pod-selector field can be used. Any field selector can be used with it, so it allows for some very powerful selection capabilities.
For instance, it can be utilized to roll multiple underlying deployments under one application to see a high-level aggregate:
- Element Chat:\n icon: matrix-light.png\n href: https://chat.example.com\n description: Matrix Synapse Powered Chat\n app: matrix-element\n namespace: comms\n pod-selector: >-\n app.kubernetes.io/instance in (\n matrix-element,\n matrix-media-repo,\n matrix-media-repo-postgresql,\n matrix-synapse\n )\nNote
A blank string as a pod-selector does not deactivate it, but will actually select all pods in the namespace. This is a useful way to capture the resource usage of a complex application siloed to a single namespace, like Longhorn.
"},{"location":"configs/kubernetes/#automatic-service-discovery","title":"Automatic Service Discovery","text":"Homepage features automatic service discovery by Ingress annotations. All configuration options can be applied using typical annotation syntax, beginning with gethomepage.dev/.
apiVersion: networking.k8s.io/v1\nkind: Ingress\nmetadata:\n name: emby\n annotations:\n gethomepage.dev/enabled: \"true\"\n gethomepage.dev/description: Media Server\n gethomepage.dev/group: Media\n gethomepage.dev/icon: emby.png\n gethomepage.dev/name: Emby\n gethomepage.dev/widget.type: \"emby\"\n gethomepage.dev/widget.url: \"https://emby.example.com\"\n gethomepage.dev/pod-selector: \"\"\n gethomepage.dev/weight: 10 # optional\n gethomepage.dev/instance: \"public\" # optional\nspec:\n rules:\n - host: emby.example.com\n http:\n paths:\n - backend:\n service:\n name: emby\n port:\n number: 8080\n path: /\n pathType: Prefix\nWhen the Kubernetes cluster connection has been properly configured, this service will be automatically discovered and added to your Homepage. You do not need to specify the namespace or app values, as they will be automatically inferred.
If you are using multiple instances of homepage, an instance annotation can be specified to limit services to a specific instance. If no instance is provided, the service will be visible on all instances.
If you have a single service that needs to be shown on multiple specific instances of homepage (but not on all of them), the service can be annotated by multiple instance.name annotations, where name can be the names of your specific multiple homepage instances. For example, a service that is annotated with gethomepage.dev/instance.public: \"\" and gethomepage.dev/instance.internal: \"\" will be shown on public and internal homepage instances.
Homepage can also read ingresses defined using the Traefik IngressRoute custom resource definition. Due to the complex nature of Traefik routing rules, it is required for the gethomepage.dev/href annotation to be set:
apiVersion: traefik.io/v1alpha1\nkind: IngressRoute\nmetadata:\n name: emby\n annotations:\n gethomepage.dev/href: \"https://emby.example.com\"\n gethomepage.dev/enabled: \"true\"\n gethomepage.dev/description: Media Server\n gethomepage.dev/group: Media\n gethomepage.dev/icon: emby.png\n gethomepage.dev/app: emby-app # optional, may be needed if app.kubernetes.io/name != ingress metadata.name\n gethomepage.dev/name: Emby\n gethomepage.dev/widget.type: \"emby\"\n gethomepage.dev/widget.url: \"https://emby.example.com\"\n gethomepage.dev/pod-selector: \"\"\n gethomepage.dev/weight: 10 # optional\n gethomepage.dev/instance: \"public\" # optional\nspec:\n entryPoints:\n - websecure\n routes:\n - kind: Rule\n match: Host(`emby.example.com`)\n services:\n - kind: Service\n name: emby\n namespace: emby\n port: 8080\n scheme: http\n strategy: RoundRobin\n weight: 10\nIf the href attribute is not present, Homepage will ignore the specific IngressRoute.
Similarly to Docker service discovery, there currently is no rigid ordering to discovered services and discovered services will be displayed above those specified in the services.yaml.
Unless otherwise noted, URLs should not end with a / or other API path. Each widget will handle the path on its own.
Each service can have one widget attached to it (often matching the service type, but that's not forced).
In addition to the href of the service, you can also specify the target location in which to open that link. See Link Target for more details.
Using Emby as an example, this is how you would attach the Emby service widget.
- Emby:\n icon: emby.png\n href: http://emby.host.or.ip/\n description: Movies & TV Shows\n widget:\n type: emby\n url: http://emby.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\nEach 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.
In all cases a widget will work and display all fields without specifying the fields property.
- Sonarr:\n icon: sonarr.png\n href: http://sonarr.host.or.ip\n widget:\n type: sonarr\n fields: [\"wanted\", \"queued\"]\n url: http://sonarr.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\nServices are configured inside the services.yaml file. You can have any number of groups, and any number of services per group.
Groups are defined as top-level array entries.
- Group A:\n - Service A:\n href: http://localhost/\n\n- Group B:\n - Service B:\n href: http://localhost/\nServices are defined as array entries on groups,
- Group A:\n - Service A:\n href: http://localhost/\n\n - Service B:\n href: http://localhost/\n\n - Service C:\n href: http://localhost/\n\n- Group B:\n - Service D:\n href: http://localhost/\nServices may have descriptions,
- Group A:\n - Service A:\n href: http://localhost/\n description: This is my service\n\n- Group B:\n - Service B:\n href: http://localhost/\n description: This is another service\nServices may have an icon attached to them, you can use icons from Dashboard Icons automatically, by passing the name of the icon, with, or without .png or with .svg to use the svg version.
You can also specify prefixed icons from Material Design Icons with mdi-XX or Simple Icons with si-XX.
You can specify a custom color by adding a hex color code as suffix e.g. mdi-XX-#f0d453 or si-XX-#a712a2.
To use a remote icon, use the absolute URL (e.g. https://...).
To use a local icon, first create a Docker mount to /app/public/icons and then reference your icon as /icons/myicon.png. You will need to restart the container when adding new icons.
Warning
Material Design Icons for brands were deprecated and may be removed in the future. Using Simple Icons for brand icons will prevent any issues if / when the Material Design Icons are removed.
- Group A:\n - Sonarr:\n icon: sonarr.png\n href: http://sonarr.host/\n description: Series management\n\n- Group B:\n - Radarr:\n icon: radarr.png\n href: http://radarr.host/\n description: Movie management\n\n- Group C:\n - Service:\n icon: mdi-flask-outline\n href: http://service.host/\n description: My cool service\nServices 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.
- Group A:\n - Sonarr:\n icon: sonarr.png\n href: http://sonarr.host/\n ping: sonarr.host\n\n- Group B:\n - Radarr:\n icon: radarr.png\n href: http://radarr.host/\n ping: some.other.host\nYou can also apply different styles to the ping indicator by using the statusStyle property, see settings.
Services may have an optional siteMonitor property (formerly ping) that allows you to monitor the availability of a URL you chose and have the response time displayed. You do not need to set your monitor URL equal to your href or ping URL.
Note
The site monitor feature works by making an http HEAD request to the URL, and falls back to GET in case that fails. It will not, for example, login if the URL requires auth or is behind e.g. Authelia. In the case of a reverse proxy and/or auth this usually requires the use of an 'internal' URL to make the site monitor feature correctly display status.
- Group A:\n - Sonarr:\n icon: sonarr.png\n href: http://sonarr.host/\n siteMonitor: http://sonarr.host/\n\n- Group B:\n - Radarr:\n icon: radarr.png\n href: http://radarr.host/\n siteMonitor: http://some.other.host/\nYou can also apply different styles to the site monitor indicator by using the statusStyle property, see settings.
Services may be connected to a Docker container, either running on the local machine, or a remote machine.
- Group A:\n - Service A:\n href: http://localhost/\n description: This is my service\n server: my-server\n container: my-container\n\n- Group B:\n - Service B:\n href: http://localhost/\n description: This is another service\n server: other-server\n container: other-container\nClicking on the status label of a service with Docker integration enabled will expand the container stats, where you can see CPU, Memory, and Network activity.
Note
This can also be controlled with showStats. See show docker stats for more information
Services may also have a service widget (or integration) attached to them, this works independently of the Docker integration.
You can find information and configuration for each of the supported integrations on the Widgets page.
Here is an example of a Radarr & Sonarr service, with their respective integrations.
- Group A:\n - Sonarr:\n icon: sonarr.png\n href: http://sonarr.host/\n description: Series management\n widget:\n type: sonarr\n url: http://sonarr.host\n key: apikeyapikeyapikeyapikeyapikey\n\n- Group B:\n - Radarr:\n icon: radarr.png\n href: http://radarr.host/\n description: Movie management\n widget:\n type: radarr\n url: http://radarr.host\n key: apikeyapikeyapikeyapikeyapikey\nThe settings.yaml file allows you to define application level options. For changes made to this file to take effect, you will need to regenerate the static HTML, this can be done by clicking the refresh icon in the bottom right of the page.
You can customize the title of the page if you'd like.
title: My Awesome Homepage\nYou can customize the start_url as required for installable apps. The default is \"/\".
startUrl: https://custom.url\nHeads Up!
You will need to restart the container any time you add new images, this is a limitation of the Next.js static site server.
Heads Up!
Do not create a bind mount to the entire /app/public/ directory.
If you'd like to use a background image instead of the solid theme color, you may provide a full URL to an image of your choice.
background: https://images.unsplash.com/photo-1502790671504-542ad42d5189?auto=format&fit=crop&w=2560&q=80\nOr you may pass the path to a local image relative to e.g. /app/public/images directory.
For example, inside of your Docker Compose file, mount a path to where your images are kept:
volumes:\n - /my/homepage/images:/app/public/images\nand then reference that image:
background: /images/background.png\nYou can specify filters to apply over your background image for blur, saturation and brightness as well as opacity to blend with the background color. The first three filter settings use tailwind CSS classes, see notes below regarding the options for each. You do not need to specify all options.
background:\n image: /images/background.png\n blur: sm # sm, \"\", md, xl... see https://tailwindcss.com/docs/backdrop-blur\n saturate: 50 # 0, 50, 100... see https://tailwindcss.com/docs/backdrop-saturate\n brightness: 50 # 0, 50, 75... see https://tailwindcss.com/docs/backdrop-brightness\n opacity: 50 # 0-100\nYou can apply a blur filter to the service & bookmark cards. Note this option is incompatible with the background blur, saturate and brightness filters.
cardBlur: sm # sm, \"\", md, etc... see https://tailwindcss.com/docs/backdrop-blur\nIf you'd like to use a custom favicon instead of the included one, you may provide a full URL to an image of your choice.
favicon: https://www.google.com/favicon.ico\nOr you may pass the path to a local image relative to the /app/public directory. See Background Image for more detailed information on how to provide your own files.
You can configure a fixed theme (and disable the theme switcher) by passing the theme option, like so:
theme: dark # or light\nYou can configured a fixed color palette (and disable the palette switcher) by passing the color option, like so:
color: slate\nSupported colors are: slate, gray, zinc, neutral, stone, amber, yellow, lime, green, emerald, teal, cyan, sky, blue, indigo, violet, purple, fuchsia, pink, rose, red, white
You can configure service and bookmarks sections to be either \"column\" or \"row\" based layouts, like so:
Assuming you have a group named Media in your services.yaml or bookmarks.yaml file,
layout:\n Media:\n style: row\n columns: 4\nAs an example, this would produce the following layout:
"},{"location":"configs/settings/#sorting","title":"Sorting","text":"Service groups and bookmark groups can be mixed in order, but should use different group names. If you do not specify any bookmark groups they will all show at the bottom of the page.
Using the same name for a service and bookmark group can cause unexpected behavior like a bookmark group being hidden
Groups will sort based on the order in the layout block. You can also mix in groups defined by docker labels, e.g.
layout:\n - Auto-Discovered1:\n - Configured1:\n - Configured2:\n - Auto-Discovered2:\n - Configured3:\n style: row\n columns: 3\nYou can hide headers for each section in the layout as well by passing header as false, like so:
layout:\n Section A:\n header: false\n Section B:\n style: row\n columns: 3\n header: false\nYou can also add an icon to a category under the layout setting similar to the options for service icons, e.g.
Home Management & Info:\n icon: home-assistant.png\n Server Tools:\n icon: https://cdn-icons-png.flaticon.com/512/252/252035.png\n ...\nThe default style for icons (e.g. icon: mdi-XXXX) is a gradient, or you can specify that prefixed icons match your theme with a 'flat' style using the setting below. More information about prefixed icons can be found in options for service icons.
iconStyle: theme # optional, defaults to gradient\nVersion 0.6.30 introduced a tabbed view to layouts which can be optionally specified in the layout. Tabs is only active if you set the tab field on at least one layout group.
Tabs are sorted based on the order in the layout block. If a group has no tab specified (and tabs are set on other groups), services and bookmarks will be shown on all tabs.
Every tab can be accessed directly by visiting Homepage URL with #Group (name lowercase and URI-encoded) at the end of the URL.
For example, the following would create four tabs:
layout:\n ...\n Bookmark Group on First Tab:\n tab: First\n\n First Service Group:\n tab: First\n style: row\n columns: 4\n\n Second Service Group:\n tab: Second\n columns: 4\n\n Third Service Group:\n tab: Third\n style: row\n\n Bookmark Group on Fourth Tab:\n tab: Fourth\n\n Service Group on every Tab:\n style: row\n columns: 4\nYou can add a fifth column to services (when style: columns which is default) by adding:
fiveColumns: true\nBy default homepage will max out at 4 columns for services with columns style
You can disable the collapsible feature of services & bookmarks by adding:
disableCollapse: true\nBy default the feature is enabled.
"},{"location":"configs/settings/#initially-collapsed-sections","title":"Initially collapsed sections","text":"You can initially collapse sections by adding the initiallyCollapsed option to the layout group.
layout:\n Section A:\n initiallyCollapsed: true\nThis can also be set globaly using the groupsInitiallyCollapsed option.
groupsInitiallyCollapsed: true\nThe value set on a group will overwrite the global setting.
By default the feature is disabled.
"},{"location":"configs/settings/#use-equal-height-cards","title":"Use Equal Height Cards","text":"You can enable equal height cards for groups of services, this will make all cards in a row the same height.
Global setting in settings.yaml:
useEqualHeights: true\nPer layout group in settings.yaml:
useEqualHeights: false\nlayout:\n ...\n Group Name:\n useEqualHeights: true # overrides global setting\nBy default the feature is disabled
"},{"location":"configs/settings/#header-style","title":"Header Style","text":"There are currently 4 options for header styles, you can see each one below.
headerStyle: underlined # default style\nheaderStyle: boxed\nheaderStyle: clean\nheaderStyle: boxedWidgets\nIn some proxy configurations, it may be necessary to set the documents base URL. You can do this by providing a base value, like so:
base: http://host.local/homepage\nThe URL must be a full, absolute URL, or it will be ignored by the browser.
"},{"location":"configs/settings/#language","title":"Language","text":"Set your desired language using:
language: fr\nCurrently supported languages: ca, de, en, es, fr, he, hr, hu, it, nb-NO, nl, pt, ru, sv, vi, zh-CN, zh-Hant
You can also specify locales e.g. for the DateTime widget, e.g. en-AU, en-GB, etc.
"},{"location":"configs/settings/#link-target","title":"Link Target","text":"Changes the behaviour of links on the homepage,
target: _blank # Possible options include _blank, _self, and _top\nUse _blank to open links in a new tab, _self to open links in the same tab, and _top to open links in a new window.
This can also be set for individual services. Note setting this at the service level overrides any setting in settings.json, e.g.:
- Example Service:\n href: https://example.com/\n ...\n target: _self\nThe providers section allows you to define shared API provider options and secrets. Currently this allows you to define your weather API keys in secret and is also the location of the Longhorn URL and credentials.
providers:\n openweathermap: openweathermapapikey\n weatherapi: weatherapiapikey\n longhorn:\n url: https://longhorn.example.com\n username: admin\n password: LonghornPassword\nYou can then pass provider instead of apiKey in your widget configuration.
- weatherapi:\n latitude: 50.449684\n longitude: 30.525026\n provider: weatherapi\nYou can use the 'Quick Launch' feature to search services, perform a web search or open a URL. To use Quick Launch, just start typing while on your homepage (as long as the search widget doesn't have focus).
There are a few optional settings for the Quick Launch feature:
searchDescriptions: which lets you control whether item descriptions are included in searches. This is false by default. When enabled, results that match the item name will be placed above those that only match the description.hideInternetSearch: disable automatically including the currently-selected web search (e.g. from the widget) as a Quick Launch option. This is false by default, enabling the feature.showSearchSuggestions: show search suggestions for the internet search. If this is not specified then the setting will be inherited from the search widget. If it is not specified there either, it will default to false. For custom providers the suggestionUrl needs to be set in order for this to work.provider: search engine provider. If none is specified it will try to use the provider set for the Search Widget, if neither are present then internet search will be disabled.hideVisitURL: disable detecting and offering an option to open URLs. This is false by default, enabling the feature.quicklaunch:\n searchDescriptions: true\n hideInternetSearch: true\n showSearchSuggestions: true\n hideVisitURL: true\n provider: google # google, duckduckgo, bing, baidu, brave or custom\nor for a custom search:
quicklaunch:\n provider: custom\n url: https://www.ecosia.org/search?q=\n target: _blank\n suggestionUrl: https://ac.ecosia.org/autocomplete?type=list&q=\nBy default the release version is displayed at the bottom of the page. To hide this, use the hideVersion setting, like so:
hideVersion: true\nBy default the homepage logfile is written to the a logs subdirectory of the config folder. In order to customize this path, you can set the logpath setting. A logs folder will be created in that location where the logfile will be written.
logpath: /logfile/path\nBy default, logs are sent both to stdout and to a file at the path specified. This can be changed by setting the LOG_TARGETS environment variable to one of both (default), stdout or file.
You can show all docker stats expanded in settings.yaml:
showStats: true\nor per-service (services.yaml) with:
- Example Service:\n ...\n showStats: true\nIf you have both set the per-service settings take precedence.
"},{"location":"configs/settings/#status-style","title":"Status Style","text":"You can choose from the following styles for docker or k8s status, site monitor and ping: dot or basic
dot shows a green dot for a successful monitor ping or healthy status.basic shows either UP or DOWN for monitor & pingFor example:
statusStyle: \"dot\"\nor per-service (services.yaml) with:
- Example Service:\n ...\n statusStyle: 'dot'\nIf you have both set, the per-service settings take precedence.
"},{"location":"configs/settings/#instance-name","title":"Instance Name","text":"Name used by automatic docker service discovery to differentiate between multiple homepage instances.
For example:
instanceName: public\nHide the visible API error messages either globally in settings.yaml:
hideErrors: true\nor per service widget (services.yaml) with:
- Example Service:\n ...\n widget:\n ...\n hideErrors: true\nIf either value is set to true, the error message will be hidden.
"},{"location":"installation/","title":"Installation","text":"You have a few options for deploying homepage, depending on your needs. We offer docker images for a majority of platforms. You can also install and run homepage from source if Docker is not your thing. It can even be installed on Kubernetes with Helm.
Danger
Please note that when using features such as widgets, Homepage can access personal information (for example from your home automation system) and Homepage currently does not (and is not planned to) include any authentication layer itself. Thus, we recommend homepage be deployed behind a reverse proxy including authentication, SSL etc, and / or behind a VPN.
\u00a0 Install on Docker
\u00a0 Install on Kubernetes
\u00a0 Install on UNRAID
\u00a0 Building from source
"},{"location":"installation/docker/","title":"Docker Installation","text":"Using docker compose:
version: \"3.3\"\nservices:\n homepage:\n image: ghcr.io/gethomepage/homepage:latest\n container_name: homepage\n ports:\n - 3000:3000\n volumes:\n - /path/to/config:/app/config # Make sure your local config directory exists\n - /var/run/docker.sock:/var/run/docker.sock # (optional) For docker integrations\nBy default, the Homepage container runs as root. Homepage also supports running your container as non-root via the standard PUID and PGID environment variables. When using these variables, make sure that any volumes mounted in to the container have the correct ownership and permissions set.
Using the docker socket directly is not the recommended method of integration and requires either running homepage as root or that the user be part of the docker group
In the docker compose example below, the environment variables $PUID and $PGID are set in a .env file.
version: \"3.3\"\nservices:\n homepage:\n image: ghcr.io/gethomepage/homepage:latest\n container_name: homepage\n ports:\n - 3000:3000\n volumes:\n - /path/to/config:/app/config # Make sure your local config directory exists\n - /var/run/docker.sock:/var/run/docker.sock # (optional) For docker integrations, see alternative methods\n environment:\n PUID: $PUID\n PGID: $PGID\ndocker run -p 3000:3000 -v /path/to/config:/app/config -v /var/run/docker.sock:/var/run/docker.sock ghcr.io/gethomepage/homepage:latest\nYou can also include environment variables in your config files to protect sensitive information. Note:
HOMEPAGE_VAR_ or HOMEPAGE_FILE_HOMEPAGE_VAR_XXX will replace {{HOMEPAGE_VAR_XXX}} in any configHOMEPAGE_FILE_XXX must be a file path, the contents of which will be used to replace {{HOMEPAGE_FILE_XXX}} in any configThere is an unofficial helm chart that creates all the necessary manifests, including the service account and RBAC entities necessary for service discovery.
helm repo add jameswynn https://jameswynn.github.io/helm-charts\nhelm install homepage jameswynn/homepage -f values.yaml\nThe helm chart allows for all the configurations to be inlined directly in your values.yaml:
config:\n bookmarks:\n - Developer:\n - Github:\n - abbr: GH\n href: https://github.com/\n services:\n - My First Group:\n - My First Service:\n href: http://localhost/\n description: Homepage is awesome\n\n - My Second Group:\n - My Second Service:\n href: http://localhost/\n description: Homepage is the best\n\n - My Third Group:\n - My Third Service:\n href: http://localhost/\n description: Homepage is \ud83d\ude0e\n widgets:\n # show the kubernetes widget, with the cluster summary and individual nodes\n - kubernetes:\n cluster:\n show: true\n cpu: true\n memory: true\n showLabel: true\n label: \"cluster\"\n nodes:\n show: true\n cpu: true\n memory: true\n showLabel: true\n - search:\n provider: duckduckgo\n target: _blank\n kubernetes:\n mode: cluster\n settings:\n\n# The service account is necessary to allow discovery of other services\nserviceAccount:\n create: true\n name: homepage\n\n# This enables the service account to access the necessary resources\nenableRbac: true\n\ningress:\n main:\n enabled: true\n annotations:\n # Example annotations to add Homepage to your Homepage!\n gethomepage.dev/enabled: \"true\"\n gethomepage.dev/name: \"Homepage\"\n gethomepage.dev/description: \"Dynamically Detected Homepage\"\n gethomepage.dev/group: \"Dynamic\"\n gethomepage.dev/icon: \"homepage.png\"\n hosts:\n - host: homepage.example.com\n paths:\n - path: /\n pathType: Prefix\nIf you don't want to use the unofficial Helm chart, you can also create your own Kubernetes manifest(s) and apply them with kubectl apply -f filename.yaml.
Here's a working example of the resources you need:
"},{"location":"installation/k8s/#serviceaccount","title":"ServiceAccount","text":"apiVersion: v1\nkind: ServiceAccount\nmetadata:\n name: homepage\n namespace: default\n labels:\n app.kubernetes.io/name: homepage\nsecrets:\n - name: homepage\napiVersion: v1\nkind: Secret\ntype: kubernetes.io/service-account-token\nmetadata:\n name: homepage\n namespace: default\n labels:\n app.kubernetes.io/name: homepage\n annotations:\n kubernetes.io/service-account.name: homepage\napiVersion: v1\nkind: ConfigMap\nmetadata:\n name: homepage\n namespace: default\n labels:\n app.kubernetes.io/name: homepage\ndata:\n kubernetes.yaml: |\n mode: cluster\n settings.yaml: \"\"\n #settings.yaml: |\n # providers:\n # longhorn:\n # url: https://longhorn.my.network\n custom.css: \"\"\n custom.js: \"\"\n bookmarks.yaml: |\n - Developer:\n - Github:\n - abbr: GH\n href: https://github.com/\n services.yaml: |\n - My First Group:\n - My First Service:\n href: http://localhost/\n description: Homepage is awesome\n\n - My Second Group:\n - My Second Service:\n href: http://localhost/\n description: Homepage is the best\n\n - My Third Group:\n - My Third Service:\n href: http://localhost/\n description: Homepage is \ud83d\ude0e\n widgets.yaml: |\n - kubernetes:\n cluster:\n show: true\n cpu: true\n memory: true\n showLabel: true\n label: \"cluster\"\n nodes:\n show: true\n cpu: true\n memory: true\n showLabel: true\n - resources:\n backend: resources\n expanded: true\n cpu: true\n memory: true\n - search:\n provider: duckduckgo\n target: _blank\n docker.yaml: \"\"\napiVersion: rbac.authorization.k8s.io/v1\nkind: ClusterRole\nmetadata:\n name: homepage\n labels:\n app.kubernetes.io/name: homepage\nrules:\n - apiGroups:\n - \"\"\n resources:\n - namespaces\n - pods\n - nodes\n verbs:\n - get\n - list\n - apiGroups:\n - extensions\n - networking.k8s.io\n resources:\n - ingresses\n verbs:\n - get\n - list\n - apiGroups:\n - traefik.containo.us\n resources:\n - ingressroutes\n verbs:\n - get\n - list\n - apiGroups:\n - metrics.k8s.io\n resources:\n - nodes\n - pods\n verbs:\n - get\n - list\n---\napiVersion: rbac.authorization.k8s.io/v1\nkind: ClusterRoleBinding\nmetadata:\n name: homepage\n labels:\n app.kubernetes.io/name: homepage\nroleRef:\n apiGroup: rbac.authorization.k8s.io\n kind: ClusterRole\n name: homepage\nsubjects:\n - kind: ServiceAccount\n name: homepage\n namespace: default\napiVersion: v1\nkind: Service\nmetadata:\n name: homepage\n namespace: default\n labels:\n app.kubernetes.io/name: homepage\n annotations:\nspec:\n type: ClusterIP\n ports:\n - port: 3000\n targetPort: http\n protocol: TCP\n name: http\n selector:\n app.kubernetes.io/name: homepage\napiVersion: apps/v1\nkind: Deployment\nmetadata:\n name: homepage\n namespace: default\n labels:\n app.kubernetes.io/name: homepage\nspec:\n revisionHistoryLimit: 3\n replicas: 1\n strategy:\n type: RollingUpdate\n selector:\n matchLabels:\n app.kubernetes.io/name: homepage\n template:\n metadata:\n labels:\n app.kubernetes.io/name: homepage\n spec:\n serviceAccountName: homepage\n automountServiceAccountToken: true\n dnsPolicy: ClusterFirst\n enableServiceLinks: true\n containers:\n - name: homepage\n image: \"ghcr.io/gethomepage/homepage:latest\"\n imagePullPolicy: Always\n ports:\n - name: http\n containerPort: 3000\n protocol: TCP\n volumeMounts:\n - mountPath: /app/config/custom.js\n name: homepage-config\n subPath: custom.js\n - mountPath: /app/config/custom.css\n name: homepage-config\n subPath: custom.css\n - mountPath: /app/config/bookmarks.yaml\n name: homepage-config\n subPath: bookmarks.yaml\n - mountPath: /app/config/docker.yaml\n name: homepage-config\n subPath: docker.yaml\n - mountPath: /app/config/kubernetes.yaml\n name: homepage-config\n subPath: kubernetes.yaml\n - mountPath: /app/config/services.yaml\n name: homepage-config\n subPath: services.yaml\n - mountPath: /app/config/settings.yaml\n name: homepage-config\n subPath: settings.yaml\n - mountPath: /app/config/widgets.yaml\n name: homepage-config\n subPath: widgets.yaml\n - mountPath: /app/config/logs\n name: logs\n volumes:\n - name: homepage-config\n configMap:\n name: homepage\n - name: logs\n emptyDir: {}\napiVersion: networking.k8s.io/v1\nkind: Ingress\nmetadata:\n name: homepage\n namespace: default\n labels:\n app.kubernetes.io/name: homepage\n annotations:\n gethomepage.dev/description: Dynamically Detected Homepage\n gethomepage.dev/enabled: \"true\"\n gethomepage.dev/group: Cluster Management\n gethomepage.dev/icon: homepage.png\n gethomepage.dev/name: Homepage\nspec:\n rules:\n - host: \"homepage.my.network\"\n http:\n paths:\n - path: \"/\"\n pathType: Prefix\n backend:\n service:\n name: homepage\n port:\n number: 3000\nIf you plan to deploy homepage with a replica count greater than 1, you may want to consider enabling sticky sessions on the homepage route. This will prevent unnecessary re-renders on page loads and window / tab focusing. The procedure for enabling sticky sessions depends on your Ingress controller. Below is an example using Traefik as the Ingress controller.
apiVersion: traefik.io/v1alpha1\nkind: IngressRoute\nmetadata:\n name: homepage.example.com\nspec:\n entryPoints:\n - websecure\n routes:\n - kind: Rule\n match: Host(`homepage.example.com`)\n services:\n - kind: Service\n name: homepage\n port: 3000\n sticky:\n cookie:\n httpOnly: true\n secure: true\n sameSite: none\nFirst, clone the repository:
git clone https://github.com/gethomepage/homepage.git\nThen install dependencies and build the production bundle (I'm using pnpm here, you can use npm or yarn if you like):
pnpm install\npnpm build\nIf this is your first time starting, copy the src/skeleton directory to config/ to populate initial example config files.
Finally, run the server:
pnpm start\nHomepage has an UNRAID community package that you may use to install homepage. This is the easiest way to get started with homepage on UNRAID.
"},{"location":"installation/unraid/#install-the-plugin","title":"Install the Plugin","text":"homepage.You may need to set the permissions of the folders to be able to edit the files.
chmod -R u-x,go-rwx,go+u,ugo+X /app/config and press Enter.chmod -R u-x,go-rwx,go+u,ugo+X /app/public/icons and press Enter.chown -R nobody:users /app/config and press Enter.chown -R nobody:users /app/public/icons and press Enter.container: parameter. There is no need to set the server.!!! note
To view detailed container statistics (CPU, RAM, etc.), or if you use a remote docker socket, `container:` will still need to be set. For example:\n - Plex:\n icon: /icons/plex.png\n href: https://app.plex.com\n container: plex\nHere you'll find resources and guides for Homepage, troubleshooting tips, and more.
"},{"location":"more/coverage/","title":"Community Coverage","text":"Homepage has been covered by quite a few YouTube channels, here are some of them. If you have a video you'd like to add, please open a PR!
"},{"location":"more/coverage/#english","title":"English","text":""},{"location":"more/coverage/#french","title":"French","text":""},{"location":"more/coverage/#german","title":"German","text":""},{"location":"more/coverage/#chinese","title":"Chinese","text":""},{"location":"more/coverage/#russian","title":"Russian","text":""},{"location":"more/development/","title":"Development","text":"First, clone the homepage repository.
For installing NPM packages, this project uses pnpm (and so should you!):
pnpm install\nStart the development server:
pnpm dev\nOpen http://localhost:3000 to start.
This is a Next.js application, see their documentation for more information.
"},{"location":"more/development/#code-linting","title":"Code Linting","text":"Once dependencies have been installed you can lint your code with
pnpm lint\nTo ensure a consistent style and formatting across the project source, the project utilizes Git pre-commit hooks to perform some formatting and linting before a commit is allowed.
Once installed, hooks will run when you commit. If the formatting isn't quite right, the commit will be rejected and you'll need to look at the output and fix the issue. Most hooks will automatically format failing files, so all you need to do is git add those files again and retry your commit.
See the pre-commit documentation to get started.
"},{"location":"more/development/#preferring-self-hosted-open-source-software","title":"Preferring self-hosted open-source software","text":"In general, homepage is meant to be a dashboard for 'self-hosted' services and we believe it is a small way we can help showcase this kind of software. While exceptions are made, mostly when there is no viable self-hosted / open-source alternative, we ask that any widgets, etc. are developed primarily for a self-hosted tool.
"},{"location":"more/development/#new-feature-guidelines","title":"New Feature Guidelines","text":"To ensure cohesiveness of various widgets, the following should be used as a guide for developing new widgets:
As of v0.7.2 homepage migrated from benphelps/homepage to an \"organization\" repository located at gethomepage/homepage. The reason for this was to setup the project for longevity and allow for community maintenance.
Migrating your installation should be as simple as changing image: ghcr.io/benphelps/homepage:latest to image: ghcr.io/gethomepage/homepage:latest.
Homepage is developed in English, component contributions must be in English. All translations are community provided, so a huge thanks go out to all those who have helped out so far!
"},{"location":"more/translations/#support-translations","title":"Support Translations","text":"If you'd like to lend a hand in translating Homepage into more languages, or to improve existing translations, the process is very simple:
If you'd like to add a new language, please create a new Discussion on Crowdin, and we'll add it to the project.
"},{"location":"troubleshooting/","title":"Troubleshooting","text":""},{"location":"troubleshooting/#introducing-the-homepage-ai-bot","title":"Introducing the Homepage AI Bot","text":"Thanks to the generous folks at Glime, Homepage is now equipped with a pretty clever AI-powered bot. The bot has full knowledge of our docs, GitHub issues and discussions and is great at answering specific questions about setting up your Homepage. To use the bot, just hit the 'Ask AI' button on any page in our docs, open a GitHub discussion or check out the #ai-support channel on Discord!
"},{"location":"troubleshooting/#general-troubleshooting-tips","title":"General Troubleshooting Tips","text":"docker logs homepage. This may provide some insight into the reason for an error.ENV variable LOG_LEVEL to debug.All service widgets work essentially the same, that is, homepage makes a proxied call to an API made available by that service. The majority of the time widgets don't work it is a configuration issue. Of course, sometimes things do break. Some basic steps to try:
Ensure that you follow the rule mentioned on https://gethomepage.dev/latest/configs/service-widgets/. Unless otherwise noted, URLs should not end with a / or other API path. Each widget will handle the path on its own.. This is very important as including a trailing slash can result in an error.
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\nIf 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.
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
curl is not installed in the base image by default but can be added inside the container with apk add curl.
The exact API endpoints and authentication vary of course, but in many cases instructions can be found by searching the web or if you feel comfortable looking at the homepage source code (e.g. src/widgets/{widget}/widget.js).
It is out of the scope of this to go into full detail about how to , but an example for PiHole would be:
curl -L -k http://PIHOLEIPORHOST/admin/api.php\nOr for AdGuard:
curl -L -k -u 'username:password' http://ADGUARDIPORHOST/control/stats\nOr for Portainer:
curl -L -k -H 'X-Api-Key:YOURKEY' 'https://PORTAINERIPORHOST:PORT/api/endpoints/2/docker/containers/json'\nSonarr:
curl -L -k 'http://SONARRIPORHOST:PORT/api/v3/queue?apikey=YOURAPIKEY'\nThis will return some data which may reveal an issue causing a true bug in the service widget.
If, after correctly adding and mapping your custom icons via the Icons instructions, you are still unable to see your icons please try recreating your container.
"},{"location":"widgets/","title":"Widgets","text":"Homepage has two types of widgets: info and service. Below we'll cover each type and how to configure them.
"},{"location":"widgets/#service-widgets","title":"Service Widgets","text":"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:\n icon: plex.png\n href: https://plex.my.host\n description: Watch movies and TV shows.\n server: localhost\n container: plex\n widget:\n type: tautulli\n url: http://172.16.1.1:8181\n key: aabbccddeeffgghhiijjkkllmmnnoo\nInfo widgets are used to display information in the header, often about your system or environment. Info widgets are defined your widgets.yaml file. Here's an example:
- openmeteo:\n label: Current\n latitude: 36.66\n longitude: -117.51\n cache: 5\nWidgets are a core component of Homepage. They are used to display information about your system, services, and environment.
"},{"location":"widgets/authoring/#overview","title":"Overview","text":"If you are new to Homepage widgets, and are looking to create a new widget, please follow along with the guide here: Widget Tutorial.
"},{"location":"widgets/authoring/#translations","title":"Translations","text":"All text and numerical content in widgets should be translated and localized. English is the default language, and other languages can be added via Crowdin.
The Homepage community prides itself on being multilingual, and we strongly encourage you to add translations for your widgets.
If you are looking to learn more about translations, please refer to the guide here: Translations Guide.
"},{"location":"widgets/authoring/#widget-component","title":"Widget Component","text":"The widget component is the core of the widget. It is responsible for fetching data from the API and rendering the widget UI. Homepage provides a set of hooks and utilities to help you build your widget component.
If you are looking to learn more about widget components, please refer to the guide here: Component Guide.
"},{"location":"widgets/authoring/#widget-metadata","title":"Widget Metadata","text":"Widget metadata defines the configuration of the widget. It defines the API endpoint to fetch data from, the proxy handler to use, and any data mappings.
If you are looking to learn more about widget metadata, endpoint and data mapping, please refer to the guide here: Metadata Guide.
If you are looking to learn more about proxy handlers, please refer to the guide here: Proxies Guide.
If you are looking to learn more making API calls from inside your widget, please refer to the guide here: API Guide.
"},{"location":"widgets/authoring/api/","title":"API Guide","text":"Homepage provides the useWidgetAPI hook to help you fetch data from an API. This hook insures that the data is fetched using a proxy, and is critical for security.
Here is an example of how the useWidgetAPI hook looks:
import useWidgetAPI from \"utils/proxy/use-widget-api\";\n\nexport default function Component({ service }) {\n const { data, error } = useWidgetAPI(widget, \"stats\");\n}\nuseWidgetAPI","text":"useWidgetAPI takes three possible arguments:
widget: The widget metadata object.endpoint: The name of the endpoint to fetch data from.params: An optional object containing query parameters to pass to the API.widget","text":"The widget argument is the metadata object for the widget. It contains information about the API endpoint, proxy handler, and mappings. This object is used by the useWidgetAPI hook to fetch data from the API. This is generally passed in as a prop from the parent component.
endpoint","text":"The endpoint argument is the name of the endpoint to fetch data from. This is defined in the widget metadata object. The useWidgetAPI hook uses this argument to determine which endpoint to fetch data from.
If no endpoint is provided, the useWidgetAPI hook will call the API endpoint defined in the widget metadata object directly.
params","text":"The params argument is an optional object containing query parameters to pass to the API. This is useful for filtering data or passing additional information to the API. This object is passed directly to the API endpoint as query parameters.
Here is an example of how to use the params argument:
import useWidgetAPI from \"utils/proxy/use-widget-api\";\n\nexport default function Component({ service }) {\n const { data, error } = useWidgetAPI(widget, \"stats\", { start: \"2021-01-01\", end: \"2021-12-31\" });\n}\nThe params must be whitelisted in the widget metadata object. This is done to prevent arbitrary query parameters from being passed to the API.
Homepage widgets are built using React components. These components are responsible for fetching data from the API and rendering the widget UI. Homepage provides a set of hooks and utilities to help you build your widget component.
"},{"location":"widgets/authoring/component/#a-basic-widget-component","title":"A Basic Widget Component","text":"Here is an example of a basic widget component:
import { useTranslation } from \"next-i18next\";\n\nimport Container from \"components/services/widget/container\";\nimport Block from \"components/services/widget/block\";\nimport useWidgetAPI from \"utils/proxy/use-widget-api\";\n\nexport default function Component({ service }) {\n const { t } = useTranslation();\n const { widget } = service;\n const { data, error } = useWidgetAPI(widget, \"info\");\n\n if (error) {\n return <Container service={service} error={error} />;\n }\n\n if (!data) {\n return (\n <Container service={service}>\n <Block label=\"yourwidget.key1\" />\n <Block label=\"yourwidget.key2\" />\n <Block label=\"yourwidget.key3\" />\n </Container>\n );\n }\n\n return (\n <Container service={service}>\n <Block label=\"yourwidget.key1\" value={t(\"common.number\", { value: data.key1 })} />\n <Block label=\"yourwidget.key2\" value={t(\"common.number\", { value: data.key2 })} />\n <Block label=\"yourwidget.key3\" value={t(\"common.number\", { value: data.key3 })} />\n </Container>\n );\n}\nWe'll cover two sections of the widget component: hooks and components.
"},{"location":"widgets/authoring/component/#hooks","title":"Hooks","text":"useTranslation
This hook is used to translate text and numerical content in widgets. Homepage provides a set of helpers to help you localize your widgets. You can learn more about translations in the Translations Guide.
useWidgetAPI
This hook is used to fetch data from the API. We cover this hook in more detail in the API Guide.
"},{"location":"widgets/authoring/component/#components","title":"Components","text":"Homepage provides a set of components to help you build your widget UI. These components are designed to provide a consistent layout, and all widgets are expected to use these components.
<Container>
This component is a wrapper for the widget. It provides a consistent layout for all widgets.
<Container service={service}></Container>\nservice is a prop that is passed to the widget component. It contains information about the service that the widget is displaying.
If there is an error fetching data from the API, the error prop can be passed to the Container component.
<Container service={service} error={error}></Container>\n<Block>
This component is used to display a key-value pair. It takes a label and value as props.
<Block label=\"yourwidget.key1\" value={t(\"common.number\", { value: data.key1 })} />\nThe label prop is used to look up the translation key in the translation files. The value prop is used to display the value of the block. To learn more about translations, please refer to the Translations Guide.
If there is no data available, the Block component can be used to display a placeholder layout.
<Container service={service}>\n <Block label=\"yourwidget.key1\" />\n <Block label=\"yourwidget.key2\" />\n <Block label=\"yourwidget.key3\" />\n</Container>\nHere, we will go over how to create and configure Homepage widget metadata. Metadata is a JS object that contains information about the widget, such as the API endpoint, proxy handler, and mappings. This metadata is used by Homepage to fetch data from the API and pass it to the widget.
"},{"location":"widgets/authoring/metadata/#widgets-configuration","title":"Widgets Configuration","text":"Here are some examples of how to configure a widget's metadata object.
Basic ExampleAdvanced Exampleimport genericProxyHandler from \"utils/proxy/handlers/generic\";\n\nconst widgetExample = {\n api: \"{url}/api/{endpoint}\",\n proxyHandler: genericProxyHandler,\n\n mappings: {\n stats: { endpoint: \"stats\" }\n },\n};\nimport credentialedProxyHandler from \"utils/proxy/handlers/credentialed\";\nimport { asJson, jsonArrayFilter } from \"utils/proxy/api-helpers\";\n\nconst widgetExample = {\n api: \"{url}/api/{endpoint}\",\n proxyHandler: credentialedProxyHandler,\n\n mappings: {\n stats: {\n endpoint: \"stats\",\n validate: [\"total\", \"average\"],\n params: [\"start\", \"end\"],\n },\n notices: {\n endpoint: \"notices\",\n map: (data) => {\n total: asJson(data).length;\n },\n },\n warnings: {\n endpoint: \"notices\",\n map: (data) => {\n total: jsonArrayFilter(data, (alert) => alert.type === \"warning\").length;\n },\n },\n },\n};\nA widgets metadata is quite powerful and can be configured in many different ways.
"},{"location":"widgets/authoring/metadata/#configuration-properties","title":"Configuration Properties","text":""},{"location":"widgets/authoring/metadata/#api","title":"api","text":"The api property is a string that represents the URL of the API endpoint that the widget will use to fetch data. The URL can contain placeholders that will be replaced with actual values at runtime. For example, the {url} placeholder will be replaced with the URL of the configured widget, and the {endpoint} placeholder will be replaced with the value of the endpoint property in the mappings object.
const widgetExample = {\n api: \"{url}/api/{endpoint}\",\n};\nproxyHandler","text":"The proxyHandler property is a function that will be used to make the API request. Homepage includes some built-in proxy handlers that can be used out of the box:
Here is an example of the generic proxy handler that makes unauthenticated requests to the specified API endpoint.
widget.jsservices.yamlconst widgetExample = {\n api: \"{url}/api/{endpoint}\",\n proxyHandler: genericProxyHandler,\n};\n- Services:\n - Your Widget:\n icon: yourwidget.svg\n href: https://example.com/\n widget:\n type: yourwidget\n url: http://127.0.0.1:1337\nIf you are looking to learn more about proxy handlers, please refer to the guide here: Proxies Guide.
"},{"location":"widgets/authoring/metadata/#mappings","title":"mappings","text":"The mappings property is an object that contains information about the API endpoint, such as the endpoint name, validation rules, and parameter names. The mappings object can contain multiple endpoints, each with its own configuration.
Security Note
The mappings or allowedEndpoints property is required for the widget to fetch data from more than a static URL. Homepage uses a whitelist approach to ensure that widgets only access allowed endpoints.
import { asJson } from \"utils/proxy/api-helpers\";\n\nconst widgetExample = {\n api: \"{url}/api/{endpoint}\",\n mappings: {\n // `/api/stats?start=...&end=...`\n stats: {\n endpoint: \"stats\",\n validate: [\"total\", \"average\"],\n params: [\"start\", \"end\"],\n },\n // `/api/notices`\n notices: {\n endpoint: \"notices\",\n map: (data) => {\n total: asJson(data).length;\n },\n },\n },\n};\nendpoint","text":"The endpoint property is a string that represents the name of the API endpoint that the widget will use to fetch data. This value will be used to replace the {endpoint} placeholder in the api property.
const widgetExample = {\n api: \"{url}/api/{endpoint}\",\n mappings: {\n // `/api/stats`\n stats: {\n endpoint: \"stats\",\n },\n },\n};\nvalidate","text":"The validate property is an array of strings that represent the keys that should be validated in the API response. If the response does not contain all of the specified keys, the widget will not render.
const widgetExample = {\n api: \"{url}/api/{endpoint}\",\n mappings: {\n // `/api/stats`\n stats: {\n endpoint: \"stats\",\n validate: [\"total\", \"average\"],\n },\n },\n};\nThis configuration will ensure that the API response contains the total and average keys before the widget is rendered.
params","text":"The params property is an array of strings that represent the keys that should be passed as parameters to the API endpoint. These keys will be replaced with the actual values at runtime.
const widgetExample = {\n api: \"{url}/api/{endpoint}\",\n mappings: {\n // `/api/stats?start=...&end=...`\n stats: {\n endpoint: \"stats\",\n params: [\"start\", \"end\"],\n },\n },\n};\nconst { data: statsData, error: statsError } = useWidgetAPI(widget, \"stats\", {\n start: new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),\n end: new Date(),\n});\nThis configuration will pass the start and end keys as parameters to the API endpoint. The values are passed as an object to the useWidgetAPI hook.
map","text":"The map property is a function that will be used to transform the API response before it is passed to the widget. This function is passed the raw API response and should return the transformed data.
import { asJson } from \"utils/proxy/api-helpers\";\n\nconst widgetExample = {\n api: \"{url}/api/{endpoint}\",\n mappings: {\n // `/api/notices`\n notices: {\n endpoint: \"notices\",\n map: (data) => {\n total: asJson(data).length;\n },\n },\n // `/api/notices`\n warnings: {\n endpoint: \"notices\",\n map: (data) => {\n total: asJson(data).filter((alert) => alert.type === \"warning\").length;\n },\n },\n },\n};\nmethod","text":"The method property is a string that represents the HTTP method that should be used to make the API request. The default value is GET.
const widgetExample = {\n api: \"{url}/api/{endpoint}\",\n mappings: {\n // `/api/stats`\n stats: {\n endpoint: \"stats\",\n method: \"POST\",\n },\n },\n};\nheaders","text":"The headers property is an object that contains additional headers that should be included in the API request. If your endpoint requires specific headers, you can include them here.
const widgetExample = {\n api: \"{url}/api/{endpoint}\",\n mappings: {\n // `/api/stats`\n stats: {\n endpoint: \"stats\",\n method: \"POST\",\n headers: {\n \"Content-Type\": \"application/json\",\n },\n },\n },\n};\nbody","text":"The body property is an object that contains the data that should be sent in the request body. This property is only used when the method property is set to POST or PUT.
const widgetExample = {\n api: \"{url}/api/{endpoint}\",\n mappings: {\n // `/api/graphql`\n stats: {\n endpoint: \"graphql\",\n method: \"POST\",\n body: {\n query: `\n query {\n stats {\n total\n average\n }\n }\n `,\n },\n headers: {\n \"Content-Type\": \"application/json\",\n },\n },\n },\n};\nallowedEndpoints","text":"The allowedEndpoints property is a RegExp that represents the allowed endpoints that the widget can use. If the widget tries to access an endpoint that is not allowed, the request will be blocked.
allowedEndpoints can be used when endpoint validation is simple and can be done using a regular expression, and more control is not required.
Security Note
The mappings or allowedEndpoints property is required for the widget to fetch data from more than a static URL. Homepage uses a whitelist approach to ensure that widgets only access allowed endpoints.
const widgetExample = {\n api: \"{url}/api/{endpoint}\",\n allowedEndpoints: /^stats|notices$/,\n};\nThis configuration will only allow the widget to access the stats and notices endpoints.
Homepage includes a set of built-in proxy handlers that can be used to fetch data from an API. We will go over how to use these proxy handlers and briefly cover how to create your own.
"},{"location":"widgets/authoring/proxies/#available-proxy-handlers","title":"Available Proxy Handlers","text":"Homepage comes with a few built-in proxy handlers that can be used to fetch data from an API. These handlers are located in the utils/proxy/handlers directory.
genericProxyHandler","text":"A proxy handler that makes generally unauthenticated requests to the specified API endpoint.
import genericProxyHandler from \"utils/proxy/handlers/generic\";\n\nconst widgetExample = {\n api: \"{url}/api/{endpoint}\",\n proxyHandler: genericProxyHandler,\n};\nYou can also pass API keys from the widget configuration to the proxy handler, for authenticated requests.
widget.jsservices.yamlimport genericProxyHandler from \"utils/proxy/handlers/generic\";\n\nconst widgetExample = {\n api: \"{url}/api/{endpoint}?key={key}\",\n proxyHandler: genericProxyHandler,\n};\n# Widget Configuration\n- Your Widget:\n icon: yourwidget.svg\n href: https://example.com/\n widget:\n type: yourwidget\n url: http://example.com\n key: your-api-key\ncredentialedProxyHandler","text":"A proxy handler that makes authenticated by setting request headers. Credentials are pulled from the widgets configuration.
By default the key is passed as an X-API-Key header. If you need to pass the key as something else, either add a case to the credentialedProxyHandler or create a new proxy handler.
import credentialedProxyHandler from \"utils/proxy/handlers/credentialed\";\n\nconst widgetExample = {\n api: \"{url}/api/{endpoint}?key={key}\",\n proxyHandler: credentialedProxyHandler,\n};\n- Your Widget:\n icon: yourwidget.svg\n href: https://example.com/\n widget:\n type: yourwidget\n url: http://127.0.0.1:1337\n key: your-api-key\njsonrpcProxyHandler","text":"A proxy handler that makes authenticated JSON-RPC requests to the specified API endpoint. Where the endpoint is the method to call.
widget.jsservices.yamlimport jsonrpcProxyHandler from \"utils/proxy/handlers/jsonrpc\";\n\nconst widgetExample = {\n api: \"{url}/api/jsonrpc\",\n proxyHandler: jsonrpcProxyHandler,\n\n mappings: {\n total: { endpoint: \"total\" },\n average: { endpoint: \"average\" },\n },\n};\n- Your Widget:\n icon: yourwidget.svg\n href: https://example.com/\n widget:\n type: yourwidget\n url: http://127.0.0.1:1337\n username: your-username\n password: your-password\nsynologyProxyHandler","text":"A proxy handler that makes authenticated requests to the specified Synology API endpoint. This is used exclusively for Synology DSM services.
widget.jsservices.yamlimport synologyProxyHandler from \"utils/proxy/handlers/synology\";\n\nconst widgetExample = {\n api: \"{url}/webapi/{cgiPath}?api={apiName}&version={maxVersion}&method={apiMethod}\",\n proxyHandler: synologyProxyHandler,\n\n mappings: {\n system_storage: {\n apiName: \"SYNO.Core.System\",\n apiMethod: 'info&type=\"storage\"',\n endpoint: \"system_storage\",\n }\n },\n};\n- Your Widget:\n icon: yourwidget.svg\n href: https://example.com/\n widget:\n type: yourwidget\n url: http://127.0.0.1:1337\n username: your-username\n password: your-password\nYou can create your own proxy handler to fetch data from an API. A proxy handler is a function that takes a configuration object and returns a function that makes the API request.
The proxy handler function takes three arguments:
req: The request object.res: The response object.map: A function that maps the API response to the widget data.The proxy handler function should return a promise that resolves to the API response.
Here is an example of a simple proxy handler that fetches data from an API and passes it to the widget:
import createLogger from \"utils/logger\";\nimport { httpProxy } from \"utils/proxy/http\";\n\nconst logger = createLogger(\"customProxyHandler\");\n\nexport default async function customProxyHandler(req, res, map) {\n const { url } = req.query;\n\n const [status, contentType, data] = await httpProxy(url);\n\n return res.status(status).send(data);\n}\nProxy handlers are a complex topic and require a good understanding of JavaScript and the Homepage codebase. If you are new to Homepage, we recommend using the built-in proxy handlers.
"},{"location":"widgets/authoring/translations/","title":"Translations Guide","text":"All text and numerical content in widgets should be translated and localized. English is the default language, and other languages can be added via Crowdin.
The Homepage community prides itself on being multilingual, and we strongly encourage you to add translations for your widgets.
"},{"location":"widgets/authoring/translations/#translations","title":"Translations","text":"Homepage uses the next-i18next library to handle translations. This library provides a set of hooks and utilities to help you localize your widgets, and Homepage has extended this library to support additional features.
component.jsxen.jsonimport { useTranslation } from \"next-i18next\";\n\nimport Container from \"components/services/widget/container\";\nimport Block from \"components/services/widget/block\";\n\nexport default function Component() {\n const { t } = useTranslation();\n\n return (\n <Container service={service}>\n <Block label=\"yourwidget.key1\" />\n <Block label=\"yourwidget.key2\" />\n <Block label=\"yourwidget.key3\" />\n </Container>\n );\n}\n\"yourwidget\": {\n \"key1\": \"Value 1\",\n \"key2\": \"Value 2\",\n \"key3\": \"Value 3\"\n}\nHomepage provides a set of common translations that you can use in your widgets. These translations are used to format numerical content, dates, and other common elements.
"},{"location":"widgets/authoring/translations/#numbers","title":"Numbers","text":"Key Translation Descriptioncommon.bytes 1,000 B Format a number in bytes. common.bits 1,000 bit Format a number in bits. common.bbytes 1 KiB Format a number in binary bytes. common.bbits 1 Kibit Format a number in binary bits. common.byterate 1,000 B/s Format a byte rate. common.bibyterate 1 KiB/s Format a binary byte rate. common.bitrate 1,000 bit/s Format a bit rate. common.bibitrate 1 Kibit/s Format a binary bit rate. common.percent 50% Format a percentage. common.number 1,000 Format a number. common.ms 1,000 ms Format a number in milliseconds. common.date 2024-01-01 Format a date. common.relativeDate 1 day ago Format a relative date. common.uptime 1 day, 1 hour Format an uptime."},{"location":"widgets/authoring/translations/#text","title":"Text","text":"Key Translation Description resources.cpu CPU CPU usage. resources.mem MEM Memory usage. resources.total Total Total resource. resources.free Free Free resource. resources.used Used Used resource. resources.load Load Load value. resources.temp TEMP Temperature value. resources.max Max Maximum value. resources.uptime UP Uptime."},{"location":"widgets/authoring/tutorial/","title":"Widget Tutorial","text":"In this guide, we'll walk through the process of creating a custom widget for Homepage. We'll cover the basic structure of a widget, how to use translations, and how to fetch data from an API. By the end of this guide, you'll have a solid understanding of how to build your own custom widget.
Prerequisites:
Throughout this guide, we'll use yourwidget as a placeholder for the unique name of your custom widget. Replace yourwidget with the actual name of your widget. It should contain only lowercase letters and no spaces.
This guide makes use of a fake API, which would return a JSON response as such, when called with the v1/info endpoint:
{ \"key1\": 123, \"key2\": 456, \"key3\": 789 }\nCreate a new folder for your widget in the src/widgets directory. Name the folder yourwidget.
Inside the yourwidget folder, create a new file named widget.js. This file will contain the metadata for your widget.
Open the widget.js file and add the following code:
import genericProxyHandler from \"utils/proxy/handlers/generic\"; // (1)!\n\nconst widget = /* (2)! */ {\n api: \"{url}/{endpoint}\" /* (3)! */,\n proxyHandler: genericProxyHandler /* (1)! */,\n\n mappings: /* (4)! */ {\n info: /* (5)! */ {\n endpoint: \"v1/info\" /* (6)! */,\n },\n },\n};\n\nexport default widget;\ngenericProxyHandler from the utils/proxy/handlers/generic module. The genericProxyHandler is a generic handler that can be used to fetch data from an API. We then assign the genericProxyHandler to the proxyHandler property of the widget object. There are other handlers available that you can use depending on your requirements. You can also create custom handlers if needed.widget object that contains the metadata for the widget.{url} and {endpoint} to dynamically generate the API endpoint based on the widget configuration.endpoint property that specifies the endpoint to fetch data from.info that specifies the v1/info endpoint to fetch data from. This would be called from the component as such: useWidgetAPI(widget, \"info\");endpoint property of the info mapping specifies the endpoint to fetch data from. There are other properties you can pass to the mapping, such as method, headers, and body.Important
All widgets that fetch data from dynamic endpoints should have either mappings or an allowedEndpoints property.
Homepage uses translated and localized strings for all text and numerical content in widgets. English is the default language, and other languages can be added via Crowdin. To add the English translations for your widget, follow these steps:
Open the public/locales/en/common.js file.
Add a new object for your widget to the bottom of the list, like this:
\"yourwidget\": {\n \"key1\": \"Value 1\",\n \"key2\": \"Value 2\",\n \"key3\": \"Value 3\"\n}\nNote
Even if you nativly speak another language, you should only add English translations. You can then add translations in your native language via Crowdin, once your widget is merged.
"},{"location":"widgets/authoring/tutorial/#create-the-widget-component","title":"Create the widget component","text":"Create a new file for your widgets component, named component.jsx, in the src/widgets/yourwidget directory. We'll build the contents of the component.jsx file step by step.
First, we'll import the necessary dependencies:
src/widgets/yourwidget/component.jsximport { useTranslation } from \"next-i18next\"; // (1)!\n\nimport Container from \"components/services/widget/container\"; // (2)!\nimport Block from \"components/services/widget/block\"; // (3)!\nimport useWidgetAPI from \"utils/proxy/use-widget-api\"; // (4)!\nuseTranslation() is a hook provided by next-i18next that allows us to access the translation strings<Container> and <Block> are custom components that we'll use to structure our widget.<Container> and <Block> are custom components that we'll use to structure our widget.useWidgetAPI(widget, endpoint) is a custom hook that we'll use to fetch data from an API.Next, we'll define a functional component named Component that takes a service prop.
export default function Component({ service }) {}\nWe grab the helper functions from the useTranslation hook.
const { t } = useTranslation();\nWe destructure the widget object from the service prop. The widget object contains the metadata for the widget, such as the API endpoint to fetch data from.
const { widget } = service;\nNow, the fun part! We use the useWidgetAPI hook to fetch data from an API. The useWidgetAPI hook takes two arguments: the widget object and the API endpoint to fetch data from. The useWidgetAPI hook returns an object with data and error properties.
const { data, error } = useWidgetAPI(widget, \"info\");\nAPI Tips
You'll see here how part of the API url is built using the url and endpoint properties from the widget definition.
In this case, we're fetching data from the info endpoint. The info endpoint is defined in the mappings object. So the full API endpoint will be \"{url}/v1/info\".
The mapping and endpoint are often the same, but must be defined regardless.
Next, we check if there's an error or no data.
If there's an error, we return a Container and pass it the service and error as props. The Container component will handle displaying the error message.
if (error) {\n return <Container service={service} error={error} />;\n}\nIf there's no data, we return a Container component with three Block components, each with a label.
if (!data) {\n return (\n <Container service={service}>\n <Block label=\"yourwidget.key1\" />\n <Block label=\"yourwidget.key2\" />\n <Block label=\"yourwidget.key3\" />\n </Container>\n );\n}\nThis will render the widget with placeholders for the data, i.e., a skeleton view.
Translation Tips
The label prop in the Block component corresponds to the translation key we defined earlier in the common.js file. All text and numerical content should be translated.
If there is data, we return a Container component with three Block components, each with a label and a value.
Here we use the t function from the useTranslation hook to translate the data values. The t function takes the translation key and an object with variables to interpolate into the translation string.
We're using the common.number translation key to format the data values as numbers. This allows for easy localization of numbers, such as using commas or periods as decimal separators.
There are a large number of common numerical translation keys available, which you can learn more about in the Translation Guide.
return (\n <Container service={service}>\n <Block label=\"yourwidget.key1\" value={t(\"common.number\", { value: data.key1 })} />\n <Block label=\"yourwidget.key2\" value={t(\"common.number\", { value: data.key2 })} />\n <Block label=\"yourwidget.key3\" value={t(\"common.number\", { value: data.key3 })} />\n </Container>\n);\nHere's the complete component.jsx file:
import { useTranslation } from \"next-i18next\";\n\nimport Container from \"components/services/widget/container\";\nimport Block from \"components/services/widget/block\";\nimport useWidgetAPI from \"utils/proxy/use-widget-api\";\n\nexport default function Component({ service }) {\n const { t } = useTranslation();\n const { widget } = service;\n const { data, error } = useWidgetAPI(widget, \"info\");\n\n if (error) {\n return <Container service={service} error={error} />;\n }\n\n if (!data) {\n return (\n <Container service={service}>\n <Block label=\"yourwidget.key1\" />\n <Block label=\"yourwidget.key2\" />\n <Block label=\"yourwidget.key3\" />\n </Container>\n );\n }\n\n return (\n <Container service={service}>\n <Block label=\"yourwidget.key1\" value={t(\"common.number\", { value: data.key1 })} />\n <Block label=\"yourwidget.key2\" value={t(\"common.number\", { value: data.key2 })} />\n <Block label=\"yourwidget.key3\" value={t(\"common.number\", { value: data.key3 })} />\n </Container>\n );\n}\nTo add your widget to the Homepage, you need to register it in the src/widgets/widgets.js file.
Open the src/widgets/widgets.js file and import the Component from your widget's component.jsx file. Please keep the alphabetical order.
// ...\nimport yourwidget from \"./yourwidget/widget\";\n// ...\nAdd yourwidget to the widgets object. Please keep the alphabetical order.
const widgets = {\n // ...\n yourwidget: yourwidget,\n // ...\n};\nYou also need to add the widget to the components object in the src/widgets/components.js file.
Open the src/widgets/components.js file and import the Component from your widget's component.jsx file.
Please keep the alphabetical order.
const components = {\n // ...\n yourwidget: dynamic(() => import(\"./yourwidget/component\")),\n // ...\n};\nYou can now use your custom widget in your Homepage. Open your services.yaml file and add a new service with the yourwidget widget.
- Services:\n - Your Widget:\n icon: yourwidget.svg\n href: https://example.com/\n widget:\n type: yourwidget\n url: http://127.0.0.1:1337\nAPI Tips
You'll see here how part of the API url is built using the url and endpoint properties from the widget definition.
We defined the api endpoint as \"{url}/{endpoint}\". This is where the url is defined. So the full API endpoint will be http://127.0.0.1:1337/{endpoint}.
That's it! You've successfully created a custom widget for Homepage. If you have any questions or need help, feel free to reach out to the Homepage community for assistance. Happy coding!
"},{"location":"widgets/info/datetime/","title":"Date & Time","text":"This allows you to display the date and/or time, can be heavily configured using Intl.DateTimeFormat.
Formatting is locale aware and will present your date in the regional format you expect, for example, 9/16/22, 3:03 PM for locale en and 16.09.22, 15:03 for de. You can also specify a locale just for the datetime widget with the locale option (see below).
- datetime:\n text_size: xl\n format:\n timeStyle: short\nAny options passed to format are passed directly to Intl.DateTimeFormat, please reference the MDN documentation for all available options.
Valid text sizes are 4xl, 3xl, 2xl, xl, md, sm, xs.
A few examples,
# 13:37\nformat:\n timeStyle: short\n hourCycle: h23\n# 1:37 PM\nformat:\n timeStyle: short\n hour12: true\n# 1/23/22, 1:37 PM\nformat:\n dateStyle: short\n timeStyle: short\n hour12: true\n# 4 januari 2023 om 13:51:25 PST\nlocale: nl\nformat:\n dateStyle: long\n timeStyle: long\n(Find the Glances service widget here)
The Glances widget allows you to monitor the resources (CPU, memory, storage, temp & uptime) of host or another machine, and is designed to match the resources info widget. You can have multiple instances by adding another configuration block. The cputemp, uptime & disk states require separate API calls and thus are not enabled by default. Glances needs to be running in \"web server\" mode to enable the API, see the glances docs.
- glances:\n url: http://host.or.ip:port\n username: user # optional if auth enabled in Glances\n password: pass # optional if auth enabled in Glances\n version: 4 # required only if running glances v4 or higher, defaults to 3\n cpu: true # optional, enabled by default, disable by setting to false\n mem: true # optional, enabled by default, disable by setting to false\n cputemp: true # disabled by default\n uptime: true # disabled by default\n disk: / # disabled by default, use mount point of disk(s) in glances. Can also be a list (see below)\n diskUnits: bytes # optional, bytes (default) or bbytes. Only applies to disk\n expanded: true # show the expanded view\n label: MyMachine # optional\nMultiple disks can be specified as:
disk:\n - /\n - /boot\n ...\nAdded in v0.4.18, updated in v0.6.11, v0.6.21
"},{"location":"widgets/info/greeting/","title":"Greeting","text":"This allows you to display simple text, can be configured like so:
- greeting:\n text_size: xl\n text: Greeting Text\nValid text sizes are 4xl, 3xl, 2xl, xl, md, sm, xs.
This is very similar to the Resources widget, but provides resource information about a Kubernetes cluster.
It provides CPU and Memory usage, by node and/or at the cluster level.
- kubernetes:\n cluster:\n # Shows cluster-wide statistics\n show: true\n # Shows the aggregate CPU stats\n cpu: true\n # Shows the aggregate memory stats\n memory: true\n # Shows a custom label\n showLabel: true\n label: \"cluster\"\n nodes:\n # Shows node-specific statistics\n show: true\n # Shows the CPU for each node\n cpu: true\n # Shows the memory for each node\n memory: true\n # Shows the label, which is always the node name\n showLabel: true\nThis allows you to display the homepage logo, you can optionally specify your own icon using similar options as other icons, see service icons.
- logo:\n icon: https://upload.wikimedia.org/wikipedia/commons/thumb/d/d5/I_Love_New_York.svg/1101px-I_Love_New_York.svg.png # optional\nAdded in v0.4.18, updated in 0.X.X
"},{"location":"widgets/info/longhorn/","title":"Longhorn","text":"The Longhorn widget pulls storage utilization metrics from the Longhorn storage driver on Kubernetes. It is designed to appear similar to the Resource widget's disk representation.
The exact metrics should be very similar to what is seen on the Longhorn dashboard itself.
It can show the aggregate metrics and/or the individual node metrics.
- longhorn:\n # Show the expanded view\n expanded: true\n # Shows a node representing the aggregate values\n total: true\n # Shows the node names as labels\n labels: true\n # Show the nodes\n nodes: true\n # An explicit list of nodes to show. All are shown by default if \"nodes\" is true\n include:\n - node1\n - node2\nThe Longhorn URL and credentials are stored in the providers section of the settings.yaml. e.g.:
providers:\n longhorn:\n username: \"longhorn-username\" # optional\n password: \"very-secret-longhorn-password\" # optional\n url: https://longhorn.aesop.network\nNo registration is required at all! See https://open-meteo.com/en/docs
- openmeteo:\n label: Kyiv # optional\n latitude: 50.449684\n longitude: 30.525026\n timezone: Europe/Kiev # optional\n units: metric # or imperial\n cache: 5 # Time in minutes to cache API responses, to stay within limits\n format: # optional, Intl.NumberFormat options\n maximumFractionDigits: 1\nYou can optionally not pass a latitude and longitude and the widget will use your current location (requires a secure context, eg. HTTPS).
The free tier \"One Call API\" is all that's required, you will need to subscribe and grab your API key.
- openweathermap:\n label: Kyiv #optional\n latitude: 50.449684\n longitude: 30.525026\n units: metric # or imperial\n provider: openweathermap\n apiKey: youropenweathermapkey # required only if not using provider, this reveals api key in requests\n cache: 5 # Time in minutes to cache API responses, to stay within limits\n format: # optional, Intl.NumberFormat options\n maximumFractionDigits: 1\nYou can optionally not pass a latitude and longitude and the widget will use your current location (requires a secure context, eg. HTTPS).
You can include all or some of the available resources. If you do not want to see that resource, simply pass false.
The disk path is the path reported by df (Mounted On), or the mount point of the disk.
The cpu and memory resource information are the container's usage while glances displays statistics for the host machine on which it is installed.
Note: unfortunately, the package used for getting CPU temp (systeminformation) is not compatible with some setups and will not report any value(s) for CPU temp.
Any disk you wish to access must be mounted to your container as a volume.
- resources:\n cpu: true\n memory: true\n disk: /disk/mount/path\n cputemp: true\n tempmin: 0 # optional, minimum cpu temp\n tempmax: 100 # optional, maximum cpu temp\n uptime: true\n units: imperial # only used by cpu temp\n refresh: 3000 # optional, in ms\n diskUnits: bytes # optional, bytes (default) or bbytes. Only applies to disk\nYou can also pass a label option, which allows you to group resources under named sections,
- resources:\n label: System\n cpu: true\n memory: true\n\n- resources:\n label: Storage\n disk: /mnt/storage\nWhich produces something like this,
If you have more than a single disk and would like to group them together under the same label, you can pass an array of paths instead,
- resources:\n label: Storage\n disk:\n - /mnt/storage\n - /mnt/backup\n - /mnt/media\nTo produce something like this,
You can additionally supply an optional expanded property set to true in order to show additional details about the resources. By default the expanded property is set to false when not supplied.
- resources:\n label: Array Disks\n expanded: true\n disk:\n - /disk1\n - /disk2\n - /disk3\nYou can add a search bar to your top widget area that can search using Google, Duckduckgo, Bing, Baidu, Brave or any other custom provider that supports the basic ?q= search query param.
- search:\n provider: google # google, duckduckgo, bing, baidu, brave or custom\n focus: true # Optional, will set focus to the search bar on page load\n showSearchSuggestions: true # Optional, will show search suggestions. Defaults to false\n target: _blank # One of _self, _blank, _parent or _top\nor for a custom search:
- search:\n provider: custom\n url: https://www.ecosia.org/search?q=\n target: _blank\n suggestionUrl: https://ac.ecosia.org/autocomplete?type=list&q= # Optional\n showSearchSuggestions: true # Optional\nmultiple providers is also supported via a dropdown (excluding custom):
- search:\n provider: [brave, google, duckduckgo]\nThe response body for the URL provided with the suggestionUrl option should look like this:
[\n \"home\",\n [\n \"home depot\",\n \"home depot near me\",\n \"home equity loan\",\n \"homeworkify\",\n \"homedepot.com\",\n \"homebase login\",\n \"home depot credit card\",\n \"home goods\"\n ]\n]\nThe first entry of the array contains the search query, the second one is an array of the suggestions. In the example above, the search query was home.
Added in v0.1.6, updated in 0.6.0
"},{"location":"widgets/info/unifi_controller/","title":"Unifi Controller","text":"(Find the Unifi Controller service widget here)
You can display general connectivity status from your Unifi (Network) Controller. When authenticating you will want to use a local account that has at least read privileges.
An optional 'site' parameter can be supplied, if it is not the widget will use the default site for the controller.
Note: If you enter e.g. incorrect credentials and receive an \"API Error\", you may need to recreate the container to clear the cache.
- unifi_console:\n url: https://unifi.host.or.ip:port\n username: user\n password: pass\n site: Site Name # optional\nAdded in v0.4.18, updated in 0.6.7
"},{"location":"widgets/info/weather/","title":"Weather API","text":"Note: this widget is considered 'deprecated' since there is no longer a free Weather API tier for new members. See the openmeteo or openweathermap widgets for alternatives.
The free tier is all that's required, you will need to register and grab your API key.
- weatherapi:\n label: Kyiv # optional\n latitude: 50.449684\n longitude: 30.525026\n units: metric # or imperial\n apiKey: yourweatherapikey\n cache: 5 # Time in minutes to cache API responses, to stay within limits\n format: # optional, Intl.NumberFormat options\n maximumFractionDigits: 1\nYou can optionally not pass a latitude and longitude and the widget will use your current location (requires a secure context, eg. HTTPS).
Learn more about Adguard Home.
The username and password are the same as used to login to the web interface.
Allowed fields: [\"queries\", \"blocked\", \"filtered\", \"latency\"].
widget:\n type: adguard\n url: http://adguard.host.or.ip\n username: admin\n password: password\nLearn more about Atsumeru.
Define same username and password that is used for login from web or supported apps
Allowed fields: [\"series\", \"archives\", \"chapters\", \"categories\"].
widget:\n type: atsumeru\n url: http://atsumeru.host.or.ip:port\n username: username\n password: password\nLearn more about Audiobookshelf.
You can find your API token by logging into the Audiobookshelf web app as an admin, go to the config \u2192 users page, and click on your account.
Allowed fields: [\"podcasts\", \"podcastsDuration\", \"books\", \"booksDuration\"]
widget:\n type: audiobookshelf\n url: http://audiobookshelf.host.or.ip:port\n key: audiobookshelflapikey\nLearn more about Authentik.
This widget reads the number of active users in the system, as well as logins for the last 24 hours.
You will need to generate an API token for an existing user under Admin Portal > Directory > Tokens & App passwords. Make sure to set Intent to \"API Token\".
The account you made the API token for also needs the following Assigned global permissions in Authentik:
Allowed fields: [\"users\", \"loginsLast24H\", \"failedLoginsLast24H\"].
widget:\n type: authentik\n url: http://authentik.host.or.ip:22070\n key: api_token\nLearn more about Autobrr.
Find your API key under Settings > API Keys.
Allowed fields: [\"approvedPushes\", \"rejectedPushes\", \"filters\", \"indexers\"].
widget:\n type: autobrr\n url: http://autobrr.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\nLearn more about Azure DevOps.
This widget has 2 functions:
Pipelines: checks if the relevant pipeline is running or not, and if not, reports the last status. Allowed fields: [\"result\", \"status\"].
Pull Requests: returns the amount of open PRs, the amount of the PRs you have open, and how many PRs that you open are marked as 'Approved' by at least 1 person and not yet completed. Allowed fields: [\"totalPrs\", \"myPrs\", \"approved\"].
You will need to generate a personal access token for an existing user, see the azure documentation
widget:\n type: azuredevops\n organization: myOrganization\n project: myProject\n definitionId: pipelineDefinitionId # required for pipelines\n branchName: branchName # optional for pipelines, leave empty for all\n userEmail: email # required for pull requests\n repositoryId: prRepositoryId # required for pull requests\n key: personalaccesstoken\nLearn more about Bazarr.
Find your API key under Settings > General.
Allowed fields: [\"missingEpisodes\", \"missingMovies\"].
widget:\n type: bazarr\n url: http://bazarr.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\nLearn more about Caddy.
Allowed fields: [\"upstreams\", \"requests\", \"requests_failed\"].
widget:\n type: caddy\n url: http://caddy.host.or.ip:adminport # default admin port is 2019\nThis widget shows monthly calendar, with optional integrations to show events from supported widgets.
widget:\n type: calendar\n firstDayInWeek: sunday # optional - defaults to monday\n view: monthly # optional - possible values monthly, agenda\n maxEvents: 10 # optional - defaults to 10\n showTime: true # optional - show time for event happening today - defaults to false\n timezone: America/Los_Angeles # optional and only when timezone is not detected properly (slightly slower performance) - force timezone for ical events (if it's the same - no change, if missing or different in ical - will be converted to this timezone)\n integrations: # optional\n - type: sonarr # active widget type that is currently enabled on homepage - possible values: radarr, sonarr, lidarr, readarr, ical\n service_group: Media # group name where widget exists\n service_name: Sonarr # service name for that widget\n color: teal # optional - defaults to pre-defined color for the service (teal for sonarr)\n params: # optional - additional params for the service\n unmonitored: true # optional - defaults to false, used with *arr stack\n - type: ical # Show calendar events from another service\n url: https://domain.url/with/link/to.ics # URL with calendar events\n name: My Events # required - name for these calendar events\n color: zinc # optional - defaults to pre-defined color for the service (zinc for ical)\n params: # optional - additional params for the service\n showName: true # optional - show name before event title in event line - defaults to false\nThis view shows only list of events from configured integrations
widget:\n type: calendar\n view: agenda\n maxEvents: 10 # optional - defaults to 10\n showTime: true # optional - show time for event happening today - defaults to false\n previousDays: 3 # optional - shows events since three days ago - defaults to 0\n integrations: # same as in Monthly view example\nCurrently integrated widgets are sonarr, radarr, lidarr and readarr.
Supported colors can be found on color palette.
"},{"location":"widgets/services/calendar/#ical","title":"iCal","text":"This custom integration allows you to show events from any calendar that supports iCal format, for example, Google Calendar (go to Settings, select specific calendar, go to Integrate calendar, copy URL from Public Address in iCal format).
Learn more about Calibre-web.
Note: widget requires calibre-web \u2265 v0.6.21.
Allowed fields: [\"books\", \"authors\", \"categories\", \"series\"].
widget:\n type: calibreweb\n url: http://your.calibreweb.host:port\n username: username\n password: password\nLearn more about Changedetection.io.
Find your API key under Settings > API.
widget:\n type: changedetectionio\n url: http://changedetection.host.or.ip:port\n key: apikeyapikeyapikeyapikeyapikey\nLearn more about Channels DVR Server.
widget:\n type: channelsdvrserver\n url: http://server.host.or.ip:port\nLearn more about Cloudflare Tunnels.
As of v0.6.10 this widget no longer accepts a Cloudflare global API key (or account email) due to security concerns. Instead, you should setup an API token which only requires the permissions Account.Cloudflare Tunnel:Read.
Allowed fields: [\"status\", \"origin_ip\"].
widget:\n type: cloudflared\n accountid: accountid # from zero trust dashboard url e.g. https://one.dash.cloudflare.com/<accountid>/home/quick-start\n tunnelid: tunnelid # found in tunnels dashboard under the tunnel name\n key: cloudflareapitoken # api token with `Account.Cloudflare Tunnel:Read` https://dash.cloudflare.com/profile/api-tokens\nLearn more about Coin Market Cap.
Get your API key from your CoinMarketCap Pro Dashboard.
Allowed fields: no configurable fields for this widget.
widget:\n type: coinmarketcap\n currency: GBP # Optional\n symbols: [BTC, LTC, ETH]\n key: apikeyapikeyapikeyapikeyapikey\n defaultinterval: 7d # Optional\nYou can also specify slugs instead of symbols (since symbols aren't guaranteed to be unique). If you supply both, slugs will be used. For example:
widget:\n type: coinmarketcap\n slugs: [chia-network, uniswap]\n key: apikeyapikeyapikeyapikeyapikey\nLearn more about Crowdsec.
See the crowdsec docs for information about registering a machine, in most instances you can use the default credentials (/etc/crowdsec/local_api_credentials.yaml).
Allowed fields: [\"alerts\", \"bans\"].
widget:\n type: crowdsec\n url: http://crowdsechostorip:port\n username: localhost # machine_id in crowdsec\n password: password\nThis widget can show information from custom self-hosted or third party API.
Fields need to be defined in the mappings section YAML object to correlate with the value in the APIs JSON object. Final field definition needs to be the key with the desired value information.
widget:\n type: customapi\n url: http://custom.api.host.or.ip:port/path/to/exact/api/endpoint\n refreshInterval: 10000 # optional - in milliseconds, defaults to 10s\n username: username # auth - optional\n password: password # auth - optional\n method: GET # optional, e.g. POST\n headers: # optional, must be object, see below\n requestBody: # optional, can be string or object, see below\n display: # optional, default to block, see below\n mappings:\n - field: key # needs to be YAML string or object\n label: Field 1\n format: text # optional - defaults to text\n - field: # needs to be YAML string or object\n path:\n to: key2\n format: number # optional - defaults to text\n label: Field 2\n - field: # needs to be YAML string or object\n path:\n to:\n another: key3\n label: Field 3\n format: percent # optional - defaults to text\n - field: key # needs to be YAML string or object\n label: Field 4\n format: date # optional - defaults to text\n locale: nl # optional\n dateStyle: long # optional - defaults to \"long\". Allowed values: `[\"full\", \"long\", \"medium\", \"short\"]`.\n timeStyle: medium # optional - Allowed values: `[\"full\", \"long\", \"medium\", \"short\"]`.\n - field: key # needs to be YAML string or object\n label: Field 5\n format: relativeDate # optional - defaults to text\n locale: nl # optional\n style: short # optional - defaults to \"long\". Allowed values: `[\"long\", \"short\", \"narrow\"]`.\n numeric: auto # optional - defaults to \"always\". Allowed values `[\"always\", \"auto\"]`.\n - field: key\n label: Field 6\n format: text\n additionalField: # optional\n field:\n hourly:\n time: other key\n color: theme # optional - defaults to \"\". Allowed values: `[\"theme\", \"adaptive\", \"black\", \"white\"]`.\n format: date # optional\nSupported formats for the values are text, number, float, percent, bytes, bitrate, date and relativeDate.
The dateStyle and timeStyle options of the date format are passed directly to Intl.DateTimeFormat and the style and numeric options of relativeDate are passed to Intl.RelativeTimeFormat.
For the following JSON object from the API:
{\n \"id\": 1,\n \"name\": \"Rick Sanchez\",\n \"status\": \"Alive\",\n \"species\": \"Human\",\n \"gender\": \"Male\",\n \"origin\": {\n \"name\": \"Earth (C-137)\"\n },\n \"locations\": [\n {\n \"name\": \"Earth (C-137)\"\n },\n {\n \"name\": \"Citadel of Ricks\"\n }\n ]\n}\nDefine the mappings section as an array, for example:
mappings:\n - field: name # Rick Sanchez\n label: Name\n - field: status # Alive\n label: Status\n - field:\n origin: name # Earth (C-137)\n label: Origin\n - field:\n locations:\n 1: name # Citadel of Ricks\n label: Location\nYou can manipulate data with the following tools remap, scale, prefix and suffix, for example:
- field: key4\n label: Field 4\n format: text\n remap:\n - value: 0\n to: None\n - value: 1\n to: Connected\n - any: true # will map all other values\n to: Unknown\n- field: key5\n label: Power\n format: float\n scale: 0.001 # can be number or string e.g. 1/16\n suffix: \"kW\"\n- field: key6\n label: Price\n format: float\n prefix: \"$\"\nYou can change the default block view to a list view by setting the display option to list.
The list view can optionally display an additional field next to the primary field.
additionalField: Similar to field, but only used in list view. Displays additional information for the mapping object on the right.
field: Defined the same way as other custom api widget fields.
color: Allowed options: \"theme\", \"adaptive\", \"black\", \"white\". The option adaptive will apply a color using the value of the additionalField, green for positive numbers, red for negative numbers.
- field: key\n label: Field\n format: text\n remap:\n - value: 0\n to: None\n - value: 1\n to: Connected\n - any: true # will map all other values\n to: Unknown\n additionalField:\n field:\n hourly:\n time: key\n color: theme\n format: date\nPass custom headers using the headers option, for example:
headers:\n X-API-Token: token\nPass custom request body using the requestBody option in either a string or object format. Objects will automatically be converted to a JSON string.
requestBody:\n foo: bar\n# or\nrequestBody: \"{\\\"foo\\\":\\\"bar\\\"}\"\nBoth formats result in {\"foo\":\"bar\"} being sent as the request body. Don't forget to set your Content-Type headers!
Learn more about Deluge.
Uses the same password used to login to the webui, see the deluge FAQ.
Allowed fields: [\"leech\", \"download\", \"seed\", \"upload\"].
widget:\n type: deluge\n url: http://deluge.host.or.ip\n password: password # webui password\nLearn more about Synology Disk Station.
Note: the widget is not compatible with 2FA.
An optional 'volume' parameter can be supplied to specify which volume's free space to display when more than one volume exists. The value of the parameter must be in form of volume_N, e.g. to display free space for volume2, volume_2 should be set as 'volume' value. If omitted, first returned volume's free space will be shown (not guaranteed to be volume1).
Allowed fields: [\"uptime\", \"volumeAvailable\", \"resources.cpu\", \"resources.mem\"].
To access these system metrics you need to connect to the DiskStation (DSM) with an account that is a member of the default Administrators group. That is because these metrics are requested from the API's SYNO.Core.System part that is only available to admin users. In order to keep the security impact as small as possible we can set the account in DSM up to limit the user's permissions inside the Synology system. In DSM 7.x, for instance, follow these steps:
remote_stats.User Groups tab of the user config dialogue check the box for Administrators.Permissions tab check the top box for No Access, effectively prohibiting the user from accessing anything in the shared folders.Applications check the box next to Deny in the header to explicitly prohibit login to all applications.DSM application, either byDeny in the respective row, or (if inheriting permission doesn't work because of other group settings)Allow for this app, orBy IP for this app to limit the source of login attempts to one or more IP addresses/subnets.Preview column shows Allow in the DSM row, click Save.Now configure the widget with the correct login information and test it.
If you encounter issues during testing:
Control Panel > Security > Protection.widget:\n type: diskstation\n url: http://diskstation.host.or.ip:port\n username: username\n password: password\n volume: volume_N # optional\nLearn more about Synology Download Station.
Note: the widget is not compatible with 2FA.
Allowed fields: [\"leech\", \"download\", \"seed\", \"upload\"].
widget:\n type: downloadstation\n url: http://downloadstation.host.or.ip:port\n username: username\n password: password\nLearn more about Emby.
You can create an API key from inside Emby at Settings > Advanced > Api Keys.
As of v0.6.11 the widget supports fields [\"movies\", \"series\", \"episodes\", \"songs\"]. These blocks are disabled by default but can be enabled with the enableBlocks option, and the \"Now Playing\" feature (enabled by default) can be disabled with the enableNowPlaying option.
widget:\n type: emby\n url: http://emby.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\n enableBlocks: true # optional, defaults to false\n enableNowPlaying: true # optional, defaults to true\n enableUser: true # optional, defaults to false\n showEpisodeNumber: true # optional, defaults to false\n expandOneStreamToTwoRows: false # optional, defaults to true\nLearn more about ESPHome.
Show the number of ESPHome devices based on their state.
Allowed fields: [\"total\", \"online\", \"offline\", \"offline_alt\", \"unknown\"] (maximum of 4).
By default ESPHome will only mark devices as offline if their address cannot be pinged. If it has an invalid config or its name cannot be resolved (by DNS) its status will be marked as unknown. To group both offline and unknown devices together, users should use the offline_alt field instead. This sums all devices that are not online together.
widget:\n type: esphome\n url: http://esphome.host.or.ip:port\nLearn more about EVSS.
Allowed fields: [\"pv_power\", \"grid_power\", \"home_power\", \"charge_power].
widget:\n type: evcc\n url: http://evcc.host.or.ip:port\nLearn more about FileFlows.
Allowed fields: [\"queue\", \"processing\", \"processed\", \"time\"].
widget:\n type: fileflows\n url: http://your.fileflows.host:port\nLearn more about Flood.
Allowed fields: [\"leech\", \"download\", \"seed\", \"upload\"].
widget:\n type: flood\n url: http://flood.host.or.ip\n username: username # if set\n password: password # if set\nLearn more about FreshRSS.
Please refer to Enable the API in FreshRSS for the \"API password\" to be entered in the password field.
Allowed fields: [\"subscriptions\", \"unread\"].
widget:\n type: freshrss\n url: http://freshrss.host.or.ip:port\n username: username\n password: password\nApplication access & UPnP must be activated on your device:
Home Network > Network > Network Settings > Access Settings in the Home Network\n[x] Allow access for applications\n[x] Transmit status information over UPnP\nCredentials are not needed and, as such, you may want to consider using http instead of https as those requests are significantly faster.
Allowed fields (limited to a max of 4): [\"connectionStatus\", \"uptime\", \"maxDown\", \"maxUp\", \"down\", \"up\", \"received\", \"sent\", \"externalIPAddress\"].
widget:\n type: fritzbox\n url: http://192.168.178.1\nLearn more about GameDig.
Uses the GameDig library to get game server information for any supported server type.
Allowed fields (limited to a max of 4): [\"status\", \"name\", \"map\", \"currentPlayers\", \"players\", \"maxPlayers\", \"bots\", \"ping\"].
widget:\n type: gamedig\n serverType: csgo # see https://github.com/gamedig/node-gamedig#games-list\n url: udp://server.host.or.ip:port\nAllowed fields: [\"up\", \"down\", \"uptime\"].
widget:\n type: gatus\n url: http://gatus.host.or.ip:port\nLearn more about Ghostfolio.
Authentication requires manually obtaining a Bearer token which can be obtained by make a POST request to the API e.g.
curl -X POST http://localhost:3333/api/v1/auth/anonymous -H 'Content-Type: application/json' -d '{ \"accessToken\": \"SECURITY_TOKEN_OF_ACCOUNT\" }'\nSee the official docs.
Note that the Bearer token is valid for 6 months, after which a new one must be generated.
Allowed fields: [\"gross_percent_today\", \"gross_percent_1y\", \"gross_percent_max\"]
widget:\n type: ghostfolio\n url: http://ghostfoliohost:port\n key: ghostfoliobearertoken\nLearn more about Gitea.
API token requires notifications, repository and issue permissions. See the gitea documentation for details on generating tokens.
Allowed fields: [\"notifications\", \"issues\", \"pulls\"].
widget:\n type: gitea\n url: http://gitea.host.or.ip:port\n key: giteaapitoken\nLearn more about Glances.
(Find the Glances information widget here)
The Glances widget allows you to monitor the resources (cpu, memory, diskio, sensors & processes) of host or another machine. You can have multiple instances by adding another service block.
widget:\n type: glances\n url: http://glances.host.or.ip:port\n username: user # optional if auth enabled in Glances\n password: pass # optional if auth enabled in Glances\n version: 4 # required only if running glances v4 or higher, defaults to 3\n metric: cpu\n diskUnits: bytes # optional, bytes (default) or bbytes. Only applies to disk\n refreshInterval: 5000 # optional - in milliseconds, defaults to 1000 or more, depending on the metric\n pointsLimit: 15 # optional, defaults to 15\nPlease note, this widget does not need an href, icon or description on its parent service. To achieve the same effect as the examples above, see as an example:
- CPU Usage:\n widget:\n type: glances\n url: http://glances.host.or.ip:port\n metric: cpu\n- Network Usage:\n widget:\n type: glances\n url: http://glances.host.or.ip:port\n metric: network:enp0s25\nThe metric field in the configuration determines the type of system monitoring data to be displayed. Here are the supported metrics:
info: System information. Shows the system's hostname, OS, kernel version, CPU type, CPU usage, RAM usage and SWAP usage.
cpu: CPU usage. Shows how much of the system's computational resources are currently being used.
memory: Memory usage. Shows how much of the system's RAM is currently being used.
process: Top 5 processes based on CPU usage. Gives an overview of which processes are consuming the most resources.
network:<interface_name>: Network data usage for the specified interface. Replace <interface_name> with the name of your network interface, e.g., network:enp0s25, as specified in glances.
sensor:<sensor_id>: Temperature of the specified sensor, typically used to monitor CPU temperature. Replace <sensor_id> with the name of your sensor, e.g., sensor:Package id 0 as specified in glances.
disk:<disk_id>: Disk I/O data for the specified disk. Replace <disk_id> with the id of your disk, e.g., disk:sdb, as specified in glances.
gpu:<gpu_id>: GPU usage for the specified GPU. Replace <gpu_id> with the id of your GPU, e.g., gpu:0, as specified in glances.
fs:<mnt_point>: Disk usage for the specified mount point. Replace <mnt_point> with the path of your disk, e.g., /mnt/storage, as specified in glances.
All widgets offer an alternative to the full or \"graph\" view, which is the compact, or \"graphless\" view.
To switch to the alternative \"graphless\" view, simply pass chart: false as an option to the widget, like so:
- Network Usage:\n widget:\n type: glances\n url: http://glances.host.or.ip:port\n metric: network:enp0s25\n chart: false\nLearn more about Gluetun.
Note
Requires HTTP control server options to be enabled. By default this runs on port 8000.
Allowed fields: [\"public_ip\", \"region\", \"country\"].
widget:\n type: gluetun\n url: http://gluetun.host.or.ip:port\nLearn more about Gotify.
Get a Gotify client token from an existing client or create a new one on your Gotify admin page.
Allowed fields: [\"apps\", \"clients\", \"messages\"].
widget:\n type: gotify\n url: http://gotify.host.or.ip\n key: clientoken\nLearn more about Grafana.
Allowed fields: [\"dashboards\", \"datasources\", \"totalalerts\", \"alertstriggered\"].
widget:\n type: grafana\n url: http://grafana.host.or.ip:port\n username: username\n password: password\nLearn more about HDHomerun.
Allowed fields: [\"channels\", \"hd\", \"tunerCount\", \"channelNumber\", \"channelNetwork\", \"signalStrength\", \"signalQuality\", \"symbolQuality\", \"networkRate\", \"clientIP\" ].
If more than 4 fields are provided, only the first 4 are displayed.
widget:\n type: hdhomerun\n url: http://hdhomerun.host.or.ip\n tuner: 0 # optional - defaults to 0, used for tuner-specific fields\n fields: [\"channels\", \"hd\"] # optional - default fields shown\nLearn more about Health Checks.
Specify a single check by including the uuid field or show the total 'up' and 'down' for all checks by leaving off the uuid field.
To use the Health Checks widget, you first need to generate an API key.
Allowed fields: [\"status\", \"last_ping\"] for single checks, [\"up\", \"down\"] for total stats.
widget:\n type: healthchecks\n url: http://healthchecks.host.or.ip:port\n key: <YOUR_API_KEY>\n uuid: <CHECK_UUID> # optional, if not included total statistics for all checks is shown\nLearn more about Home Assistant.
You will need to generate a long-lived access token for an existing Home Assistant user in its profile.
Allowed fields: [\"people_home\", \"lights_on\", \"switches_on\"].
Up to a maximum of four custom states and/or templates can be queried via the custom property like in the example below. The custom property will have no effect as long as the fields property is defined.
state will query the state of the specified entity_id\"{attributes.friendly_name}\"\"{state} {attributes.unit_of_measurement}\"template will query the specified template, see Home Assistant Templatingwidget:\n type: homeassistant\n url: http://homeassistant.host.or.ip:port\n key: access_token\n custom:\n - state: sensor.total_power\n - state: sensor.total_energy_today\n label: energy today\n - template: \"{{ states.switch|selectattr('state','equalto','on')|list|length }}\"\n label: switches on\n - state: weather.forecast_home\n label: wind speed\n value: \"{attributes.wind_speed} {attributes.wind_speed_unit}\"\nLearn more about Homebox.
Uses the same username and password used to login from the web.
The totalValue field will attempt to format using the currency you have configured in Homebox.
Allowed fields: [\"items\", \"totalWithWarranty\", \"locations\", \"labels\", \"users\", \"totalValue\"].
If more than 4 fields are provided, only the first 4 are displayed.
widget:\n type: homebox\n url: http://homebox.host.or.ip:port\n username: username\n password: password\n fields: [\"items\", \"locations\", \"totalValue\"] # optional - default fields shown\nLearn more about Homebridge.
The Homebridge API is actually provided by the Config UI X plugin that has been included with Homebridge for a while, still it is required to be installed for this widget to work.
Allowed fields: [\"updates\", \"child_bridges\"].
widget:\n type: homebridge\n url: http://homebridge.host.or.ip:port\n username: username\n password: password\nA basic iFrame widget to show external content, see the MDN docs for more details about some of the options.
Warning
Requests made via the iFrame widget are inherently not proxied as they are made from the browser itself.
"},{"location":"widgets/services/iframe/#basic-example","title":"Basic Example","text":"widget:\n type: iframe\n name: myIframe\n src: http://example.com\nwidget:\n type: iframe\n name: myIframe\n src: http://example.com\n classes: h-60 sm:h-60 md:h-60 lg:h-60 xl:h-60 2xl:h-72 # optional, use tailwind height classes, see https://tailwindcss.com/docs/height\n referrerPolicy: same-origin # optional, no default\n allowPolicy: autoplay; fullscreen; gamepad # optional, no default\n allowFullscreen: false # optional, default: true\n loadingStrategy: eager # optional, default: eager\n allowScrolling: no # optional, default: yes\n refreshInterval: 2000 # optional, no default\nLearn more about Immich.
Find your API key under Account Settings > API Keys.
Allowed fields: [\"users\" ,\"photos\", \"videos\", \"storage\"].
Note that API key must be from admin user.
widget:\n type: immich\n url: http://immich.host.or.ip\n key: adminapikeyadminapikeyadminapikey\nLearn more about Jackett.
If Jackett has an admin password set, you must set the password field for the widget to work.
Allowed fields: [\"configured\", \"errored\"].
widget:\n type: jackett\n url: http://jackett.host.or.ip\n password: jackettadminpassword # optional\nLearn more about JDownloader.
Basic widget to show number of items in download queue, along with the queue size and current download speed.
Allowed fields: [\"downloadCount\", \"downloadTotalBytes\",\"downloadBytesRemaining\", \"downloadSpeed\"].
widget:\n type: jdownloader\n username: JDownloader Username\n password: JDownloader Password\n client: Name of JDownloader Instance\nLearn more about Jellyfin.
You can create an API key from inside Jellyfin at Settings > Advanced > Api Keys.
As of v0.6.11 the widget supports fields [\"movies\", \"series\", \"episodes\", \"songs\"]. These blocks are disabled by default but can be enabled with the enableBlocks option, and the \"Now Playing\" feature (enabled by default) can be disabled with the enableNowPlaying option.
widget:\n type: jellyfin\n url: http://jellyfin.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\n enableBlocks: true # optional, defaults to false\n enableNowPlaying: true # optional, defaults to true\n enableUser: true # optional, defaults to false\n showEpisodeNumber: true # optional, defaults to false\n expandOneStreamToTwoRows: false # optional, defaults to true\nLearn more about Jellyseerr.
Find your API key under Settings > General > API Key.
Allowed fields: [\"pending\", \"approved\", \"available\"].
widget:\n type: jellyseerr\n url: http://jellyseerr.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\nLearn more about Kavita.
Uses the same admin role username and password used to login from the web.
Allowed fields: [\"seriesCount\", \"totalFiles\"].
widget:\n type: kavita\n url: http://kavita.host.or.ip:port\n username: username\n password: password\nLearn more about Komga.
Uses the same username and password used to login from the web.
Allowed fields: [\"libraries\", \"series\", \"books\"].
widget:\n type: komga\n url: http://komga.host.or.ip:port\n username: username\n password: password\nLearn more about Kopia.
Allowed fields: [\"status\", \"size\", \"lastrun\", \"nextrun\"].
You may optionally pass values for snapshotHost and / or snapshotPath to select a specific backup source for the widget.
widget:\n type: kopia\n url: http://kopia.host.or.ip:port\n username: username\n password: password\n snapshotHost: hostname # optional\n snapshotPath: path # optional\nLearn more about Lidarr.
Find your API key under Settings > General.
Allowed fields: [\"wanted\", \"queued\", \"artists\"].
widget:\n type: lidarr\n url: http://lidarr.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\nLearn more about Mastodon.
Use the base URL of the Mastodon instance you'd like to pull stats for. Does not require authentication as the stats are part of the public API endpoints.
Allowed fields: [\"user_count\", \"status_count\", \"domain_count\"].
widget:\n type: mastodon\n url: https://mastodon.host.name\nLearn more about Mealie.
Generate a user API key under Profile > Manage Your API Tokens > Generate.
Allowed fields: [\"recipes\", \"users\", \"categories\", \"tags\"].
widget:\n type: mealie\n url: http://mealie-frontend.host.or.ip\n key: mealieapitoken\nLearn more about Medusa.
Allowed fields: [\"wanted\", \"queued\", \"series\"].
widget:\n type: medusa\n url: http://medusa.host.or.ip:port\n key: medusaapikeyapikeyapikeyapikeyapikey\nHTTPS may be required, per the documentation
Allowed fields: [\"uptime\", \"cpuLoad\", \"memoryUsed\", \"numberOfLeases\"].
widget:\n type: mikrotik\n url: https://mikrotik.host.or.ip\n username: username\n password: password\nAllowed fields: [\"players\", \"version\", \"status\"].
widget:\n type: minecraft\n url: udp://minecraftserveripordomain:port\nLearn more about Miniflux.
Api key is found under Settings > API keys
Allowed fields: [\"unread\", \"read\"].
widget:\n type: miniflux\n url: http://miniflux.host.or.ip:port\n key: minifluxapikey\nPass the stream URL from a service like \u00b5Streamer or camera-streamer.
widget:\n type: mjpeg\n stream: http://mjpeg.host.or.ip/webcam/stream\nLearn more about Moonraker.
Allowed fields: [\"printer_state\", \"print_status\", \"print_progress\", \"layers\"].
widget:\n type: moonraker\n url: http://moonraker.host.or.ip:port\nIf your moonraker instance has an active authorization and your homepage ip isn't whitelisted you need to add your api key (Authorization Documentation).
widget:\n type: moonraker\n url: http://moonraker.host.or.ip:port\n key: api_keymoonraker\nLearn more about Mylar3.
API must be enabled in Mylar3 settings.
Allowed fields: [\"series\", \"issues\", \"wanted\"].
widget:\n type: mylar\n url: http://mylar3.host.or.ip:port\n key: yourmylar3apikey\nLearn more about Navidrome.
For detailed information about how to generate the token see http://www.subsonic.org/pages/api.jsp.
Allowed fields: no configurable fields for this widget.
widget:\n type: navidrome\n url: http://navidrome.host.or.ip:port\n user: username\n token: token #md5(password + salt)\n salt: randomsalt\nLearn more about NetAlertX.
Note that the project was renamed from PiAlert to NetAlertX.
Allowed fields: [\"total\", \"connected\", \"new_devices\", \"down_alerts\"].
widget:\n type: netalertx\n url: http://ip:port\nLearn more about Netdata.
Allowed fields: [\"warnings\", \"criticals\"].
widget:\n type: netdata\n url: http://netdata.host.or.ip\nLearn more about Nextcloud.
Use username & password, or the NC-Token key. Information about the token can be found under Settings > System. If both are provided, NC-Token will be used.
Allowed fields: [\"cpuload\", \"memoryusage\", \"freespace\", \"activeusers\", \"numfiles\", \"numshares\"].
Note \"cpuload\" and \"memoryusage\" were deprecated in v0.6.18 and a maximum of 4 fields can be displayed.
widget:\n type: nextcloud\n url: https://nextcloud.host.or.ip:port\n key: token\nwidget:\n type: nextcloud\n url: https://nextcloud.host.or.ip:port\n username: username\n password: password\nLearn more about NextDNS.
Api key is found under Account > API, profile ID is found under Setup > Endpoints > ID
widget:\n type: nextdns\n profile: profileid\n key: yourapikeyhere\nLearn more about Nginx Proxy Manager.
Login with the same admin username and password used to access the web UI.
Allowed fields: [\"enabled\", \"disabled\", \"total\"].
widget:\n type: npm\n url: http://npm.host.or.ip\n username: admin_username\n password: admin_password\nLearn more about NZBget.
This widget uses the same authentication method as your browser when logging in (HTTP Basic Auth), and is often referred to as the ControlUsername and ControlPassword inside of Nzbget documentation.
Allowed fields: [\"rate\", \"remaining\", \"downloaded\"].
widget:\n type: nzbget\n url: http://nzbget.host.or.ip\n username: controlusername\n password: controlpassword\nLearn more about OctoPrint.
Allowed fields: [\"printer_state\", \"temp_tool\", \"temp_bed\", \"job_completion\"].
widget:\n type: octoprint\n url: http://octoprint.host.or.ip:port\n key: youroctoprintapikey\nThe widget supports controller versions 3, 4 and 5.
Allowed fields: [\"connectedAp\", \"activeUser\", \"alerts\", \"connectedGateways\", \"connectedSwitches\"].
widget:\n type: omada\n url: http://omada.host.or.ip:port\n username: username\n password: password\n site: sitename\nLearn more about Ombi.
Find your API key under Settings > Configuration > General.
Allowed fields: [\"pending\", \"approved\", \"available\"].
widget:\n type: ombi\n url: http://ombi.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\nLearn more about OpenDTU.
Allowed fields: [\"yieldDay\", \"relativePower\", \"absolutePower\", \"limit\"].
widget:\n type: opendtu\n url: http://opendtu.host.or.ip\nLearn more about OpenMediaVault.
Provides useful information from your OpenMediaVault
widget:\n type: openmediavault\n url: http://omv.host.or.ip\n username: admin\n password: pass\n method: services.getStatus # required\nThe method field determines the type of data to be displayed and is required. Supported methods:
services.getStatus: Shows status of running services. Allowed fields: [\"running\", \"stopped\", \"total\"]
smart.getListBg: Shows S.M.A.R.T. status from disks. Allowed fields: [\"passed\", \"failed\"]
downloader.getDownloadList: Displays the number of tasks from the Downloader plugin currently being downloaded and total. Allowed fields: [\"downloading\", \"total\"]
Learn more about OpenWRT.
Provides information from OpenWRT
widget:\n type: openwrt\n url: http://host.or.ip\n username: homepage\n password: pass\n interfaceName: eth0 # optional\nSetting interfaceName (e.g. eth0) will display information for that particular device, otherwise the widget will display general system info.
In order for homepage to access the OpenWRT RPC endpoints you will need to create an ACL and new user in OpenWRT.
Create an ACL named homepage.json in /usr/share/rpcd/acl.d/, the following permissions will suffice:
{\n \"homepage\": {\n \"description\": \"Homepage widget\",\n \"read\": {\n \"ubus\": {\n \"network.interface.wan\": [\"status\"],\n \"network.interface.lan\": [\"status\"],\n \"network.device\": [\"status\"],\n \"system\": [\"info\"]\n }\n }\n }\n}\nCreate a crypt(5) password hash using the following command in the OpenWRT shell:
uhttpd -m \"<somepassphrase>\"\nThen add a user that will use the ACL and hashed password in /etc/config/rpcd:
config login\n option username 'homepage'\n option password '<hashedpassword>'\n list read homepage\nThis username and password will be used in Homepage's services.yaml to grant access.
"},{"location":"widgets/services/opnsense/","title":"OPNSense","text":"Learn more about OPNSense.
The API key & secret can be generated via the webui by creating a new user at System/Access/Users. Ensure \"Generate a scrambled password to prevent local database logins for this user\" is checked and then edit the effective privileges selecting only:
Finally, create a new API key which will download an apikey.txt file with your key and secret in it. Use the values as the username and password fields, respectively, in your homepage config.
Allowed fields: [\"cpu\", \"memory\", \"wanUpload\", \"wanDownload\"].
widget:\n type: opnsense\n url: http://opnsense.host.or.ip\n username: key\n password: secret\nLearn more about Overseerr.
Find your API key under Settings > General.
Allowed fields: [\"pending\", \"approved\", \"available\", \"processing\"].
widget:\n type: overseerr\n url: http://overseerr.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\nLearn more about Paperless-ngx.
Use username & password, or the token key. Information about the token can be found in the Paperless-ngx API documentation. If both are provided, the token will be used.
Allowed fields: [\"total\", \"inbox\"].
widget:\n type: paperlessngx\n url: http://paperlessngx.host.or.ip:port\n username: username\n password: password\nwidget:\n type: paperlessngx\n url: http://paperlessngx.host.or.ip:port\n key: token\nLearn more about PeaNUT.
This widget adds support for Network UPS Tools via a third party tool, PeaNUT.
The default ups name is ups. To configure more than one ups, you must create multiple peanut services.
Allowed fields: [\"battery_charge\", \"ups_load\", \"ups_status\"].
Note
This widget requires an additional tool, PeaNUT, as noted. Other projects exist to achieve similar results using a customapi widget, for example NUTCase.
widget:\n type: peanut\n url: http://peanut.host.or.ip:port\n key: nameofyourups\nLearn more about pfSense.
This widget requires the installation of the pfsense-api which is a 3rd party package for pfSense routers.
Once pfSense API is installed, you can set the API to be read-only in System > API > Settings.
There are two currently supported authentication modes: 'Local Database' and 'API Token'. For 'Local Database', use username and password with the credentials of an admin user. For 'API Token', utilize the headers parameter with client_token and client_id obtained from pfSense as shown below. Do not use both headers and username / password.
The interface to monitor is defined by updating the wan parameter. It should be referenced as it is shown under Interfaces > Assignments in pfSense.
Load is returned instead of cpu utilization. This is a limitation in the pfSense API due to the complexity of this calculation. This may become available in future versions.
Allowed fields: [\"load\", \"memory\", \"temp\", \"wanStatus\", \"wanIP\", \"disk\"] (maximum of 4)
widget:\n type: pfsense\n url: http://pfsense.host.or.ip:port\n username: user # optional, or API token\n password: pass # optional, or API token\n headers: # optional, or username/password\n Authorization: client_id client_token\n wan: igb0\n fields: [\"load\", \"memory\", \"temp\", \"wanStatus\"] # optional\nLearn more about PhotoPrism..
Allowed fields: [\"albums\", \"photos\", \"videos\", \"people\"].
widget:\n type: photoprism\n url: http://photoprism.host.or.ip:port\n username: admin\n password: password\nLearn more about PiHole.
As of v2022.12 PiHole requires the use of an API key if an admin password is set. Older versions do not require any authentication even if the admin uses a password.
Allowed fields: [\"queries\", \"blocked\", \"blocked_percent\", \"gravity\"].
Note: by default the \"blocked\" and \"blocked_percent\" fields are merged e.g. \"1,234 (15%)\" but explicitly including the \"blocked_percent\" field will change them to display separately.
widget:\n type: pihole\n url: http://pi.hole.or.ip\n version: 6 # required if running v6 or higher, defaults to 5\n key: yourpiholeapikey # optional\nAdded in v0.1.0, updated in v0.8.9
"},{"location":"widgets/services/plantit/","title":"Plant-it","text":"Learn more about Plantit.
API key can be created from the REST API.
Allowed fields: [\"events\", \"plants\", \"photos\", \"species\"].
widget:\n type: plantit\n url: http://plant-it.host.or.ip:port # api port\n key: plantit-api-key\nLearn more about Tautulli.
Provides detailed information about currently active streams. You can find the API key from inside Tautulli at Settings > Web Interface > API.
Allowed fields: no configurable fields for this widget.
widget:\n type: tautulli\n url: http://tautulli.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\n enableUser: true # optional, defaults to false\n showEpisodeNumber: true # optional, defaults to false\n expandOneStreamToTwoRows: false # optional, defaults to true\nLearn more about Plex.
The core Plex API is somewhat limited but basic info regarding library sizes and the number of active streams is supported. For more detailed info regarding active streams see the Plex Tautulli widget.
Allowed fields: [\"streams\", \"albums\", \"movies\", \"tv\"].
widget:\n type: plex\n url: http://plex.host.or.ip:32400\n key: mytokenhere # see https://www.plexopedia.com/plex-media-server/general/plex-token/\nLearn more about Portainer.
You'll need to make sure you have the correct environment set for the integration to work properly. From the Environments section inside of Portainer, click the one you'd like to connect to and observe the ID at the end of the URL (should be), something like #!/endpoints/1, here 1 is the value to set as the env value. In order to generate an API key, please follow the steps outlined here https://docs.portainer.io/api/access.
Allowed fields: [\"running\", \"stopped\", \"total\"].
widget:\n type: portainer\n url: https://portainer.host.or.ip:9443\n env: 1\n key: ptr_accesskeyaccesskeyaccesskeyaccesskey\nLearn more about Prometheus.
Allowed fields: [\"targets_up\", \"targets_down\", \"targets_total\"].
widget:\n type: prometheus\n url: http://prometheushost:port\nLearn more about Prowlarr.
Find your API key under Settings > General.
Allowed fields: [\"numberOfGrabs\", \"numberOfQueries\", \"numberOfFailGrabs\", \"numberOfFailQueries\"].
widget:\n type: prowlarr\n url: http://prowlarr.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\nLearn more about Proxmox.
This widget shows the running and total counts of both QEMU VMs and LX Containers in the Proxmox cluster. It also shows the CPU and memory usage of the first node in the cluster.
You will need to generate an API Token for new or an existing user. Here is an example of how to do this for a new user.
apihomepageUse username@pam!Token ID as the username (e.g api@pam!homepage) setting and Secret as the password setting.
Allowed fields: [\"vms\", \"lxc\", \"resources.cpu\", \"resources.mem\"].
You can set the optional node setting when you want to show metrics for a single node. By default it will show the average for the complete cluster.
widget:\n type: proxmox\n url: https://proxmox.host.or.ip:8006\n username: api_token_id\n password: api_token_secret\n node: pve-1 # optional\nLearn more about Proxmox Backup Server.
Allowed fields: [\"datastore_usage\", \"failed_tasks_24h\", \"cpu_usage\", \"memory_usage\"].
widget:\n type: proxmoxbackupserver\n url: https://proxmoxbackupserver.host:port\n username: api_token_id\n password: api_token_secret\nLearn more about Pterodactyl.
Allowed fields: [\"nodes\", \"servers\"].
widget:\n type: pterodactyl\n url: http://pterodactylhost:port\n key: pterodactylapikey\nLearn more about Pyload.
Allowed fields: [\"speed\", \"active\", \"queue\", \"total\"].
widget:\n type: pyload\n url: http://pyload.host.or.ip:port\n username: username\n password: password # only needed if set\nLearn more about qBittorrent.
Uses the same username and password used to login from the web.
Allowed fields: [\"leech\", \"download\", \"seed\", \"upload\"].
widget:\n type: qbittorrent\n url: http://qbittorrent.host.or.ip\n username: username\n password: password\nLearn more about QNAP.
Allowed fields: [\"cpuUsage\", \"memUsage\", \"systemTempC\", \"poolUsage\", \"volumeUsage\"].
widget:\n type: qnap\n url: http://qnap.host.or.ip:port\n username: user\n password: pass\nIf the QNAP device has multiple volumes, the poolUsage will be a sum of all volumes.
If only a single volume needs to be tracked, add the following to your configuration and the Widget will track this as volumeUsage:
volume: Volume Name From QNAP\nLearn more about Radarr.
Find your API key under Settings > General.
Allowed fields: [\"wanted\", \"missing\", \"queued\", \"movies\"].
A detailed queue listing is disabled by default, but can be enabled with the enableQueue option.
widget:\n type: radarr\n url: http://radarr.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\n enableQueue: true # optional, defaults to false\nLearn more about Readarr.
Find your API key under Settings > General.
Allowed fields: [\"wanted\", \"queued\", \"books\"].
widget:\n type: readarr\n url: http://readarr.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\nAllowed fields: [\"platforms\", \"totalRoms\"].
widget:\n type: romm\n url: http://romm.host.or.ip\n username: username # optional\n password: password # optional\nLearn more about ruTorrent.
This requires the httprpc plugin to be installed and enabled, and is part of the default ruTorrent plugins. If you have not explicitly removed or disable this plugin, it should be available.
Allowed fields: [\"active\", \"upload\", \"download\"].
widget:\n type: rutorrent\n url: http://rutorrent.host.or.ip\n username: username # optional, false if not used\n password: password # optional, false if not used\nLearn more about SABnzbd.
Find your API key under Config > General.
Allowed fields: [\"rate\", \"queue\", \"timeleft\"].
widget:\n type: sabnzbd\n url: http://sabnzbd.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\nLearn more about Scrutiny.
Allowed fields: [\"passed\", \"failed\", \"unknown\"].
widget:\n type: scrutiny\n url: http://scrutiny.host.or.ip\nLearn more about Sonarr.
Find your API key under Settings > General.
Allowed fields: [\"wanted\", \"queued\", \"series\"].
A detailed queue listing is disabled by default, but can be enabled with the enableQueue option.
widget:\n type: sonarr\n url: http://sonarr.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\n enableQueue: true # optional, defaults to false\nLearn more about Speedtest Tracker. or Speedtest Tracker
No extra configuration is required.
This widget is compatible with both alexjustesen/speedtest-tracker and henrywhitaker3/Speedtest-Tracker.
Allowed fields: [\"download\", \"upload\", \"ping\"].
widget:\n type: speedtest\n url: http://speedtest.host.or.ip\n bitratePrecision: 3 # optional, default is 0\nLearn more about Stash.
Find your API key from inside Stash at Settings > Security > API Key. Note that the API key is only required if your Stash instance has login credentials.
Allowed fields: [\"scenes\", \"scenesPlayed\", \"playCount\", \"playDuration\", \"sceneSize\", \"sceneDuration\", \"images\", \"imageSize\", \"galleries\", \"performers\", \"studios\", \"movies\", \"tags\", \"oCount\"].
If more than 4 fields are provided, only the first 4 are displayed.
widget:\n type: stash\n url: http://stash.host.or.ip\n key: stashapikey\n fields: [\"scenes\", \"images\"] # optional - default fields shown\nLearn more about SWAG Dashboard.
Allowed fields: [\"proxied\", \"auth\", \"outdated\", \"banned\"].
widget:\n type: swagdashboard\n url: http://swagdashboard.host.or.ip:adminport # default port is 81\nLearn more about Syncthing Relay Server.
Pulls stats from the relay server. See here for more information on configuration.
Allowed fields: [\"numActiveSessions\", \"numConnections\", \"bytesProxied\"].
widget:\n type: strelaysrv\n url: http://syncthing.host.or.ip:22070\nLearn more about Tailscale.
You will need to generate an API access token from the keys page on the Tailscale dashboard.
To find your device ID, go to the machine overview page and select your machine. In the \"Machine Details\" section, copy your ID. It will end with CNTRL.
Allowed fields: [\"address\", \"last_seen\", \"expires\"].
widget:\n type: tailscale\n deviceid: deviceid\n key: tailscalekey\nGenerate a user API key under Settings > API > Generate. For the token's scope, use read.
Allowed fields: [\"users\", \"recipes\", \"keywords\"].
widget:\n type: tandoor\n url: http://tandoor-frontend.host.or.ip\n key: tandoor-api-token\nLearn more about Tdarr.
Allowed fields: [\"queue\", \"processed\", \"errored\", \"saved\"].
widget:\n type: tdarr\n url: http://tdarr.host.or.ip\nLearn more about Traefik.
No extra configuration is required. If your traefik install requires authentication, include the username and password used to login to the web interface.
Allowed fields: [\"routers\", \"services\", \"middleware\"].
widget:\n type: traefik\n url: http://traefik.host.or.ip\n username: username # optional\n password: password # optional\nLearn more about Transmission.
Uses the same username and password used to login from the web.
Allowed fields: [\"leech\", \"download\", \"seed\", \"upload\"].
widget:\n type: transmission\n url: http://transmission.host.or.ip\n username: username\n password: password\n rpcUrl: /transmission/ # Optional. Matches the value of \"rpc-url\" in your Transmission's settings.json file\nLearn more about TrueNas.
Allowed fields: [\"load\", \"uptime\", \"alerts\"].
To create an API Key, follow the official TrueNAS documentation.
A detailed pool listing is disabled by default, but can be enabled with the enablePools option.
To use the enablePools option with TrueNAS Core, the nasType parameter is required.
widget:\n type: truenas\n url: http://truenas.host.or.ip\n username: user # not required if using api key\n password: pass # not required if using api key\n key: yourtruenasapikey # not required if using username / password\n enablePools: true # optional, defaults to false\n nasType: scale # defaults to scale, must be set to 'core' if using enablePools with TrueNAS Core\nLearn more about Tube Archivist.
Requires API key.
Allowed fields: [\"downloads\", \"videos\", \"channels\", \"playlists\"].
widget:\n type: tubearchivist\n url: http://tubearchivist.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\nLearn more about Unifi Controller.
(Find the Unifi Controller information widget here)
You can display general connectivity status from your Unifi (Network) Controller. When authenticating you will want to use an account that has at least read privileges.
An optional 'site' parameter can be supplied, if it is not the widget will use the default site for the controller.
Allowed fields: [\"uptime\", \"wan\", \"lan\", \"lan_users\", \"lan_devices\", \"wlan\", \"wlan_users\", \"wlan_devices\"] (maximum of four).
Note that fields unsupported by the unifi device will not be shown.
widget:\n type: unifi\n url: https://unifi.host.or.ip:port\n username: username\n password: password\n site: Site Name # optional\nAdded in v0.4.18, updated in 0.6.7
"},{"location":"widgets/services/unmanic/","title":"Unmanic","text":"Learn more about Unmanic.
Allowed fields: [\"active_workers\", \"total_workers\", \"records_total\"].
widget:\n type: unmanic\n url: http://unmanic.host.or.ip:port\nLearn more about Uptime Kuma.
As Uptime Kuma does not yet have a full API the widget uses data from a single \"status page\". As such you will need a status page setup with a group of monitored sites, which is where you get the slug (the url without the /status/ portion). E.g. if your status page is URL http://uptimekuma.host/status/statuspageslug, insert slug: statuspageslug.
Allowed fields: [\"up\", \"down\", \"uptime\", \"incident\"].
widget:\n type: uptimekuma\n url: http://uptimekuma.host.or.ip:port\n slug: statuspageslug\nLearn more about UptimeRobot.
To generate an API key, select My Settings, and either Monitor-Specific API Key or Read-Only API Key.
A Monitor-Specific API Key will provide the following detailed information for the selected monitor:
Allowed fields: [\"status\", \"uptime\", \"lastDown\", \"downDuration\"].
A Read-Only API Key will provide a summary of all monitors in your account:
Allowed fields: [\"sitesUp\", \"sitesDown\"].
widget:\n type: uptimerobot\n url: https://api.uptimerobot.com\n key: uptimerobotapitoken\nLearn more about UrBackup.
The UrBackup widget retrieves the total number of clients that currently have no errors, have errors, or haven't backed up recently. Clients are considered \"Errored\" or \"Out of Date\" if either the file or image backups for that client have errors/are out of date, unless the client does not support image backups.
The default number of days that can elapse before a client is marked Out of Date is 3, but this value can be customized by setting the maxDays value in the config.
Optionally, the widget can also report the total amount of disk space consumed by backups. This is disabled by default, because it requires a second API call.
Note: client status is only shown for backups that the specified user has access to. Disk Usage shown is the total for all backups, regardless of permissions.
Allowed fields: [\"ok\", \"errored\", \"noRecent\", \"totalUsed\"]. Note that totalUsed will not be shown unless explicitly included in fields.
widget:\n type: urbackup\n username: urbackupUsername\n password: urbackupPassword\n url: http://urbackupUrl:55414\n maxDays: 5 # optional\nLearn more about Watchtower.
To use this widget, Watchtower needs to be configured to to enable metrics.
Allowed fields: [\"containers_scanned\", \"containers_updated\", \"containers_failed\"].
widget:\n type: watchtower\n url: http://your-ip-address:8080\n key: demotoken\nLearn more about Wg-Easy.
Allowed fields: [\"connected\", \"enabled\", \"disabled\", \"total\"].
Note: by default [\"connected\", \"enabled\", \"total\"] are displayed.
To detect if a device is connected the time since the last handshake is queried. threshold is the time to wait in minutes since the last handshake to consider a device connected. Default is 2 minutes.
widget:\n type: wgeasy\n url: http://wg.easy.or.ip\n password: yourwgeasypassword\n threshold: 2 # optional\nLearn more about What's Up Docker.
Allowed fields: [\"monitoring\", \"updates\"].
widget:\n type: whatsupdocker\n url: http://whatsupdocker:port\n username: username # optional\n password: password # optional\nLearn more about Xteve.
Allowed fields: [\"streams_all\", \"streams_active\", \"streams_xepg\"].
widget:\n type: xteve\n url: http://xteve.host.or.ip\n username: username # optional\n password: password # optional\n