Update services.md

Update ical.jsx
Fix: iCal integration fails with all-day events (#2883 )
2024-02-13 10:54:34 -08:00 · 2024-02-10 21:37:59 -08:00 · 2024-02-10 12:30:37 -08:00 · 2024-02-09 11:46:56 -08:00 · 2024-02-09 11:28:13 -08:00 · 2024-02-09 11:28:13 -08:00
277 changed files with 20847 additions and 12844 deletions
@@ -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"
@@ -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],
 }
@@ -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"
@@ -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.
@@ -25,7 +25,7 @@ What type of change does your PR introduce to Homepage?

 ## Checklist:

- [ ] If adding a service widget or a change that requires it, I have added corresponding documentation changes.
- [ ] If adding a new widget I have reviewed the [guidelines](https://gethomepage.dev/latest/more/development/#service-widget-guidelines).
- [ ] I have checked that all code style checks pass using pre-commit hooks and linting checks with `pnpm lint` (see development guidelines).
+- [ ] If applicable, I have added corresponding documentation changes.
+- [ ] If applicable, I have reviewed the [feature](https://gethomepage.dev/latest/more/development/#new-feature-guidelines) and / or [service widget guidelines](https://gethomepage.dev/latest/more/development/#service-widget-guidelines).
+- [ ] I have checked that all code style checks pass using [pre-commit hooks](https://gethomepage.dev/latest/more/development/#code-formatting-with-pre-commit-hooks) and [linting checks](https://gethomepage.dev/latest/more/development/#code-linting).
 - [ ] If applicable, I have tested my code for new features & regressions on both mobile & desktop devices, using the latest version of major browsers.
@@ -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,31 @@
+name: Crowdin Action
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '2 */12 * * *'
+  push:
+    paths: [
+      '/public/locales/en/**',
+    ]
+    branches: [ main ]
+
+jobs:
+  synchronize-with-crowdin:
+    name: Crowdin Sync
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: crowdin action
+      uses: crowdin/github-action@v1
+      with:
+        upload_translations: false
+        download_translations: true
+        crowdin_branch_name: main
+        localization_branch_name: l10n_main
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        CROWDIN_PROJECT_ID: ${{ secrets.CROWDIN_PROJECT_ID }}
+        CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
@@ -9,7 +9,9 @@ on:
  schedule:
    - cron: '20 0 * * *'
  push:
-    branches: [ "main" ]
+    branches:
+      - main
+      - feature/**
    # Publish semver tags as releases.
    tags: [ 'v*.*.*' ]
    paths-ignore:
@@ -39,12 +41,12 @@ jobs:
        uses: actions/checkout@v4
      -
        name: Install python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
        with:
          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
@@ -117,7 +119,7 @@ jobs:
        uses: docker/build-push-action@v5
        with:
          context: .
-          push: ${{ github.event_name != 'pull_request' }}
+          push: ${{ github.event_name != 'pull_request' && !(github.event_name == 'push' && startsWith(github.ref, 'refs/heads/feature')) }}
          tags: ${{ steps.meta.outputs.tags }}
          labels: ${{ steps.meta.outputs.labels }}
          build-args: |
@@ -27,12 +27,12 @@ jobs:
        uses: actions/checkout@v4
      -
        name: Install python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
        with:
          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
@@ -42,11 +42,11 @@ jobs:
      - pre-commit
    steps:
      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
        with:
          python-version: 3.x
      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
-      - uses: actions/cache@v3
+      - uses: actions/cache@v4
        with:
          key: mkdocs-material-${{ env.cache_id }}
          path: .cache
@@ -67,18 +67,18 @@ jobs:
      - uses: actions/checkout@v4
        with:
          ref: main
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
        with:
          python-version: 3.x
-      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
-      - uses: actions/cache@v3
+      - run: echo "cache_id=${{github.sha}}" >> $GITHUB_ENV
+      - uses: actions/cache@v4
        with:
          key: mkdocs-material-${{ env.cache_id }}
          path: .cache
          restore-keys: |
            mkdocs-material-
      - run: sudo apt-get install pngquant
-      - run: pip install mike
+      - run: pip install mike==2.0.0
      - run: pip install git+https://${GH_TOKEN}@github.com/benphelps/mkdocs-material-insiders.git
      - name: Set Git config
        run: |
@@ -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);
+              }
+            }
@@ -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!

 ## Write bug reports with detail, background, and sample configurations

@@ -42,7 +42,7 @@ Please see the [documentation regarding development](https://gethomepage.dev/lat

 ## Use a Consistent Coding Style

-Please see information in the docs regarding [code formatting with pre-commit hooks](https://gethomepage.dev/latest/more/development.md#code-formatting-with-pre-commit-hooks).
+Please see information in the docs regarding [code formatting with pre-commit hooks](https://gethomepage.dev/latest/more/development/#code-formatting-with-pre-commit-hooks).

 ## License

@@ -45,11 +45,11 @@ Homepage has built-in support for Docker, and can automatically discover and add

 ## Service Widgets

-Homepage also has support for over 100 3rd party services, including all popular starr apps, and most popular self-hosted apps. Some examples include: Radarr, Sonarr, Lidarr, Bazarr, Ombi, Tautulli, Plex, Jellyfin, Emby, Transmission, qBittorrent, Deluge, Jackett, NZBGet, SABnzbd, etc. As well as service integrations, Homepage also has a number of information providers, sourcing information from a variety of external 3rd party APIs. See the [Service](https://gethomepage.dev/latest/configs/service-widgets/) page for more information.
+Homepage also has support for over 100 3rd party services, including all popular starr apps, and most popular self-hosted apps. Some examples include: Radarr, Sonarr, Lidarr, Bazarr, Ombi, Tautulli, Plex, Jellyfin, Emby, Transmission, qBittorrent, Deluge, Jackett, NZBGet, SABnzbd, etc. As well as service integrations, Homepage also has a number of information providers, sourcing information from a variety of external 3rd party APIs. See the [Service](https://gethomepage.dev/latest/widgets/) page for more information.

 ## Information Widgets

-Homepage has built-in support for a number of information providers, including weather, time, date, search, glances and more. System and status information presented at the top of the page. See the [Information Providers](https://gethomepage.dev/latest/configs/widgets/) page for more information.
+Homepage has built-in support for a number of information providers, including weather, time, date, search, glances and more. System and status information presented at the top of the page. See the [Information Providers](https://gethomepage.dev/latest/widgets/) page for more information.

 ## Customization

@@ -164,9 +164,7 @@ 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 & Contributers
+## Contributing & Contributors

 Contributions are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information.

@@ -1,3 +1,6 @@
+project_id_env: CROWDIN_PROJECT_ID
+api_token_env: CROWDIN_PERSONAL_TOKEN
+preserve_hierarchy: true
 files:
  - source: /public/locales/en/*.json
    translation: /public/locales/%osx_locale%/%original_file_name%
@@ -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.
@@ -153,7 +153,7 @@ labels:
  - homepage.widget.fields=["field1","field2"] # optional
 ```

-You can add specify fields for e.g. the [CustomAPI](/widgets/services/customapi) widget by using array-style dot notation:
+You can add specify fields for e.g. the [CustomAPI](../widgets/services/customapi.md) widget by using array-style dot notation:

 ```yaml
 labels:
@@ -164,10 +164,10 @@ labels:
  - homepage.description=Media server
  - homepage.widget.type=customapi
  - homepage.widget.url=http://argus.service/api/v1/service/summary/emby
-  - homepage.widget.field[0].label=Deployed Version
-  - homepage.widget.field[0].field.status=deployed_version
-  - homepage.widget.field[1].label=Latest Version
-  - homepage.widget.field[1].field.status=latest_version
+  - homepage.widget.mappings[0].label=Deployed Version
+  - homepage.widget.mappings[0].field.status=deployed_version
+  - homepage.widget.mappings[1].label=Latest Version
+  - homepage.widget.mappings[1].field.status=latest_version
 ```

 ## Docker Swarm
@@ -201,6 +201,22 @@ In order to detect every service within the Docker swarm it is necessary that se
 ...
 ```

+## Multiple Homepage Instances
+
+The optional field `instanceName` can be configured in [settings.md](settings.md#instance-name) to differentiate between multiple homepage instances.
+
+To limit a label to an instance, insert `.instance.{{instanceName}}` after the `homepage` prefix.
+
+```yaml
+labels:
+  - homepage.group=Media
+  - homepage.name=Emby
+  - homepage.icon=emby.png
+  - homepage.instance.internal.href=http://emby.lan/
+  - homepage.instance.public.href=https://emby.mydomain.com/
+  - homepage.description=Media server
+```
+
 ## Ordering

 As of v0.6.4 discovered services can include an optional `weight` field to determine sorting such that:
@@ -79,6 +79,7 @@ metadata:
    gethomepage.dev/widget.url: "https://emby.example.com"
    gethomepage.dev/pod-selector: ""
    gethomepage.dev/weight: 10 # optional
+    gethomepage.dev/instance: "public" # optional
 spec:
  rules:
    - host: emby.example.com
@@ -95,6 +96,8 @@ spec:

 When the Kubernetes cluster connection has been properly configured, this service will be automatically discovered and added to your Homepage. **You do not need to specify the `namespace` or `app` values, as they will be automatically inferred.**

+If you are using multiple instances of homepage, an `instance` annotation can be specified to limit services to a specific instance. If no instance is provided, the service will be visible on all instances.
+
 ### Traefik IngressRoute support

 Homepage can also read ingresses defined using the Traefik IngressRoute custom resource definition. Due to the complex nature of Traefik routing rules, it is required for the `gethomepage.dev/href` annotation to be set:
@@ -116,6 +119,7 @@ metadata:
    gethomepage.dev/widget.url: "https://emby.example.com"
    gethomepage.dev/pod-selector: ""
    gethomepage.dev/weight: 10 # optional
+    gethomepage.dev/instance: "public" # optional
 spec:
  entryPoints:
    - websecure
@@ -5,7 +5,7 @@ description: Service Widget Configuration

 Unless otherwise noted, URLs should not end with a `/` or other API path. Each widget will handle the path on its own.

-Each service can have one widget attached to it (often matching the service type, but thats not forced).
+Each service can have one widget attached to it (often matching the service type, but that's not forced).

 In addition to the href of the service, you can also specify the target location in which to open that link. See [Link Target](settings.md#link-target) for more details.

@@ -101,30 +101,50 @@ 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 endpoint you chose and have the response time displayed. You do not need to set your ping URL equal to your href URL.
-
-!!! note
-
-    The ping feature works by making an http `HEAD` request to the URL, and falls back to `GET` in case that fails. It will not, for example, login if the URL requires auth or is behind e.g. Authelia. In the case of a reverse proxy and/or auth this usually requires the use of an 'internal' URL to make the ping feature correctly display status.
+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:
    - Sonarr:
        icon: sonarr.png
        href: http://sonarr.host/
-        ping: http://sonarr.host/
+        ping: sonarr.host

 - Group B:
    - Radarr:
        icon: radarr.png
        href: http://radarr.host/
-        ping: http://some.other.host/
+        ping: some.other.host
 ```

 <img width="1038" alt="Ping" src="https://github.com/gethomepage/homepage/assets/88257202/7bc13bd3-0d0b-44e3-888c-a20e069a3233">

 You can also apply different styles to the ping indicator by using the `statusStyle` property, see [settings](settings.md#status-style).

+## Site Monitor
+
+Services may have an optional `siteMonitor` property (formerly `ping`) that allows you to monitor the availability of a URL you chose and have the response time displayed. You do not need to set your monitor URL equal to your href or ping URL.
+
+!!! note
+
+    The site monitor feature works by making an http `HEAD` request to the URL, and falls back to `GET` in case that fails. It will not, for example, login if the URL requires auth or is behind e.g. Authelia. In the case of a reverse proxy and/or auth this usually requires the use of an 'internal' URL to make the site monitor feature correctly display status.
+
+```yaml
+- Group A:
+    - Sonarr:
+        icon: sonarr.png
+        href: http://sonarr.host/
+        siteMonitor: http://sonarr.host/
+
+- Group B:
+    - Radarr:
+        icon: radarr.png
+        href: http://radarr.host/
+        siteMonitor: http://some.other.host/
+```
+
+You can also apply different styles to the site monitor indicator by using the `statusStyle` property, see [settings](settings.md#status-style).
+
 ## Docker Integration

 Services may be connected to a Docker container, either running on the local machine, or a remote machine.
@@ -159,7 +179,7 @@ Services may be connected to a Docker container, either running on the local mac

 Services may also have a service widget (or integration) attached to them, this works independently of the Docker integration.

-You can find information and configuration for each of the supported integrations on the [Service Widgets](service-widgets.md) page.
+You can find information and configuration for each of the supported integrations on the [Widgets](../widgets/index.md) page.

 Here is an example of a Radarr & Sonarr service, with their respective integrations.

@@ -67,7 +67,7 @@ background:

 ### Card Background Blur

-You can apply a blur filter to the service & bookmark cards. Note this option is incompatible with the backround blur, saturate and brightness filters.
+You can apply a blur filter to the service & bookmark cards. Note this option is incompatible with the background blur, saturate and brightness filters.

 ```yaml
 cardBlur: sm # sm, "", md, etc... see https://tailwindcss.com/docs/backdrop-blur
@@ -229,6 +229,48 @@ 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.
+
+Global setting in `settings.yaml`:
+
+```yaml
+useEqualHeights: true
+```
+
+Per layout group in `settings.yaml`:
+
+```yaml
+useEqualHeights: false
+layout:
+  ...
+  Group Name:
+    useEqualHeights: true # overrides global setting
+```
+
+By default the feature is disabled
+
 ## Header Style

 There are currently 4 options for header styles, you can see each one below.
@@ -329,7 +371,7 @@ You can then pass `provider` instead of `apiKey` in your widget configuration.

 ## Quick Launch

-You can use the 'Quick Launch' feature to search services, perform a web search or open a URL. To use Quick Launch, just start typing while on your homepage (as long as the search widget doesnt have focus).
+You can use the 'Quick Launch' feature to search services, perform a web search or open a URL. To use Quick Launch, just start typing while on your homepage (as long as the search widget doesn't have focus).

 <img width="1000" alt="quicklaunch" src="https://user-images.githubusercontent.com/4887959/216880811-90ff72cb-2990-4475-889b-7c3a31e6beef.png">

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

@@ -382,11 +426,11 @@ If you have both set the per-service settings take precedence.

 ## Status Style

-You can choose from the following styles for docker or k8s status and ping: `dot` or `basic`
+You can choose from the following styles for docker or k8s status, site monitor and ping: `dot` or `basic`

- The default is no value, and displays the ping response time in ms and the docker / k8s container status
- `dot` shows a green dot for a successful ping or healthy status.
- `basic` shows either UP or DOWN for ping
+- The default is no value, and displays the monitor and ping response time in ms and the docker / k8s container status
+- `dot` shows a green dot for a successful monitor ping or healthy status.
+- `basic` shows either UP or DOWN for monitor & ping

 For example:

@@ -404,6 +448,16 @@ or per-service (`services.yaml`) with:

 If you have both set, the per-service settings take precedence.

+## Instance Name
+
+Name used by automatic docker service discovery to differentiate between multiple homepage instances.
+
+For example:
+
+```yaml
+instanceName: public
+```
+
 ## Hide Widget Error Messages

 Hide the visible API error messages either globally in `settings.yaml`:
@@ -422,4 +476,4 @@ or per service widget (`services.yaml`) with:
        hideErrors: true
 ```

-If either value is set to true, the errror message will be hidden.
+If either value is set to true, the error message will be hidden.
@@ -34,17 +34,22 @@ pnpm lint
 ## Code formatting with pre-commit hooks

 To ensure a consistent style and formatting across the project source, the project utilizes Git [`pre-commit`](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks) hooks to perform some formatting and linting before a commit is allowed.
-That way, everyone uses the same style and some common issues can be caught early on.

-Once installed, hooks will run when you commit. If the formatting isn't quite right or a linter catches something, the commit will be rejected.
-You'll need to look at the output and fix the issue. Some hooks will format failing files, so all you need to do is `git add` those files again
-and retry your commit.
+Once installed, hooks will run when you commit. If the formatting isn't quite right, the commit will be rejected and you'll need to look at the output and fix the issue. Most hooks will automatically format failing files, so all you need to do is `git add` those files again and retry your commit.
+
+See the [pre-commit documentation](https://pre-commit.com/#install) to get started.
+
+## New Feature Guidelines
+
+- 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'
+- 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
@@ -6,6 +6,10 @@ hide:
  - navigation
 ---

+## Introducing the Homepage AI Bot
+
+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

 - For API errors, clicking the "API Error Information" button in the widget will usually show some helpful information as to whether the issue is reaching the service host, an authentication issue, etc.
@@ -0,0 +1,35 @@
+var glimeScript;
+var glimeStyles = [];
+document$.subscribe(function () {
+  if (!glimeScript) {
+    glimeScript = document.createElement("script");
+    glimeScript.setAttribute("src", "https://cdn.glimelab.ai/widget/1.0.0/widget.js");
+    glimeScript.setAttribute("onload", "onGlimeLoad()");
+    document.head.appendChild(glimeScript);
+  } else {
+    var newGlimeStyle = document.createElement("style");
+    document.head.appendChild(newGlimeStyle);
+    var i = 0;
+    glimeStyles.forEach((rule) => {
+      newGlimeStyle.sheet.insertRule(rule.cssText, i);
+      i++;
+    });
+  }
+});
+
+onGlimeLoad = () => {
+  window.glime.init("Bl3mlvfCnTnRm5");
+  setTimeout(() => {
+    const sheets = document.styleSheets;
+    [...sheets].forEach((sheet) => {
+      if (!sheet.href) {
+        [...sheet.cssRules].forEach((rule) => {
+          if (!rule || rule.href || !rule.selectorText) return;
+          if (rule.selectorText.indexOf(".css-") === 0 || rule.selectorText.indexOf("glime") > -1) {
+            glimeStyles.push(rule);
+          }
+        });
+      }
+    });
+  }, 1000);
+};
@@ -18,3 +18,7 @@
        border-color: var(--md-default-bg-color--lighter);
    }
 }
+
+#glimeRoot * {
+    font-family: var(--md-text-font) !important;
+}
@@ -7,7 +7,7 @@ Homepage has two types of widgets: info and service. Below we'll cover each type

 ## Service Widgets

-Service widgets are used to display the status of a service, often a web service or API. Services (and their widgets) are defined in your `services.yml` file. Here's an example:
+Service widgets are used to display the status of a service, often a web service or API. Services (and their widgets) are defined in your `services.yaml` file. Here's an example:

 ```yaml
 - Plex:
@@ -24,7 +24,7 @@ Service widgets are used to display the status of a service, often a web service

 ## Info Widgets

-Info widgets are used to display information in the header, often about your system or environment. Info widgets are defined your `widgets.yml` file. Here's an example:
+Info widgets are used to display information in the header, often about your system or environment. Info widgets are defined your `widgets.yaml` file. Here's an example:

 ```yaml
 - openmeteo:
@@ -26,4 +26,12 @@ It can show the aggregate metrics and/or the individual node metrics.
      - node2
 ```

-The Longhorn URL and credentials are stored in the `providers` section of the `settings.yaml`.
+The Longhorn URL and credentials are stored in the `providers` section of the `settings.yaml`. e.g.:
+
+```yaml
+providers:
+  longhorn:
+    username: "longhorn-username" # optional
+    password: "very-secret-longhorn-password" # optional
+    url: https://longhorn.aesop.network
+```
@@ -3,7 +3,7 @@ title: OpenWeatherMap
 description: OpenWeatherMap Information Widget Configuration
 ---

-The free tier "One Call API" is all thats required, you will need to [subscribe](https://home.openweathermap.org/subscriptions/unauth_subscribe/onecall_30/base) and grab your API key.
+The free tier "One Call API" is all that's required, you will need to [subscribe](https://home.openweathermap.org/subscriptions/unauth_subscribe/onecall_30/base) and grab your API key.

 ```yaml
 - openweathermap:
@@ -9,7 +9,7 @@ The disk path is the path reported by `df` (Mounted On), or the mount point of t

 The cpu and memory resource information are the container's usage while [glances](glances.md) displays statistics for the host machine on which it is installed.

-_Note: unfortunately, the package used for getting CPU temp ([systeminformation](https://systeminformation.io)) is not compatibile with some setups and will not report any value(s) for CPU temp._
+_Note: unfortunately, the package used for getting CPU temp ([systeminformation](https://systeminformation.io)) is not compatible with some setups and will not report any value(s) for CPU temp._

 **Any disk you wish to access must be mounted to your container as a volume.**

@@ -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_
@@ -5,7 +5,7 @@ description: Weather API Information Widget Configuration

 **Note: this widget is considered 'deprecated' since there is no longer a free Weather API tier for new members. See the openmeteo or openweathermap widgets for alternatives.**

-The free tier is all thats required, you will need to [register](https://www.weatherapi.com/signup.aspx) and grab your API key.
+The free tier is all that's required, you will need to [register](https://www.weatherapi.com/signup.aspx) and grab your API key.

 ```yaml
 - weatherapi:
@@ -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,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.\
   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 atleast 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.\
   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)
@@ -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: Calendar
 description: Calendar widget
 ---

+## Monthly view
+
 <img alt="calendar" src="https://user-images.githubusercontent.com/5442891/271131282-6767a3ea-573e-4005-aeb9-6e14ee01e845.png">

 This widget shows monthly calendar, with optional integrations to show events from supported widgets.
@@ -11,15 +13,45 @@ This widget shows monthly calendar, with optional integrations to show events fr
 widget:
  type: calendar
  firstDayInWeek: sunday # optional - defaults to monday
+  view: monthly # optional - possible values monthly, agenda
+  maxEvents: 10 # optional - defaults to 10
+  showTime: true # optional - show time for event happening today - defaults to false
+  timezone: America/Los_Angeles # optional and only when timezone is not detected properly (slightly slower performance) - force timezone for ical events (if it's the same - no change, if missing or different in ical - will be converted to this timezone)
  integrations: # optional
-    - type: sonarr # active widget type that is currently enabled on homepage - possible values: radarr, sonarr, lidarr, readarr
+    - type: sonarr # active widget type that is currently enabled on homepage - possible values: radarr, sonarr, lidarr, readarr, ical
      service_group: Media # group name where widget exists
      service_name: Sonarr # service name for that widget
      color: teal # optional - defaults to pre-defined color for the service (teal for sonarr)
      params: # optional - additional params for the service
        unmonitored: true # optional - defaults to false, used with *arr stack
+    - type: ical # Show calendar events from another service
+      url: https://domain.url/with/link/to.ics # URL with calendar events
+      name: My Events # required - name for these calendar events
+      color: zinc # optional - defaults to pre-defined color for the service (zinc for ical)
+      params: # optional - additional params for the service
+        showName: true # optional - show name before event title in event line - defaults to false
 ```

+## Agenda
+
+This view shows only list of events from configured integrations
+
+```yaml
+widget:
+  type: calendar
+  view: agenda
+  maxEvents: 10 # optional - defaults to 10
+  showTime: true # optional - show time for event happening today - defaults to false
+  previousDays: 3 # optional - shows events since three days ago - defaults to 0
+  integrations: # same as in Monthly view example
+```
+
+## Integrations
+
 Currently integrated widgets are [sonarr](sonarr.md), [radarr](radarr.md), [lidarr](lidarr.md) and [readarr](readarr.md).

 Supported colors can be found on [color palette](../../configs/settings.md#color-palette).
+
+### iCal
+
+This custom integration allows you to show events from any calendar that supports iCal format, for example, Google Calendar (go to `Settings`, select specific calendar, go to `Integrate calendar`, copy URL from `Public Address in iCal format`).
@@ -3,7 +3,9 @@ title: Calibre-web
 description: Calibre-web Widget Configuration
 ---

-**Note: this widget requires a feature of calibre-web that has not yet been distributed in versioned release. The code is contained in ["nightly" lsio builds after 25/8/23](https://hub.docker.com/layers/linuxserver/calibre-web/nightly/images/sha256-b27cbe5d17503de38135d925e226eb3e5ba04c558dbc865dc85d77824d35d7e2) or running the calibre-web source code including commit [0499e57](https://github.com/janeczku/calibre-web/commit/0499e578cdd45db656da34cd2d7152c8d88ceb23).**
+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:
@@ -31,9 +31,23 @@ widget:
            another: key3
      label: Field 3
      format: percent # optional - defaults to text
+    - field: key # needs to be YAML string or object
+      label: Field 4
+      format: date # optional - defaults to text
+      locale: nl # optional
+      dateStyle: long # optional - defaults to "long". Allowed values: `["full", "long", "medium", "short"]`.
+      timeStyle: medium # optional - Allowed values: `["full", "long", "medium", "short"]`.
+    - field: key # needs to be YAML string or object
+      label: Field 5
+      format: relativeDate # optional - defaults to text
+      locale: nl # optional
+      style: short # optional - defaults to "long". Allowed values: `["long", "short", "narrow"]`.
+      numeric: auto # optional - defaults to "always". Allowed values `["always", "auto"]`.
 ```

-Supported formats for the values are `text`, `number`, `float`, `percent`, `bytes` and `bitrate`.
+Supported formats for the values are `text`, `number`, `float`, `percent`, `bytes`, `bitrate`, `date` and `relativeDate`.
+
+The `dateStyle` and `timeStyle` options of the `date` format are passed directly to [Intl.DateTimeFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat) and the `style` and `numeric` options of `relativeDate` are passed to [Intl.RelativeTimeFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/RelativeTimeFormat/RelativeTimeFormat).

 ## Example

@@ -60,7 +74,7 @@ For the following JSON object from the API:
 }
 ```

-Define the `mappings` section as an aray, for example:
+Define the `mappings` section as an array, for example:

 ```yaml
 mappings:
@@ -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"]`.
@@ -0,0 +1,22 @@
+---
+title: FRITZ!Box
+description: FRITZ!Box Widget Configuration
+---
+
+Application access & UPnP must be activated on your device:
+
+```
+Home Network > Network > Network Settings > Access Settings in the Home Network
+[x] Allow access for applications
+[x] Transmit status information over UPnP
+```
+
+Credentials are not needed and, as such, you may want to consider using `http` instead of `https` as those requests are significantly faster.
+
+Allowed fields (limited to a max of 4): `["connectionStatus", "uptime", "maxDown", "maxUp", "down", "up", "received", "sent", "externalIPAddress"]`.
+
+```yaml
+widget:
+  type: fritzbox
+  url: http://192.168.178.1
+```
@@ -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))_
@@ -18,7 +20,7 @@ widget:
  metric: cpu
 ```

-_Please note, this widget does not need an `href`, `icon` or `description` on its parent service. To achive the same effect as the examples above, see as an example:_
+_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:_

 ```yaml
 - CPU Usage:
@@ -45,15 +47,15 @@ The metric field in the configuration determines the type of system monitoring d

 `process`: Top 5 processes based on CPU usage. Gives an overview of which processes are consuming the most resources.

-`network:<interface_name>`: Network data usage for the specified interface. Replace `<interface_name>` with the name of your network interface, e.g., `network:enp0s25`, as specificed in glances.
+`network:<interface_name>`: Network data usage for the specified interface. Replace `<interface_name>` with the name of your network interface, e.g., `network:enp0s25`, as specified in glances.

-`sensor:<sensor_id>`: Temperature of the specified sensor, typically used to monitor CPU temperature. Replace `<sensor_id>` with the name of your sensor, e.g., `sensor:Package id 0` as specificed in glances.
+`sensor:<sensor_id>`: Temperature of the specified sensor, typically used to monitor CPU temperature. Replace `<sensor_id>` with the name of your sensor, e.g., `sensor:Package id 0` as specified in glances.

-`disk:<disk_id>`: Disk I/O data for the specified disk. Replace `<disk_id>` with the id of your disk, e.g., `disk:sdb`, as specificed in glances.
+`disk:<disk_id>`: Disk I/O data for the specified disk. Replace `<disk_id>` with the id of your disk, e.g., `disk:sdb`, as specified in glances.

-`gpu:<gpu_id>`: GPU usage for the specified GPU. Replace `<gpu_id>` with the id of your GPU, e.g., `gpu:0`, as specificed in glances.
+`gpu:<gpu_id>`: GPU usage for the specified GPU. Replace `<gpu_id>` with the id of your GPU, e.g., `gpu:0`, as specified in glances.

-`fs:<mnt_point>`: Disk usage for the specified mount point. Replace `<mnt_point>` with the path of your disk, e.g., `/mnt/storage`, as specificed in glances.
+`fs:<mnt_point>`: Disk usage for the specified mount point. Replace `<mnt_point>` with the path of your disk, e.g., `/mnt/storage`, as specified in glances.

 ## Views

@@ -61,7 +63,7 @@ All widgets offer an alternative to the full or "graph" view, which is the compa

 <img width="970" alt="Screenshot 2023-09-06 at 1 51 48 PM" src="https://github-production-user-asset-6210df.s3.amazonaws.com/82196/265985295-cc6b9adc-4218-4274-96ca-36c3e64de5d0.png">

-To switch to the alternative "graphless" view, simply passs `chart: false` as an option to the widget, like so:
+To switch to the alternative "graphless" view, simply pass `chart: false` as an option to the widget, like so:

 ```yaml
 - Network Usage:
@@ -3,12 +3,16 @@ title: Gluetun
 description: Gluetun Widget Configuration
 ---

-Requires [HTTP control server options](https://github.com/qdm12/gluetun-wiki/blob/main/setup/advanced/control-server.md) to be enabled.
+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`.

 Allowed fields: `["public_ip", "region", "country"]`.

 ```yaml
 widget:
  type: gluetun
-  url: http://gluetun.host.or.ip
+  url: http://gluetun.host.or.ip:port
 ```
@@ -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,18 +3,23 @@ title: Health checks
 description: Health checks Widget Configuration
 ---

-To use the Health Checks widget, you first need to generate an API key. To do this, follow these steps:
+Learn more about [Health Checks](https://github.com/healthchecks/healthchecks).

-1. Go to Settings in your check dashboard.
+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.
+
+To use the Health Checks widget, you first need to generate an API key.
+
+1. In your project, go to project Settings on the navigation bar.
 2. Click on API key (read-only) and then click _Create_.
 3. Copy the API key that is generated for you.

-Allowed fields: `["status", "last_ping"]`.
+Allowed fields: `["status", "last_ping"]` for single checks, `["up", "down"]` for total stats.

 ```yaml
 widget:
  type: healthchecks
  url: http://healthchecks.host.or.ip:port
  key: <YOUR_API_KEY>
-  uuid: <YOUR_CHECK_UUID>
+  uuid: <CHECK_UUID> # optional, if not included total statistics for all checks is shown
 ```
@@ -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"]`.
@@ -0,0 +1,35 @@
+---
+title: iFrame
+Description: Add a custom iFrame Widget
+---
+
+A basic iFrame widget to show external content, see the [MDN docs](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe) for more details about some of the options.
+
+!!! warning
+
+    Requests made via the iFrame widget are inherently **not proxied** as they are made from the browser itself.
+
+## Basic Example
+
+```yaml
+widget:
+  type: iframe
+  name: myIframe
+  src: http://example.com
+```
+
+## Full Example
+
+```yaml
+widget:
+  type: iframe
+  name: myIframe
+  src: http://example.com
+  classes: h-60 sm:h-60 md:h-60 lg:h-60 xl:h-60 2xl:h-72 # optional, use tailwind height classes, see https://tailwindcss.com/docs/height
+  referrerPolicy: same-origin # optional, no default
+  allowPolicy: autoplay; fullscreen; gamepad # optional, no default
+  allowFullscreen: false # optional, default: true
+  loadingStrategy: eager # optional, default: eager
+  allowScrolling: no # optional, default: yes
+  refreshInterval: 2000 # optional, no default
+```
@@ -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.
@@ -0,0 +1,14 @@
+---
+title: Netdata
+description: Netdata Widget Configuration
+---
+
+Learn more about [Netdata](https://github.com/netdata/netdata).
+
+Allowed fields: `["warnings", "criticals"]`.
+
+```yaml
+widget:
+  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"]`.
@@ -0,0 +1,23 @@
+---
+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"]`
+
+!!! note
+
+    This widget requires an additional tool, [PeaNUT](https://github.com/Brandawg93/PeaNUT), as noted. Other projects exist to achieve similar results using a `customapi` widget, for example [NUTCase](https://github.com/ArthurMitchell42/nutcase#using-nutcase-homepage).
+
+```yaml
+widget:
+  type: peanut
+  url: http://peanut.host.or.ip:port
+  key: nameofyourups
+```
@@ -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