mirror of
https://github.com/DI0IK/homepage-plus.git
synced 2025-07-07 14:18:47 +00:00
Merge branch 'dev'
This commit is contained in:
shamoon
commit
b2d75a99e7
150 changed files with 1153 additions and 655 deletions
|
|
@ -55,7 +55,7 @@ self-hosted / open-source alternative, we ask that any widgets, etc. are develop
|
|||
|
||||
To ensure cohesiveness of various widgets, the following should be used as a guide for developing new widgets:
|
||||
|
||||
- Please only submit widgets that target a feature request discussion with at least 10 'up-votes'. The purpose of this requirement is to avoid the addition (and maintenance) of service widgets that might only benefit a small number of users.
|
||||
- Please only submit widgets that target a feature request discussion with at least 20 'up-votes'. The purpose of this requirement is to avoid the addition (and maintenance) of service widgets that might only benefit a small number of users.
|
||||
- Note that we reserve the right to decline widgets for projects that are very young (eg < ~1y) or those with a small reach (eg low GitHub stars). Again, this is in an effort to keep overall widget maintenance under control.
|
||||
- Widgets should be only one row of blocks
|
||||
- Widgets should be no more than 4 blocks wide and generally conform to the styling / design choices of other widgets
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ You can also pass API keys from the widget configuration to the proxy handler, f
|
|||
|
||||
### `credentialedProxyHandler`
|
||||
|
||||
A proxy handler that makes authenticated by setting request headers. Credentials are pulled from the widgets configuration.
|
||||
A proxy handler that makes authenticated requests by setting request headers. Credentials are pulled from the widgets configuration.
|
||||
|
||||
By default the key is passed as an `X-API-Key` header. If you need to pass the key as something else, either add a case to the credentialedProxyHandler or create a new proxy handler.
|
||||
|
||||
|
|
|
|||
|
|
@ -19,12 +19,17 @@ Service widgets are used to display the status of a service, often a web service
|
|||
description: Watch movies and TV shows.
|
||||
server: localhost
|
||||
container: plex
|
||||
widget:
|
||||
type: tautulli
|
||||
url: http://172.16.1.1:8181
|
||||
key: aabbccddeeffgghhiijjkkllmmnnoo
|
||||
widgets:
|
||||
- type: tautulli
|
||||
url: http://172.16.1.1:8181
|
||||
key: aabbccddeeffgghhiijjkkllmmnnoo
|
||||
- type: uptimekuma
|
||||
url: http://172.16.1.2:8080
|
||||
slug: aaaaaaabbbbb
|
||||
```
|
||||
|
||||
More detail on configuring service widgets can be found in the [Service Widgets Config](../configs/services.md) section.
|
||||
|
||||
## Info Widgets
|
||||
|
||||
Info widgets are used to display information in the header, often about your system or environment. Info widgets are defined your `widgets.yaml` file. Here's an example:
|
||||
|
|
@ -36,3 +41,5 @@ Info widgets are used to display information in the header, often about your sys
|
|||
longitude: -117.51
|
||||
cache: 5
|
||||
```
|
||||
|
||||
More detail on configuring info widgets can be found in the [Info Widgets Config](../configs/info-widgets.md) section.
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ title: Open-Meteo
|
|||
description: Open-Meteo Information Widget Configuration
|
||||
---
|
||||
|
||||
No registration is required at all! See [https://open-meteo.com/en/docs](https://open-meteo.com/en/docs)
|
||||
Homepage's recommended weather widget. No registration is required at all! See [https://open-meteo.com/en/docs](https://open-meteo.com/en/docs)
|
||||
|
||||
```yaml
|
||||
- openmeteo:
|
||||
|
|
|
|||
|
|
@ -24,9 +24,10 @@ _Note: unfortunately, the package used for getting CPU temp ([systeminformation]
|
|||
tempmin: 0 # optional, minimum cpu temp
|
||||
tempmax: 100 # optional, maximum cpu temp
|
||||
uptime: true
|
||||
units: imperial # only used by cpu temp
|
||||
units: imperial # only used by cpu temp, options: 'imperial' or 'metric'
|
||||
refresh: 3000 # optional, in ms
|
||||
diskUnits: bytes # optional, bytes (default) or bbytes. Only applies to disk
|
||||
network: true # optional, uses 'default' if true or specify a network interface name
|
||||
```
|
||||
|
||||
You can also pass a `label` option, which allows you to group resources under named sections,
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ _(Find the Unifi Controller service widget [here](../services/unifi-controller.m
|
|||
|
||||
You can display general connectivity status from your Unifi (Network) Controller.
|
||||
|
||||
!!!
|
||||
!!! warning
|
||||
|
||||
When authenticating you will want to use a local account that has at least read privileges.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,22 +0,0 @@
|
|||
---
|
||||
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 that's 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
|
||||
format: # optional, Intl.NumberFormat options
|
||||
maximumFractionDigits: 1
|
||||
```
|
||||
|
||||
You can optionally not pass a `latitude` and `longitude` and the widget will use your current location (requires a secure context, eg. HTTPS).
|
||||
|
|
@ -12,6 +12,11 @@ The `systemID` in the `id` field on the collections page of Beszel.
|
|||
Allowed fields for 'overview' mode: `["systems", "up"]`
|
||||
Allowed fields for a single system: `["name", "status", "updated", "cpu", "memory", "disk", "network"]`
|
||||
|
||||
| Beszel Version | Homepage Widget Version |
|
||||
| -------------- | ----------------------- |
|
||||
| < 0.9.0 | 1 (default) |
|
||||
| >= 0.9.0 | 2 |
|
||||
|
||||
```yaml
|
||||
widget:
|
||||
type: beszel
|
||||
|
|
@ -19,4 +24,5 @@ widget:
|
|||
username: username # email
|
||||
password: password
|
||||
systemId: systemId # optional
|
||||
version: 2 # optional, default is 1
|
||||
```
|
||||
|
|
|
|||
|
|
@ -14,4 +14,5 @@ widget:
|
|||
type: deluge
|
||||
url: http://deluge.host.or.ip
|
||||
password: password # webui password
|
||||
enableLeechProgress: true # optional, defaults to false
|
||||
```
|
||||
|
|
|
|||
|
|
@ -16,5 +16,6 @@ To group both `offline` and `unknown` devices together, users should use the `of
|
|||
widget:
|
||||
type: esphome
|
||||
url: http://esphome.host.or.ip:port
|
||||
key: myesphomecookie # only if auth enabled, get the value from a request from the frontend e.g. `authenticated=myesphomecookie`
|
||||
username: myesphomeuser # only if auth enabled
|
||||
password: myesphomepass # only if auth enabled
|
||||
```
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ title: EVCC
|
|||
description: EVCC Widget Configuration
|
||||
---
|
||||
|
||||
Learn more about [EVSS](https://github.com/evcc-io/evcc).
|
||||
Learn more about [EVCC](https://github.com/evcc-io/evcc).
|
||||
|
||||
Allowed fields: `["pv_power", "grid_power", "home_power", "charge_power]`.
|
||||
|
||||
|
|
|
|||
|
|
@ -51,6 +51,8 @@ The metric field in the configuration determines the type of system monitoring d
|
|||
|
||||
`process`: Top 5 processes based on CPU usage. Gives an overview of which processes are consuming the most resources.
|
||||
|
||||
`containers`: Docker or Kubernetes containers list. Shows up to 5 containers running on the system and their resource usage.
|
||||
|
||||
`network:<interface_name>`: Network data usage for the specified interface. Replace `<interface_name>` with the name of your network interface, e.g., `network:enp0s25`, as specified in glances.
|
||||
|
||||
`sensor:<sensor_id>`: Temperature of the specified sensor, typically used to monitor CPU temperature. Replace `<sensor_id>` with the name of your sensor, e.g., `sensor:Package id 0` as specified in glances.
|
||||
|
|
|
|||
|
|
@ -15,4 +15,5 @@ widget:
|
|||
url: http://qbittorrent.host.or.ip
|
||||
username: username
|
||||
password: password
|
||||
enableLeechProgress: true # optional, defaults to false
|
||||
```
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ _(Find the Unifi Controller information widget [here](../info/unifi_controller.m
|
|||
|
||||
You can display general connectivity status from your Unifi (Network) Controller.
|
||||
|
||||
!!!
|
||||
!!! warning
|
||||
|
||||
When authenticating you will want to use a local account that has at least read privileges.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue