Update contributing / development guidelines

---------

Co-authored-by: shamoon <4887959+shamoon@users.noreply.github.com>

.devcontainer/Dockerfile

@@ -3,4 +3,10 @@ FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:${VARIANT}
 
 RUN npm install -g pnpm
 
+RUN apt-get update \
+   && apt-get -y install --no-install-recommends \
+        python3-pip \
+        && apt-get clean -y \
+        && rm -rf /var/lib/apt/lists/*
+
 ENV PATH="${PATH}:./node_modules/.bin"

.devcontainer/devcontainer.json

@@ -1,27 +1,26 @@
 {
-	"name": "homepage",
-	"build": {
-		"dockerfile": "Dockerfile",
-		"args": {
-			"VARIANT": "18-bullseye"
-		}
-	},
-	"customizations": {
-		"vscode": {
-			"extensions": [
-				"dbaeumer.vscode-eslint",
-				"mhutchie.git-graph",
-				"streetsidesoftware.code-spell-checker",
-			],
-			"settings": {
-				"eslint.format.enable": true,
-				"eslint.lintTask.enable": true,
-				"eslint.packageManager": "pnpm"
-			}
-		}
-	},
-	"postCreateCommand": ".devcontainer/setup.sh",
-	"forwardPorts": [
-		3000
-	]
+  "name": "homepage",
+  "build": {
+    "dockerfile": "Dockerfile",
+    "args": {
+      "VARIANT": "18-bullseye",
+    },
+  },
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "dbaeumer.vscode-eslint",
+        "mhutchie.git-graph",
+        "streetsidesoftware.code-spell-checker",
+        "esbenp.prettier-vscode",
+      ],
+      "settings": {
+        "eslint.format.enable": true,
+        "eslint.lintTask.enable": true,
+        "eslint.packageManager": "pnpm",
+      },
+    },
+  },
+  "postCreateCommand": ".devcontainer/setup.sh",
+  "forwardPorts": [3000],
 }

.devcontainer/setup.sh

@@ -3,6 +3,8 @@
 # Install Node packages
 pnpm install
 
+python3 -m pip install -r requirements.txt
+
 # Copy in skeleton configuration if there is no existing configuration
 if [ ! -d "config/" ]; then
   echo "Adding skeleton config"

.github/DISCUSSION_TEMPLATE/support.yml

@@ -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

.github/FUNDING.yml

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

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,99 +1,33 @@
-name: Bug report
-description: Create a report to help us improve
-title: "[Bug] Concise description of the issue"
-labels: ["bug, unconfirmed"]
+name: 🐛 Bug report
+description: Please only raise an issue if you've been advised to do so in a GitHub discussion. Thanks! 🙏
+labels: ["bug"]
 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.
+        ## ⚠️ Please note
+        The starting point for a bug report should always be a [GitHub discussion](https://github.com/gethomepage/homepage/discussions/new?category=support)
+        Thank you for contributing to homepage! ✊
   - type: checkboxes
     id: pre-flight
     attributes:
-      label: Before submitting, I have made sure to
+      label: Before submitting, please confirm the following
       options:
-        - label: Check [the documentation](https://gethomepage.dev/)
+        - label: I confirm this was discussed, and the maintainers suggest I open an issue (note that AI bots are not maintainers).
           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).
+        - label: I am aware that if I create this issue without a discussion, it will be removed without a response.
           required: true
+  - type: input
+    id: discussion
+    attributes:
+      label: Discussion Link
+      description: |
+        Please link to the GitHub discussion that led to this issue.
+    validations:
+      required: true
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional context
+      description: Optional
+      render: Text

.github/ISSUE_TEMPLATE/config.yml

@@ -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, possible bug reports or general questions.
   - name: 💬 Chat
     url: https://discord.gg/k4ruYNrudu
     about: Want to discuss homepage with others? Check out our chat.

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,12 +1,12 @@
 ## Proposed change
 
 <!--
-Please include a summary of the change. Screenshots and / or videos can also be helpful if appropriate.
+Please include a summary of the change. Screenshots and/or videos can also be helpful if appropriate.
 
 *** Please see the development guidelines for new widgets: https://gethomepage.dev/latest/more/development/#service-widget-guidelines
 *** If you do not follow these guidelines your PR will likely be closed without review.
 
-New service widgets should include example(s) of relevant relevant API output as well updates to the docs for the new widget.
+New service widgets should include example(s) of relevant API output as well as updates to the docs for the new widget.
 -->
 
 Closes # (issue)

.github/dependabot.yml

@@ -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"

.github/workflows/docker-publish.yml

@@ -46,7 +46,7 @@ jobs:
           python-version: 3.x
       -
         name: Check files
-        uses: pre-commit/action@v3.0.0
+        uses: pre-commit/action@v3.0.1
 
   build:
     name: Docker Build & Push

.github/workflows/docs-publish.yml

@@ -32,7 +32,7 @@ jobs:
           python-version: 3.x
       -
         name: Check files
-        uses: pre-commit/action@v3.0.0
+        uses: pre-commit/action@v3.0.1
 
   test:
     name: Test Build

.github/workflows/repo-maintenance.yml

@@ -0,0 +1,280 @@
+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. See our [contributing guidelines](https://github.com/gethomepage/homepage/blob/main/CONTRIBUTING.md#automatic-respoistory-maintenance) for more details.
+  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.
+            See our [contributing guidelines](https://github.com/gethomepage/homepage/blob/main/CONTRIBUTING.md#automatic-repository-maintenance) for more details.
+          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.
+            See our [contributing guidelines](https://github.com/gethomepage/homepage/blob/main/CONTRIBUTING.md#automatic-repository-maintenance) for more details.
+          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.
+            See our [contributing guidelines](https://github.com/gethomepage/homepage/blob/main/CONTRIBUTING.md#automatic-repository-maintenance) for more details.
+  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. See our [contributing guidelines](https://github.com/gethomepage/homepage/blob/main/CONTRIBUTING.md#automatic-repository-maintenance) for more details.',
+              }
+              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. See our [contributing guidelines](https://github.com/gethomepage/homepage/blob/main/CONTRIBUTING.md#automatic-repository-maintenance) for more details.',
+                }
+                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);
+              }
+            }
+  close-unsupported-feature-requests:
+    name: 'Close Unsupported Feature Requests'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/github-script@v7
+        with:
+          script: |
+            function sleep(ms) {
+              return new Promise(resolve => setTimeout(resolve, ms));
+            }
+
+            const CUTOFF_1_DAYS = 180;
+            const CUTOFF_1_COUNT = 5;
+            const CUTOFF_2_DAYS = 365;
+            const CUTOFF_2_COUNT = 10;
+
+            const cutoff1Date = new Date();
+            cutoff1Date.setDate(cutoff1Date.getDate() - CUTOFF_1_DAYS);
+            const cutoff2Date = new Date();
+            cutoff2Date.setDate(cutoff2Date.getDate() - CUTOFF_2_DAYS);
+
+            const query = `query(
+                $owner:String!,
+                $name:String!,
+                $featureRequestsCategory:ID!,
+              ) {
+              repository(owner:$owner, name:$name){
+                discussions(
+                  categoryId:$featureRequestsCategory,
+                  last:100,
+                  states:[OPEN],
+                ) {
+                  nodes {
+                    id,
+                    number,
+                    updatedAt,
+                    upvoteCount,
+                  }
+                },
+              }
+            }`;
+            const variables = {
+              owner: context.repo.owner,
+              name: context.repo.repo,
+              featureRequestsCategory: "DIC_kwDOH31rQM4CRErS"
+            }
+            const result = await github.graphql(query, variables);
+
+            for (const discussion of result.repository.discussions.nodes) {
+              const discussionDate = new Date(discussion.updatedAt);
+              if ((discussionDate < cutoff1Date && discussion.upvoteCount < CUTOFF_1_COUNT) ||
+                  (discussionDate < cutoff2Date && discussion.upvoteCount < CUTOFF_2_COUNT)) {
+                console.log(`Closing discussion #${discussion.number} (${discussion.id}), last updated at ${discussion.updatedAt} with votes ${discussion.upvoteCount}`);
+                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 lack of community support. See our [contributing guidelines](https://github.com/gethomepage/homepage/blob/main/CONTRIBUTING.md#automatic-repository-maintenance) for more details.',
+                }
+                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);
+              }
+            }

CONTRIBUTING.md

@@ -16,9 +16,9 @@ We use github to host code, to track issues and feature requests, as well as acc
 
 In short, when you submit code changes, your submissions are understood to be under the same [GNU General Public License v3.0](https://choosealicense.com/licenses/gpl-3.0/) that covers the project. Feel free to contact the maintainers if that's a concern.
 
-## Report bugs using Github's [issues](https://github.com/gethomepage/homepage/issues)
+## Report bugs using Github [discussions](https://github.com/gethomepage/homepage/discussions)
 
-We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/gethomepage/homepage/issues/new); it's that easy!
+We use GitHub discussions to triage bugs. Report a bug by [opening a new discussion](https://github.com/gethomepage/homepage/discussions/new?category=support); it's that easy! Please do not open an issue unless instructed to do so by a project maintainer.
 
 ## Write bug reports with detail, background, and sample configurations
 
@@ -48,6 +48,24 @@ Please see information in the docs regarding [code formatting with pre-commit ho
 
 By contributing, you agree that your contributions will be licensed under its GNU General Public License.
 
+## Use of AI for pull requests
+
+In general, homepage does not accept "AI-generated" PRs. If you choose to use something like that to aid the development process to generate a significant proportion of the pull request, please make sure this is explicitly stated in the PR itself.
+
 ## References
 
 This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/main/CONTRIBUTING.md)
+
+## Automatic Respository Maintenance
+
+The homepage team appreciates all effort and interest from the community in filing bug reports, creating feature requests, sharing ideas and helping other community members. That said, in an effort to keep the repository organized and managebale the project uses automatic handling of certain areas:
+
+- Issues, pull requests and discussions that are closed will be locked after 30 days of inactivity.
+- Discussions with a marked answer will be automatically closed.
+- Discussions in the 'General' or 'Support' categories will be closed after 180 days of inactivity.
+- Feature requests that do not meet the following thresholds will be closed: 5 "up-votes" after 180 days of inactivity or 10 "up-votes" after 365 days.
+
+In all cases, threads can be re-opened by project maintainers and, of course, users can always create a new discussion for related concerns.
+Finally, remember that all information remains searchable and 'closed' feature requests can still serve as inspiration for new features.
+
+Thank you all for your contributions.

README.md

@@ -41,7 +41,7 @@ With features like quick search, bookmarks, weather support, a wide range of int
 
 ## Docker Integration
 
-Homepage has built-in support for Docker, and can automatically discover and add services to the homepage based on labels. See the [Docker](https://gethomepage.dev/latest/installation/docker/) page for more information.
+Homepage has built-in support for Docker, and can automatically discover and add services to the homepage based on labels. See the [Docker Service Discovery](https://gethomepage.dev/latest/configs/docker/#automatic-service-discovery) page for more information.
 
 ## Service Widgets
 
@@ -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.

docs/configs/bookmarks.md

@@ -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.

docs/configs/services.md

@@ -101,7 +101,7 @@ To use a local icon, first create a Docker mount to `/app/public/icons` and then
 
 ## Ping
 
-Services may have an optional `ping` property that allows you to monitor the availability of an external host. As of v0.8.0, the ping feature attempts to use a true (ICMP) ping command on the underlying host.
+Services may have an optional `ping` property that allows you to monitor the availability of an external host. As of v0.8.0, the ping feature attempts to use a true (ICMP) ping command on the underlying host. Currently, only IPv4 is supported.
 
 ```yaml
 - Group A:

docs/configs/settings.md

@@ -85,7 +85,7 @@ Or you may pass the path to a local image relative to the `/app/public` director
 
 ## Theme
 
-You can configure a fixed them (and disable the theme switcher) by passing the `theme` option, like so:
+You can configure a fixed theme (and disable the theme switcher) by passing the `theme` option, like so:
 
 ```yaml
 theme: dark # or light
@@ -211,13 +211,13 @@ layout:
 
 ### Five Columns
 
-You can add a fifth column (when `style: columns` which is default) by adding:
+You can add a fifth column to services (when `style: columns` which is default) by adding:
 
 ```yaml
 fiveColumns: true
 ```
 
-By default homepage will max out at 4 columns for column style
+By default homepage will max out at 4 columns for services with `columns` style
 
 ### Collapsible sections
 
@@ -229,6 +229,26 @@ disableCollapse: true
 
 By default the feature is enabled.
 
+### Initially collapsed sections
+
+You can initially collapse sections by adding the `initiallyCollapsed` option to the layout group.
+
+```yaml
+layout:
+  Section A:
+    initiallyCollapsed: true
+```
+
+This can also be set globaly using the `groupsInitiallyCollapsed` option.
+
+```yaml
+groupsInitiallyCollapsed: true
+```
+
+The value set on a group will overwrite the global setting.
+
+By default the feature is disabled.
+
 ### Use Equal Height Cards
 
 You can enable equal height cards for groups of services, this will make all cards in a row the same height.
@@ -359,12 +379,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
 ```
 
@@ -384,6 +406,8 @@ By default the homepage logfile is written to the a `logs` subdirectory of the `
 logpath: /logfile/path
 ```
 
+By default, logs are sent both to `stdout` and to a file at the path specified. This can be changed by setting the `LOG_TARGETS` environment variable to one of `both` (default), `stdout` or `file`.
+
 ## Show Docker Stats
 
 You can show all docker stats expanded in `settings.yaml`:

docs/installation/k8s.md

@@ -361,3 +361,33 @@ spec:
                 port:
                   number: 3000
 ```
+
+### Multiple Replicas
+
+If you plan to deploy homepage with a replica count greater than 1, you may
+want to consider enabling sticky sessions on the homepage route. This will
+prevent unnecessary re-renders on page loads and window / tab focusing. The
+procedure for enabling sticky sessions depends on your Ingress controller. Below
+is an example using Traefik as the Ingress controller.
+
+```
+apiVersion: traefik.io/v1alpha1
+kind: IngressRoute
+metadata:
+  name: homepage.example.com
+spec:
+  entryPoints:
+    - websecure
+  routes:
+    - kind: Rule
+      match: Host(`homepage.example.com`)
+      services:
+        - kind: Service
+          name: homepage
+          port: 3000
+          sticky:
+            cookie:
+              httpOnly: true
+              secure: true
+              sameSite: none
+```

docs/more/development.md

@@ -39,17 +39,24 @@ Once installed, hooks will run when you commit. If the formatting isn't quite ri
 
 See the [pre-commit documentation](https://pre-commit.com/#install) to get started.
 
+## Preferring self-hosted open-source software
+
+In general, homepage is meant to be a dashboard for 'self-hosted' services and we believe it is a small way we can help showcase this kind of software. While exceptions are made, mostly when there is no viable
+self-hosted / open-source alternative, we ask that any widgets, etc. are developed primarily for a self-hosted tool.
+
 ## 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
+- Widgets should be no more than 4 blocks wide and generally conform to the styling / design choices of other widgets
 - Minimize the number of API calls
 - Avoid the use of custom proxy unless absolutely necessary
+- Widgets should be 'read-only', as in they should not make write changes using the relevant tool's API. Homepage widgets are designed to surface information, not to be a (usually worse) replacement for the tool itself.

docs/more/troubleshooting.md

@@ -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
 

docs/widgets/info/glances.md

@@ -12,11 +12,13 @@ The Glances widget allows you to monitor the resources (CPU, memory, storage, te
     url: http://host.or.ip:port
     username: user # optional if auth enabled in Glances
     password: pass # optional if auth enabled in Glances
+    version: 4 # required only if running glances v4 or higher, defaults to 3
     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)
+    diskUnits: bytes # optional, bytes (default) or bbytes. Only applies to disk
     expanded: true # show the expanded view
     label: MyMachine # optional
 ```

docs/widgets/info/openmeteo.md

@@ -13,6 +13,8 @@ No registration is required at all! See [https://open-meteo.com/en/docs](https:/
     timezone: Europe/Kiev # optional
     units: metric # or imperial
     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).

docs/widgets/info/openweathermap.md

@@ -14,6 +14,8 @@ The free tier "One Call API" is all that's required, you will need to [subscribe
     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
+    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).

docs/widgets/info/resources.md

@@ -22,6 +22,7 @@ _Note: unfortunately, the package used for getting CPU temp ([systeminformation]
     uptime: true
     units: imperial # only used by cpu temp
     refresh: 3000 # optional, in ms
+    diskUnits: bytes # optional, bytes (default) or bbytes. Only applies to disk
 ```
 
 You can also pass a `label` option, which allows you to group resources under named sections,

docs/widgets/info/search.md

@@ -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_

docs/widgets/info/weather.md

@@ -15,6 +15,8 @@ The free tier is all that's required, you will need to [register](https://www.we
     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).

docs/widgets/services/adguard-home.md

@@ -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"]`.

docs/widgets/services/atsumeru.md

@@ -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"]`.

docs/widgets/services/audiobookshelf.md

@@ -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"]`

docs/widgets/services/authentik.md

@@ -3,16 +3,19 @@ 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:
+You will need to generate an API token for an existing user under `Admin Portal` > `Directory` > `Tokens & App passwords`.
+Make sure to set Intent to "API Token".
 
-1. Navigate to the Authentik Admin Portal
-2. Expand Directory, the click Tokens & App passwords
-3. Click the Create button
-4. Fill out the dialog making sure to set Intent to API Token
-5. Click the Create button on the dialog
-6. Click the copy button on the far right of the newly created API Token
+The account you made the API token for also needs the following **Assigned global permissions** in Authentik:
+
+- authentik Core
+  - User
+- authentik Events
+  - Event
 
 Allowed fields: `["users", "loginsLast24H", "failedLoginsLast24H"]`.
 

docs/widgets/services/autobrr.md

@@ -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"]`.

docs/widgets/services/azuredevops.md

@@ -3,12 +3,14 @@ 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.\
+1. Pipelines: checks if the relevant pipeline is running or not, and if not, reports the last status.<br>
    Allowed fields: `["result", "status"]`.
 
-2. Pull Requests: returns the amount of open PRs, the amount of the PRs you have open, and how many PRs that you open are marked as 'Approved' by at least 1 person and not yet completed.\
+2. Pull Requests: returns the amount of open PRs, the amount of the PRs you have open, and how many PRs that you open are marked as 'Approved' by at least 1 person and not yet completed.<br>
    Allowed fields: `["totalPrs", "myPrs", "approved"]`.
 
 You will need to generate a personal access token for an existing user, see the [azure documentation](https://learn.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops&tabs=Windows#create-a-pat)

docs/widgets/services/bazarr.md

@@ -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"]`.

docs/widgets/services/caddy.md

@@ -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

docs/widgets/services/calibre-web.md

@@ -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"]`.

docs/widgets/services/changedetectionio.md

@@ -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

docs/widgets/services/channelsdvrserver.md

@@ -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

docs/widgets/services/cloudflared.md

@@ -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"]`.

docs/widgets/services/coin-market-cap.md

@@ -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.

docs/widgets/services/crowdsec.md

@@ -0,0 +1,19 @@
+---
+title: Crowdsec
+description: Crowdsec Widget Configuration
+---
+
+Learn more about [Crowdsec](https://crowdsec.net).
+
+See the [crowdsec docs](https://docs.crowdsec.net/docs/local_api/intro/#machines) for information about registering a machine,
+in most instances you can use the default credentials (`/etc/crowdsec/local_api_credentials.yaml`).
+
+Allowed fields: `["alerts", "bans"]`.
+
+```yaml
+widget:
+  type: crowdsec
+  url: http://crowdsechostorip:port
+  username: localhost # machine_id in crowdsec
+  passowrd: password
+```

docs/widgets/services/customapi.md

@@ -16,6 +16,8 @@ widget:
   password: password # auth - optional
   method: GET # optional, e.g. POST
   headers: # optional, must be object, see below
+  requestBody: # optional, can be string or object, see below
+  display: # optional, default to block, see below
   mappings:
     - field: key # needs to be YAML string or object
       label: Field 1
@@ -43,6 +45,15 @@ widget:
       locale: nl # optional
       style: short # optional - defaults to "long". Allowed values: `["long", "short", "narrow"]`.
       numeric: auto # optional - defaults to "always". Allowed values `["always", "auto"]`.
+    - field: key
+      label: Field 6
+      format: text
+      additionalField: # optional
+        field:
+          hourly:
+            time: other key
+        color: theme # optional - defaults to "". Allowed values: `["theme", "adaptive", "black", "white"]`.
+        format: date # optional
 ```
 
 Supported formats for the values are `text`, `number`, `float`, `percent`, `bytes`, `bitrate`, `date` and `relativeDate`.
@@ -93,7 +104,7 @@ mappings:
 
 ## Data Transformation
 
-You can manipulate data with the following tools `remap`, `scale` and `suffix`, for example:
+You can manipulate data with the following tools `remap`, `scale`, `prefix` and `suffix`, for example:
 
 ```yaml
 - field: key4
@@ -110,7 +121,42 @@ You can manipulate data with the following tools `remap`, `scale` and `suffix`,
   label: Power
   format: float
   scale: 0.001 # can be number or string e.g. 1/16
-  suffix: kW
+  suffix: "kW"
+- field: key6
+  label: Price
+  format: float
+  prefix: "$"
+```
+
+## List View
+
+You can change the default block view to a list view by setting the `display` option to `list`.
+
+The list view can optionally display an additional field next to the primary field.
+
+`additionalField`: Similar to `field`, but only used in list view. Displays additional information for the mapping object on the right.
+
+`field`: Defined the same way as other custom api widget fields.
+
+`color`: Allowed options: `"theme", "adaptive", "black", "white"`. The option `adaptive` will apply a color using the value of the `additionalField`, green for positive numbers, red for negative numbers.
+
+```yaml
+- field: key
+  label: Field
+  format: text
+  remap:
+    - value: 0
+      to: None
+    - value: 1
+      to: Connected
+    - any: true # will map all other values
+      to: Unknown
+  additionalField:
+    field:
+      hourly:
+        time: key
+    color: theme
+    format: date
 ```
 
 ## Custom Headers
@@ -121,3 +167,16 @@ Pass custom headers using the `headers` option, for example:
 headers:
   X-API-Token: token
 ```
+
+## Custom Request Body
+
+Pass custom request body using the `requestBody` option in either a string or object format. Objects will automatically be converted to a JSON string.
+
+```yaml
+requestBody:
+  foo: bar
+# or
+requestBody: "{\"foo\":\"bar\"}"
+```
+
+Both formats result in `{"foo":"bar"}` being sent as the request body. Don't forget to set your `Content-Type` headers!

docs/widgets/services/deluge.md

@@ -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"]`.

docs/widgets/services/diskstation.md

@@ -3,28 +3,35 @@ 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).
 
 Allowed fields: `["uptime", "volumeAvailable", "resources.cpu", "resources.mem"]`.
 
-To access these system metrics you need to connect to the DiskStation with an account that is a member of the default `Administrators` group. That is because these metrics are requested from the API's `SYNO.Core.System` part that is only available to admin users. In order to keep the security impact as small as possible we can set the account in DSM up to limit the user's permissions inside the Synology system. In DSM 7.x, for instance, follow these steps:
+To access these system metrics you need to connect to the DiskStation (`DSM`) with an account that is a member of the default `Administrators` group. That is because these metrics are requested from the API's `SYNO.Core.System` part that is only available to admin users. In order to keep the security impact as small as possible we can set the account in DSM up to limit the user's permissions inside the Synology system. In DSM 7.x, for instance, follow these steps:
 
 1. Create a new user, i.e. `remote_stats`.
 2. Set up a strong password for the new user
 3. Under the `User Groups` tab of the user config dialogue check the box for `Administrators`.
 4. On the `Permissions` tab check the top box for `No Access`, effectively prohibiting the user from accessing anything in the shared folders.
 5. Under `Applications` check the box next to `Deny` in the header to explicitly prohibit login to all applications.
-6. Now _only_ allow login to the `Download Station` application, either by
+6. Now _only_ allow login to the `DSM` application, either by
    - unchecking `Deny` in the respective row, or (if inheriting permission doesn't work because of other group settings)
    - checking `Allow` for this app, or
    - checking `By IP` for this app to limit the source of login attempts to one or more IP addresses/subnets.
-7. When the `Preview` column shows `Allow` in the `Download Station` row, click `Save`.
+7. When the `Preview` column shows `Allow` in the `DSM` row, click `Save`.
 
 Now configure the widget with the correct login information and test it.
 
-If you encounter issues during testing, make sure to uncheck the option for automatic blocking due to invalid logins under `Control Panel > Security > Protection`. If desired, this setting can be reactivated once the login is established working.
+If you encounter issues during testing:
+
+1. Make sure to uncheck the option for automatic blocking due to invalid logins under `Control Panel > Security > Protection`.
+   - If desired, this setting can be reactivated once the login is established working.
+2. Login to your Synology DSM with the newly created account and accept terms and conditions.
+3. Reattempt
 
 ```yaml
 widget:

docs/widgets/services/downloadstation.md

@@ -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"]`.

docs/widgets/services/emby.md

@@ -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.

docs/widgets/services/esphome.md

@@ -0,0 +1,19 @@
+---
+title: ESPHome
+description: ESPHome Widget Configuration
+---
+
+Learn more about [ESPHome](https://esphome.io/).
+
+Show the number of ESPHome devices based on their state.
+
+Allowed fields: `["total", "online", "offline", "offline_alt", "unknown"]` (maximum of 4).
+
+By default ESPHome will only mark devices as `offline` if their address cannot be pinged. If it has an invalid config or its name cannot be resolved (by DNS) its status will be marked as `unknown`.
+To group both `offline` and `unknown` devices together, users should use the `offline_alt` field instead. This sums all devices that are _not_ online together.
+
+```yaml
+widget:
+  type: esphome
+  url: http://esphome.host.or.ip:port
+```

docs/widgets/services/evcc.md

@@ -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

docs/widgets/services/fileflows.md

@@ -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

docs/widgets/services/flood.md

@@ -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

docs/widgets/services/freshrss.md

@@ -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"]`.

docs/widgets/services/gamedig.md

@@ -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"]`.

docs/widgets/services/gatus.md

@@ -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
+```

docs/widgets/services/ghostfolio.md

@@ -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.
 
 ```

docs/widgets/services/gitea.md

@@ -0,0 +1,17 @@
+---
+title: Gitea
+description: Gitea Widget Configuration
+---
+
+Learn more about [Gitea](https://gitea.com).
+
+API token requires `notifications`, `repository` and `issue` permissions. See the [gitea documentation](https://docs.gitea.com/development/api-usage#generating-and-listing-api-tokens) for details on generating tokens.
+
+Allowed fields: `["notifications", "issues", "pulls"]`.
+
+```yaml
+widget:
+  type: gitea
+  url: http://gitea.host.or.ip:port
+  key: giteaapitoken
+```

docs/widgets/services/glances.md

@@ -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))_
@@ -15,7 +17,11 @@ widget:
   url: http://glances.host.or.ip:port
   username: user # optional if auth enabled in Glances
   password: pass # optional if auth enabled in Glances
+  version: 4 # required only if running glances v4 or higher, defaults to 3
   metric: cpu
+  diskUnits: bytes # optional, bytes (default) or bbytes. Only applies to disk
+  refreshInterval: 5000 # optional - in milliseconds, defaults to 1000 or more, depending on the metric
+  pointsLimit: 15 # optional, defaults to 15
 ```
 
 _Please note, this widget does not need an `href`, `icon` or `description` on its parent service. To achieve the same effect as the examples above, see as an example:_

docs/widgets/services/gluetun.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`.

docs/widgets/services/gotify.md

@@ -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"]`.

docs/widgets/services/grafana.md

@@ -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

docs/widgets/services/hdhomerun.md

@@ -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
 ```

docs/widgets/services/healthchecks.md

@@ -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.
 

docs/widgets/services/homeassistant.md

@@ -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"]`.
@@ -16,7 +18,7 @@ The `custom` property will have no effect as long as the `fields` property is de
   - state labels and values can be user defined and may reference entity attributes in curly brackets
   - if no state label is defined it will default to `"{attributes.friendly_name}"`
   - if no state value is defined it will default to `"{state} {attributes.unit_of_measurement}"`
-- `template` will query the specified template, see (Home Assistant Templating)[https://www.home-assistant.io/docs/configuration/templating]
+- `template` will query the specified template, see [Home Assistant Templating](https://www.home-assistant.io/docs/configuration/templating)
   - if no template label is defined it will be empty
 
 ```yaml

docs/widgets/services/homebox.md

@@ -0,0 +1,23 @@
+---
+title: Homebox
+description: Homebox Widget Configuration
+---
+
+Learn more about [Homebox](https://github.com/hay-kot/homebox).
+
+Uses the same username and password used to login from the web.
+
+The `totalValue` field will attempt to format using the currency you have configured in Homebox.
+
+Allowed fields: `["items", "totalWithWarranty", "locations", "labels", "users", "totalValue"]`.
+
+If more than 4 fields are provided, only the first 4 are displayed.
+
+```yaml
+widget:
+  type: homebox
+  url: http://homebox.host.or.ip:port
+  username: username
+  password: password
+  fields: ["items", "locations", "totalValue"] # optional - default fields shown
+```

docs/widgets/services/homebridge.md

@@ -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"]`.

docs/widgets/services/immich.md

@@ -3,6 +3,8 @@ 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"]`.

docs/widgets/services/jackett.md

@@ -3,7 +3,9 @@ title: Jackett
 description: Jackett Widget Configuration
 ---
 
-Jackett must not have any authentication for the widget to work.
+Learn more about [Jackett](https://github.com/Jackett/Jackett).
+
+If Jackett has an admin password set, you must set the `password` field 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
+  password: jackettadminpassword # optional
 ```

docs/widgets/services/jdownloader.md

@@ -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"]`.

docs/widgets/services/jellyfin.md

@@ -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.

docs/widgets/services/jellyseerr.md

@@ -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"]`.

docs/widgets/services/kavita.md

@@ -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"]`.
 

docs/widgets/services/komga.md

@@ -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"]`.

docs/widgets/services/kopia.md

@@ -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.

docs/widgets/services/lidarr.md

@@ -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"]`.

docs/widgets/services/mastodon.md

@@ -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"]`.

docs/widgets/services/mealie.md

@@ -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"]`.

docs/widgets/services/medusa.md

@@ -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

docs/widgets/services/miniflux.md

@@ -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"]`.

docs/widgets/services/moonraker.md

@@ -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
@@ -10,3 +12,12 @@ widget:
   type: moonraker
   url: http://moonraker.host.or.ip:port
 ```
+
+If your moonraker instance has an active authorization and your homepage ip isn't whitelisted you need to add your api key ([Authorization Documentation](https://moonraker.readthedocs.io/en/latest/web_api/#authorization)).
+
+```yaml
+widget:
+  type: moonraker
+  url: http://moonraker.host.or.ip:port
+  key: api_keymoonraker
+```

docs/widgets/services/mylar.md

@@ -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"]`.

docs/widgets/services/navidrome.md

@@ -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.

docs/widgets/services/netalertx.md

@@ -0,0 +1,16 @@
+---
+title: NetAlertX
+description: NetAlertX (formerly PiAlert) Widget Configuration
+---
+
+Learn more about [NetAlertX](https://github.com/jokob-sk/NetAlertX).
+
+_Note that the project was renamed from PiAlert to NetAlertX._
+
+Allowed fields: `["total", "connected", "new_devices", "down_alerts"]`.
+
+```yaml
+widget:
+  type: netalertx
+  url: http://ip:port
+```

docs/widgets/services/netdata.md

@@ -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
 ```

docs/widgets/services/nextcloud.md

@@ -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"]`.

docs/widgets/services/nextdns.md

@@ -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

docs/widgets/services/nginx-proxy-manager.md

@@ -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"]`.

docs/widgets/services/nzbget.md

@@ -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"]`.

docs/widgets/services/octoprint.md

@@ -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

docs/widgets/services/ombi.md

@@ -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"]`.

docs/widgets/services/opendtu.md

@@ -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

docs/widgets/services/openmediavault.md

@@ -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

docs/widgets/services/openwrt.md

@@ -0,0 +1,60 @@
+---
+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:
+
+```json
+{
+  "homepage": {
+    "description": "Homepage widget",
+    "read": {
+      "ubus": {
+        "network.interface.wan": ["status"],
+        "network.interface.lan": ["status"],
+        "network.device": ["status"],
+        "system": ["info"]
+      }
+    }
+  }
+}
+```
+
+Create a `crypt(5)` password hash using the following command in the OpenWRT shell:
+
+```sh
+uhttpd -m "<somepassphrase>"
+```
+
+Then add a user that will use the ACL and hashed password in `/etc/config/rpcd`:
+
+```
+config login
+        option username 'homepage'
+        option password '<hashedpassword>'
+        list read homepage
+```
+
+This username and password will be used in Homepage's services.yaml to grant access.

docs/widgets/services/opnsense.md

@@ -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

docs/widgets/services/overseerr.md

@@ -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"]`.

docs/widgets/services/paperlessngx.md

@@ -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"]`.

docs/widgets/services/peanut.md

@@ -3,11 +3,13 @@ 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.
 
-Allowed fields: `["battery_charge", "ups_load", "ups_status"]`
+Allowed fields: `["battery_charge", "ups_load", "ups_status"]`.
 
 !!! note
 

docs/widgets/services/pfsense.md

@@ -3,13 +3,15 @@ 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.
 
-Currently the only supported authentication mode is 'Local Database'.
+There are two currently supported authentication modes: 'Local Database' and 'API Token'. For 'Local Database', use `username` and `password` with the credentials of an admin user. For 'API Token', utilize the `headers` parameter with `client_token` and `client_id` obtained from pfSense as shown below. Do not use both headers and username / password.
 
-WAN interface to monitor can be defined by updating the `wan` param.
+The interface to monitor is defined by updating the `wan` parameter. It should be referenced as it is shown under Interfaces > Assignments in pfSense.
 
 Load is returned instead of cpu utilization. This is a limitation in the pfSense API due to the complexity of this calculation. This may become available in future versions.
 
@@ -19,7 +21,10 @@ Allowed fields: `["load", "memory", "temp", "wanStatus", "wanIP", "disk"]` (maxi
 widget:
   type: pfsense
   url: http://pfsense.host.or.ip:port
-  username: user
-  password: pass
+  username: user # optional, or API token
+  password: pass # optional, or API token
+  headers: # optional, or username/password
+    Authorization: client_id client_token
   wan: igb0
+  fields: ["load", "memory", "temp", "wanStatus"] # optional
 ```

docs/widgets/services/photoprism.md

@@ -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

docs/widgets/services/pialert.md

@@ -1,14 +0,0 @@
----
-title: PiAlert
-description: PiAlert Widget Configuration
----
-
-Widget for [PiAlert](https://github.com/jokob-sk/Pi.Alert).
-
-Allowed fields: `["total", "connected", "new_devices", "down_alerts"]`.
-
-```yaml
-widget:
-  type: pialert
-  url: http://ip:port
-```

docs/widgets/services/pihole.md

@@ -3,15 +3,20 @@ 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"]`.
 
+Note: by default the "blocked" and "blocked_percent" fields are merged e.g. "1,234 (15%)" but explicitly including the "blocked_percent" field will change them to display separately.
+
 ```yaml
 widget:
   type: pihole
   url: http://pi.hole.or.ip
+  version: 6 # required if running v6 or higher, defaults to 5
   key: yourpiholeapikey # optional
 ```
 
-_Added in v0.1.0, updated in v0.6.18_
+_Added in v0.1.0, updated in v0.8.9_

docs/widgets/services/plantit.md

@@ -0,0 +1,17 @@
+---
+title: Plant-it
+description: Plant-it Widget Configuration
+---
+
+Learn more about [Plantit](https://github.com/MDeLuise/plant-it).
+
+API key can be created from the REST API.
+
+Allowed fields: `["events", "plants", "photos", "species"]`.
+
+```yaml
+widget:
+  type: plantit
+  url: http://plant-it.host.or.ip:port # api port
+  key: plantit-api-key
+```

docs/widgets/services/plex-tautulli.md

@@ -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.