Merge branch 'gethomepage:main' into feature/auth_viz

pull/2849/head
Aaron Dalton 4 months ago committed by GitHub
commit 4f3fd81619
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -0,0 +1,49 @@
body:
- type: textarea
id: description
attributes:
label: Description
description: A clear and concise description of the issue or question. If applicable, add screenshots to help explain your problem.
validations:
required: true
- type: input
id: version
attributes:
label: homepage version
placeholder: e.g. v0.4.18 (4ea2798)
validations:
required: true
- type: dropdown
id: install-method
attributes:
label: Installation method
options:
- Docker
- Unraid
- Source
- Other (please describe above)
validations:
required: true
- type: textarea
id: config
attributes:
label: Configuration
description: Please provide any relevant service, widget or otherwise related configuration here
render: yaml
- type: textarea
id: container-logs
attributes:
label: Container Logs
description: Please review and provide any logs from the container, if relevant
- type: textarea
id: browser-logs
attributes:
label: Browser Logs
description: Please review and provide any logs from the browser, if relevant
- type: textarea
id: troubleshooting
attributes:
label: Troubleshooting
description: Please include output from your [troubleshooting tests](https://gethomepage.dev/latest/more/troubleshooting/#service-widget-errors), if relevant.
validations:
required: true

@ -1,3 +1,2 @@
github: benphelps
ko_fi: benphelps
custom: ["https://paypal.me/phelpsben"]
github: [gethomepage, benphelps, shamoon]
open_collective: homepage

@ -1,99 +0,0 @@
name: Bug report
description: Create a report to help us improve
title: "[Bug] Concise description of the issue"
labels: ["bug, unconfirmed"]
body:
- type: markdown
attributes:
value: |
## ⚠️ Please remember: issues are for *bugs*
That is, something you believe affects every single homepage user, not just you. Otherwise, start with one of the other options below.
- type: markdown
attributes:
value: |
Have a question? 👉 [Start a new discussion](https://github.com/gethomepage/homepage/discussions/new) or [ask in chat](https://discord.gg/SaPGSzrEZC).
Before opening an issue, please double check:
- [The troubleshooting guide](https://gethomepage.dev/latest/more/troubleshooting/).
- [The homepage documentation](https://gethomepage.dev/)
- [Existing issues](https://github.com/gethomepage/homepage/search?q=&type=issues) and [discussions](https://github.com/gethomepage/homepage/search?q=&type=discussions).
- type: textarea
id: description
attributes:
label: Description
description: A clear and concise description of what the bug is. If applicable, add screenshots to help explain your problem.
placeholder: |
Currently homepage does not work when...
[Screenshot if applicable]
validations:
required: true
- type: textarea
id: reproduction
attributes:
label: Steps to reproduce
description: Steps to reproduce the behavior.
placeholder: |
1. Go to '...'
2. Click on '....'
3. See error
validations:
required: true
- type: input
id: version
attributes:
label: homepage version
placeholder: e.g. v0.4.18 (4ea2798)
validations:
required: true
- type: dropdown
id: install-method
attributes:
label: Installation method
options:
- Docker
- Unraid
- Source
- Other (please describe above)
validations:
required: true
- type: textarea
id: config
attributes:
label: Configuration
description: Please provide any relevant service, widget or otherwise related configuration here
render: yaml
- type: textarea
id: container-logs
attributes:
label: Container Logs
description: Please review and provide any logs from the container, if relevant
- type: textarea
id: browser-logs
attributes:
label: Browser Logs
description: Please review and provide any logs from the browser, if relevant
- type: textarea
id: troubleshooting
attributes:
label: Troubleshooting
description: Please include output from your [troubleshooting tests](https://gethomepage.dev/latest/more/troubleshooting/#service-widget-errors). If this is a service widget issue and you do not include any information here your issue will be closed. If it is not, indicate e.g. 'n/a'
validations:
required: true
- type: textarea
id: other
attributes:
label: Other
description: Include any other relevant details. E.g. service version or API version, docker version, etc.
- type: checkboxes
id: pre-flight
attributes:
label: Before submitting, I have made sure to
options:
- label: Check [the documentation](https://gethomepage.dev/)
required: true
- label: Follow [the troubleshooting guide](https://gethomepage.dev/latest/more/troubleshooting/) (please include output above if applicable).
required: true
- label: Search [existing issues](https://github.com/gethomepage/homepage/search?q=&type=issues) and [discussions](https://github.com/gethomepage/homepage/search?q=&type=discussions).
required: true

@ -2,7 +2,7 @@ blank_issues_enabled: false
contact_links:
- name: 🤔 Questions and Help
url: https://github.com/gethomepage/homepage/discussions
about: This issue tracker is for bugs only, not general support questions. Please refer to our Discussions.
about: For support or general questions.
- name: 💬 Chat
url: https://discord.gg/k4ruYNrudu
about: Want to discuss homepage with others? Check out our chat.

@ -5,7 +5,11 @@
version: 2
updates:
- package-ecosystem: "github-actions" # Maintain dependencies for GitHub Actions
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "daily"
- package-ecosystem: "npm"
directory: "/"
schedule:
interval: "monthly"

@ -0,0 +1,199 @@
name: 'Repository Maintenance'
on:
schedule:
- cron: '0 3 * * *'
workflow_dispatch:
permissions:
issues: write
pull-requests: write
discussions: write
concurrency:
group: lock
jobs:
stale:
name: 'Stale'
runs-on: ubuntu-latest
steps:
- uses: actions/stale@v9
with:
days-before-stale: 7
days-before-close: 14
stale-issue-label: stale
stale-pr-label: stale
stale-issue-message: >
This issue has been automatically marked as stale because it has not had
recent activity. It will be closed if no further activity occurs. Thank you
for your contributions.
lock-threads:
name: 'Lock Old Threads'
runs-on: ubuntu-latest
steps:
- uses: dessant/lock-threads@v5
with:
issue-inactive-days: '30'
pr-inactive-days: '30'
discussion-inactive-days: '30'
log-output: true
issue-comment: >
This issue has been automatically locked since there
has not been any recent activity after it was closed.
Please open a new discussion for related concerns.
pr-comment: >
This pull request has been automatically locked since there
has not been any recent activity after it was closed.
Please open a new discussion for related concerns.
discussion-comment: >
This discussion has been automatically locked since there
has not been any recent activity after it was closed.
Please open a new discussion for related concerns.
close-answered-discussions:
name: 'Close Answered Discussions'
runs-on: ubuntu-latest
steps:
- uses: actions/github-script@v7
with:
script: |
function sleep(ms) {
return new Promise(resolve => setTimeout(resolve, ms));
}
const query = `query($owner:String!, $name:String!) {
repository(owner:$owner, name:$name){
discussions(first:100, answered:true, states:[OPEN]) {
nodes {
id,
number
}
}
}
}`;
const variables = {
owner: context.repo.owner,
name: context.repo.repo,
}
const result = await github.graphql(query, variables)
console.log(`Found ${result.repository.discussions.nodes.length} open answered discussions`)
for (const discussion of result.repository.discussions.nodes) {
console.log(`Closing discussion #${discussion.number} (${discussion.id})`)
const addCommentMutation = `mutation($discussion:ID!, $body:String!) {
addDiscussionComment(input:{discussionId:$discussion, body:$body}) {
clientMutationId
}
}`;
const commentVariables = {
discussion: discussion.id,
body: 'This discussion has been automatically closed because it was marked as answered.',
}
await github.graphql(addCommentMutation, commentVariables)
const closeDiscussionMutation = `mutation($discussion:ID!, $reason:DiscussionCloseReason!) {
closeDiscussion(input:{discussionId:$discussion, reason:$reason}) {
clientMutationId
}
}`;
const closeVariables = {
discussion: discussion.id,
reason: "RESOLVED",
}
await github.graphql(closeDiscussionMutation, closeVariables)
await sleep(1000)
}
close-outdated-discussions:
name: 'Close Outdated Discussions'
runs-on: ubuntu-latest
steps:
- uses: actions/github-script@v7
with:
script: |
function sleep(ms) {
return new Promise(resolve => setTimeout(resolve, ms));
}
const CUTOFF_DAYS = 180;
const cutoff = new Date();
cutoff.setDate(cutoff.getDate() - CUTOFF_DAYS);
const query = `query(
$owner:String!,
$name:String!,
$supportCategory:ID!,
$generalCategory:ID!,
) {
supportDiscussions: repository(owner:$owner, name:$name){
discussions(
categoryId:$supportCategory,
last:50,
answered:false,
states:[OPEN],
) {
nodes {
id,
number,
updatedAt
}
},
},
generalDiscussions: repository(owner:$owner, name:$name){
discussions(
categoryId:$generalCategory,
last:50,
states:[OPEN],
) {
nodes {
id,
number,
updatedAt
}
}
}
}`;
const variables = {
owner: context.repo.owner,
name: context.repo.repo,
supportCategory: "DIC_kwDOH31rQM4CRErR",
generalCategory: "DIC_kwDOH31rQM4CRErQ"
}
const result = await github.graphql(query, variables);
const combinedDiscussions = [
...result.supportDiscussions.discussions.nodes,
...result.generalDiscussions.discussions.nodes,
]
console.log(`Checking ${combinedDiscussions.length} open discussions`);
for (const discussion of combinedDiscussions) {
if (new Date(discussion.updatedAt) < cutoff) {
console.log(`Closing outdated discussion #${discussion.number} (${discussion.id}), last updated at ${discussion.updatedAt}`);
const addCommentMutation = `mutation($discussion:ID!, $body:String!) {
addDiscussionComment(input:{discussionId:$discussion, body:$body}) {
clientMutationId
}
}`;
const commentVariables = {
discussion: discussion.id,
body: 'This discussion has been automatically closed due to inactivity.',
}
await github.graphql(addCommentMutation, commentVariables);
const closeDiscussionMutation = `mutation($discussion:ID!, $reason:DiscussionCloseReason!) {
closeDiscussion(input:{discussionId:$discussion, reason:$reason}) {
clientMutationId
}
}`;
const closeVariables = {
discussion: discussion.id,
reason: "OUTDATED",
}
await github.graphql(closeDiscussionMutation, closeVariables);
await sleep(1000);
}
}

@ -164,8 +164,6 @@ mkdocs serve # or build, to build the static site
If you have any questions, suggestions, or general issues, please start a discussion on the [Discussions](https://github.com/gethomepage/homepage/discussions) page.
For bug reports, please open an issue on the [Issues](https://github.com/gethomepage/homepage/issues) page.
## Contributing & Contributors
Contributions are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information.

@ -3,7 +3,7 @@ title: Bookmarks
description: Bookmark Configuration
---
Bookmarks function much the same as [Services](services.md), in how groups and lists work. They're just much simpler, smaller, and contain no extra features other than being a link out.
Bookmarks are configured in the `bookmarks.yaml` file. They function much the same as [Services](services.md), in how groups and lists work. They're just much simpler, smaller, and contain no extra features other than being a link out.
The design of homepage expects `abbr` to be 2 letters, but is not otherwise forced.
@ -12,6 +12,7 @@ You can also use an icon for bookmarks similar to the [options for service icons
By default, the description will use the hostname of the link, but you can override it with a custom description.
```yaml
---
- Developer:
- Github:
- abbr: GH
@ -29,4 +30,8 @@ By default, the description will use the hostname of the link, but you can overr
href: https://youtube.com/
```
which renders to (depending on your theme, etc.):
<img width="1000" alt="Bookmarks" src="https://user-images.githubusercontent.com/19408/269307009-d7e45885-230f-4e07-b421-9822017ae878.png">
The default [bookmarks.yaml](https://github.com/gethomepage/homepage/blob/main/src/skeleton/bookmarks.yaml) is a working example.

@ -359,12 +359,14 @@ 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.
- `showSearchSuggestions`: shows search suggestions for the internet search. This value will be inherited from the search widget if it is not specified. If it is not specified there either, it will default to false.
- `hideVisitURL`: disable detecting and offering an option to open URLs. This is false by default, enabling the feature.
```yaml
quicklaunch:
searchDescriptions: true
hideInternetSearch: true
showSearchSuggestions: true
hideVisitURL: true
```

@ -41,14 +41,15 @@ See the [pre-commit documentation](https://pre-commit.com/#install) to get start
## New Feature Guidelines
- New features should be linked to an existing feature request with at least 5 'up-votes'. The purpose of this requirement is to avoid the addition (and maintenance) of features that might only benefit a small number of users.
- New features should be linked to an existing feature request with at least 10 'up-votes'. The purpose of this requirement is to avoid the addition (and maintenance) of features that might only benefit a small number of users.
- If you have ideas for a larger feature, please open a discussion first.
- Please note that though it is a requirement, a discussion with 10 'up-votes' in no way guarantees that a PR will be merged.
## Service Widget Guidelines
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'. 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 have been requested and have 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.
- Widgets should be only one row of blocks
- Widgets should be no more than 4 blocks wide
- Minimize the number of API calls

@ -8,7 +8,7 @@ hide:
## Introducing the Homepage AI Bot
Thanks to the generous folks at [Glime](https://glimelab.ai), Homepage is now equipped with a pretty helpful AI-powered bot. The bot has full knowledge of our docs, GitHub issues and discussions and great at answering specific questions about setting up your Homepage. To use the bot, just hit the 'Ask AI' button on any page in our docs or check out the [#ai-support channel on Discord](https://discord.com/channels/1019316731635834932/1177885603552038993)!
Thanks to the generous folks at [Glime](https://glimelab.ai), Homepage is now equipped with a pretty clever AI-powered bot. The bot has full knowledge of our docs, GitHub issues and discussions and is great at answering specific questions about setting up your Homepage. To use the bot, just hit the 'Ask AI' button on any page in our docs, [open a GitHub discussion](https://github.com/gethomepage/homepage/discussions) or check out the [#ai-support channel on Discord](https://discord.com/channels/1019316731635834932/1177885603552038993)!
## General Troubleshooting Tips

@ -9,6 +9,7 @@ You can add a search bar to your top widget area that can search using Google, D
- search:
provider: google # google, duckduckgo, bing, baidu, brave or custom
focus: true # Optional, will set focus to the search bar on page load
showSearchSuggestions: true # Optional, will show search suggestions. Defaults to false
target: _blank # One of _self, _blank, _parent or _top
```
@ -17,8 +18,10 @@ or for a custom search:
```yaml
- search:
provider: custom
url: https://lougle.com/?q=
url: https://www.ecosia.org/search?q=
target: _blank
suggestionUrl: https://ac.ecosia.org/autocomplete?type=list&q= # Optional
showSearchSuggestions: true # Optional
```
multiple providers is also supported via a dropdown (excluding custom):
@ -28,4 +31,25 @@ multiple providers is also supported via a dropdown (excluding custom):
provider: [brave, google, duckduckgo]
```
The response body for the URL provided with the `suggestionUrl` option should look like this:
```json
[
"home",
[
"home depot",
"home depot near me",
"home equity loan",
"homeworkify",
"homedepot.com",
"homebase login",
"home depot credit card",
"home goods"
]
]
```
The first entry of the array contains the search query, the second one is an array of the suggestions.
In the example above, the search query was **home**.
_Added in v0.1.6, updated in 0.6.0_

@ -3,6 +3,8 @@ title: Adguard Home
description: Adguard Home Widget Configuration
---
Learn more about [Adguard Home](https://github.com/AdguardTeam/AdGuardHome).
The username and password are the same as used to login to the web interface.
Allowed fields: `["queries", "blocked", "filtered", "latency"]`.

@ -3,6 +3,8 @@ title: Atsumeru
description: Atsumeru Widget Configuration
---
Learn more about [Atsumeru](https://github.com/AtsumeruDev/Atsumeru).
Define same username and password that is used for login from web or supported apps
Allowed fields: `["series", "archives", "chapters", "categories"]`.

@ -3,6 +3,8 @@ title: Audiobookshelf
description: Audiobookshelf Widget Configuration
---
Learn more about [Audiobookshelf](https://github.com/advplyr/audiobookshelf).
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"]`

@ -3,6 +3,8 @@ title: Authentik
description: Authentik Widget Configuration
---
Learn more about [Authentik](https://github.com/goauthentik/authentik).
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:

@ -3,6 +3,8 @@ title: Autobrr
description: Autobrr Widget Configuration
---
Learn more about [Autobrr](https://github.com/autobrr/autobrr).
Find your API key under `Settings > API Keys`.
Allowed fields: `["approvedPushes", "rejectedPushes", "filters", "indexers"]`.

@ -3,6 +3,8 @@ title: Azure DevOps
description: Azure DevOps Widget Configuration
---
Learn more about [Azure DevOps](https://azure.microsoft.com/en-us/products/devops).
This widget has 2 functions:
1. Pipelines: checks if the relevant pipeline is running or not, and if not, reports the last status.\

@ -3,6 +3,8 @@ title: Bazarr
description: Bazarr Widget Configuration
---
Learn more about [Bazarr](https://github.com/morpheus65535/bazarr).
Find your API key under `Settings > General`.
Allowed fields: `["missingEpisodes", "missingMovies"]`.

@ -3,6 +3,8 @@ title: Caddy
description: Caddy Widget Configuration
---
Learn more about [Caddy](https://github.com/caddyserver/caddy).
Allowed fields: `["upstreams", "requests", "requests_failed"]`.
```yaml

@ -3,6 +3,8 @@ title: Calibre-web
description: Calibre-web Widget Configuration
---
Learn more about [Calibre-web](https://github.com/janeczku/calibre-web).
**Note: widget requires calibre-web ≥ v0.6.21.**
Allowed fields: `["books", "authors", "categories", "series"]`.

@ -3,6 +3,8 @@ title: Changedetection.io
description: Changedetection.io Widget Configuration
---
Learn more about [Changedetection.io](https://github.com/dgtlmoon/changedetection.io).
Find your API key under `Settings > API`.
```yaml

@ -3,6 +3,8 @@ title: Channels DVR Server
description: Channels DVR Server Widget Configuration
---
Learn more about [Channels DVR Server](https://getchannels.com/dvr-server/).
```yaml
widget:
type: channelsdvrserver

@ -3,6 +3,8 @@ title: Cloudflare Tunnels
description: Cloudflare Tunnels Widget Configuration
---
Learn more about [Cloudflare Tunnels](https://www.cloudflare.com/products/tunnel/).
_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"]`.

@ -3,6 +3,8 @@ title: Coin Market Cap
description: Coin Market Cap Widget Configuration
---
Learn more about [Coin Market Cap](https://coinmarketcap.com/api).
Get your API key from your [CoinMarketCap Pro Dashboard](https://pro.coinmarketcap.com/account).
Allowed fields: no configurable fields for this widget.
@ -16,7 +18,7 @@ widget:
defaultinterval: 7d # Optional
```
You can also specify slugs instead of symbols (since symbols aren't garaunteed to be unique). If you supply both, slugs will be used. For example:
You can also specify slugs instead of symbols (since symbols aren't guaranteed to be unique). If you supply both, slugs will be used. For example:
```yaml
widget:

@ -3,6 +3,8 @@ title: Deluge
description: Deluge Widget Configuration
---
Learn more about [Deluge](https://deluge-torrent.org/).
Uses the same password used to login to the webui, see [the deluge FAQ](https://dev.deluge-torrent.org/wiki/Faq#Whatisthedefaultpassword).
Allowed fields: `["leech", "download", "seed", "upload"]`.

@ -3,6 +3,8 @@ title: Synology Disk Station
description: Synology Disk Station Widget Configuration
---
Learn more about [Synology Disk Station](https://www.synology.com/en-global/dsm).
Note: the widget is not compatible with 2FA.
An optional 'volume' parameter can be supplied to specify which volume's free space to display when more than one volume exists. The value of the parameter must be in form of `volume_N`, e.g. to display free space for volume2, `volume_2` should be set as 'volume' value. If omitted, first returned volume's free space will be shown (not guaranteed to be volume1).

@ -3,6 +3,8 @@ title: Synology Download Station
description: Synology Download Station Widget Configuration
---
Learn more about [Synology Download Station](https://www.synology.com/en-us/dsm/packages/DownloadStation).
Note: the widget is not compatible with 2FA.
Allowed fields: `["leech", "download", "seed", "upload"]`.

@ -3,6 +3,8 @@ title: Emby
description: Emby Widget Configuration
---
Learn more about [Emby](https://github.com/MediaBrowser/Emby).
You can create an API key from inside Emby at `Settings > Advanced > Api Keys`.
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.

@ -3,6 +3,8 @@ title: EVCC
description: EVCC Widget Configuration
---
Learn more about [EVSS](https://github.com/evcc-io/evcc).
Allowed fields: `["pv_power", "grid_power", "home_power", "charge_power]`.
```yaml

@ -3,6 +3,8 @@ title: Fileflows
description: Fileflows Widget Configuration
---
Learn more about [FileFlows](https://github.com/revenz/FileFlows).
Allowed fields: `["queue", "processing", "processed", "time"]`.
```yaml

@ -3,6 +3,8 @@ title: Flood
description: Flood Widget Configuration
---
Learn more about [Flood](https://github.com/jesec/flood).
Allowed fields: `["leech", "download", "seed", "upload"]`.
```yaml

@ -3,6 +3,8 @@ title: FreshRSS
description: FreshRSS Widget Configuration
---
Learn more about [FreshRSS](https://github.com/FreshRSS/FreshRSS).
Please refer to [Enable the API in FreshRSS](https://freshrss.github.io/FreshRSS/en/users/06_Mobile_access.html#enable-the-api-in-freshrss) for the "API password" to be entered in the password field.
Allowed fields: `["subscriptions", "unread"]`.

@ -3,6 +3,8 @@ title: GameDig
description: GameDig Widget Configuration
---
Learn more about [GameDig](https://github.com/gamedig/node-gamedig).
Uses the [GameDig](https://www.npmjs.com/package/gamedig) library to get game server information for any supported server type.
Allowed fields (limited to a max of 4): `["status", "name", "map", "currentPlayers", "players", "maxPlayers", "bots", "ping"]`.

@ -0,0 +1,12 @@
---
title: Gatus
description: Gatus Widget Configuration
---
Allowed fields: `["up", "down", "uptime"]`.
```yaml
widget:
type: gatus
url: http://gatus.host.or.ip:port
```

@ -3,6 +3,8 @@ title: Ghostfolio
description: Ghostfolio Widget Configuration
---
Learn more about [Ghostfolio](https://github.com/ghostfolio/ghostfolio).
Authentication requires manually obtaining a Bearer token which can be obtained by make a POST request to the API e.g.
```

@ -3,6 +3,8 @@ title: Glances
description: Glances Widget Configuration
---
Learn more about [Glances](https://github.com/nicolargo/glances).
<img width="1614" alt="glances" src="https://github-production-user-asset-6210df.s3.amazonaws.com/82196/257382012-25648c97-2c1b-4db0-b5a5-f1509806079c.png">
_(Find the Glances information widget [here](../info/glances.md))_

@ -3,6 +3,8 @@ title: Gluetun
description: Gluetun Widget Configuration
---
Learn more about [Gluetun](https://github.com/qdm12/gluetun).
!!! note
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`.

@ -3,6 +3,8 @@ title: Gotify
description: Gotify Widget Configuration
---
Learn more about [Gotify](https://github.com/gotify/server).
Get a Gotify client token from an existing client or create a new one on your Gotify admin page.
Allowed fields: `["apps", "clients", "messages"]`.

@ -3,6 +3,8 @@ title: Grafana
description: Grafana Widget Configuration
---
Learn more about [Grafana](https://github.com/grafana/grafana).
Allowed fields: `["dashboards", "datasources", "totalalerts", "alertstriggered"]`.
```yaml

@ -3,10 +3,16 @@ title: HDHomerun
description: HDHomerun Widget Configuration
---
Allowed fields: `["channels", "hd"]`.
Learn more about [HDHomerun](https://www.silicondust.com/support/downloads/).
Allowed fields: `["channels", "hd", "tunerCount", "channelNumber", "channelNetwork", "signalStrength", "signalQuality", "symbolQuality", "networkRate", "clientIP" ]`.
If more than 4 fields are provided, only the first 4 are displayed.
```yaml
widget:
type: hdhomerun
url: http://hdhomerun.host.or.ip
tuner: 0 # optional - defaults to 0, used for tuner-specific fields
fields: ["channels", "hd"] # optional - default fields shown
```

@ -3,6 +3,8 @@ title: Health checks
description: Health checks Widget Configuration
---
Learn more about [Health Checks](https://github.com/healthchecks/healthchecks).
Specify a single check by including the `uuid` field or show the total 'up' and 'down' for all
checks by leaving off the `uuid` field.

@ -3,6 +3,8 @@ title: Home Assistant
description: Home Assistant Widget Configuration
---
Learn more about [Home Assistant](https://www.home-assistant.io/).
You will need to generate a long-lived access token for an existing Home Assistant user in its profile.
Allowed fields: `["people_home", "lights_on", "switches_on"]`.

@ -3,6 +3,8 @@ title: Homebridge
description: Homebridge
---
Learn more about [Homebridge](https://github.com/homebridge/homebridge).
The Homebridge API is actually provided by the Config UI X plugin that has been included with Homebridge for a while, still it is required to be installed for this widget to work.
Allowed fields: `["updates", "child_bridges"]`.

@ -3,6 +3,10 @@ title: Immich
description: Immich Widget Configuration
---
Learn more about [Immich](https://github.com/immich-app/immich).
Find your API key under `Account Settings > API Keys`.
Allowed fields: `["users" ,"photos", "videos", "storage"]`.
Note that API key must be from admin user.

@ -3,6 +3,8 @@ title: Jackett
description: Jackett Widget Configuration
---
Learn more about [Jackett](https://github.com/Jackett/Jackett).
Jackett must not have any authentication for the widget to work.
Allowed fields: `["configured", "errored"]`.
@ -11,4 +13,5 @@ Allowed fields: `["configured", "errored"]`.
widget:
type: jackett
url: http://jackett.host.or.ip
key: jackettapikey
```

@ -3,6 +3,8 @@ title: JDownloader
description: NextPVR Widget Configuration
---
Learn more about [JDownloader](https://jdownloader.org/).
Basic widget to show number of items in download queue, along with the queue size and current download speed.
Allowed fields: `["downloadCount", "downloadTotalBytes","downloadBytesRemaining", "downloadSpeed"]`.

@ -3,6 +3,8 @@ title: Jellyfin
description: Jellyfin Widget Configuration
---
Learn more about [Jellyfin](https://github.com/jellyfin/jellyfin).
You can create an API key from inside Jellyfin at `Settings > Advanced > Api Keys`.
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.

@ -3,6 +3,8 @@ title: Jellyseerr
description: Jellyseerr Widget Configuration
---
Learn more about [Jellyseerr](https://github.com/Fallenbagel/jellyseerr).
Find your API key under `Settings > General > API Key`.
Allowed fields: `["pending", "approved", "available"]`.

@ -3,7 +3,9 @@ title: Kavita
description: Kavita Widget Configuration
---
Uses the same username and password used to login from the web.
Learn more about [Kavita](https://github.com/Kareadita/Kavita).
Uses the same admin role username and password used to login from the web.
Allowed fields: `["seriesCount", "totalFiles"]`.

@ -3,6 +3,8 @@ title: Komga
description: Komga Widget Configuration
---
Learn more about [Komga](https://github.com/gotson/komga).
Uses the same username and password used to login from the web.
Allowed fields: `["libraries", "series", "books"]`.

@ -3,6 +3,8 @@ title: Kopia
description: Kopia Widget Configuration
---
Learn more about [Kopia](https://github.com/kopia/kopia).
Allowed fields: `["status", "size", "lastrun", "nextrun"]`.
You may optionally pass values for `snapshotHost` and / or `snapshotPath` to select a specific backup source for the widget.

@ -3,6 +3,8 @@ title: Lidarr
description: Lidarr Widget Configuration
---
Learn more about [Lidarr](https://github.com/Lidarr/Lidarr).
Find your API key under `Settings > General`.
Allowed fields: `["wanted", "queued", "artists"]`.

@ -3,6 +3,8 @@ title: Mastodon
description: Mastodon Widget Configuration
---
Learn more about [Mastodon](https://github.com/mastodon/mastodon).
Use the base URL of the Mastodon instance you'd like to pull stats for. Does not require authentication as the stats are part of the public API endpoints.
Allowed fields: `["user_count", "status_count", "domain_count"]`.

@ -3,6 +3,8 @@ title: Mealie
description: Mealie Widget Configuration
---
Learn more about [Mealie](https://github.com/mealie-recipes/mealie).
Generate a user API key under `Profile > Manage Your API Tokens > Generate`.
Allowed fields: `["recipes", "users", "categories", "tags"]`.

@ -3,6 +3,8 @@ title: Medusa
description: Medusa Widget Configuration
---
Learn more about [Medusa](https://github.com/medusajs/medusa).
Allowed fields: `["wanted", "queued", "series"]`.
```yaml

@ -3,6 +3,8 @@ title: Miniflux
description: Miniflux Widget Configuration
---
Learn more about [Miniflux](https://github.com/miniflux/v2).
Api key is found under Settings > API keys
Allowed fields: `["unread", "read"]`.

@ -3,6 +3,8 @@ title: Moonraker (Klipper)
description: Moonraker (Klipper) Widget Configuration
---
Learn more about [Moonraker](https://github.com/Arksine/moonraker).
Allowed fields: `["printer_state", "print_status", "print_progress", "layers"]`.
```yaml

@ -3,6 +3,8 @@ title: Mylar3
description: Mylar3 Widget Configuration
---
Learn more about [Mylar3](https://github.com/mylar3/mylar3).
API must be enabled in Mylar3 settings.
Allowed fields: `["series", "issues", "wanted"]`.

@ -3,6 +3,8 @@ title: Navidrome
description: Navidrome Widget Configuration
---
Learn more about [Navidrome](https://github.com/navidrome/navidrome).
For detailed information about how to generate the token see http://www.subsonic.org/pages/api.jsp.
Allowed fields: no configurable fields for this widget.

@ -3,10 +3,12 @@ title: Netdata
description: Netdata Widget Configuration
---
Learn more about [Netdata](https://github.com/netdata/netdata).
Allowed fields: `["warnings", "criticals"]`.
```yaml
widget:
type: Netdata
type: netdata
url: http://netdata.host.or.ip
```

@ -3,6 +3,8 @@ title: Nextcloud
description: Nextcloud Widget Configuration
---
Learn more about [Nextcloud](https://github.com/nextcloud).
Use username & password, or the `NC-Token` key. Information about the token can be found under **Settings** > **System**. If both are provided, NC-Token will be used.
Allowed fields: `["cpuload", "memoryusage", "freespace", "activeusers", "numfiles", "numshares"]`.

@ -3,6 +3,8 @@ title: NextDNS
description: NextDNS Widget Configuration
---
Learn more about [NextDNS](https://nextdns.io/).
Api key is found under Account > API, profile ID is found under Setup > Endpoints > ID
```yaml

@ -3,6 +3,8 @@ title: Nginx Proxy Manager
description: Nginx Proxy Manager Widget Configuration
---
Learn more about [Nginx Proxy Manager](https://nginxproxymanager.com/).
Login with the same admin username and password used to access the web UI.
Allowed fields: `["enabled", "disabled", "total"]`.

@ -3,6 +3,8 @@ title: NZBget
description: NZBget Widget Configuration
---
Learn more about [NZBget](https://github.com/nzbget/nzbget).
This widget uses the same authentication method as your browser when logging in (HTTP Basic Auth), and is often referred to as the ControlUsername and ControlPassword inside of Nzbget documentation.
Allowed fields: `["rate", "remaining", "downloaded"]`.

@ -3,6 +3,8 @@ title: OctoPrint
description: OctoPrintWidget Configuration
---
Learn more about [OctoPrint](https://octoprint.org/).
Allowed fields: `["printer_state", "temp_tool", "temp_bed", "job_completion"]`.
```yaml

@ -3,6 +3,8 @@ title: Ombi
description: Ombi Widget Configuration
---
Learn more about [Ombi](https://github.com/Ombi-app/Ombi).
Find your API key under `Settings > Configuration > General`.
Allowed fields: `["pending", "approved", "available"]`.

@ -3,6 +3,8 @@ title: OpenDTU
description: OpenDTU Widget
---
Learn more about [OpenDTU](https://github.com/tbnobody/OpenDTU).
Allowed fields: `["yieldDay", "relativePower", "absolutePower", "limit"]`.
```yaml

@ -3,6 +3,8 @@ title: OpenMediaVault
description: OpenMediaVault Widget Configuration
---
Learn more about [OpenMediaVault](https://www.openmediavault.org/).
Provides useful information from your OpenMediaVault
```yaml

@ -0,0 +1,54 @@
---
title: OpenWRT
description: OpenWRT widget configuration
---
Learn more about [OpenWRT](https://openwrt.org/).
Provides information from OpenWRT
```yaml
widget:
type: openwrt
url: http://host.or.ip
username: homepage
password: pass
interfaceName: eth0 # optional
```
## Interface
Setting `interfaceName` (e.g. eth0) will display information for that particular device, otherwise the widget will display general system info.
## Authorization
In order for homepage to access the OpenWRT RPC endpoints you will need to [create an ACL](https://openwrt.org/docs/techref/ubus#acls) and [new user](https://openwrt.org/docs/techref/ubus#authentication) in OpenWRT.
Create an ACL named `homepage.json` in `/usr/share/rpcd/acl.d/`, the following permissions will suffice:
```
{
"homepage": {
"description": "Homepage widget",
"read": {
"ubus": {
"network.interface.wan": ["status"],
"network.interface.lan": ["status"],
"network.device": ["status"]
"system": ["info"]
}
},
}
}
```
Then add a user that will use that ACL in `/etc/config/rpc`:
```config login
option username 'homepage'
option password '<password>'
list read homepage
list write '*'
```
This username and password will be used in Homepage's services.yaml to grant access.

@ -3,6 +3,8 @@ title: OPNSense
description: OPNSense Widget Configuration
---
Learn more about [OPNSense](https://opnsense.org/).
The API key & secret can be generated via the webui by creating a new user at _System/Access/Users_. Ensure "Generate a scrambled password to prevent local database logins for this user" is checked and then edit the effective privileges selecting **only**:
- Diagnostics: System Activity

@ -3,6 +3,8 @@ title: Overseerr
description: Overseerr Widget Configuration
---
Learn more about [Overseerr](https://github.com/sct/overseerr).
Find your API key under `Settings > General`.
Allowed fields: `["pending", "approved", "available", "processing"]`.

@ -3,6 +3,8 @@ title: Paperless-ngx
description: Paperless-ngx Widget Configuration
---
Learn more about [Paperless-ngx](https://github.com/paperless-ngx/paperless-ngx).
Use username & password, or the token key. Information about the token can be found in the [Paperless-ngx API documentation](https://docs.paperless-ngx.com/api/#authorization). If both are provided, the token will be used.
Allowed fields: `["total", "inbox"]`.

@ -3,6 +3,8 @@ title: PeaNUT
description: PeaNUT Widget Configuration
---
Learn more about [PeaNUT](https://github.com/Brandawg93/PeaNUT).
This widget adds support for [Network UPS Tools](https://networkupstools.org/) via a third party tool, [PeaNUT](https://github.com/Brandawg93/PeaNUT).
The default ups name is `ups`. To configure more than one ups, you must create multiple peanut services.

@ -3,6 +3,8 @@ title: pfSense
description: pfSense Widget Configuration
---
Learn more about [pfSense](https://github.com/pfsense/pfsense).
This widget requires the installation of the [pfsense-api](https://github.com/jaredhendrickson13/pfsense-api) which is a 3rd party package for pfSense routers.
Once pfSense API is installed, you can set the API to be read-only in System > API > Settings.

@ -3,6 +3,8 @@ title: PhotoPrism
description: PhotoPrism Widget Configuration
---
Learn more about [PhotoPrism](https://github.com/photoprism/photoprism)..
Allowed fields: `["albums", "photos", "videos", "people"]`.
```yaml

@ -3,7 +3,9 @@ title: PiAlert
description: PiAlert Widget Configuration
---
Widget for [PiAlert](https://github.com/jokob-sk/Pi.Alert).
Learn more about [PiAlert](https://github.com/jokob-sk/Pi.Alert).
Note that [pucherot/PiAlert](https://github.com/pucherot/Pi.Alert) has been abandoned and might not work properly.
Allowed fields: `["total", "connected", "new_devices", "down_alerts"]`.

@ -3,6 +3,8 @@ title: PiHole
description: PiHole Widget Configuration
---
Learn more about [PiHole](https://github.com/pi-hole/pi-hole).
As of v2022.12 [PiHole requires the use of an API key](https://pi-hole.net/blog/2022/11/17/upcoming-changes-authentication-for-more-api-endpoints-required/#page-content) if an admin password is set. Older versions do not require any authentication even if the admin uses a password.
Allowed fields: `["queries", "blocked", "blocked_percent", "gravity"]`.

@ -3,6 +3,8 @@ title: Tautulli (Plex)
description: Tautulli Widget Configuration
---
Learn more about [Tautulli](https://github.com/Tautulli/Tautulli).
Provides detailed information about currently active streams. You can find the API key from inside Tautulli at `Settings > Web Interface > API`.
Allowed fields: no configurable fields for this widget.

@ -3,6 +3,8 @@ title: Plex
description: Plex Widget Configuration
---
Learn more about [Plex](https://www.plex.tv/).
The core Plex API is somewhat limited but basic info regarding library sizes and the number of active streams is supported. For more detailed info regarding active streams see the [Plex Tautulli widget](plex-tautulli.md).
Allowed fields: `["streams", "albums", "movies", "tv"]`.

@ -3,6 +3,8 @@ title: Portainer
description: Portainer Widget Configuration
---
Learn more about [Portainer](https://github.com/portainer/portainer).
You'll need to make sure you have the correct environment set for the integration to work properly. From the Environments section inside of Portainer, click the one you'd like to connect to and observe the ID at the end of the URL (should be), something like `#!/endpoints/1`, here `1` is the value to set as the `env` value. In order to generate an API key, please follow the steps outlined here https://docs.portainer.io/api/access.
Allowed fields: `["running", "stopped", "total"]`.

@ -3,6 +3,8 @@ title: Prometheus
description: Prometheus Widget Configuration
---
Learn more about [Prometheus](https://github.com/prometheus/prometheus).
Allowed fields: `["targets_up", "targets_down", "targets_total"]`
```yaml

@ -3,6 +3,8 @@ title: Prowlarr
description: Prowlarr Widget Configuration
---
Learn more about [Prowlarr](https://github.com/Prowlarr/Prowlarr).
Find your API key under `Settings > General`.
Allowed fields: `["numberOfGrabs", "numberOfQueries", "numberOfFailGrabs", "numberOfFailQueries"]`.

@ -3,6 +3,8 @@ title: Proxmox
description: Proxmox Widget Configuration
---
Learn more about [Proxmox](https://www.proxmox.com/en/).
This widget shows the running and total counts of both QEMU VMs and LX Containers in the Proxmox cluster. It also shows the CPU and memory usage of the first node in the cluster.
You will need to generate an API Token for new or an existing user. Here is an example of how to do this for a new user.

@ -3,6 +3,8 @@ title: Proxmox Backup Server
description: Proxmox Backup Server Widget Configuration
---
Learn more about [Proxmox Backup Server](https://www.proxmox.com/en/proxmox-backup-server/overview).
Allowed fields: `["datastore_usage", "failed_tasks_24h", "cpu_usage", "memory_usage"]`.
```yaml

@ -3,6 +3,8 @@ title: Pterodactyl
description: Pterodactyl Widget Configuration
---
Learn more about [Pterodactyl](https://github.com/pterodactyl).
Allowed fields: `["nodes", "servers"]`
```yaml

@ -3,6 +3,8 @@ title: Pyload
description: Pyload Widget Configuration
---
Learn more about [Pyload](https://github.com/pyload/pyload).
Allowed fields: `["speed", "active", "queue", "total"]`.
```yaml

@ -3,6 +3,8 @@ title: qBittorrent
description: qBittorrent Widget Configuration
---
Learn more about [qBittorrent](https://github.com/qbittorrent/qBittorrent).
Uses the same username and password used to login from the web.
Allowed fields: `["leech", "download", "seed", "upload"]`.

@ -3,6 +3,8 @@ title: QNAP
description: QNAP Widget Configuration
---
Learn more about [QNAP](https://www.qnap.com).
Allowed fields: `["cpuUsage", "memUsage", "systemTempC", "poolUsage", "volumeUsage"]`.
```yaml

@ -3,6 +3,8 @@ title: Radarr
description: Radarr Widget Configuration
---
Learn more about [Radarr](https://github.com/Radarr/Radarr).
Find your API key under `Settings > General`.
Allowed fields: `["wanted", "missing", "queued", "movies"]`.

@ -3,6 +3,8 @@ title: Readarr
description: Readarr Widget Configuration
---
Learn more about [Readarr](https://github.com/Readarr/Readarr).
Find your API key under `Settings > General`.
Allowed fields: `["wanted", "queued", "books"]`.

@ -0,0 +1,14 @@
---
title: Romm
description: Romm Widget Configuration
---
Allowed fields: `["platforms", "totalRoms"]`.
```yaml
widget:
type: romm
url: http://romm.host.or.ip
username: username # optional
password: password # optional
```

@ -3,6 +3,8 @@ title: ruTorrent
description: ruTorrent Widget Configuration
---
Learn more about [ruTorrent](https://github.com/Novik/ruTorrent).
This requires the `httprpc` plugin to be installed and enabled, and is part of the default ruTorrent plugins. If you have not explicitly removed or disable this plugin, it should be available.
Allowed fields: `["active", "upload", "download"]`.

@ -3,6 +3,8 @@ title: SABnzbd
description: SABnzbd Widget Configuration
---
Learn more about [SABnzbd](https://github.com/sabnzbd/sabnzbd).
Find your API key under `Config > General`.
Allowed fields: `["rate", "queue", "timeleft"]`.

@ -3,6 +3,8 @@ title: Scrutiny
description: Scrutiny Widget Configuration
---
Learn more about [Scrutiny](https://github.com/AnalogJ/scrutiny).
Allowed fields: `["passed", "failed", "unknown"]`.
```yaml

@ -3,6 +3,8 @@ title: Sonarr
description: Sonarr Widget Configuration
---
Learn more about [Sonarr](https://github.com/Sonarr/Sonarr).
Find your API key under `Settings > General`.
Allowed fields: `["wanted", "queued", "series"]`.

@ -3,6 +3,9 @@ title: Speedtest Tracker
description: Speedtest Tracker Widget Configuration
---
Learn more about [Speedtest Tracker](https://github.com/alexjustesen/speedtest-tracker). or
[Speedtest Tracker](https://github.com/henrywhitaker3/Speedtest-Tracker)
No extra configuration is required.
This widget is compatible with both [alexjustesen/speedtest-tracker](https://github.com/alexjustesen/speedtest-tracker) and [henrywhitaker3/Speedtest-Tracker](https://github.com/henrywhitaker3/Speedtest-Tracker).

@ -3,6 +3,8 @@ title: Syncthing Relay Server
description: Syncthing Relay Server Widget Configuration
---
Learn more about [Syncthing Relay Server](https://github.com/syncthing/syncthing).
Pulls stats from the [relay server](https://docs.syncthing.net/users/strelaysrv.html). [See here](https://github.com/gethomepage/homepage/pull/230#issuecomment-1253053472) for more information on configuration.
Allowed fields: `["numActiveSessions", "numConnections", "bytesProxied"]`.

@ -3,6 +3,8 @@ title: Tailscale
description: Tailscale Widget Configuration
---
Learn more about [Tailscale](https://github.com/tailscale/tailscale).
You will need to generate an API access token from the [keys page](https://login.tailscale.com/admin/settings/keys) on the Tailscale dashboard.
To find your device ID, go to the [machine overview page](https://login.tailscale.com/admin/machines) and select your machine. In the "Machine Details" section, copy your `ID`. It will end with `CNTRL`.

@ -3,6 +3,8 @@ title: Tdarr
description: Tdarr Widget Configuration
---
Learn more about [Tdarr](https://github.com/HaveAGitGat/Tdarr).
Allowed fields: `["queue", "processed", "errored", "saved"]`.
```yaml

Some files were not shown because too many files have changed in this diff Show More

Loading…
Cancel
Save