Merge branch 'main' into dev

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

.babelrc

@@ -1,3 +0,0 @@
-{
-  "presets": ["next/babel"]
-}

.dockerignore

@@ -16,11 +16,11 @@
 **/compose*
 **/Dockerfile*
 **/node_modules
+!.next/standalone/node_modules
 **/npm-debug.log
 **/obj
 **/secrets.dev.yaml
 **/values.dev.yaml
-**/.next
 README.md
 config/
 k3d/

.eslintrc.json

@@ -1,5 +1,9 @@
 {
-  "extends": ["airbnb", "next/core-web-vitals", "prettier"],
+  "extends": [
+    "next/core-web-vitals",
+    "prettier",
+    "plugin:react-hooks/recommended"
+  ],
   "plugins": ["prettier"],
   "rules": {
     "import/no-cycle": [
@@ -13,6 +17,12 @@
       {
         "newlines-between": "always"
       }
+    ],
+    "no-else-return": [
+      "error",
+      {
+        "allowElseIf": true
+      }
     ]
   },
   "settings": {
@@ -21,5 +31,12 @@
         "paths": ["src"]
       }
     }
+  },
+  "parserOptions": {
+    "ecmaVersion": 6,
+    "sourceType": "module",
+    "ecmaFeatures": {
+      "modules": true
+    }
   }
 }

.github/DISCUSSION_TEMPLATE/support.yml

@@ -1,4 +1,11 @@
 body:
+  - type: markdown
+    attributes:
+      value: |
+        ### ⚠️ Before opening a discussion:
+
+        - [Check the troubleshooting guide](https://gethomepage.dev/troubleshooting/) and include the output of all steps below.
+        - [Search existing issues](https://github.com/gethomepage/homepage/search?q=&type=issues) [and discussions](https://github.com/gethomepage/homepage/search?q=&type=discussions) (including closed ones!).
   - type: textarea
     id: description
     attributes:
@@ -44,6 +51,14 @@ body:
     id: troubleshooting
     attributes:
       label: Troubleshooting
-      description: Please include output from your [troubleshooting tests](https://gethomepage.dev/latest/more/troubleshooting/#service-widget-errors), if relevant.
+      description: Please include output from your [troubleshooting steps](https://gethomepage.dev/more/troubleshooting/#service-widget-errors), if relevant.
     validations:
       required: true
+  - type: markdown
+    attributes:
+      value: |
+        ## ⚠️ STOP ⚠️
+
+        Before you submit this support request, please ensure you have entered your configuration files and actually followed the steps from the troubleshooting guide linked above *and posted the output*, if relevant. The troubleshooting steps often help to solve the problem or at least can help figure it out.
+
+        *Please remember that this project is maintained by regular people **just like you**, so if you don't take the time to fill out the requested information, don't expect a reply back.*

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -13,7 +13,7 @@ body:
     attributes:
       label: Before submitting, please confirm the following
       options:
-        - label: I confirm this was discussed, and the maintainers suggest I open an issue (note that AI bots are not maintainers).
+        - label: I confirm this was discussed, and the maintainers asked that I open an issue.
           required: true
         - label: I am aware that if I create this issue without a discussion, it will be removed without a response.
           required: true

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,11 +1,20 @@
+<!--
+==== STOP ====================
+======== STOP ================
+============ STOP ============
+================ STOP ========
+==================== STOP ====
+
+⚠️ Before opening this pull request please review the guidelines in the checklist below.
+
+If this PR does not meet those guidelines it will not be accepted, and everyone will be sad.
+-->
+
 ## Proposed change
 
 <!--
 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 API output as well as updates to the docs for the new widget.
 -->
 
@@ -19,13 +28,13 @@ What type of change does your PR introduce to Homepage?
 
 - [ ] New service widget
 - [ ] Bug fix (non-breaking change which fixes an issue)
-- [ ] New feature (non-breaking change which adds functionality)
+- [ ] New feature or enhancement (non-breaking change which adds functionality)
 - [ ] Documentation only
 - [ ] Other (please explain)
 
 ## Checklist:
 
 - [ ] 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 reviewed the [feature / enhancement](https://gethomepage.dev/more/development/#new-feature-guidelines) and / or [service widget guidelines](https://gethomepage.dev/more/development/#service-widget-guidelines).
+- [ ] I have checked that all code style checks pass using [pre-commit hooks](https://gethomepage.dev/more/development/#code-formatting-with-pre-commit-hooks) and [linting checks](https://gethomepage.dev/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.

.github/workflows/crowdin.yml

@@ -8,7 +8,7 @@ on:
     paths: [
       '/public/locales/en/**',
     ]
-    branches: [ main ]
+    branches: [ dev ]
 
 jobs:
   synchronize-with-crowdin:
@@ -17,14 +17,14 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v4
+      uses: actions/checkout@v5
     - name: crowdin action
       uses: crowdin/github-action@v2
       with:
         upload_translations: false
         download_translations: true
-        crowdin_branch_name: main
-        localization_branch_name: l10n_main
+        crowdin_branch_name: dev
+        localization_branch_name: l10n_dev
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         CROWDIN_PROJECT_ID: ${{ secrets.CROWDIN_PROJECT_ID }}

.github/workflows/docker-publish.yml

@@ -1,9 +1,4 @@
-name: Docker
-
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
+name: Docker CI
 
 on:
   schedule:
@@ -12,142 +7,150 @@ on:
     branches:
       - main
       - feature/**
-    # Publish semver tags as releases.
+      - dev
     tags: [ 'v*.*.*' ]
-    paths-ignore:
-      - 'docs/**'
-      - 'mkdocs.yml'
   pull_request:
-    branches: [ "main" ]
-    paths-ignore:
-      - 'docs/**'
-      - 'mkdocs.yml'
+    branches: [ "dev" ]
   merge_group:
 
 env:
-  # Use docker.io for Docker Hub if empty
-  REGISTRY: ghcr.io
-  # github.repository as <account>/<repo>
   IMAGE_NAME: ${{ github.repository }}
 
-
 jobs:
   pre-commit:
     name: Linting Checks
     runs-on: ubuntu-22.04
     steps:
-      -
-        name: Checkout repository
-        uses: actions/checkout@v4
-      -
-        name: Install python
+      - name: Checkout repository
+        uses: actions/checkout@v5
+
+      - name: Install python
         uses: actions/setup-python@v5
         with:
           python-version: 3.x
-      -
-        name: Check files
+
+      - name: Check files
         uses: pre-commit/action@v3.0.1
 
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          run_install: false
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'pnpm'
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Lint frontend
+        run: pnpm run lint
+
   build:
     name: Docker Build & Push
-    if:  github.repository == 'gethomepage/homepage'
+    if: github.repository == 'gethomepage/homepage'
     runs-on: self-hosted
-    needs:
-      - pre-commit
+    needs: [ pre-commit ]
     permissions:
       contents: read
       packages: write
-      # This is used to complete the identity challenge
-      # with sigstore/fulcio when running outside of PRs.
       id-token: write
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
-      # Install the cosign tool except on PR
-      # https://github.com/sigstore/cosign-installer
-      - name: Install cosign
-        if: github.event_name != 'pull_request'
-        uses: sigstore/cosign-installer@main
-        with:
-          cosign-release: 'v1.13.1' # optional
-
-      # Setup QEMU
-      # https://github.com/marketplace/actions/docker-setup-buildx#with-qemu
-      - name: Setup QEMU
-        uses: docker/setup-qemu-action@v3
-
-      # Workaround: https://github.com/docker/build-push-action/issues/461
-      - name: Setup Docker buildx
-        uses: docker/setup-buildx-action@v3
-
-      # This step is being disabled because the runner is on a self-hosted machine
-      # where the cache will stick between runs.
-      # - name: Cache Docker layers
-      #   uses: actions/cache@v3
-      #   with:
-      #     path: /tmp/.buildx-cache
-      #     key: ${{ runner.os }}-buildx-${{ github.sha }}
-      #     restore-keys: |
-      #       ${{ runner.os }}-buildx-
-
-      # Login against a Docker registry except on PR
-      # https://github.com/docker/login-action
-      - name: Log into registry ${{ env.REGISTRY }}
-        if: github.event_name != 'pull_request'
-        uses: docker/login-action@v3
-        with:
-          registry: ${{ env.REGISTRY }}
-          username: ${{ github.actor }}
-          password: ${{ secrets.GITHUB_TOKEN }}
-
-      # Extract metadata (tags, labels) for Docker
-      # https://github.com/docker/metadata-action
       - name: Extract Docker metadata
         id: meta
         uses: docker/metadata-action@v5
         with:
-          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          images: |
+            ${{ env.IMAGE_NAME }}
+            ghcr.io/${{ env.IMAGE_NAME }}
+          tags: |
+            # Default tags
+            type=schedule,pattern=nightly
+            type=ref,event=branch
+            type=ref,event=tag
+            # Versioning tags
+            type=semver,pattern=v{{version}}
+            type=semver,pattern=v{{major}}.{{minor}}
+            type=semver,pattern=v{{major}}
           flavor: |
             latest=auto
 
-      # Build and push Docker image with Buildx (don't push on PR)
-      # https://github.com/docker/build-push-action
+      - name: Next.js build cache
+        uses: actions/cache@v4
+        with:
+          path: .next/cache
+          key: nextjs-${{ runner.os }}-${{ hashFiles('pnpm-lock.yaml') }}-${{ hashFiles('**/*.js', '**/*.jsx') }}
+          restore-keys: |
+            nextjs-${{ runner.os }}-${{ hashFiles('pnpm-lock.yaml') }}
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          run_install: false
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'pnpm'
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Build app
+        run: |
+          NEXT_PUBLIC_BUILDTIME="${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.created'] }}" \
+          NEXT_PUBLIC_VERSION="${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.version'] }}" \
+          NEXT_PUBLIC_REVISION="${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.revision'] }}" \
+          pnpm run build
+
+      - name: Log into registry ${{ env.REGISTRY }}
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Login to Docker Hub
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Setup QEMU
+        uses: docker/setup-qemu-action@v3.6.0
+
+      - name: Setup Docker buildx
+        uses: docker/setup-buildx-action@v3
+
       - name: Build and push Docker image
         id: build-and-push
         uses: docker/build-push-action@v6
         with:
           context: .
-          push: ${{ github.event_name != 'pull_request' && !(github.event_name == 'push' && startsWith(github.ref, 'refs/heads/feature')) }}
+          push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
           build-args: |
+            CI=true
             BUILDTIME=${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.created'] }}
             VERSION=${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.version'] }}
             REVISION=${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.revision'] }}
-          # https://github.com/docker/setup-qemu-action#about
-          # platforms: linux/amd64,linux/arm64,linux/riscv64,linux/ppc64le,linux/s390x,linux/386,linux/mips64le,linux/mips64,linux/arm/v7,linux/arm/v6
-          platforms: linux/amd64,linux/arm64,linux/arm/v7,linux/arm/v6
+          platforms: linux/amd64,linux/arm64
+          provenance: false
           cache-from: type=local,src=/tmp/.buildx-cache
           cache-to: type=local,dest=/tmp/.buildx-cache-new,mode=max
 
-      # Sign the resulting Docker image digest except on PRs.
-      # This will only write to the public Rekor transparency log when the Docker
-      # repository is public to avoid leaking data.  If you would like to publish
-      # transparency data even for private images, pass --force to cosign below.
-      # https://github.com/sigstore/cosign
-#       - name: Sign the published Docker image
-#         if: ${{ github.event_name != 'pull_request' }}
-#         env:
-#           COSIGN_EXPERIMENTAL: "true"
-#         # This step uses the identity token to provision an ephemeral certificate
-#         # against the sigstore community Fulcio instance.
-#         run: echo "${{ steps.meta.outputs.tags }}" | xargs -I {} cosign sign {}@${{ steps.build-and-push.outputs.digest }}
-
-      # Temp fix
-      # https://github.com/docker/build-push-action/issues/252
-      # https://github.com/moby/buildkit/issues/1896
+      # https://github.com/docker/build-push-action/issues/252 / https://github.com/moby/buildkit/issues/1896
       - name: Move cache
         run: |
           rm -rf /tmp/.buildx-cache

.github/workflows/docs-publish.yml

@@ -4,13 +4,7 @@ on:
   push:
     tags: ["v*.*.*"]
     branches: ["main"]
-    paths:
-      - "docs/**"
-      - "mkdocs.yml"
   pull_request:
-    paths:
-      - "docs/**"
-      - "mkdocs.yml"
   merge_group:
   workflow_dispatch:
 
@@ -23,7 +17,7 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Install python
         uses: actions/setup-python@v5
         with:
@@ -32,13 +26,13 @@ jobs:
         uses: pre-commit/action@v3.0.1
 
   test:
-    name: Test Build
+    name: Test Build Docs
     if: github.repository == 'gethomepage/homepage' && github.event_name == 'pull_request'
     runs-on: ubuntu-latest
     needs:
       - pre-commit
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - uses: actions/setup-python@v5
         with:
           python-version: 3.x
@@ -50,20 +44,21 @@ jobs:
           restore-keys: |
             mkdocs-material-
       - run: sudo apt-get install pngquant
-      - run: pip install mike
       - run: pip install mkdocs-material mkdocs-redirects "mkdocs-material[imaging]"
       - name: Test Docs Build
         run: MKINSIDERS=false mkdocs build
   deploy:
-    name: Build & Deploy
-    if: github.repository == 'gethomepage/homepage' && github.event_name != 'pull_request'
+    name: Build & Deploy Docs
+    if: github.repository == 'gethomepage/homepage' && github.event_name != 'pull_request' && github.ref == 'refs/heads/main'
     runs-on: ubuntu-latest
     needs:
       - pre-commit
     steps:
-      - uses: actions/checkout@v4
-        with:
-          ref: main
+      - uses: actions/checkout@v5
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
       - uses: actions/setup-python@v5
         with:
           python-version: 3.x
@@ -75,24 +70,9 @@ jobs:
           restore-keys: |
             mkdocs-material-
       - run: sudo apt-get install pngquant
-      - run: pip install mike==2.0.0
       - run: pip install git+https://${GH_TOKEN}@github.com/benphelps/mkdocs-material-insiders.git
       - run: pip install mkdocs-redirects "mkdocs-material[imaging]"
-      - name: Set Git config
-        run: |
-          git config --global user.name "GitHub Action"
-          git config --global user.email "action@github.com"
-      - name: Sync gh-pages
-        run: |
-          git fetch origin gh-pages
-          git checkout gh-pages
-          git pull origin gh-pages
-          git checkout main
-      - name: Docs Deploy for Main
-        if: github.ref == 'refs/heads/main'
-        run: MKINSIDERS=true mike deploy --update --push ${{github.ref_name}}
-      - name: Docs Deploy for Tags
-        if: github.ref != 'refs/heads/main'
-        run: MKINSIDERS=true mike deploy --update --push ${{github.ref_name}} latest
+      - name: Docs Deploy
+        run: MKINSIDERS=true mkdocs gh-deploy --force
 env:
   GH_TOKEN: ${{ secrets.GH_TOKEN }}

.github/workflows/reaction-comments.yml

@@ -0,0 +1,18 @@
+name: 'Reaction Comments'
+
+on:
+  issue_comment:
+    types: [created, edited]
+  pull_request_review_comment:
+    types: [created, edited]
+
+permissions:
+  actions: write
+  issues: write
+  pull-requests: write
+
+jobs:
+  action:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: dessant/reaction-comments@v4

.github/workflows/repo-maintenance.yml

@@ -212,9 +212,9 @@ jobs:
             }
 
             const CUTOFF_1_DAYS = 180;
-            const CUTOFF_1_COUNT = 5;
+            const CUTOFF_1_COUNT = 20;
             const CUTOFF_2_DAYS = 365;
-            const CUTOFF_2_COUNT = 10;
+            const CUTOFF_2_COUNT = 40;
 
             const cutoff1Date = new Date();
             cutoff1Date.setDate(cutoff1Date.getDate() - CUTOFF_1_DAYS);

.pre-commit-config.yaml

@@ -9,11 +9,14 @@ repos:
     -   id: check-yaml
         exclude: "(^mkdocs\\.yml$)"
     -   id: check-added-large-files
--   repo: https://github.com/pre-commit/mirrors-prettier
-    rev: 'v3.0.3'
+-   repo: https://github.com/rbubley/mirrors-prettier
+    rev: 'v3.3.3'
     hooks:
     -   id: prettier
         types_or:
           - javascript
           - markdown
           - jsx
+        additional_dependencies:
+          - prettier@3.3.3
+          - 'prettier-plugin-organize-imports@4.1.0'

.prettierrc

@@ -1 +0,0 @@
-{}

.prettierrc.js

@@ -0,0 +1,5 @@
+const config = {
+  plugins: [require("prettier-plugin-organize-imports")],
+};
+
+module.exports = config;

.vscode/launch.json

@@ -1,19 +1,31 @@
 {
-  // Use IntelliSense to learn about possible attributes.
-  // Hover to view descriptions of existing attributes.
-  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-  "version": "0.2.0",
   "configurations": [
     {
-      "name": "Next.js: debug full stack",
+      "name": "Debug homepage",
       "type": "node",
       "request": "launch",
-      "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/next",
-      "serverReadyAction": {
-        "pattern": "started server on .+, url: (https?://.+)",
-        "uriFormat": "%s",
-        "action": "debugWithChrome"
+      "runtimeExecutable": "pnpm",
+      "runtimeArgs": ["run", "dev"],
+      "env": {
+        "LOG_LEVEL": "debug"
+      },
+      "skipFiles": ["<node_internals>/**"],
+      "console": "integratedTerminal",
+      "serverReadyAction":{
+        "pattern": ".*http://localhost:3000.*",
+        "action": "startDebugging",
+        "name": "Launch Chromium",
+        "killOnServerStop": true,
       }
+    },
+    {
+      "name": "Launch Chromium",
+      "type": "chrome",
+      "request": "launch",
+      "url": "http://localhost:3000",
+      "urlFilter": "http://localhost:3000",
+      "webRoot": "${workspaceFolder}",
+      "trace": true
     }
   ]
 }

CONTRIBUTING.md

@@ -38,11 +38,11 @@ People _love_ thorough bug reports. I'm not even kidding.
 
 ## Development Guidelines
 
-Please see the [documentation regarding development](https://gethomepage.dev/latest/more/development/) and specifically the [guidelines for new service widgets](https://gethomepage.dev/latest/more/development/#service-widget-guidelines) if you are considering making one.
+Please see the [documentation regarding development](https://gethomepage.dev/more/development/) and specifically the [guidelines for new service widgets](https://gethomepage.dev/more/development/#service-widget-guidelines) if you are considering making one.
 
 ## Use a Consistent Coding Style
 
-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).
+Please see information in the docs regarding [code formatting with pre-commit hooks](https://gethomepage.dev/more/development/#code-formatting-with-pre-commit-hooks).
 
 ## License
 
@@ -63,7 +63,7 @@ The homepage team appreciates all effort and interest from the community in fili
 - 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.
+- Feature requests that do not meet the following thresholds will be closed: 20 "up-votes" after 180 days of inactivity or 40 "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.

Dockerfile

@@ -1,66 +1,63 @@
-# syntax = docker/dockerfile:latest
-
-# Install dependencies only when needed
-FROM docker.io/node:18-alpine AS deps
-
+# =========================
+# Builder Stage
+# =========================
+FROM node:22-slim AS builder
 WORKDIR /app
 
-COPY --link package.json pnpm-lock.yaml* ./
-
-SHELL ["/bin/ash", "-xeo", "pipefail", "-c"]
-RUN apk add --no-cache libc6-compat \
- && apk add --no-cache --virtual .gyp python3 make g++ \
- && npm install -g pnpm
-
-RUN --mount=type=cache,id=pnpm-store,target=/root/.local/share/pnpm/store pnpm fetch | grep -v "cross-device link not permitted\|Falling back to copying packages from store"
-
-RUN --mount=type=cache,id=pnpm-store,target=/root/.local/share/pnpm/store pnpm install -r --offline
-
-# Rebuild the source code only when needed
-FROM docker.io/node:18-alpine AS builder
-WORKDIR /app
+# Setup
+RUN mkdir config
+COPY . .
 
+ARG CI
 ARG BUILDTIME
 ARG VERSION
 ARG REVISION
+ENV CI=$CI
 
-COPY --link --from=deps /app/node_modules ./node_modules/
-COPY . .
+# Install and build only outside CI
+RUN if [ "$CI" != "true" ]; then \
+      corepack enable && corepack prepare pnpm@latest --activate && \
+      pnpm install --frozen-lockfile --prefer-offline && \
+      NEXT_TELEMETRY_DISABLED=1 \
+      NEXT_PUBLIC_BUILDTIME=$BUILDTIME \
+      NEXT_PUBLIC_VERSION=$VERSION \
+      NEXT_PUBLIC_REVISION=$REVISION \
+      pnpm run build; \
+    else \
+      echo "✅ Using prebuilt app from CI context"; \
+    fi
 
-SHELL ["/bin/ash", "-xeo", "pipefail", "-c"]
-RUN npm run telemetry \
- && mkdir config \
- && NEXT_PUBLIC_BUILDTIME=$BUILDTIME NEXT_PUBLIC_VERSION=$VERSION NEXT_PUBLIC_REVISION=$REVISION npm run build
-
-# Production image, copy all the files and run next
-FROM docker.io/node:18-alpine AS runner
-LABEL org.opencontainers.image.title "Homepage"
-LABEL org.opencontainers.image.description "A self-hosted services landing page, with docker and service integrations."
+# =========================
+# Runtime Stage
+# =========================
+FROM node:22-alpine AS runner
+LABEL org.opencontainers.image.title="Homepage"
+LABEL org.opencontainers.image.description="A self-hosted services landing page, with docker and service integrations."
 LABEL org.opencontainers.image.url="https://github.com/gethomepage/homepage"
 LABEL org.opencontainers.image.documentation='https://github.com/gethomepage/homepage/wiki'
 LABEL org.opencontainers.image.source='https://github.com/gethomepage/homepage'
 LABEL org.opencontainers.image.licenses='Apache-2.0'
 
-ENV NODE_ENV production
-
+# Setup
 WORKDIR /app
 
-# Copy files from context (this allows the files to copy before the builder stage is done).
-COPY --link --chown=1000:1000 package.json next.config.js ./
+# Copy some files from context
 COPY --link --chown=1000:1000 /public ./public/
-
-# Copy files from builder
-COPY --link --from=builder --chown=1000:1000 /app/.next/standalone ./
-COPY --link --from=builder --chown=1000:1000 /app/.next/static/ ./.next/static/
 COPY --link --chmod=755 docker-entrypoint.sh /usr/local/bin/
 
-RUN apk add --no-cache su-exec
+# Copy only necessary files from the build stage
+COPY --link --from=builder --chown=1000:1000 /app/.next/standalone/ ./
+COPY --link --from=builder --chown=1000:1000 /app/.next/static/ ./.next/static
 
-ENV PORT 3000
+RUN apk add --no-cache su-exec iputils-ping shadow
+
+ENV NODE_ENV=production
+ENV HOSTNAME=0.0.0.0
+ENV PORT=3000
 EXPOSE $PORT
 
 HEALTHCHECK --interval=10s --timeout=3s --start-period=20s \
-  CMD wget --no-verbose --tries=1 --spider --no-check-certificate http://localhost:$PORT/api/healthcheck || exit 1
+  CMD wget --no-verbose --tries=1 --spider http://127.0.0.1:$PORT/api/healthcheck || exit 1
 
 ENTRYPOINT ["docker-entrypoint.sh"]
 CMD ["node", "server.js"]

Dockerfile-tilt

@@ -10,7 +10,7 @@ RUN <<EOF
     apk add libc6-compat
     apk add --virtual .gyp python3 make g++
     npm install -g pnpm
-    npm install -g next
+    pnpm install -g next
 EOF
 
 RUN --mount=type=cache,id=pnpm-store,target=/root/.local/share/pnpm/store pnpm fetch | grep -v "cross-device link not permitted\|Falling back to copying packages from store"

README.md

@@ -20,7 +20,7 @@
    
   <a href="https://discord.gg/k4ruYNrudu"><img alt="Discord" src="https://img.shields.io/discord/1019316731635834932"></a>
   &nbsp;
-  <a href="http://gethomepage.dev/latest/" title="Docs"><img title="Docs" src="https://github.com/gethomepage/homepage/actions/workflows/docs-publish.yml/badge.svg"/></a>
+  <a href="https://gethomepage.dev/" title="Docs"><img title="Docs" src="https://github.com/gethomepage/homepage/actions/workflows/docs-publish.yml/badge.svg"/></a>
   &nbsp;
   <a href="https://paypal.me/phelpsben" title="Donate"><img alt="GitHub Sponsors" src="https://img.shields.io/github/sponsors/benphelps"></a>
 </p>
@@ -38,7 +38,7 @@ With features like quick search, bookmarks, weather support, a wide range of int
 
 - **Fast** - The site is statically generated at build time for instant load times.
 - **Secure** - All API requests to backend services are proxied, keeping your API keys hidden. Constantly reviewed for security by the community.
-- **For Everyone** - Images built for AMD64, ARM64, ARMv7, and ARMv6.
+- **For Everyone** - Images built for AMD64, ARM64.
 - **Full i18n** - Support for over 40 languages.
 - **Service & Web Bookmarks** - Add custom links to the homepage.
 - **Docker Integration** - Container status and stats. Automatic service discovery via labels.
@@ -48,19 +48,19 @@ 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 Service Discovery](https://gethomepage.dev/latest/configs/docker/#automatic-service-discovery) 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/configs/docker/#automatic-service-discovery) page for more information.
 
 ## 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/widgets/) page for more information.
+Homepage also has support for hundreds of 3rd-party services, including all popular \*arr 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/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/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/widgets/) page for more information.
 
 ## Customization
 
-Homepage is highly customizable, with support for custom themes, custom CSS & JS, custom layouts, formatting, localization and more. See the [Settings](https://gethomepage.dev/latest/configs/settings/) page for more information.
+Homepage is highly customizable, with support for custom themes, custom CSS & JS, custom layouts, formatting, localization and more. See the [Settings](https://gethomepage.dev/configs/settings/) page for more information.
 
 # Getting Started
 
@@ -75,14 +75,14 @@ Please note that when using features such as widgets, Homepage can access person
 Using docker compose:
 
 ```yaml
-version: "3.3"
 services:
   homepage:
     image: ghcr.io/gethomepage/homepage:latest
     container_name: homepage
     environment:
-      PUID: 1000 -- optional, your user id
-      PGID: 1000 -- optional, your group id
+      HOMEPAGE_ALLOWED_HOSTS: gethomepage.dev # required, may need port. See gethomepage.dev/installation/#homepage_allowed_hosts
+      PUID: 1000 # optional, your user id
+      PGID: 1000 # optional, your group id
     ports:
       - 3000:3000
     volumes:
@@ -95,6 +95,7 @@ or docker run:
 
 ```bash
 docker run --name homepage \
+  -e HOMEPAGE_ALLOWED_HOSTS=gethomepage.dev \
   -e PUID=1000 \
   -e PGID=1000 \
   -p 3000:3000 \
@@ -104,7 +105,7 @@ docker run --name homepage \
   ghcr.io/gethomepage/homepage:latest
 ```
 
-## With Node
+## From Source
 
 First, clone the repository:
 
@@ -112,7 +113,7 @@ First, clone the repository:
 git clone https://github.com/gethomepage/homepage.git
 ```
 
-Then install dependencies and build the production bundle (I'm using pnpm here, you can use npm or yarn if you like):
+Then install dependencies and build the production bundle:
 
 ```bash
 pnpm install
@@ -127,15 +128,9 @@ Finally, run the server in production mode:
 pnpm start
 ```
 
-or development mode:
-
-```bash
-pnpm dev
-```
-
 # Configuration
 
-Please refer to the [homepage documentation](https://gethomepage.dev/) website for more information. Everything you need to know about configuring Homepage is there. Please read everything carefully before asking for help, as most questions are answered there or are simple YAML configuration issues.
+Please refer to the [homepage documentation website](https://gethomepage.dev/) for more information. Everything you need to know about configuring Homepage is there. Please read everything carefully before asking for help, as most questions are answered there or are simple YAML configuration issues.
 
 # Development
 
@@ -175,6 +170,10 @@ 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.
 
+## Troubleshooting
+
+In addition to the docs, the [troubleshooting guide](https://gethomepage.dev/troubleshooting/) can help reveal many basic config or network issues. If you're having a problem, it's a good place to start.
+
 ## Contributing & Contributors
 
 Contributions are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information.

docker-entrypoint.sh

@@ -12,10 +12,49 @@ export PGID=${PGID:-0}
 
 export HOMEPAGE_BUILDTIME=$(date +%s)
 
-# Set privileges for /app but only if pid 1 user is root and we are dropping privileges.
-# If container is run as an unprivileged user, it means owner already handled ownership setup on their own.
-# Running chown in that case (as non-root) will cause error
-[ "$(id -u)" == "0" ] && [ "${PUID}" != "0" ] && chown -R ${PUID}:${PGID} /app
+# Check ownership before chown
+if [ -e /app/config ]; then
+  CURRENT_UID=$(stat -c %u /app/config)
+  CURRENT_GID=$(stat -c %g /app/config)
+
+  if [ "$CURRENT_UID" -ne "$PUID" ] || [ "$CURRENT_GID" -ne "$PGID" ]; then
+    echo "Fixing ownership of /app/config"
+    if ! chown -R "$PUID:$PGID" /app/config 2>/dev/null; then
+      echo "Warning: Could not chown /app/config; continuing anyway"
+    fi
+  else
+    echo "/app/config already owned by correct UID/GID, skipping chown"
+  fi
+else
+  echo "/app/config does not exist; skipping ownership check"
+fi
+
+# Ensure /app/config/logs exists and is owned
+if [ -n "$PUID" ] && [ -n "$PGID" ]; then
+  mkdir -p /app/config/logs 2>/dev/null || true
+  if [ -d /app/config/logs ]; then
+    LOG_UID=$(stat -c %u /app/config/logs)
+    LOG_GID=$(stat -c %g /app/config/logs)
+    if [ "$LOG_UID" -ne "$PUID" ] || [ "$LOG_GID" -ne "$PGID" ]; then
+      echo "Fixing ownership of /app/config/logs"
+      chown -R "$PUID:$PGID" /app/config/logs 2>/dev/null || echo "Warning: Could not chown /app/config/logs"
+    fi
+  fi
+fi
+
+if [ -d /app/.next ]; then
+  CURRENT_UID=$(stat -c %u /app/.next)
+  CURRENT_GID=$(stat -c %g /app/.next)
+
+  if [ "$PUID" -ne 0 ] && ([ "$CURRENT_UID" -ne "$PUID" ] || [ "$CURRENT_GID" -ne "$PGID" ]); then
+    echo "Fixing ownership of /app/.next"
+    if ! chown -R "$PUID:$PGID" /app/.next 2>/dev/null; then
+      echo "Warning: Could not chown /app/.next; continuing anyway"
+    fi
+  else
+    echo "/app/.next already owned by correct UID/GID or running as root, skipping chown"
+  fi
+fi
 
 # Drop privileges (when asked to) if root, otherwise run as current user
 if [ "$(id -u)" == "0" ] && [ "${PUID}" != "0" ]; then

docs/CNAME

@@ -0,0 +1 @@
+gethomepage.dev

docs/assets/custom.css

@@ -1,3 +0,0 @@
-.md-typeset[data-page-id="landing"] .md-header-anchor {
-    display: none;
-}

docs/configs/docker.md

@@ -20,7 +20,7 @@ Since Docker supports connecting with TLS and client certificate authentication,
 ```yaml
 my-remote-docker:
   host: 192.168.0.101
-  port: 275
+  port: 2375
   tls:
     keyFile: tls/key.pem
     caFile: tls/ca.pem
@@ -66,6 +66,30 @@ my-docker:
   port: 2375
 ```
 
+Use `protocol: https` if you’re connecting through a reverse proxy (e.g., Traefik) that serves the Docker API over HTTPS:
+
+```yaml
+my-docker:
+  host: dockerproxy
+  port: 443
+  protocol: https
+```
+
+!!! note
+
+    Note: This does not require TLS certificates if the proxy handles encryption. Do not use `protocol: https` unless you’re sure the target host supports HTTPS.
+
+You can also include `headers` for the connection, for example, if you are using a reverse proxy that requires authentication:
+
+```yaml
+my-docker:
+  host: dockerproxy
+  port: 443
+  protocol: https
+  headers:
+    Authorization: Basic <base64-encoded-credentials>
+```
+
 ## Using Socket Directly
 
 If you'd rather use the socket directly, first make sure that you're passing the local socket into the Docker container.
@@ -153,6 +177,18 @@ labels:
   - homepage.widget.fields=["field1","field2"] # optional
 ```
 
+Multiple widgets can be specified by incrementing the index, e.g.
+
+```yaml
+labels: ...
+  - homepage.widgets[0].type=emby
+  - homepage.widgets[0].url=http://emby.home
+  - homepage.widgets[0].key=yourembyapikeyhere
+  - homepage.widgets[1].type=uptimekuma
+  - homepage.widgets[1].url=http://uptimekuma.home
+  - homepage.widgets[1].slug=youreventslughere
+```
+
 You can add specify fields for e.g. the [CustomAPI](../widgets/services/customapi.md) widget by using array-style dot notation:
 
 ```yaml

docs/configs/info-widgets.md

@@ -0,0 +1,24 @@
+---
+title: Information Widgets
+description: Homepage info widgets.
+---
+
+Information widgets are widgets that provide information about your system or environment and are displayed at the top of the homepage. You can find a list of all available info widgets under the [Info Widgets](../widgets/info/index.md) section.
+
+Info widgets are defined in the widgets.yaml
+
+Each widget has its own configuration options, which are detailed in the widget's documentation.
+
+## Layout
+
+Info widgets are displayed in the order they are defined in the `widgets.yaml` file. You can change the order by moving the widgets around in the file. However, some widgets (weather, search and datetime) are aligned to the right side of the screen which can affect the layout of the widgets.
+
+## Adding A Link
+
+You can add a link to an info widget such as the logo or text widgets by adding an `href` option, for example:
+
+```yaml
+logo:
+  href: https://example.com
+  target: _blank # Optional, can be set in settings
+```

docs/configs/kubernetes.md

@@ -8,6 +8,7 @@ The Kubernetes connectivity has the following requirements:
 - Kubernetes 1.19+
 - Metrics Service
 - An Ingress controller
+  - Optionally: Gateway-API
 
 The Kubernetes connection is configured in the `kubernetes.yaml` file. There are 3 modes to choose from:
 
@@ -19,6 +20,22 @@ The Kubernetes connection is configured in the `kubernetes.yaml` file. There are
 mode: default
 ```
 
+To configure Kubernetes gateway-api, ingress or ingressRoute service discovery, add one or multiple of the following settings.
+
+Example settings:
+
+```yaml
+ingress: true # default, enable ingress only
+```
+
+or
+
+```yaml
+ingress: true # default, enable ingress
+traefik: true # enable traefik ingressRoute
+gateway: true # enable gateway-api
+```
+
 ## Services
 
 Once the Kubernetes connection is configured, individual services can be configured to pull statistics. Only CPU and Memory are currently supported.
@@ -36,7 +53,7 @@ Inside of the service you'd like to connect to a pod:
 
 The `app` field is used to create a label selector, in this example case it would match pods with the label: `app.kubernetes.io/name=emby`.
 
-Sometimes this is insufficient for complex or atypical application deployments. In these cases, the `pod-selector` field can be used. Any field selector can be used with it, so it allows for some very powerful selection capabilities.
+Sometimes this is insufficient for complex or atypical application deployments. In these cases, the `podSelector` field can be used. Any field selector can be used with it, so it allows for some very powerful selection capabilities.
 
 For instance, it can be utilized to roll multiple underlying deployments under one application to see a high-level aggregate:
 
@@ -47,7 +64,7 @@ For instance, it can be utilized to roll multiple underlying deployments under o
     description: Matrix Synapse Powered Chat
     app: matrix-element
     namespace: comms
-    pod-selector: >-
+    podSelector: >-
       app.kubernetes.io/instance in (
           matrix-element,
           matrix-media-repo,
@@ -58,7 +75,7 @@ For instance, it can be utilized to roll multiple underlying deployments under o
 
 !!! note
 
-    A blank string as a pod-selector does not deactivate it, but will actually select all pods in the namespace. This is a useful way to capture the resource usage of a complex application siloed to a single namespace, like Longhorn.
+    A blank string as a podSelector does not deactivate it, but will actually select all pods in the namespace. This is a useful way to capture the resource usage of a complex application siloed to a single namespace, like Longhorn.
 
 ## Automatic Service Discovery
 
@@ -100,6 +117,8 @@ If you are using multiple instances of homepage, an `instance` annotation can be
 
 If you have a single service that needs to be shown on multiple specific instances of homepage (but not on all of them), the service can be annotated by multiple `instance.name` annotations, where `name` can be the names of your specific multiple homepage instances. For example, a service that is annotated with `gethomepage.dev/instance.public: ""` and `gethomepage.dev/instance.internal: ""` will be shown on `public` and `internal` homepage instances.
 
+Use the `gethomepage.dev/pod-selector` selector to specify the pod used for the health check. For example, a service that is annotated with `gethomepage.dev/pod-selector: app.kubernetes.io/name=deployment` would link to a pod with the label `app.kubernetes.io/name: deployment`.
+
 ### 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:
@@ -140,6 +159,22 @@ spec:
 
 If the `href` attribute is not present, Homepage will ignore the specific IngressRoute.
 
+### Gateway API HttpRoute support
+
+Homepage also features automatic service discovery for Gateway API. Service definitions are read by annotating the HttpRoute custom resource definition and are indentical to the Ingress example as defined in [Automatic Service Discovery](#automatic-service-discovery).
+
+To enable Gateway API HttpRoute update `kubernetes.yaml` to include:
+
+```
+gateway: true # enable gateway-api
+```
+
+#### Using the unoffocial helm chart?
+
+If you are using the unofficial helm chart ensure that the `ClusterRole` has required permissions for `gateway.networking.k8s.io`.
+
+See [ClusterRole and ClusterRoleBinding](../installation/k8s.md#clusterrole-and-clusterrolebinding)
+
 ## Caveats
 
 Similarly to Docker service discovery, there currently is no rigid ordering to discovered services and discovered services will be displayed above those specified in the `services.yaml`.

docs/configs/proxmox.md

@@ -0,0 +1,79 @@
+---
+title: Proxmox
+description: Proxmox Configuration
+---
+
+The Proxmox connection is configured in the `proxmox.yaml` file. See [Create token](#create-token) section below for details on how to generate the required API token.
+
+```yaml
+url: https://proxmox.host.or.ip:8006
+token: username@pam!Token ID
+secret: secret
+```
+
+## Services
+
+Once the Proxmox connection is configured, individual services can be configured to pull statistics of VMs or LXCs. Only CPU and Memory are currently supported.
+
+### Configuration Options
+
+- `proxmoxNode`: The name of the Proxmox node where your VM/LXC is running
+- `proxmoxVMID`: The ID of the Proxmox VM or LXC container
+- `proxmoxType`: (Optional) The type of Proxmox virtual machine. Defaults to `qemu` for VMs, but can be set to `lxc` for LXC containers
+
+#### Examples
+
+For a QEMU VM (default):
+
+```yaml
+- HomeAssistant:
+  icon: home-assistant.png
+  href: http://homeassistant.local/
+  description: Home automation
+  proxmoxNode: pve
+  proxmoxVMID: 101
+  # proxmoxType: qemu # This is the default, so it can be omitted
+```
+
+For an LXC container:
+
+```yaml
+- Nginx:
+  icon: nginx.png
+  href: http://nginx.local/
+  description: Web server
+  proxmoxNode: pve
+  proxmoxVMID: 200
+  proxmoxType: lxc
+```
+
+## Create token
+
+You will need to generate an API Token for new or an existing user. Here is an example of how to do this for a new user.
+
+1.  Navigate to the Proxmox portal, click on Datacenter
+2.  Expand Permissions, click on Groups
+3.  Click the Create button
+4.  Name the group something informative, like api-ro-users
+5.  Click on the Permissions "folder"
+6.  Click Add -> Group Permission
+    - Path: /
+    - Group: group from bullet 4 above
+    - Role: PVEAuditor
+    - Propagate: Checked
+7.  Expand Permissions, click on Users
+8.  Click the Add button
+    - User name: something informative like `api`
+    - Realm: Linux PAM standard authentication
+    - Group: group from bullet 4 above
+9.  Expand Permissions, click on API Tokens
+10. Click the Add button
+    - User: user from bullet 8 above
+    - Token ID: something informative like the application or purpose like `homepage`
+    - Privilege Separation: Checked
+11. Go back to the "Permissions" menu
+12. Click Add -> API Token Permission
+    - Path: /
+    - API Token: select the Token ID created in Step 10
+    - Role: PVE Auditor
+    - Propagate: Checked

docs/configs/service-widgets.md

@@ -1,40 +0,0 @@
----
-title: Service Widgets
-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 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.
-
-Using Emby as an example, this is how you would attach the Emby service widget.
-
-```yaml
-- Emby:
-    icon: emby.png
-    href: http://emby.host.or.ip/
-    description: Movies & TV Shows
-    widget:
-      type: emby
-      url: http://emby.host.or.ip
-      key: apikeyapikeyapikeyapikeyapikey
-```
-
-## Field Visibility
-
-Each widget can optionally provide a list of which fields should be visible via the `fields` widget property. If no fields are specified, then all fields will be displayed. The `fields` property must be a valid YAML array of strings. As an example, here is the entry for Sonarr showing only a couple of fields.
-
-**In all cases a widget will work and display all fields without specifying the `fields` property.**
-
-```yaml
-- Sonarr:
-    icon: sonarr.png
-    href: http://sonarr.host.or.ip
-    widget:
-      type: sonarr
-      fields: ["wanted", "queued"]
-      url: http://sonarr.host.or.ip
-      key: apikeyapikeyapikeyapikeyapikey
-```

docs/configs/services.md

@@ -21,6 +21,23 @@ Groups are defined as top-level array entries.
 
 <img width="1038" alt="Service Groups" src="https://user-images.githubusercontent.com/82196/187040754-28065242-4534-4409-881c-93d1921c6141.png">
 
+### Nested Groups
+
+Groups can be nested by using the same format as the top-level groups.
+
+```yaml
+- Group A:
+    - Service A:
+        href: http://localhost/
+
+    - Group B:
+        - Service B:
+            href: http://localhost/
+
+        - Service C:
+            href: http://localhost/
+```
+
 ## Services
 
 Services are defined as array entries on groups,
@@ -43,6 +60,64 @@ Services are defined as array entries on groups,
 
 <img width="1038" alt="Service Services" src="https://user-images.githubusercontent.com/82196/187040763-038023a2-8bee-4d87-b5cc-13447e7365a4.png">
 
+### Service Widgets
+
+Each service can have widgets 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.
+
+Using Emby as an example, this is how you would attach the Emby service widget.
+
+```yaml
+- Emby:
+    icon: emby.png
+    href: http://emby.host.or.ip/
+    description: Movies & TV Shows
+    widget:
+      type: emby
+      url: http://emby.host.or.ip
+      key: apikeyapikeyapikeyapikeyapikey
+```
+
+#### Multiple Widgets
+
+Each service can have multiple widgets attached to it, for example:
+
+```yaml
+- Emby:
+    icon: emby.png
+    href: http://emby.host.or.ip/
+    description: Movies & TV Shows
+    widgets:
+      - type: emby
+        url: http://emby.host.or.ip
+        key: apikeyapikeyapikeyapikeyapikey
+      - type: uptimekuma
+        url: http://uptimekuma.host.or.ip:port
+        slug: statuspageslug
+```
+
+!!! note
+
+      Multiple widgets per service are not yet supported with Kubernetes ingress annotations.
+
+#### Field Visibility
+
+Each widget can optionally provide a list of which fields should be visible via the `fields` widget property. If no fields are specified, then all fields will be displayed. The `fields` property must be a valid YAML array of strings. As an example, here is the entry for Sonarr showing only a couple of fields.
+
+**In all cases a widget will work and display all fields without specifying the `fields` property.**
+
+```yaml
+- Sonarr:
+    icon: sonarr.png
+    href: http://sonarr.host.or.ip
+    widget:
+      type: sonarr
+      fields: ["wanted", "queued"]
+      url: http://sonarr.host.or.ip
+      key: apikeyapikeyapikeyapikeyapikey
+```
+
 ## Descriptions
 
 Services may have descriptions,
@@ -63,11 +138,15 @@ Services may have descriptions,
 
 ## Icons
 
-Services may have an icon attached to them, you can use icons from [Dashboard Icons](https://github.com/walkxcode/dashboard-icons) automatically, by passing the name of the icon, with, or without `.png` or with `.svg` to use the svg version.
+Services may have an icon attached to them, you can use icons from [Dashboard Icons](https://github.com/homarr-labs/dashboard-icons) automatically, by passing the name of the icon, with, or without `.png`, `.webp` or `.svg` to specify the desired version.
 
-You can also specify prefixed icons from [Material Design Icons](https://materialdesignicons.com) with `mdi-XX` or [Simple Icons](https://simpleicons.org/) with `si-XX`.
+You can also specify prefixed icons from:
 
-You can specify a custom color by adding a hex color code as suffix e.g. `mdi-XX-#f0d453` or `si-XX-#a712a2`.
+- [Material Design Icons](https://pictogrammers.com/library/mdi/) with `mdi-XX`
+- [Simple Icons](https://simpleicons.org/) with `si-XX`
+- [selfh.st/icons](https://selfh.st/icons/) with `sh-XX` to use the png version or `sh-XX.svg/png/webp` for a specific version
+
+You can specify a custom color for `mdi` and `si` icons by adding a hex color code as a suffix e.g. `mdi-XX-#f0d453` or `si-XX-#a712a2`.
 
 To use a remote icon, use the absolute URL (e.g. `https://...`).
 
@@ -103,6 +182,10 @@ To use a local icon, first create a Docker mount to `/app/public/icons` and then
 
 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.
 
+!!! note
+
+      Because ping uses the ping command on the underlying host, in some cases you may need to install e.g. the `iputils-ping` package on the host system.
+
 ```yaml
 - Group A:
     - Sonarr:
@@ -171,7 +254,7 @@ Services may be connected to a Docker container, either running on the local mac
 
 !!! note
 
-      This can also be controlled with `showStats`. See [show docker stats](docker.md#show-docker-stats) for more information
+      This can also be controlled with `showStats`. See [show docker stats](docker.md#show-stats) for more information
 
 <img width="1038" alt="Docker Stats Expanded" src="https://github.com/gethomepage/homepage/assets/88257202/f95fd595-449e-48ae-af67-fd89618904ec">
 

docs/configs/settings.md

@@ -13,6 +13,14 @@ You can customize the title of the page if you'd like.
 title: My Awesome Homepage
 ```
 
+## Description
+
+You can customize the description of the page if you'd like.
+
+```yaml
+description: A description of my awesome homepage
+```
+
 ## Start URL
 
 You can customize the start_url as required for installable apps. The default is "/".
@@ -70,7 +78,7 @@ background:
 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
+cardBlur: xs # xs, md, etc... see https://tailwindcss.com/docs/backdrop-blur
 ```
 
 ## Favicon
@@ -93,7 +101,7 @@ theme: dark # or light
 
 ## Color Palette
 
-You can configured a fixed color palette (and disable the palette switcher) by passing the `color` option, like so:
+You can configure a fixed color palette (and disable the palette switcher) by passing the `color` option, like so:
 
 ```yaml
 color: slate
@@ -118,6 +126,22 @@ As an example, this would produce the following layout:
 
 <img width="1260" alt="Screenshot 2022-09-15 at 8 03 57 PM" src="https://user-images.githubusercontent.com/82196/190466646-8ca94505-0fcf-4964-9687-3a6c7cd3144f.png">
 
+### Icons-Only Layout
+
+You can also specify the an icon-only layout for bookmarks, either like so:
+
+```yaml
+layout:
+  Media:
+    iconsOnly: true
+```
+
+or globally:
+
+```yaml
+bookmarksStyle: icons
+```
+
 ### Sorting
 
 Service groups and bookmark groups can be mixed in order, **but should use different group names**. If you do not specify any bookmark groups they will all show at the bottom of the page.
@@ -137,6 +161,27 @@ layout:
       columns: 3
 ```
 
+### Nested Groups
+
+If your services config has nested groups, you can apply settings to these groups by nesting them in the layout block
+and using the same settings. For example
+
+```yaml
+layout:
+  Group A:
+    style: row
+    columns: 4
+  Group C:
+    style: row
+    columns: 2
+    Nested Group A:
+      style: row
+      columns: 2
+    Nested Group B:
+      style: row
+      columns: 2
+```
+
 ### Headers
 
 You can hide headers for each section in the layout as well by passing `header` as false, like so:
@@ -209,15 +254,29 @@ layout:
     columns: 4
 ```
 
-### Five Columns
+### Full Width
 
-You can add a fifth column to services (when `style: columns` which is default) by adding:
+You can make homepage take up the entire window width by adding:
 
 ```yaml
-fiveColumns: true
+fullWidth: true
 ```
 
-By default homepage will max out at 4 columns for services with `columns` style
+### Maximum Group Columns
+
+You can set the maximum number of columns of groups on larger screen sizes (note this is only for groups with the default `style: columns`, not groups with `style: row`) by adding:
+
+```yaml
+maxGroupColumns: 8 # default is 4 for services, 6 for bookmarks, max 8
+```
+
+By default homepage will max out at 4 columns for services and 6 for bookmarks, thus the minimum for this setting is _5_. Of course, if you're setting this to higher numbers, you may want to consider enabling the [fullWidth](#full-width) option as well.
+
+If you want to set the maximum columns for bookmark groups separately, you can do so by adding:
+
+```yaml
+maxBookmarkGroupColumns: 6 # default is 6, max 8
+```
 
 ### Collapsible sections
 
@@ -348,12 +407,12 @@ This can also be set for individual services. Note setting this at the service l
 
 ## Providers
 
-The `providers` section allows you to define shared API provider options and secrets. Currently this allows you to define your weather API keys in secret and is also the location of the Longhorn URL and credentials.
+The `providers` section allows you to define shared API provider options and secrets.
 
 ```yaml
 providers:
   openweathermap: openweathermapapikey
-  weatherapi: weatherapiapikey
+  finnhub: yourfinnhubapikeyhere
   longhorn:
     url: https://longhorn.example.com
     username: admin
@@ -363,10 +422,10 @@ providers:
 You can then pass `provider` instead of `apiKey` in your widget configuration.
 
 ```yaml
-- weatherapi:
+- openweathermap:
     latitude: 50.449684
     longitude: 30.525026
-    provider: weatherapi
+    provider: openweathermap
 ```
 
 ## Quick Launch
@@ -402,7 +461,7 @@ quicklaunch:
   suggestionUrl: https://ac.ecosia.org/autocomplete?type=list&q=
 ```
 
-## Homepage Version
+## Homepage Version & Update Checking
 
 By default the release version is displayed at the bottom of the page. To hide this, use the `hideVersion` setting, like so:
 
@@ -410,6 +469,12 @@ By default the release version is displayed at the bottom of the page. To hide t
 hideVersion: true
 ```
 
+You can disable checking for new versions from GitHub (enabled by default) with:
+
+```yaml
+disableUpdateCheck: true
+```
+
 ## Log Path
 
 By default the homepage logfile is written to the a `logs` subdirectory of the `config` folder. In order to customize this path, you can set the `logpath` setting. A `logs` folder will be created in that location where the logfile will be written.

docs/installation/docker.md

@@ -6,7 +6,6 @@ description: Install and run homepage from Docker
 Using docker compose:
 
 ```yaml
-version: "3.3"
 services:
   homepage:
     image: ghcr.io/gethomepage/homepage:latest
@@ -16,6 +15,8 @@ services:
     volumes:
       - /path/to/config:/app/config # Make sure your local config directory exists
       - /var/run/docker.sock:/var/run/docker.sock # (optional) For docker integrations
+    environment:
+      HOMEPAGE_ALLOWED_HOSTS: gethomepage.dev # required, may need port. See gethomepage.dev/installation/#homepage_allowed_hosts
 ```
 
 ### Running as non-root
@@ -27,7 +28,6 @@ _Using the docker socket directly is not the recommended method of integration a
 In the docker compose example below, the environment variables `$PUID` and `$PGID` are set in a `.env` file.
 
 ```yaml
-version: "3.3"
 services:
   homepage:
     image: ghcr.io/gethomepage/homepage:latest
@@ -38,6 +38,7 @@ services:
       - /path/to/config:/app/config # Make sure your local config directory exists
       - /var/run/docker.sock:/var/run/docker.sock # (optional) For docker integrations, see alternative methods
     environment:
+      HOMEPAGE_ALLOWED_HOSTS: gethomepage.dev # required, may need port. See gethomepage.dev/installation/#homepage_allowed_hosts
       PUID: $PUID
       PGID: $PGID
 ```
@@ -45,7 +46,7 @@ services:
 ### With Docker Run
 
 ```bash
-docker run -p 3000:3000 -v /path/to/config:/app/config -v /var/run/docker.sock:/var/run/docker.sock ghcr.io/gethomepage/homepage:latest
+docker run -p 3000:3000 -e HOMEPAGE_ALLOWED_HOSTS=gethomepage.dev -v /path/to/config:/app/config -v /var/run/docker.sock:/var/run/docker.sock ghcr.io/gethomepage/homepage:latest
 ```
 
 ### Using Environment Secrets

docs/installation/index.md

@@ -4,27 +4,37 @@ description: Docs intro
 icon: simple/docker
 ---
 
-<p>
 You have a few options for deploying homepage, depending on your needs. We offer docker images for a majority of platforms. You can also install and run homepage from source if Docker is not your thing. It can even be installed on Kubernetes with Helm.
-</p>
 
-!!! danger
+!!! info
 
     Please note that when using features such as widgets, Homepage can access personal information (for example from your home automation system) and Homepage currently does not (and is not planned to) include any authentication layer itself. Thus, we recommend homepage be deployed behind a reverse proxy including authentication, SSL etc, and / or behind a VPN.
 
 <br>
 
 <div class="grid cards" style="margin: 0 auto;" markdown>
-:simple-docker: [&nbsp; Install on Docker :octicons-arrow-right-24:](docker.md)
+[:simple-docker: &nbsp; Install on Docker :octicons-arrow-right-24:](docker.md)
 { .card }
 
-:simple-kubernetes: [&nbsp; Install on Kubernetes :octicons-arrow-right-24:](k8s.md)
+[:simple-kubernetes: &nbsp; Install on Kubernetes :octicons-arrow-right-24:](k8s.md)
 { .card }
 
-:simple-unraid: [&nbsp; Install on UNRAID :octicons-arrow-right-24:](unraid.md)
+[:simple-unraid: &nbsp; Install on UNRAID :octicons-arrow-right-24:](unraid.md)
 { .card }
 
-:simple-nextdotjs: [&nbsp; Building from source :octicons-arrow-right-24:](source.md)
+[:simple-nextdotjs: &nbsp; Building from source :octicons-arrow-right-24:](source.md)
 { .card }
 
 </div>
+
+### `HOMEPAGE_ALLOWED_HOSTS`
+
+As of v1.0 there is one required environment variable to access homepage via a URL other than `localhost`, <code>HOMEPAGE_ALLOWED_HOSTS</code>. The setting helps prevent certain kinds of attacks when retrieving data from the homepage API proxy.
+
+The value is a comma-separated (no spaces) list of allowed hosts (sometimes with the port) that can host your homepage install. See the [docker](docker.md), [kubernetes](k8s.md) and [source](source.md) installation pages for more information about where / how to set the variable.
+
+`localhost:3000` and `127.0.0.1:3000` are always included, but you can add a domain or IP address to this list to allow that host such as `HOMEPAGE_ALLOWED_HOSTS=gethomepage.dev,192.168.1.2:1234`, etc.
+
+If you are seeing errors about host validation, check the homepage logs and ensure that the host exactly as output in the logs is in the `HOMEPAGE_ALLOWED_HOSTS` list.
+
+This can be disabled by setting `HOMEPAGE_ALLOWED_HOSTS` to `*` but this is not recommended.

docs/installation/k8s.md

@@ -3,85 +3,6 @@ title: Kubernetes Installation
 description: Install on Kubernetes
 ---
 
-## Install with Helm
-
-There is an [unofficial helm chart](https://github.com/jameswynn/helm-charts/tree/main/charts/homepage) that creates all the necessary manifests, including the service account and RBAC entities necessary for service discovery.
-
-```sh
-helm repo add jameswynn https://jameswynn.github.io/helm-charts
-helm install homepage jameswynn/homepage -f values.yaml
-```
-
-The helm chart allows for all the configurations to be inlined directly in your `values.yaml`:
-
-```yaml
-config:
-  bookmarks:
-    - Developer:
-        - Github:
-            - abbr: GH
-              href: https://github.com/
-  services:
-    - My First Group:
-        - My First Service:
-            href: http://localhost/
-            description: Homepage is awesome
-
-    - My Second Group:
-        - My Second Service:
-            href: http://localhost/
-            description: Homepage is the best
-
-    - My Third Group:
-        - My Third Service:
-            href: http://localhost/
-            description: Homepage is 😎
-  widgets:
-    # show the kubernetes widget, with the cluster summary and individual nodes
-    - kubernetes:
-        cluster:
-          show: true
-          cpu: true
-          memory: true
-          showLabel: true
-          label: "cluster"
-        nodes:
-          show: true
-          cpu: true
-          memory: true
-          showLabel: true
-    - search:
-        provider: duckduckgo
-        target: _blank
-  kubernetes:
-    mode: cluster
-  settings:
-
-# The service account is necessary to allow discovery of other services
-serviceAccount:
-  create: true
-  name: homepage
-
-# This enables the service account to access the necessary resources
-enableRbac: true
-
-ingress:
-  main:
-    enabled: true
-    annotations:
-      # Example annotations to add Homepage to your Homepage!
-      gethomepage.dev/enabled: "true"
-      gethomepage.dev/name: "Homepage"
-      gethomepage.dev/description: "Dynamically Detected Homepage"
-      gethomepage.dev/group: "Dynamic"
-      gethomepage.dev/icon: "homepage.png"
-    hosts:
-      - host: homepage.example.com
-        paths:
-          - path: /
-            pathType: Prefix
-```
-
 ## Install with Kubernetes Manifests
 
 If you don't want to use the unofficial Helm chart, you can also create your own Kubernetes manifest(s) and apply them with `kubectl apply -f filename.yaml`.
@@ -175,6 +96,7 @@ data:
         expanded: true
         cpu: true
         memory: true
+        network: default
     - search:
         provider: duckduckgo
         target: _blank
@@ -209,12 +131,20 @@ rules:
       - get
       - list
   - apiGroups:
-      - traefik.containo.us
+      - traefik.io
     resources:
       - ingressroutes
     verbs:
       - get
       - list
+  - apiGroups:
+      - gateway.networking.k8s.io
+    resources:
+      - httproutes
+      - gateways
+    verbs:
+      - get
+      - list
   - apiGroups:
       - metrics.k8s.io
     resources:
@@ -293,6 +223,9 @@ spec:
         - name: homepage
           image: "ghcr.io/gethomepage/homepage:latest"
           imagePullPolicy: Always
+          env:
+            - name: HOMEPAGE_ALLOWED_HOSTS
+              value: gethomepage.dev # required, may need port. See gethomepage.dev/installation/#homepage_allowed_hosts
           ports:
             - name: http
               containerPort: 3000
@@ -370,7 +303,7 @@ 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.
 
-```
+```yaml
 apiVersion: traefik.io/v1alpha1
 kind: IngressRoute
 metadata:

docs/installation/source.md

@@ -9,7 +9,13 @@ First, clone the repository:
 git clone https://github.com/gethomepage/homepage.git
 ```
 
-Then install dependencies and build the production bundle (I'm using pnpm here, you can use npm or yarn if you like):
+If `pnpm` is not installed, install it:
+
+```bash
+npm install -g pnpm
+```
+
+Then install dependencies and build the production bundle:
 
 ```bash
 pnpm install
@@ -21,5 +27,9 @@ If this is your first time starting, copy the `src/skeleton` directory to `confi
 Finally, run the server:
 
 ```bash
-pnpm start
+HOMEPAGE_ALLOWED_HOSTS=gethomepage.dev:1234 pnpm start
 ```
+
+When updating homepage versions you will need to re-build the static files i.e. repeat the process above.
+
+See [HOMEPAGE_ALLOWED_HOSTS](index.md#homepage_allowed_hosts) for more information on this environment variable.

docs/installation/unraid.md

@@ -31,15 +31,15 @@ You may need to set the permissions of the folders to be able to edit the files.
 
 - To use the [Docker integration](../configs/docker.md), you only need to use the `container:` parameter. There is no need to set the server.
 
-  !!! note
+!!! note
 
-        To view detailed container statistics (CPU, RAM, etc.), or if you use a remote docker socket, `container:` will still need to be set. For example:
+      To view detailed container statistics (CPU, RAM, etc.), or if you use a remote docker socket, `container:` will still need to be set. For example:
 
-  ```
-      - Plex:
-          icon: /icons/plex.png
-          href: https://app.plex.com
-          container: plex
-  ```
+```
+    - Plex:
+        icon: /icons/plex.png
+        href: https://app.plex.com
+        container: plex
+```
 
 - When you upload a new image into the **/images** folder, you will need to restart the container for it to show up in the WebUI. Please see the [service icons](../configs/services.md#icons) for more information.

docs/more/sponsors.md

@@ -34,13 +34,6 @@ These companies help the Homepage project by providing services, tools, and reso
     </p>
   </div>
 
-  <div style="margin-bottom: 16px;">
-    <a href="https://glimelab.ai/"><img src="https://framerusercontent.com/images/28KxmT1G06GrFM8TKeNAC03QIms.svg" alt="Crowdin" style="max-width: 100%; height: 64px; display: block;" /></a>
-    <p>
-      GlimeLab provides the project with the awesome AI chatbot here and on GitHub and Discord.
-    </p>
-  </div>
-
   <div style="margin-bottom: 16px;">
     <a href="https://www.jetbrains.com/"><img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jetbrains.png" alt="JetBrains" style="max-width: 100%; height: 64px; display: block;" /></a>
     <p>

docs/scripts/extra.js

@@ -1,35 +0,0 @@
-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);
-};

docs/stylesheets/extra.css

@@ -14,6 +14,16 @@
   --md-default-fg-color: white;
 }
 
+[data-md-color-scheme="default"] .md-search__inner {
+  --md-default-fg-color--light: gray;
+  --md-default-fg-color--lighter: black;
+  --md-default-bg-color: hsla(0, 0%, 100%, 0.9);
+}
+
+[data-md-color-scheme="default"] .md-search__inner .md-search__input {
+  color: var(--md-default-fg-color--light);
+}
+
 [data-md-toggle="search"]:not(:checked) ~ .md-header .md-search__form::after {
   position: absolute;
   top: 0.3rem;
@@ -35,10 +45,6 @@
   }
 }
 
-#glimeRoot * {
-  font-family: var(--md-text-font) !important;
-}
-
 #carbonads {
   margin-top: 10px;
 }
@@ -51,6 +57,11 @@
   --carbon-text-color: var(--md-typeset-color) !important;
 }
 
+[data-md-color-scheme="default"] .carbon-text {
+  color: var(--md-code-fg-color) !important;
+  --carbon-text-color: #313131 !important;
+}
+
 .md-typeset__table {
   width: 100%;
 }
@@ -92,11 +103,11 @@
 }
 
 body {
+  background-color: transparent !important;
   background-image: url("https://raw.githubusercontent.com/gethomepage/homepage/main/docs/assets/blossom_valley.jpg");
   background-size: cover;
   background-attachment: fixed;
   background-position: center;
-  background-color: transparent;
   color: rgba(255, 255, 255, 0.8);
 }
 
@@ -152,6 +163,12 @@ body[data-md-color-scheme="default"] {
   -webkit-backdrop-filter: blur(16px);
 }
 
+.md-header:has(.md-search-result__item),
+.md-header:has(.md-search__input.focus-visible) {
+  backdrop-filter: none !important;
+  -webkit-backdrop-filter: none !important;
+}
+
 .md-footer-meta {
   background-color: transparent;
 }
@@ -212,7 +229,7 @@ body[data-md-color-scheme="default"] {
 }
 
 .md-search__scrollwrap {
-  background-color: hsla(0, 0%, 0%, 0.3);
+  background-color: hsla(0, 0%, 0%, 0.8);
   backdrop-filter: blur(16px);
   -webkit-backdrop-filter: blur(16px);
 }
@@ -269,3 +286,13 @@ body[data-md-color-scheme="default"] {
 .md-tabs__link {
   transform: translateZ(0);
 }
+
+.grid.cards .card {
+  padding: 0;
+}
+
+.grid.cards .card a {
+  display: block;
+  padding: 0.8rem;
+  text-decoration: none;
+}

docs/troubleshooting/index.md

@@ -6,24 +6,23 @@ 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.
 - Check config/logs/homepage.log, on docker simply e.g. `docker logs homepage`. This may provide some insight into the reason for an error.
 - Check the browser error console, this can also sometimes provide useful information.
 - Consider setting the `ENV` variable `LOG_LEVEL` to `debug`.
+- If certain widgets are failing when connecting to public APIs, consider [disabling IPv6](#disabling-ipv6).
 
 ## Service Widget Errors
 
-All service widgets work essentially the same, that is, homepage makes a proxied call to an API made available by that service. The majority of the time widgets don't work it is a configuration issue. Of course, sometimes things do break. Some basic steps to try:
+All service widgets work essentially the same, that is, homepage makes a proxied call to an API made available by that service. The majority of the time widgets don't work it is a configuration issue. Of course, sometimes things do break. Some basic steps to check:
 
-1.  Ensure that you follow the rule mentioned on https://gethomepage.dev/latest/configs/service-widgets/. **Unless otherwise noted, URLs should not end with a / or other API path. Each widget will handle the path on its own.**. This is very important as including a trailing slash can result in an error.
+1.  URLs should not end with a / or other API path. Each widget will handle the path on its own.
 
-2.  Verify the homepage installation can connect to the IP address or host you are using for the widget `url`. This is most simply achieved by pinging the server from the homepage machine, in Docker this means _from inside the container_ itself, e.g.:
+2.  All services with a widget require a unique name as well as a unique group (and all subgroups) name.
+
+3.  Verify the homepage installation can connect to the IP address or host you are using for the widget `url`. This is most simply achieved by pinging the server from the homepage machine, in Docker this means _from inside the container_ itself, e.g.:
 
     ```
     docker exec homepage ping SERVICEIPORDOMAIN
@@ -31,7 +30,7 @@ All service widgets work essentially the same, that is, homepage makes a proxied
 
     If your homepage install (container) cannot reach the service then you need to figure out why, for example in Docker this can mean putting the two containers on the same network, checking firewall issues, etc.
 
-3.  If you have verified that homepage can in fact reach the service then you can also check the API output using e.g. `curl`, which is often helpful if you do need to file a bug report. Again, depending on your networking setup this may need to be run from _inside the container_ as IP / hostname resolution can differ inside vs outside.
+4.  If you have verified that homepage can in fact reach the service then you can also check the API output using e.g. `curl`, which is often helpful if you do need to file a bug report. Again, depending on your networking setup this may need to be run from _inside the container_ as IP / hostname resolution can differ inside vs outside.
 
     !!! note
 
@@ -68,3 +67,17 @@ All service widgets work essentially the same, that is, homepage makes a proxied
 ## Missing custom icons
 
 If, after correctly adding and mapping your custom icons via the [Icons](../configs/services.md#icons) instructions, you are still unable to see your icons please try recreating your container.
+
+## Disabling IPv6
+
+If you are having issues with certain widgets that are unable to reach public APIs (e.g. weather), in certain setups you may need to disable IPv6. You can set the environment variable `HOMEPAGE_PROXY_DISABLE_IPV6` to `true` to disable IPv6 for the homepage proxy.
+
+Alternatively, you can use the `sysctls` option in your docker-compose file to disable IPv6 for the homepage container completely:
+
+```yaml
+services:
+  homepage:
+    ...
+    sysctls:
+      - net.ipv6.conf.all.disable_ipv6=1
+```

docs/widgets/authoring/getting-started.md

@@ -46,17 +46,17 @@ See the [pre-commit documentation](https://pre-commit.com/#install) to get start
 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 Feature or Enhancement Guidelines {#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.
+- New features or enhancements, **no matter how small**, must be linked to an existing feature request with some comments or 'up-votes' that demonstrate community interest. 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 you may want to open a discussion first.
 
 ## 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 10 'up-votes'. The purpose of this requirement is to avoid the addition (and maintenance) of service widgets that might only benefit a small number of users.
+- Please only submit widgets that target a feature request discussion with at least 20 'up-votes'. The purpose of this requirement is to avoid the addition (and maintenance) of service widgets that might only benefit a small number of users.
+- Note that we reserve the right to decline widgets for projects that are very young (eg < ~1y) or those with a small reach (eg low GitHub stars). Again, this is in an effort to keep overall widget maintenance under control.
 - Widgets should be only one row of blocks
 - Widgets should be no more than 4 blocks wide and generally conform to the styling / design choices of other widgets
 - Minimize the number of API calls

docs/widgets/authoring/metadata.md

@@ -225,20 +225,8 @@ const widgetExample = {
 
 #### `method`
 
-The `method` property is a string that represents the HTTP method that should be used to make the API request. The default value is `GET`.
-
-```js
-const widgetExample = {
-  api: "{url}/api/{endpoint}",
-  mappings: {
-    // `/api/stats`
-    stats: {
-      endpoint: "stats",
-      method: "POST",
-    },
-  },
-};
-```
+The `method` represents the HTTP method that should be used to make the API request. The default value is `GET`. Note that `POST` requests are not allowed via the
+widget API and require the use of a custom proxy.
 
 #### `headers`
 
@@ -251,7 +239,6 @@ const widgetExample = {
     // `/api/stats`
     stats: {
       endpoint: "stats",
-      method: "POST",
       headers: {
         "Content-Type": "application/json",
       },
@@ -271,7 +258,6 @@ const widgetExample = {
     // `/api/graphql`
     stats: {
       endpoint: "graphql",
-      method: "POST",
       body: {
         query: `
           query {

docs/widgets/authoring/proxies.md

@@ -50,7 +50,7 @@ You can also pass API keys from the widget configuration to the proxy handler, f
 
 ### `credentialedProxyHandler`
 
-A proxy handler that makes authenticated by setting request headers. Credentials are pulled from the widgets configuration.
+A proxy handler that makes authenticated requests by setting request headers. Credentials are pulled from the widgets configuration.
 
 By default the key is passed as an `X-API-Key` header. If you need to pass the key as something else, either add a case to the credentialedProxyHandler or create a new proxy handler.
 
@@ -79,7 +79,21 @@ By default the key is passed as an `X-API-Key` header. If you need to pass the k
 
 ### `jsonrpcProxyHandler`
 
-A proxy handler that makes authenticated JSON-RPC requests to the specified API endpoint. Where the endpoint is the method to call.
+A proxy handler that makes authenticated JSON-RPC requests to the specified API endpoint, either using username + password or an API token.
+The endpoint is the method to call and queryParams are used as the parameters.
+
+=== "component.js"
+
+    ```js
+    import Container from "components/services/widget/container";
+    import useWidgetAPI from "utils/proxy/use-widget-api";
+
+    export default function Component({ service }) {
+      const { widget } = service;
+
+      const { data, error } = useWidgetAPI(widget, 'trigger', { "triggerids": "14062", "output": "extend", "selectFunctions": "extend" });
+    }
+    ```
 
 === "widget.js"
 
@@ -93,6 +107,7 @@ A proxy handler that makes authenticated JSON-RPC requests to the specified API
       mappings: {
         total: { endpoint: "total" },
         average: { endpoint: "average" },
+        trigger: { endpoint: "trigger.get" },
       },
     };
     ```
@@ -110,6 +125,16 @@ A proxy handler that makes authenticated JSON-RPC requests to the specified API
           password: your-password
     ```
 
+    ```yaml
+    - Your Widget:
+        icon: yourwidget.svg
+        href: https://example.com/
+        widget:
+          type: yourwidget
+          url: http://127.0.0.1:1337
+          key: your-api-token
+    ```
+
 ### `synologyProxyHandler`
 
 A proxy handler that makes authenticated requests to the specified Synology API endpoint. This is used exclusively for Synology DSM services.

docs/widgets/authoring/translations.md

@@ -34,7 +34,7 @@ Homepage uses the [next-i18next](https://github.com/i18next/next-i18next) librar
 
 Homepage uses translated and localized strings for **all text and numerical content** in widgets. English is the default language, and other languages can be added via [Crowdin](https://crowdin.com/project/gethomepage). To add the English translations for your widget, follow these steps:
 
-Open the `public/locales/en/common.js` file.
+Open the `public/locales/en/common.json` file.
 
 Add a new object for your widget to the bottom of the list, like this:
 
@@ -71,7 +71,7 @@ Homepage provides a set of common translations that you can use in your widgets.
 | `common.ms`           | `1,000 ms`      | Format a number in milliseconds. |
 | `common.date`         | `2024-01-01`    | Format a date.                   |
 | `common.relativeDate` | `1 day ago`     | Format a relative date.          |
-| `common.uptime`       | `1 day, 1 hour` | Format an uptime.                |
+| `common.duration`     | `1 day, 1 hour` | Format an duration.              |
 
 ### Text
 

docs/widgets/authoring/tutorial.md

@@ -150,7 +150,7 @@ This will render the widget with placeholders for the data, i.e., a skeleton vie
 
 !!! tip "Translation Tips"
 
-      The `label` prop in the `Block` component corresponds to the translation key we defined earlier in the `common.js` file.  All text and numerical content should be translated.
+      The `label` prop in the `Block` component corresponds to the translation key we defined earlier in the `common.json` file.  All text and numerical content should be translated.
 
 ---
 

docs/widgets/index.md

@@ -6,6 +6,8 @@ icon: material/widgets
 
 Homepage has two types of widgets: info and service. Below we'll cover each type and how to configure them.
 
+The left navigation of this site contains links to all available widgets.
+
 ## 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.yaml` file. Here's an example:
@@ -17,12 +19,17 @@ Service widgets are used to display the status of a service, often a web service
     description: Watch movies and TV shows.
     server: localhost
     container: plex
-    widget:
-      type: tautulli
-      url: http://172.16.1.1:8181
-      key: aabbccddeeffgghhiijjkkllmmnnoo
+    widgets:
+      - type: tautulli
+        url: http://172.16.1.1:8181
+        key: aabbccddeeffgghhiijjkkllmmnnoo
+      - type: uptimekuma
+        url: http://172.16.1.2:8080
+        slug: aaaaaaabbbbb
 ```
 
+More detail on configuring service widgets can be found in the [Service Widgets Config](../configs/services.md) section.
+
 ## Info Widgets
 
 Info widgets are used to display information in the header, often about your system or environment. Info widgets are defined your `widgets.yaml` file. Here's an example:
@@ -34,3 +41,5 @@ Info widgets are used to display information in the header, often about your sys
     longitude: -117.51
     cache: 5
 ```
+
+More detail on configuring info widgets can be found in the [Info Widgets Config](../configs/info-widgets.md) section.

docs/widgets/info/index.md

@@ -1,4 +1,21 @@
 ---
 title: Info Widgets
 description: Homepage info widgets.
+search:
+  exclude: true
 ---
+
+You can also find a list of all available info widgets in the sidebar navigation.
+
+- [Date & Time](datetime.md)
+- [Glances](glances.md)
+- [Greeting](greeting.md)
+- [Kubernetes](kubernetes.md)
+- [Logo](logo.md)
+- [Longhorn](longhorn.md)
+- [OpenMeteo](openmeteo.md)
+- [OpenWeatherMap](openweathermap.md)
+- [Resources](resources.md)
+- [Search](search.md)
+- [Stocks](stocks.md)
+- [UniFi Controller](unifi_controller.md)

docs/widgets/info/openmeteo.md

@@ -3,7 +3,7 @@ title: Open-Meteo
 description: Open-Meteo Information Widget Configuration
 ---
 
-No registration is required at all! See [https://open-meteo.com/en/docs](https://open-meteo.com/en/docs)
+Homepage's recommended weather widget. No registration is required at all! See [https://open-meteo.com/en/docs](https://open-meteo.com/en/docs)
 
 ```yaml
 - openmeteo:

docs/widgets/info/resources.md

@@ -9,6 +9,8 @@ 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.
 
+The resources widget primarily relies on a popular tool called [systeminformation](https://systeminformation.io). Thus, any limitiations of that software apply, for example, BRTFS RAID is not supported for the disk usage. In this case users may want to use the [glances widget](glances.md) instead.
+
 _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.**
@@ -22,9 +24,10 @@ _Note: unfortunately, the package used for getting CPU temp ([systeminformation]
     tempmin: 0 # optional, minimum cpu temp
     tempmax: 100 # optional, maximum cpu temp
     uptime: true
-    units: imperial # only used by cpu temp
+    units: imperial # only used by cpu temp, options: 'imperial' or 'metric'
     refresh: 3000 # optional, in ms
     diskUnits: bytes # optional, bytes (default) or bbytes. Only applies to disk
+    network: true # optional, uses 'default' if true or specify a network interface name
 ```
 
 You can also pass a `label` option, which allows you to group resources under named sections,

docs/widgets/info/unifi_controller.md

@@ -5,20 +5,25 @@ description: Unifi Controller Information Widget Configuration
 
 _(Find the Unifi Controller service widget [here](../services/unifi-controller.md))_
 
-You can display general connectivity status from your Unifi (Network) Controller. When authenticating you will want to use a local account that has at least read privileges.
+You can display general connectivity status from your Unifi (Network) Controller.
+
+!!! warning
+
+    When authenticating you will want to use a local account that has at least read privileges.
 
 An optional 'site' parameter can be supplied, if it is not the widget will use the default site for the controller.
 
-_Note: If you enter e.g. incorrect credentials and receive an "API Error", you may need to recreate the container to clear the cache._
+!!! hint
+
+    If you enter e.g. incorrect credentials and receive an "API Error", you may need to recreate the container to clear the cache.
 
 <img width="162" alt="unifi_infowidget" src="https://user-images.githubusercontent.com/4887959/197706832-f5a8706b-7282-4892-a666-b7d999752562.png">
 
 ```yaml
 - unifi_console:
     url: https://unifi.host.or.ip:port
+    site: Site Name # optional
     username: user
     password: pass
-    site: Site Name # optional
+    key: unifiapikey # required if using API key instead of username/password
 ```
-
-_Added in v0.4.18, updated in 0.6.7_

docs/widgets/info/weather.md

@@ -1,22 +0,0 @@
----
-title: Weather API
-description: Weather API Information Widget Configuration
----
-
-**Note: this widget is considered 'deprecated' since there is no longer a free Weather API tier for new members. See the openmeteo or openweathermap widgets for alternatives.**
-
-The free tier is all that's required, you will need to [register](https://www.weatherapi.com/signup.aspx) and grab your API key.
-
-```yaml
-- weatherapi:
-    label: Kyiv # optional
-    latitude: 50.449684
-    longitude: 30.525026
-    units: metric # or imperial
-    apiKey: yourweatherapikey
-    cache: 5 # Time in minutes to cache API responses, to stay within limits
-    format: # optional, Intl.NumberFormat options
-      maximumFractionDigits: 1
-```
-
-You can optionally not pass a `latitude` and `longitude` and the widget will use your current location (requires a secure context, eg. HTTPS).

docs/widgets/services/apcups.md

@@ -0,0 +1,16 @@
+---
+title: APC UPS Monitoring
+description: Lightweight monitoring widget for APC UPSs using apcupsd daemon
+---
+
+This widget extracts UPS information from an apcupsd daemon.
+Only works for [APC/Schneider](https://www.se.com/us/en/product-range/61915-smartups/#products) UPS products.
+
+[!NOTE]
+By default apcupsd daemon is bound to 127.0.0.1. Edit `/etc/apcupsd.conf` and change `NISIP` to an IP accessible from your homepage docker (usually your internal LAN interface).
+
+```yaml
+widget:
+  type: apcups
+  url: tcp://your.acpupsd.host:3551
+```

docs/widgets/services/argocd.md

@@ -0,0 +1,33 @@
+---
+title: ArgoCD
+description: ArgoCD Widget Configuration
+---
+
+Learn more about [ArgoCD](https://argo-cd.readthedocs.io/en/stable/).
+
+Allowed fields (limited to a max of 4): `["apps", "synced", "outOfSync", "healthy", "progressing", "degraded", "suspended", "missing"]`
+
+```yaml
+widget:
+  type: argocd
+  url: http://argocd.host.or.ip:port
+  key: argocdapikey
+```
+
+You can generate an API key either by creating a bearer token for an existing account, see [Authorization](https://argo-cd.readthedocs.io/en/latest/developer-guide/api-docs/#authorization) (not recommended) or create a new local user account with limited privileges and generate an authentication token for this account. To do this the steps are:
+
+- [Create a new local user](https://argo-cd.readthedocs.io/en/stable/operator-manual/user-management/#create-new-user) and give it the `apiKey` capability
+- Setup [RBAC configuration](https://argo-cd.readthedocs.io/en/stable/operator-manual/rbac/#rbac-configuration) for your the user and give it readonly access to your ArgoCD resources, e.g. by giving it the `role:readonly` role.
+- In your ArgoCD project under _Settings / Accounts_ open the newly created account and in the _Tokens_ section click on _Generate New_ to generate an access token, optionally specifying an expiry date.
+
+If you installed ArgoCD via the official Helm chart, the account creation and rbac config can be achived by overriding these helm values:
+
+```yaml
+configs:
+  cm:
+    accounts.readonly: apiKey
+  rbac:
+    policy.csv: "g, readonly, role:readonly"
+```
+
+This creates a new account called `readonly` and attaches the `role:readonly` role to it.

docs/widgets/services/authentik.md

@@ -17,9 +17,15 @@ The account you made the API token for also needs the following **Assigned globa
 
 Allowed fields: `["users", "loginsLast24H", "failedLoginsLast24H"]`.
 
+| Authentik Version | Homepage Widget Version |
+| ----------------- | ----------------------- |
+| < 2025.8.0        | 1 (default)             |
+| >= 2025.8.0       | 2                       |
+
 ```yaml
 widget:
   type: authentik
-  url: http://authentik.host.or.ip:22070
+  url: http://authentik.host.or.ip:port
   key: api_token
+  version: 2 # optional, default is 1
 ```

docs/widgets/services/beszel.md

@@ -0,0 +1,30 @@
+---
+title: Beszel
+description: Beszel Widget Configuration
+---
+
+Learn more about [Beszel](https://github.com/henrygd/beszel)
+
+The widget has two modes, a single system with detailed info if `systemId` is provided, or an overview of all systems if `systemId` is not provided.
+
+The `systemID` is the `id` field on the collections page of Beszel under the PocketBase admin panel. You can also use the 'nice name' from the Beszel UI.
+
+A "superuser" is currently required to access the data from the Beszel API.
+
+Allowed fields for 'overview' mode: `["systems", "up"]`
+Allowed fields for a single system: `["name", "status", "updated", "cpu", "memory", "disk", "network"]`
+
+| Beszel Version | Homepage Widget Version |
+| -------------- | ----------------------- |
+| < 0.9.0        | 1 (default)             |
+| >= 0.9.0       | 2                       |
+
+```yaml
+widget:
+  type: beszel
+  url: http://beszel.host.or.ip
+  username: username # email
+  password: password
+  systemId: systemId # optional
+  version: 2 # optional, default is 1
+```

docs/widgets/services/calendar.md

@@ -22,6 +22,7 @@ widget:
       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)
+      baseUrl: https://sonarr.domain.url # optional - adds links to sonarr/radarr pages
       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

docs/widgets/services/changedetectionio.md

@@ -7,6 +7,8 @@ Learn more about [Changedetection.io](https://github.com/dgtlmoon/changedetectio
 
 Find your API key under `Settings > API`.
 
+Allowed fields: `["diffsDetected", "totalObserved"]`.
+
 ```yaml
 widget:
   type: changedetectionio

docs/widgets/services/checkmk.md

@@ -0,0 +1,17 @@
+---
+title: Checkmk
+description: Checkmk Widget Configuration
+---
+
+Learn more about [Checkmk](https://github.com/Checkmk/checkmk).
+
+To setup authentication, follow the official [Checkmk API](https://docs.checkmk.com/latest/en/rest_api.html?lquery=api#bearerauth) documentation.
+
+```yaml
+widget:
+  type: checkmk
+  url: http://checkmk.host.or.ip:port
+  site: your-site-name-cla-by-default
+  username: username
+  password: password
+```

docs/widgets/services/customapi.md

@@ -19,27 +19,22 @@ widget:
   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
+    - field: key
       label: Field 1
       format: text # optional - defaults to text
-    - field: # needs to be YAML string or object
-        path:
-          to: key2
+    - field: path.to.key2
       format: number # optional - defaults to text
       label: Field 2
-    - field: # needs to be YAML string or object
-        path:
-          to:
-            another: key3
+    - field: path.to.another.key3
       label: Field 3
       format: percent # optional - defaults to text
-    - field: key # needs to be YAML string or object
+    - field: key
       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
+    - field: key
       label: Field 5
       format: relativeDate # optional - defaults to text
       locale: nl # optional
@@ -49,17 +44,25 @@ widget:
       label: Field 6
       format: text
       additionalField: # optional
-        field:
-          hourly:
-            time: other key
+        field: hourly.time.key
         color: theme # optional - defaults to "". Allowed values: `["theme", "adaptive", "black", "white"]`.
         format: date # optional
+    - field: key
+      label: Number of things in array
+      format: size
+    # This (no field) will take the root of the API response, e.g. when APIs return an array:
+    - label: Number of items
+      format: size
 ```
 
-Supported formats for the values are `text`, `number`, `float`, `percent`, `bytes`, `bitrate`, `date` and `relativeDate`.
+Supported formats for the values are `text`, `number`, `float`, `percent`, `duration`, `bytes`, `bitrate`, `size`, `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).
 
+The `duration` format expects the duration to be specified in seconds. The `scale` transformation tool can be used if a conversion is required.
+
+The `size` format will return the length of the array or string, or the number of keys in an object. This is then formatted as `number`.
+
 ## Example
 
 For the following JSON object from the API:
@@ -93,9 +96,16 @@ mappings:
     label: Name
   - field: status # Alive
     label: Status
-  - field:
-      origin: name # Earth (C-137)
+  - field: origin.name # Earth (C-137)
     label: Origin
+  - field: locations.1.name # Citadel of Ricks
+    label: Location
+```
+
+Note that older versions of the widget accepted fields as a yaml object, which is still supported. E.g.:
+
+```yaml
+mappings:
   - field:
       locations:
         1: name # Citadel of Ricks
@@ -128,7 +138,15 @@ You can manipulate data with the following tools `remap`, `scale`, `prefix` and
   prefix: "$"
 ```
 
-## List View
+## Display Options
+
+The widget supports different display modes that can be set using the `display` property.
+
+### Block View (Default)
+
+The default display mode is `block`, which shows fields in a block format.
+
+### List View
 
 You can change the default block view to a list view by setting the `display` option to `list`.
 
@@ -152,13 +170,54 @@ The list view can optionally display an additional field next to the primary fie
     - any: true # will map all other values
       to: Unknown
   additionalField:
-    field:
-      hourly:
-        time: key
+    field: hourly.time.key
     color: theme
     format: date
 ```
 
+### Dynamic List View
+
+To display a list of items from an array in the API response, set the `display` property to `dynamic-list` and configure the `mappings` object with the following properties:
+
+```yaml
+widget:
+  type: customapi
+  url: https://example.com/api/servers
+  display: dynamic-list
+  mappings:
+    items: data # optional, the path to the array in the API response. Omit this option if the array is at the root level
+    name: id # required, field in each item to use as the item name (left side)
+    label: ip_address # required, field in each item to use as the item label (right side)
+    limit: 5 # optional, limit the number of items to display
+    format: text # optional - format of the label field
+    target: https://example.com/server/{id} # optional, makes items clickable with template support
+```
+
+This configuration would work with an API that returns a response like:
+
+```json
+{
+  "data": [
+    { "id": "server1", "name": "Server 1", "ip_address": "192.168.0.1" },
+    { "id": "server2", "name": "Server 2", "ip_address": "192.168.0.2" }
+  ]
+}
+```
+
+The widget would display a list with two items:
+
+- "Server 1" on the left and "192.168.0.1" on the right, clickable to "https://example.com/server/server1"
+- "Server 2" on the left and "192.168.0.2" on the right, clickable to "https://example.com/server/server2"
+
+For nested fields in the items, you can use dot notation:
+
+```yaml
+mappings:
+  items: data.results.servers
+  name: details.id
+  label: details.name
+```
+
 ## Custom Headers
 
 Pass custom headers using the `headers` option, for example:

docs/widgets/services/deluge.md

@@ -14,4 +14,5 @@ widget:
   type: deluge
   url: http://deluge.host.or.ip
   password: password # webui password
+  enableLeechProgress: true # optional, defaults to false
 ```

docs/widgets/services/develancacheui.md

@@ -0,0 +1,14 @@
+---
+title: DeveLanCacheUI
+description: DeveLanCacheUI Widget Configuration
+---
+
+Learn more about [DeveLanCacheUI](https://github.com/devedse/DeveLanCacheUI_Backend).
+
+```yaml
+widget:
+  type: develancacheui
+  url: http://your.develancacheui_backend.host:port
+```
+
+The url should point to the DeveLanCacheUI Backend (API)

docs/widgets/services/diskstation.md

@@ -18,7 +18,7 @@ To access these system metrics you need to connect to the DiskStation (`DSM`) wi
 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 `DSM` application, either by
+6. Now _only_ allow login to the `DSM` and `Download Station` applications, 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.

docs/widgets/services/emby.md

@@ -17,6 +17,7 @@ widget:
   enableBlocks: true # optional, defaults to false
   enableNowPlaying: true # optional, defaults to true
   enableUser: true # optional, defaults to false
+  enableMediaControl: false # optional, defaults to true
   showEpisodeNumber: true # optional, defaults to false
   expandOneStreamToTwoRows: false # optional, defaults to true
 ```

docs/widgets/services/esphome.md

@@ -16,4 +16,6 @@ To group both `offline` and `unknown` devices together, users should use the `of
 widget:
   type: esphome
   url: http://esphome.host.or.ip:port
+  username: myesphomeuser # only if auth enabled
+  password: myesphomepass # only if auth enabled
 ```

docs/widgets/services/evcc.md

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

docs/widgets/services/filebrowser.md

@@ -0,0 +1,19 @@
+---
+title: Filebrowser
+description: Filebrowser Widget Configuration
+---
+
+Learn more about [Filebrowser](https://filebrowser.org).
+
+If you are using [Proxy header authentication](https://filebrowser.org/configuration/authentication-method#proxy-header) you have to set `authHeader` and `username`.
+
+Allowed fields: `["available", "used", "total"]`.
+
+```yaml
+widget:
+  type: filebrowser
+  url: http://filebrowserhostorip:port
+  username: username
+  password: password
+  authHeader: X-My-Header # If using Proxy header authentication
+```

docs/widgets/services/firefly.md

@@ -0,0 +1,17 @@
+---
+title: Firefly III
+description: Firefly III Widget Configuration
+---
+
+Learn more about [Firefly III](https://www.firefly-iii.org/).
+
+Find your API key under `Options > Profile > OAuth > Personal Access Tokens`.
+
+Allowed fields: `["networth" ,"budget"]`.
+
+```yaml
+widget:
+  type: firefly
+  url: https://firefly.host.or.ip
+  key: personalaccesstoken.personalaccesstoken.personalaccesstoken
+```

docs/widgets/services/frigate.md

@@ -0,0 +1,17 @@
+---
+title: Frigate
+description: Frigate Widget Configuration
+---
+
+Learn more about [Frigate](https://frigate.video/).
+
+Allowed fields: `["cameras", "uptime", "version"]`.
+
+A recent event listing is disabled by default, but can be enabled with the `enableRecentEvents` option.
+
+```yaml
+widget:
+  type: frigate
+  url: http://frigate.host.or.ip:port
+  enableRecentEvents: true # Optional, defaults to false
+```

docs/widgets/services/fritzbox.md

@@ -13,7 +13,7 @@ Home Network > Network > Network Settings > Access Settings in the Home Network
 
 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"]`.
+Allowed fields (limited to a max of 4): `["connectionStatus", "uptime", "maxDown", "maxUp", "down", "up", "received", "sent", "externalIPAddress", "externalIPv6Address", "externalIPv6Prefix"]`.
 
 ```yaml
 widget:

docs/widgets/services/gamedig.md

@@ -14,4 +14,5 @@ widget:
   type: gamedig
   serverType: csgo # see https://github.com/gamedig/node-gamedig#games-list
   url: udp://server.host.or.ip:port
+  gameToken: # optional, a token used by gamedig with certain games
 ```

docs/widgets/services/gitea.md

@@ -7,7 +7,7 @@ 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"]`.
+Allowed fields: `["repositories", "notifications", "issues", "pulls"]`.
 
 ```yaml
 widget:

docs/widgets/services/gitlab.md

@@ -0,0 +1,20 @@
+---
+title: Gitlab
+description: Gitlab Widget Configuration
+---
+
+Learn more about [Gitlab](https://gitlab.com).
+
+API requires a personal access token with either `read_api` or `api` permission. See the [gitlab documentation](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#create-a-personal-access-token) for details on generating one.
+
+Your Gitlab user ID can be found on [your profile page](https://support.circleci.com/hc/en-us/articles/20761157174043-How-to-find-your-GitLab-User-ID).
+
+Allowed fields: `["events", "issues", "merges", "projects"]`.
+
+```yaml
+widget:
+  type: gitlab
+  url: http://gitlab.host.or.ip:port
+  key: personal-access-token
+  user_id: 123456
+```

docs/widgets/services/glances.md

@@ -51,6 +51,8 @@ The metric field in the configuration determines the type of system monitoring d
 
 `process`: Top 5 processes based on CPU usage. Gives an overview of which processes are consuming the most resources.
 
+`containers`: Docker or Kubernetes containers list. Shows up to 5 containers running on the system and their resource usage.
+
 `network:<interface_name>`: Network data usage for the specified interface. Replace `<interface_name>` with the name of your network interface, e.g., `network:enp0s25`, as specified in glances.
 
 `sensor:<sensor_id>`: Temperature of the specified sensor, typically used to monitor CPU temperature. Replace `<sensor_id>` with the name of your sensor, e.g., `sensor:Package id 0` as specified in glances.

docs/widgets/services/gluetun.md

@@ -9,10 +9,14 @@ Learn more about [Gluetun](https://github.com/qdm12/gluetun).
 
     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"]`.
+Allowed fields: `["public_ip", "region", "country", "port_forwarded"]`.
+Default fields: `["public_ip", "region", "country"]`.
+
+To setup authentication, follow [the official Gluetun documentation](https://github.com/qdm12/gluetun-wiki/blob/main/setup/advanced/control-server.md#authentication). Note that to use the api key method, you must add the route `GET /v1/publicip/ip` to the `routes` array in your Gluetun config.toml. Similarly, if you want to include the `port_forwarded` field, you must add the route `GET /v1/openvpn/portforwarded` to your Gluetun config.toml.
 
 ```yaml
 widget:
   type: gluetun
   url: http://gluetun.host.or.ip:port
+  key: gluetunkey # Not required if /v1/publicip/ip endpoint is configured with `auth = none`
 ```

docs/widgets/services/grafana.md

@@ -5,11 +5,18 @@ description: Grafana Widget Configuration
 
 Learn more about [Grafana](https://github.com/grafana/grafana).
 
+| Grafana Version | Homepage Widget Version |
+| --------------- | ----------------------- |
+| <= v10.4        | 1 (default)             |
+| > v10.4         | 2                       |
+
 Allowed fields: `["dashboards", "datasources", "totalalerts", "alertstriggered"]`.
 
 ```yaml
 widget:
   type: grafana
+  version: 2 # optional, default is 1
+  alerts: alertmanager # optional, default is grafana
   url: http://grafana.host.or.ip:port
   username: username
   password: password

docs/widgets/services/headscale.md

@@ -0,0 +1,20 @@
+---
+title: Headscale
+description: Headscale Widget Configuration
+---
+
+Learn more about [Headscale](https://headscale.net/).
+
+You will need to generate an API access token from the [command line](https://headscale.net/ref/remote-cli/#create-an-api-key) using `headscale apikeys create` command.
+
+To find your node ID, you can use `headscale nodes list` command.
+
+Allowed fields: `["name", "address", "last_seen", "status"]`.
+
+```yaml
+widget:
+  type: headscale
+  url: http://headscale.host.or.ip:port
+  nodeId: nodeid
+  key: headscaleapiaccesstoken
+```

docs/widgets/services/immich.md

@@ -5,15 +5,19 @@ description: Immich Widget Configuration
 
 Learn more about [Immich](https://github.com/immich-app/immich).
 
+| Immich Version | Homepage Widget Version |
+| -------------- | ----------------------- |
+| < v1.118       | 1 (default)             |
+| >= v1.118      | 2                       |
+
 Find your API key under `Account Settings > API Keys`.
 
 Allowed fields: `["users" ,"photos", "videos", "storage"]`.
 
-Note that API key must be from admin user.
-
 ```yaml
 widget:
   type: immich
   url: http://immich.host.or.ip
   key: adminapikeyadminapikeyadminapikey
+  version: 2 # optional, default is 1
 ```

docs/widgets/services/index.md

@@ -1,4 +1,152 @@
 ---
 title: Service Widgets
 description: Homepage service widgets.
+search:
+  exclude: true
 ---
+
+You can also find a list of all available service widgets in the sidebar navigation.
+
+- [Adguard Home](adguard-home.md)
+- [APC UPS](apcups.md)
+- [ArgoCD](argocd.md)
+- [Atsumeru](atsumeru.md)
+- [Audiobookshelf](audiobookshelf.md)
+- [Authentik](authentik.md)
+- [Autobrr](autobrr.md)
+- [Azure DevOps](azuredevops.md)
+- [Bazarr](bazarr.md)
+- [Beszel](beszel.md)
+- [Caddy](caddy.md)
+- [Calendar](calendar.md)
+- [Calibre-Web](calibre-web.md)
+- [ChangeDetection.io](changedetectionio.md)
+- [Channels DVR Server](channelsdvrserver.md)
+- [Checkmk](checkmk.md)
+- [Cloudflared](cloudflared.md)
+- [Coin Market Cap](coin-market-cap.md)
+- [CrowdSec](crowdsec.md)
+- [Custom API](customapi.md)
+- [Deluge](deluge.md)
+- [DeveLanCacheUI](develancacheui.md)
+- [DiskStation](diskstation.md)
+- [DownloadStation](downloadstation.md)
+- [Emby](emby.md)
+- [ESPHome](esphome.md)
+- [EVCC](evcc.md)
+- [Filebrowser](filebrowser.md)
+- [Fileflows](fileflows.md)
+- [Firefly III](firefly.md)
+- [Flood](flood.md)
+- [FreshRSS](freshrss.md)
+- [Frigate](frigate.md)
+- [Fritz!Box](fritzbox.md)
+- [GameDig](gamedig.md)
+- [Gatus](gatus.md)
+- [Ghostfolio](ghostfolio.md)
+- [Gitea](gitea.md)
+- [Gitlab](gitlab.md)
+- [Glances](glances.md)
+- [Gluetun](gluetun.md)
+- [Gotify](gotify.md)
+- [Grafana](grafana.md)
+- [HDHomeRun](hdhomerun.md)
+- [Headscale](headscale.md)
+- [Healthchecks](healthchecks.md)
+- [Karakeep](karakeep.md)
+- [Home Assistant](homeassistant.md)
+- [HomeBox](homebox.md)
+- [Homebridge](homebridge.md)
+- [iFrame](iframe.md)
+- [Immich](immich.md)
+- [Jackett](jackett.md)
+- [JDownloader](jdownloader.md)
+- [Jellyfin](jellyfin.md)
+- [Jellyseerr](jellyseerr.md)
+- [Jellystat](jellystat.md)
+- [Kavita](kavita.md)
+- [Komga](komga.md)
+- [Komodo](komodo.md)
+- [Kopia](kopia.md)
+- [Lidarr](lidarr.md)
+- [Linkwarden](linkwarden.md)
+- [Lubelogger](lubelogger.md)
+- [Mastodon](mastodon.md)
+- [Mailcow](mailcow.md)
+- [Mealie](mealie.md)
+- [Medusa](medusa.md)
+- [Mikrotik](mikrotik.md)
+- [Minecraft](minecraft.md)
+- [Miniflux](miniflux.md)
+- [MJpeg](mjpeg.md)
+- [Moonraker](moonraker.md)
+- [Mylar](mylar.md)
+- [MySpeed](myspeed.md)
+- [Navidrome](navidrome.md)
+- [NetAlertX](netalertx.md)
+- [Netdata](netdata.md)
+- [Nextcloud](nextcloud.md)
+- [NextDNS](nextdns.md)
+- [NGINX Proxy Manager](nginx-proxy-manager.md)
+- [NZBGet](nzbget.md)
+- [OctoPrint](octoprint.md)
+- [Omada](omada.md)
+- [Ombi](ombi.md)
+- [OpenDTU](opendtu.md)
+- [OpenMediaVault](openmediavault.md)
+- [OpenWRT](openwrt.md)
+- [OPNsense](opnsense.md)
+- [Overseerr](overseerr.md)
+- [PaperlessNGX](paperlessngx.md)
+- [Peanut](peanut.md)
+- [pfSense](pfsense.md)
+- [PhotoPrism](photoprism.md)
+- [Pi-hole](pihole.md)
+- [PlantIt](plantit.md)
+- [Plex & Tautulli](plex-tautulli.md)
+- [Plex](plex.md)
+- [Portainer](portainer.md)
+- [Prometheus](prometheus.md)
+- [Prometheus Metric](prometheusmetric.md)
+- [Prowlarr](prowlarr.md)
+- [Proxmox](proxmox.md)
+- [Proxmox Backup Server](proxmoxbackupserver.md)
+- [Pterodactyl](pterodactyl.md)
+- [PyLoad](pyload.md)
+- [qBittorrent](qbittorrent.md)
+- [QNAP](qnap.md)
+- [Radarr](radarr.md)
+- [Readarr](readarr.md)
+- [ROMM](romm.md)
+- [ruTorrent](rutorrent.md)
+- [SABnzbd](sabnzbd.md)
+- [Scrutiny](scrutiny.md)
+- [Slskd](slskd.md)
+- [Sonarr](sonarr.md)
+- [Speedtest Tracker](speedtest-tracker.md)
+- [Stash](stash.md)
+- [Stocks](stocks.md)
+- [SwagDashboard](swagdashboard.md)
+- [Syncthing Relay Server](syncthing-relay-server.md)
+- [Tailscale](tailscale.md)
+- [Tandoor](tandoor.md)
+- [Technitium DNS](technitium.md)
+- [TDarr](tdarr.md)
+- [Traefik](traefik.md)
+- [Transmission](transmission.md)
+- [Trilium](trilium.md)
+- [TrueNAS](truenas.md)
+- [TubeArchivist](tubearchivist.md)
+- [UniFi Controller](unifi-controller.md)
+- [Unmanic](unmanic.md)
+- [Unraid](unraid.md)
+- [Uptime Kuma](uptime-kuma.md)
+- [UptimeRobot](uptimerobot.md)
+- [UrBackup](urbackup.md)
+- [Vikunja](vikunja.md)
+- [Wallos](wallos.md)
+- [Watchtower](watchtower.md)
+- [WGEasy](wgeasy.md)
+- [WhatsUpDocker](whatsupdocker.md)
+- [xTeVe](xteve.md)
+- [Zabbix](zabbix.md)

docs/widgets/services/jdownloader.md

@@ -1,6 +1,6 @@
 ---
 title: JDownloader
-description: NextPVR Widget Configuration
+description: JDownloader Widget Configuration
 ---
 
 Learn more about [JDownloader](https://jdownloader.org/).

docs/widgets/services/jellyfin.md

@@ -17,6 +17,7 @@ widget:
   enableBlocks: true # optional, defaults to false
   enableNowPlaying: true # optional, defaults to true
   enableUser: true # optional, defaults to false
+  enableMediaControl: false # optional, defaults to true
   showEpisodeNumber: true # optional, defaults to false
   expandOneStreamToTwoRows: false # optional, defaults to true
 ```

docs/widgets/services/jellystat.md

@@ -0,0 +1,18 @@
+---
+title: Jellystat
+description: Jellystat Widget Configuration
+---
+
+Learn more about [Jellystat](https://github.com/CyferShepard/Jellystat). The widget supports (at least) Jellystat version 1.1.6
+
+You can create an API key from inside Jellystat at `Settings > API Key`.
+
+Allowed fields: `["songs", "movies", "episodes", "other"]`.
+
+```yaml
+widget:
+  type: jellystat
+  url: http://jellystat.host.or.ip
+  key: apikeyapikeyapikeyapikeyapikey
+  days: 30 # optional, defaults to 30
+```

docs/widgets/services/karakeep.md

@@ -0,0 +1,17 @@
+---
+title: Karakeep
+description: Karakeep Widget Configuration
+---
+
+Learn more about [Karakeep](https://karakeep.app) (formerly known as Hoarder).
+
+Generate an API key for your user at `User Settings > API Keys`.
+
+Allowed fields: `["bookmarks", "favorites", "archived", "highlights", "lists", "tags"]` (maximum of 4).
+
+```yaml
+widget:
+  type: karakeep
+  url: http[s]://karakeep.host.or.ip[:port]
+  key: karakeep_api_key
+```

docs/widgets/services/kavita.md

@@ -15,4 +15,5 @@ widget:
   url: http://kavita.host.or.ip:port
   username: username
   password: password
+  key: kavitaapikey # Optional, e.g. if not using username and password
 ```

docs/widgets/services/komga.md

@@ -9,10 +9,16 @@ Uses the same username and password used to login from the web.
 
 Allowed fields: `["libraries", "series", "books"]`.
 
+| Komga API Version | Homepage Widget Version |
+| ----------------- | ----------------------- |
+| < v2              | 1 (default)             |
+| >= v2             | 2                       |
+
 ```yaml
 widget:
   type: komga
   url: http://komga.host.or.ip:port
   username: username
   password: password
+  key: komgaapikey # optional
 ```

docs/widgets/services/komodo.md

@@ -0,0 +1,22 @@
+---
+title: Komodo
+description: Komodo Widget Configuration
+---
+
+This widget shows either details about all containers or stacks (if `showStacks` is true) managed by [Komodo](https://komo.do/) or the number of running servers, containers and stacks when `showSummary` is enabled.
+
+The api key and secret can be found in the Komodo settings.
+
+Allowed fields (max 4): `["total", "running", "stopped", "unhealthy", "unknown"]`.
+Allowed fields with `showStacks` (max 4): `["total", "running", "down", "unhealthy", "unknown"]`.
+Allowed fields with `showSummary`: `["servers", "stacks", "containers"]`.
+
+```yaml
+widget:
+  type: komodo
+  url: http://komodo.hostname.or.ip:port
+  key: K-xxxxxx...
+  secret: S-xxxxxx...
+  showSummary: true # optional, default: false
+  showStacks: true # optional, default: false
+```

docs/widgets/services/linkwarden.md

@@ -0,0 +1,15 @@
+---
+title: Linkwarden
+description: Linkwarden Widget Configuration
+---
+
+Learn more about [Linkwarden](https://linkwarden.app/).
+
+Allowed fields: `["links", "collections", "tags"]`.
+
+```yaml
+widget:
+  type: linkwarden
+  url: http://linkwarden.host.or.ip
+  key: myApiKeyHere # On your Linkwarden install, go to Settings > Access Tokens. Generate a token.
+```

docs/widgets/services/lubelogger.md

@@ -0,0 +1,20 @@
+---
+title: LubeLogger
+description: LubeLogger Widget Configuration
+---
+
+Learn more about [LubeLogger](https://github.com/hargata/lubelog) (v1.3.7 or higher is required).
+
+The widget comes in two 'flavors', one shows data for all vehicles or for just a specific vehicle with the `vehicleID` parameter.
+
+Allowed fields: `["vehicles", "serviceRecords", "reminders"]`.
+For the single-vehicle version: `["vehicle", "serviceRecords", "reminders", "nextReminder"]`.
+
+```yaml
+widget:
+  type: lubelogger
+  url: https://lubelogger.host.or.ip
+  username: lubeloggerusername
+  password: lubeloggerpassword
+  vehicleID: 1 # optional, changes to single-vehicle version
+```

docs/widgets/services/mailcow.md

@@ -0,0 +1,15 @@
+---
+title: Mailcow
+description: Mailcow Widget Configuration
+---
+
+Learn more about [Mailcow](https://github.com/mailcow/mailcow-dockerized).
+
+Allowed fields: `["domains", "mailboxes", "mails", "storage"]`.
+
+```yaml
+widget:
+  type: mailcow
+  url: https://mailcow.host.or.ip
+  key: mailcowapikey
+```

docs/widgets/services/mealie.md

@@ -14,4 +14,5 @@ widget:
   type: mealie
   url: http://mealie-frontend.host.or.ip
   key: mealieapitoken
+  version: 2 # only required if version > 1, defaults to 1
 ```

docs/widgets/services/netalertx.md

@@ -9,8 +9,11 @@ _Note that the project was renamed from PiAlert to NetAlertX._
 
 Allowed fields: `["total", "connected", "new_devices", "down_alerts"]`.
 
+If you have enabled a password on your NetAlertX instance, you will need to provide the `SYNC_api_token` as the `key` in your config.
+
 ```yaml
 widget:
   type: netalertx
   url: http://ip:port
+  key: netalertxsyncapitoken # optional, only if password is enabled
 ```

docs/widgets/services/opnsense.md

@@ -8,7 +8,7 @@ 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
-- Status: Traffic Graph
+- Status: Traffic Graph / Reporting: Traffic (OPNSENSE 24.7.x)
 
 Finally, create a new API key which will download an `apikey.txt` file with your key and secret in it. Use the values as the username and password fields, respectively, in your homepage config.
 
@@ -20,4 +20,5 @@ widget:
   url: http://opnsense.host.or.ip
   username: key
   password: secret
+  wan: opt1 # optional, defaults to wan
 ```

docs/widgets/services/peanut.md

@@ -20,4 +20,6 @@ widget:
   type: peanut
   url: http://peanut.host.or.ip:port
   key: nameofyourups
+  username: username # only needed if set
+  password: password # only needed if set
 ```

docs/widgets/services/pfsense.md

@@ -9,7 +9,7 @@ This widget requires the installation of the [pfsense-api](https://github.com/ja
 
 Once pfSense API is installed, you can set the API to be read-only in System > API > Settings.
 
-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.
+There are two currently supported authentication modes: 'Local Database' and 'API Key' (v2) / 'API Token' (v1). For 'Local Database', use `username` and `password` with the credentials of an admin user. The specifics of using the API key / token depend on the version of the pfSense API, see the config examples below. Do not use both headers and username / password.
 
 The interface to monitor is defined by updating the `wan` parameter. It should be referenced as it is shown under Interfaces > Assignments in pfSense.
 
@@ -17,14 +17,25 @@ Load is returned instead of cpu utilization. This is a limitation in the pfSense
 
 Allowed fields: `["load", "memory", "temp", "wanStatus", "wanIP", "disk"]` (maximum of 4)
 
+For version 2:
+
 ```yaml
 widget:
   type: pfsense
   url: http://pfsense.host.or.ip:port
-  username: user # optional, or API token
-  password: pass # optional, or API token
+  username: user # optional, or API key
+  password: pass # optional, or API key
   headers: # optional, or username/password
-    Authorization: client_id client_token
+    X-API-Key: key
   wan: igb0
+  version: 2 # optional, defaults to 1 for api v1
   fields: ["load", "memory", "temp", "wanStatus"] # optional
 ```
+
+For version 1:
+
+```yaml
+headers: # optional, or username/password
+  Authorization: client_id client_token # obtained from pfSense API
+version: 1
+```

docs/widgets/services/photoprism.md

@@ -3,7 +3,9 @@ title: PhotoPrism
 description: PhotoPrism Widget Configuration
 ---
 
-Learn more about [PhotoPrism](https://github.com/photoprism/photoprism)..
+Learn more about [PhotoPrism](https://github.com/photoprism/photoprism).
+
+Authentication is possible via [app passwords](https://docs.photoprism.app/user-guide/settings/account/#apps-and-devices) or username/password.
 
 Allowed fields: `["albums", "photos", "videos", "people"]`.
 
@@ -11,6 +13,7 @@ Allowed fields: `["albums", "photos", "videos", "people"]`.
 widget:
   type: photoprism
   url: http://photoprism.host.or.ip:port
-  username: admin
-  password: password
+  username: admin # required only if using username/password
+  password: password # required only if using username/password
+  key: # required only if using app passwords
 ```

docs/widgets/services/pihole.md

@@ -5,8 +5,6 @@ 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.
@@ -16,7 +14,5 @@ widget:
   type: pihole
   url: http://pi.hole.or.ip
   version: 6 # required if running v6 or higher, defaults to 5
-  key: yourpiholeapikey # optional
+  key: yourpiholeapikey # optional, in v6 can be your password or app password
 ```
-
-_Added in v0.1.0, updated in v0.8.9_

docs/widgets/services/portainer.md

@@ -7,12 +7,16 @@ Learn more about [Portainer](https://github.com/portainer/portainer).
 
 You'll need to make sure you have the correct environment set for the integration to work properly. From the Environments section inside of Portainer, click the one you'd like to connect to and observe the ID at the end of the URL (should be), something like `#!/endpoints/1`, here `1` is the value to set as the `env` value. In order to generate an API key, please follow the steps outlined here https://docs.portainer.io/api/access.
 
-Allowed fields: `["running", "stopped", "total"]`.
+Allowed fields:
+
+- For Docker mode (default): `["running", "stopped", "total"]`
+- For Kubernetes mode (`kubernetes: true`): `["applications", "services", "namespaces"]`
 
 ```yaml
 widget:
   type: portainer
   url: https://portainer.host.or.ip:9443
   env: 1
+  kubernetes: true # optional, defaults to false
   key: ptr_accesskeyaccesskeyaccesskeyaccesskey
 ```

docs/widgets/services/prometheusmetric.md

@@ -0,0 +1,67 @@
+---
+title: Prometheus Metric
+description: Prometheus Metric Widget Configuration
+---
+
+Learn more about [Querying Prometheus](https://prometheus.io/docs/prometheus/latest/querying/basics/).
+
+This widget can show metrics for your service defined by PromQL queries which are requested from a running Prometheus instance.
+
+Quries can be defined in the `metrics` array of the widget along with a label to be used to present the metric value. You can optionally specify a global `refreshInterval` in milliseconds and/or define the `refreshInterval` per metric. Inside the optional `format` object of a metric various formatting styles and transformations can be applied (see below).
+
+```yaml
+widget:
+  type: prometheusmetric
+  url: https://prometheus.host.or.ip
+  refreshInterval: 10000 # optional - in milliseconds, defaults to 10s
+  metrics:
+    - label: Metric 1
+      query: alertmanager_alerts{state="active"}
+    - label: Metric 2
+      query: apiserver_storage_size_bytes{node="mynode"}
+      format:
+        type: bytes
+    - label: Metric 3
+      query: avg(prometheus_notifications_latency_seconds)
+      format:
+        type: number
+        suffix: s
+        options:
+          maximumFractionDigits: 4
+    - label: Metric 4
+      query: time()
+      refreshInterval: 1000 # will override global refreshInterval
+      format:
+        type: date
+        scale: 1000
+        options:
+          timeStyle: medium
+```
+
+## Formatting
+
+Supported values for `format.type` are `text`, `number`, `percent`, `bytes`, `bits`, `bbytes`, `bbits`, `byterate`, `bibyterate`, `bitrate`, `bibitrate`, `date`, `duration`, `relativeDate`, and `text` which is the default.
+
+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). For the `number` format, options of [Intl.NumberFormat](https://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat) can be used, e.g. `maximumFractionDigits` or `minimumFractionDigits`.
+
+### Data Transformation
+
+You can manipulate your metric value with the following tools: `scale`, `prefix` and `suffix`, for example:
+
+```yaml
+- query: my_custom_metric{}
+  label: Metric 1
+  format:
+    type: number
+    scale: 1000 # multiplies value by a number or fraction string e.g. 1/16
+- query: my_custom_metric{}
+  label: Metric 2
+  format:
+    type: number
+    prefix: "$" # prefixes value with given string
+- query: my_custom_metric{}
+  label: Metric 3
+  format:
+    type: number
+    suffix: "€" # suffixes value with given string
+```

docs/widgets/services/proxmox.md

@@ -7,34 +7,7 @@ Learn more about [Proxmox](https://www.proxmox.com/en/).
 
 This widget shows the running and total counts of both QEMU VMs and LX Containers in the Proxmox cluster. It also shows the CPU and memory usage of the first node in the cluster.
 
-You will need to generate an API Token for new or an existing user. Here is an example of how to do this for a new user.
-
-1. Navigate to the Proxmox portal, click on Datacenter
-2. Expand Permissions, click on Groups
-3. Click the Create button
-4. Name the group something informative, like api-ro-users
-5. Click on the Permissions "folder"
-6. Click Add -> Group Permission
-   - Path: /
-   - Group: group from bullet 4 above
-   - Role: PVEAuditor
-   - Propagate: Checked
-7. Expand Permissions, click on Users
-8. Click the Add button
-   - User name: something informative like `api`
-   - Realm: Linux PAM standard authentication
-   - Group: group from bullet 4 above
-9. Expand Permissions, click on API Tokens
-10. Click the Add button
-    - User: user from bullet 8 above
-    - Token ID: something informative like the application or purpose like `homepage`
-    - Privilege Separation: Checked
-11. Go back to the "Permissions" menu
-12. Click Add -> API Token Permission
-    - Path: /
-    - API Token: select the Token ID created in Step 10
-    - Role: PVE Auditor
-    - Propagate: Checked
+See the [Proxmox configuration documentation](../../configs/proxmox.md#create-token) for details on creating API tokens.
 
 Use `username@pam!Token ID` as the `username` (e.g `api@pam!homepage`) setting and `Secret` as the `password` setting.
 

docs/widgets/services/proxmoxbackupserver.md

@@ -5,6 +5,8 @@ description: Proxmox Backup Server Widget Configuration
 
 Learn more about [Proxmox Backup Server](https://www.proxmox.com/en/proxmox-backup-server/overview).
 
+Create a user and an API token similar to the [Proxmox VE description](proxmox.md). The "Audit" role is required for both the user and token (not group).
+
 Allowed fields: `["datastore_usage", "failed_tasks_24h", "cpu_usage", "memory_usage"]`.
 
 ```yaml
@@ -13,4 +15,5 @@ widget:
   url: https://proxmoxbackupserver.host:port
   username: api_token_id
   password: api_token_secret
+  datastore: datastore_name #optional; if ommitted, will display a combination of all datastores used / total
 ```

docs/widgets/services/qbittorrent.md

@@ -15,4 +15,5 @@ widget:
   url: http://qbittorrent.host.or.ip
   username: username
   password: password
+  enableLeechProgress: true # optional, defaults to false
 ```

docs/widgets/services/romm.md

@@ -3,12 +3,12 @@ title: Romm
 description: Romm Widget Configuration
 ---
 
-Allowed fields: `["platforms", "totalRoms"]`.
+Allowed fields: `["platforms", "totalRoms", "saves", "states", "screenshots", "totalfilesize"]`.
+If more than (4) fields are provided, only the first (4) will be used.
 
 ```yaml
 widget:
   type: romm
   url: http://romm.host.or.ip
-  username: username # optional
-  password: password # optional
+  fields: ["platforms", "totalRoms", "saves", "states"] # optional - default fields shown
 ```

docs/widgets/services/slskd.md

@@ -0,0 +1,25 @@
+---
+title: Slskd
+description: Slskd Widget Configuration
+---
+
+Learn more about [Slskd](https://github.com/slskd/slskd).
+
+Generate an API key for slskd with `openssl rand -base64 48`.
+Add it to your `path/to/config/slskd.yml` in `web > authentication > api_keys`:
+
+```yaml
+homepage_widget:
+  key: <generated key>
+  role: readonly
+  cidr: <homepage subnet>
+```
+
+Allowed fields: `["slskStatus", "updateStatus", "downloads", "uploads", "sharedFiles"]` (maximum of 4).
+
+```yaml
+widget:
+  type: slskd
+  url: http[s]://slskd.host.or.ip[:5030]
+  key: generatedapikey
+```