+ 
- A modern (fully static, fast), secure (fully proxied), highly customizable application dashboard with integrations for more than 25 services and translations for over 15 languages. Easily configured via YAML files (or discovery via docker labels). + 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.
-
+
- 
- 
- 
- 
- 
+ 
+
+ 
+
+ 
- 
- 
- 
-
diff --git a/docs/configs/custom-css-js.md b/docs/configs/custom-css-js.md
new file mode 100644
index 00000000..a76ea650
--- /dev/null
+++ b/docs/configs/custom-css-js.md
@@ -0,0 +1,17 @@
+---
+title: Custom CSS & JS
+description: Adding Custom CSS or JS
+---
+
+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.
+
+```yaml
+Service:
+ id: myserviceid
+ icon: icon.png
+ ...
+```
diff --git a/docs/configs/docker.md b/docs/configs/docker.md
new file mode 100644
index 00000000..133c263b
--- /dev/null
+++ b/docs/configs/docker.md
@@ -0,0 +1,205 @@
+---
+title: Docker
+description: Docker Configuration
+---
+
+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](https://gist.github.com/styblope/dc55e0ad2a9848f2cc3307d4819d819f) to accept API traffic over the HTTP API.
+
+```yaml
+my-remote-docker:
+ host: 192.168.0.101
+ port: 2375
+```
+
+## Using Docker TLS
+
+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](https://docs.docker.com/engine/security/protect-access/#use-tls-https-to-protect-the-docker-daemon-socket). The file entries are relative to the `config` directory (location of `docker.yaml` file).
+
+```yaml
+my-remote-docker:
+ host: 192.168.0.101
+ port: 275
+ tls:
+ keyFile: tls/key.pem
+ caFile: tls/ca.pem
+ certFile: tls/cert.pem
+```
+
+## Using Docker Socket Proxy
+
+Due to security concerns with exposing the docker socket directly, you can use a [docker-socket-proxy](https://github.com/Tecnativa/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:
+
+```yaml
+dockerproxy:
+ image: ghcr.io/tecnativa/docker-socket-proxy:latest
+ container_name: dockerproxy
+ environment:
+ - CONTAINERS=1 # Allow access to viewing containers
+ - SERVICES=1 # Allow access to viewing services (necessary when using Docker Swarm)
+ - TASKS=1 # Allow access to viewing tasks (necessary when using Docker Swarm)
+ - POST=0 # Disallow any POST operations (effectively read-only)
+ ports:
+ - 127.0.0.1:2375:2375
+ volumes:
+ - /var/run/docker.sock:/var/run/docker.sock:ro # Mounted as read-only
+ restart: unless-stopped
+
+homepage:
+ image: ghcr.io/gethomepage/homepage:latest
+ container_name: homepage
+ volumes:
+ - /path/to/config:/app/config
+ ports:
+ - 3000:3000
+ restart: unless-stopped
+```
+
+Then, inside of your `docker.yaml` settings file, you'd configure the docker instance like so:
+
+```yaml
+my-docker:
+ host: dockerproxy
+ port: 2375
+```
+
+## Using Socket Directly
+
+If 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
+
+```yaml
+homepage:
+ image: ghcr.io/gethomepage/homepage:latest
+ container_name: homepage
+ volumes:
+ - /path/to/config:/app/config
+ - /var/run/docker.sock:/var/run/docker.sock # pass local proxy
+ ports:
+ - 3000:3000
+ restart: unless-stopped
+```
+
+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:
+
+```yaml
+my-docker:
+ socket: /var/run/docker.sock
+```
+
+## Services
+
+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:
+
+```yaml
+- Emby:
+ icon: emby.png
+ href: "http://emby.home/"
+ description: Media server
+ server: my-docker # The docker server that was configured
+ container: emby # The name of the container you'd like to connect
+```
+
+## Automatic Service Discovery
+
+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.
+
+```yaml
+services:
+ emby:
+ image: lscr.io/linuxserver/emby:latest
+ container_name: emby
+ ports:
+ - 8096:8096
+ restart: unless-stopped
+ labels:
+ - homepage.group=Media
+ - homepage.name=Emby
+ - homepage.icon=emby.png
+ - homepage.href=http://emby.home/
+ - homepage.description=Media server
+```
+
+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_**
+
+## Widgets
+
+You may also configure widgets, along with the standard service entry, again, using dot notation.
+
+```yaml
+labels:
+ - homepage.group=Media
+ - homepage.name=Emby
+ - homepage.icon=emby.png
+ - homepage.href=http://emby.home/
+ - homepage.description=Media server
+ - homepage.widget.type=emby
+ - homepage.widget.url=http://emby.home
+ - homepage.widget.key=yourembyapikeyhere
+ - homepage.widget.fields=["field1","field2"] # optional
+```
+
+## Docker Swarm
+
+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.
+
+```yaml
+my-docker:
+ socket: /var/run/docker.sock
+ swarm: true
+```
+
+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.
+
+```yaml
+....
+ deploy:
+ placement:
+ constraints:
+ - node.role == manager
+...
+```
+
+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:
+
+```yaml
+....
+ deploy:
+ labels:
+ - homepage.icon=foobar
+...
+```
+
+## Ordering
+
+As of v0.6.4 discovered services can include an optional `weight` field to determine sorting such that:
+
+- Default weight for discovered services is 0
+- Default weight for configured services is their index within their group scaled by 100, i.e. (index + 1) \* 100
+- If two items have the same weight value, then they will be sorted by name
+
+## Show stats
+
+You can show the docker stats by clicking the status indicator but this can also be controlled per-service with:
+
+```yaml
+- Example Service:
+ ...
+ showStats: true
+```
+
+Also see the settings for [show docker stats](docker.md#show-docker-stats).
diff --git a/docs/configs/index.md b/docs/configs/index.md
new file mode 100644
index 00000000..a43977f6
--- /dev/null
+++ b/docs/configs/index.md
@@ -0,0 +1,16 @@
+---
+title: Configuration
+description: Homepage Configuration
+---
+
+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:
+
+1. **Use Indentation Carefully**: YAML relies on indentation, not brackets.
+2. Avoid Tabs: Stick to spaces for indentation to avoid parsing errors. 2 spaces are common.
+3. Quote Strings: Use single or double quotes for strings with special characters, this is especially important for API keys.
+4. Key-Value Syntax: Use key: value format. Colon must be followed by a space.
+5. Validate: Always validate your YAML with a linter before deploying.
+
+You can find tons of online YAML validators, here's one: [https://codebeautify.org/yaml-validator](https://codebeautify.org/yaml-validator), heres another: [https://jsonformatter.org/yaml-validator](https://jsonformatter.org/yaml-validator).
diff --git a/docs/configs/kubernetes.md b/docs/configs/kubernetes.md
new file mode 100644
index 00000000..1035db40
--- /dev/null
+++ b/docs/configs/kubernetes.md
@@ -0,0 +1,138 @@
+---
+title: Kubernetes
+description: Kubernetes Configuration
+---
+
+The Kubernetes connectivity has the following requirements:
+
+- Kubernetes 1.19+
+- Metrics Service
+- An Ingress controller
+
+The Kubernetes connection is configured in the `kubernetes.yaml` file. There are 3 modes to choose from:
+
+- **disabled** - disables kubernetes connectivity
+- **default** - uses the default kubeconfig [resolution](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/)
+- **cluster** - uses a service account inside the cluster
+
+```yaml
+mode: default
+```
+
+## Services
+
+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:
+
+```yaml
+- Emby:
+ icon: emby.png
+ href: "http://emby.home/"
+ description: Media server
+ namespace: media # The kubernetes namespace the app resides in
+ app: emby # The name of the deployed app
+```
+
+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 `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:
+
+```yaml
+- Element Chat:
+ icon: matrix-light.png
+ href: https://chat.example.com
+ description: Matrix Synapse Powered Chat
+ app: matrix-element
+ namespace: comms
+ pod-selector: >-
+ app.kubernetes.io/instance in (
+ matrix-element,
+ matrix-media-repo,
+ matrix-media-repo-postgresql,
+ matrix-synapse
+ )
+```
+
+!!! note
+
+ 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.
+
+## Automatic Service Discovery
+
+Homepage features automatic service discovery by Ingress annotations. All configuration options can be applied using typical annotation syntax, beginning with `gethomepage.dev/`.
+
+```yaml
+apiVersion: networking.k8s.io/v1
+kind: Ingress
+metadata:
+ name: emby
+ annotations:
+ gethomepage.dev/enabled: "true"
+ gethomepage.dev/description: Media Server
+ gethomepage.dev/group: Media
+ gethomepage.dev/icon: emby.png
+ gethomepage.dev/name: Emby
+ gethomepage.dev/widget.type: "emby"
+ gethomepage.dev/widget.url: "https://emby.example.com"
+ gethomepage.dev/pod-selector: ""
+ gethomepage.dev/weight: 10 # optional
+spec:
+ rules:
+ - host: emby.example.com
+ http:
+ paths:
+ - backend:
+ service:
+ name: emby
+ port:
+ number: 8080
+ path: /
+ pathType: Prefix
+```
+
+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.**
+
+### Traefik IngressRoute support
+
+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:
+
+```yaml
+apiVersion: traefik.io/v1alpha1
+kind: IngressRoute
+metadata:
+ name: emby
+ annotations:
+ gethomepage.dev/href: "https://emby.example.com"
+ gethomepage.dev/enabled: "true"
+ gethomepage.dev/description: Media Server
+ gethomepage.dev/group: Media
+ gethomepage.dev/icon: emby.png
+ gethomepage.dev/name: Emby
+ gethomepage.dev/widget.type: "emby"
+ gethomepage.dev/widget.url: "https://emby.example.com"
+ gethomepage.dev/pod-selector: ""
+ gethomepage.dev/weight: 10 # optional
+spec:
+ entryPoints:
+ - websecure
+ routes:
+ - kind: Rule
+ match: Host(`emby.example.com`)
+ services:
+ - kind: Service
+ name: emby
+ namespace: emby
+ port: 8080
+ scheme: http
+ strategy: RoundRobin
+ weight: 10
+```
+
+If the `href` attribute is not present, Homepage will ignore the specific IngressRoute.
+
+## Caveats
+
+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`.
diff --git a/docs/configs/service-widgets.md b/docs/configs/service-widgets.md
new file mode 100644
index 00000000..93ed968e
--- /dev/null
+++ b/docs/configs/service-widgets.md
@@ -0,0 +1,40 @@
+---
+title: Service Widgets
+description: Service Widget Configuration
+---
+
+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 thats 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](settings.md#link-target) for more details.
+
+Using Emby as an example, this is how you would attach the Emby service widget.
+
+```yaml
+- Emby:
+ icon: emby.png
+ href: http://emby.host.or.ip/
+ description: Movies & TV Shows
+ widget:
+ type: emby
+ url: http://emby.host.or.ip
+ key: apikeyapikeyapikeyapikeyapikey
+```
+
+## Field Visibility
+
+Each 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.**
+
+```yaml
+- Sonarr:
+ icon: sonarr.png
+ href: http://sonarr.host.or.ip
+ widget:
+ type: sonarr
+ fields: ["wanted", "queued"]
+ url: http://sonarr.host.or.ip
+ key: apikeyapikeyapikeyapikeyapikey
+```
diff --git a/docs/configs/services.md b/docs/configs/services.md
new file mode 100644
index 00000000..3a099e63
--- /dev/null
+++ b/docs/configs/services.md
@@ -0,0 +1,188 @@
+---
+title: Services
+description: Service Configuration
+---
+
+Services are configured inside the `services.yaml` file. You can have any number of groups, and any number of services per group.
+
+## Groups
+
+Groups are defined as top-level array entries.
+
+```yaml
+- Group A:
+ - Service A:
+ href: http://localhost/
+
+- Group B:
+ - Service B:
+ href: http://localhost/
+```
+
+
+
+## Services
+
+Services are defined as array entries on groups,
+
+```yaml
+- Group A:
+ - Service A:
+ href: http://localhost/
+
+ - Service B:
+ href: http://localhost/
+
+ - Service C:
+ href: http://localhost/
+
+- Group B:
+ - Service D:
+ href: http://localhost/
+```
+
+
+
+## Descriptions
+
+Services may have descriptions,
+
+```yaml
+- Group A:
+ - Service A:
+ href: http://localhost/
+ description: This is my service
+
+- Group B:
+ - Service B:
+ href: http://localhost/
+ description: This is another service
+```
+
+
+
+## Icons
+
+Services may have an icon attached to them, you can use icons from [Dashboard Icons](https://github.com/walkxcode/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](https://materialdesignicons.com) with `mdi-XX` or [Simple Icons](https://simpleicons.org/) 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.
+
+```yaml
+- Group A:
+ - Sonarr:
+ icon: sonarr.png
+ href: http://sonarr.host/
+ description: Series management
+
+- Group B:
+ - Radarr:
+ icon: radarr.png
+ href: http://radarr.host/
+ description: Movie management
+
+- Group C:
+ - Service:
+ icon: mdi-flask-outline
+ href: http://service.host/
+ description: My cool service
+```
+
+
+
+## Ping
+
+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.
+
+```yaml
+- Group A:
+ - Sonarr:
+ icon: sonarr.png
+ href: http://sonarr.host/
+ ping: http://sonarr.host/
+
+- Group B:
+ - Radarr:
+ icon: radarr.png
+ href: http://radarr.host/
+ ping: http://some.other.host/
+```
+
+
diff --git a/docs/configs/settings.md b/docs/configs/settings.md
new file mode 100644
index 00000000..06b6b40a
--- /dev/null
+++ b/docs/configs/settings.md
@@ -0,0 +1,425 @@
+---
+title: Settings
+description: Service Configuration
+---
+
+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.
+
+## Title
+
+You can customize the title of the page if you'd like.
+
+```yaml
+title: My Awesome Homepage
+```
+
+## Start URL
+
+You can customize the start_url as required for installable apps. The default is "/".
+
+```yaml
+startUrl: https://custom.url
+```
+
+## Background Image
+
+!!! warning "Heads 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.
+
+!!! warning "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.
+
+```yaml
+background: https://images.unsplash.com/photo-1502790671504-542ad42d5189?auto=format&fit=crop&w=2560&q=80
+```
+
+Or 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:
+
+```yaml
+volumes:
+ - /my/homepage/images:/app/public/images
+```
+
+and then reference that image:
+
+```yaml
+background: /images/background.png
+```
+
+### Background Opacity & Filters
+
+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.
+
+```yaml
+background:
+ image: /images/background.png
+ blur: sm # sm, "", md, xl... see https://tailwindcss.com/docs/backdrop-blur
+ saturate: 50 # 0, 50, 100... see https://tailwindcss.com/docs/backdrop-saturate
+ brightness: 50 # 0, 50, 75... see https://tailwindcss.com/docs/backdrop-brightness
+ opacity: 50 # 0-100
+```
+
+### Card Background Blur
+
+You can apply a blur filter to the service & bookmark cards. Note this option is incompatible with the backround blur, saturate and brightness filters.
+
+```yaml
+cardBlur: sm # sm, "", md, etc... see https://tailwindcss.com/docs/backdrop-blur
+```
+
+## Favicon
+
+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.
+
+```yaml
+favicon: https://www.google.com/favicon.ico
+```
+
+Or you may pass the path to a local image relative to the `/app/public` directory. See [Background Image](#background-image) for more detailed information on how to provide your own files.
+
+## Theme
+
+You can configure a fixed them (and disable the theme switcher) by passing the `theme` option, like so:
+
+```yaml
+theme: dark # or light
+```
+
+## Color Palette
+
+You can configured a fixed color palette (and disable the palette switcher) by passing the `color` option, like so:
+
+```yaml
+color: slate
+```
+
+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`
+
+## Layout
+
+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,
+
+```yaml
+layout:
+ Media:
+ style: row
+ columns: 4
+```
+
+As an example, this would produce the following layout:
+
+
+
+### Sorting
+
+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.
+
+```yaml
+layout:
+ - Auto-Discovered1:
+ - Configured1:
+ - Configured2:
+ - Auto-Discovered2:
+ - Configured3:
+ style: row
+ columns: 3
+```
+
+### Headers
+
+You can hide headers for each section in the layout as well by passing `header` as false, like so:
+
+```yaml
+layout:
+ Section A:
+ header: false
+ Section B:
+ style: row
+ columns: 3
+ header: false
+```
+
+### Category Icons
+
+You can also add an icon to a category under the `layout` setting similar to the [options for service icons](services.md#icons), e.g.
+
+```yaml
+ Home Management & Info:
+ icon: home-assistant.png
+ Server Tools:
+ icon: https://cdn-icons-png.flaticon.com/512/252/252035.png
+ ...
+```
+
+### Icon Style
+
+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](services.md#icons).
+
+```yaml
+iconStyle: theme # optional, defaults to gradient
+```
+
+### Tabs
+
+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:
+
+```yaml
+layout:
+ ...
+ Bookmark Group on First Tab:
+ tab: First
+
+ First Service Group:
+ tab: First
+ style: row
+ columns: 4
+
+ Second Service Group:
+ tab: Second
+ columns: 4
+
+ Third Service Group:
+ tab: Third
+ style: row
+
+ Bookmark Group on Fourth Tab:
+ tab: Fourth
+
+ Service Group on every Tab:
+ style: row
+ columns: 4
+```
+
+### Five Columns
+
+You can add a fifth column (when `style: columns` which is default) by adding:
+
+```yaml
+fiveColumns: true
+```
+
+By default homepage will max out at 4 columns for column style
+
+### Collapsible sections
+
+You can disable the collapsible feature of services & bookmarks by adding:
+
+```yaml
+disableCollapse: true
+```
+
+By default the feature is enabled.
+
+## Header Style
+
+There are currently 4 options for header styles, you can see each one below.
+
+
+
+```yaml
+headerStyle: underlined # default style
+```
+
+---
+
+
+
+```yaml
+headerStyle: boxed
+```
+
+---
+
+
+
+```yaml
+headerStyle: clean
+```
+
+---
+
+
+
+```yaml
+headerStyle: boxedWidgets
+```
+
+## Base URL
+
+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:
+
+```yaml
+base: http://host.local/homepage
+```
+
+**_The URL must be a full, absolute URL, or it will be ignored by the browser._**
+
+## Language
+
+Set your desired language using:
+
+```yaml
+language: fr
+```
+
+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.
+
+## Link Target
+
+Changes the behaviour of links on the homepage,
+
+```yaml
+target: _blank # Possible options include _blank, _self, and _top
+```
+
+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.:
+
+```yaml
+- Example Service:
+ href: https://example.com/
+ ...
+ target: _self
+```
+
+## Providers
+
+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.
+
+```yaml
+providers:
+ openweathermap: openweathermapapikey
+ weatherapi: weatherapiapikey
+ longhorn:
+ url: https://longhorn.example.com
+ username: admin
+ password: LonghornPassword
+```
+
+You can then pass `provider` instead of `apiKey` in your widget configuration.
+
+```yaml
+- weather:
+ latitude: 50.449684
+ longitude: 30.525026
+ provider: weatherapi
+```
+
+## Quick Launch
+
+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:
+
+- `searchDescriptions`: which lets you control whether item descriptions are included in searches. This is off 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.
+- `hideVisitURL`: disable detecting and offering an option to open URLs. This is false by default, enabling the feature.
+
+```yaml
+quicklaunch:
+ searchDescriptions: true
+ hideInternetSearch: true
+ hideVisitURL: true
+```
+
+## Homepage Version
+
+By default the release version is displayed at the bottom of the page. To hide this, use the `hideVersion` setting, like so:
+
+```yaml
+hideVersion: true
+```
+
+## Log Path
+
+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.
+
+```yaml
+logpath: /logfile/path
+```
+
+## Show Docker Stats
+
+You can show all docker stats expanded in `settings.yaml`:
+
+```yaml
+showStats: true
+```
+
+or per-service (`services.yaml`) with:
+
+```yaml
+- Example Service:
+ ...
+ showStats: true
+```
+
+If you have both set the per-service settings take precedence.
+
+## Status Style
+
+You can choose from the following styles for docker or k8s status and ping: `dot` or `basic`
+
+- The default is no value, and displays the ping response time in ms and the docker / k8s container status
+- `dot` shows a green dot for a successful ping or healthy status.
+- `basic` shows either UP or DOWN for ping
+
+For example:
+
+```yaml
+statusStyle: 'dot'
+```
+
+or per-service (`services.yaml`) with:
+
+```yaml
+- Example Service:
+ ...
+ statusStyle: 'dot'
+```
+
+If you have both set, the per-service settings take precedence.
+
+## Hide Widget Error Messages
+
+Hide the visible API error messages either globally in `settings.yaml`:
+
+```yaml
+hideErrors: true
+```
+
+or per service widget (`services.yaml`) with:
+
+```yaml
+- Example Service:
+ ...
+ widget:
+ ...
+ hideErrors: true
+```
+
+If either value is set to true, the errror message will be hidden.
diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 00000000..97a3704b
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,19 @@
+---
+title: Home
+hide:
+ - navigation
+ - toc
+ - path
+---
+
+#
+
+
+
++ + + +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. + + diff --git a/docs/installation/docker.md b/docs/installation/docker.md new file mode 100644 index 00000000..7c696792 --- /dev/null +++ b/docs/installation/docker.md @@ -0,0 +1,57 @@ +--- +title: Docker Installation +description: Install and run homepage from Docker +--- + +Using docker compose: + +```yaml +version: "3.3" +services: + homepage: + image: ghcr.io/gethomepage/homepage:latest + container_name: homepage + ports: + - 3000:3000 + volumes: + - /path/to/config:/app/config # Make sure your local config directory exists + - /var/run/docker.sock:/var/run/docker.sock # (optional) For docker integrations +``` + +### Running as non-root + +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. + +```yaml +version: "3.3" +services: + homepage: + image: ghcr.io/gethomepage/homepage:latest + container_name: homepage + ports: + - 3000:3000 + volumes: + - /path/to/config:/app/config # Make sure your local config directory exists + - /var/run/docker.sock:/var/run/docker.sock # (optional) For docker integrations, see alternative methods + environment: + PUID: $PUID + PGID: $PGID +``` + +### With Docker Run + +```bash +docker run -p 3000:3000 -v /path/to/config:/app/config -v /var/run/docker.sock:/var/run/docker.sock ghcr.io/gethomepage/homepage:latest +``` + +### Using Environment Secrets + +You can also include environment variables in your config files to protect sensitive information. Note: + +- Environment variables must start with `HOMEPAGE_VAR_` or `HOMEPAGE_FILE_` +- The value of env var `HOMEPAGE_VAR_XXX` will replace `{{HOMEPAGE_VAR_XXX}}` in any config +- The value of env var `HOMEPAGE_FILE_XXX` must be a file path, the contents of which will be used to replace `{{HOMEPAGE_FILE_XXX}}` in any config diff --git a/docs/installation/index.md b/docs/installation/index.md new file mode 100644 index 00000000..f1d317c4 --- /dev/null +++ b/docs/installation/index.md @@ -0,0 +1,25 @@ +--- +title: Installation +description: Docs intro +--- + +
+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. +
+ +
+
+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,
+
+```yaml
+- resources:
+ label: Storage
+ disk:
+ - /mnt/storage
+ - /mnt/backup
+ - /mnt/media
+```
+
+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.
+
+```yaml
+- resources:
+ label: Array Disks
+ expanded: true
+ disk:
+ - /disk1
+ - /disk2
+ - /disk3
+```
+
+
diff --git a/docs/widgets/info/search.md b/docs/widgets/info/search.md
new file mode 100644
index 00000000..a03d711c
--- /dev/null
+++ b/docs/widgets/info/search.md
@@ -0,0 +1,31 @@
+---
+title: Search
+description: Search Information Widget Configuration
+---
+
+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.
+
+```yaml
+- search:
+ provider: google # google, duckduckgo, bing, baidu, brave or custom
+ focus: true # Optional, will set focus to the search bar on page load
+ target: _blank # One of _self, _blank, _parent or _top
+```
+
+or for a custom search:
+
+```yaml
+- search:
+ provider: custom
+ url: https://lougle.com/?q=
+ target: _blank
+```
+
+multiple providers is also supported via a dropdown (excluding custom):
+
+```yaml
+- search:
+ provider: [brave, google, duckduckgo]
+```
+
+_Added in v0.1.6, updated in 0.6.0_
diff --git a/docs/widgets/info/unifi_controller.md b/docs/widgets/info/unifi_controller.md
new file mode 100644
index 00000000..29188270
--- /dev/null
+++ b/docs/widgets/info/unifi_controller.md
@@ -0,0 +1,24 @@
+---
+title: Unifi Controller
+description: Unifi Controller Information Widget Configuration
+---
+
+_(Find the Unifi Controller service widget [here](../services/unifi-controller.md))_
+
+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._
+
+
+
+```yaml
+- unifi_console:
+ url: https://unifi.host.or.ip:port
+ username: user
+ password: pass
+ site: Site Name # optional
+```
+
+_Added in v0.4.18, updated in 0.6.7_
diff --git a/docs/widgets/info/weather.md b/docs/widgets/info/weather.md
new file mode 100644
index 00000000..338ca256
--- /dev/null
+++ b/docs/widgets/info/weather.md
@@ -0,0 +1,20 @@
+---
+title: Weather API
+description: Weather API Information Widget Configuration
+---
+
+**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](https://www.weatherapi.com/signup.aspx) and grab your API key.
+
+```yaml
+- weatherapi:
+ label: Kyiv # optional
+ latitude: 50.449684
+ longitude: 30.525026
+ units: metric # or imperial
+ apiKey: yourweatherapikey
+ cache: 5 # Time in minutes to cache API responses, to stay within limits
+```
+
+You can optionally not pass a `latitude` and `longitude` and the widget will use your current location (requires a secure context, eg. HTTPS).
diff --git a/docs/widgets/services/adguard-home.md b/docs/widgets/services/adguard-home.md
new file mode 100644
index 00000000..57fad6a6
--- /dev/null
+++ b/docs/widgets/services/adguard-home.md
@@ -0,0 +1,16 @@
+---
+title: Adguard Home
+description: Adguard Home Widget Configuration
+---
+
+The username and password are the same as used to login to the web interface.
+
+Allowed fields: `["queries", "blocked", "filtered", "latency"]`.
+
+```yaml
+widget:
+ type: adguard
+ url: http://adguard.host.or.ip
+ username: admin
+ password: password
+```
diff --git a/docs/widgets/services/atsumeru.md b/docs/widgets/services/atsumeru.md
new file mode 100644
index 00000000..06126f2e
--- /dev/null
+++ b/docs/widgets/services/atsumeru.md
@@ -0,0 +1,16 @@
+---
+title: Atsumeru
+description: Atsumeru Widget Configuration
+---
+
+Define same username and password that is used for login from web or supported apps
+
+Allowed fields: `["series", "archives", "chapters", "categories"]`.
+
+```yaml
+widget:
+ type: atsumeru
+ url: http://atsumeru.host.or.ip:port
+ username: username
+ password: password
+```
diff --git a/docs/widgets/services/audiobookshelf.md b/docs/widgets/services/audiobookshelf.md
new file mode 100644
index 00000000..73e2b744
--- /dev/null
+++ b/docs/widgets/services/audiobookshelf.md
@@ -0,0 +1,15 @@
+---
+title: Audiobookshelf
+description: Audiobookshelf Widget Configuration
+---
+
+You can find your API token by logging into the Audiobookshelf web app as an admin, go to the config → users page, and click on your account.
+
+Allowed fields: `["podcasts", "podcastsDuration", "books", "booksDuration"]`
+
+```yaml
+widget:
+ type: audiobookshelf
+ url: http://audiobookshelf.host.or.ip:port
+ key: audiobookshelflapikey
+```
diff --git a/docs/widgets/services/authentik.md b/docs/widgets/services/authentik.md
new file mode 100644
index 00000000..306107e0
--- /dev/null
+++ b/docs/widgets/services/authentik.md
@@ -0,0 +1,24 @@
+---
+title: Authentik
+description: Authentik Widget Configuration
+---
+
+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. To do so follow these steps:
+
+1. Navigate to the Authentik Admin Portal
+2. Expand Directory, the click Tokens & App passwords
+3. Click the Create button
+4. Fill out the dialog making sure to set Intent to API Token
+5. Click the Create button on the dialog
+6. Click the copy button on the far right of the newly created API Token
+
+Allowed fields: `["users", "loginsLast24H", "failedLoginsLast24H"]`.
+
+```yaml
+widget:
+ type: authentik
+ url: http://authentik.host.or.ip:22070
+ key: api_token
+```
diff --git a/docs/widgets/services/autobrr.md b/docs/widgets/services/autobrr.md
new file mode 100644
index 00000000..ba034d2a
--- /dev/null
+++ b/docs/widgets/services/autobrr.md
@@ -0,0 +1,15 @@
+---
+title: Autobrr
+description: Autobrr Widget Configuration
+---
+
+Find your API key under `Settings > API Keys`.
+
+Allowed fields: `["approvedPushes", "rejectedPushes", "filters", "indexers"]`.
+
+```yaml
+widget:
+ type: autobrr
+ url: http://autobrr.host.or.ip
+ key: apikeyapikeyapikeyapikeyapikey
+```
diff --git a/docs/widgets/services/azuredevops.md b/docs/widgets/services/azuredevops.md
new file mode 100644
index 00000000..a9142731
--- /dev/null
+++ b/docs/widgets/services/azuredevops.md
@@ -0,0 +1,26 @@
+---
+title: Azure DevOps
+description: Azure DevOps Widget Configuration
+---
+
+This widget has 2 functions:
+
+1. Pipelines: checks if the relevant pipeline is running or not, and if not, reports the last status.\
+ Allowed fields: `["result", "status"]`.
+
+2. 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 atleast 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](https://learn.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops&tabs=Windows#create-a-pat)
+
+```yaml
+widget:
+ type: azuredevops
+ organization: myOrganization
+ project: myProject
+ definitionId: pipelineDefinitionId # required for pipelines
+ branchName: branchName # optional for pipelines, leave empty for all
+ userEmail: email # required for pull requests
+ repositoryId: prRepositoryId # required for pull requests
+ key: personalaccesstoken
+```
diff --git a/docs/widgets/services/bazarr.md b/docs/widgets/services/bazarr.md
new file mode 100644
index 00000000..3a48821e
--- /dev/null
+++ b/docs/widgets/services/bazarr.md
@@ -0,0 +1,15 @@
+---
+title: Bazarr
+description: Bazarr Widget Configuration
+---
+
+Find your API key under `Settings > General`.
+
+Allowed fields: `["missingEpisodes", "missingMovies"]`.
+
+```yaml
+widget:
+ type: bazarr
+ url: http://bazarr.host.or.ip
+ key: apikeyapikeyapikeyapikeyapikey
+```
diff --git a/docs/widgets/services/caddy.md b/docs/widgets/services/caddy.md
new file mode 100644
index 00000000..52c1d462
--- /dev/null
+++ b/docs/widgets/services/caddy.md
@@ -0,0 +1,12 @@
+---
+title: Caddy
+description: Caddy Widget Configuration
+---
+
+Allowed fields: `["upstreams", "requests", "requests_failed"]`.
+
+```yaml
+widget:
+ type: caddy
+ url: http://caddy.host.or.ip:adminport # default admin port is 2019
+```
diff --git a/docs/widgets/services/calendar.md b/docs/widgets/services/calendar.md
new file mode 100644
index 00000000..794c0ed2
--- /dev/null
+++ b/docs/widgets/services/calendar.md
@@ -0,0 +1,25 @@
+---
+title: Calendar
+description: Calendar widget
+---
+
+
+
+This widget shows monthly calendar, with optional integrations to show events from supported widgets.
+
+```yaml
+widget:
+ type: calendar
+ firstDayInWeek: sunday # optional - defaults to monday
+ integrations: # optional
+ - type: sonarr # active widget type that is currently enabled on homepage - possible values: radarr, sonarr, lidarr, readarr
+ service_group: Media # group name where widget exists
+ service_name: Sonarr # service name for that widget
+ color: teal # optional - defaults to pre-defined color for the service (teal for sonarr)
+ params: # optional - additional params for the service
+ unmonitored: true # optional - defaults to false, used with *arr stack
+```
+
+Currently integrated widgets are [sonarr](sonarr.md), [radarr](radarr.md), [lidarr](lidarr.md) and [readarr](readarr.md).
+
+Supported colors can be found on [color palette](../../configs/settings.md#color-palette).
diff --git a/docs/widgets/services/calibre-web.md b/docs/widgets/services/calibre-web.md
new file mode 100644
index 00000000..f9090f8d
--- /dev/null
+++ b/docs/widgets/services/calibre-web.md
@@ -0,0 +1,16 @@
+---
+title: Calibre-web
+description: Calibre-web Widget Configuration
+---
+
+**Note: this widget requires a feature of calibre-web that has not yet been distributed in versioned release. The code is contained in ["nightly" lsio builds after 25/8/23](https://hub.docker.com/layers/linuxserver/calibre-web/nightly/images/sha256-b27cbe5d17503de38135d925e226eb3e5ba04c558dbc865dc85d77824d35d7e2) or running the calibre-web source code including commit [0499e57](https://github.com/janeczku/calibre-web/commit/0499e578cdd45db656da34cd2d7152c8d88ceb23).**
+
+Allowed fields: `["books", "authors", "categories", "series"]`.
+
+```yaml
+widget:
+ type: calibreweb
+ url: http://your.calibreweb.host:port
+ username: username
+ password: password
+```
diff --git a/docs/widgets/services/changedetectionio.md b/docs/widgets/services/changedetectionio.md
new file mode 100644
index 00000000..674db9a8
--- /dev/null
+++ b/docs/widgets/services/changedetectionio.md
@@ -0,0 +1,13 @@
+---
+title: Changedetection.io
+description: Changedetection.io Widget Configuration
+---
+
+Find your API key under `Settings > API`.
+
+```yaml
+widget:
+ type: changedetectionio
+ url: http://changedetection.host.or.ip:port
+ key: apikeyapikeyapikeyapikeyapikey
+```
diff --git a/docs/widgets/services/channelsdvrserver.md b/docs/widgets/services/channelsdvrserver.md
new file mode 100644
index 00000000..390df42c
--- /dev/null
+++ b/docs/widgets/services/channelsdvrserver.md
@@ -0,0 +1,10 @@
+---
+title: Channels DVR Server
+description: Channels DVR Server Widget Configuration
+---
+
+```yaml
+widget:
+ type: channelsdvrserver
+ url: http://192.168.1.55:8089
+```
diff --git a/docs/widgets/services/cloudflared.md b/docs/widgets/services/cloudflared.md
new file mode 100644
index 00000000..3212a278
--- /dev/null
+++ b/docs/widgets/services/cloudflared.md
@@ -0,0 +1,16 @@
+---
+title: Cloudflare Tunnels
+description: Cloudflare Tunnels Widget Configuration
+---
+
+_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"]`.
+
+```yaml
+widget:
+ type: cloudflared
+ accountid: accountid # from zero trust dashboard url e.g. https://one.dash.cloudflare.com/
+
+_(Find the Glances information widget [here](../info/glances.md))_
+
+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.
+
+```yaml
+widget:
+ type: glances
+ url: http://glances.host.or.ip:port
+ username: user # optional if auth enabled in Glances
+ password: pass # optional if auth enabled in Glances
+ metric: cpu
+```
+
+_Please note, this widget does not need an `href`, `icon` or `description` on its parent service. To achive the same effect as the examples above, see as an example:_
+
+```yaml
+- CPU Usage:
+ widget:
+ type: glances
+ url: http://glances.host.or.ip:port
+ metric: cpu
+- Network Usage:
+ widget:
+ type: glances
+ url: http://glances.host.or.ip:port
+ metric: network:enp0s25
+```
+
+## Metrics
+
+The 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:
+
+To switch to the alternative "graphless" view, simply passs `chart: false` as an option to the widget, like so:
+
+```yaml
+- Network Usage:
+ widget:
+ type: glances
+ url: http://glances.host.or.ip:port
+ metric: network:enp0s25
+ chart: false
+```
diff --git a/docs/widgets/services/gluetun.md b/docs/widgets/services/gluetun.md
new file mode 100644
index 00000000..08b5c70b
--- /dev/null
+++ b/docs/widgets/services/gluetun.md
@@ -0,0 +1,14 @@
+---
+title: Gluetun
+description: Gluetun Widget Configuration
+---
+
+Requires [HTTP control server options](https://github.com/qdm12/gluetun-wiki/blob/main/setup/advanced/control-server.md) to be enabled.
+
+Allowed fields: `["public_ip", "region", "country"]`.
+
+```yaml
+widget:
+ type: gluetun
+ url: http://gluetun.host.or.ip
+```
diff --git a/docs/widgets/services/gotify.md b/docs/widgets/services/gotify.md
new file mode 100644
index 00000000..1eb16c03
--- /dev/null
+++ b/docs/widgets/services/gotify.md
@@ -0,0 +1,15 @@
+---
+title: Gotify
+description: Gotify Widget Configuration
+---
+
+Get a Gotify client token from an existing client or create a new one on your Gotify admin page.
+
+Allowed fields: `["apps", "clients", "messages"]`.
+
+```yaml
+widget:
+ type: gotify
+ url: http://gotify.host.or.ip
+ key: clientoken
+```
diff --git a/docs/widgets/services/grafana.md b/docs/widgets/services/grafana.md
new file mode 100644
index 00000000..5d3aab9e
--- /dev/null
+++ b/docs/widgets/services/grafana.md
@@ -0,0 +1,14 @@
+---
+title: Grafana
+description: Grafana Widget Configuration
+---
+
+Allowed fields: `["dashboards", "datasources", "totalalerts", "alertstriggered"]`.
+
+```yaml
+widget:
+ type: grafana
+ url: http://grafana.host.or.ip:port
+ username: username
+ password: password
+```
diff --git a/docs/widgets/services/hdhomerun.md b/docs/widgets/services/hdhomerun.md
new file mode 100644
index 00000000..850deea5
--- /dev/null
+++ b/docs/widgets/services/hdhomerun.md
@@ -0,0 +1,12 @@
+---
+title: HDHomerun
+description: HDHomerun Widget Configuration
+---
+
+Allowed fields: `["channels", "hd"]`.
+
+```yaml
+widget:
+ type: hdhomerun
+ url: http://hdhomerun.host.or.ip
+```
diff --git a/docs/widgets/services/healthchecks.md b/docs/widgets/services/healthchecks.md
new file mode 100644
index 00000000..c8effa92
--- /dev/null
+++ b/docs/widgets/services/healthchecks.md
@@ -0,0 +1,20 @@
+---
+title: Health checks
+description: Health checks Widget Configuration
+---
+
+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"]`.
+
+```yaml
+widget:
+ type: healthchecks
+ url: http://healthchecks.host.or.ip:port
+ key: