{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"],"fields":{"title":{"boost":1000.0},"text":{"boost":1.0},"tags":{"boost":1000000.0}}},"docs":[{"location":"","title":"Home","text":"

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.

\u00a0 Install on Docker

\u00a0 Install on Kubernetes

\u00a0 Install on UNRAID

\u00a0 Building from source

"},{"location":"configs/bookmarks/","title":"Bookmarks","text":"

Bookmarks 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.

- Developer:\n- Github:\n- abbr: GH\nhref: https://github.com/\n- Social:\n- Reddit:\n- icon: reddit.png\nhref: https://reddit.com/\n- Entertainment:\n- YouTube:\n- abbr: YT\nhref: https://youtube.com/\n

"},{"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:\nid: myserviceid\nicon: icon.png\n...\n
"},{"location":"configs/docker/","title":"Docker","text":"

Docker 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:\nhost: 192.168.0.101\nport: 2375\n
"},{"location":"configs/docker/#using-docker-tls","title":"Using Docker TLS","text":"

Since 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:\nhost: 192.168.0.101\nport: 275\ntls:\nkeyFile: tls/key.pem\ncaFile: tls/ca.pem\ncertFile: tls/cert.pem\n
"},{"location":"configs/docker/#using-docker-socket-proxy","title":"Using Docker Socket Proxy","text":"

Due 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:\nimage: ghcr.io/tecnativa/docker-socket-proxy:latest\ncontainer_name: dockerproxy\nenvironment:\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)\nports:\n- 127.0.0.1:2375:2375\nvolumes:\n- /var/run/docker.sock:/var/run/docker.sock:ro # Mounted as read-only\nrestart: unless-stopped\nhomepage:\nimage: ghcr.io/benphelps/homepage:latest\ncontainer_name: homepage\nvolumes:\n- /path/to/config:/app/config\nports:\n- 3000:3000\nrestart: unless-stopped\n

Then, inside of your docker.yaml settings file, you'd configure the docker instance like so:

my-docker:\nhost: dockerproxy\nport: 2375\n
"},{"location":"configs/docker/#using-socket-directly","title":"Using Socket Directly","text":"

If you'd rather use the socket directly, first make sure that you're passing the local socket into the Docker container.

Note that in order to use the socket directly homepage must be running as root

homepage:\nimage: ghcr.io/benphelps/homepage:latest\ncontainer_name: homepage\nvolumes:\n- /path/to/config:/app/config\n- /var/run/docker.sock:/var/run/docker.sock # pass local proxy\nports:\n- 3000:3000\nrestart: unless-stopped\n

If 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:\nsocket: /var/run/docker.sock\n
"},{"location":"configs/docker/#services","title":"Services","text":"

Once 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:\nicon: emby.png\nhref: \"http://emby.home/\"\ndescription: Media server\nserver: my-docker # The docker server that was configured\ncontainer: emby # The name of the container you'd like to connect\n
"},{"location":"configs/docker/#automatic-service-discovery","title":"Automatic Service Discovery","text":"

Homepage 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:\nemby:\nimage: lscr.io/linuxserver/emby:latest\ncontainer_name: emby\nports:\n- 8096:8096\nrestart: unless-stopped\nlabels:\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

When 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\n
"},{"location":"configs/docker/#docker-swarm","title":"Docker Swarm","text":"

Docker 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:\nsocket: /var/run/docker.sock\nswarm: true\n

For 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.

....\ndeploy:\nplacement:\nconstraints:\n- node.role == manager\n...\n

In 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:

....\ndeploy:\nlabels:\n- homepage.icon=foobar\n...\n
"},{"location":"configs/docker/#ordering","title":"Ordering","text":"

As of v0.6.4 discovered services can include an optional weight field to determine sorting such that:

"},{"location":"configs/docker/#show-stats","title":"Show stats","text":"

You can show the docker stats by clicking the status indicator but this can also be controlled per-service with:

- Example Service:\n...\nshowStats: true\n

Also 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\n
"},{"location":"configs/kubernetes/#services","title":"Services","text":"

Once 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:\nicon: emby.png\nhref: \"http://emby.home/\"\ndescription: Media server\nnamespace: media # The kubernetes namespace the app resides in\napp: emby # The name of the deployed app\n

The 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 podSelector 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:\nicon: matrix-light.png\nhref: https://chat.example.com\ndescription: Matrix Synapse Powered Chat\napp: matrix-element\nnamespace: comms\npodSelector: >-\napp.kubernetes.io/instance in (\nmatrix-element,\nmatrix-media-repo,\nmatrix-media-repo-postgresql,\nmatrix-synapse\n)\n

NOTE: A blank string as a podSelector 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:\nname: emby\nannotations:\ngethomepage.dev/enabled: \"true\"\ngethomepage.dev/description: Media Server\ngethomepage.dev/group: Media\ngethomepage.dev/icon: emby.png\ngethomepage.dev/name: Emby\ngethomepage.dev/widget.type: \"emby\"\ngethomepage.dev/widget.url: \"https://emby.example.com\"\ngethomepage.dev/podSelector: \"\"\ngethomepage.dev/weight: 10 # optional\nspec:\nrules:\n- host: emby.example.com\nhttp:\npaths:\n- backend:\nservice:\nname: emby\nport:\nnumber: 8080\npath: /\npathType: Prefix\n

When 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.

"},{"location":"configs/kubernetes/#traefik-ingressroute-support","title":"Traefik IngressRoute support","text":"

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:\nname: emby\nannotations:\ngethomepage.dev/href: \"https://emby.example.com\"\ngethomepage.dev/enabled: \"true\"\ngethomepage.dev/description: Media Server\ngethomepage.dev/group: Media\ngethomepage.dev/icon: emby.png\ngethomepage.dev/name: Emby\ngethomepage.dev/widget.type: \"emby\"\ngethomepage.dev/widget.url: \"https://emby.example.com\"\ngethomepage.dev/podSelector: \"\"\ngethomepage.dev/weight: 10 # optional\nspec:\nentryPoints:\n- websecure\nroutes:\n- kind: Rule\nmatch: Host(`emby.example.com`)\nservices:\n- kind: Service\nname: emby\nnamespace: emby\nport: 8080\nscheme: http\nstrategy: RoundRobin\nweight: 10\n

If the href attribute is not present, Homepage will ignore the specific IngressRoute.

"},{"location":"configs/kubernetes/#caveats","title":"Caveats","text":"

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.

"},{"location":"configs/services/","title":"Services","text":"

Services are configured inside the services.yaml file. You can have any number of groups, and any number of services per group.

"},{"location":"configs/services/#groups","title":"Groups","text":"

Groups are defined as top-level array entries.

- Group A:\n- Service A:\nhref: http://localhost/\n- Group B:\n- Service B:\nhref: http://localhost/\n

"},{"location":"configs/services/#services","title":"Services","text":"

Services are defined as array entries on groups,

- Group A:\n- Service A:\nhref: http://localhost/\n- Service B:\nhref: http://localhost/\n- Service C:\nhref: http://localhost/\n- Group B:\n- Service D:\nhref: http://localhost/\n

"},{"location":"configs/services/#descriptions","title":"Descriptions","text":"

Services may have descriptions,

- Group A:\n- Service A:\nhref: http://localhost/\ndescription: This is my service\n- Group B:\n- Service B:\nhref: http://localhost/\ndescription: This is another service\n

"},{"location":"configs/services/#icons","title":"Icons","text":"

Services 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.

Note: 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:\nicon: sonarr.png\nhref: http://sonarr.host/\ndescription: Series management\n- Group B:\n- Radarr:\nicon: radarr.png\nhref: http://radarr.host/\ndescription: Movie management\n- Group C:\n- Service:\nicon: mdi-flask-outline\nhref: http://service.host/\ndescription: My cool service\n

"},{"location":"configs/services/#ping","title":"Ping","text":"

Services may have an optional ping property that allows you to monitor the availability of an endpoint you chose and have the response time displayed. You do not need to set your ping URL equal to your href URL.

Note: the ping 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 ping feature correctly display status.

- Group A:\n- Sonarr:\nicon: sonarr.png\nhref: http://sonarr.host/\nping: http://sonarr.host/\n- Group B:\n- Radarr:\nicon: radarr.png\nhref: http://radarr.host/\nping: http://some.other.host/\n

"},{"location":"configs/services/#docker-integration","title":"Docker Integration","text":"

Services may be connected to a Docker container, either running on the local machine, or a remote machine.

- Group A:\n- Service A:\nhref: http://localhost/\ndescription: This is my service\nserver: my-server\ncontainer: my-container\n- Group B:\n- Service B:\nhref: http://localhost/\ndescription: This is another service\nserver: other-server\ncontainer: other-container\n

Clicking 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

"},{"location":"configs/services/#service-integrations","title":"Service Integrations","text":"

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 Service Widgets page.

Here is an example of a Radarr & Sonarr service, with their respective integrations.

- Group A:\n- Sonarr:\nicon: sonarr.png\nhref: http://sonarr.host/\ndescription: Series management\nwidget:\ntype: sonarr\nurl: http://sonarr.host\nkey: apikeyapikeyapikeyapikeyapikey\n- Group B:\n- Radarr:\nicon: radarr.png\nhref: http://radarr.host/\ndescription: Movie management\nwidget:\ntype: radarr\nurl: http://radarr.host\nkey: apikeyapikeyapikeyapikeyapikey\n

"},{"location":"configs/settings/","title":"Settings","text":"

The 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.

"},{"location":"configs/settings/#title","title":"Title","text":"

You can customize the title of the page if you'd like.

title: My Awesome Homepage\n
"},{"location":"configs/settings/#start-url","title":"Start URL","text":"

You can customize the start_url as required for installable apps. The default is \"/\".

startUrl: https://custom.url\n
"},{"location":"configs/settings/#background-image","title":"Background Image","text":"

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\n

Or you may pass the path to a local image relative to e.g. /app/public/images directory. Note: do not create a bind mount to the entire /app/public/ directory.

You will need to restart the container any time you add new images, this is a limitation of the Next.js static site server.

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\n

and then reference that image:

background: /images/background.png\n
"},{"location":"configs/settings/#background-opacity-filters","title":"Background Opacity & Filters","text":"

You 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:\nimage: /images/background.png\nblur: sm # sm, \"\", md, xl... see https://tailwindcss.com/docs/backdrop-blur\nsaturate: 50 # 0, 50, 100... see https://tailwindcss.com/docs/backdrop-saturate\nbrightness: 50 # 0, 50, 75... see https://tailwindcss.com/docs/backdrop-brightness\nopacity: 50 # 0-100\n
"},{"location":"configs/settings/#card-background-blur","title":"Card Background Blur","text":"

You can apply a blur filter to the service & bookmark cards. Note this option is incompatible with the backround blur, saturate and brightness filters.

cardBlur: sm # sm, \"\", md, etc... see https://tailwindcss.com/docs/backdrop-blur\n
"},{"location":"configs/settings/#favicon","title":"Favicon","text":"

If 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\n

Or 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.

"},{"location":"configs/settings/#theme","title":"Theme","text":"

You can configure a fixed them (and disable the theme switcher) by passing the theme option, like so:

theme: dark # or light\n
"},{"location":"configs/settings/#color-palette","title":"Color Palette","text":"

You can configured a fixed color palette (and disable the palette switcher) by passing the color option, like so:

color: slate\n

Supported colors are: slate, gray, zinc, neutral, stone, amber, yellow, lime, green, emerald, teal, cyan, sky, blue, indigo, violet, purple, fuchsia, pink, rose, red, white

"},{"location":"configs/settings/#layout","title":"Layout","text":"

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:\nMedia:\nstyle: row\ncolumns: 4\n

As 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:\nstyle: row\ncolumns: 3\n
"},{"location":"configs/settings/#headers","title":"Headers","text":"

You can hide headers for each section in the layout as well by passing header as false, like so:

layout:\nSection A:\nheader: false\nSection B:\nstyle: row\ncolumns: 3\nheader: false\n
"},{"location":"configs/settings/#category-icons","title":"Category Icons","text":"

You can also add an icon to a category under the layout setting similar to the options for service icons, e.g.

  Home Management & Info:\nicon: home-assistant.png\nServer Tools:\nicon: https://cdn-icons-png.flaticon.com/512/252/252035.png\n...\n
"},{"location":"configs/settings/#icon-style","title":"Icon Style","text":"

The 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\n
"},{"location":"configs/settings/#tabs","title":"Tabs","text":"

Version 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...\nBookmark Group on First Tab:\ntab: First\nFirst Service Group:\ntab: First\nstyle: row\ncolumns: 4\nSecond Service Group:\ntab: Second\ncolumns: 4\nThird Service Group:\ntab: Third\nstyle: row\nBookmark Group on Fourth Tab:\ntab: Fourth\nService Group on every Tab:\nstyle: row\ncolumns: 4\n
"},{"location":"configs/settings/#five-columns","title":"Five Columns","text":"

You can add a fifth column (when style: columns which is default) by adding:

fiveColumns: true\n

By default homepage will max out at 4 columns for column style

"},{"location":"configs/settings/#collapsible-sections","title":"Collapsible sections","text":"

You can disable the collapsible feature of services & bookmarks by adding:

disableCollapse: true\n

By default the feature is enabled.

"},{"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\n

headerStyle: boxed\n

headerStyle: clean\n

headerStyle: boxedWidgets\n
"},{"location":"configs/settings/#base-url","title":"Base URL","text":"

In 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\n

The 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\n

Currently 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\n

Use _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:\nhref: https://example.com/\n...\ntarget: _self\n
"},{"location":"configs/settings/#providers","title":"Providers","text":"

The 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:\nopenweathermap: openweathermapapikey\nweatherapi: weatherapiapikey\nlonghorn:\nurl: https://longhorn.example.com\nusername: admin\npassword: LonghornPassword\n

You can then pass provider instead of apiKey in your widget configuration.

- weather:\nlatitude: 50.449684\nlongitude: 30.525026\nprovider: weatherapi\n
"},{"location":"configs/settings/#quick-launch","title":"Quick Launch","text":"

You 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 doesnt have focus).

There are a few optional settings for the Quick Launch feature:

quicklaunch:\nsearchDescriptions: true\nhideInternetSearch: true\nhideVisitURL: true\n
"},{"location":"configs/settings/#homepage-version","title":"Homepage Version","text":"

By default the release version is displayed at the bottom of the page. To hide this, use the hideVersion setting, like so:

hideVersion: true\n
"},{"location":"configs/settings/#log-path","title":"Log Path","text":"

By 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\n
"},{"location":"configs/settings/#show-docker-stats","title":"Show Docker Stats","text":"

You can show all docker stats expanded in settings.yaml:

showStats: true\n

or per-service (services.yaml) with:

- Example Service:\n...\nshowStats: true\n

If you have both set the per-service settings take precedence.

"},{"location":"configs/settings/#hide-widget-error-messages","title":"Hide Widget Error Messages","text":"

Hide the visible API error messages either globally in settings.yaml:

hideErrors: true\n

or per service widget (services.yaml) with:

- Example Service:\n...\nwidget:\n...\nhideErrors: true\n

If either value is set to true, the errror 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.

Deploy with Docker

Deploy on Kubernetes

Deploy on UNRAID

Build from Source

"},{"location":"installation/docker/","title":"Docker Installation","text":"

Using docker compose:

version: \"3.3\"\nservices:\nhomepage:\nimage: ghcr.io/benphelps/homepage:latest\ncontainer_name: homepage\nports:\n- 3000:3000\nvolumes:\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\n
"},{"location":"installation/docker/#running-as-non-root","title":"Running as non-root","text":"

By 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:\nhomepage:\nimage: ghcr.io/benphelps/homepage:latest\ncontainer_name: homepage\nports:\n- 3000:3000\nvolumes:\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\nenvironment:\nPUID: $PUID\nPGID: $PGID\n
"},{"location":"installation/docker/#with-docker-run","title":"With Docker Run","text":"
docker run -p 3000:3000 -v /path/to/config:/app/config -v /var/run/docker.sock:/var/run/docker.sock ghcr.io/benphelps/homepage:latest\n
"},{"location":"installation/docker/#using-environment-secrets","title":"Using Environment Secrets","text":"

You can also include environment variables in your config files to protect sensitive information. Note:

"},{"location":"installation/k8s/","title":"Kubernetes Installation","text":""},{"location":"installation/k8s/#install-with-helm","title":"Install with Helm","text":"

There 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\n

The helm chart allows for all the configurations to be inlined directly in your values.yaml:

config:\nbookmarks:\n- Developer:\n- Github:\n- abbr: GH\nhref: https://github.com/\nservices:\n- My First Group:\n- My First Service:\nhref: http://localhost/\ndescription: Homepage is awesome\n- My Second Group:\n- My Second Service:\nhref: http://localhost/\ndescription: Homepage is the best\n- My Third Group:\n- My Third Service:\nhref: http://localhost/\ndescription: Homepage is \ud83d\ude0e\nwidgets:\n# show the kubernetes widget, with the cluster summary and individual nodes\n- kubernetes:\ncluster:\nshow: true\ncpu: true\nmemory: true\nshowLabel: true\nlabel: \"cluster\"\nnodes:\nshow: true\ncpu: true\nmemory: true\nshowLabel: true\n- search:\nprovider: duckduckgo\ntarget: _blank\nkubernetes:\nmode: cluster\nsettings:\n# The service account is necessary to allow discovery of other services\nserviceAccount:\ncreate: true\nname: homepage\n# This enables the service account to access the necessary resources\nenableRbac: true\ningress:\nmain:\nenabled: true\nannotations:\n# Example annotations to add Homepage to your Homepage!\ngethomepage.dev/enabled: \"true\"\ngethomepage.dev/name: \"Homepage\"\ngethomepage.dev/description: \"Dynamically Detected Homepage\"\ngethomepage.dev/group: \"Dynamic\"\ngethomepage.dev/icon: \"homepage.png\"\nhosts:\n- host: homepage.example.com\npaths:\n- path: /\npathType: Prefix\n
"},{"location":"installation/k8s/#install-with-kubernetes-manifests","title":"Install with Kubernetes Manifests","text":"

If 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:\nname: homepage\nnamespace: default\nlabels:\napp.kubernetes.io/name: homepage\nsecrets:\n- name: homepage\n
"},{"location":"installation/k8s/#secret","title":"Secret","text":"
apiVersion: v1\nkind: Secret\ntype: kubernetes.io/service-account-token\nmetadata:\nname: homepage\nnamespace: default\nlabels:\napp.kubernetes.io/name: homepage\nannotations:\nkubernetes.io/service-account.name: homepage\n
"},{"location":"installation/k8s/#configmap","title":"ConfigMap","text":"
apiVersion: v1\nkind: ConfigMap\nmetadata:\nname: homepage\nnamespace: default\nlabels:\napp.kubernetes.io/name: homepage\ndata:\nkubernetes.yaml: |\nmode: cluster\nsettings.yaml: \"\"\n#settings.yaml: |\n#  providers:\n#    longhorn:\n#      url: https://longhorn.my.network\ncustom.css: \"\"\ncustom.js: \"\"\nbookmarks.yaml: |\n- Developer:\n- Github:\n- abbr: GH\nhref: https://github.com/\nservices.yaml: |\n- My First Group:\n- My First Service:\nhref: http://localhost/\ndescription: Homepage is awesome\n- My Second Group:\n- My Second Service:\nhref: http://localhost/\ndescription: Homepage is the best\n- My Third Group:\n- My Third Service:\nhref: http://localhost/\ndescription: Homepage is \ud83d\ude0e\nwidgets.yaml: |\n- kubernetes:\ncluster:\nshow: true\ncpu: true\nmemory: true\nshowLabel: true\nlabel: \"cluster\"\nnodes:\nshow: true\ncpu: true\nmemory: true\nshowLabel: true\n- resources:\nbackend: resources\nexpanded: true\ncpu: true\nmemory: true\n- search:\nprovider: duckduckgo\ntarget: _blank\ndocker.yaml: \"\"\n
"},{"location":"installation/k8s/#clusterrole-and-clusterrolebinding","title":"ClusterRole and ClusterRoleBinding","text":"
apiVersion: rbac.authorization.k8s.io/v1\nkind: ClusterRole\nmetadata:\nname: homepage\nlabels:\napp.kubernetes.io/name: homepage\nrules:\n- apiGroups:\n- \"\"\nresources:\n- namespaces\n- pods\n- nodes\nverbs:\n- get\n- list\n- apiGroups:\n- extensions\n- networking.k8s.io\nresources:\n- ingresses\nverbs:\n- get\n- list\n- apiGroups:\n- traefik.containo.us\nresources:\n- ingressroutes\nverbs:\n- get\n- list\n- apiGroups:\n- metrics.k8s.io\nresources:\n- nodes\n- pods\nverbs:\n- get\n- list\n---\napiVersion: rbac.authorization.k8s.io/v1\nkind: ClusterRoleBinding\nmetadata:\nname: homepage\nlabels:\napp.kubernetes.io/name: homepage\nroleRef:\napiGroup: rbac.authorization.k8s.io\nkind: ClusterRole\nname: homepage\nsubjects:\n- kind: ServiceAccount\nname: homepage\nnamespace: default\n
"},{"location":"installation/k8s/#service","title":"Service","text":"
apiVersion: v1\nkind: Service\nmetadata:\nname: homepage\nnamespace: default\nlabels:\napp.kubernetes.io/name: homepage\nannotations:\nspec:\ntype: ClusterIP\nports:\n- port: 3000\ntargetPort: http\nprotocol: TCP\nname: http\nselector:\napp.kubernetes.io/name: homepage\n
"},{"location":"installation/k8s/#deployment","title":"Deployment","text":"
apiVersion: apps/v1\nkind: Deployment\nmetadata:\nname: homepage\nnamespace: default\nlabels:\napp.kubernetes.io/name: homepage\nspec:\nrevisionHistoryLimit: 3\nreplicas: 1\nstrategy:\ntype: RollingUpdate\nselector:\nmatchLabels:\napp.kubernetes.io/name: homepage\ntemplate:\nmetadata:\nlabels:\napp.kubernetes.io/name: homepage\nspec:\nserviceAccountName: homepage\nautomountServiceAccountToken: true\ndnsPolicy: ClusterFirst\nenableServiceLinks: true\ncontainers:\n- name: homepage\nimage: \"ghcr.io/benphelps/homepage:latest\"\nimagePullPolicy: Always\nports:\n- name: http\ncontainerPort: 3000\nprotocol: TCP\nvolumeMounts:\n- name: homepage-config\nmountPath: /app/config\n- name: logs\nmountPath: /app/config/logs\nvolumes:\n- name: homepage-config\nconfigMap:\nname: homepage\n- name: logs\nemptyDir: {}\n
"},{"location":"installation/k8s/#ingress","title":"Ingress","text":"
apiVersion: networking.k8s.io/v1\nkind: Ingress\nmetadata:\nname: homepage\nnamespace: default\nlabels:\napp.kubernetes.io/name: homepage\nannotations:\ngethomepage.dev/description: Dynamically Detected Homepage\ngethomepage.dev/enabled: \"true\"\ngethomepage.dev/group: Cluster Management\ngethomepage.dev/icon: homepage.png\ngethomepage.dev/name: Homepage\nspec:\nrules:\n- host: \"homepage.my.network\"\nhttp:\npaths:\n- path: \"/\"\npathType: Prefix\nbackend:\nservice:\nname: homepage\nport:\nnumber: 3000\n
"},{"location":"installation/source/","title":"Source Installation","text":"

First, clone the repository:

git clone https://github.com/benphelps/homepage.git\n

Then 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\n

If 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\n
"},{"location":"installation/unraid/","title":"UNRAID Installation","text":"

Homepage 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":""},{"location":"installation/unraid/#run-the-container","title":"Run the Container","text":"

You may need to set the permissions of the folders to be able to edit the files.

"},{"location":"installation/unraid/#some-other-notes","title":"Some Other Notes","text":""},{"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\n

Start the development server:

pnpm dev\n

Open 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\n
"},{"location":"more/development/#service-widget-guidelines","title":"Service Widget Guidelines","text":"

To ensure cohesiveness of various widgets, the following should be used as a guide for developing new widgets:

"},{"location":"more/translations/","title":"Translations","text":"

Homepage is developed in English, most other supported languages are provided via Google Translate. When a i18n key is not found, the fallback language is English.

"},{"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.

Everything can be done from a simple to use web interface here: https://hosted.weblate.org/projects/homepage/homepage/

When creating a new language, it can take 5 to 10 minutes before you'll see translatable strings added, but the process is automatic. Once the strings are added, you can then start translating them.

"},{"location":"more/troubleshooting/","title":"Troubleshooting","text":""},{"location":"more/troubleshooting/#general-troubleshooting-tips","title":"General Troubleshooting Tips","text":""},{"location":"more/troubleshooting/#service-widget-errors","title":"Service Widget Errors","text":"

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:

  1. Ensure that you follow the rule mentioned on https://gethomepage.dev/en/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.

  2. Verify the homepage installation can connect to the IP address or host you are using for the widget url. This is most simply achieved by pinging the server from the homepage machine, in Docker this means from inside the container itself, e.g.:

    docker exec homepage ping SERVICEIPORDOMAIN\n

    If your homepage install (container) cannot reach the service then you need to figure out why, for example in Docker this can mean putting the two containers on the same network, checking firewall issues, etc.

  3. If you have verified that homepage can in fact reach the service then you can also check the API output using e.g. curl, which is often helpful if you do need to file a bug report. Again, depending on your networking setup this may need to be run from inside the container as IP / hostname resolution can differ inside vs outside.

    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\n

    Or for AdGuard:

    curl -L -k -u 'username:password' http://ADGUARDIPORHOST/control/stats\n

    Or for Portainer:

    curl -L -k -H 'X-Api-Key:YOURKEY' 'https://PORTAINERIPORHOST:PORT/api/endpoints/2/docker/containers/json'\n

    Sonarr:

    curl -L -k 'http://SONARRIPORHOST:PORT/api/v3/queue?apikey=YOURAPIKEY'\n

    This will return some data which may reveal an issue causing a true bug in the service widget.

"},{"location":"more/troubleshooting/#missing-custom-icons","title":"Missing custom icons","text":"

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":"services/coin-market-cap/","title":"Coin Market Cap","text":"

Get your API key from your CoinMarketCap Pro Dashboard.

Allowed fields: no configurable fields for this widget.

widget:\ntype: coinmarketcap\ncurrency: GBP # Optional\nsymbols: [BTC, LTC, ETH]\nkey: apikeyapikeyapikeyapikeyapikey\n

You can also specify slugs instead of symbols (since symbols aren't garaunteed to be unique). If you supply both, slugs will be used. For example:

widget:\ntype: coinmarketcap\nslugs: [chia-network, uniswap]\nkey: apikeyapikeyapikeyapikeyapikey\n
"},{"location":"services/gotify/","title":"Gotify","text":"

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:\ntype: gotify\nurl: http://gotify.host.or.ip\nkey: clientoken\n
"},{"location":"services/healthchecks/","title":"Health checks","text":"

To use the Health Checks widget, you first need to generate an API key. To do this, follow these steps:

  1. Go to Settings in your check dashboard.
  2. Click on API key (read-only) and then click Create.
  3. Copy the API key that is generated for you.

Allowed fields: [\"status\", \"last_ping\"].

widget:\ntype: healthchecks\nurl: http://healthchecks.host.or.ip:port\nkey: <YOUR_API_KEY>\nuuid: <YOUR_CHECK_UUID>\n
"},{"location":"services/jellyfin/","title":"Jellyfin","text":"

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:\ntype: jellyfin\nurl: http://jellyfin.host.or.ip\nkey: apikeyapikeyapikeyapikeyapikey\nenableBlocks: true # optional, defaults to false\nenableNowPlaying: true # optional, defaults to true\n
"},{"location":"services/jellyseerr/","title":"Jellyseerr","text":"

Find your API key under Settings > General > API Key.

Allowed fields: [\"pending\", \"approved\", \"available\"].

widget:\ntype: jellyseerr\nurl: http://jellyseerr.host.or.ip\nkey: apikeyapikeyapikeyapikeyapikey\n
"},{"location":"services/mjpeg/","title":"MJPEG","text":"

Pass the stream URL from a service like \u00b5Streamer or camera-streamer.

widget:\ntype: mjpeg\nstream: http://mjpeg.host.or.ip/webcam/stream\n
"},{"location":"services/nginx-proxy-manager/","title":"Nginx Proxy Manager","text":"

Login with the same admin username and password used to access the web UI.

Allowed fields: [\"enabled\", \"disabled\", \"total\"].

widget:\ntype: npm\nurl: http://npm.host.or.ip\nusername: admin_username\npassword: admin_password\n
"},{"location":"services/nzbget/","title":"NZBget","text":"

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:\ntype: nzbget\nurl: http://nzbget.host.or.ip\nusername: controlusername\npassword: controlpassword\n
"},{"location":"services/ombi/","title":"Ombi","text":"

Find your API key under Settings > Configuration > General.

Allowed fields: [\"pending\", \"approved\", \"available\"].

widget:\ntype: ombi\nurl: http://ombi.host.or.ip\nkey: apikeyapikeyapikeyapikeyapikey\n
"},{"location":"services/openmediavault/","title":"OpenMediaVault","text":"

Provides useful information from your OpenMediaVault

widget:\ntype: openmediavault\nurl: http://omv.host.or.ip\nusername: admin\npassword: pass\nmethod: services.getStatus # required\n
"},{"location":"services/openmediavault/#methods","title":"Methods","text":"

The 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\"]

"},{"location":"services/overseerr/","title":"Overseerr","text":"

Find your API key under Settings > General.

Allowed fields: [\"pending\", \"approved\", \"available\", \"processing\"].

widget:\ntype: overseerr\nurl: http://overseerr.host.or.ip\nkey: apikeyapikeyapikeyapikeyapikey\n
"},{"location":"services/pihole/","title":"PiHole","text":"

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\"].

widget:\ntype: pihole\nurl: http://pi.hole.or.ip\nkey: yourpiholeapikey # optional\n

Added in v0.1.0, udpated in v0.6.18

"},{"location":"services/plex-tautulli/","title":"Tautulli (Plex)","text":"

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:\ntype: tautulli\nurl: http://tautulli.host.or.ip\nkey: apikeyapikeyapikeyapikeyapikey\n
"},{"location":"services/portainer/","title":"Portainer","text":"

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:\ntype: portainer\nurl: https://portainer.host.or.ip:9443\nenv: 1\nkey: ptr_accesskeyaccesskeyaccesskeyaccesskey\n
"},{"location":"services/prowlarr/","title":"Prowlarr","text":"

Find your API key under Settings > General.

Allowed fields: [\"numberOfGrabs\", \"numberOfQueries\", \"numberOfFailGrabs\", \"numberOfFailQueries\"].

widget:\ntype: prowlarr\nurl: http://prowlarr.host.or.ip\nkey: apikeyapikeyapikeyapikeyapikey\n
"},{"location":"services/radarr/","title":"Radarr","text":"

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:\ntype: radarr\nurl: http://radarr.host.or.ip\nkey: apikeyapikeyapikeyapikeyapikey\nenableQueue: true # optional, defaults to false\n
"},{"location":"services/readarr/","title":"Readarr","text":"

Find your API key under Settings > General.

Allowed fields: [\"wanted\", \"queued\", \"books\"].

widget:\ntype: readarr\nurl: http://readarr.host.or.ip\nkey: apikeyapikeyapikeyapikeyapikey\n
"},{"location":"services/rutorrent/","title":"ruTorrent","text":"

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:\ntype: rutorrent\nurl: http://rutorrent.host.or.ip\nusername: username # optional, false if not used\npassword: password # optional, false if not used\n
"},{"location":"services/sabnzbd/","title":"SABnzbd","text":"

Find your API key under Config > General.

Allowed fields: [\"rate\", \"queue\", \"timeleft\"].

widget:\ntype: sabnzbd\nurl: http://sabnzbd.host.or.ip\nkey: apikeyapikeyapikeyapikeyapikey\n
"},{"location":"services/sonarr/","title":"Sonarr","text":"

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:\ntype: sonarr\nurl: http://sonarr.host.or.ip\nkey: apikeyapikeyapikeyapikeyapikey\nenableQueue: true # optional, defaults to false\n
"},{"location":"services/speedtest-tracker/","title":"Speedtest Tracker","text":"

No extra configuration is required.

This widget is compatible with both alexjustesen/speedtest-tracker and henrywhitaker3/Speedtest-Tracker.

Allowed fields: [\"download\", \"upload\", \"ping\"].

widget:\ntype: speedtest\nurl: http://speedtest.host.or.ip\n
"},{"location":"services/tailscale/","title":"Tailscale","text":"

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:\ntype: tailscale\ndeviceid: deviceid\nkey: tailscalekey\n
"},{"location":"services/traefik/","title":"Traefik","text":"

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:\ntype: traefik\nurl: http://traefik.host.or.ip\nusername: username # optional\npassword: password # optional\n
"},{"location":"services/transmission/","title":"Transmission","text":"

Uses the same username and password used to login from the web.

Allowed fields: [\"leech\", \"download\", \"seed\", \"upload\"].

widget:\ntype: transmission\nurl: http://transmission.host.or.ip\nusername: username\npassword: password\nrpcUrl: /transmission/ # Optional. Matches the value of \"rpc-url\" in your Transmission's settings.json file\n
"},{"location":"services/uptimerobot/","title":"UptimeRobot","text":"

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:\ntype: uptimerobot\nurl: https://api.uptimerobot.com\nkey: uptimerobotapitoken\n
"},{"location":"services/urbackup/","title":"UrBackup","text":"

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:\ntype: urbackup\nusername: urbackupUsername\npassword: urbackupPassword\nurl: http://urbackupUrl:55414\nmaxDays: 5 # optional\n
"},{"location":"widgets/openweathermap/","title":"OpenWeatherMap","text":"

The free tier \"One Call API\" is all thats required, you will need to subscribe and grab your API key.

- openweathermap:\nlabel: Kyiv #optional\nlatitude: 50.449684\nlongitude: 30.525026\nunits: metric # or imperial\nprovider: openweathermap\napiKey: youropenweathermapkey # required only if not using provider, this reveals api key in requests\ncache: 5 # Time in minutes to cache API responses, to stay within limits\n

You can optionally not pass a latitude and longitude and the widget will use your current location (requires a secure context, eg. HTTPS).

"},{"location":"widgets/resources/","title":"Resources","text":"

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 compatibile 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:\ncpu: true\nmemory: true\ndisk: /disk/mount/path\ncputemp: true\nuptime: true\nunits: imperial # only used by cpu temp\nrefresh: 3000 # optional, in ms\n

You can also pass a label option, which allows you to group resources under named sections,

- resources:\nlabel: System\ncpu: true\nmemory: true\n- resources:\nlabel: Storage\ndisk: /mnt/storage\n

Which 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:\nlabel: Storage\ndisk:\n- /mnt/storage\n- /mnt/backup\n- /mnt/media\n

To 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:\nlabel: Array Disks\nexpanded: true\ndisk:\n- /disk1\n- /disk2\n- /disk3\n

"},{"location":"widgets/search/","title":"Search","text":"

You 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:\nprovider: google # google, duckduckgo, bing, baidu, brave or custom\nfocus: true # Optional, will set focus to the search bar on page load\ntarget: _blank # One of _self, _blank, _parent or _top\n

or for a custom search:

- search:\nprovider: custom\nurl: https://lougle.com/?q=\ntarget: _blank\n

multiple providers is also supported via a dropdown (excluding custom):

- search:\nprovider: [brave, google, duckduckgo]\n

Added in v0.1.6, updated in 0.6.0

"},{"location":"widgets/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 thats required, you will need to register and grab your API key.

- weatherapi:\nlabel: Kyiv # optional\nlatitude: 50.449684\nlongitude: 30.525026\nunits: metric # or imperial\napiKey: yourweatherapikey\ncache: 5 # Time in minutes to cache API responses, to stay within limits\n

You can optionally not pass a latitude and longitude and the widget will use your current location (requires a secure context, eg. HTTPS).

"}]}