diff --git a/docs/configs/docker.md b/docs/configs/docker.md
index b4e089bb..cc9ec465 100644
--- a/docs/configs/docker.md
+++ b/docs/configs/docker.md
@@ -9,8 +9,8 @@ For IP:PORT, simply make sure your Docker instance [has been configured](https:/
```yaml
my-remote-docker:
- host: 192.168.0.101
- port: 2375
+ host: 192.168.0.101
+ port: 2375
```
## Using Docker TLS
@@ -19,12 +19,12 @@ Since Docker supports connecting with TLS and client certificate authentication,
```yaml
my-remote-docker:
- host: 192.168.0.101
- port: 275
- tls:
- keyFile: tls/key.pem
- caFile: tls/ca.pem
- certFile: tls/cert.pem
+ host: 192.168.0.101
+ port: 275
+ tls:
+ keyFile: tls/key.pem
+ caFile: tls/ca.pem
+ certFile: tls/cert.pem
```
## Using Docker Socket Proxy
@@ -35,35 +35,35 @@ Here is an example docker-compose file that will expose the docker socket, and t
```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
+ 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
+ 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
+ host: dockerproxy
+ port: 2375
```
## Using Socket Directly
@@ -76,14 +76,14 @@ If you'd rather use the socket directly, first make sure that you're passing the
```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
+ 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`.
@@ -92,7 +92,7 @@ Then, inside of your `docker.yaml` settings file, you'd configure the docker ins
```yaml
my-docker:
- socket: /var/run/docker.sock
+ socket: /var/run/docker.sock
```
## Services
@@ -118,18 +118,18 @@ 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
+ 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.**
@@ -142,32 +142,32 @@ You may also configure widgets, along with the standard service entry, again, us
```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
+ - 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
```
You can add specify fields for e.g. the [CustomAPI](/widgets/services/customapi) widget by using array-style 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=customapi
- - homepage.widget.url=http://argus.service/api/v1/service/summary/emby
- - homepage.widget.field[0].label=Deployed Version
- - homepage.widget.field[0].field.status=deployed_version
- - homepage.widget.field[1].label=Latest Version
- - homepage.widget.field[1].field.status=latest_version
+ - homepage.group=Media
+ - homepage.name=Emby
+ - homepage.icon=emby.png
+ - homepage.href=http://emby.home/
+ - homepage.description=Media server
+ - homepage.widget.type=customapi
+ - homepage.widget.url=http://argus.service/api/v1/service/summary/emby
+ - homepage.widget.field[0].label=Deployed Version
+ - homepage.widget.field[0].field.status=deployed_version
+ - homepage.widget.field[1].label=Latest Version
+ - homepage.widget.field[1].field.status=latest_version
```
## Docker Swarm
@@ -176,8 +176,8 @@ Docker swarm is supported and Docker services are specified with the same `serve
```yaml
my-docker:
- socket: /var/run/docker.sock
- swarm: true
+ 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.
@@ -205,9 +205,9 @@ In order to detect every service within the Docker swarm it is necessary that se
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
+- 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
diff --git a/docs/configs/kubernetes.md b/docs/configs/kubernetes.md
index 1d46fe8c..c1777612 100644
--- a/docs/configs/kubernetes.md
+++ b/docs/configs/kubernetes.md
@@ -5,15 +5,15 @@ description: Kubernetes Configuration
The Kubernetes connectivity has the following requirements:
-- Kubernetes 1.19+
-- Metrics Service
-- An Ingress controller
+- 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
+- **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
@@ -42,18 +42,18 @@ For instance, it can be utilized to roll multiple underlying deployments under o
```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
- )
+ 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
@@ -68,29 +68,29 @@ Homepage features automatic service discovery by Ingress annotations. All config
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
+ 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
+ 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.**
@@ -103,33 +103,33 @@ Homepage can also read ingresses defined using the Traefik IngressRoute custom r
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/app: emby-app # optional, may be needed if app.kubernetes.io/name != ingress metadata.name
- 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
+ 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/app: emby-app # optional, may be needed if app.kubernetes.io/name != ingress metadata.name
+ 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
+ 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.
diff --git a/docs/configs/service-widgets.md b/docs/configs/service-widgets.md
index 93ed968e..4cdf4930 100644
--- a/docs/configs/service-widgets.md
+++ b/docs/configs/service-widgets.md
@@ -13,13 +13,13 @@ 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
+ 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
@@ -30,11 +30,11 @@ Each widget can optionally provide a list of which fields should be visible via
```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
+ 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/settings.md b/docs/configs/settings.md
index 06b6b40a..f2c17934 100644
--- a/docs/configs/settings.md
+++ b/docs/configs/settings.md
@@ -391,7 +391,7 @@ You can choose from the following styles for docker or k8s status and ping: `dot
For example:
```yaml
-statusStyle: 'dot'
+statusStyle: "dot"
```
or per-service (`services.yaml`) with:
diff --git a/docs/installation/docker.md b/docs/installation/docker.md
index 7c696792..1f9f07d6 100644
--- a/docs/installation/docker.md
+++ b/docs/installation/docker.md
@@ -8,14 +8,14 @@ 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
+ 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
@@ -29,17 +29,17 @@ In the docker compose example below, the environment variables `$PUID` and `$PGI
```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
+ 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
@@ -52,6 +52,6 @@ docker run -p 3000:3000 -v /path/to/config:/app/config -v /var/run/docker.sock:/
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
+- 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/k8s.md b/docs/installation/k8s.md
index 336801d8..685472ea 100644
--- a/docs/installation/k8s.md
+++ b/docs/installation/k8s.md
@@ -16,70 +16,70 @@ The helm chart allows for all the configurations to be inlined directly in your
```yaml
config:
- bookmarks:
- - Developer:
- - Github:
- - abbr: GH
- href: https://github.com/
- services:
- - My First Group:
- - My First Service:
- href: http://localhost/
- description: Homepage is awesome
+ bookmarks:
+ - Developer:
+ - Github:
+ - abbr: GH
+ href: https://github.com/
+ services:
+ - My First Group:
+ - My First Service:
+ href: http://localhost/
+ description: Homepage is awesome
- - My Second Group:
- - My Second Service:
- href: http://localhost/
- description: Homepage is the best
+ - My Second Group:
+ - My Second Service:
+ href: http://localhost/
+ description: Homepage is the best
- - My Third Group:
- - My Third Service:
- href: http://localhost/
- description: Homepage is 😎
- widgets:
- # show the kubernetes widget, with the cluster summary and individual nodes
- - kubernetes:
- cluster:
- show: true
- cpu: true
- memory: true
- showLabel: true
- label: "cluster"
- nodes:
- show: true
- cpu: true
- memory: true
- showLabel: true
- - search:
- provider: duckduckgo
- target: _blank
- kubernetes:
- mode: cluster
- settings:
+ - My Third Group:
+ - My Third Service:
+ href: http://localhost/
+ description: Homepage is 😎
+ widgets:
+ # show the kubernetes widget, with the cluster summary and individual nodes
+ - kubernetes:
+ cluster:
+ show: true
+ cpu: true
+ memory: true
+ showLabel: true
+ label: "cluster"
+ nodes:
+ show: true
+ cpu: true
+ memory: true
+ showLabel: true
+ - search:
+ provider: duckduckgo
+ target: _blank
+ kubernetes:
+ mode: cluster
+ settings:
# The service account is necessary to allow discovery of other services
serviceAccount:
- create: true
- name: homepage
+ create: true
+ name: homepage
# This enables the service account to access the necessary resources
enableRbac: true
ingress:
- main:
- enabled: true
- annotations:
- # Example annotations to add Homepage to your Homepage!
- gethomepage.dev/enabled: "true"
- gethomepage.dev/name: "Homepage"
- gethomepage.dev/description: "Dynamically Detected Homepage"
- gethomepage.dev/group: "Dynamic"
- gethomepage.dev/icon: "homepage.png"
- hosts:
- - host: homepage.example.com
- paths:
- - path: /
- pathType: Prefix
+ main:
+ enabled: true
+ annotations:
+ # Example annotations to add Homepage to your Homepage!
+ gethomepage.dev/enabled: "true"
+ gethomepage.dev/name: "Homepage"
+ gethomepage.dev/description: "Dynamically Detected Homepage"
+ gethomepage.dev/group: "Dynamic"
+ gethomepage.dev/icon: "homepage.png"
+ hosts:
+ - host: homepage.example.com
+ paths:
+ - path: /
+ pathType: Prefix
```
## Install with Kubernetes Manifests
@@ -94,12 +94,12 @@ Here's a working example of the resources you need:
apiVersion: v1
kind: ServiceAccount
metadata:
- name: homepage
- namespace: default
- labels:
- app.kubernetes.io/name: homepage
+ name: homepage
+ namespace: default
+ labels:
+ app.kubernetes.io/name: homepage
secrets:
- - name: homepage
+ - name: homepage
```
#### Secret
@@ -109,12 +109,12 @@ apiVersion: v1
kind: Secret
type: kubernetes.io/service-account-token
metadata:
- name: homepage
- namespace: default
- labels:
- app.kubernetes.io/name: homepage
- annotations:
- kubernetes.io/service-account.name: homepage
+ name: homepage
+ namespace: default
+ labels:
+ app.kubernetes.io/name: homepage
+ annotations:
+ kubernetes.io/service-account.name: homepage
```
#### ConfigMap
@@ -123,62 +123,62 @@ metadata:
apiVersion: v1
kind: ConfigMap
metadata:
- name: homepage
- namespace: default
- labels:
- app.kubernetes.io/name: homepage
+ name: homepage
+ namespace: default
+ labels:
+ app.kubernetes.io/name: homepage
data:
- kubernetes.yaml: |
- mode: cluster
- settings.yaml: ""
- #settings.yaml: |
- # providers:
- # longhorn:
- # url: https://longhorn.my.network
- custom.css: ""
- custom.js: ""
- bookmarks.yaml: |
- - Developer:
- - Github:
- - abbr: GH
- href: https://github.com/
- services.yaml: |
- - My First Group:
- - My First Service:
- href: http://localhost/
- description: Homepage is awesome
+ kubernetes.yaml: |
+ mode: cluster
+ settings.yaml: ""
+ #settings.yaml: |
+ # providers:
+ # longhorn:
+ # url: https://longhorn.my.network
+ custom.css: ""
+ custom.js: ""
+ bookmarks.yaml: |
+ - Developer:
+ - Github:
+ - abbr: GH
+ href: https://github.com/
+ services.yaml: |
+ - My First Group:
+ - My First Service:
+ href: http://localhost/
+ description: Homepage is awesome
- - My Second Group:
- - My Second Service:
- href: http://localhost/
- description: Homepage is the best
+ - My Second Group:
+ - My Second Service:
+ href: http://localhost/
+ description: Homepage is the best
- - My Third Group:
- - My Third Service:
- href: http://localhost/
- description: Homepage is 😎
- widgets.yaml: |
- - kubernetes:
- cluster:
- show: true
- cpu: true
- memory: true
- showLabel: true
- label: "cluster"
- nodes:
- show: true
- cpu: true
- memory: true
- showLabel: true
- - resources:
- backend: resources
- expanded: true
- cpu: true
- memory: true
- - search:
- provider: duckduckgo
- target: _blank
- docker.yaml: ""
+ - My Third Group:
+ - My Third Service:
+ href: http://localhost/
+ description: Homepage is 😎
+ widgets.yaml: |
+ - kubernetes:
+ cluster:
+ show: true
+ cpu: true
+ memory: true
+ showLabel: true
+ label: "cluster"
+ nodes:
+ show: true
+ cpu: true
+ memory: true
+ showLabel: true
+ - resources:
+ backend: resources
+ expanded: true
+ cpu: true
+ memory: true
+ - search:
+ provider: duckduckgo
+ target: _blank
+ docker.yaml: ""
```
#### ClusterRole and ClusterRoleBinding
@@ -187,57 +187,57 @@ data:
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
- name: homepage
- labels:
- app.kubernetes.io/name: homepage
+ name: homepage
+ labels:
+ app.kubernetes.io/name: homepage
rules:
- - apiGroups:
- - ""
- resources:
- - namespaces
- - pods
- - nodes
- verbs:
- - get
- - list
- - apiGroups:
- - extensions
- - networking.k8s.io
- resources:
- - ingresses
- verbs:
- - get
- - list
- - apiGroups:
- - traefik.containo.us
- resources:
- - ingressroutes
- verbs:
- - get
- - list
- - apiGroups:
- - metrics.k8s.io
- resources:
- - nodes
- - pods
- verbs:
- - get
- - list
+ - apiGroups:
+ - ""
+ resources:
+ - namespaces
+ - pods
+ - nodes
+ verbs:
+ - get
+ - list
+ - apiGroups:
+ - extensions
+ - networking.k8s.io
+ resources:
+ - ingresses
+ verbs:
+ - get
+ - list
+ - apiGroups:
+ - traefik.containo.us
+ resources:
+ - ingressroutes
+ verbs:
+ - get
+ - list
+ - apiGroups:
+ - metrics.k8s.io
+ resources:
+ - nodes
+ - pods
+ verbs:
+ - get
+ - list
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
- name: homepage
- labels:
- app.kubernetes.io/name: homepage
+ name: homepage
+ labels:
+ app.kubernetes.io/name: homepage
roleRef:
- apiGroup: rbac.authorization.k8s.io
- kind: ClusterRole
- name: homepage
+ apiGroup: rbac.authorization.k8s.io
+ kind: ClusterRole
+ name: homepage
subjects:
- - kind: ServiceAccount
- name: homepage
- namespace: default
+ - kind: ServiceAccount
+ name: homepage
+ namespace: default
```
#### Service
@@ -246,20 +246,20 @@ subjects:
apiVersion: v1
kind: Service
metadata:
- name: homepage
- namespace: default
- labels:
- app.kubernetes.io/name: homepage
- annotations:
+ name: homepage
+ namespace: default
+ labels:
+ app.kubernetes.io/name: homepage
+ annotations:
spec:
- type: ClusterIP
- ports:
- - port: 3000
- targetPort: http
- protocol: TCP
- name: http
- selector:
- app.kubernetes.io/name: homepage
+ type: ClusterIP
+ ports:
+ - port: 3000
+ targetPort: http
+ protocol: TCP
+ name: http
+ selector:
+ app.kubernetes.io/name: homepage
```
#### Deployment
@@ -268,68 +268,68 @@ spec:
apiVersion: apps/v1
kind: Deployment
metadata:
- name: homepage
- namespace: default
- labels:
- app.kubernetes.io/name: homepage
+ name: homepage
+ namespace: default
+ labels:
+ app.kubernetes.io/name: homepage
spec:
- revisionHistoryLimit: 3
- replicas: 1
- strategy:
- type: RollingUpdate
- selector:
- matchLabels:
- app.kubernetes.io/name: homepage
- template:
- metadata:
- labels:
- app.kubernetes.io/name: homepage
- spec:
- serviceAccountName: homepage
- automountServiceAccountToken: true
- dnsPolicy: ClusterFirst
- enableServiceLinks: true
- containers:
- - name: homepage
- image: "ghcr.io/gethomepage/homepage:latest"
- imagePullPolicy: Always
- ports:
- - name: http
- containerPort: 3000
- protocol: TCP
- volumeMounts:
- - mountPath: /app/config/custom.js
- name: homepage-config
- subPath: custom.js
- - mountPath: /app/config/custom.css
- name: homepage-config
- subPath: custom.css
- - mountPath: /app/config/bookmarks.yaml
- name: homepage-config
- subPath: bookmarks.yaml
- - mountPath: /app/config/docker.yaml
- name: homepage-config
- subPath: docker.yaml
- - mountPath: /app/config/kubernetes.yaml
- name: homepage-config
- subPath: kubernetes.yaml
- - mountPath: /app/config/services.yaml
- name: homepage-config
- subPath: services.yaml
- - mountPath: /app/config/settings.yaml
- name: homepage-config
- subPath: settings.yaml
- - mountPath: /app/config/widgets.yaml
- name: homepage-config
- subPath: widgets.yaml
- - mountPath: /app/config/logs
- name: logs
- volumes:
- - name: homepage-config
- configMap:
- name: homepage
- - name: logs
- emptyDir: {}
+ revisionHistoryLimit: 3
+ replicas: 1
+ strategy:
+ type: RollingUpdate
+ selector:
+ matchLabels:
+ app.kubernetes.io/name: homepage
+ template:
+ metadata:
+ labels:
+ app.kubernetes.io/name: homepage
+ spec:
+ serviceAccountName: homepage
+ automountServiceAccountToken: true
+ dnsPolicy: ClusterFirst
+ enableServiceLinks: true
+ containers:
+ - name: homepage
+ image: "ghcr.io/gethomepage/homepage:latest"
+ imagePullPolicy: Always
+ ports:
+ - name: http
+ containerPort: 3000
+ protocol: TCP
+ volumeMounts:
+ - mountPath: /app/config/custom.js
+ name: homepage-config
+ subPath: custom.js
+ - mountPath: /app/config/custom.css
+ name: homepage-config
+ subPath: custom.css
+ - mountPath: /app/config/bookmarks.yaml
+ name: homepage-config
+ subPath: bookmarks.yaml
+ - mountPath: /app/config/docker.yaml
+ name: homepage-config
+ subPath: docker.yaml
+ - mountPath: /app/config/kubernetes.yaml
+ name: homepage-config
+ subPath: kubernetes.yaml
+ - mountPath: /app/config/services.yaml
+ name: homepage-config
+ subPath: services.yaml
+ - mountPath: /app/config/settings.yaml
+ name: homepage-config
+ subPath: settings.yaml
+ - mountPath: /app/config/widgets.yaml
+ name: homepage-config
+ subPath: widgets.yaml
+ - mountPath: /app/config/logs
+ name: logs
+ volumes:
+ - name: homepage-config
+ configMap:
+ name: homepage
+ - name: logs
+ emptyDir: {}
```
#### Ingress
@@ -338,26 +338,26 @@ spec:
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
- name: homepage
- namespace: default
- labels:
- app.kubernetes.io/name: homepage
- annotations:
- gethomepage.dev/description: Dynamically Detected Homepage
- gethomepage.dev/enabled: "true"
- gethomepage.dev/group: Cluster Management
- gethomepage.dev/icon: homepage.png
- gethomepage.dev/name: Homepage
+ name: homepage
+ namespace: default
+ labels:
+ app.kubernetes.io/name: homepage
+ annotations:
+ gethomepage.dev/description: Dynamically Detected Homepage
+ gethomepage.dev/enabled: "true"
+ gethomepage.dev/group: Cluster Management
+ gethomepage.dev/icon: homepage.png
+ gethomepage.dev/name: Homepage
spec:
- rules:
- - host: "homepage.my.network"
- http:
- paths:
- - path: "/"
- pathType: Prefix
- backend:
- service:
- name: homepage
- port:
- number: 3000
+ rules:
+ - host: "homepage.my.network"
+ http:
+ paths:
+ - path: "/"
+ pathType: Prefix
+ backend:
+ service:
+ name: homepage
+ port:
+ number: 3000
```
diff --git a/docs/installation/unraid.md b/docs/installation/unraid.md
index 192837d2..eb5be7a8 100644
--- a/docs/installation/unraid.md
+++ b/docs/installation/unraid.md
@@ -7,39 +7,39 @@ Homepage has an UNRAID community package that you may use to install homepage. T
## Install the Plugin
-- In the UNRAID webGUI, go to the **Apps** tab.
-- In the search bar, search for `homepage`.
-- Click on **Install**.
-- Change the parameters to your liking.
- - Click on **APPLY**.
+- In the UNRAID webGUI, go to the **Apps** tab.
+- In the search bar, search for `homepage`.
+- Click on **Install**.
+- Change the parameters to your liking.
+ - Click on **APPLY**.
## Run the Container
-- While the container is running, open the WebUI.
- - Opening the page will generate the configuration files.
+- While the container is running, open the WebUI.
+ - Opening the page will generate the configuration files.
You may need to set the permissions of the folders to be able to edit the files.
-- Click on the Homepage icon.
-- Click on **Console**.
- - Enter `chmod -R u-x,go-rwx,go+u,ugo+X /app/config` and press **Enter**.
- - Enter `chmod -R u-x,go-rwx,go+u,ugo+X /app/public/icons` and press **Enter**.
- - Enter `chown -R nobody:users /app/config` and press **Enter**.
- - Enter `chown -R nobody:users /app/public/icons` and press **Enter**.
+- Click on the Homepage icon.
+- Click on **Console**.
+ - Enter `chmod -R u-x,go-rwx,go+u,ugo+X /app/config` and press **Enter**.
+ - Enter `chmod -R u-x,go-rwx,go+u,ugo+X /app/public/icons` and press **Enter**.
+ - Enter `chown -R nobody:users /app/config` and press **Enter**.
+ - Enter `chown -R nobody:users /app/public/icons` and press **Enter**.
## Some Other Notes
-- To use the [Docker integration](../configs/docker.md), you only need to use the `container:` parameter. There is no need to set the server.
+- To use the [Docker integration](../configs/docker.md), you only need to use the `container:` parameter. There is no need to set the server.
- !!! note
+ !!! note
To view detailed container statistics (CPU, RAM, etc.), or if you use a remote docker socket, `container:` will still need to be set. For example:
- ```
- - Plex:
- icon: /icons/plex.png
- href: https://app.plex.com
- container: plex
- ```
+ ```
+ - Plex:
+ icon: /icons/plex.png
+ href: https://app.plex.com
+ container: plex
+ ```
-- When you upload a new image into the **/images** folder, you will need to restart the container for it to show up in the WebUI. Please see the [service icons](../configs/services.md#icons) for more information.
+- When you upload a new image into the **/images** folder, you will need to restart the container for it to show up in the WebUI. Please see the [service icons](../configs/services.md#icons) for more information.
diff --git a/docs/more/development.md b/docs/more/development.md
index af5a58dd..f0468e7f 100644
--- a/docs/more/development.md
+++ b/docs/more/development.md
@@ -35,8 +35,8 @@ pnpm lint
To ensure cohesiveness of various widgets, the following should be used as a guide for developing new widgets:
-- Please only submit widgets that have been requested and have at least 5 'up-votes'
-- Widgets should be only one row of blocks
-- Widgets should be no more than 4 blocks wide
-- Minimize the number of API calls
-- Avoid the use of custom proxy unless absolutely necessary
+- Please only submit widgets that have been requested and have at least 5 'up-votes'
+- Widgets should be only one row of blocks
+- Widgets should be no more than 4 blocks wide
+- Minimize the number of API calls
+- Avoid the use of custom proxy unless absolutely necessary
diff --git a/docs/more/homepage-move.md b/docs/more/homepage-move.md
index de99e640..061fd21b 100644
--- a/docs/more/homepage-move.md
+++ b/docs/more/homepage-move.md
@@ -5,4 +5,4 @@ description: Homepage Container Deprecation
As of v0.7.2 homepage migrated from benphelps/homepage to an "organization" repository located at [gethomepage/homepage](https://github.com/gethomepage/homepage/). The reason for this was to setup the project for longevity and allow for community maintenance.
-Migrating your installation should be as simple as changing `image: ghcr.io/benphelps/homepage:latest` to `image: ghcr.io/gethomepage/homepage:latest`.
\ No newline at end of file
+Migrating your installation should be as simple as changing `image: ghcr.io/benphelps/homepage:latest` to `image: ghcr.io/gethomepage/homepage:latest`.
diff --git a/docs/more/translations.md b/docs/more/translations.md
index 7a978989..824d6cb6 100644
--- a/docs/more/translations.md
+++ b/docs/more/translations.md
@@ -3,7 +3,7 @@ title: Translations
description: Contributing Translations
---
-Homepage is developed in English, component contributions must be in English. All translations are community provided, so a huge thanks go out to all those who have helped out so far!
+Homepage is developed in English, component contributions must be in English. All translations are community provided, so a huge thanks go out to all those who have helped out so far!
## Support Translations
diff --git a/docs/more/troubleshooting.md b/docs/more/troubleshooting.md
index 3ca3eb73..9d0fdc75 100644
--- a/docs/more/troubleshooting.md
+++ b/docs/more/troubleshooting.md
@@ -17,9 +17,9 @@ hide:
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/latest/configs/service-widgets/. **Unless otherwise noted, URLs should not end with a / or other API path. Each widget will handle the path on its own.**. This is very important as including a trailing slash can result in an error.
+1. Ensure that you follow the rule mentioned on https://gethomepage.dev/latest/configs/service-widgets/. **Unless otherwise noted, URLs should not end with a / or other API path. Each widget will handle the path on its own.**. This is very important as including a trailing slash can result in an error.
-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.:
+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
@@ -27,10 +27,10 @@ All service widgets work essentially the same, that is, homepage makes a proxied
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.
+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`).
diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css
index 0756f278..f7a8217e 100644
--- a/docs/stylesheets/extra.css
+++ b/docs/stylesheets/extra.css
@@ -17,4 +17,4 @@
color: var(--md-default-bg-color--lighter);
border-color: var(--md-default-bg-color--lighter);
}
-}
\ No newline at end of file
+}
diff --git a/docs/widgets/info/datetime.md b/docs/widgets/info/datetime.md
index 47feb45f..71ea007b 100644
--- a/docs/widgets/info/datetime.md
+++ b/docs/widgets/info/datetime.md
@@ -9,9 +9,9 @@ Formatting is locale aware and will present your date in the regional format you
```yaml
- datetime:
- text_size: xl
- format:
- timeStyle: short
+ text_size: xl
+ format:
+ timeStyle: short
```
Any options passed to `format` are passed directly to [Intl.DateTimeFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat), please reference the MDN documentation for all available options.
@@ -23,29 +23,29 @@ A few examples,
```yaml
# 13:37
format:
- timeStyle: short
- hourCycle: h23
+ timeStyle: short
+ hourCycle: h23
```
```yaml
# 1:37 PM
format:
- timeStyle: short
- hour12: true
+ timeStyle: short
+ hour12: true
```
```yaml
# 1/23/22, 1:37 PM
format:
- dateStyle: short
- timeStyle: short
- hour12: true
+ dateStyle: short
+ timeStyle: short
+ hour12: true
```
```yaml
# 4 januari 2023 om 13:51:25 PST
locale: nl
format:
- dateStyle: long
- timeStyle: long
+ dateStyle: long
+ timeStyle: long
```
diff --git a/docs/widgets/info/glances.md b/docs/widgets/info/glances.md
index e5cbc7bc..e6fc2a61 100644
--- a/docs/widgets/info/glances.md
+++ b/docs/widgets/info/glances.md
@@ -9,16 +9,16 @@ The Glances widget allows you to monitor the resources (CPU, memory, storage, te
```yaml
- glances:
- url: http://host.or.ip:port
- username: user # optional if auth enabled in Glances
- password: pass # optional if auth enabled in Glances
- cpu: true # optional, enabled by default, disable by setting to false
- mem: true # optional, enabled by default, disable by setting to false
- cputemp: true # disabled by default
- uptime: true # disabled by default
- disk: / # disabled by default, use mount point of disk(s) in glances. Can also be a list (see below)
- expanded: true # show the expanded view
- label: MyMachine # optional
+ url: http://host.or.ip:port
+ username: user # optional if auth enabled in Glances
+ password: pass # optional if auth enabled in Glances
+ cpu: true # optional, enabled by default, disable by setting to false
+ mem: true # optional, enabled by default, disable by setting to false
+ cputemp: true # disabled by default
+ uptime: true # disabled by default
+ disk: / # disabled by default, use mount point of disk(s) in glances. Can also be a list (see below)
+ expanded: true # show the expanded view
+ label: MyMachine # optional
```
Multiple disks can be specified as:
diff --git a/docs/widgets/info/greeting.md b/docs/widgets/info/greeting.md
index 0902814a..8a11290c 100644
--- a/docs/widgets/info/greeting.md
+++ b/docs/widgets/info/greeting.md
@@ -7,8 +7,8 @@ This allows you to display simple text, can be configured like so:
```yaml
- greeting:
- text_size: xl
- text: Greeting Text
+ text_size: xl
+ text: Greeting Text
```
Valid text sizes are `4xl`, `3xl`, `2xl`, `xl`, `md`, `sm`, `xs`.
diff --git a/docs/widgets/info/kubernetes.md b/docs/widgets/info/kubernetes.md
index d424a9c4..36096579 100644
--- a/docs/widgets/info/kubernetes.md
+++ b/docs/widgets/info/kubernetes.md
@@ -9,23 +9,23 @@ It provides CPU and Memory usage, by node and/or at the cluster level.
```yaml
- kubernetes:
- cluster:
- # Shows cluster-wide statistics
- show: true
- # Shows the aggregate CPU stats
- cpu: true
- # Shows the aggregate memory stats
- memory: true
- # Shows a custom label
- showLabel: true
- label: "cluster"
- nodes:
- # Shows node-specific statistics
- show: true
- # Shows the CPU for each node
- cpu: true
- # Shows the memory for each node
- memory: true
- # Shows the label, which is always the node name
- showLabel: true
+ cluster:
+ # Shows cluster-wide statistics
+ show: true
+ # Shows the aggregate CPU stats
+ cpu: true
+ # Shows the aggregate memory stats
+ memory: true
+ # Shows a custom label
+ showLabel: true
+ label: "cluster"
+ nodes:
+ # Shows node-specific statistics
+ show: true
+ # Shows the CPU for each node
+ cpu: true
+ # Shows the memory for each node
+ memory: true
+ # Shows the label, which is always the node name
+ showLabel: true
```
diff --git a/docs/widgets/info/longhorn.md b/docs/widgets/info/longhorn.md
index 4c7bbdbe..e25c844b 100644
--- a/docs/widgets/info/longhorn.md
+++ b/docs/widgets/info/longhorn.md
@@ -12,18 +12,18 @@ It can show the aggregate metrics and/or the individual node metrics.
```yaml
- longhorn:
- # Show the expanded view
- expanded: true
- # Shows a node representing the aggregate values
- total: true
- # Shows the node names as labels
- labels: true
- # Show the nodes
- nodes: true
- # An explicit list of nodes to show. All are shown by default if "nodes" is true
- include:
- - node1
- - node2
+ # Show the expanded view
+ expanded: true
+ # Shows a node representing the aggregate values
+ total: true
+ # Shows the node names as labels
+ labels: true
+ # Show the nodes
+ nodes: true
+ # An explicit list of nodes to show. All are shown by default if "nodes" is true
+ include:
+ - node1
+ - node2
```
The Longhorn URL and credentials are stored in the `providers` section of the `settings.yaml`.
diff --git a/docs/widgets/info/openmeteo.md b/docs/widgets/info/openmeteo.md
index db1daac3..4cc49e26 100644
--- a/docs/widgets/info/openmeteo.md
+++ b/docs/widgets/info/openmeteo.md
@@ -7,12 +7,12 @@ No registration is required at all! See [https://open-meteo.com/en/docs](https:/
```yaml
- openmeteo:
- label: Kyiv # optional
- latitude: 50.449684
- longitude: 30.525026
- timezone: Europe/Kiev # optional
- units: metric # or imperial
- cache: 5 # Time in minutes to cache API responses, to stay within limits
+ label: Kyiv # optional
+ latitude: 50.449684
+ longitude: 30.525026
+ timezone: Europe/Kiev # optional
+ units: metric # or imperial
+ 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/info/openweathermap.md b/docs/widgets/info/openweathermap.md
index 63e7295d..8c972988 100644
--- a/docs/widgets/info/openweathermap.md
+++ b/docs/widgets/info/openweathermap.md
@@ -7,13 +7,13 @@ The free tier "One Call API" is all thats required, you will need to [subscribe]
```yaml
- openweathermap:
- label: Kyiv #optional
- latitude: 50.449684
- longitude: 30.525026
- units: metric # or imperial
- provider: openweathermap
- apiKey: youropenweathermapkey # required only if not using provider, this reveals api key in requests
- cache: 5 # Time in minutes to cache API responses, to stay within limits
+ label: Kyiv #optional
+ latitude: 50.449684
+ longitude: 30.525026
+ units: metric # or imperial
+ provider: openweathermap
+ apiKey: youropenweathermapkey # required only if not using provider, this reveals api key in requests
+ 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/info/resources.md b/docs/widgets/info/resources.md
index 43dea381..fb4678bc 100644
--- a/docs/widgets/info/resources.md
+++ b/docs/widgets/info/resources.md
@@ -15,26 +15,26 @@ _Note: unfortunately, the package used for getting CPU temp ([systeminformation]
```yaml
- resources:
- cpu: true
- memory: true
- disk: /disk/mount/path
- cputemp: true
- uptime: true
- units: imperial # only used by cpu temp
- refresh: 3000 # optional, in ms
+ cpu: true
+ memory: true
+ disk: /disk/mount/path
+ cputemp: true
+ uptime: true
+ units: imperial # only used by cpu temp
+ refresh: 3000 # optional, in ms
```
You can also pass a `label` option, which allows you to group resources under named sections,
```yaml
- resources:
- label: System
- cpu: true
- memory: true
+ label: System
+ cpu: true
+ memory: true
- resources:
- label: Storage
- disk: /mnt/storage
+ label: Storage
+ disk: /mnt/storage
```
Which produces something like this,
@@ -45,11 +45,11 @@ If you have more than a single disk and would like to group them together under
```yaml
- resources:
- label: Storage
- disk:
- - /mnt/storage
- - /mnt/backup
- - /mnt/media
+ label: Storage
+ disk:
+ - /mnt/storage
+ - /mnt/backup
+ - /mnt/media
```
To produce something like this,
@@ -60,12 +60,12 @@ You can additionally supply an optional `expanded` property set to true in order
```yaml
- resources:
- label: Array Disks
- expanded: true
- disk:
- - /disk1
- - /disk2
- - /disk3
+ label: Array Disks
+ expanded: true
+ disk:
+ - /disk1
+ - /disk2
+ - /disk3
```
diff --git a/docs/widgets/info/search.md b/docs/widgets/info/search.md
index a03d711c..a9851bb1 100644
--- a/docs/widgets/info/search.md
+++ b/docs/widgets/info/search.md
@@ -7,25 +7,25 @@ You can add a search bar to your top widget area that can search using Google, D
```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
+ 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
+ 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]
+ provider: [brave, google, duckduckgo]
```
_Added in v0.1.6, updated in 0.6.0_
diff --git a/docs/widgets/info/weather.md b/docs/widgets/info/weather.md
index 338ca256..4893089e 100644
--- a/docs/widgets/info/weather.md
+++ b/docs/widgets/info/weather.md
@@ -9,12 +9,12 @@ The free tier is all thats required, you will need to [register](https://www.wea
```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
+ 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
index 57fad6a6..af922f77 100644
--- a/docs/widgets/services/adguard-home.md
+++ b/docs/widgets/services/adguard-home.md
@@ -9,8 +9,8 @@ Allowed fields: `["queries", "blocked", "filtered", "latency"]`.
```yaml
widget:
- type: adguard
- url: http://adguard.host.or.ip
- username: admin
- password: password
+ 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
index 06126f2e..77432216 100644
--- a/docs/widgets/services/atsumeru.md
+++ b/docs/widgets/services/atsumeru.md
@@ -9,8 +9,8 @@ Allowed fields: `["series", "archives", "chapters", "categories"]`.
```yaml
widget:
- type: atsumeru
- url: http://atsumeru.host.or.ip:port
- username: username
- password: password
+ 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
index 73e2b744..10beec24 100644
--- a/docs/widgets/services/audiobookshelf.md
+++ b/docs/widgets/services/audiobookshelf.md
@@ -9,7 +9,7 @@ Allowed fields: `["podcasts", "podcastsDuration", "books", "booksDuration"]`
```yaml
widget:
- type: audiobookshelf
- url: http://audiobookshelf.host.or.ip:port
- key: audiobookshelflapikey
+ 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
index 306107e0..b3f8cdd6 100644
--- a/docs/widgets/services/authentik.md
+++ b/docs/widgets/services/authentik.md
@@ -18,7 +18,7 @@ Allowed fields: `["users", "loginsLast24H", "failedLoginsLast24H"]`.
```yaml
widget:
- type: authentik
- url: http://authentik.host.or.ip:22070
- key: api_token
+ 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
index ba034d2a..d41d7c32 100644
--- a/docs/widgets/services/autobrr.md
+++ b/docs/widgets/services/autobrr.md
@@ -9,7 +9,7 @@ Allowed fields: `["approvedPushes", "rejectedPushes", "filters", "indexers"]`.
```yaml
widget:
- type: autobrr
- url: http://autobrr.host.or.ip
- key: apikeyapikeyapikeyapikeyapikey
+ type: autobrr
+ url: http://autobrr.host.or.ip
+ key: apikeyapikeyapikeyapikeyapikey
```
diff --git a/docs/widgets/services/azuredevops.md b/docs/widgets/services/azuredevops.md
index a9142731..32ff2296 100644
--- a/docs/widgets/services/azuredevops.md
+++ b/docs/widgets/services/azuredevops.md
@@ -15,12 +15,12 @@ You will need to generate a personal access token for an existing user, see the
```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
+ 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
index 3a48821e..ac1a95c8 100644
--- a/docs/widgets/services/bazarr.md
+++ b/docs/widgets/services/bazarr.md
@@ -9,7 +9,7 @@ Allowed fields: `["missingEpisodes", "missingMovies"]`.
```yaml
widget:
- type: bazarr
- url: http://bazarr.host.or.ip
- key: apikeyapikeyapikeyapikeyapikey
+ type: bazarr
+ url: http://bazarr.host.or.ip
+ key: apikeyapikeyapikeyapikeyapikey
```
diff --git a/docs/widgets/services/caddy.md b/docs/widgets/services/caddy.md
index 52c1d462..c85d1d9a 100644
--- a/docs/widgets/services/caddy.md
+++ b/docs/widgets/services/caddy.md
@@ -7,6 +7,6 @@ Allowed fields: `["upstreams", "requests", "requests_failed"]`.
```yaml
widget:
- type: caddy
- url: http://caddy.host.or.ip:adminport # default admin port is 2019
+ type: caddy
+ url: http://caddy.host.or.ip:adminport # default admin port is 2019
```
diff --git a/docs/widgets/services/calibre-web.md b/docs/widgets/services/calibre-web.md
index f9090f8d..5de503e6 100644
--- a/docs/widgets/services/calibre-web.md
+++ b/docs/widgets/services/calibre-web.md
@@ -9,8 +9,8 @@ Allowed fields: `["books", "authors", "categories", "series"]`.
```yaml
widget:
- type: calibreweb
- url: http://your.calibreweb.host:port
- username: username
- password: password
+ 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
index 674db9a8..060043fd 100644
--- a/docs/widgets/services/changedetectionio.md
+++ b/docs/widgets/services/changedetectionio.md
@@ -7,7 +7,7 @@ Find your API key under `Settings > API`.
```yaml
widget:
- type: changedetectionio
- url: http://changedetection.host.or.ip:port
- key: apikeyapikeyapikeyapikeyapikey
+ 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
index 390df42c..59edaac5 100644
--- a/docs/widgets/services/channelsdvrserver.md
+++ b/docs/widgets/services/channelsdvrserver.md
@@ -5,6 +5,6 @@ description: Channels DVR Server Widget Configuration
```yaml
widget:
- type: channelsdvrserver
- url: http://192.168.1.55:8089
+ type: channelsdvrserver
+ url: http://192.168.1.55:8089
```
diff --git a/docs/widgets/services/cloudflared.md b/docs/widgets/services/cloudflared.md
index 3212a278..663d0d6e 100644
--- a/docs/widgets/services/cloudflared.md
+++ b/docs/widgets/services/cloudflared.md
@@ -9,8 +9,8 @@ Allowed fields: `["status", "origin_ip"]`.
```yaml
widget:
- type: cloudflared
- accountid: accountid # from zero trust dashboard url e.g. https://one.dash.cloudflare.com/{service.description}
++ {service.description} +
{service.description}
++ {service.description} +