mirror of
https://github.com/gethomepage/homepage.git
synced 2026-02-07 16:30:52 +08:00
Merge branch 'dev'
This commit is contained in:
18
docs/widgets/services/arcane.md
Normal file
18
docs/widgets/services/arcane.md
Normal file
@@ -0,0 +1,18 @@
|
||||
---
|
||||
title: Arcane
|
||||
description: Arcane Widget Configuration
|
||||
---
|
||||
|
||||
Learn more about [Arcane](https://github.com/getarcaneapp/arcane).
|
||||
|
||||
**Allowed fields** (max 4): `running`, `stopped`, `total`, `images`, `images_used`, `images_unused`, `image_updates`.
|
||||
**Default fields**: `running`, `stopped`, `total`, `image_updates`.
|
||||
|
||||
```yaml
|
||||
widget:
|
||||
type: arcane
|
||||
url: http://localhost:3552
|
||||
env: 0 # required, 0 is Arcane default local environment
|
||||
key: your-api-key
|
||||
fields: ["running", "stopped", "total", "image_updates"] # optional
|
||||
```
|
||||
17
docs/widgets/services/dispatcharr.md
Normal file
17
docs/widgets/services/dispatcharr.md
Normal file
@@ -0,0 +1,17 @@
|
||||
---
|
||||
title: Dispatcharr
|
||||
description: Dispatcharr Widget Configuration
|
||||
---
|
||||
|
||||
Learn more about [Dispatcharr](https://github.com/Dispatcharr/Dispatcharr).
|
||||
|
||||
Allowed fields: `["channels", "streams"]`.
|
||||
|
||||
```yaml
|
||||
widget:
|
||||
type: dispatcharr
|
||||
url: http://dispatcharr.host.or.ip
|
||||
username: username
|
||||
password: password
|
||||
enableActiveStreams: true # optional, defaults to false
|
||||
```
|
||||
20
docs/widgets/services/dockhand.md
Normal file
20
docs/widgets/services/dockhand.md
Normal file
@@ -0,0 +1,20 @@
|
||||
---
|
||||
title: Dockhand
|
||||
description: Dockhand Widget Configuration
|
||||
---
|
||||
|
||||
Learn more about [Dockhand](https://dockhand.pro/).
|
||||
|
||||
Note: The widget currently supports Dockhand's **local** authentication only.
|
||||
|
||||
**Allowed fields:** (max 4): `running`, `stopped`, `paused`, `total`, `cpu`, `memory`, `images`, `volumes`, `events_today`, `pending_updates`, `stacks`.
|
||||
**Default fields:** `running`, `total`, `cpu`, `memory`.
|
||||
|
||||
```yaml
|
||||
widget:
|
||||
type: dockhand
|
||||
url: http://localhost:3001
|
||||
environment: local # optional: name or id; aggregates all when omitted
|
||||
username: your-user # required for local auth
|
||||
password: your-pass # required for local auth
|
||||
```
|
||||
@@ -9,6 +9,7 @@ You can also find a list of all available service widgets in the sidebar navigat
|
||||
|
||||
- [Adguard Home](adguard-home.md)
|
||||
- [APC UPS](apcups.md)
|
||||
- [Arcane](arcane.md)
|
||||
- [ArgoCD](argocd.md)
|
||||
- [Atsumeru](atsumeru.md)
|
||||
- [Audiobookshelf](audiobookshelf.md)
|
||||
@@ -32,6 +33,8 @@ You can also find a list of all available service widgets in the sidebar navigat
|
||||
- [Deluge](deluge.md)
|
||||
- [DeveLanCacheUI](develancacheui.md)
|
||||
- [DiskStation](diskstation.md)
|
||||
- [Dispatcharr](dispatcharr.md)
|
||||
- [Dockhand](dockhand.md)
|
||||
- [DownloadStation](downloadstation.md)
|
||||
- [Emby](emby.md)
|
||||
- [ESPHome](esphome.md)
|
||||
|
||||
@@ -9,11 +9,17 @@ You can create an API key from inside Jellyfin at `Settings > Advanced > Api Key
|
||||
|
||||
As of v0.6.11 the widget supports fields `["movies", "series", "episodes", "songs"]`. These blocks are disabled by default but can be enabled with the `enableBlocks` option, and the "Now Playing" feature (enabled by default) can be disabled with the `enableNowPlaying` option.
|
||||
|
||||
| Jellyfin Version | Homepage Widget Version |
|
||||
| ---------------- | ----------------------- |
|
||||
| < 10.12 | 1 (default) |
|
||||
| >= 10.12 | 2 |
|
||||
|
||||
```yaml
|
||||
widget:
|
||||
type: jellyfin
|
||||
url: http://jellyfin.host.or.ip
|
||||
key: apikeyapikeyapikeyapikeyapikey
|
||||
version: 2 # optional, default is 1
|
||||
enableBlocks: true # optional, defaults to false
|
||||
enableNowPlaying: true # optional, defaults to true
|
||||
enableUser: true # optional, defaults to false
|
||||
|
||||
@@ -9,10 +9,16 @@ Allowed fields: `["projects", "tasks7d", "tasksOverdue", "tasksInProgress"]`.
|
||||
|
||||
A list of the next 5 tasks ordered by due date is disabled by default, but can be enabled with the `enableTaskList` option.
|
||||
|
||||
| Vikunja Version | Homepage Widget Version |
|
||||
| --------------- | ----------------------- |
|
||||
| < v1.0.0-rc4 | 1 (default) |
|
||||
| >= v1.0.0-rc4 | 2 |
|
||||
|
||||
```yaml
|
||||
widget:
|
||||
type: vikunja
|
||||
url: http[s]://vikunja.host.or.ip[:port]
|
||||
key: vikunjaapikey
|
||||
enableTaskList: true # optional, defaults to false
|
||||
version: 2 # optional, defaults to 1
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user