mirror of
https://github.com/gethomepage/homepage.git
synced 2025-12-05 21:47:48 +01:00
Merge branch 'dev'
This commit is contained in:
@@ -20,7 +20,7 @@ Since Docker supports connecting with TLS and client certificate authentication,
|
||||
```yaml
|
||||
my-remote-docker:
|
||||
host: 192.168.0.101
|
||||
port: 275
|
||||
port: 2375
|
||||
tls:
|
||||
keyFile: tls/key.pem
|
||||
caFile: tls/ca.pem
|
||||
@@ -66,6 +66,30 @@ my-docker:
|
||||
port: 2375
|
||||
```
|
||||
|
||||
Use `protocol: https` if you’re connecting through a reverse proxy (e.g., Traefik) that serves the Docker API over HTTPS:
|
||||
|
||||
```yaml
|
||||
my-docker:
|
||||
host: dockerproxy
|
||||
port: 443
|
||||
protocol: https
|
||||
```
|
||||
|
||||
!!! note
|
||||
|
||||
Note: This does not require TLS certificates if the proxy handles encryption. Do not use `protocol: https` unless you’re sure the target host supports HTTPS.
|
||||
|
||||
You can also include `headers` for the connection, for example, if you are using a reverse proxy that requires authentication:
|
||||
|
||||
```yaml
|
||||
my-docker:
|
||||
host: dockerproxy
|
||||
port: 443
|
||||
protocol: https
|
||||
headers:
|
||||
Authorization: Basic <base64-encoded-credentials>
|
||||
```
|
||||
|
||||
## 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.
|
||||
|
||||
@@ -163,6 +163,18 @@ If the `href` attribute is not present, Homepage will ignore the specific Ingres
|
||||
|
||||
Homepage also features automatic service discovery for Gateway API. Service definitions are read by annotating the HttpRoute custom resource definition and are indentical to the Ingress example as defined in [Automatic Service Discovery](#automatic-service-discovery).
|
||||
|
||||
To enable Gateway API HttpRoute update `kubernetes.yaml` to include:
|
||||
|
||||
```
|
||||
gateway: true # enable gateway-api
|
||||
```
|
||||
|
||||
#### Using the unoffocial helm chart?
|
||||
|
||||
If you are using the unofficial helm chart ensure that the `ClusterRole` has required permissions for `gateway.networking.k8s.io`.
|
||||
|
||||
See [ClusterRole and ClusterRoleBinding](../installation/k8s.md#clusterrole-and-clusterrolebinding)
|
||||
|
||||
## 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`.
|
||||
|
||||
@@ -101,7 +101,7 @@ 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:
|
||||
You can configure a fixed color palette (and disable the palette switcher) by passing the `color` option, like so:
|
||||
|
||||
```yaml
|
||||
color: slate
|
||||
|
||||
17
docs/widgets/services/checkmk.md
Normal file
17
docs/widgets/services/checkmk.md
Normal file
@@ -0,0 +1,17 @@
|
||||
---
|
||||
title: Checkmk
|
||||
description: Checkmk Widget Configuration
|
||||
---
|
||||
|
||||
Learn more about [Checkmk](https://github.com/Checkmk/checkmk).
|
||||
|
||||
To setup authentication, follow the official [Checkmk API](https://docs.checkmk.com/latest/en/rest_api.html?lquery=api#bearerauth) documentation.
|
||||
|
||||
```yaml
|
||||
widget:
|
||||
type: checkmk
|
||||
url: http://checkmk.host.or.ip:port
|
||||
site: your-site-name-cla-by-default
|
||||
username: username
|
||||
password: password
|
||||
```
|
||||
@@ -14,4 +14,5 @@ widget:
|
||||
type: gamedig
|
||||
serverType: csgo # see https://github.com/gamedig/node-gamedig#games-list
|
||||
url: udp://server.host.or.ip:port
|
||||
gameToken: # optional, a token used by gamedig with certain games
|
||||
```
|
||||
|
||||
@@ -9,7 +9,7 @@ Learn more about [Gluetun](https://github.com/qdm12/gluetun).
|
||||
|
||||
Requires [HTTP control server options](https://github.com/qdm12/gluetun-wiki/blob/main/setup/advanced/control-server.md) to be enabled. By default this runs on port `8000`.
|
||||
|
||||
Allowed fields: `["public_ip", "region", "country"]`.
|
||||
Allowed fields: `["public_ip", "region", "country", "port_forwarded"]`.
|
||||
|
||||
To setup authentication, follow [the official Gluetun documentation](https://github.com/qdm12/gluetun-wiki/blob/main/setup/advanced/control-server.md#authentication). Note that to use the api key method, you must add the route `GET /v1/publicip/ip` to the `routes` array in your Gluetun config.toml.
|
||||
|
||||
|
||||
18
docs/widgets/services/jellystat.md
Normal file
18
docs/widgets/services/jellystat.md
Normal file
@@ -0,0 +1,18 @@
|
||||
---
|
||||
title: Jellystat
|
||||
description: Jellystat Widget Configuration
|
||||
---
|
||||
|
||||
Learn more about [Jellystat](https://github.com/CyferShepard/Jellystat). The widget supports (at least) Jellystat version 1.1.6
|
||||
|
||||
You can create an API key from inside Jellystat at `Settings > API Key`.
|
||||
|
||||
Allowed fields: `["songs", "movies", "episodes", "other"]`.
|
||||
|
||||
```yaml
|
||||
widget:
|
||||
type: jellystat
|
||||
url: http://jellystat.host.or.ip
|
||||
key: apikeyapikeyapikeyapikeyapikey
|
||||
days: 30 # optional, defaults to 30
|
||||
```
|
||||
Reference in New Issue
Block a user