Enforce method

Co-authored-by: Crowdin Bot <support+bot@crowdin.com>

.devcontainer/Dockerfile

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

.devcontainer/devcontainer.json

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

.devcontainer/setup.sh

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

.github/DISCUSSION_TEMPLATE/support.yml

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

.github/FUNDING.yml

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

.github/ISSUE_TEMPLATE/bug_report.yml

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

.github/ISSUE_TEMPLATE/config.yml

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

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,12 +1,12 @@
 ## Proposed change
 
 <!--
-Please include a summary of the change. Screenshots and / or videos can also be helpful if appropriate.
+Please include a summary of the change. Screenshots and/or videos can also be helpful if appropriate.
 
 *** Please see the development guidelines for new widgets: https://gethomepage.dev/latest/more/development/#service-widget-guidelines
 *** If you do not follow these guidelines your PR will likely be closed without review.
 
-New service widgets should include example(s) of relevant relevant API output as well updates to the docs for the new widget.
+New service widgets should include example(s) of relevant API output as well as updates to the docs for the new widget.
 -->
 
 Closes # (issue)
@@ -25,7 +25,7 @@ What type of change does your PR introduce to Homepage?
 
 ## Checklist:
 
-- [ ] If adding a service widget or a change that requires it, I have added corresponding documentation changes.
-- [ ] If adding a new widget I have reviewed the [guidelines](https://gethomepage.dev/latest/more/development/#service-widget-guidelines).
-- [ ] If applicable, I have checked that all tests pass with e.g. `pnpm lint`.
+- [ ] If applicable, I have added corresponding documentation changes.
+- [ ] If applicable, I have reviewed the [feature](https://gethomepage.dev/latest/more/development/#new-feature-guidelines) and / or [service widget guidelines](https://gethomepage.dev/latest/more/development/#service-widget-guidelines).
+- [ ] I have checked that all code style checks pass using [pre-commit hooks](https://gethomepage.dev/latest/more/development/#code-formatting-with-pre-commit-hooks) and [linting checks](https://gethomepage.dev/latest/more/development/#code-linting).
 - [ ] If applicable, I have tested my code for new features & regressions on both mobile & desktop devices, using the latest version of major browsers.

.github/dependabot.yml

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

.github/workflows/crowdin.yml

@@ -0,0 +1,31 @@
+name: Crowdin Action
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '2 */12 * * *'
+  push:
+    paths: [
+      '/public/locales/en/**',
+    ]
+    branches: [ main ]
+
+jobs:
+  synchronize-with-crowdin:
+    name: Crowdin Sync
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: crowdin action
+      uses: crowdin/github-action@v2
+      with:
+        upload_translations: false
+        download_translations: true
+        crowdin_branch_name: main
+        localization_branch_name: l10n_main
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        CROWDIN_PROJECT_ID: ${{ secrets.CROWDIN_PROJECT_ID }}
+        CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}

.github/workflows/docker-publish.yml

@@ -9,7 +9,9 @@ on:
   schedule:
     - cron: '20 0 * * *'
   push:
-    branches: [ "main" ]
+    branches:
+      - main
+      - feature/**
     # Publish semver tags as releases.
     tags: [ 'v*.*.*' ]
     paths-ignore:
@@ -30,10 +32,28 @@ env:
 
 
 jobs:
+  pre-commit:
+    name: Linting Checks
+    runs-on: ubuntu-22.04
+    steps:
+      -
+        name: Checkout repository
+        uses: actions/checkout@v4
+      -
+        name: Install python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      -
+        name: Check files
+        uses: pre-commit/action@v3.0.1
+
   build:
     name: Docker Build & Push
     if:  github.repository == 'gethomepage/homepage'
     runs-on: self-hosted
+    needs:
+      - pre-commit
     permissions:
       contents: read
       packages: write
@@ -48,7 +68,7 @@ jobs:
       # Install the cosign tool except on PR
       # https://github.com/sigstore/cosign-installer
       - name: Install cosign
-        if: github.event_name != 'pull_request' 
+        if: github.event_name != 'pull_request'
         uses: sigstore/cosign-installer@main
         with:
           cosign-release: 'v1.13.1' # optional
@@ -57,11 +77,11 @@ jobs:
       # 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
@@ -99,7 +119,7 @@ jobs:
         uses: docker/build-push-action@v5
         with:
           context: .
-          push: ${{ github.event_name != 'pull_request' }}
+          push: ${{ github.event_name != 'pull_request' && !(github.event_name == 'push' && startsWith(github.ref, 'refs/heads/feature')) }}
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
           build-args: |

.github/workflows/docs-publish.yml

@@ -18,17 +18,35 @@ permissions:
   contents: write
 
 jobs:
+  pre-commit:
+    name: Linting Checks
+    runs-on: ubuntu-22.04
+    steps:
+      -
+        name: Checkout repository
+        uses: actions/checkout@v4
+      -
+        name: Install python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      -
+        name: Check files
+        uses: pre-commit/action@v3.0.1
+
   test:
     name: Test Build
     if: github.repository == 'gethomepage/homepage' && github.event_name == 'pull_request'
     runs-on: ubuntu-latest
+    needs:
+      - pre-commit
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: 3.x
       - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
-      - uses: actions/cache@v3
+      - uses: actions/cache@v4
         with:
           key: mkdocs-material-${{ env.cache_id }}
           path: .cache
@@ -40,25 +58,27 @@ jobs:
       - name: Test Docs Build
         run: MKINSIDERS=false mkdocs build
   deploy:
-    name: Build & Deploy 
+    name: Build & Deploy
     if: github.repository == 'gethomepage/homepage' && github.event_name != 'pull_request'
     runs-on: ubuntu-latest
+    needs:
+      - pre-commit
     steps:
       - uses: actions/checkout@v4
         with:
           ref: main
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: 3.x
-      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
-      - uses: actions/cache@v3
+      - run: echo "cache_id=${{github.sha}}" >> $GITHUB_ENV
+      - uses: actions/cache@v4
         with:
           key: mkdocs-material-${{ env.cache_id }}
           path: .cache
           restore-keys: |
             mkdocs-material-
       - run: sudo apt-get install pngquant
-      - run: pip install mike
+      - run: pip install mike==2.0.0
       - run: pip install git+https://${GH_TOKEN}@github.com/benphelps/mkdocs-material-insiders.git
       - name: Set Git config
         run: |

.github/workflows/repo-maintenance.yml

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

.pre-commit-config.yaml

@@ -0,0 +1,19 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+        exclude: "(^mkdocs\\.yml$)"
+    -   id: check-added-large-files
+-   repo: https://github.com/pre-commit/mirrors-prettier
+    rev: 'v3.0.3'
+    hooks:
+    -   id: prettier
+        types_or:
+          - javascript
+          - markdown
+          - jsx

.prettierrc

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

CODE_OF_CONDUCT.md

@@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
 Examples of behavior that contributes to a positive environment for our
 community include:
 
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
   and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
+- Focusing on what is best not just for us as individuals, but for the
   overall community
 
 Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery, and sexual attention or
+- The use of sexualized language or imagery, and sexual attention or
   advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
   address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Enforcement Responsibilities
@@ -106,7 +106,7 @@ Violating these terms may lead to a permanent ban.
 ### 4. Permanent Ban
 
 **Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
+standards, including sustained inappropriate behavior, harassment of an
 individual, or aggression toward or disparagement of classes of individuals.
 
 **Consequence**: A permanent ban from any sort of public interaction within

CONTRIBUTING.md

@@ -1,4 +1,5 @@
 # Contributing to Homepage
+
 We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
 
 - Reporting a bug
@@ -8,16 +9,20 @@ We love your input! We want to make contributing to this project as easy and tra
 - Becoming a maintainer
 
 ## We Develop with Github
+
 We use github to host code, to track issues and feature requests, as well as accept pull requests.
 
 ## Any contributions you make will be under the GNU General Public License v3.0
+
 In short, when you submit code changes, your submissions are understood to be under the same [GNU General Public License v3.0](https://choosealicense.com/licenses/gpl-3.0/) that covers the project. Feel free to contact the maintainers if that's a concern.
 
-## Report bugs using Github's [issues](https://github.com/gethomepage/homepage/issues)
-We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/gethomepage/homepage/issues/new); it's that easy!
+## Report bugs using Github [discussions](https://github.com/gethomepage/homepage/discussions)
+
+We use GitHub discussions to triage bugs. Report a bug by [opening a new discussion](https://github.com/gethomepage/homepage/discussions/new?category=support); it's that easy! Please do not open an issue unless instructed to do so by a project maintainer.
 
 ## Write bug reports with detail, background, and sample configurations
-Homepage includes a lot of configuration options and is often deploying in larger systems.  Please include as much information (configurations, deployment method, Docker & API versions, etc) as you can when reporting an issue.
+
+Homepage includes a lot of configuration options and is often deploying in larger systems. Please include as much information (configurations, deployment method, Docker & API versions, etc) as you can when reporting an issue.
 
 **Great Bug Reports** tend to have:
 
@@ -29,16 +34,38 @@ Homepage includes a lot of configuration options and is often deploying in large
 - What actually happens
 - Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
 
-People *love* thorough bug reports. I'm not even kidding.
+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.
 
 ## Use a Consistent Coding Style
-This project follows the [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript), please follow it when submitting pull requests.
+
+Please see information in the docs regarding [code formatting with pre-commit hooks](https://gethomepage.dev/latest/more/development/#code-formatting-with-pre-commit-hooks).
 
 ## License
+
 By contributing, you agree that your contributions will be licensed under its GNU General Public License.
 
+## Use of AI for pull requests
+
+In general, homepage does not accept "AI-generated" PRs. If you choose to use something like that to aid the development process to generate a significant proportion of the pull request, please make sure this is explicitly stated in the PR itself.
+
 ## References
+
 This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/main/CONTRIBUTING.md)
+
+## Automatic Respository Maintenance
+
+The homepage team appreciates all effort and interest from the community in filing bug reports, creating feature requests, sharing ideas and helping other community members. That said, in an effort to keep the repository organized and managebale the project uses automatic handling of certain areas:
+
+- Issues, pull requests and discussions that are closed will be locked after 30 days of inactivity.
+- Discussions with a marked answer will be automatically closed.
+- Discussions in the 'General' or 'Support' categories will be closed after 180 days of inactivity.
+- Feature requests that do not meet the following thresholds will be closed: 5 "up-votes" after 180 days of inactivity or 10 "up-votes" after 365 days.
+
+In all cases, threads can be re-opened by project maintainers and, of course, users can always create a new discussion for related concerns.
+Finally, remember that all information remains searchable and 'closed' feature requests can still serve as inspiration for new features.
+
+Thank you all for your contributions.

README.md

@@ -16,13 +16,22 @@
 <p align="center">
   <a href="https://github.com/gethomepage/homepage/actions/workflows/docker-publish.yml"><img alt="GitHub Workflow Status (with event)" src="https://img.shields.io/github/actions/workflow/status/gethomepage/homepage/docker-publish.yml"></a>
   &nbsp;
-  <a href="https://hosted.weblate.org/engage/homepage/"><img src="https://hosted.weblate.org/widgets/homepage/-/homepage/svg-badge.svg" alt="Weblate"></a>
+  <a href="https://crowdin.com/project/gethomepage" target="_blank"><img src="https://badges.crowdin.net/gethomepage/localized.svg"></a>
   &nbsp;
   <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>
+  &nbsp;
   <a href="https://paypal.me/phelpsben" title="Donate"><img alt="GitHub Sponsors" src="https://img.shields.io/github/sponsors/benphelps"></a>
 </p>
 
+<p align="center">
+  <a href="https://www.digitalocean.com/?refcode=df14bcb7c016&utm_campaign=Referral_Invite&utm_medium=Referral_Program&utm_source=badge"><img src="https://web-platforms.sfo2.cdn.digitaloceanspaces.com/WWW/Badge%201.svg" alt="DigitalOcean Referral Badge" /></a>
+</p>
+<p align="center">
+<em>Homepage builds are kindly powered by DigitalOcean.</em>
+</p>
+
 # Features
 
 With features like quick search, bookmarks, weather support, a wide range of integrations and widgets, an elegant and modern design, and a focus on performance, Homepage is your ideal start to the day and a handy companion throughout it.
@@ -39,15 +48,15 @@ With features like quick search, bookmarks, weather support, a wide range of int
 
 ## Docker Integration
 
-Homepage has built-in support for Docker, and can automatically discover and add services to the homepage based on labels. See the [Docker](https://gethomepage.dev/latest/installation/docker/) page for more information.
+Homepage has built-in support for Docker, and can automatically discover and add services to the homepage based on labels. See the [Docker Service Discovery](https://gethomepage.dev/latest/configs/docker/#automatic-service-discovery) page for more information.
 
 ## Service Widgets
 
-Homepage also has support for over 100 3rd party services, including all popular starr apps, and most popular self-hosted apps. Some examples include: Radarr, Sonarr, Lidarr, Bazarr, Ombi, Tautulli, Plex, Jellyfin, Emby, Transmission, qBittorrent, Deluge, Jackett, NZBGet, SABnzbd, etc. As well as service integrations, Homepage also has a number of information providers, sourcing information from a variety of external 3rd party APIs. See the [Service](https://gethomepage.dev/latest/configs/service-widgets/) page for more information.
+Homepage also has support for over 100 3rd party services, including all popular starr apps, and most popular self-hosted apps. Some examples include: Radarr, Sonarr, Lidarr, Bazarr, Ombi, Tautulli, Plex, Jellyfin, Emby, Transmission, qBittorrent, Deluge, Jackett, NZBGet, SABnzbd, etc. As well as service integrations, Homepage also has a number of information providers, sourcing information from a variety of external 3rd party APIs. See the [Service](https://gethomepage.dev/latest/widgets/) page for more information.
 
 ## Information Widgets
 
-Homepage has built-in support for a number of information providers, including weather, time, date, search, glances and more. System and status information presented at the top of the page. See the [Information Providers](https://gethomepage.dev/latest/configs/widgets/) page for more information.
+Homepage has built-in support for a number of information providers, including weather, time, date, search, glances and more. System and status information presented at the top of the page. See the [Information Providers](https://gethomepage.dev/latest/widgets/) page for more information.
 
 ## Customization
 
@@ -122,7 +131,7 @@ pnpm dev
 
 # Configuration
 
-Please refere 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](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.
 
 # Development
 
@@ -144,6 +153,8 @@ This is a [Next.js](https://nextjs.org/) application, see their documentation fo
 
 # Documentation
 
+The homepage documentation is available at [https://gethomepage.dev/](https://gethomepage.dev/).
+
 Homepage uses Material for MkDocs for documentation. To run the documentation locally, first install the dependencies:
 
 ```bash
@@ -160,9 +171,7 @@ mkdocs serve # or build, to build the static site
 
 If you have any questions, suggestions, or general issues, please start a discussion on the [Discussions](https://github.com/gethomepage/homepage/discussions) page.
 
-For bug reports, please open an issue on the [Issues](https://github.com/gethomepage/homepage/issues) page.
-
-## Contributing & Contributers
+## Contributing & Contributors
 
 Contributions are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information.
 

crowdin.yml

@@ -1,3 +1,6 @@
+project_id_env: CROWDIN_PROJECT_ID
+api_token_env: CROWDIN_PERSONAL_TOKEN
+preserve_hierarchy: true
 files:
   - source: /public/locales/en/*.json
     translation: /public/locales/%osx_locale%/%original_file_name%

docs/configs/bookmarks.md

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

docs/configs/docker.md

@@ -9,8 +9,8 @@ For IP:PORT, simply make sure your Docker instance [has been configured](https:/
 
 ```yaml
 my-remote-docker:
-    host: 192.168.0.101
-    port: 2375
+  host: 192.168.0.101
+  port: 2375
 ```
 
 ## Using Docker TLS
@@ -19,12 +19,12 @@ Since Docker supports connecting with TLS and client certificate authentication,
 
 ```yaml
 my-remote-docker:
-    host: 192.168.0.101
-    port: 275
-    tls:
-        keyFile: tls/key.pem
-        caFile: tls/ca.pem
-        certFile: tls/cert.pem
+  host: 192.168.0.101
+  port: 275
+  tls:
+    keyFile: tls/key.pem
+    caFile: tls/ca.pem
+    certFile: tls/cert.pem
 ```
 
 ## Using Docker Socket Proxy
@@ -35,35 +35,35 @@ Here is an example docker-compose file that will expose the docker socket, and t
 
 ```yaml
 dockerproxy:
-    image: ghcr.io/tecnativa/docker-socket-proxy:latest
-    container_name: dockerproxy
-    environment:
-        - CONTAINERS=1 # Allow access to viewing containers
-        - SERVICES=1 # Allow access to viewing services (necessary when using Docker Swarm)
-        - TASKS=1 # Allow access to viewing tasks (necessary when using Docker Swarm)
-        - POST=0 # Disallow any POST operations (effectively read-only)
-    ports:
-        - 127.0.0.1:2375:2375
-    volumes:
-        - /var/run/docker.sock:/var/run/docker.sock:ro # Mounted as read-only
-    restart: unless-stopped
+  image: ghcr.io/tecnativa/docker-socket-proxy:latest
+  container_name: dockerproxy
+  environment:
+    - CONTAINERS=1 # Allow access to viewing containers
+    - SERVICES=1 # Allow access to viewing services (necessary when using Docker Swarm)
+    - TASKS=1 # Allow access to viewing tasks (necessary when using Docker Swarm)
+    - POST=0 # Disallow any POST operations (effectively read-only)
+  ports:
+    - 127.0.0.1:2375:2375
+  volumes:
+    - /var/run/docker.sock:/var/run/docker.sock:ro # Mounted as read-only
+  restart: unless-stopped
 
 homepage:
-    image: ghcr.io/gethomepage/homepage:latest
-    container_name: homepage
-    volumes:
-        - /path/to/config:/app/config
-    ports:
-        - 3000:3000
-    restart: unless-stopped
+  image: ghcr.io/gethomepage/homepage:latest
+  container_name: homepage
+  volumes:
+    - /path/to/config:/app/config
+  ports:
+    - 3000:3000
+  restart: unless-stopped
 ```
 
 Then, inside of your `docker.yaml` settings file, you'd configure the docker instance like so:
 
 ```yaml
 my-docker:
-    host: dockerproxy
-    port: 2375
+  host: dockerproxy
+  port: 2375
 ```
 
 ## Using Socket Directly
@@ -76,14 +76,14 @@ If you'd rather use the socket directly, first make sure that you're passing the
 
 ```yaml
 homepage:
-    image: ghcr.io/gethomepage/homepage:latest
-    container_name: homepage
-    volumes:
-        - /path/to/config:/app/config
-        - /var/run/docker.sock:/var/run/docker.sock # pass local proxy
-    ports:
-        - 3000:3000
-    restart: unless-stopped
+  image: ghcr.io/gethomepage/homepage:latest
+  container_name: homepage
+  volumes:
+    - /path/to/config:/app/config
+    - /var/run/docker.sock:/var/run/docker.sock # pass local proxy
+  ports:
+    - 3000:3000
+  restart: unless-stopped
 ```
 
 If you're using `docker run`, this would be `-v /var/run/docker.sock:/var/run/docker.sock`.
@@ -92,7 +92,7 @@ Then, inside of your `docker.yaml` settings file, you'd configure the docker ins
 
 ```yaml
 my-docker:
-    socket: /var/run/docker.sock
+  socket: /var/run/docker.sock
 ```
 
 ## Services
@@ -118,18 +118,18 @@ Below is an example of the same service entry shown above, as docker labels.
 
 ```yaml
 services:
-    emby:
-        image: lscr.io/linuxserver/emby:latest
-        container_name: emby
-        ports:
-            - 8096:8096
-        restart: unless-stopped
-        labels:
-            - homepage.group=Media
-            - homepage.name=Emby
-            - homepage.icon=emby.png
-            - homepage.href=http://emby.home/
-            - homepage.description=Media server
+  emby:
+    image: lscr.io/linuxserver/emby:latest
+    container_name: emby
+    ports:
+      - 8096:8096
+    restart: unless-stopped
+    labels:
+      - homepage.group=Media
+      - homepage.name=Emby
+      - homepage.icon=emby.png
+      - homepage.href=http://emby.home/
+      - homepage.description=Media server
 ```
 
 When your Docker instance has been properly configured, this service will be automatically discovered and added to your Homepage. **You do not need to specify the `server` or `container` values, as they will be automatically inferred.**
@@ -142,15 +142,32 @@ You may also configure widgets, along with the standard service entry, again, us
 
 ```yaml
 labels:
-    - homepage.group=Media
-    - homepage.name=Emby
-    - homepage.icon=emby.png
-    - homepage.href=http://emby.home/
-    - homepage.description=Media server
-    - homepage.widget.type=emby
-    - homepage.widget.url=http://emby.home
-    - homepage.widget.key=yourembyapikeyhere
-    - homepage.widget.fields=["field1","field2"] # optional
+  - homepage.group=Media
+  - homepage.name=Emby
+  - homepage.icon=emby.png
+  - homepage.href=http://emby.home/
+  - homepage.description=Media server
+  - homepage.widget.type=emby
+  - homepage.widget.url=http://emby.home
+  - homepage.widget.key=yourembyapikeyhere
+  - homepage.widget.fields=["field1","field2"] # optional
+```
+
+You can add specify fields for e.g. the [CustomAPI](../widgets/services/customapi.md) widget by using array-style dot notation:
+
+```yaml
+labels:
+  - homepage.group=Media
+  - homepage.name=Emby
+  - homepage.icon=emby.png
+  - homepage.href=http://emby.home/
+  - homepage.description=Media server
+  - homepage.widget.type=customapi
+  - homepage.widget.url=http://argus.service/api/v1/service/summary/emby
+  - homepage.widget.mappings[0].label=Deployed Version
+  - homepage.widget.mappings[0].field.status=deployed_version
+  - homepage.widget.mappings[1].label=Latest Version
+  - homepage.widget.mappings[1].field.status=latest_version
 ```
 
 ## Docker Swarm
@@ -159,8 +176,8 @@ Docker swarm is supported and Docker services are specified with the same `serve
 
 ```yaml
 my-docker:
-    socket: /var/run/docker.sock
-    swarm: true
+  socket: /var/run/docker.sock
+  swarm: true
 ```
 
 For the automatic service discovery to discover all services it is important that homepage should be deployed on a manager node. Set deploy requirements to the master node in your stack yaml config, e.g.
@@ -184,13 +201,29 @@ In order to detect every service within the Docker swarm it is necessary that se
 ...
 ```
 
+## Multiple Homepage Instances
+
+The optional field `instanceName` can be configured in [settings.md](settings.md#instance-name) to differentiate between multiple homepage instances.
+
+To limit a label to an instance, insert `.instance.{{instanceName}}` after the `homepage` prefix.
+
+```yaml
+labels:
+  - homepage.group=Media
+  - homepage.name=Emby
+  - homepage.icon=emby.png
+  - homepage.instance.internal.href=http://emby.lan/
+  - homepage.instance.public.href=https://emby.mydomain.com/
+  - homepage.description=Media server
+```
+
 ## Ordering
 
 As of v0.6.4 discovered services can include an optional `weight` field to determine sorting such that:
 
--   Default weight for discovered services is 0
--   Default weight for configured services is their index within their group scaled by 100, i.e. (index + 1) \* 100
--   If two items have the same weight value, then they will be sorted by name
+- Default weight for discovered services is 0
+- Default weight for configured services is their index within their group scaled by 100, i.e. (index + 1) \* 100
+- If two items have the same weight value, then they will be sorted by name
 
 ## Show stats
 
@@ -202,4 +235,4 @@ You can show the docker stats by clicking the status indicator but this can also
   showStats: true
 ```
 
-Also see the settings for [show docker stats](docker.md#show-docker-stats).
+Also see the settings for [show docker stats](settings.md#show-docker-stats).

docs/configs/kubernetes.md

@@ -5,15 +5,15 @@ description: Kubernetes Configuration
 
 The Kubernetes connectivity has the following requirements:
 
--   Kubernetes 1.19+
--   Metrics Service
--   An Ingress controller
+- Kubernetes 1.19+
+- Metrics Service
+- An Ingress controller
 
 The Kubernetes connection is configured in the `kubernetes.yaml` file. There are 3 modes to choose from:
 
--   **disabled** - disables kubernetes connectivity
--   **default** - uses the default kubeconfig [resolution](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/)
--   **cluster** - uses a service account inside the cluster
+- **disabled** - disables kubernetes connectivity
+- **default** - uses the default kubeconfig [resolution](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/)
+- **cluster** - uses a service account inside the cluster
 
 ```yaml
 mode: default
@@ -36,29 +36,29 @@ 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 `podSelector` 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 `pod-selector` 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:
 
 ```yaml
 - Element Chat:
-      icon: matrix-light.png
-      href: https://chat.example.com
-      description: Matrix Synapse Powered Chat
-      app: matrix-element
-      namespace: comms
-      podSelector: >-
-          app.kubernetes.io/instance in (
-              matrix-element,
-              matrix-media-repo,
-              matrix-media-repo-postgresql,
-              matrix-synapse
-          )
+    icon: matrix-light.png
+    href: https://chat.example.com
+    description: Matrix Synapse Powered Chat
+    app: matrix-element
+    namespace: comms
+    pod-selector: >-
+      app.kubernetes.io/instance in (
+          matrix-element,
+          matrix-media-repo,
+          matrix-media-repo-postgresql,
+          matrix-synapse
+      )
 ```
 
 !!! note
 
-    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.
+    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.
 
 ## Automatic Service Discovery
 
@@ -68,33 +68,36 @@ Homepage features automatic service discovery by Ingress annotations. All config
 apiVersion: networking.k8s.io/v1
 kind: Ingress
 metadata:
-    name: emby
-    annotations:
-        gethomepage.dev/enabled: "true"
-        gethomepage.dev/description: Media Server
-        gethomepage.dev/group: Media
-        gethomepage.dev/icon: emby.png
-        gethomepage.dev/name: Emby
-        gethomepage.dev/widget.type: "emby"
-        gethomepage.dev/widget.url: "https://emby.example.com"
-        gethomepage.dev/podSelector: ""
-        gethomepage.dev/weight: 10 # optional
+  name: emby
+  annotations:
+    gethomepage.dev/enabled: "true"
+    gethomepage.dev/description: Media Server
+    gethomepage.dev/group: Media
+    gethomepage.dev/icon: emby.png
+    gethomepage.dev/name: Emby
+    gethomepage.dev/widget.type: "emby"
+    gethomepage.dev/widget.url: "https://emby.example.com"
+    gethomepage.dev/pod-selector: ""
+    gethomepage.dev/weight: 10 # optional
+    gethomepage.dev/instance: "public" # optional
 spec:
-    rules:
-        - host: emby.example.com
-          http:
-              paths:
-                  - backend:
-                        service:
-                            name: emby
-                            port:
-                                number: 8080
-                    path: /
-                    pathType: Prefix
+  rules:
+    - host: emby.example.com
+      http:
+        paths:
+          - backend:
+              service:
+                name: emby
+                port:
+                  number: 8080
+            path: /
+            pathType: Prefix
 ```
 
 When the Kubernetes cluster connection has been properly configured, this service will be automatically discovered and added to your Homepage. **You do not need to specify the `namespace` or `app` values, as they will be automatically inferred.**
 
+If you are using multiple instances of homepage, an `instance` annotation can be specified to limit services to a specific instance. If no instance is provided, the service will be visible on all instances.
+
 ### Traefik IngressRoute support
 
 Homepage can also read ingresses defined using the Traefik IngressRoute custom resource definition. Due to the complex nature of Traefik routing rules, it is required for the `gethomepage.dev/href` annotation to be set:
@@ -103,32 +106,34 @@ Homepage can also read ingresses defined using the Traefik IngressRoute custom r
 apiVersion: traefik.io/v1alpha1
 kind: IngressRoute
 metadata:
-    name: emby
-    annotations:
-        gethomepage.dev/href: "https://emby.example.com"
-        gethomepage.dev/enabled: "true"
-        gethomepage.dev/description: Media Server
-        gethomepage.dev/group: Media
-        gethomepage.dev/icon: emby.png
-        gethomepage.dev/name: Emby
-        gethomepage.dev/widget.type: "emby"
-        gethomepage.dev/widget.url: "https://emby.example.com"
-        gethomepage.dev/podSelector: ""
-        gethomepage.dev/weight: 10 # optional
+  name: emby
+  annotations:
+    gethomepage.dev/href: "https://emby.example.com"
+    gethomepage.dev/enabled: "true"
+    gethomepage.dev/description: Media Server
+    gethomepage.dev/group: Media
+    gethomepage.dev/icon: emby.png
+    gethomepage.dev/app: emby-app # optional, may be needed if app.kubernetes.io/name != ingress metadata.name
+    gethomepage.dev/name: Emby
+    gethomepage.dev/widget.type: "emby"
+    gethomepage.dev/widget.url: "https://emby.example.com"
+    gethomepage.dev/pod-selector: ""
+    gethomepage.dev/weight: 10 # optional
+    gethomepage.dev/instance: "public" # optional
 spec:
-    entryPoints:
-        - websecure
-    routes:
-        - kind: Rule
-          match: Host(`emby.example.com`)
-          services:
-              - kind: Service
-                name: emby
-                namespace: emby
-                port: 8080
-                scheme: http
-                strategy: RoundRobin
-                weight: 10
+  entryPoints:
+    - websecure
+  routes:
+    - kind: Rule
+      match: Host(`emby.example.com`)
+      services:
+        - kind: Service
+          name: emby
+          namespace: emby
+          port: 8080
+          scheme: http
+          strategy: RoundRobin
+          weight: 10
 ```
 
 If the `href` attribute is not present, Homepage will ignore the specific IngressRoute.

docs/configs/service-widgets.md

@@ -5,7 +5,7 @@ description: Service Widget Configuration
 
 Unless otherwise noted, URLs should not end with a `/` or other API path. Each widget will handle the path on its own.
 
-Each service can have one widget attached to it (often matching the service type, but thats not forced).
+Each service can have one widget attached to it (often matching the service type, but that's not forced).
 
 In addition to the href of the service, you can also specify the target location in which to open that link. See [Link Target](settings.md#link-target) for more details.
 
@@ -13,13 +13,13 @@ 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
+    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
@@ -30,11 +30,11 @@ Each widget can optionally provide a list of which fields should be visible via
 
 ```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
+    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

@@ -101,30 +101,50 @@ To use a local icon, first create a Docker mount to `/app/public/icons` and then
 
 ## Ping
 
-Services may have an optional `ping` property that allows you to monitor the availability of an endpoint you chose and have the response time displayed. You do not need to set your ping URL equal to your href URL.
-
-!!! note
-
-    The ping feature works by making an http `HEAD` request to the URL, and falls back to `GET` in case that fails. It will not, for example, login if the URL requires auth or is behind e.g. Authelia. In the case of a reverse proxy and/or auth this usually requires the use of an 'internal' URL to make the ping feature correctly display status.
+Services may have an optional `ping` property that allows you to monitor the availability of an external host. As of v0.8.0, the ping feature attempts to use a true (ICMP) ping command on the underlying host. Currently, only IPv4 is supported.
 
 ```yaml
 - Group A:
     - Sonarr:
         icon: sonarr.png
         href: http://sonarr.host/
-        ping: http://sonarr.host/
+        ping: sonarr.host
 
 - Group B:
     - Radarr:
         icon: radarr.png
         href: http://radarr.host/
-        ping: http://some.other.host/
+        ping: some.other.host
 ```
 
 <img width="1038" alt="Ping" src="https://github.com/gethomepage/homepage/assets/88257202/7bc13bd3-0d0b-44e3-888c-a20e069a3233">
 
 You can also apply different styles to the ping indicator by using the `statusStyle` property, see [settings](settings.md#status-style).
 
+## Site Monitor
+
+Services may have an optional `siteMonitor` property (formerly `ping`) that allows you to monitor the availability of a URL you chose and have the response time displayed. You do not need to set your monitor URL equal to your href or ping URL.
+
+!!! note
+
+    The site monitor feature works by making an http `HEAD` request to the URL, and falls back to `GET` in case that fails. It will not, for example, login if the URL requires auth or is behind e.g. Authelia. In the case of a reverse proxy and/or auth this usually requires the use of an 'internal' URL to make the site monitor feature correctly display status.
+
+```yaml
+- Group A:
+    - Sonarr:
+        icon: sonarr.png
+        href: http://sonarr.host/
+        siteMonitor: http://sonarr.host/
+
+- Group B:
+    - Radarr:
+        icon: radarr.png
+        href: http://radarr.host/
+        siteMonitor: http://some.other.host/
+```
+
+You can also apply different styles to the site monitor indicator by using the `statusStyle` property, see [settings](settings.md#status-style).
+
 ## Docker Integration
 
 Services may be connected to a Docker container, either running on the local machine, or a remote machine.
@@ -159,7 +179,7 @@ Services may be connected to a Docker container, either running on the local mac
 
 Services may also have a service widget (or integration) attached to them, this works independently of the Docker integration.
 
-You can find information and configuration for each of the supported integrations on the [Service Widgets](service-widgets.md) page.
+You can find information and configuration for each of the supported integrations on the [Widgets](../widgets/index.md) page.
 
 Here is an example of a Radarr & Sonarr service, with their respective integrations.
 

docs/configs/settings.md

@@ -67,7 +67,7 @@ background:
 
 ### Card Background Blur
 
-You can apply a blur filter to the service & bookmark cards. Note this option is incompatible with the backround blur, saturate and brightness filters.
+You can apply a blur filter to the service & bookmark cards. Note this option is incompatible with the background blur, saturate and brightness filters.
 
 ```yaml
 cardBlur: sm # sm, "", md, etc... see https://tailwindcss.com/docs/backdrop-blur
@@ -85,7 +85,7 @@ Or you may pass the path to a local image relative to the `/app/public` director
 
 ## Theme
 
-You can configure a fixed them (and disable the theme switcher) by passing the `theme` option, like so:
+You can configure a fixed theme (and disable the theme switcher) by passing the `theme` option, like so:
 
 ```yaml
 theme: dark # or light
@@ -211,13 +211,13 @@ layout:
 
 ### Five Columns
 
-You can add a fifth column (when `style: columns` which is default) by adding:
+You can add a fifth column to services (when `style: columns` which is default) by adding:
 
 ```yaml
 fiveColumns: true
 ```
 
-By default homepage will max out at 4 columns for column style
+By default homepage will max out at 4 columns for services with `columns` style
 
 ### Collapsible sections
 
@@ -229,6 +229,48 @@ disableCollapse: true
 
 By default the feature is enabled.
 
+### Initially collapsed sections
+
+You can initially collapse sections by adding the `initiallyCollapsed` option to the layout group.
+
+```yaml
+layout:
+  Section A:
+    initiallyCollapsed: true
+```
+
+This can also be set globaly using the `groupsInitiallyCollapsed` option.
+
+```yaml
+groupsInitiallyCollapsed: true
+```
+
+The value set on a group will overwrite the global setting.
+
+By default the feature is disabled.
+
+### Use Equal Height Cards
+
+You can enable equal height cards for groups of services, this will make all cards in a row the same height.
+
+Global setting in `settings.yaml`:
+
+```yaml
+useEqualHeights: true
+```
+
+Per layout group in `settings.yaml`:
+
+```yaml
+useEqualHeights: false
+layout:
+  ...
+  Group Name:
+    useEqualHeights: true # overrides global setting
+```
+
+By default the feature is disabled
+
 ## Header Style
 
 There are currently 4 options for header styles, you can see each one below.
@@ -321,7 +363,7 @@ providers:
 You can then pass `provider` instead of `apiKey` in your widget configuration.
 
 ```yaml
-- weather:
+- weatherapi:
     latitude: 50.449684
     longitude: 30.525026
     provider: weatherapi
@@ -329,21 +371,35 @@ You can then pass `provider` instead of `apiKey` in your widget configuration.
 
 ## Quick Launch
 
-You can use the 'Quick Launch' feature to search services, perform a web search or open a URL. To use Quick Launch, just start typing while on your homepage (as long as the search widget doesnt have focus).
+You can use the 'Quick Launch' feature to search services, perform a web search or open a URL. To use Quick Launch, just start typing while on your homepage (as long as the search widget doesn't have focus).
 
 <img width="1000" alt="quicklaunch" src="https://user-images.githubusercontent.com/4887959/216880811-90ff72cb-2990-4475-889b-7c3a31e6beef.png">
 
 There are a few optional settings for the Quick Launch feature:
 
-- `searchDescriptions`: which lets you control whether item descriptions are included in searches. This is off by default. When enabled, results that match the item name will be placed above those that only match the description.
+- `searchDescriptions`: which lets you control whether item descriptions are included in searches. This is false by default. When enabled, results that match the item name will be placed above those that only match the description.
 - `hideInternetSearch`: disable automatically including the currently-selected web search (e.g. from the widget) as a Quick Launch option. This is false by default, enabling the feature.
+- `showSearchSuggestions`: show search suggestions for the internet search. If this is not specified then the setting will be inherited from the search widget. If it is not specified there either, it will default to false. For custom providers the `suggestionUrl` needs to be set in order for this to work.
+- `provider`: search engine provider. If none is specified it will try to use the provider set for the Search Widget, if neither are present then internet search will be disabled.
 - `hideVisitURL`: disable detecting and offering an option to open URLs. This is false by default, enabling the feature.
 
 ```yaml
 quicklaunch:
   searchDescriptions: true
   hideInternetSearch: true
+  showSearchSuggestions: true
   hideVisitURL: true
+  provider: google # google, duckduckgo, bing, baidu, brave or custom
+```
+
+or for a custom search:
+
+```yaml
+quicklaunch:
+  provider: custom
+  url: https://www.ecosia.org/search?q=
+  target: _blank
+  suggestionUrl: https://ac.ecosia.org/autocomplete?type=list&q=
 ```
 
 ## Homepage Version
@@ -362,6 +418,8 @@ By default the homepage logfile is written to the a `logs` subdirectory of the `
 logpath: /logfile/path
 ```
 
+By default, logs are sent both to `stdout` and to a file at the path specified. This can be changed by setting the `LOG_TARGETS` environment variable to one of `both` (default), `stdout` or `file`.
+
 ## Show Docker Stats
 
 You can show all docker stats expanded in `settings.yaml`:
@@ -382,16 +440,16 @@ If you have both set the per-service settings take precedence.
 
 ## Status Style
 
-You can choose from the following styles for docker or k8s status and ping: `dot` or `basic`
+You can choose from the following styles for docker or k8s status, site monitor and ping: `dot` or `basic`
 
-- The default is no value, and displays the ping response time in ms and the docker / k8s container status
-- `dot` shows a green dot for a successful ping or healthy status.
-- `basic` shows either UP or DOWN for ping
+- The default is no value, and displays the monitor and ping response time in ms and the docker / k8s container status
+- `dot` shows a green dot for a successful monitor ping or healthy status.
+- `basic` shows either UP or DOWN for monitor & ping
 
 For example:
 
 ```yaml
-statusStyle: 'dot'
+statusStyle: "dot"
 ```
 
 or per-service (`services.yaml`) with:
@@ -404,6 +462,16 @@ or per-service (`services.yaml`) with:
 
 If you have both set, the per-service settings take precedence.
 
+## Instance Name
+
+Name used by automatic docker service discovery to differentiate between multiple homepage instances.
+
+For example:
+
+```yaml
+instanceName: public
+```
+
 ## Hide Widget Error Messages
 
 Hide the visible API error messages either globally in `settings.yaml`:
@@ -422,4 +490,4 @@ or per service widget (`services.yaml`) with:
         hideErrors: true
 ```
 
-If either value is set to true, the errror message will be hidden.
+If either value is set to true, the error message will be hidden.

docs/index.md

@@ -17,3 +17,10 @@ hide:
 A modern, <em>fully static, fast</em>, secure <em>fully proxied</em>, highly customizable application dashboard with integrations for over 100 services and translations into multiple languages. Easily configured via YAML files or through docker label discovery.
 
 ![Alt text](assets/homepage_demo.png)
+
+<p align="center">
+  <a href="https://www.digitalocean.com/?refcode=df14bcb7c016&utm_campaign=Referral_Invite&utm_medium=Referral_Program&utm_source=badge"><img src="https://web-platforms.sfo2.cdn.digitaloceanspaces.com/WWW/Badge%203.svg" alt="DigitalOcean Referral Badge" /></a>
+</p>
+<p align="center">
+<em>Homepage builds are kindly powered by DigitalOcean.</em>
+</p>

docs/installation/docker.md

@@ -8,14 +8,14 @@ Using docker compose:
 ```yaml
 version: "3.3"
 services:
-    homepage:
-        image: ghcr.io/gethomepage/homepage:latest
-        container_name: homepage
-        ports:
-            - 3000:3000
-        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
+  homepage:
+    image: ghcr.io/gethomepage/homepage:latest
+    container_name: homepage
+    ports:
+      - 3000:3000
+    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
 ```
 
 ### Running as non-root
@@ -29,17 +29,17 @@ In the docker compose example below, the environment variables `$PUID` and `$PGI
 ```yaml
 version: "3.3"
 services:
-    homepage:
-        image: ghcr.io/gethomepage/homepage:latest
-        container_name: homepage
-        ports:
-            - 3000:3000
-        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, see alternative methods
-        environment:
-            PUID: $PUID
-            PGID: $PGID
+  homepage:
+    image: ghcr.io/gethomepage/homepage:latest
+    container_name: homepage
+    ports:
+      - 3000:3000
+    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, see alternative methods
+    environment:
+      PUID: $PUID
+      PGID: $PGID
 ```
 
 ### With Docker Run
@@ -52,6 +52,6 @@ docker run -p 3000:3000 -v /path/to/config:/app/config -v /var/run/docker.sock:/
 
 You can also include environment variables in your config files to protect sensitive information. Note:
 
--   Environment variables must start with `HOMEPAGE_VAR_` or `HOMEPAGE_FILE_`
--   The value of env var `HOMEPAGE_VAR_XXX` will replace `{{HOMEPAGE_VAR_XXX}}` in any config
--   The value of env var `HOMEPAGE_FILE_XXX` must be a file path, the contents of which will be used to replace `{{HOMEPAGE_FILE_XXX}}` in any config
+- Environment variables must start with `HOMEPAGE_VAR_` or `HOMEPAGE_FILE_`
+- The value of env var `HOMEPAGE_VAR_XXX` will replace `{{HOMEPAGE_VAR_XXX}}` in any config
+- The value of env var `HOMEPAGE_FILE_XXX` must be a file path, the contents of which will be used to replace `{{HOMEPAGE_FILE_XXX}}` in any config

docs/installation/k8s.md

@@ -16,70 +16,70 @@ The helm chart allows for all the configurations to be inlined directly in your
 
 ```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
+  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 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:
+    - 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
+  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
+  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
@@ -94,12 +94,12 @@ Here's a working example of the resources you need:
 apiVersion: v1
 kind: ServiceAccount
 metadata:
-    name: homepage
-    namespace: default
-    labels:
-        app.kubernetes.io/name: homepage
+  name: homepage
+  namespace: default
+  labels:
+    app.kubernetes.io/name: homepage
 secrets:
-    - name: homepage
+  - name: homepage
 ```
 
 #### Secret
@@ -109,12 +109,12 @@ apiVersion: v1
 kind: Secret
 type: kubernetes.io/service-account-token
 metadata:
-    name: homepage
-    namespace: default
-    labels:
-        app.kubernetes.io/name: homepage
-    annotations:
-        kubernetes.io/service-account.name: homepage
+  name: homepage
+  namespace: default
+  labels:
+    app.kubernetes.io/name: homepage
+  annotations:
+    kubernetes.io/service-account.name: homepage
 ```
 
 #### ConfigMap
@@ -123,62 +123,62 @@ metadata:
 apiVersion: v1
 kind: ConfigMap
 metadata:
-    name: homepage
-    namespace: default
-    labels:
-        app.kubernetes.io/name: homepage
+  name: homepage
+  namespace: default
+  labels:
+    app.kubernetes.io/name: homepage
 data:
-    kubernetes.yaml: |
-        mode: cluster
-    settings.yaml: ""
-    #settings.yaml: |
-    #  providers:
-    #    longhorn:
-    #      url: https://longhorn.my.network
-    custom.css: ""
-    custom.js: ""
-    bookmarks.yaml: |
-        - Developer:
-            - Github:
-                - abbr: GH
-                  href: https://github.com/
-    services.yaml: |
-        - My First Group:
-            - My First Service:
-                href: http://localhost/
-                description: Homepage is awesome
+  kubernetes.yaml: |
+    mode: cluster
+  settings.yaml: ""
+  #settings.yaml: |
+  #  providers:
+  #    longhorn:
+  #      url: https://longhorn.my.network
+  custom.css: ""
+  custom.js: ""
+  bookmarks.yaml: |
+    - Developer:
+        - Github:
+            - abbr: GH
+              href: https://github.com/
+  services.yaml: |
+    - 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 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.yaml: |
-        - kubernetes:
-            cluster:
-              show: true
-              cpu: true
-              memory: true
-              showLabel: true
-              label: "cluster"
-            nodes:
-              show: true
-              cpu: true
-              memory: true
-              showLabel: true
-        - resources:
-            backend: resources
-            expanded: true
-            cpu: true
-            memory: true
-        - search:
-            provider: duckduckgo
-            target: _blank
-    docker.yaml: ""
+    - My Third Group:
+        - My Third Service:
+            href: http://localhost/
+            description: Homepage is 😎
+  widgets.yaml: |
+    - kubernetes:
+        cluster:
+          show: true
+          cpu: true
+          memory: true
+          showLabel: true
+          label: "cluster"
+        nodes:
+          show: true
+          cpu: true
+          memory: true
+          showLabel: true
+    - resources:
+        backend: resources
+        expanded: true
+        cpu: true
+        memory: true
+    - search:
+        provider: duckduckgo
+        target: _blank
+  docker.yaml: ""
 ```
 
 #### ClusterRole and ClusterRoleBinding
@@ -187,57 +187,57 @@ data:
 apiVersion: rbac.authorization.k8s.io/v1
 kind: ClusterRole
 metadata:
-    name: homepage
-    labels:
-        app.kubernetes.io/name: homepage
+  name: homepage
+  labels:
+    app.kubernetes.io/name: homepage
 rules:
-    - apiGroups:
-          - ""
-      resources:
-          - namespaces
-          - pods
-          - nodes
-      verbs:
-          - get
-          - list
-    - apiGroups:
-          - extensions
-          - networking.k8s.io
-      resources:
-          - ingresses
-      verbs:
-          - get
-          - list
-    - apiGroups:
-          - traefik.containo.us
-      resources:
-          - ingressroutes
-      verbs:
-          - get
-          - list
-    - apiGroups:
-          - metrics.k8s.io
-      resources:
-          - nodes
-          - pods
-      verbs:
-          - get
-          - list
+  - apiGroups:
+      - ""
+    resources:
+      - namespaces
+      - pods
+      - nodes
+    verbs:
+      - get
+      - list
+  - apiGroups:
+      - extensions
+      - networking.k8s.io
+    resources:
+      - ingresses
+    verbs:
+      - get
+      - list
+  - apiGroups:
+      - traefik.containo.us
+    resources:
+      - ingressroutes
+    verbs:
+      - get
+      - list
+  - apiGroups:
+      - metrics.k8s.io
+    resources:
+      - nodes
+      - pods
+    verbs:
+      - get
+      - list
 ---
 apiVersion: rbac.authorization.k8s.io/v1
 kind: ClusterRoleBinding
 metadata:
-    name: homepage
-    labels:
-        app.kubernetes.io/name: homepage
+  name: homepage
+  labels:
+    app.kubernetes.io/name: homepage
 roleRef:
-    apiGroup: rbac.authorization.k8s.io
-    kind: ClusterRole
-    name: homepage
+  apiGroup: rbac.authorization.k8s.io
+  kind: ClusterRole
+  name: homepage
 subjects:
-    - kind: ServiceAccount
-      name: homepage
-      namespace: default
+  - kind: ServiceAccount
+    name: homepage
+    namespace: default
 ```
 
 #### Service
@@ -246,20 +246,20 @@ subjects:
 apiVersion: v1
 kind: Service
 metadata:
-    name: homepage
-    namespace: default
-    labels:
-        app.kubernetes.io/name: homepage
-    annotations:
+  name: homepage
+  namespace: default
+  labels:
+    app.kubernetes.io/name: homepage
+  annotations:
 spec:
-    type: ClusterIP
-    ports:
-        - port: 3000
-          targetPort: http
-          protocol: TCP
-          name: http
-    selector:
-        app.kubernetes.io/name: homepage
+  type: ClusterIP
+  ports:
+    - port: 3000
+      targetPort: http
+      protocol: TCP
+      name: http
+  selector:
+    app.kubernetes.io/name: homepage
 ```
 
 #### Deployment
@@ -268,46 +268,68 @@ spec:
 apiVersion: apps/v1
 kind: Deployment
 metadata:
-    name: homepage
-    namespace: default
-    labels:
-        app.kubernetes.io/name: homepage
+  name: homepage
+  namespace: default
+  labels:
+    app.kubernetes.io/name: homepage
 spec:
-    revisionHistoryLimit: 3
-    replicas: 1
-    strategy:
-        type: RollingUpdate
-    selector:
-        matchLabels:
-            app.kubernetes.io/name: homepage
-    template:
-        metadata:
-            labels:
-                app.kubernetes.io/name: homepage
-        spec:
-            serviceAccountName: homepage
-            automountServiceAccountToken: true
-            dnsPolicy: ClusterFirst
-            enableServiceLinks: true
-            containers:
-                - name: homepage
-                  image: "ghcr.io/gethomepage/homepage:latest"
-                  imagePullPolicy: Always
-                  ports:
-                      - name: http
-                        containerPort: 3000
-                        protocol: TCP
-                  volumeMounts:
-                      - name: homepage-config
-                        mountPath: /app/config
-                      - name: logs
-                        mountPath: /app/config/logs
-            volumes:
-                - name: homepage-config
-                  configMap:
-                      name: homepage
-                - name: logs
-                  emptyDir: {}
+  revisionHistoryLimit: 3
+  replicas: 1
+  strategy:
+    type: RollingUpdate
+  selector:
+    matchLabels:
+      app.kubernetes.io/name: homepage
+  template:
+    metadata:
+      labels:
+        app.kubernetes.io/name: homepage
+    spec:
+      serviceAccountName: homepage
+      automountServiceAccountToken: true
+      dnsPolicy: ClusterFirst
+      enableServiceLinks: true
+      containers:
+        - name: homepage
+          image: "ghcr.io/gethomepage/homepage:latest"
+          imagePullPolicy: Always
+          ports:
+            - name: http
+              containerPort: 3000
+              protocol: TCP
+          volumeMounts:
+            - mountPath: /app/config/custom.js
+              name: homepage-config
+              subPath: custom.js
+            - mountPath: /app/config/custom.css
+              name: homepage-config
+              subPath: custom.css
+            - mountPath: /app/config/bookmarks.yaml
+              name: homepage-config
+              subPath: bookmarks.yaml
+            - mountPath: /app/config/docker.yaml
+              name: homepage-config
+              subPath: docker.yaml
+            - mountPath: /app/config/kubernetes.yaml
+              name: homepage-config
+              subPath: kubernetes.yaml
+            - mountPath: /app/config/services.yaml
+              name: homepage-config
+              subPath: services.yaml
+            - mountPath: /app/config/settings.yaml
+              name: homepage-config
+              subPath: settings.yaml
+            - mountPath: /app/config/widgets.yaml
+              name: homepage-config
+              subPath: widgets.yaml
+            - mountPath: /app/config/logs
+              name: logs
+      volumes:
+        - name: homepage-config
+          configMap:
+            name: homepage
+        - name: logs
+          emptyDir: {}
 ```
 
 #### Ingress
@@ -316,26 +338,56 @@ spec:
 apiVersion: networking.k8s.io/v1
 kind: Ingress
 metadata:
-    name: homepage
-    namespace: default
-    labels:
-        app.kubernetes.io/name: homepage
-    annotations:
-        gethomepage.dev/description: Dynamically Detected Homepage
-        gethomepage.dev/enabled: "true"
-        gethomepage.dev/group: Cluster Management
-        gethomepage.dev/icon: homepage.png
-        gethomepage.dev/name: Homepage
+  name: homepage
+  namespace: default
+  labels:
+    app.kubernetes.io/name: homepage
+  annotations:
+    gethomepage.dev/description: Dynamically Detected Homepage
+    gethomepage.dev/enabled: "true"
+    gethomepage.dev/group: Cluster Management
+    gethomepage.dev/icon: homepage.png
+    gethomepage.dev/name: Homepage
 spec:
-    rules:
-        - host: "homepage.my.network"
-          http:
-              paths:
-                  - path: "/"
-                    pathType: Prefix
-                    backend:
-                        service:
-                            name: homepage
-                            port:
-                                number: 3000
+  rules:
+    - host: "homepage.my.network"
+      http:
+        paths:
+          - path: "/"
+            pathType: Prefix
+            backend:
+              service:
+                name: homepage
+                port:
+                  number: 3000
+```
+
+### Multiple Replicas
+
+If you plan to deploy homepage with a replica count greater than 1, you may
+want to consider enabling sticky sessions on the homepage route. This will
+prevent unnecessary re-renders on page loads and window / tab focusing. The
+procedure for enabling sticky sessions depends on your Ingress controller. Below
+is an example using Traefik as the Ingress controller.
+
+```
+apiVersion: traefik.io/v1alpha1
+kind: IngressRoute
+metadata:
+  name: homepage.example.com
+spec:
+  entryPoints:
+    - websecure
+  routes:
+    - kind: Rule
+      match: Host(`homepage.example.com`)
+      services:
+        - kind: Service
+          name: homepage
+          port: 3000
+          sticky:
+            cookie:
+              httpOnly: true
+              secure: true
+              sameSite: none
 ```

docs/installation/unraid.md

@@ -7,39 +7,39 @@ Homepage has an UNRAID community package that you may use to install homepage. T
 
 ## Install the Plugin
 
--   In the UNRAID webGUI, go to the **Apps** tab.
--   In the search bar, search for `homepage`.
--   Click on **Install**.
--   Change the parameters to your liking.
-    -   Click on **APPLY**.
+- In the UNRAID webGUI, go to the **Apps** tab.
+- In the search bar, search for `homepage`.
+- Click on **Install**.
+- Change the parameters to your liking.
+  - Click on **APPLY**.
 
 ## Run the Container
 
--   While the container is running, open the WebUI.
-    -   Opening the page will generate the configuration files.
+- While the container is running, open the WebUI.
+  - Opening the page will generate the configuration files.
 
 You may need to set the permissions of the folders to be able to edit the files.
 
--   Click on the Homepage icon.
--   Click on **Console**.
-    -   Enter `chmod -R u-x,go-rwx,go+u,ugo+X /app/config` and press **Enter**.
-    -   Enter `chmod -R u-x,go-rwx,go+u,ugo+X /app/public/icons` and press **Enter**.
-    -   Enter `chown -R nobody:users /app/config` and press **Enter**.
-    -   Enter `chown -R nobody:users /app/public/icons` and press **Enter**.
+- Click on the Homepage icon.
+- Click on **Console**.
+  - Enter `chmod -R u-x,go-rwx,go+u,ugo+X /app/config` and press **Enter**.
+  - Enter `chmod -R u-x,go-rwx,go+u,ugo+X /app/public/icons` and press **Enter**.
+  - Enter `chown -R nobody:users /app/config` and press **Enter**.
+  - Enter `chown -R nobody:users /app/public/icons` and press **Enter**.
 
 ## Some Other Notes
 
--    To use the [Docker integration](../configs/docker.md), you only need to use the `container:` parameter. There is no need to set the server.
+- 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:
 
-    ```
-        - 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.
+- 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/development.md

@@ -31,12 +31,32 @@ Once dependencies have been installed you can lint your code with
 pnpm lint
 ```
 
+## Code formatting with pre-commit hooks
+
+To ensure a consistent style and formatting across the project source, the project utilizes Git [`pre-commit`](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks) hooks to perform some formatting and linting before a commit is allowed.
+
+Once installed, hooks will run when you commit. If the formatting isn't quite right, the commit will be rejected and you'll need to look at the output and fix the issue. Most hooks will automatically format failing files, so all you need to do is `git add` those files again and retry your commit.
+
+See the [pre-commit documentation](https://pre-commit.com/#install) to get started.
+
+## Preferring self-hosted open-source software
+
+In general, homepage is meant to be a dashboard for 'self-hosted' services and we believe it is a small way we can help showcase this kind of software. While exceptions are made, mostly when there is no viable
+self-hosted / open-source alternative, we ask that any widgets, etc. are developed primarily for a self-hosted tool.
+
+## New Feature Guidelines
+
+- New features should be linked to an existing feature request with at least 10 'up-votes'. The purpose of this requirement is to avoid the addition (and maintenance) of features that might only benefit a small number of users.
+- If you have ideas for a larger feature, please open a discussion first.
+- Please note that though it is a requirement, a discussion with 10 'up-votes' in no way guarantees that a PR will be merged.
+
 ## Service Widget Guidelines
 
 To ensure cohesiveness of various widgets, the following should be used as a guide for developing new widgets:
 
--   Please only submit widgets that have been requested and have at least 5 'up-votes'
--   Widgets should be only one row of blocks
--   Widgets should be no more than 4 blocks wide
--   Minimize the number of API calls
--   Avoid the use of custom proxy unless absolutely necessary
+- Please only submit widgets that have been requested and have at least 10 'up-votes'. The purpose of this requirement is to avoid the addition (and maintenance) of service widgets that might only benefit a small number of users.
+- Widgets should be only one row of blocks
+- Widgets should be no more than 4 blocks wide and generally conform to the styling / design choices of other widgets
+- Minimize the number of API calls
+- Avoid the use of custom proxy unless absolutely necessary
+- Widgets should be 'read-only', as in they should not make write changes using the relevant tool's API. Homepage widgets are designed to surface information, not to be a (usually worse) replacement for the tool itself.

docs/more/homepage-move.md

@@ -5,4 +5,4 @@ description: Homepage Container Deprecation
 
 As of v0.7.2 homepage migrated from benphelps/homepage to an "organization" repository located at [gethomepage/homepage](https://github.com/gethomepage/homepage/). The reason for this was to setup the project for longevity and allow for community maintenance.
 
-Migrating your installation should be as simple as changing `image: ghcr.io/benphelps/homepage:latest` to `image: ghcr.io/gethomepage/homepage:latest`.
+Migrating your installation should be as simple as changing `image: ghcr.io/benphelps/homepage:latest` to `image: ghcr.io/gethomepage/homepage:latest`.

docs/more/translations.md

@@ -3,12 +3,17 @@ title: Translations
 description: Contributing Translations
 ---
 
-Homepage is developed in English, most other supported languages are provided via Google Translate. When a i18n key is not found, the fallback language is English.
+Homepage is developed in English, component contributions must be in English. All translations are community provided, so a huge thanks go out to all those who have helped out so far!
 
 ## Support Translations
 
-If you'd like to lend a hand in translating Homepage into more languages, or to improve existing translations, the process is very simple.
+If you'd like to lend a hand in translating Homepage into more languages, or to improve existing translations, the process is very simple:
 
-Everything can be done from a simple to use web interface here: https://hosted.weblate.org/projects/homepage/homepage/
+1. Create a free account at [Crowdin](https://crowdin.com/join)
+2. Visit the [Homepage project](https://crowdin.com/project/gethomepage)
+3. Select the language you'd like to translate
+4. Start translating!
 
-When creating a new language, it can take 5 to 10 minutes before you'll see translatable strings added, but the process _is_ automatic. Once the strings are added, you can then start translating them.
+## Adding a new language
+
+If you'd like to add a new language, please [create a new Discussion on Crowdin](https://crowdin.com/project/gethomepage/discussions), and we'll add it to the project.

docs/more/troubleshooting.md

@@ -6,6 +6,10 @@ hide:
   - navigation
 ---
 
+## Introducing the Homepage AI Bot
+
+Thanks to the generous folks at [Glime](https://glimelab.ai), Homepage is now equipped with a pretty clever AI-powered bot. The bot has full knowledge of our docs, GitHub issues and discussions and is great at answering specific questions about setting up your Homepage. To use the bot, just hit the 'Ask AI' button on any page in our docs, [open a GitHub discussion](https://github.com/gethomepage/homepage/discussions) or check out the [#ai-support channel on Discord](https://discord.com/channels/1019316731635834932/1177885603552038993)!
+
 ## General Troubleshooting Tips
 
 - For API errors, clicking the "API Error Information" button in the widget will usually show some helpful information as to whether the issue is reaching the service host, an authentication issue, etc.
@@ -17,47 +21,49 @@ hide:
 
 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:
 
-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.  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.
 
-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.  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
-   ```
+    ```
+    docker exec homepage ping SERVICEIPORDOMAIN
+    ```
 
-   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.
+    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.
+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.
 
-   _Note: `curl` is not installed in the base image by default but can be added inside the container with `apk add curl`._
+    !!! note
 
-   The exact API endpoints and authentication vary of course, but in many cases instructions can be found by searching the web or if you feel comfortable looking at the homepage source code (e.g. `src/widgets/{widget}/widget.js`).
+        `curl` is not installed in the base image by default but can be added inside the container with `apk add curl`.
 
-   It is out of the scope of this to go into full detail about how to , but an example for PiHole would be:
+    The exact API endpoints and authentication vary of course, but in many cases instructions can be found by searching the web or if you feel comfortable looking at the homepage source code (e.g. `src/widgets/{widget}/widget.js`).
 
-   ```
-   curl -L -k http://PIHOLEIPORHOST/admin/api.php
-   ```
+    It is out of the scope of this to go into full detail about how to , but an example for PiHole would be:
 
-   Or for AdGuard:
+    ```
+    curl -L -k http://PIHOLEIPORHOST/admin/api.php
+    ```
 
-   ```
-   curl -L -k -u 'username:password' http://ADGUARDIPORHOST/control/stats
-   ```
+    Or for AdGuard:
 
-   Or for Portainer:
+    ```
+    curl -L -k -u 'username:password' http://ADGUARDIPORHOST/control/stats
+    ```
 
-   ```
-   curl -L -k -H 'X-Api-Key:YOURKEY' 'https://PORTAINERIPORHOST:PORT/api/endpoints/2/docker/containers/json'
-   ```
+    Or for Portainer:
 
-   Sonarr:
+    ```
+    curl -L -k -H 'X-Api-Key:YOURKEY' 'https://PORTAINERIPORHOST:PORT/api/endpoints/2/docker/containers/json'
+    ```
 
-   ```
-   curl -L -k 'http://SONARRIPORHOST:PORT/api/v3/queue?apikey=YOURAPIKEY'
-   ```
+    Sonarr:
 
-   This will return some data which may reveal an issue causing a true bug in the service widget.
+    ```
+    curl -L -k 'http://SONARRIPORHOST:PORT/api/v3/queue?apikey=YOURAPIKEY'
+    ```
+
+    This will return some data which may reveal an issue causing a true bug in the service widget.
 
 ## Missing custom icons
 

docs/overrides/main.html

@@ -0,0 +1,47 @@
+{% extends "base.html" %}
+
+{% block site_nav %}
+  <!-- Navigation -->
+  {% if nav %}
+    {% if page.meta and page.meta.hide %}
+      {% set hidden = "hidden" if "navigation" in page.meta.hide %}
+    {% endif %}
+    <div
+      class="md-sidebar md-sidebar--primary"
+      data-md-component="sidebar"
+      data-md-type="navigation"
+      {{ hidden }}
+    >
+      <div class="md-sidebar__scrollwrap">
+        <div class="md-sidebar__inner">
+          {% include "partials/nav.html" %}
+          {% if 'widgets/' not in page.url and 'more/' not in page.url %}
+            <script async type="text/javascript" src="//cdn.carbonads.com/carbon.js?serve=CWYIL2JU&placement=gethomepagedev&format=cover" id="_carbonads_js"></script>
+          {% endif %}
+        </div>
+      </div>
+    </div>
+  {% endif %}
+
+  <!-- Table of contents -->
+  {% if "toc.integrate" not in features %}
+    {% if page.meta and page.meta.hide %}
+      {% set hidden = "hidden" if "toc" in page.meta.hide %}
+    {% endif %}
+    <div
+      class="md-sidebar md-sidebar--secondary"
+      data-md-component="sidebar"
+      data-md-type="toc"
+      {{ hidden }}
+    >
+      <div class="md-sidebar__scrollwrap" style="height: 200px;">
+        <div class="md-sidebar__inner">
+          {% include "partials/toc.html" %}
+          {% if 'widgets/' in page.url or 'more/' in page.url %}
+            <script async type="text/javascript" src="//cdn.carbonads.com/carbon.js?serve=CWYIL2JU&placement=gethomepagedev&format=cover" id="_carbonads_js"></script>
+          {% endif %}
+        </div>
+      </div>
+    </div>
+  {% endif %}
+{% endblock %}

docs/scripts/extra.js

@@ -0,0 +1,35 @@
+var glimeScript;
+var glimeStyles = [];
+document$.subscribe(function () {
+  if (!glimeScript) {
+    glimeScript = document.createElement("script");
+    glimeScript.setAttribute("src", "https://cdn.glimelab.ai/widget/1.0.0/widget.js");
+    glimeScript.setAttribute("onload", "onGlimeLoad()");
+    document.head.appendChild(glimeScript);
+  } else {
+    var newGlimeStyle = document.createElement("style");
+    document.head.appendChild(newGlimeStyle);
+    var i = 0;
+    glimeStyles.forEach((rule) => {
+      newGlimeStyle.sheet.insertRule(rule.cssText, i);
+      i++;
+    });
+  }
+});
+
+onGlimeLoad = () => {
+  window.glime.init("Bl3mlvfCnTnRm5");
+  setTimeout(() => {
+    const sheets = document.styleSheets;
+    [...sheets].forEach((sheet) => {
+      if (!sheet.href) {
+        [...sheet.cssRules].forEach((rule) => {
+          if (!rule || rule.href || !rule.selectorText) return;
+          if (rule.selectorText.indexOf(".css-") === 0 || rule.selectorText.indexOf("glime") > -1) {
+            glimeStyles.push(rule);
+          }
+        });
+      }
+    });
+  }, 1000);
+};

docs/stylesheets/extra.css

@@ -17,4 +17,20 @@
         color: var(--md-default-bg-color--lighter);
         border-color: var(--md-default-bg-color--lighter);
     }
-}
+}
+
+#glimeRoot * {
+    font-family: var(--md-text-font) !important;
+}
+
+#carbonads {
+    margin-top: 10px;
+}
+
+#carbon-responsive {
+    --carbon-padding: 1em;
+    --carbon-max-char: 20ch;
+    --carbon-bg-primary: var(--md-default-bg-color) !important;
+    --carbon-bg-secondary: var(--md-default-fg-color--lightest) !important;
+    --carbon-text-color: var(--md-typeset-color) !important;
+}

docs/widgets/index.md

@@ -7,7 +7,7 @@ Homepage has two types of widgets: info and service. Below we'll cover each type
 
 ## Service Widgets
 
-Service widgets are used to display the status of a service, often a web service or API. Services (and their widgets) are defined in your `services.yml` file. Here's an example:
+Service widgets are used to display the status of a service, often a web service or API. Services (and their widgets) are defined in your `services.yaml` file. Here's an example:
 
 ```yaml
 - Plex:
@@ -24,7 +24,7 @@ Service widgets are used to display the status of a service, often a web service
 
 ## Info Widgets
 
-Info widgets are used to display information in the header, often about your system or environment. Info widgets are defined your `widgets.yml` file. Here's an example:
+Info widgets are used to display information in the header, often about your system or environment. Info widgets are defined your `widgets.yaml` file. Here's an example:
 
 ```yaml
 - openmeteo:

docs/widgets/info/datetime.md

@@ -9,9 +9,9 @@ Formatting is locale aware and will present your date in the regional format you
 
 ```yaml
 - datetime:
-      text_size: xl
-      format:
-          timeStyle: short
+    text_size: xl
+    format:
+      timeStyle: short
 ```
 
 Any options passed to `format` are passed directly to [Intl.DateTimeFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat), please reference the MDN documentation for all available options.
@@ -23,29 +23,29 @@ A few examples,
 ```yaml
 # 13:37
 format:
-    timeStyle: short
-    hourCycle: h23
+  timeStyle: short
+  hourCycle: h23
 ```
 
 ```yaml
 # 1:37 PM
 format:
-    timeStyle: short
-    hour12: true
+  timeStyle: short
+  hour12: true
 ```
 
 ```yaml
 # 1/23/22, 1:37 PM
 format:
-    dateStyle: short
-    timeStyle: short
-    hour12: true
+  dateStyle: short
+  timeStyle: short
+  hour12: true
 ```
 
 ```yaml
 # 4 januari 2023 om 13:51:25 PST
 locale: nl
 format:
-    dateStyle: long
-    timeStyle: long
+  dateStyle: long
+  timeStyle: long
 ```

docs/widgets/info/glances.md

@@ -9,16 +9,18 @@ The Glances widget allows you to monitor the resources (CPU, memory, storage, te
 
 ```yaml
 - glances:
-      url: http://host.or.ip:port
-      username: user # optional if auth enabled in Glances
-      password: pass # optional if auth enabled in Glances
-      cpu: true # optional, enabled by default, disable by setting to false
-      mem: true # optional, enabled by default, disable by setting to false
-      cputemp: true # disabled by default
-      uptime: true # disabled by default
-      disk: / # disabled by default, use mount point of disk(s) in glances. Can also be a list (see below)
-      expanded: true # show the expanded view
-      label: MyMachine # optional
+    url: http://host.or.ip:port
+    username: user # optional if auth enabled in Glances
+    password: pass # optional if auth enabled in Glances
+    version: 4 # required only if running glances v4 or higher, defaults to 3
+    cpu: true # optional, enabled by default, disable by setting to false
+    mem: true # optional, enabled by default, disable by setting to false
+    cputemp: true # disabled by default
+    uptime: true # disabled by default
+    disk: / # disabled by default, use mount point of disk(s) in glances. Can also be a list (see below)
+    diskUnits: bytes # optional, bytes (default) or bbytes. Only applies to disk
+    expanded: true # show the expanded view
+    label: MyMachine # optional
 ```
 
 Multiple disks can be specified as:

docs/widgets/info/greeting.md

@@ -7,8 +7,8 @@ This allows you to display simple text, can be configured like so:
 
 ```yaml
 - greeting:
-      text_size: xl
-      text: Greeting Text
+    text_size: xl
+    text: Greeting Text
 ```
 
 Valid text sizes are `4xl`, `3xl`, `2xl`, `xl`, `md`, `sm`, `xs`.

docs/widgets/info/kubernetes.md

@@ -9,23 +9,23 @@ It provides CPU and Memory usage, by node and/or at the cluster level.
 
 ```yaml
 - kubernetes:
-      cluster:
-          # Shows cluster-wide statistics
-          show: true
-          # Shows the aggregate CPU stats
-          cpu: true
-          # Shows the aggregate memory stats
-          memory: true
-          # Shows a custom label
-          showLabel: true
-          label: "cluster"
-      nodes:
-          # Shows node-specific statistics
-          show: true
-          # Shows the CPU for each node
-          cpu: true
-          # Shows the memory for each node
-          memory: true
-          # Shows the label, which is always the node name
-          showLabel: true
+    cluster:
+      # Shows cluster-wide statistics
+      show: true
+      # Shows the aggregate CPU stats
+      cpu: true
+      # Shows the aggregate memory stats
+      memory: true
+      # Shows a custom label
+      showLabel: true
+      label: "cluster"
+    nodes:
+      # Shows node-specific statistics
+      show: true
+      # Shows the CPU for each node
+      cpu: true
+      # Shows the memory for each node
+      memory: true
+      # Shows the label, which is always the node name
+      showLabel: true
 ```

docs/widgets/info/longhorn.md

@@ -12,18 +12,26 @@ It can show the aggregate metrics and/or the individual node metrics.
 
 ```yaml
 - longhorn:
-      # Show the expanded view
-      expanded: true
-      # Shows a node representing the aggregate values
-      total: true
-      # Shows the node names as labels
-      labels: true
-      # Show the nodes
-      nodes: true
-      # An explicit list of nodes to show. All are shown by default if "nodes" is true
-      include:
-          - node1
-          - node2
+    # Show the expanded view
+    expanded: true
+    # Shows a node representing the aggregate values
+    total: true
+    # Shows the node names as labels
+    labels: true
+    # Show the nodes
+    nodes: true
+    # An explicit list of nodes to show. All are shown by default if "nodes" is true
+    include:
+      - node1
+      - node2
 ```
 
-The Longhorn URL and credentials are stored in the `providers` section of the `settings.yaml`.
+The Longhorn URL and credentials are stored in the `providers` section of the `settings.yaml`. e.g.:
+
+```yaml
+providers:
+  longhorn:
+    username: "longhorn-username" # optional
+    password: "very-secret-longhorn-password" # optional
+    url: https://longhorn.aesop.network
+```

docs/widgets/info/openmeteo.md

@@ -7,12 +7,14 @@ No registration is required at all! See [https://open-meteo.com/en/docs](https:/
 
 ```yaml
 - openmeteo:
-      label: Kyiv # optional
-      latitude: 50.449684
-      longitude: 30.525026
-      timezone: Europe/Kiev # optional
-      units: metric # or imperial
-      cache: 5 # Time in minutes to cache API responses, to stay within limits
+    label: Kyiv # optional
+    latitude: 50.449684
+    longitude: 30.525026
+    timezone: Europe/Kiev # optional
+    units: metric # or imperial
+    cache: 5 # Time in minutes to cache API responses, to stay within limits
+    format: # optional, Intl.NumberFormat options
+      maximumFractionDigits: 1
 ```
 
 You can optionally not pass a `latitude` and `longitude` and the widget will use your current location (requires a secure context, eg. HTTPS).

docs/widgets/info/openweathermap.md

@@ -3,17 +3,19 @@ title: OpenWeatherMap
 description: OpenWeatherMap Information Widget Configuration
 ---
 
-The free tier "One Call API" is all thats required, you will need to [subscribe](https://home.openweathermap.org/subscriptions/unauth_subscribe/onecall_30/base) and grab your API key.
+The free tier "One Call API" is all that's required, you will need to [subscribe](https://home.openweathermap.org/subscriptions/unauth_subscribe/onecall_30/base) and grab your API key.
 
 ```yaml
 - openweathermap:
-      label: Kyiv #optional
-      latitude: 50.449684
-      longitude: 30.525026
-      units: metric # or imperial
-      provider: openweathermap
-      apiKey: youropenweathermapkey # required only if not using provider, this reveals api key in requests
-      cache: 5 # Time in minutes to cache API responses, to stay within limits
+    label: Kyiv #optional
+    latitude: 50.449684
+    longitude: 30.525026
+    units: metric # or imperial
+    provider: openweathermap
+    apiKey: youropenweathermapkey # required only if not using provider, this reveals api key in requests
+    cache: 5 # Time in minutes to cache API responses, to stay within limits
+    format: # optional, Intl.NumberFormat options
+      maximumFractionDigits: 1
 ```
 
 You can optionally not pass a `latitude` and `longitude` and the widget will use your current location (requires a secure context, eg. HTTPS).

docs/widgets/info/resources.md

@@ -9,32 +9,35 @@ The disk path is the path reported by `df` (Mounted On), or the mount point of t
 
 The cpu and memory resource information are the container's usage while [glances](glances.md) displays statistics for the host machine on which it is installed.
 
-_Note: unfortunately, the package used for getting CPU temp ([systeminformation](https://systeminformation.io)) is not compatibile with some setups and will not report any value(s) for CPU temp._
+_Note: unfortunately, the package used for getting CPU temp ([systeminformation](https://systeminformation.io)) is not compatible with some setups and will not report any value(s) for CPU temp._
 
 **Any disk you wish to access must be mounted to your container as a volume.**
 
 ```yaml
 - resources:
-      cpu: true
-      memory: true
-      disk: /disk/mount/path
-      cputemp: true
-      uptime: true
-      units: imperial # only used by cpu temp
-      refresh: 3000 # optional, in ms
+    cpu: true
+    memory: true
+    disk: /disk/mount/path
+    cputemp: true
+    tempmin: 0 # optional, minimum cpu temp
+    tempmax: 100 # optional, maximum cpu temp
+    uptime: true
+    units: imperial # only used by cpu temp
+    refresh: 3000 # optional, in ms
+    diskUnits: bytes # optional, bytes (default) or bbytes. Only applies to disk
 ```
 
 You can also pass a `label` option, which allows you to group resources under named sections,
 
 ```yaml
 - resources:
-      label: System
-      cpu: true
-      memory: true
+    label: System
+    cpu: true
+    memory: true
 
 - resources:
-      label: Storage
-      disk: /mnt/storage
+    label: Storage
+    disk: /mnt/storage
 ```
 
 Which produces something like this,
@@ -45,11 +48,11 @@ If you have more than a single disk and would like to group them together under
 
 ```yaml
 - resources:
-      label: Storage
-      disk:
-          - /mnt/storage
-          - /mnt/backup
-          - /mnt/media
+    label: Storage
+    disk:
+      - /mnt/storage
+      - /mnt/backup
+      - /mnt/media
 ```
 
 To produce something like this,
@@ -60,12 +63,12 @@ You can additionally supply an optional `expanded` property set to true in order
 
 ```yaml
 - resources:
-      label: Array Disks
-      expanded: true
-      disk:
-          - /disk1
-          - /disk2
-          - /disk3
+    label: Array Disks
+    expanded: true
+    disk:
+      - /disk1
+      - /disk2
+      - /disk3
 ```
 
 ![194136533-c4238c82-4d67-41a4-b3c8-18bf26d33ac2](https://user-images.githubusercontent.com/3441425/194728642-a9885274-922b-4027-acf5-a746f58fdfce.png)

docs/widgets/info/search.md

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

docs/widgets/info/weather.md

@@ -5,16 +5,18 @@ description: Weather API Information Widget Configuration
 
 **Note: this widget is considered 'deprecated' since there is no longer a free Weather API tier for new members. See the openmeteo or openweathermap widgets for alternatives.**
 
-The free tier is all thats required, you will need to [register](https://www.weatherapi.com/signup.aspx) and grab your API key.
+The free tier is all that's required, you will need to [register](https://www.weatherapi.com/signup.aspx) and grab your API key.
 
 ```yaml
 - weatherapi:
-      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
+    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/adguard-home.md

@@ -3,14 +3,16 @@ title: Adguard Home
 description: Adguard Home Widget Configuration
 ---
 
+Learn more about [Adguard Home](https://github.com/AdguardTeam/AdGuardHome).
+
 The username and password are the same as used to login to the web interface.
 
 Allowed fields: `["queries", "blocked", "filtered", "latency"]`.
 
 ```yaml
 widget:
-    type: adguard
-    url: http://adguard.host.or.ip
-    username: admin
-    password: password
+  type: adguard
+  url: http://adguard.host.or.ip
+  username: admin
+  password: password
 ```

docs/widgets/services/atsumeru.md

@@ -3,14 +3,16 @@ title: Atsumeru
 description: Atsumeru Widget Configuration
 ---
 
+Learn more about [Atsumeru](https://github.com/AtsumeruDev/Atsumeru).
+
 Define same username and password that is used for login from web or supported apps
 
 Allowed fields: `["series", "archives", "chapters", "categories"]`.
 
 ```yaml
 widget:
-    type: atsumeru
-    url: http://atsumeru.host.or.ip:port
-    username: username
-    password: password
+  type: atsumeru
+  url: http://atsumeru.host.or.ip:port
+  username: username
+  password: password
 ```

docs/widgets/services/audiobookshelf.md

@@ -3,13 +3,15 @@ title: Audiobookshelf
 description: Audiobookshelf Widget Configuration
 ---
 
+Learn more about [Audiobookshelf](https://github.com/advplyr/audiobookshelf).
+
 You can find your API token by logging into the Audiobookshelf web app as an admin, go to the config → users page, and click on your account.
 
 Allowed fields: `["podcasts", "podcastsDuration", "books", "booksDuration"]`
 
 ```yaml
 widget:
-    type: audiobookshelf
-    url: http://audiobookshelf.host.or.ip:port
-    key: audiobookshelflapikey
+  type: audiobookshelf
+  url: http://audiobookshelf.host.or.ip:port
+  key: audiobookshelflapikey
 ```

docs/widgets/services/authentik.md

@@ -3,22 +3,23 @@ title: Authentik
 description: Authentik Widget Configuration
 ---
 
+Learn more about [Authentik](https://github.com/goauthentik/authentik).
+
 This widget reads the number of active users in the system, as well as logins for the last 24 hours.
 
-You will need to generate an API token for an existing user. To do so follow these steps:
+You will need to generate an API token for an existing user under `Admin Portal` > `Directory` > `Tokens & App passwords`.
+Make sure to set Intent to "API Token".
 
-1. Navigate to the Authentik Admin Portal
-2. Expand Directory, the click Tokens & App passwords
-3. Click the Create button
-4. Fill out the dialog making sure to set Intent to API Token
-5. Click the Create button on the dialog
-6. Click the copy button on the far right of the newly created API Token
+The account you made the API token for also needs the following **Assigned global permissions** in Authentik:
+
+- authentik Core -> Can view User (Model: User)
+- authentik Events -> Can view Event (Model: Event)
 
 Allowed fields: `["users", "loginsLast24H", "failedLoginsLast24H"]`.
 
 ```yaml
 widget:
-    type: authentik
-    url: http://authentik.host.or.ip:22070
-    key: api_token
+  type: authentik
+  url: http://authentik.host.or.ip:22070
+  key: api_token
 ```

docs/widgets/services/autobrr.md

@@ -3,13 +3,15 @@ title: Autobrr
 description: Autobrr Widget Configuration
 ---
 
+Learn more about [Autobrr](https://github.com/autobrr/autobrr).
+
 Find your API key under `Settings > API Keys`.
 
 Allowed fields: `["approvedPushes", "rejectedPushes", "filters", "indexers"]`.
 
 ```yaml
 widget:
-    type: autobrr
-    url: http://autobrr.host.or.ip
-    key: apikeyapikeyapikeyapikeyapikey
+  type: autobrr
+  url: http://autobrr.host.or.ip
+  key: apikeyapikeyapikeyapikeyapikey
 ```

docs/widgets/services/azuredevops.md

@@ -3,24 +3,26 @@ title: Azure DevOps
 description: Azure DevOps Widget Configuration
 ---
 
+Learn more about [Azure DevOps](https://azure.microsoft.com/en-us/products/devops).
+
 This widget has 2 functions:
 
-1. Pipelines: checks if the relevant pipeline is running or not, and if not, reports the last status.\
+1. Pipelines: checks if the relevant pipeline is running or not, and if not, reports the last status.<br>
    Allowed fields: `["result", "status"]`.
 
-2. Pull Requests: returns the amount of open PRs, the amount of the PRs you have open, and how many PRs that you open are marked as 'Approved' by atleast 1 person and not yet completed.\
+2. Pull Requests: returns the amount of open PRs, the amount of the PRs you have open, and how many PRs that you open are marked as 'Approved' by at least 1 person and not yet completed.<br>
    Allowed fields: `["totalPrs", "myPrs", "approved"]`.
 
 You will need to generate a personal access token for an existing user, see the [azure documentation](https://learn.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops&tabs=Windows#create-a-pat)
 
 ```yaml
 widget:
-    type: azuredevops
-    organization: myOrganization
-    project: myProject
-    definitionId: pipelineDefinitionId # required for pipelines
-    branchName: branchName # optional for pipelines, leave empty for all
-    userEmail: email # required for pull requests
-    repositoryId: prRepositoryId # required for pull requests
-    key: personalaccesstoken
+  type: azuredevops
+  organization: myOrganization
+  project: myProject
+  definitionId: pipelineDefinitionId # required for pipelines
+  branchName: branchName # optional for pipelines, leave empty for all
+  userEmail: email # required for pull requests
+  repositoryId: prRepositoryId # required for pull requests
+  key: personalaccesstoken
 ```

docs/widgets/services/bazarr.md

@@ -3,13 +3,15 @@ title: Bazarr
 description: Bazarr Widget Configuration
 ---
 
+Learn more about [Bazarr](https://github.com/morpheus65535/bazarr).
+
 Find your API key under `Settings > General`.
 
 Allowed fields: `["missingEpisodes", "missingMovies"]`.
 
 ```yaml
 widget:
-    type: bazarr
-    url: http://bazarr.host.or.ip
-    key: apikeyapikeyapikeyapikeyapikey
+  type: bazarr
+  url: http://bazarr.host.or.ip
+  key: apikeyapikeyapikeyapikeyapikey
 ```

docs/widgets/services/caddy.md

@@ -3,10 +3,12 @@ title: Caddy
 description: Caddy Widget Configuration
 ---
 
+Learn more about [Caddy](https://github.com/caddyserver/caddy).
+
 Allowed fields: `["upstreams", "requests", "requests_failed"]`.
 
 ```yaml
 widget:
-    type: caddy
-    url: http://caddy.host.or.ip:adminport # default admin port is 2019
+  type: caddy
+  url: http://caddy.host.or.ip:adminport # default admin port is 2019
 ```

docs/widgets/services/calendar.md

@@ -3,6 +3,8 @@ title: Calendar
 description: Calendar widget
 ---
 
+## Monthly view
+
 <img alt="calendar" src="https://user-images.githubusercontent.com/5442891/271131282-6767a3ea-573e-4005-aeb9-6e14ee01e845.png">
 
 This widget shows monthly calendar, with optional integrations to show events from supported widgets.
@@ -11,15 +13,45 @@ This widget shows monthly calendar, with optional integrations to show events fr
 widget:
   type: calendar
   firstDayInWeek: sunday # optional - defaults to monday
+  view: monthly # optional - possible values monthly, agenda
+  maxEvents: 10 # optional - defaults to 10
+  showTime: true # optional - show time for event happening today - defaults to false
+  timezone: America/Los_Angeles # optional and only when timezone is not detected properly (slightly slower performance) - force timezone for ical events (if it's the same - no change, if missing or different in ical - will be converted to this timezone)
   integrations: # optional
-    - type: sonarr # active widget type that is currently enabled on homepage - possible values: radarr, sonarr, lidarr, readarr
+    - type: sonarr # active widget type that is currently enabled on homepage - possible values: radarr, sonarr, lidarr, readarr, ical
       service_group: Media # group name where widget exists
       service_name: Sonarr # service name for that widget
       color: teal # optional - defaults to pre-defined color for the service (teal for sonarr)
       params: # optional - additional params for the service
         unmonitored: true # optional - defaults to false, used with *arr stack
+    - type: ical # Show calendar events from another service
+      url: https://domain.url/with/link/to.ics # URL with calendar events
+      name: My Events # required - name for these calendar events
+      color: zinc # optional - defaults to pre-defined color for the service (zinc for ical)
+      params: # optional - additional params for the service
+        showName: true # optional - show name before event title in event line - defaults to false
 ```
 
+## Agenda
+
+This view shows only list of events from configured integrations
+
+```yaml
+widget:
+  type: calendar
+  view: agenda
+  maxEvents: 10 # optional - defaults to 10
+  showTime: true # optional - show time for event happening today - defaults to false
+  previousDays: 3 # optional - shows events since three days ago - defaults to 0
+  integrations: # same as in Monthly view example
+```
+
+## Integrations
+
 Currently integrated widgets are [sonarr](sonarr.md), [radarr](radarr.md), [lidarr](lidarr.md) and [readarr](readarr.md).
 
 Supported colors can be found on [color palette](../../configs/settings.md#color-palette).
+
+### iCal
+
+This custom integration allows you to show events from any calendar that supports iCal format, for example, Google Calendar (go to `Settings`, select specific calendar, go to `Integrate calendar`, copy URL from `Public Address in iCal format`).

docs/widgets/services/calibre-web.md

@@ -3,14 +3,16 @@ title: Calibre-web
 description: Calibre-web Widget Configuration
 ---
 
-**Note: this widget requires a feature of calibre-web that has not yet been distributed in versioned release. The code is contained in ["nightly" lsio builds after 25/8/23](https://hub.docker.com/layers/linuxserver/calibre-web/nightly/images/sha256-b27cbe5d17503de38135d925e226eb3e5ba04c558dbc865dc85d77824d35d7e2) or running the calibre-web source code including commit [0499e57](https://github.com/janeczku/calibre-web/commit/0499e578cdd45db656da34cd2d7152c8d88ceb23).**
+Learn more about [Calibre-web](https://github.com/janeczku/calibre-web).
+
+**Note: widget requires calibre-web ≥ v0.6.21.**
 
 Allowed fields: `["books", "authors", "categories", "series"]`.
 
 ```yaml
 widget:
-    type: calibreweb
-    url: http://your.calibreweb.host:port
-    username: username
-    password: password
+  type: calibreweb
+  url: http://your.calibreweb.host:port
+  username: username
+  password: password
 ```

docs/widgets/services/changedetectionio.md

@@ -3,11 +3,13 @@ title: Changedetection.io
 description: Changedetection.io Widget Configuration
 ---
 
+Learn more about [Changedetection.io](https://github.com/dgtlmoon/changedetection.io).
+
 Find your API key under `Settings > API`.
 
 ```yaml
 widget:
-    type: changedetectionio
-    url: http://changedetection.host.or.ip:port
-    key: apikeyapikeyapikeyapikeyapikey
+  type: changedetectionio
+  url: http://changedetection.host.or.ip:port
+  key: apikeyapikeyapikeyapikeyapikey
 ```

docs/widgets/services/channelsdvrserver.md

@@ -3,8 +3,10 @@ title: Channels DVR Server
 description: Channels DVR Server Widget Configuration
 ---
 
+Learn more about [Channels DVR Server](https://getchannels.com/dvr-server/).
+
 ```yaml
 widget:
-    type: channelsdvrserver
-    url: http://192.168.1.55:8089
+  type: channelsdvrserver
+  url: http://server.host.or.ip:port
 ```

docs/widgets/services/cloudflared.md

@@ -3,14 +3,16 @@ title: Cloudflare Tunnels
 description: Cloudflare Tunnels Widget Configuration
 ---
 
+Learn more about [Cloudflare Tunnels](https://www.cloudflare.com/products/tunnel/).
+
 _As of v0.6.10 this widget no longer accepts a Cloudflare global API key (or account email) due to security concerns. Instead, you should setup an API token which only requires the permissions `Account.Cloudflare Tunnel:Read`._
 
 Allowed fields: `["status", "origin_ip"]`.
 
 ```yaml
 widget:
-    type: cloudflared
-    accountid: accountid # from zero trust dashboard url e.g. https://one.dash.cloudflare.com/<accountid>/home/quick-start
-    tunnelid: tunnelid # found in tunnels dashboard under the tunnel name
-    key: cloudflareapitoken # api token with `Account.Cloudflare Tunnel:Read` https://dash.cloudflare.com/profile/api-tokens
+  type: cloudflared
+  accountid: accountid # from zero trust dashboard url e.g. https://one.dash.cloudflare.com/<accountid>/home/quick-start
+  tunnelid: tunnelid # found in tunnels dashboard under the tunnel name
+  key: cloudflareapitoken # api token with `Account.Cloudflare Tunnel:Read` https://dash.cloudflare.com/profile/api-tokens
 ```

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

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

docs/widgets/services/crowdsec.md

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

docs/widgets/services/customapi.md

@@ -9,31 +9,56 @@ Fields need to be defined in the `mappings` section YAML object to correlate wit
 
 ```yaml
 widget:
-    type: customapi
-    url: http://custom.api.host.or.ip:port/path/to/exact/api/endpoint
-    refreshInterval: 10000 # optional - in milliseconds, defaults to 10s
-    username: username # auth - optional
-    password: password # auth - optional
-    method: GET # optional, e.g. POST
-    headers: # optional, must be object, see below
-    mappings:
-        - field: key # needs to be YAML string or object
-          label: Field 1
-          format: text # optional - defaults to text
-        - field: # needs to be YAML string or object
-              path:
-                  to: key2
-          format: number # optional - defaults to text
-          label: Field 2
-        - field: # needs to be YAML string or object
-              path:
-                  to:
-                      another: key3
-          label: Field 3
-          format: percent # optional - defaults to text
+  type: customapi
+  url: http://custom.api.host.or.ip:port/path/to/exact/api/endpoint
+  refreshInterval: 10000 # optional - in milliseconds, defaults to 10s
+  username: username # auth - optional
+  password: password # auth - optional
+  method: GET # optional, e.g. POST
+  headers: # optional, must be object, see below
+  requestBody: # optional, can be string or object, see below
+  display: # optional, default to block, see below
+  mappings:
+    - field: key # needs to be YAML string or object
+      label: Field 1
+      format: text # optional - defaults to text
+    - field: # needs to be YAML string or object
+        path:
+          to: key2
+      format: number # optional - defaults to text
+      label: Field 2
+    - field: # needs to be YAML string or object
+        path:
+          to:
+            another: key3
+      label: Field 3
+      format: percent # optional - defaults to text
+    - field: key # needs to be YAML string or object
+      label: Field 4
+      format: date # optional - defaults to text
+      locale: nl # optional
+      dateStyle: long # optional - defaults to "long". Allowed values: `["full", "long", "medium", "short"]`.
+      timeStyle: medium # optional - Allowed values: `["full", "long", "medium", "short"]`.
+    - field: key # needs to be YAML string or object
+      label: Field 5
+      format: relativeDate # optional - defaults to text
+      locale: nl # optional
+      style: short # optional - defaults to "long". Allowed values: `["long", "short", "narrow"]`.
+      numeric: auto # optional - defaults to "always". Allowed values `["always", "auto"]`.
+    - field: key
+      label: Field 6
+      format: text
+      additionalField: # optional
+        field:
+          hourly:
+            time: other key
+        color: theme # optional - defaults to "". Allowed values: `["theme", "adaptive", "black", "white"]`.
+        format: date # optional
 ```
 
-Supported formats for the values are `text`, `number`, `float`, `percent`, `bytes` and `bitrate`.
+Supported formats for the values are `text`, `number`, `float`, `percent`, `bytes`, `bitrate`, `date` and `relativeDate`.
+
+The `dateStyle` and `timeStyle` options of the `date` format are passed directly to [Intl.DateTimeFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat) and the `style` and `numeric` options of `relativeDate` are passed to [Intl.RelativeTimeFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/RelativeTimeFormat/RelativeTimeFormat).
 
 ## Example
 
@@ -41,62 +66,97 @@ For the following JSON object from the API:
 
 ```json
 {
-    "id": 1,
-    "name": "Rick Sanchez",
-    "status": "Alive",
-    "species": "Human",
-    "gender": "Male",
-    "origin": {
-        "name": "Earth (C-137)"
+  "id": 1,
+  "name": "Rick Sanchez",
+  "status": "Alive",
+  "species": "Human",
+  "gender": "Male",
+  "origin": {
+    "name": "Earth (C-137)"
+  },
+  "locations": [
+    {
+      "name": "Earth (C-137)"
     },
-    "locations": [
-        {
-            "name": "Earth (C-137)"
-        },
-        {
-            "name": "Citadel of Ricks"
-        }
-    ]
+    {
+      "name": "Citadel of Ricks"
+    }
+  ]
 }
 ```
 
-Define the `mappings` section as an aray, for example:
+Define the `mappings` section as an array, for example:
 
 ```yaml
 mappings:
-    - field: name # Rick Sanchez
-      label: Name
-    - field: status # Alive
-      label: Status
-    - field:
-          origin: name # Earth (C-137)
-      label: Origin
-    - field:
-          locations:
-              1: name # Citadel of Ricks
-      label: Location
+  - field: name # Rick Sanchez
+    label: Name
+  - field: status # Alive
+    label: Status
+  - field:
+      origin: name # Earth (C-137)
+    label: Origin
+  - field:
+      locations:
+        1: name # Citadel of Ricks
+    label: Location
 ```
 
 ## Data Transformation
 
-You can manipulate data with the following tools `remap`, `scale` and `suffix`, for example:
+You can manipulate data with the following tools `remap`, `scale`, `prefix` and `suffix`, for example:
 
 ```yaml
 - field: key4
   label: Field 4
   format: text
   remap:
-      - value: 0
-        to: None
-      - value: 1
-        to: Connected
-      - any: true # will map all other values
-        to: Unknown
+    - value: 0
+      to: None
+    - value: 1
+      to: Connected
+    - any: true # will map all other values
+      to: Unknown
 - field: key5
   label: Power
   format: float
   scale: 0.001 # can be number or string e.g. 1/16
-  suffix: kW
+  suffix: "kW"
+- field: key6
+  label: Price
+  format: float
+  prefix: "$"
+```
+
+## List View
+
+You can change the default block view to a list view by setting the `display` option to `list`.
+
+The list view can optionally display an additional field next to the primary field.
+
+`additionalField`: Similar to `field`, but only used in list view. Displays additional information for the mapping object on the right.
+
+`field`: Defined the same way as other custom api widget fields.
+
+`color`: Allowed options: `"theme", "adaptive", "black", "white"`. The option `adaptive` will apply a color using the value of the `additionalField`, green for positive numbers, red for negative numbers.
+
+```yaml
+- field: key
+  label: Field
+  format: text
+  remap:
+    - value: 0
+      to: None
+    - value: 1
+      to: Connected
+    - any: true # will map all other values
+      to: Unknown
+  additionalField:
+    field:
+      hourly:
+        time: key
+    color: theme
+    format: date
 ```
 
 ## Custom Headers
@@ -105,5 +165,18 @@ Pass custom headers using the `headers` option, for example:
 
 ```yaml
 headers:
-    X-API-Token: token
+  X-API-Token: token
 ```
+
+## Custom Request Body
+
+Pass custom request body using the `requestBody` option in either a string or object format. Objects will automatically be converted to a JSON string.
+
+```yaml
+requestBody:
+  foo: bar
+# or
+requestBody: "{\"foo\":\"bar\"}"
+```
+
+Both formats result in `{"foo":"bar"}` being sent as the request body. Don't forget to set your `Content-Type` headers!

docs/widgets/services/deluge.md

@@ -3,13 +3,15 @@ title: Deluge
 description: Deluge Widget Configuration
 ---
 
+Learn more about [Deluge](https://deluge-torrent.org/).
+
 Uses the same password used to login to the webui, see [the deluge FAQ](https://dev.deluge-torrent.org/wiki/Faq#Whatisthedefaultpassword).
 
 Allowed fields: `["leech", "download", "seed", "upload"]`.
 
 ```yaml
 widget:
-    type: deluge
-    url: http://deluge.host.or.ip
-    password: password # webui password
+  type: deluge
+  url: http://deluge.host.or.ip
+  password: password # webui password
 ```

docs/widgets/services/diskstation.md

@@ -3,34 +3,41 @@ title: Synology Disk Station
 description: Synology Disk Station Widget Configuration
 ---
 
+Learn more about [Synology Disk Station](https://www.synology.com/en-global/dsm).
+
 Note: the widget is not compatible with 2FA.
 
 An optional 'volume' parameter can be supplied to specify which volume's free space to display when more than one volume exists. The value of the parameter must be in form of `volume_N`, e.g. to display free space for volume2, `volume_2` should be set as 'volume' value. If omitted, first returned volume's free space will be shown (not guaranteed to be volume1).
 
 Allowed fields: `["uptime", "volumeAvailable", "resources.cpu", "resources.mem"]`.
 
-To access these system metrics you need to connect to the DiskStation with an account that is a member of the default `Administrators` group. That is because these metrics are requested from the API's `SYNO.Core.System` part that is only available to admin users. In order to keep the security impact as small as possible we can set the account in DSM up to limit the user's permissions inside the Synology system. In DSM 7.x, for instance, follow these steps:
+To access these system metrics you need to connect to the DiskStation (`DSM`) with an account that is a member of the default `Administrators` group. That is because these metrics are requested from the API's `SYNO.Core.System` part that is only available to admin users. In order to keep the security impact as small as possible we can set the account in DSM up to limit the user's permissions inside the Synology system. In DSM 7.x, for instance, follow these steps:
 
 1. Create a new user, i.e. `remote_stats`.
 2. Set up a strong password for the new user
 3. Under the `User Groups` tab of the user config dialogue check the box for `Administrators`.
 4. On the `Permissions` tab check the top box for `No Access`, effectively prohibiting the user from accessing anything in the shared folders.
 5. Under `Applications` check the box next to `Deny` in the header to explicitly prohibit login to all applications.
-6. Now _only_ allow login to the `Download Station` application, either by
-    - unchecking `Deny` in the respective row, or (if inheriting permission doesn't work because of other group settings)
-    - checking `Allow` for this app, or
-    - checking `By IP` for this app to limit the source of login attempts to one or more IP addresses/subnets.
-7. When the `Preview` column shows `Allow` in the `Download Station` row, click `Save`.
+6. Now _only_ allow login to the `DSM` application, either by
+   - unchecking `Deny` in the respective row, or (if inheriting permission doesn't work because of other group settings)
+   - checking `Allow` for this app, or
+   - checking `By IP` for this app to limit the source of login attempts to one or more IP addresses/subnets.
+7. When the `Preview` column shows `Allow` in the `DSM` row, click `Save`.
 
 Now configure the widget with the correct login information and test it.
 
-If you encounter issues during testing, make sure to uncheck the option for automatic blocking due to invalid logins under `Control Panel > Security > Protection`. If desired, this setting can be reactivated once the login is established working.
+If you encounter issues during testing:
+
+1. Make sure to uncheck the option for automatic blocking due to invalid logins under `Control Panel > Security > Protection`.
+   - If desired, this setting can be reactivated once the login is established working.
+2. Login to your Synology DSM with the newly created account and accept terms and conditions.
+3. Reattempt
 
 ```yaml
 widget:
-    type: diskstation
-    url: http://diskstation.host.or.ip:port
-    username: username
-    password: password
-    volume: volume_N # optional
+  type: diskstation
+  url: http://diskstation.host.or.ip:port
+  username: username
+  password: password
+  volume: volume_N # optional
 ```

docs/widgets/services/downloadstation.md

@@ -3,14 +3,16 @@ title: Synology Download Station
 description: Synology Download Station Widget Configuration
 ---
 
+Learn more about [Synology Download Station](https://www.synology.com/en-us/dsm/packages/DownloadStation).
+
 Note: the widget is not compatible with 2FA.
 
 Allowed fields: `["leech", "download", "seed", "upload"]`.
 
 ```yaml
 widget:
-    type: downloadstation
-    url: http://downloadstation.host.or.ip:port
-    username: username
-    password: password
+  type: downloadstation
+  url: http://downloadstation.host.or.ip:port
+  username: username
+  password: password
 ```

docs/widgets/services/emby.md

@@ -3,15 +3,20 @@ title: Emby
 description: Emby Widget Configuration
 ---
 
+Learn more about [Emby](https://github.com/MediaBrowser/Emby).
+
 You can create an API key from inside Emby at `Settings > Advanced > Api Keys`.
 
 As of v0.6.11 the widget supports fields `["movies", "series", "episodes", "songs"]`. These blocks are disabled by default but can be enabled with the `enableBlocks` option, and the "Now Playing" feature (enabled by default) can be disabled with the `enableNowPlaying` option.
 
 ```yaml
 widget:
-    type: emby
-    url: http://emby.host.or.ip
-    key: apikeyapikeyapikeyapikeyapikey
-    enableBlocks: true # optional, defaults to false
-    enableNowPlaying: true # optional, defaults to true
+  type: emby
+  url: http://emby.host.or.ip
+  key: apikeyapikeyapikeyapikeyapikey
+  enableBlocks: true # optional, defaults to false
+  enableNowPlaying: true # optional, defaults to true
+  enableUser: true # optional, defaults to false
+  showEpisodeNumber: true # optional, defaults to false
+  expandOneStreamToTwoRows: false # optional, defaults to true
 ```

docs/widgets/services/esphome.md

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

docs/widgets/services/evcc.md

@@ -3,10 +3,12 @@ title: EVCC
 description: EVCC Widget Configuration
 ---
 
+Learn more about [EVSS](https://github.com/evcc-io/evcc).
+
 Allowed fields: `["pv_power", "grid_power", "home_power", "charge_power]`.
 
 ```yaml
 widget:
-    type: evcc
-    url: http://evcc.host.or.ip:port
+  type: evcc
+  url: http://evcc.host.or.ip:port
 ```

docs/widgets/services/fileflows.md

@@ -3,10 +3,12 @@ title: Fileflows
 description: Fileflows Widget Configuration
 ---
 
+Learn more about [FileFlows](https://github.com/revenz/FileFlows).
+
 Allowed fields: `["queue", "processing", "processed", "time"]`.
 
 ```yaml
 widget:
-    type: fileflows
-    url: http://your.fileflows.host:port
+  type: fileflows
+  url: http://your.fileflows.host:port
 ```

docs/widgets/services/flood.md

@@ -3,12 +3,14 @@ title: Flood
 description: Flood Widget Configuration
 ---
 
+Learn more about [Flood](https://github.com/jesec/flood).
+
 Allowed fields: `["leech", "download", "seed", "upload"]`.
 
 ```yaml
 widget:
-    type: flood
-    url: http://flood.host.or.ip
-    username: username # if set
-    password: password # if set
+  type: flood
+  url: http://flood.host.or.ip
+  username: username # if set
+  password: password # if set
 ```

docs/widgets/services/freshrss.md

@@ -3,14 +3,16 @@ title: FreshRSS
 description: FreshRSS Widget Configuration
 ---
 
+Learn more about [FreshRSS](https://github.com/FreshRSS/FreshRSS).
+
 Please refer to [Enable the API in FreshRSS](https://freshrss.github.io/FreshRSS/en/users/06_Mobile_access.html#enable-the-api-in-freshrss) for the "API password" to be entered in the password field.
 
 Allowed fields: `["subscriptions", "unread"]`.
 
 ```yaml
 widget:
-    type: freshrss
-    url: http://freshrss.host.or.ip:port
-    username: username
-    password: password
+  type: freshrss
+  url: http://freshrss.host.or.ip:port
+  username: username
+  password: password
 ```

docs/widgets/services/fritzbox.md

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

docs/widgets/services/gamedig.md

@@ -3,13 +3,15 @@ title: GameDig
 description: GameDig Widget Configuration
 ---
 
+Learn more about [GameDig](https://github.com/gamedig/node-gamedig).
+
 Uses the [GameDig](https://www.npmjs.com/package/gamedig) library to get game server information for any supported server type.
 
 Allowed fields (limited to a max of 4): `["status", "name", "map", "currentPlayers", "players", "maxPlayers", "bots", "ping"]`.
 
 ```yaml
 widget:
-    type: gamedig
-    serverType: csgo # see https://github.com/gamedig/node-gamedig#games-list
-    url: udp://server.host.or.ip:port
+  type: gamedig
+  serverType: csgo # see https://github.com/gamedig/node-gamedig#games-list
+  url: udp://server.host.or.ip:port
 ```

docs/widgets/services/gatus.md

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

docs/widgets/services/ghostfolio.md

@@ -3,6 +3,8 @@ title: Ghostfolio
 description: Ghostfolio Widget Configuration
 ---
 
+Learn more about [Ghostfolio](https://github.com/ghostfolio/ghostfolio).
+
 Authentication requires manually obtaining a Bearer token which can be obtained by make a POST request to the API e.g.
 
 ```
@@ -17,7 +19,7 @@ Allowed fields: `["gross_percent_today", "gross_percent_1y", "gross_percent_max"
 
 ```yaml
 widget:
-    type: ghostfolio
-    url: http://ghostfoliohost:port
-    key: ghostfoliobearertoken
+  type: ghostfolio
+  url: http://ghostfoliohost:port
+  key: ghostfoliobearertoken
 ```

docs/widgets/services/gitea.md

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

docs/widgets/services/glances.md

@@ -3,7 +3,9 @@ title: Glances
 description: Glances Widget Configuration
 ---
 
-<img width="1614" alt="glances" src="https://github.com/gethomepage/homepage-docs/assets/82196/25648c97-2c1b-4db0-b5a5-f1509806079c">
+Learn more about [Glances](https://github.com/nicolargo/glances).
+
+<img width="1614" alt="glances" src="https://github-production-user-asset-6210df.s3.amazonaws.com/82196/257382012-25648c97-2c1b-4db0-b5a5-f1509806079c.png">
 
 _(Find the Glances information widget [here](../info/glances.md))_
 
@@ -15,10 +17,14 @@ widget:
   url: http://glances.host.or.ip:port
   username: user # optional if auth enabled in Glances
   password: pass # optional if auth enabled in Glances
+  version: 4 # required only if running glances v4 or higher, defaults to 3
   metric: cpu
+  diskUnits: bytes # optional, bytes (default) or bbytes. Only applies to disk
+  refreshInterval: 5000 # optional - in milliseconds, defaults to 1000 or more, depending on the metric
+  pointsLimit: 15 # optional, defaults to 15
 ```
 
-_Please note, this widget does not need an `href`, `icon` or `description` on its parent service. To achive the same effect as the examples above, see as an example:_
+_Please note, this widget does not need an `href`, `icon` or `description` on its parent service. To achieve the same effect as the examples above, see as an example:_
 
 ```yaml
 - CPU Usage:
@@ -45,23 +51,23 @@ The metric field in the configuration determines the type of system monitoring d
 
 `process`: Top 5 processes based on CPU usage. Gives an overview of which processes are consuming the most resources.
 
-`network:<interface_name>`: Network data usage for the specified interface. Replace `<interface_name>` with the name of your network interface, e.g., `network:enp0s25`, as specificed in glances.
+`network:<interface_name>`: Network data usage for the specified interface. Replace `<interface_name>` with the name of your network interface, e.g., `network:enp0s25`, as specified in glances.
 
-`sensor:<sensor_id>`: Temperature of the specified sensor, typically used to monitor CPU temperature. Replace `<sensor_id>` with the name of your sensor, e.g., `sensor:Package id 0` as specificed in glances.
+`sensor:<sensor_id>`: Temperature of the specified sensor, typically used to monitor CPU temperature. Replace `<sensor_id>` with the name of your sensor, e.g., `sensor:Package id 0` as specified in glances.
 
-`disk:<disk_id>`: Disk I/O data for the specified disk. Replace `<disk_id>` with the id of your disk, e.g., `disk:sdb`, as specificed in glances.
+`disk:<disk_id>`: Disk I/O data for the specified disk. Replace `<disk_id>` with the id of your disk, e.g., `disk:sdb`, as specified in glances.
 
-`gpu:<gpu_id>`: GPU usage for the specified GPU. Replace `<gpu_id>` with the id of your GPU, e.g., `gpu:0`, as specificed in glances.
+`gpu:<gpu_id>`: GPU usage for the specified GPU. Replace `<gpu_id>` with the id of your GPU, e.g., `gpu:0`, as specified in glances.
 
-`fs:<mnt_point>`: Disk usage for the specified mount point. Replace `<mnt_point>` with the path of your disk, e.g., `/mnt/storage`, as specificed in glances.
+`fs:<mnt_point>`: Disk usage for the specified mount point. Replace `<mnt_point>` with the path of your disk, e.g., `/mnt/storage`, as specified in glances.
 
 ## Views
 
 All widgets offer an alternative to the full or "graph" view, which is the compact, or "graphless" view.
 
-<img width="970" alt="Screenshot 2023-09-06 at 1 51 48 PM" src="https://github.com/gethomepage/homepage-docs/assets/82196/cc6b9adc-4218-4274-96ca-36c3e64de5d0">
+<img width="970" alt="Screenshot 2023-09-06 at 1 51 48 PM" src="https://github-production-user-asset-6210df.s3.amazonaws.com/82196/265985295-cc6b9adc-4218-4274-96ca-36c3e64de5d0.png">
 
-To switch to the alternative "graphless" view, simply passs `chart: false` as an option to the widget, like so:
+To switch to the alternative "graphless" view, simply pass `chart: false` as an option to the widget, like so:
 
 ```yaml
 - Network Usage:

docs/widgets/services/gluetun.md

@@ -3,12 +3,16 @@ title: Gluetun
 description: Gluetun Widget Configuration
 ---
 
-Requires [HTTP control server options](https://github.com/qdm12/gluetun-wiki/blob/main/setup/advanced/control-server.md) to be enabled.
+Learn more about [Gluetun](https://github.com/qdm12/gluetun).
+
+!!! note
+
+    Requires [HTTP control server options](https://github.com/qdm12/gluetun-wiki/blob/main/setup/advanced/control-server.md) to be enabled. By default this runs on port `8000`.
 
 Allowed fields: `["public_ip", "region", "country"]`.
 
 ```yaml
 widget:
-    type: gluetun
-    url: http://gluetun.host.or.ip
+  type: gluetun
+  url: http://gluetun.host.or.ip:port
 ```

docs/widgets/services/gotify.md

@@ -3,13 +3,15 @@ title: Gotify
 description: Gotify Widget Configuration
 ---
 
+Learn more about [Gotify](https://github.com/gotify/server).
+
 Get a Gotify client token from an existing client or create a new one on your Gotify admin page.
 
 Allowed fields: `["apps", "clients", "messages"]`.
 
 ```yaml
 widget:
-    type: gotify
-    url: http://gotify.host.or.ip
-    key: clientoken
+  type: gotify
+  url: http://gotify.host.or.ip
+  key: clientoken
 ```

docs/widgets/services/grafana.md

@@ -3,12 +3,14 @@ title: Grafana
 description: Grafana Widget Configuration
 ---
 
+Learn more about [Grafana](https://github.com/grafana/grafana).
+
 Allowed fields: `["dashboards", "datasources", "totalalerts", "alertstriggered"]`.
 
 ```yaml
 widget:
-    type: grafana
-    url: http://grafana.host.or.ip:port
-    username: username
-    password: password
+  type: grafana
+  url: http://grafana.host.or.ip:port
+  username: username
+  password: password
 ```

docs/widgets/services/hdhomerun.md

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

docs/widgets/services/healthchecks.md

@@ -3,18 +3,23 @@ title: Health checks
 description: Health checks Widget Configuration
 ---
 
-To use the Health Checks widget, you first need to generate an API key. To do this, follow these steps:
+Learn more about [Health Checks](https://github.com/healthchecks/healthchecks).
 
-1. Go to Settings in your check dashboard.
+Specify a single check by including the `uuid` field or show the total 'up' and 'down' for all
+checks by leaving off the `uuid` field.
+
+To use the Health Checks widget, you first need to generate an API key.
+
+1. In your project, go to project Settings on the navigation bar.
 2. Click on API key (read-only) and then click _Create_.
 3. Copy the API key that is generated for you.
 
-Allowed fields: `["status", "last_ping"]`.
+Allowed fields: `["status", "last_ping"]` for single checks, `["up", "down"]` for total stats.
 
 ```yaml
 widget:
-    type: healthchecks
-    url: http://healthchecks.host.or.ip:port
-    key: <YOUR_API_KEY>
-    uuid: <YOUR_CHECK_UUID>
+  type: healthchecks
+  url: http://healthchecks.host.or.ip:port
+  key: <YOUR_API_KEY>
+  uuid: <CHECK_UUID> # optional, if not included total statistics for all checks is shown
 ```

docs/widgets/services/homeassistant.md

@@ -3,6 +3,8 @@ title: Home Assistant
 description: Home Assistant Widget Configuration
 ---
 
+Learn more about [Home Assistant](https://www.home-assistant.io/).
+
 You will need to generate a long-lived access token for an existing Home Assistant user in its profile.
 
 Allowed fields: `["people_home", "lights_on", "switches_on"]`.
@@ -12,25 +14,25 @@ Allowed fields: `["people_home", "lights_on", "switches_on"]`.
 Up to a maximum of four custom states and/or templates can be queried via the `custom` property like in the example below.
 The `custom` property will have no effect as long as the `fields` property is defined.
 
--   `state` will query the state of the specified `entity_id`
-    -   state labels and values can be user defined and may reference entity attributes in curly brackets
-    -   if no state label is defined it will default to `"{attributes.friendly_name}"`
-    -   if no state value is defined it will default to `"{state} {attributes.unit_of_measurement}"`
--   `template` will query the specified template, see (Home Assistant Templating)[https://www.home-assistant.io/docs/configuration/templating]
-    -   if no template label is defined it will be empty
+- `state` will query the state of the specified `entity_id`
+  - state labels and values can be user defined and may reference entity attributes in curly brackets
+  - if no state label is defined it will default to `"{attributes.friendly_name}"`
+  - if no state value is defined it will default to `"{state} {attributes.unit_of_measurement}"`
+- `template` will query the specified template, see [Home Assistant Templating](https://www.home-assistant.io/docs/configuration/templating)
+  - if no template label is defined it will be empty
 
 ```yaml
 widget:
-    type: homeassistant
-    url: http://homeassistant.host.or.ip:port
-    key: access_token
-    custom:
-        - state: sensor.total_power
-        - state: sensor.total_energy_today
-          label: energy today
-        - template: "{{ states.switch|selectattr('state','equalto','on')|list|length }}"
-          label: switches on
-        - state: weather.forecast_home
-          label: wind speed
-          value: "{attributes.wind_speed} {attributes.wind_speed_unit}"
+  type: homeassistant
+  url: http://homeassistant.host.or.ip:port
+  key: access_token
+  custom:
+    - state: sensor.total_power
+    - state: sensor.total_energy_today
+      label: energy today
+    - template: "{{ states.switch|selectattr('state','equalto','on')|list|length }}"
+      label: switches on
+    - state: weather.forecast_home
+      label: wind speed
+      value: "{attributes.wind_speed} {attributes.wind_speed_unit}"
 ```

docs/widgets/services/homebox.md

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

docs/widgets/services/homebridge.md

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

docs/widgets/services/iframe.md

@@ -0,0 +1,35 @@
+---
+title: iFrame
+Description: Add a custom iFrame Widget
+---
+
+A basic iFrame widget to show external content, see the [MDN docs](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe) for more details about some of the options.
+
+!!! warning
+
+    Requests made via the iFrame widget are inherently **not proxied** as they are made from the browser itself.
+
+## Basic Example
+
+```yaml
+widget:
+  type: iframe
+  name: myIframe
+  src: http://example.com
+```
+
+## Full Example
+
+```yaml
+widget:
+  type: iframe
+  name: myIframe
+  src: http://example.com
+  classes: h-60 sm:h-60 md:h-60 lg:h-60 xl:h-60 2xl:h-72 # optional, use tailwind height classes, see https://tailwindcss.com/docs/height
+  referrerPolicy: same-origin # optional, no default
+  allowPolicy: autoplay; fullscreen; gamepad # optional, no default
+  allowFullscreen: false # optional, default: true
+  loadingStrategy: eager # optional, default: eager
+  allowScrolling: no # optional, default: yes
+  refreshInterval: 2000 # optional, no default
+```

docs/widgets/services/immich.md

@@ -3,13 +3,17 @@ title: Immich
 description: Immich Widget Configuration
 ---
 
+Learn more about [Immich](https://github.com/immich-app/immich).
+
+Find your API key under `Account Settings > API Keys`.
+
 Allowed fields: `["users" ,"photos", "videos", "storage"]`.
 
 Note that API key must be from admin user.
 
 ```yaml
 widget:
-    type: immich
-    url: http://immich.host.or.ip
-    key: adminapikeyadminapikeyadminapikey
+  type: immich
+  url: http://immich.host.or.ip
+  key: adminapikeyadminapikeyadminapikey
 ```

docs/widgets/services/jackett.md

@@ -3,12 +3,15 @@ title: Jackett
 description: Jackett Widget Configuration
 ---
 
-Jackett must not have any authentication for the widget to work.
+Learn more about [Jackett](https://github.com/Jackett/Jackett).
+
+If Jackett has an admin password set, you must set the `password` field for the widget to work.
 
 Allowed fields: `["configured", "errored"]`.
 
 ```yaml
 widget:
-    type: jackett
-    url: http://jackett.host.or.ip
+  type: jackett
+  url: http://jackett.host.or.ip
+  password: jackettadminpassword # optional
 ```

docs/widgets/services/jdownloader.md

@@ -3,14 +3,16 @@ title: JDownloader
 description: NextPVR Widget Configuration
 ---
 
+Learn more about [JDownloader](https://jdownloader.org/).
+
 Basic widget to show number of items in download queue, along with the queue size and current download speed.
 
 Allowed fields: `["downloadCount", "downloadTotalBytes","downloadBytesRemaining", "downloadSpeed"]`.
 
 ```yaml
 widget:
-    type: jdownloader
-    username: JDownloader Username
-    password: JDownloader Password
-    client: Name of JDownloader Instance
+  type: jdownloader
+  username: JDownloader Username
+  password: JDownloader Password
+  client: Name of JDownloader Instance
 ```

docs/widgets/services/jellyfin.md

@@ -3,15 +3,20 @@ title: Jellyfin
 description: Jellyfin Widget Configuration
 ---
 
+Learn more about [Jellyfin](https://github.com/jellyfin/jellyfin).
+
 You can create an API key from inside Jellyfin at `Settings > Advanced > Api Keys`.
 
 As of v0.6.11 the widget supports fields `["movies", "series", "episodes", "songs"]`. These blocks are disabled by default but can be enabled with the `enableBlocks` option, and the "Now Playing" feature (enabled by default) can be disabled with the `enableNowPlaying` option.
 
 ```yaml
 widget:
-    type: jellyfin
-    url: http://jellyfin.host.or.ip
-    key: apikeyapikeyapikeyapikeyapikey
-    enableBlocks: true # optional, defaults to false
-    enableNowPlaying: true # optional, defaults to true
+  type: jellyfin
+  url: http://jellyfin.host.or.ip
+  key: apikeyapikeyapikeyapikeyapikey
+  enableBlocks: true # optional, defaults to false
+  enableNowPlaying: true # optional, defaults to true
+  enableUser: true # optional, defaults to false
+  showEpisodeNumber: true # optional, defaults to false
+  expandOneStreamToTwoRows: false # optional, defaults to true
 ```

docs/widgets/services/jellyseerr.md

@@ -3,13 +3,15 @@ title: Jellyseerr
 description: Jellyseerr Widget Configuration
 ---
 
+Learn more about [Jellyseerr](https://github.com/Fallenbagel/jellyseerr).
+
 Find your API key under `Settings > General > API Key`.
 
 Allowed fields: `["pending", "approved", "available"]`.
 
 ```yaml
 widget:
-    type: jellyseerr
-    url: http://jellyseerr.host.or.ip
-    key: apikeyapikeyapikeyapikeyapikey
+  type: jellyseerr
+  url: http://jellyseerr.host.or.ip
+  key: apikeyapikeyapikeyapikeyapikey
 ```

docs/widgets/services/kavita.md

@@ -3,14 +3,16 @@ title: Kavita
 description: Kavita Widget Configuration
 ---
 
-Uses the same username and password used to login from the web.
+Learn more about [Kavita](https://github.com/Kareadita/Kavita).
+
+Uses the same admin role username and password used to login from the web.
 
 Allowed fields: `["seriesCount", "totalFiles"]`.
 
 ```yaml
 widget:
-    type: kavita
-    url: http://kavita.host.or.ip:port
-    username: username
-    password: password
+  type: kavita
+  url: http://kavita.host.or.ip:port
+  username: username
+  password: password
 ```

docs/widgets/services/komga.md

@@ -3,14 +3,16 @@ title: Komga
 description: Komga Widget Configuration
 ---
 
+Learn more about [Komga](https://github.com/gotson/komga).
+
 Uses the same username and password used to login from the web.
 
 Allowed fields: `["libraries", "series", "books"]`.
 
 ```yaml
 widget:
-    type: komga
-    url: http://komga.host.or.ip:port
-    username: username
-    password: password
+  type: komga
+  url: http://komga.host.or.ip:port
+  username: username
+  password: password
 ```

docs/widgets/services/kopia.md

@@ -3,16 +3,18 @@ title: Kopia
 description: Kopia Widget Configuration
 ---
 
+Learn more about [Kopia](https://github.com/kopia/kopia).
+
 Allowed fields: `["status", "size", "lastrun", "nextrun"]`.
 
 You may optionally pass values for `snapshotHost` and / or `snapshotPath` to select a specific backup source for the widget.
 
 ```yaml
 widget:
-    type: kopia
-    url: http://kopia.host.or.ip:port
-    username: username
-    password: password
-    snapshotHost: hostname # optional
-    snapshotPath: path # optional
+  type: kopia
+  url: http://kopia.host.or.ip:port
+  username: username
+  password: password
+  snapshotHost: hostname # optional
+  snapshotPath: path # optional
 ```

docs/widgets/services/lidarr.md

@@ -3,13 +3,15 @@ title: Lidarr
 description: Lidarr Widget Configuration
 ---
 
+Learn more about [Lidarr](https://github.com/Lidarr/Lidarr).
+
 Find your API key under `Settings > General`.
 
 Allowed fields: `["wanted", "queued", "artists"]`.
 
 ```yaml
 widget:
-    type: lidarr
-    url: http://lidarr.host.or.ip
-    key: apikeyapikeyapikeyapikeyapikey
+  type: lidarr
+  url: http://lidarr.host.or.ip
+  key: apikeyapikeyapikeyapikeyapikey
 ```

docs/widgets/services/mastodon.md

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

docs/widgets/services/mealie.md

@@ -3,13 +3,15 @@ title: Mealie
 description: Mealie Widget Configuration
 ---
 
+Learn more about [Mealie](https://github.com/mealie-recipes/mealie).
+
 Generate a user API key under `Profile > Manage Your API Tokens > Generate`.
 
 Allowed fields: `["recipes", "users", "categories", "tags"]`.
 
 ```yaml
 widget:
-    type: mealie
-    url: http://mealie-frontend.host.or.ip
-    key: mealieapitoken
+  type: mealie
+  url: http://mealie-frontend.host.or.ip
+  key: mealieapitoken
 ```

docs/widgets/services/medusa.md

@@ -3,11 +3,13 @@ title: Medusa
 description: Medusa Widget Configuration
 ---
 
+Learn more about [Medusa](https://github.com/pymedusa/Medusa).
+
 Allowed fields: `["wanted", "queued", "series"]`.
 
 ```yaml
 widget:
-    type: medusa
-    url: http://medusa.host.or.ip:port
-    key: medusaapikeyapikeyapikeyapikeyapikey
+  type: medusa
+  url: http://medusa.host.or.ip:port
+  key: medusaapikeyapikeyapikeyapikeyapikey
 ```

docs/widgets/services/mikrotik.md

@@ -9,8 +9,8 @@ Allowed fields: `["uptime", "cpuLoad", "memoryUsed", "numberOfLeases"]`.
 
 ```yaml
 widget:
-    type: mikrotik
-    url: https://mikrotik.host.or.ip
-    username: username
-    password: password
+  type: mikrotik
+  url: https://mikrotik.host.or.ip
+  username: username
+  password: password
 ```