New Crowdin translations by GitHub Action (#3758)

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"

.editorconfig

@@ -11,3 +11,6 @@ charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 max_line_length = 120
+
+[*.md]
+trim_trailing_whitespace = false

.eslintrc.json

@@ -13,6 +13,12 @@
       {
         "newlines-between": "always"
       }
+    ],
+    "no-else-return": [
+      "error",
+      {
+        "allowElseIf": true
+      }
     ]
   },
   "settings": {

.github/DISCUSSION_TEMPLATE/support.yml

@@ -0,0 +1,56 @@
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ### ⚠️ Before opening a discussion:
+
+        - [Check the troubleshooting guide](https://gethomepage.dev/latest/troubleshooting/).
+        - [Search 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 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,3 @@
-github: benphelps
-ko_fi: benphelps
-custom: ["https://paypal.me/phelpsben"]
+github: [gethomepage]
+open_collective: homepage
+patreon: gethomepage

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,94 +1,33 @@
-name: Bug report
-description: Create a report to help us improve
-title: "[Bug] "
-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: |
-        Have a question? 👉 [Start a new discussion](https://github.com/benphelps/homepage/discussions/new) or [ask in chat](https://discord.gg/SaPGSzrEZC).
-
-        Before opening an issue, please double check:
-
-        - [The troubleshooting guide](https://gethomepage.dev/en/more/troubleshooting/).
-        - [The homepage documentation](https://gethomepage.dev/)
-        - [Existing issues](https://github.com/benphelps/homepage/search?q=&type=issues) and [discussions](https://github.com/benphelps/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/en/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 asked that I open an issue.
           required: true
-        - label: Follow [the troubleshooting guide](https://gethomepage.dev/en/more/troubleshooting/) (please include output above if applicable).
-          required: true
-        - label: Search [existing issues](https://github.com/benphelps/homepage/search?q=&type=issues) and [discussions](https://github.com/benphelps/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

@@ -1,11 +1,11 @@
 blank_issues_enabled: false
 contact_links:
   - name: 🤔 Questions and Help
-    url: https://github.com/benphelps/homepage/discussions
-    about: This issue tracker is for bugs only, not general support questions. Please refer to our Discussions.
+    url: https://github.com/gethomepage/homepage/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.
   - name: 🚀 Feature Request
-    url: https://github.com/benphelps/homepage/discussions/new?category=feature-requests
+    url: https://github.com/gethomepage/homepage/discussions/new?category=feature-requests
     about: Remember to search for existing feature requests and "up-vote" any you like

.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/en/more/development/#service-widget-guidelines
+*** 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 as a PR 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)
@@ -20,11 +20,12 @@ What type of change does your PR introduce to Homepage?
 - [ ] New service widget
 - [ ] Bug fix (non-breaking change which fixes an issue)
 - [ ] New feature (non-breaking change which adds functionality)
+- [ ] Documentation only
 - [ ] Other (please explain)
 
 ## Checklist:
 
-- [ ] If adding a service widget or a change that requires it, I have added a corresponding PR to the [documentation](https://github.com/benphelps/homepage-docs) here: 
-- [ ] If adding a new widget I have reviewed the [guidelines](https://gethomepage.dev/en/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,11 +9,20 @@ on:
   schedule:
     - cron: '20 0 * * *'
   push:
-    branches: [ "main" ]
+    branches:
+      - main
+      - feature/**
     # Publish semver tags as releases.
     tags: [ 'v*.*.*' ]
+    paths-ignore:
+      - 'docs/**'
+      - 'mkdocs.yml'
   pull_request:
     branches: [ "main" ]
+    paths-ignore:
+      - 'docs/**'
+      - 'mkdocs.yml'
+  merge_group:
 
 env:
   # Use docker.io for Docker Hub if empty
@@ -23,9 +32,28 @@ env:
 
 
 jobs:
-  build:
+  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
@@ -35,7 +63,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       # Install the cosign tool except on PR
       # https://github.com/sigstore/cosign-installer
@@ -48,12 +76,12 @@ jobs:
       # Setup QEMU
       # https://github.com/marketplace/actions/docker-setup-buildx#with-qemu
       - name: Setup QEMU
-        uses: docker/setup-qemu-action@v2
-      
+        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@v2
-        
+        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
@@ -68,7 +96,7 @@ jobs:
       # https://github.com/docker/login-action
       - name: Log into registry ${{ env.REGISTRY }}
         if: github.event_name != 'pull_request'
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           registry: ${{ env.REGISTRY }}
           username: ${{ github.actor }}
@@ -78,7 +106,7 @@ jobs:
       # https://github.com/docker/metadata-action
       - name: Extract Docker metadata
         id: meta
-        uses: docker/metadata-action@v4
+        uses: docker/metadata-action@v5
         with:
           images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
           flavor: |
@@ -88,10 +116,10 @@ jobs:
       # https://github.com/docker/build-push-action
       - name: Build and push Docker image
         id: build-and-push
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v6
         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

@@ -0,0 +1,98 @@
+name: Docs
+
+on:
+  push:
+    tags: ["v*.*.*"]
+    branches: ["main"]
+    paths:
+      - "docs/**"
+      - "mkdocs.yml"
+  pull_request:
+    paths:
+      - "docs/**"
+      - "mkdocs.yml"
+  merge_group:
+  workflow_dispatch:
+
+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@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $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 mkdocs-material mkdocs-redirects "mkdocs-material[imaging]"
+      - name: Test Docs Build
+        run: MKINSIDERS=false mkdocs build
+  deploy:
+    name: Build & Deploy
+    if: github.repository == 'gethomepage/homepage' && github.event_name != 'pull_request'
+    runs-on: ubuntu-latest
+    needs:
+      - pre-commit
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: main
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - 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==2.0.0
+      - run: pip install git+https://${GH_TOKEN}@github.com/benphelps/mkdocs-material-insiders.git
+      - run: pip install mkdocs-redirects "mkdocs-material[imaging]"
+      - name: Set Git config
+        run: |
+          git config --global user.name "GitHub Action"
+          git config --global user.email "action@github.com"
+      - name: Sync gh-pages
+        run: |
+          git fetch origin gh-pages
+          git checkout gh-pages
+          git pull origin gh-pages
+          git checkout main
+      - name: Docs Deploy for Main
+        if: github.ref == 'refs/heads/main'
+        run: MKINSIDERS=true mike deploy --update --push ${{github.ref_name}}
+      - name: Docs Deploy for Tags
+        if: github.ref != 'refs/heads/main'
+        run: MKINSIDERS=true mike deploy --update --push ${{github.ref_name}} latest
+env:
+  GH_TOKEN: ${{ secrets.GH_TOKEN }}

.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);
+              }
+            }

.gitignore

@@ -46,4 +46,9 @@ next-env.d.ts
 # IDEs
 /.idea/
 
+# MkDocs documentation
+site*/
+.cache/
 
+# venv
+.venv/

.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 @@
+{}

.vscode/launch.json

@@ -16,4 +16,4 @@
       }
     }
   ]
-}
+}

.vscode/settings.json

@@ -2,5 +2,18 @@
     "files.exclude": {
         "**/.next": true,
         "**/node_modules": true
-    }
-}
+    },
+    "yaml.schemas": {
+        "https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
+    },
+    "yaml.customTags": [
+        "!ENV scalar",
+        "!ENV sequence",
+        "tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg",
+        "tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji",
+        "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format"
+    ],
+    "[python]": {
+        "editor.defaultFormatter": "ms-python.autopep8"
+    },
+}

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/benphelps/homepage/issues)
-We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/benphelps/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/en/more/development/) and specifically the [guidelines for new service widgets](https://gethomepage.dev/en/more/development/#service-widget-guidelines) if you are considering making one.
+
+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.

Dockerfile

@@ -36,9 +36,9 @@ RUN npm run telemetry \
 FROM docker.io/node:18-alpine AS runner
 LABEL org.opencontainers.image.title "Homepage"
 LABEL org.opencontainers.image.description "A self-hosted services landing page, with docker and service integrations."
-LABEL org.opencontainers.image.url="https://github.com/benphelps/homepage"
-LABEL org.opencontainers.image.documentation='https://github.com/benphelps/homepage/wiki'
-LABEL org.opencontainers.image.source='https://github.com/benphelps/homepage'
+LABEL org.opencontainers.image.url="https://github.com/gethomepage/homepage"
+LABEL org.opencontainers.image.documentation='https://github.com/gethomepage/homepage/wiki'
+LABEL org.opencontainers.image.source='https://github.com/gethomepage/homepage'
 LABEL org.opencontainers.image.licenses='Apache-2.0'
 
 ENV NODE_ENV production

README.md

@@ -6,99 +6,109 @@
 </p>
 
 <p align="center">
-  A modern <em>(fully static, fast)</em>, secure <em>(fully proxied)</em>, highly customizable application dashboard with integrations for more than 25 services and translations for over 15 languages. Easily configured via YAML files (or discovery via docker labels).
+  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.
 </p>
 
 <p align="center">
-  <img src="images/1.png" />
+  <img src="images/1.png?v=2" />
 </p>
 
 <p align="center">
-  <img src="images/2.png" width="19%" />
-  <img src="images/3.png" width="19%" />
-  <img src="images/4.png" width="19%" />
-  <img src="images/5.png" width="19%" />
-  <img src="images/6.png" width="19%" />
+  <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://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://discord.gg/k4ruYNrudu"><img src="https://img.shields.io/badge/Discord - Chat-blue?logo=discord&logoColor=white" /></a>
-  <a href="https://paypal.me/phelpsben" title="Donate"><img src="https://img.shields.io/badge/PayPal - Donate-blue?logo=paypal&logoColor=white" alt="Linkedin - phelpsben"></a>
+  <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">
-  <a href="https://github.com/benphelps/homepage/actions/workflows/docker-publish.yml"><img src="https://github.com/benphelps/homepage/actions/workflows/docker-publish.yml/badge.svg" alt="Docker"></a>
-  <a href="https://hosted.weblate.org/engage/homepage/"><img src="https://hosted.weblate.org/widgets/homepage/-/homepage/svg-badge.svg" alt="Weblate"></a>
+<em>Homepage builds are kindly powered by DigitalOcean.</em>
 </p>
 
-## Features
+# Features
 
-- **Fast!** The entire site is statically generated at build time, so you can expect instant load times
-- **Secure!** Every API request to backend services goes through a proxy server, so your API keys are never exposed to the frontend client.
-- Images built for AMD64 (x86_64), ARM64, ARMv7 and ARMv6
-  - Supports all Raspberry Pi's, most SBCs & Apple Silicon
-- Full i18n support with translations for Catalan, Chinese, Dutch, Finnish, French, German, Hebrew, Hungarian, Malay, Norwegian Bokmål, Polish, Portuguese, Portuguese (Brazil), Romanian, Russian, Spanish, Swedish and Yue
-  - Want to help translate? [Join the Weblate project](https://hosted.weblate.org/engage/homepage/)
-- Service & Web Bookmarks
-- Docker Integration
-  - Container status (Running / Stopped) & statistics (CPU, Memory, Network)
-  - Automatic service discovery (via labels)
-- Service Integration
-  - Sonarr, Radarr, Readarr, Prowlarr, Bazarr, Lidarr, Emby, Jellyfin, Tautulli, Plex and more
-  - Ombi, Overseerr, Jellyseerr, Jackett, NZBGet, SABnzbd, ruTorrent, Transmission, qBittorrent and more
-  - Portainer, Traefik, Speedtest Tracker, PiHole, AdGuard Home, Nginx Proxy Manager, Gotify, Syncthing Relay Server, Authentik, Proxmox and more
-- Information Providers
-  - Coin Market Cap, Mastodon and more
-- Information & Utility Widgets
-  - System Stats (Disk, CPU, Memory)
-  - Weather via [OpenWeatherMap](https://openweathermap.org/) or [Open-Meteo](https://open-meteo.com/)
-  - Web Search Bar
-  - UniFi Console, Glances and more
-- Instant "Quick-launch" search
-- Customizable
-  - 21 theme colors with light and dark mode support
-  - Background image support
-  - Column and Row layout options
+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.
 
-## Support & Suggestions
+- **Fast** - The site is statically generated at build time for instant load times.
+- **Secure** - All API requests to backend services are proxied, keeping your API keys hidden. Constantly reviewed for security by the community.
+- **For Everyone** - Images built for AMD64, ARM64, ARMv7, and ARMv6.
+- **Full i18n** - Support for over 40 languages.
+- **Service & Web Bookmarks** - Add custom links to the homepage.
+- **Docker Integration** - Container status and stats. Automatic service discovery via labels.
+- **Service Integration** - Over 100 service integrations, including popular starr and self-hosted apps.
+- **Information & Utility Widgets** - Weather, time, date, search, and more.
+- **And much more...**
 
-If you have any questions, suggestions, or general issues, please start a discussion on the [Discussions](https://github.com/benphelps/homepage/discussions) page.
+## Docker Integration
 
-For bug reports, please open an issue on the [Issues](https://github.com/benphelps/homepage/issues) page.
+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.
 
-## Getting Started
+## Service Widgets
 
-For configuration options, examples and more, [please check out the homepage site](http://gethomepage.dev).
+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.
 
-### With Docker
+## Information Widgets
+
+Homepage has built-in support for a number of information providers, including weather, time, date, search, glances and more. System and status information presented at the top of the page. See the [Information Providers](https://gethomepage.dev/latest/widgets/) page for more information.
+
+## Customization
+
+Homepage is highly customizable, with support for custom themes, custom CSS & JS, custom layouts, formatting, localization and more. See the [Settings](https://gethomepage.dev/latest/configs/settings/) page for more information.
+
+# Getting Started
+
+For configuration options, examples and more, [please check out the homepage documentation](http://gethomepage.dev).
+
+## Security Notice 🔒
+
+Please note that when using features such as widgets, Homepage can access personal information (for example from your home automation system) and Homepage currently does not (and is not planned to) include any authentication layer itself. Thus, we recommend homepage be deployed behind a reverse proxy including authentication, SSL etc, and / or behind a VPN.
+
+## With Docker
 
 Using docker compose:
 
 ```yaml
-version: "3.3"
 services:
   homepage:
-    image: ghcr.io/benphelps/homepage:latest
+    image: ghcr.io/gethomepage/homepage:latest
     container_name: homepage
+    environment:
+      PUID: 1000 # optional, your user id
+      PGID: 1000 # optional, your group id
     ports:
       - 3000:3000
     volumes:
       - /path/to/config:/app/config # Make sure your local config directory exists
-      - /var/run/docker.sock:/var/run/docker.sock:ro # (optional) For docker integrations
+      - /var/run/docker.sock:/var/run/docker.sock:ro # optional, for docker integrations
+    restart: unless-stopped
 ```
 
 or docker run:
 
 ```bash
-docker run -p 3000:3000 -v /path/to/config:/app/config -v /var/run/docker.sock:/var/run/docker.sock ghcr.io/benphelps/homepage:latest
+docker run --name homepage \
+  -e PUID=1000 \
+  -e PGID=1000 \
+  -p 3000:3000 \
+  -v /path/to/config:/app/config \
+  -v /var/run/docker.sock:/var/run/docker.sock:ro \
+  --restart unless-stopped \
+  ghcr.io/gethomepage/homepage:latest
 ```
 
-### With Node
+## From Source
 
 First, clone the repository:
 
 ```bash
-git clone https://github.com/benphelps/homepage.git
+git clone https://github.com/gethomepage/homepage.git
 ```
 
 Then install dependencies and build the production bundle (I'm using pnpm here, you can use npm or yarn if you like):
@@ -110,22 +120,17 @@ pnpm build
 
 If this is your first time starting, copy the `src/skeleton` directory to `config/` to populate initial example config files.
 
-Finally, run the server:
+Finally, run the server in production mode:
 
 ```bash
 pnpm start
 ```
 
-## Configuration
+# Configuration
 
-Configuration files will be generated and placed on the first request.
+Please refer to the [homepage documentation website](https://gethomepage.dev/) for more information. Everything you need to know about configuring Homepage is there. Please read everything carefully before asking for help, as most questions are answered there or are simple YAML configuration issues.
 
-Configuration is done in the /config directory using .yaml files. Refer to each config for
-the specific configuration options.
-
-You may also check [the homepage site](http://gethomepage.dev) for detailed configuration instructions, examples and more.
-
-## Development
+# Development
 
 Install NPM packages, this project uses [pnpm](https://pnpm.io/) (and so should you!):
 
@@ -141,21 +146,36 @@ pnpm dev
 
 Open [http://localhost:3000](http://localhost:3000) to start.
 
-This is a [Next.js](https://nextjs.org/) application, see their documentation for more information:
+This is a [Next.js](https://nextjs.org/) application, see their documentation for more information.
 
-## Contributors
+# Documentation
 
-<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
-<!-- prettier-ignore-start -->
-<!-- markdownlint-disable -->
+The homepage documentation is available at [https://gethomepage.dev/](https://gethomepage.dev/).
 
-<!-- markdownlint-restore -->
-<!-- prettier-ignore-end -->
+Homepage uses Material for MkDocs for documentation. To run the documentation locally, first install the dependencies:
 
-<!-- ALL-CONTRIBUTORS-LIST:END -->
+```bash
+pip install -r requirements.txt
+```
 
+Then run the development server:
 
+```bash
+mkdocs serve # or build, to build the static site
+```
 
-<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-13-orange.svg?style=flat-square)](#contributors)
-<!-- ALL-CONTRIBUTORS-BADGE:END -->
+# Support & Suggestions
+
+If you have any questions, suggestions, or general issues, please start a discussion on the [Discussions](https://github.com/gethomepage/homepage/discussions) page.
+
+## Troubleshooting
+
+In addition to the docs, the [troubleshooting guide](https://gethomepage.dev/latest/troubleshooting/) can help reveal many basic config or network issues. If you're having a problem, it's a good place to start.
+
+## Contributing & Contributors
+
+Contributions are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information.
+
+Thanks to the over 200 contributors who have helped make this project what it is today!
+
+Especially huge thanks to [@shamoon](https://github.com/shamoon), who has been the backbone of this community from the very start.

crowdin.yml

@@ -0,0 +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/assets/custom.css

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

docs/configs/bookmarks.md

@@ -0,0 +1,37 @@
+---
+title: Bookmarks
+description: Bookmark Configuration
+---
+
+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.
+
+You can also use an icon for bookmarks similar to the [options for service icons](services.md#icons). If both icon and abbreviation are supplied, the icon takes precedence.
+
+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/
+
+- Social:
+    - Reddit:
+        - icon: reddit.png
+          href: https://reddit.com/
+          description: The front page of the internet
+
+- Entertainment:
+    - 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/custom-css-js.md

@@ -0,0 +1,17 @@
+---
+title: Custom CSS & JS
+description: Adding Custom CSS or JS
+---
+
+As of version v0.6.30 homepage supports adding your own custom css & javascript. Please do so **at your own risk**.
+
+To add custom css simply edit the `custom.css` file under your config directory, similarly for javascript you would edit `custom.js`. You can then target elements in homepage with various classes / ids to customize things to your liking.
+
+You can also set a specific `id` for a service or bookmark to target with your custom css or javascript, e.g.
+
+```yaml
+Service:
+    id: myserviceid
+    icon: icon.png
+    ...
+```

docs/configs/docker.md

@@ -0,0 +1,238 @@
+---
+title: Docker
+description: Docker Configuration
+---
+
+Docker instances are configured inside the `docker.yaml` file. Both IP:PORT and Socket connections are supported.
+
+For IP:PORT, simply make sure your Docker instance [has been configured](https://gist.github.com/styblope/dc55e0ad2a9848f2cc3307d4819d819f) to accept API traffic over the HTTP API.
+
+```yaml
+my-remote-docker:
+  host: 192.168.0.101
+  port: 2375
+```
+
+## Using Docker TLS
+
+Since Docker supports connecting with TLS and client certificate authentication, you can include TLS details when connecting to the HTTP API. Further details of setting up Docker to accept TLS connections, and generation of the keys and certs can be found [in the Docker documentation](https://docs.docker.com/engine/security/protect-access/#use-tls-https-to-protect-the-docker-daemon-socket). The file entries are relative to the `config` directory (location of `docker.yaml` file).
+
+```yaml
+my-remote-docker:
+  host: 192.168.0.101
+  port: 275
+  tls:
+    keyFile: tls/key.pem
+    caFile: tls/ca.pem
+    certFile: tls/cert.pem
+```
+
+## Using Docker Socket Proxy
+
+Due to security concerns with exposing the docker socket directly, you can use a [docker-socket-proxy](https://github.com/Tecnativa/docker-socket-proxy) container to expose the docker socket on a more restricted and secure API.
+
+Here is an example docker-compose file that will expose the docker socket, and then connect to it from the homepage container:
+
+```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
+
+homepage:
+  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
+```
+
+## Using Socket Directly
+
+If you'd rather use the socket directly, first make sure that you're passing the local socket into the Docker container.
+
+!!! note
+
+    In order to use the socket directly homepage must be running as root
+
+```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
+```
+
+If you're using `docker run`, this would be `-v /var/run/docker.sock:/var/run/docker.sock`.
+
+Then, inside of your `docker.yaml` settings file, you'd configure the docker instance like so:
+
+```yaml
+my-docker:
+  socket: /var/run/docker.sock
+```
+
+## Services
+
+Once you've configured your docker instances, you can then apply them to your services, to get stats and status reporting shown.
+
+Inside of the service you'd like to connect to docker:
+
+```yaml
+- Emby:
+  icon: emby.png
+  href: "http://emby.home/"
+  description: Media server
+  server: my-docker # The docker server that was configured
+  container: emby # The name of the container you'd like to connect
+```
+
+## Automatic Service Discovery
+
+Homepage features automatic service discovery for containers with the proper labels attached, all configuration options can be applied using dot notation, beginning with `homepage`.
+
+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
+```
+
+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.**
+
+**When using docker swarm use _deploy/labels_**
+
+## Widgets
+
+You may also configure widgets, along with the standard service entry, again, using 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=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
+
+Docker swarm is supported and Docker services are specified with the same `server` and `container` notation. To enable swarm support you will need to include a `swarm` setting in your docker.yaml, e.g.
+
+```yaml
+my-docker:
+  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.
+
+```yaml
+....
+  deploy:
+    placement:
+      constraints:
+        - node.role == manager
+...
+```
+
+In order to detect every service within the Docker swarm it is necessary that service labels should be used and not container labels. Specify the homepage labels as:
+
+```yaml
+....
+  deploy:
+    labels:
+      - homepage.icon=foobar
+...
+```
+
+## Multiple Homepage Instances
+
+The optional field `instanceName` can be configured in [settings.yaml](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
+
+## Show stats
+
+You can show the docker stats by clicking the status indicator but this can also be controlled per-service with:
+
+```yaml
+- Example Service:
+  ...
+  showStats: true
+```
+
+Also see the settings for [show docker stats](settings.md#show-docker-stats).

docs/configs/index.md

@@ -0,0 +1,17 @@
+---
+title: Configuration
+description: Homepage Configuration
+icon: material/cog
+---
+
+Homepage uses YAML for configuration, YAML stands for "YAML Ain't Markup Language.". It's a human-readable data serialization format that's a superset of JSON. Great for config files, easy to read and write. Supports complex data types like lists and objects. **Indentation matters.** If you already use Docker Compose, you already use YAML.
+
+Here are some tips when writing YAML:
+
+1. **Use Indentation Carefully**: YAML relies on indentation, not brackets.
+2. Avoid Tabs: Stick to spaces for indentation to avoid parsing errors. 2 spaces are common.
+3. Quote Strings: Use single or double quotes for strings with special characters, this is especially important for API keys.
+4. Key-Value Syntax: Use key: value format. Colon must be followed by a space.
+5. Validate: Always validate your YAML with a linter before deploying.
+
+You can find tons of online YAML validators, here's one: [https://codebeautify.org/yaml-validator](https://codebeautify.org/yaml-validator), heres another: [https://jsonformatter.org/yaml-validator](https://jsonformatter.org/yaml-validator).

docs/configs/kubernetes.md

@@ -0,0 +1,145 @@
+---
+title: Kubernetes
+description: Kubernetes Configuration
+---
+
+The Kubernetes connectivity has the following requirements:
+
+- 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
+
+```yaml
+mode: default
+```
+
+## Services
+
+Once the Kubernetes connection is configured, individual services can be configured to pull statistics. Only CPU and Memory are currently supported.
+
+Inside of the service you'd like to connect to a pod:
+
+```yaml
+- Emby:
+  icon: emby.png
+  href: "http://emby.home/"
+  description: Media server
+  namespace: media # The kubernetes namespace the app resides in
+  app: emby # The name of the deployed app
+```
+
+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.
+
+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
+      )
+```
+
+!!! 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.
+
+## Automatic Service Discovery
+
+Homepage features automatic service discovery by Ingress annotations. All configuration options can be applied using typical annotation syntax, beginning with `gethomepage.dev/`.
+
+```yaml
+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/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
+```
+
+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.
+
+If you have a single service that needs to be shown on multiple specific instances of homepage (but not on all of them), the service can be annotated by multiple `instance.name` annotations, where `name` can be the names of your specific multiple homepage instances. For example, a service that is annotated with `gethomepage.dev/instance.public: ""` and `gethomepage.dev/instance.internal: ""` will be shown on `public` and `internal` homepage instances.
+
+### 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:
+
+```yaml
+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/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
+```
+
+If the `href` attribute is not present, Homepage will ignore the specific IngressRoute.
+
+## Caveats
+
+Similarly to Docker service discovery, there currently is no rigid ordering to discovered services and discovered services will be displayed above those specified in the `services.yaml`.

docs/configs/service-widgets.md

@@ -0,0 +1,40 @@
+---
+title: Service Widgets
+description: Service Widget Configuration
+---
+
+Unless otherwise noted, URLs should not end with a `/` or other API path. Each widget will handle the path on its own.
+
+Each service can have one widget attached to it (often matching the service type, but that's not forced).
+
+In addition to the href of the service, you can also specify the target location in which to open that link. See [Link Target](settings.md#link-target) for more details.
+
+Using Emby as an example, this is how you would attach the Emby service widget.
+
+```yaml
+- Emby:
+    icon: emby.png
+    href: http://emby.host.or.ip/
+    description: Movies & TV Shows
+    widget:
+      type: emby
+      url: http://emby.host.or.ip
+      key: apikeyapikeyapikeyapikeyapikey
+```
+
+## Field Visibility
+
+Each widget can optionally provide a list of which fields should be visible via the `fields` widget property. If no fields are specified, then all fields will be displayed. The `fields` property must be a valid YAML array of strings. As an example, here is the entry for Sonarr showing only a couple of fields.
+
+**In all cases a widget will work and display all fields without specifying the `fields` property.**
+
+```yaml
+- Sonarr:
+    icon: sonarr.png
+    href: http://sonarr.host.or.ip
+    widget:
+      type: sonarr
+      fields: ["wanted", "queued"]
+      url: http://sonarr.host.or.ip
+      key: apikeyapikeyapikeyapikeyapikey
+```

docs/configs/services.md

@@ -0,0 +1,208 @@
+---
+title: Services
+description: Service Configuration
+---
+
+Services are configured inside the `services.yaml` file. You can have any number of groups, and any number of services per group.
+
+## Groups
+
+Groups are defined as top-level array entries.
+
+```yaml
+- Group A:
+    - Service A:
+        href: http://localhost/
+
+- Group B:
+    - Service B:
+        href: http://localhost/
+```
+
+<img width="1038" alt="Service Groups" src="https://user-images.githubusercontent.com/82196/187040754-28065242-4534-4409-881c-93d1921c6141.png">
+
+## Services
+
+Services are defined as array entries on groups,
+
+```yaml
+- Group A:
+    - Service A:
+        href: http://localhost/
+
+    - Service B:
+        href: http://localhost/
+
+    - Service C:
+        href: http://localhost/
+
+- Group B:
+    - Service D:
+        href: http://localhost/
+```
+
+<img width="1038" alt="Service Services" src="https://user-images.githubusercontent.com/82196/187040763-038023a2-8bee-4d87-b5cc-13447e7365a4.png">
+
+## Descriptions
+
+Services may have descriptions,
+
+```yaml
+- Group A:
+    - Service A:
+        href: http://localhost/
+        description: This is my service
+
+- Group B:
+    - Service B:
+        href: http://localhost/
+        description: This is another service
+```
+
+<img width="1038" alt="Service Descriptions" src="https://user-images.githubusercontent.com/82196/187040817-11a3d0eb-c997-4ef9-8f06-2d03a11332b6.png">
+
+## Icons
+
+Services may have an icon attached to them, you can use icons from [Dashboard Icons](https://github.com/walkxcode/dashboard-icons) automatically, by passing the name of the icon, with, or without `.png` or with `.svg` to use the svg version.
+
+You can also specify prefixed icons from [Material Design Icons](https://materialdesignicons.com) with `mdi-XX` or [Simple Icons](https://simpleicons.org/) with `si-XX`.
+
+You can specify a custom color by adding a hex color code as suffix e.g. `mdi-XX-#f0d453` or `si-XX-#a712a2`.
+
+To use a remote icon, use the absolute URL (e.g. `https://...`).
+
+To use a local icon, first create a Docker mount to `/app/public/icons` and then reference your icon as `/icons/myicon.png`. You will need to restart the container when adding new icons.
+
+!!! warning
+
+      Material Design Icons for **brands** were deprecated and may be removed in the future. Using Simple Icons for brand icons will prevent any issues if / when the Material Design Icons are removed.
+
+```yaml
+- Group A:
+    - Sonarr:
+        icon: sonarr.png
+        href: http://sonarr.host/
+        description: Series management
+
+- Group B:
+    - Radarr:
+        icon: radarr.png
+        href: http://radarr.host/
+        description: Movie management
+
+- Group C:
+    - Service:
+        icon: mdi-flask-outline
+        href: http://service.host/
+        description: My cool service
+```
+
+<img width="1038" alt="Service Icons" src="https://user-images.githubusercontent.com/82196/187040777-da1361d7-f0c4-4531-95db-136cd00a1611.png">
+
+## Ping
+
+Services may have an optional `ping` property that allows you to monitor the availability of an external host. As of v0.8.0, the ping feature attempts to use a true (ICMP) ping command on the underlying host. Currently, only IPv4 is supported.
+
+```yaml
+- Group A:
+    - Sonarr:
+        icon: sonarr.png
+        href: http://sonarr.host/
+        ping: sonarr.host
+
+- Group B:
+    - Radarr:
+        icon: radarr.png
+        href: http://radarr.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.
+
+```yaml
+- Group A:
+    - Service A:
+        href: http://localhost/
+        description: This is my service
+        server: my-server
+        container: my-container
+
+- Group B:
+    - Service B:
+        href: http://localhost/
+        description: This is another service
+        server: other-server
+        container: other-container
+```
+
+<img width="1038" alt="Service Containers" src="https://github.com/gethomepage/homepage/assets/88257202/4c685783-52c6-4e55-afb3-affe9baac09b">
+
+**Clicking on the status label of a service with Docker integration enabled will expand the container stats, where you can see CPU, Memory, and Network activity.**
+
+!!! note
+
+      This can also be controlled with `showStats`. See [show docker stats](docker.md#show-docker-stats) for more information
+
+<img width="1038" alt="Docker Stats Expanded" src="https://github.com/gethomepage/homepage/assets/88257202/f95fd595-449e-48ae-af67-fd89618904ec">
+
+## Service Integrations
+
+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 [Widgets](../widgets/index.md) page.
+
+Here is an example of a Radarr & Sonarr service, with their respective integrations.
+
+```yaml
+- Group A:
+    - Sonarr:
+        icon: sonarr.png
+        href: http://sonarr.host/
+        description: Series management
+        widget:
+          type: sonarr
+          url: http://sonarr.host
+          key: apikeyapikeyapikeyapikeyapikey
+
+- Group B:
+    - Radarr:
+        icon: radarr.png
+        href: http://radarr.host/
+        description: Movie management
+        widget:
+          type: radarr
+          url: http://radarr.host
+          key: apikeyapikeyapikeyapikeyapikey
+```
+
+<img width="1038" alt="Service Integrations" src="https://user-images.githubusercontent.com/82196/187040838-6cd518c2-4f08-41ef-8aa6-364df5e2660e.png">

docs/configs/settings.md

@@ -0,0 +1,493 @@
+---
+title: Settings
+description: Service Configuration
+---
+
+The `settings.yaml` file allows you to define application level options. For changes made to this file to take effect, you will need to regenerate the static HTML, this can be done by clicking the refresh icon in the bottom right of the page.
+
+## Title
+
+You can customize the title of the page if you'd like.
+
+```yaml
+title: My Awesome Homepage
+```
+
+## Start URL
+
+You can customize the start_url as required for installable apps. The default is "/".
+
+```yaml
+startUrl: https://custom.url
+```
+
+## Background Image
+
+!!! warning "Heads Up!"
+
+    You will need to restart the container any time you add new images, this is a limitation of the Next.js static site server.
+
+!!! warning "Heads Up!"
+
+    Do not create a bind mount to the entire `/app/public/` directory.
+
+If you'd like to use a background image instead of the solid theme color, you may provide a full URL to an image of your choice.
+
+```yaml
+background: https://images.unsplash.com/photo-1502790671504-542ad42d5189?auto=format&fit=crop&w=2560&q=80
+```
+
+Or you may pass the path to a local image relative to e.g. `/app/public/images` directory.
+
+For example, inside of your Docker Compose file, mount a path to where your images are kept:
+
+```yaml
+volumes:
+  - /my/homepage/images:/app/public/images
+```
+
+and then reference that image:
+
+```yaml
+background: /images/background.png
+```
+
+### Background Opacity & Filters
+
+You can specify filters to apply over your background image for blur, saturation and brightness as well as opacity to blend with the background color. The first three filter settings use tailwind CSS classes, see notes below regarding the options for each. You do not need to specify all options.
+
+```yaml
+background:
+  image: /images/background.png
+  blur: sm # sm, "", md, xl... see https://tailwindcss.com/docs/backdrop-blur
+  saturate: 50 # 0, 50, 100... see https://tailwindcss.com/docs/backdrop-saturate
+  brightness: 50 # 0, 50, 75... see https://tailwindcss.com/docs/backdrop-brightness
+  opacity: 50 # 0-100
+```
+
+### Card Background Blur
+
+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
+```
+
+## Favicon
+
+If you'd like to use a custom favicon instead of the included one, you may provide a full URL to an image of your choice.
+
+```yaml
+favicon: https://www.google.com/favicon.ico
+```
+
+Or you may pass the path to a local image relative to the `/app/public` directory. See [Background Image](#background-image) for more detailed information on how to provide your own files.
+
+## Theme
+
+You can configure a fixed theme (and disable the theme switcher) by passing the `theme` option, like so:
+
+```yaml
+theme: dark # or light
+```
+
+## Color Palette
+
+You can configured a fixed color palette (and disable the palette switcher) by passing the `color` option, like so:
+
+```yaml
+color: slate
+```
+
+Supported colors are: `slate`, `gray`, `zinc`, `neutral`, `stone`, `amber`, `yellow`, `lime`, `green`, `emerald`, `teal`, `cyan`, `sky`, `blue`, `indigo`, `violet`, `purple`, `fuchsia`, `pink`, `rose`, `red`, `white`
+
+## Layout
+
+You can configure service and bookmarks sections to be either "column" or "row" based layouts, like so:
+
+Assuming you have a group named `Media` in your `services.yaml` or `bookmarks.yaml` file,
+
+```yaml
+layout:
+  Media:
+    style: row
+    columns: 4
+```
+
+As an example, this would produce the following layout:
+
+<img width="1260" alt="Screenshot 2022-09-15 at 8 03 57 PM" src="https://user-images.githubusercontent.com/82196/190466646-8ca94505-0fcf-4964-9687-3a6c7cd3144f.png">
+
+### Sorting
+
+Service groups and bookmark groups can be mixed in order, **but should use different group names**. If you do not specify any bookmark groups they will all show at the bottom of the page.
+
+**_Using the same name for a service and bookmark group can cause unexpected behavior like a bookmark group being hidden_**
+
+Groups will sort based on the order in the layout block. You can also mix in groups defined by docker labels, e.g.
+
+```yaml
+layout:
+  - Auto-Discovered1:
+  - Configured1:
+  - Configured2:
+  - Auto-Discovered2:
+  - Configured3:
+      style: row
+      columns: 3
+```
+
+### Headers
+
+You can hide headers for each section in the layout as well by passing `header` as false, like so:
+
+```yaml
+layout:
+  Section A:
+    header: false
+  Section B:
+    style: row
+    columns: 3
+    header: false
+```
+
+### Category Icons
+
+You can also add an icon to a category under the `layout` setting similar to the [options for service icons](services.md#icons), e.g.
+
+```yaml
+  Home Management & Info:
+    icon: home-assistant.png
+  Server Tools:
+    icon: https://cdn-icons-png.flaticon.com/512/252/252035.png
+  ...
+```
+
+### Icon Style
+
+The default style for icons (e.g. `icon: mdi-XXXX`) is a gradient, or you can specify that prefixed icons match your theme with a 'flat' style using the setting below.
+More information about prefixed icons can be found in [options for service icons](services.md#icons).
+
+```yaml
+iconStyle: theme # optional, defaults to gradient
+```
+
+### Tabs
+
+Version 0.6.30 introduced a tabbed view to layouts which can be optionally specified in the layout. Tabs is only active if you set the `tab` field on at least one layout group.
+
+Tabs are sorted based on the order in the layout block. If a group has no tab specified (and tabs are set on other groups), services and bookmarks will be shown on all tabs.
+
+Every tab can be accessed directly by visiting Homepage URL with `#Group` (name lowercase and URI-encoded) at the end of the URL.
+
+For example, the following would create four tabs:
+
+```yaml
+layout:
+  ...
+  Bookmark Group on First Tab:
+    tab: First
+
+  First Service Group:
+    tab: First
+    style: row
+    columns: 4
+
+  Second Service Group:
+    tab: Second
+    columns: 4
+
+  Third Service Group:
+    tab: Third
+    style: row
+
+  Bookmark Group on Fourth Tab:
+    tab: Fourth
+
+  Service Group on every Tab:
+    style: row
+    columns: 4
+```
+
+### Five Columns
+
+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 services with `columns` style
+
+### Collapsible sections
+
+You can disable the collapsible feature of services & bookmarks by adding:
+
+```yaml
+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.
+
+<img width="1000" alt="underlined" src="https://user-images.githubusercontent.com/82196/194725622-39ce271c-34e5-414d-be53-62d221811f88.png">
+
+```yaml
+headerStyle: underlined # default style
+```
+
+---
+
+<img width="1000" alt="boxed" src="https://user-images.githubusercontent.com/82196/194725645-abcb8ed9-d017-416f-9e74-cc5642fa982c.png">
+
+```yaml
+headerStyle: boxed
+```
+
+---
+
+<img width="1000" alt="clean" src="https://user-images.githubusercontent.com/82196/194725650-7a86e818-172d-4d0f-9861-5eae7fecb50a.png">
+
+```yaml
+headerStyle: clean
+```
+
+---
+
+<img width="1000" alt="boxedWidgets" src="https://user-images.githubusercontent.com/5442891/232258758-ed5262d6-f940-462c-b39e-00e54c19b9ce.png">
+
+```yaml
+headerStyle: boxedWidgets
+```
+
+## Base URL
+
+In some proxy configurations, it may be necessary to set the documents base URL. You can do this by providing a `base` value, like so:
+
+```yaml
+base: http://host.local/homepage
+```
+
+**_The URL must be a full, absolute URL, or it will be ignored by the browser._**
+
+## Language
+
+Set your desired language using:
+
+```yaml
+language: fr
+```
+
+Currently supported languages: ca, de, en, es, fr, he, hr, hu, it, nb-NO, nl, pt, ru, sv, vi, zh-CN, zh-Hant
+
+You can also specify locales e.g. for the DateTime widget, e.g. en-AU, en-GB, etc.
+
+## Link Target
+
+Changes the behaviour of links on the homepage,
+
+```yaml
+target: _blank # Possible options include _blank, _self, and _top
+```
+
+Use `_blank` to open links in a new tab, `_self` to open links in the same tab, and `_top` to open links in a new window.
+
+This can also be set for individual services. Note setting this at the service level overrides any setting in settings.json, e.g.:
+
+```yaml
+- Example Service:
+    href: https://example.com/
+    ...
+    target: _self
+```
+
+## Providers
+
+The `providers` section allows you to define shared API provider options and secrets. Currently this allows you to define your weather API keys in secret and is also the location of the Longhorn URL and credentials.
+
+```yaml
+providers:
+  openweathermap: openweathermapapikey
+  weatherapi: weatherapiapikey
+  longhorn:
+    url: https://longhorn.example.com
+    username: admin
+    password: LonghornPassword
+```
+
+You can then pass `provider` instead of `apiKey` in your widget configuration.
+
+```yaml
+- weatherapi:
+    latitude: 50.449684
+    longitude: 30.525026
+    provider: weatherapi
+```
+
+## 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 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 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
+
+By default the release version is displayed at the bottom of the page. To hide this, use the `hideVersion` setting, like so:
+
+```yaml
+hideVersion: true
+```
+
+## Log Path
+
+By default the homepage logfile is written to the a `logs` subdirectory of the `config` folder. In order to customize this path, you can set the `logpath` setting. A `logs` folder will be created in that location where the logfile will be written.
+
+```yaml
+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`:
+
+```yaml
+showStats: true
+```
+
+or per-service (`services.yaml`) with:
+
+```yaml
+- Example Service:
+    ...
+    showStats: true
+```
+
+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, site monitor and ping: `dot` or `basic`
+
+- 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"
+```
+
+or per-service (`services.yaml`) with:
+
+```yaml
+- Example Service:
+    ...
+    statusStyle: 'dot'
+```
+
+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`:
+
+```yaml
+hideErrors: true
+```
+
+or per service widget (`services.yaml`) with:
+
+```yaml
+- Example Service:
+    ...
+    widget:
+    ...
+        hideErrors: true
+```
+
+If either value is set to true, the error message will be hidden.

docs/index.md

@@ -0,0 +1,32 @@
+---
+title: Home
+description: A modern, fully static, fast, secure, fully proxied, highly customizable application dashboard with integrations for over 100 services and translations into multiple languages.
+icon: material/home
+hide:
+  - navigation
+  - toc
+  - path
+---
+
+#
+
+<div style="margin-top: -100px;"></div>
+
+<div style="max-width: 70%; margin: 0 auto; display: block;">
+
+<img src="assets/banner_light@2x.webp" alt="homepage" style="max-width: 100%; max-height: 175px; margin: 0 auto; display: block;" />
+
+<img src="assets/homepage_demo_clip.webp" alt="homepage" style="max-width: 100%; margin: 0 auto; display: block;" />
+
+<p style="margin: 0 0 30px;">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.</p>
+
+</div>
+
+<style>
+  .md-header__source {
+    display: none;
+  }
+  .md-typeset img, .md-typeset svg, .md-typeset video {
+    box-shadow: none;
+  }
+</style>

docs/installation/docker.md

@@ -0,0 +1,55 @@
+---
+title: Docker Installation
+description: Install and run homepage from Docker
+---
+
+Using docker compose:
+
+```yaml
+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
+```
+
+### Running as non-root
+
+By default, the Homepage container runs as root. Homepage also supports running your container as non-root via the standard `PUID` and `PGID` environment variables. When using these variables, make sure that any volumes mounted in to the container have the correct ownership and permissions set.
+
+_Using the docker socket directly is not the recommended method of integration and requires either running homepage as root or that the user be part of the docker group_
+
+In the docker compose example below, the environment variables `$PUID` and `$PGID` are set in a `.env` file.
+
+```yaml
+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
+```
+
+### With Docker Run
+
+```bash
+docker run -p 3000:3000 -v /path/to/config:/app/config -v /var/run/docker.sock:/var/run/docker.sock ghcr.io/gethomepage/homepage:latest
+```
+
+### Using Environment Secrets
+
+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

docs/installation/index.md

@@ -0,0 +1,30 @@
+---
+title: Installation
+description: Docs intro
+icon: simple/docker
+---
+
+<p>
+You have a few options for deploying homepage, depending on your needs. We offer docker images for a majority of platforms. You can also install and run homepage from source if Docker is not your thing. It can even be installed on Kubernetes with Helm.
+</p>
+
+!!! danger
+
+    Please note that when using features such as widgets, Homepage can access personal information (for example from your home automation system) and Homepage currently does not (and is not planned to) include any authentication layer itself. Thus, we recommend homepage be deployed behind a reverse proxy including authentication, SSL etc, and / or behind a VPN.
+
+<br>
+
+<div class="grid cards" style="margin: 0 auto;" markdown>
+:simple-docker: [&nbsp; Install on Docker :octicons-arrow-right-24:](docker.md)
+{ .card }
+
+:simple-kubernetes: [&nbsp; Install on Kubernetes :octicons-arrow-right-24:](k8s.md)
+{ .card }
+
+:simple-unraid: [&nbsp; Install on UNRAID :octicons-arrow-right-24:](unraid.md)
+{ .card }
+
+:simple-nextdotjs: [&nbsp; Building from source :octicons-arrow-right-24:](source.md)
+{ .card }
+
+</div>

docs/installation/k8s.md

@@ -0,0 +1,393 @@
+---
+title: Kubernetes Installation
+description: Install on Kubernetes
+---
+
+## Install with Helm
+
+There is an [unofficial helm chart](https://github.com/jameswynn/helm-charts/tree/main/charts/homepage) that creates all the necessary manifests, including the service account and RBAC entities necessary for service discovery.
+
+```sh
+helm repo add jameswynn https://jameswynn.github.io/helm-charts
+helm install homepage jameswynn/homepage -f values.yaml
+```
+
+The helm chart allows for all the configurations to be inlined directly in your `values.yaml`:
+
+```yaml
+config:
+  bookmarks:
+    - Developer:
+        - Github:
+            - abbr: GH
+              href: https://github.com/
+  services:
+    - My First Group:
+        - My First Service:
+            href: http://localhost/
+            description: Homepage is awesome
+
+    - My Second Group:
+        - My Second Service:
+            href: http://localhost/
+            description: Homepage is the best
+
+    - My Third Group:
+        - My Third Service:
+            href: http://localhost/
+            description: Homepage is 😎
+  widgets:
+    # show the kubernetes widget, with the cluster summary and individual nodes
+    - kubernetes:
+        cluster:
+          show: true
+          cpu: true
+          memory: true
+          showLabel: true
+          label: "cluster"
+        nodes:
+          show: true
+          cpu: true
+          memory: true
+          showLabel: true
+    - search:
+        provider: duckduckgo
+        target: _blank
+  kubernetes:
+    mode: cluster
+  settings:
+
+# The service account is necessary to allow discovery of other services
+serviceAccount:
+  create: true
+  name: homepage
+
+# This enables the service account to access the necessary resources
+enableRbac: true
+
+ingress:
+  main:
+    enabled: true
+    annotations:
+      # Example annotations to add Homepage to your Homepage!
+      gethomepage.dev/enabled: "true"
+      gethomepage.dev/name: "Homepage"
+      gethomepage.dev/description: "Dynamically Detected Homepage"
+      gethomepage.dev/group: "Dynamic"
+      gethomepage.dev/icon: "homepage.png"
+    hosts:
+      - host: homepage.example.com
+        paths:
+          - path: /
+            pathType: Prefix
+```
+
+## Install with Kubernetes Manifests
+
+If you don't want to use the unofficial Helm chart, you can also create your own Kubernetes manifest(s) and apply them with `kubectl apply -f filename.yaml`.
+
+Here's a working example of the resources you need:
+
+#### ServiceAccount
+
+```yaml
+apiVersion: v1
+kind: ServiceAccount
+metadata:
+  name: homepage
+  namespace: default
+  labels:
+    app.kubernetes.io/name: homepage
+secrets:
+  - name: homepage
+```
+
+#### Secret
+
+```yaml
+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
+```
+
+#### ConfigMap
+
+```yaml
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  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
+
+    - 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: ""
+```
+
+#### ClusterRole and ClusterRoleBinding
+
+```yaml
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRole
+metadata:
+  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
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRoleBinding
+metadata:
+  name: homepage
+  labels:
+    app.kubernetes.io/name: homepage
+roleRef:
+  apiGroup: rbac.authorization.k8s.io
+  kind: ClusterRole
+  name: homepage
+subjects:
+  - kind: ServiceAccount
+    name: homepage
+    namespace: default
+```
+
+#### Service
+
+```yaml
+apiVersion: v1
+kind: Service
+metadata:
+  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
+```
+
+#### Deployment
+
+```yaml
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  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:
+            - 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
+
+```yaml
+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
+spec:
+  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/source.md

@@ -0,0 +1,25 @@
+---
+title: Source Installation
+description: Install and run homepage from source
+---
+
+First, clone the repository:
+
+```bash
+git clone https://github.com/gethomepage/homepage.git
+```
+
+Then install dependencies and build the production bundle (I'm using pnpm here, you can use npm or yarn if you like):
+
+```bash
+pnpm install
+pnpm build
+```
+
+If this is your first time starting, copy the `src/skeleton` directory to `config/` to populate initial example config files.
+
+Finally, run the server:
+
+```bash
+pnpm start
+```

docs/installation/unraid.md

@@ -0,0 +1,45 @@
+---
+title: UNRAID Installation
+description: Install and run homepage on UNRAID
+---
+
+Homepage has an UNRAID community package that you may use to install homepage. This is the easiest way to get started with homepage on UNRAID.
+
+## 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**.
+
+## Run the Container
+
+- 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**.
+
+## 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.
+
+  !!! 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
+  ```
+
+- 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/layouts/custom.yml

@@ -0,0 +1,252 @@
+# Copyright (c) 2016-2024 Martin Donath <martin.donath@squidfunk.com>
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
+
+# -----------------------------------------------------------------------------
+# Configuration
+# -----------------------------------------------------------------------------
+
+# Definitions
+definitions:
+  # Background image
+  - &background_image >-
+    {{ layout.background_image | x }}
+
+  # Background color (default: indigo)
+  - &background_color >-
+    {%- if layout.background_color -%}
+      {{ layout.background_color }}
+    {%- else -%}
+      {%- set palette = config.theme.palette or {} -%}
+      {%- if not palette is mapping -%}
+        {%- set list = palette | selectattr("primary") | list + palette -%}
+        {%- set palette = list | first -%}
+      {%- endif -%}
+      {%- set primary = palette.get("primary", "indigo") -%}
+      {%- set primary = primary.replace(" ", "-") -%}
+      {{ {
+        "red":         "#ef5552",
+        "pink":        "#e92063",
+        "purple":      "#ab47bd",
+        "deep-purple": "#7e56c2",
+        "indigo":      "#4051b5",
+        "blue":        "#2094f3",
+        "light-blue":  "#02a6f2",
+        "cyan":        "#00bdd6",
+        "teal":        "#009485",
+        "green":       "#4cae4f",
+        "light-green": "#8bc34b",
+        "lime":        "#cbdc38",
+        "yellow":      "#ffec3d",
+        "amber":       "#ffc105",
+        "orange":      "#ffa724",
+        "deep-orange": "#ff6e42",
+        "brown":       "#795649",
+        "grey":        "#757575",
+        "blue-grey":   "#546d78",
+        "black":       "#000000",
+        "white":       "#ffffff"
+      }[primary] or "#4051b5" }}
+    {%- endif -%}
+
+  # Text color (default: white)
+  - &color >-
+    {%- if layout.color -%}
+      {{ layout.color }}
+    {%- else -%}
+      {%- set palette = config.theme.palette or {} -%}
+      {%- if not palette is mapping -%}
+        {%- set list = palette | selectattr("primary") | list + palette -%}
+        {%- set palette = list | first -%}
+      {%- endif -%}
+      {%- set primary = palette.get("primary", "indigo") -%}
+      {%- set primary = primary.replace(" ", "-") -%}
+      {{ {
+        "red":         "#ffffff",
+        "pink":        "#ffffff",
+        "purple":      "#ffffff",
+        "deep-purple": "#ffffff",
+        "indigo":      "#ffffff",
+        "blue":        "#ffffff",
+        "light-blue":  "#ffffff",
+        "cyan":        "#ffffff",
+        "teal":        "#ffffff",
+        "green":       "#ffffff",
+        "light-green": "#ffffff",
+        "lime":        "#000000",
+        "yellow":      "#000000",
+        "amber":       "#000000",
+        "orange":      "#000000",
+        "deep-orange": "#ffffff",
+        "brown":       "#ffffff",
+        "grey":        "#ffffff",
+        "blue-grey":   "#ffffff",
+        "black":       "#ffffff",
+        "white":       "#000000"
+      }[primary] or "#ffffff" }}
+    {%- endif -%}
+
+  # Font family (default: Roboto)
+  - &font_family >-
+    {%- if layout.font_family -%}
+      {{ layout.font_family }}
+    {%- elif config.theme.font is mapping -%}
+      {{ config.theme.font.get("text", "Roboto") }}
+    {%- else -%}
+      Roboto
+    {%- endif -%}
+
+  # Font variant
+  - &font_variant >-
+    {%- if layout.font_variant -%}
+      {{ layout.font_variant }}
+    {%- endif -%}
+
+  # Site name
+  - &site_name >-
+    {{ config.site_name }}
+
+  # Page title
+  - &page_title >-
+    {%- if layout.title -%}
+      {{ layout.title }}
+    {%- else -%}
+      {{ page.meta.get("title", page.title) }}
+    {%- endif -%}
+
+  # Page title with site name
+  - &page_title_with_site_name >-
+    {%- if not page.is_homepage -%}
+      {{ page.meta.get("title", page.title) }} - {{ config.site_name }}
+    {%- else -%}
+      {{ page.meta.get("title", page.title) }}
+    {%- endif -%}
+
+  # Page description
+  - &page_description >-
+    {%- if layout.description -%}
+      {{ layout.description }}
+    {%- else -%}
+      {{ page.meta.get("description", config.site_description) | x }}
+    {%- endif -%}
+
+  # Page icon
+  - &page_icon >-
+    {{ page.meta.icon | x }}
+
+  # Logo
+  - &logo >-
+    {%- if layout.logo -%}
+      {{ layout.logo }}
+    {%- elif config.theme.logo -%}
+      {{ config.docs_dir }}/{{ config.theme.logo }}
+    {%- endif -%}
+
+  # Logo (icon)
+  - &logo_icon >-
+    {%- if not layout.logo and config.theme.icon -%}
+      {{ config.theme.icon.logo | x }}
+    {%- endif -%}
+
+# Meta tags
+tags:
+  # Open Graph
+  og:type: website
+  og:title: *page_title_with_site_name
+  og:description: *page_description
+  og:image: "{{ image.url }}"
+  og:image:type: "{{ image.type }}"
+  og:image:width: "{{ image.width }}"
+  og:image:height: "{{ image.height }}"
+  og:url: "{{ page.canonical_url }}"
+
+  # Twitter
+  twitter:card: summary_large_image
+  twitter:title: *page_title_with_site_name
+  twitter:description: *page_description
+  twitter:image: "{{ image.url }}"
+
+# -----------------------------------------------------------------------------
+# Specification
+# -----------------------------------------------------------------------------
+
+# Card size and layers
+size: { width: 1200, height: 630 }
+layers:
+  # Background
+  - background:
+      image: *background_image
+      color: *background_color
+
+  # Page icon
+  - size: { width: 630, height: 630 }
+    offset: { x: 800, y: 0 }
+    icon:
+      value: *page_icon
+      color: "#FFFFFF20"
+
+  # Logo
+  - size: { width: 64, height: 64 }
+    offset: { x: 64, y: 64 }
+    background:
+      image: *logo
+    icon:
+      value: *logo_icon
+      color: *color
+
+  # Site name
+  - size: { width: 768, height: 42 }
+    offset: { x: 160, y: 74 }
+    typography:
+      content: *site_name
+      color: *color
+      font:
+        family: *font_family
+        variant: *font_variant
+        style: Bold
+
+  # Page title
+  - size: { width: 864, height: 256 }
+    offset: { x: 62, y: 192 }
+    typography:
+      content: *page_title
+      align: start
+      color: *color
+      line:
+        amount: 3
+        height: 1.25
+      font:
+        family: *font_family
+        variant: *font_variant
+        style: Bold
+
+  # Page description
+  - size: { width: 864, height: 64 }
+    offset: { x: 64, y: 512 }
+    typography:
+      content: *page_description
+      align: start
+      color: *color
+      line:
+        amount: 2
+        height: 1.5
+      font:
+        family: *font_family
+        variant: *font_variant
+        style: Regular

docs/more/coverage.md

@@ -0,0 +1,57 @@
+---
+title: Community Coverage
+description: Homepage has been covered by quite a few YouTube channels, here are some of them.
+---
+
+Homepage has been covered by quite a few YouTube channels, here are some of them. If you have a video you'd like to add, please open a PR!
+
+## English
+
+<div class="grid" markdown>
+
+[![Youtube Video](https://img.youtube.com/vi/mC3tjysJ01E/maxresdefault.jpg)](https://www.youtube.com/watch?v=mC3tjysJ01E)
+
+[![Youtube Video](https://img.youtube.com/vi/o9SLve4wBPY/maxresdefault.jpg)](https://www.youtube.com/watch?v=o9SLve4wBPY)
+
+[![Youtube Video](https://img.youtube.com/vi/j9kbQucNwlc/maxresdefault.jpg)](https://www.youtube.com/watch?v=j9kbQucNwlc)
+
+[![Youtube Video](https://img.youtube.com/vi/3Ux7zfCCM1A/maxresdefault.jpg)](https://www.youtube.com/watch?v=3Ux7zfCCM1A)
+
+[![Youtube Video](https://img.youtube.com/vi/4AwUNy2eztA/maxresdefault.jpg)](https://www.youtube.com/watch?v=4AwUNy2eztA)
+
+[![Youtube Video](https://img.youtube.com/vi/7mUUCB3kP0E/maxresdefault.jpg)](https://www.youtube.com/watch?v=7mUUCB3kP0E)
+
+[![Youtube Video](https://img.youtube.com/vi/a5-4u0qFKaE/maxresdefault.jpg)](https://www.youtube.com/watch?v=a5-4u0qFKaE)
+
+[![Youtube Video](https://img.youtube.com/vi/tV7-06FU4gQ/maxresdefault.jpg)](https://www.youtube.com/watch?v=tV7-06FU4gQ)
+
+[![Youtube Video](https://img.youtube.com/vi/X2ycbT7rPu4/maxresdefault.jpg)](https://www.youtube.com/watch?v=X2ycbT7rPu4)
+
+[![Youtube Video](https://img.youtube.com/vi/1jEWUJqL-eo/maxresdefault.jpg)](https://www.youtube.com/watch?v=1jEWUJqL-eo)
+
+</div>
+
+<div class="grid" markdown>
+
+<div markdown>
+## French
+[![Youtube Video](https://img.youtube.com/vi/aGztk8you6o/maxresdefault.jpg)](https://www.youtube.com/watch?v=aGztk8you6o)
+[![Youtube Video](https://img.youtube.com/vi/pQfhWqZh7YE/maxresdefault.jpg)](https://www.youtube.com/watch?v=pQfhWqZh7YE)
+</div>
+
+<div markdown>
+## German
+[![Youtube Video](https://img.youtube.com/vi/DrDgg-WRA2g/maxresdefault.jpg)](https://www.youtube.com/watch?v=DrDgg-WRA2g)
+</div>
+
+<div markdown>
+## Chinese
+[![Youtube Video](https://img.youtube.com/vi/DAW15ckt4n4/mqdefault.jpg){: style="width: 100%"}](https://www.youtube.com/watch?v=DAW15ckt4n4)
+</div>
+
+<div markdown>
+## Russian
+[![Youtube Video](https://img.youtube.com/vi/dk3Cp5ck8mY/maxresdefault.jpg)](https://www.youtube.com/watch?v=dk3Cp5ck8mY)
+</div>
+
+</div>

docs/more/homepage-move.md

@@ -0,0 +1,8 @@
+---
+title: Homepage Move
+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`.

docs/more/index.md

@@ -0,0 +1,7 @@
+---
+title: More
+description: More homepage resources and guides.
+icon: material/information-slab-circle
+---
+
+Here you'll find resources and guides for Homepage, troubleshooting tips, and more.

docs/more/sponsors.md

@@ -0,0 +1,58 @@
+---
+title: Sponsors
+description: Homepage is supported by these awesome people and companies.
+---
+
+If you would like to support the Homepage project, you can do so by becoming a sponsor. Your sponsorship helps to keep the project running and growing.
+
+<div class="grid" markdown>
+
+[:simple-github: GitHub Sponsors](https://github.com/sponsors/gethomepage){ .md-button }
+
+[:simple-opencollective: OpenCollective](https://opencollective.com/homepage){ .md-button }
+
+[:simple-patreon: Patreon](https://www.patreon.com/gethomepage){ .md-button .w-full }
+
+</div>
+
+<hr style="margin-top: 48px;" />
+
+These companies help the Homepage project by providing services, tools, and resources.
+
+<div class="grid" markdown>
+  <div style="margin-bottom: 16px;">
+    <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%202.svg" alt="DigitalOcean" style="max-width: 100%; height: 64px; display: block;" /></a>
+    <p>
+      DigitalOcean provides the GitHub Actions runner for the project.  Dramatically speeding up the CI/CD process.
+    </p>
+  </div>
+
+  <div style="margin-bottom: 16px;">
+    <a href="https://crowdin.com/project/homepage"><img src="https://support.crowdin.com/assets/logos/core-logo/png/crowdin-core-logo-cWhite.png" alt="Crowdin" style="max-width: 100%; height: 64px; display: block;" /></a>
+    <p>
+      Crowdin provides the translation platform for the project.  Making it easy to translate the project into multiple languages.
+    </p>
+  </div>
+
+  <div style="margin-bottom: 16px;">
+    <a href="https://www.jetbrains.com/"><img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jetbrains.png" alt="JetBrains" style="max-width: 100%; height: 64px; display: block;" /></a>
+    <p>
+      JetBrains provides the project with free licenses for their awesome tools.
+    </p>
+  </div>
+
+  <div style="margin-bottom: 16px;">
+    <a href="https://www.buysellads.com/"><img src="https://www.buysellads.com/hubfs/raw_assets/public/BSA-2023/images/logo.svg" alt="BuySellAds" style="max-width: 100%; height: 64px; display: block; filter: invert();" /></a>
+    <p>
+      BuySellAds provides the project with the ability to monetize the website, with high quality ads from the CarbonAds network.  All earnings are sent directly to the projects OpenCollective.
+    </p>
+  </div>
+</div>
+
+<style>
+.md-typeset img,
+.md-typeset svg,
+.md-typeset video {
+  box-shadow: none;
+}
+</style>

docs/more/translations.md

@@ -0,0 +1,19 @@
+---
+title: Translations
+description: Contributing Translations
+---
+
+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:
+
+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!
+
+## 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/overrides/main.html

@@ -0,0 +1,52 @@
+{% extends "base.html" %}
+
+{% block header %}
+  <div id="blur-overlay" class="blur-overlay"></div>
+  {% include "partials/header.html" %}
+{% endblock %}
+
+{% 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/stylesheets/extra.css

@@ -0,0 +1,283 @@
+[data-md-color-scheme="slate"] {
+  --md-hue: 220;
+  --md-default-bg-color: hsla(0, 0%, 14%, 0.6);
+  --md-code-bg-color: hsla(0, 0%, 0%, 0.2);
+}
+
+[data-md-color-scheme="default"] {
+  --md-hue: 220;
+  --md-default-fg-color--light: white;
+  --md-default-fg-color--lighter: hsla(0, 0%, 100%, 0.6);
+  --md-default-bg-color: hsla(0, 0%, 100%, 0.8);
+  --md-code-bg-color: hsla(0, 0%, 100%, 0.6);
+  --md-code-bg-color--lighter: hsla(0, 0%, 100%, 0.6);
+  --md-default-fg-color: white;
+}
+
+[data-md-color-scheme="default"] .md-search__inner {
+  --md-default-fg-color--light: gray;
+  --md-default-fg-color--lighter: black;
+  --md-default-bg-color: hsla(0, 0%, 100%, 0.9);
+}
+
+[data-md-color-scheme="default"] .md-search__inner .md-search__input {
+  color: var(--md-default-fg-color--light);
+}
+
+[data-md-toggle="search"]:not(:checked) ~ .md-header .md-search__form::after {
+  position: absolute;
+  top: 0.3rem;
+  right: 0.3rem;
+  display: block;
+  padding: 0.1rem 0.4rem;
+  color: var(--md-default-fg-color--lighter);
+  font-weight: bold;
+  font-size: 0.8rem;
+  border: 0.05rem solid var(--md-default-fg-color--lighter);
+  border-radius: 0.1rem;
+  content: "/";
+}
+
+[data-md-color-scheme="default"][data-md-color-primary="black"] {
+  [data-md-toggle="search"]:not(:checked) ~ .md-header .md-search__form::after {
+    color: var(--md-default-bg-color--lighter);
+    border-color: var(--md-default-bg-color--lighter);
+  }
+}
+
+#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;
+}
+
+.md-typeset__table {
+  width: 100%;
+}
+
+.md-typeset table:not([class]) {
+  display: table;
+}
+
+/* less than 1440px wide */
+@media (max-width: 1440px) {
+  .md-footer-meta__inner {
+    justify-content: center;
+  }
+}
+
+/* less than 740px wide */
+@media (max-width: 740px) {
+  .md-footer-meta__inner {
+    justify-content: left;
+    flex-direction: column;
+  }
+  .md-social {
+    padding-top: 0;
+  }
+}
+
+.md-header__button.md-logo {
+  padding: 0;
+  margin: 0;
+}
+
+.md-header__button.md-logo img,
+.md-header__button.md-logo svg {
+  height: 2rem;
+}
+
+.md-header__topic .md-ellipsis {
+  display: none;
+}
+
+body {
+  background-color: transparent !important;
+  background-image: url("https://raw.githubusercontent.com/gethomepage/homepage/main/docs/assets/blossom_valley.jpg");
+  background-size: cover;
+  background-attachment: fixed;
+  background-position: center;
+  color: rgba(255, 255, 255, 0.8);
+}
+
+.md-typeset h1 {
+  color: #fff;
+}
+
+body[data-md-color-scheme="default"] {
+  color: rgba(255, 255, 255, 1);
+}
+
+.blur-overlay {
+  z-index: -1;
+  position: fixed;
+  width: 100%;
+  height: 100%;
+  background: hsl(0deg 0% 0% / 10%);
+  backdrop-filter: blur(128px);
+  -webkit-backdrop-filter: blur(128px);
+}
+
+[data-md-color-scheme="default"] .blur-overlay {
+  background: hsla(0, 0%, 0%, 0);
+}
+
+.md-nav--lifted > .md-nav__list > .md-nav__item--active > .md-nav__link,
+.md-nav--secondary .md-nav__title {
+  background: none;
+  box-shadow: none;
+}
+
+[data-md-color-scheme="slate"] .md-main,
+[data-md-color-scheme="slate"] .md-tabs,
+[data-md-color-scheme="slate"] .md-footer {
+  background-color: hsla(0, 0%, 0%, 0.3);
+}
+
+[data-md-color-scheme="default"] .md-main,
+[data-md-color-scheme="default"] .md-tabs,
+[data-md-color-scheme="default"] .md-footer {
+  background-color: hsla(0, 0%, 100%, 0.1);
+}
+
+[data-md-color-scheme="slate"] .md-header {
+  background-color: hsla(0, 0%, 0%, 0.3);
+  backdrop-filter: blur(16px);
+  -webkit-backdrop-filter: blur(16px);
+}
+
+[data-md-color-scheme="default"] .md-header {
+  background-color: hsla(0, 0%, 100%, 0.1);
+  backdrop-filter: blur(16px);
+  -webkit-backdrop-filter: blur(16px);
+}
+
+.md-header:has(.md-search-result__item),
+.md-header:has(.md-search__input.focus-visible) {
+  backdrop-filter: none !important;
+  -webkit-backdrop-filter: none !important;
+}
+
+.md-footer-meta {
+  background-color: transparent;
+}
+
+[data-md-color-scheme="slate"][data-md-color-primary="black"],
+[data-md-color-scheme="default"][data-md-color-primary="black"] {
+  --md-typeset-a-color: #ffffff;
+}
+
+.md-content__inner a {
+  text-decoration: underline;
+  font-weight: bolder;
+}
+
+[data-md-color-scheme="default"] .highlight .p,
+[data-md-color-scheme="default"] .highlight .o,
+[data-md-color-scheme="default"] .highlight .ow,
+[data-md-color-scheme="default"] .highlight .c,
+[data-md-color-scheme="default"] .highlight .c1,
+[data-md-color-scheme="default"] .highlight .ch,
+[data-md-color-scheme="default"] .highlight .cm,
+[data-md-color-scheme="default"] .highlight .cs,
+[data-md-color-scheme="default"] .highlight .sd {
+  color: #36464eaa;
+}
+
+[data-md-color-scheme="default"] .md-annotation__index:after {
+  background-color: #36464ecc;
+}
+
+/* I know this is a farce, but I want it to look nice. */
+.css-9if7bc {
+  background-color: hsla(0, 0%, 0%, 0.3);
+  backdrop-filter: blur(16px);
+  -webkit-backdrop-filter: blur(16px);
+}
+
+@media screen and (max-width: 76.234375em) {
+  .md-nav--primary,
+  .md-nav--primary .md-nav {
+    background-color: hsla(0, 0%, 0%, 0.8);
+  }
+}
+
+@media screen and (max-width: 76.234375em) {
+  .md-nav--primary .md-nav__title ~ .md-nav__list {
+    background-color: hsla(0, 0%, 0%, 0.8);
+    backdrop-filter: blur(16px);
+    -webkit-backdrop-filter: blur(16px);
+  }
+}
+
+@media screen and (max-width: 76.234375em) {
+  .md-nav--primary .md-nav__title {
+    background-color: hsla(0, 0%, 0%, 0.8);
+    backdrop-filter: blur(16px);
+  }
+}
+
+.md-search__scrollwrap {
+  background-color: hsla(0, 0%, 0%, 0.8);
+  backdrop-filter: blur(16px);
+  -webkit-backdrop-filter: blur(16px);
+}
+
+.md-search-result .md-typeset h1 {
+  color: #fff;
+}
+
+[data-md-color-scheme="default"] .highlight span.filename,
+[data-md-color-scheme="default"] .linenodiv a {
+  color: #36464e;
+  font-weight: light;
+}
+
+.linenodiv a {
+  text-decoration: none;
+}
+
+.md-typeset .admonition,
+.md-typeset details {
+  background-color: transparent;
+}
+
+.md-typeset img,
+.md-typeset svg,
+.md-typeset video {
+  box-shadow: 0 0 1rem 0.25rem hsla(0, 0%, 0%, 0.1);
+}
+
+.highlight {
+  box-shadow: 0 0 1rem 0.25rem hsla(0, 0%, 0%, 0.1);
+}
+
+.md-typeset .admonition.tip,
+.md-typeset details.tip {
+  box-shadow: 0 0 1rem 0.25rem hsl(171.83deg 100% 37.45% / 20%);
+}
+
+.md-typeset .admonition.note,
+.md-typeset details.note {
+  box-shadow: 0 0 1rem 0.25rem hsl(214.29deg 100% 37.45% / 20%);
+}
+
+.md-typeset .admonition.warning,
+.md-typeset details.warning {
+  box-shadow: 0 0 1rem 0.25rem hsl(40.91deg 100% 37.45% / 20%);
+}
+
+.md-typeset .admonition.danger,
+.md-typeset details.danger {
+  box-shadow: 0 0 1rem 0.25rem hsl(0deg 100% 37.45% / 20%);
+}
+
+.md-tabs__link {
+  transform: translateZ(0);
+}

docs/troubleshooting/index.md

@@ -0,0 +1,66 @@
+---
+title: Troubleshooting
+description: Basic Troubleshooting
+icon: material/message-question
+hide:
+  - navigation
+---
+
+## General Troubleshooting Tips
+
+- For API errors, clicking the "API Error Information" button in the widget will usually show some helpful information as to whether the issue is reaching the service host, an authentication issue, etc.
+- Check config/logs/homepage.log, on docker simply e.g. `docker logs homepage`. This may provide some insight into the reason for an error.
+- Check the browser error console, this can also sometimes provide useful information.
+- Consider setting the `ENV` variable `LOG_LEVEL` to `debug`.
+
+## Service Widget Errors
+
+All service widgets work essentially the same, that is, homepage makes a proxied call to an API made available by that service. The majority of the time widgets don't work it is a configuration issue. Of course, sometimes things do break. Some basic steps to try:
+
+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.:
+
+    ```
+    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.
+
+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`.
+
+    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`).
+
+    It is out of the scope of this to go into full detail about how to , but an example for PiHole would be:
+
+    ```
+    curl -L -k http://PIHOLEIPORHOST/admin/api.php
+    ```
+
+    Or for AdGuard:
+
+    ```
+    curl -L -k -u 'username:password' http://ADGUARDIPORHOST/control/stats
+    ```
+
+    Or for Portainer:
+
+    ```
+    curl -L -k -H 'X-Api-Key:YOURKEY' 'https://PORTAINERIPORHOST:PORT/api/endpoints/2/docker/containers/json'
+    ```
+
+    Sonarr:
+
+    ```
+    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
+
+If, after correctly adding and mapping your custom icons via the [Icons](../configs/services.md#icons) instructions, you are still unable to see your icons please try recreating your container.

docs/widgets/authoring/api.md

@@ -0,0 +1,50 @@
+---
+title: API Guide
+description: Get comfortable with making API calls from inside your widget.
+---
+
+Homepage provides the `useWidgetAPI` hook to help you fetch data from an API. This hook insures that the data is fetched using a proxy, and is critical for security.
+
+Here is an example of how the `useWidgetAPI` hook looks:
+
+```js title="Fetch data from the stats endpoint"
+import useWidgetAPI from "utils/proxy/use-widget-api";
+
+export default function Component({ service }) {
+  const { data, error } = useWidgetAPI(widget, "stats");
+}
+```
+
+## `useWidgetAPI`
+
+`useWidgetAPI` takes three possible arguments:
+
+- `widget`: The widget metadata object.
+- `endpoint`: The name of the endpoint to fetch data from.
+- `params`: An optional object containing query parameters to pass to the API.
+
+### `widget`
+
+The `widget` argument is the metadata object for the widget. It contains information about the API endpoint, proxy handler, and mappings. This object is used by the `useWidgetAPI` hook to fetch data from the API. This is generally passed in as a prop from the parent component.
+
+### `endpoint`
+
+The `endpoint` argument is the name of the endpoint to fetch data from. This is [defined in the widget metadata object](metadata.md#endpoint). The `useWidgetAPI` hook uses this argument to determine which endpoint to fetch data from.
+
+If no endpoint is provided, the `useWidgetAPI` hook will call the API endpoint defined in the widget metadata object directly.
+
+### `params`
+
+The `params` argument is an optional object containing query parameters to pass to the API. This is useful for filtering data or passing additional information to the API. This object is passed directly to the API endpoint as query parameters.
+
+Here is an example of how to use the `params` argument:
+
+```js title="Fetch data from the stats endpoint with query parameters"
+import useWidgetAPI from "utils/proxy/use-widget-api";
+
+export default function Component({ service }) {
+  const { data, error } = useWidgetAPI(widget, "stats", { start: "2021-01-01", end: "2021-12-31" });
+}
+```
+
+The `params` must be [whitelisted in the widget metadata object](metadata.md#params). This is done to prevent arbitrary query parameters from being passed to the API.

docs/widgets/authoring/component.md

@@ -0,0 +1,102 @@
+---
+title: Component Guide
+description: Learn more about the widget component in Homepage, and how to build your widget UI.
+---
+
+Homepage widgets are built using React components. These components are responsible for fetching data from the API and rendering the widget UI. Homepage provides a set of hooks and utilities to help you build your widget component.
+
+## A Basic Widget Component
+
+Here is an example of a basic widget component:
+
+```js
+import { useTranslation } from "next-i18next";
+
+import Container from "components/services/widget/container";
+import Block from "components/services/widget/block";
+import useWidgetAPI from "utils/proxy/use-widget-api";
+
+export default function Component({ service }) {
+  const { t } = useTranslation();
+  const { widget } = service;
+  const { data, error } = useWidgetAPI(widget, "info");
+
+  if (error) {
+    return <Container service={service} error={error} />;
+  }
+
+  if (!data) {
+    return (
+      <Container service={service}>
+        <Block label="yourwidget.key1" />
+        <Block label="yourwidget.key2" />
+        <Block label="yourwidget.key3" />
+      </Container>
+    );
+  }
+
+  return (
+    <Container service={service}>
+      <Block label="yourwidget.key1" value={t("common.number", { value: data.key1 })} />
+      <Block label="yourwidget.key2" value={t("common.number", { value: data.key2 })} />
+      <Block label="yourwidget.key3" value={t("common.number", { value: data.key3 })} />
+    </Container>
+  );
+}
+```
+
+### Breakdown
+
+We'll cover two sections of the widget component: hooks and components.
+
+#### Hooks
+
+**`useTranslation`**
+
+This hook is used to translate text and numerical content in widgets. Homepage provides a set of helpers to help you localize your widgets. You can learn more about translations in the [Translations Guide](translations.md).
+
+**`useWidgetAPI`**
+
+This hook is used to fetch data from the API. We cover this hook in more detail in the [API Guide](api.md).
+
+#### Components
+
+Homepage provides a set of components to help you build your widget UI. These components are designed to provide a consistent layout, and all widgets are expected to use these components.
+
+![Component Sections](../../assets/sections.webp)
+
+**`<Container>`**
+
+This component is a wrapper for the widget. It provides a consistent layout for all widgets.
+
+```js
+<Container service={service}></Container>
+```
+
+`service` is a prop that is passed to the widget component. It contains information about the service that the widget is displaying.
+
+If there is an error fetching data from the API, the `error` prop can be passed to the `Container` component.
+
+```js
+<Container service={service} error={error}></Container>
+```
+
+**`<Block>`**
+
+This component is used to display a key-value pair. It takes a label and value as props.
+
+```js
+<Block label="yourwidget.key1" value={t("common.number", { value: data.key1 })} />
+```
+
+The `label` prop is used to look up the translation key in the translation files. The `value` prop is used to display the value of the block. To learn more about translations, please refer to the [Translations Guide](translations.md).
+
+If there is no data available, the `Block` component can be used to display a placeholder layout.
+
+```js
+<Container service={service}>
+  <Block label="yourwidget.key1" />
+  <Block label="yourwidget.key2" />
+  <Block label="yourwidget.key3" />
+</Container>
+```

docs/widgets/authoring/getting-started.md

@@ -0,0 +1,65 @@
+---
+title: Getting Started
+description: Get started developing for Homepage.
+---
+
+We'll cover getting homepage up and running on your local machine for development, as well as some guidelines for developing new features and widgets.
+
+## Development
+
+First, clone the homepage repository.
+
+For installing NPM packages, this project uses [pnpm](https://pnpm.io/) (and so should you!):
+
+```bash
+pnpm install
+```
+
+Start the development server:
+
+```bash
+pnpm dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) to start.
+
+This is a [Next.js](https://nextjs.org/) application, see their documentation for more information.
+
+## Code Linting
+
+Once dependencies have been installed you can lint your code with
+
+```bash
+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 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.
+- Note that we reserve the right to decline widgets for projects that are very young (eg < ~1y) or those with a small reach (eg low GitHub stars). Again, this is in an effort to keep overall widget maintenance under control.
+- Widgets should be only one row of blocks
+- Widgets should be no more than 4 blocks wide and generally conform to the styling / design choices of other widgets
+- Minimize the number of API calls
+- 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/widgets/authoring/index.md

@@ -0,0 +1,33 @@
+---
+title: Guides & Tutorials
+description: Learn how to create and customize widgets in Homepage. Explore translations, widget components, widget metadata, proxy handlers, and making API calls.
+icon: fontawesome/solid/graduation-cap
+---
+
+Widgets are a core component of Homepage. They are used to display information about your system, services, and environment.
+
+## Overview
+
+If you are new to Homepage widgets, and are looking to create a new widget, please follow along with the guide here: [Widget Tutorial](tutorial.md).
+
+### Translations
+
+All text and numerical content in widgets should be translated and localized. English is the default language, and other languages can be added via [Crowdin](https://crowdin.com/project/gethomepage).
+
+To learn more about translations, please refer to the guide here: [Translations Guide](translations.md).
+
+### Widget Component
+
+The widget component is the core of the widget. It is responsible for [fetching data from the API](api.md) and rendering the widget UI. Homepage provides a set of hooks and utilities to help you build your widget component.
+
+To learn more about widget components, please refer to the guide here: [Component Guide](component.md).
+
+### Widget Metadata
+
+Widget metadata defines the configuration of the widget. It defines the API endpoint to fetch data from, the proxy handler to use, and any data mappings.
+
+To learn more about widget metadata, endpoint and data mapping, please refer to the guide here: [Metadata Guide](metadata.md).
+
+To learn more about proxy handlers, please refer to the guide here: [Proxies Guide](proxies.md).
+
+To learn more about making API calls from inside your widget, please refer to the guide here: [API Guide](api.md).

docs/widgets/authoring/metadata.md

@@ -0,0 +1,310 @@
+---
+title: Metadata Guide
+description: Explore all the metadata properties that can be used to configure a widget in Homepage.
+---
+
+Here, we will go over how to create and configure Homepage widget metadata. Metadata is a JS object that contains information about the widget, such as the API endpoint, proxy handler, and mappings. This metadata is used by Homepage to fetch data from the API and pass it to the widget.
+
+## Widgets Configuration
+
+Here are some examples of how to configure a widget's metadata object.
+
+=== "Basic Example"
+
+    ```js
+    import genericProxyHandler from "utils/proxy/handlers/generic";
+
+    const widgetExample = {
+      api: "{url}/api/{endpoint}",
+      proxyHandler: genericProxyHandler,
+
+      mappings: {
+        stats: { endpoint: "stats" }
+      },
+    };
+    ```
+
+=== "Advanced Example"
+
+    ```js
+    import credentialedProxyHandler from "utils/proxy/handlers/credentialed";
+    import { asJson, jsonArrayFilter } from "utils/proxy/api-helpers";
+
+    const widgetExample = {
+      api: "{url}/api/{endpoint}",
+      proxyHandler: credentialedProxyHandler,
+
+      mappings: {
+        stats: {
+          endpoint: "stats",
+          validate: ["total", "average"],
+          params: ["start", "end"],
+        },
+        notices: {
+          endpoint: "notices",
+          map: (data) => {
+            total: asJson(data).length;
+          },
+        },
+        warnings: {
+          endpoint: "notices",
+          map: (data) => {
+            total: jsonArrayFilter(data, (alert) => alert.type === "warning").length;
+          },
+        },
+      },
+    };
+    ```
+
+A widget's metadata is quite powerful and can be configured in many different ways.
+
+## Configuration Properties
+
+### `api`
+
+The `api` property is a string that represents the URL of the API endpoint that the widget will use to fetch data. The URL can contain placeholders that will be replaced with actual values at runtime. For example, the `{url}` placeholder will be replaced with the URL of the configured widget, and the `{endpoint}` placeholder will be replaced with the value of the `endpoint` property in the `mappings` object.
+
+```js
+const widgetExample = {
+  api: "{url}/api/{endpoint}",
+};
+```
+
+### `proxyHandler`
+
+The `proxyHandler` property is a function that will be used to make the API request. Homepage includes some built-in proxy handlers that can be used out of the box:
+
+Here is an example of the generic proxy handler that makes unauthenticated requests to the specified API endpoint.
+
+=== "widget.js"
+
+    ```js
+    const widgetExample = {
+      api: "{url}/api/{endpoint}",
+      proxyHandler: genericProxyHandler,
+    };
+    ```
+
+=== "services.yaml"
+
+    ```yaml
+    - Services:
+        - Your Widget:
+            icon: yourwidget.svg
+            href: https://example.com/
+            widget:
+              type: yourwidget
+              url: http://127.0.0.1:1337
+    ```
+
+If you are looking to learn more about proxy handlers, please refer to the guide here: [Proxies Guide](proxies.md).
+
+### `mappings`
+
+The `mappings` property is an object that contains information about the API endpoint, such as the endpoint name, validation rules, and parameter names. The `mappings` object can contain multiple endpoints, each with its own configuration.
+
+!!! note "Security Note"
+
+    The `mappings` or `allowedEndpoints` property is required for the widget to fetch data from more than a static URL. Homepage uses a whitelist approach to ensure that widgets only access allowed endpoints.
+
+```js
+import { asJson } from "utils/proxy/api-helpers";
+
+const widgetExample = {
+  api: "{url}/api/{endpoint}",
+  mappings: {
+    // `/api/stats?start=...&end=...`
+    stats: {
+      endpoint: "stats",
+      validate: ["total", "average"],
+      params: ["start", "end"],
+    },
+    // `/api/notices`
+    notices: {
+      endpoint: "notices",
+      map: (data) => {
+        total: asJson(data).length;
+      },
+    },
+  },
+};
+```
+
+#### `endpoint`
+
+The `endpoint` property is a string that represents the name of the API endpoint that the widget will use to fetch data. This value will be used to replace the `{endpoint}` placeholder in the `api` property.
+
+```js
+const widgetExample = {
+  api: "{url}/api/{endpoint}",
+  mappings: {
+    // `/api/stats`
+    stats: {
+      endpoint: "stats",
+    },
+  },
+};
+```
+
+#### `validate`
+
+The `validate` property is an array of strings that represent the keys that should be validated in the API response. If the response does not contain all of the specified keys, the widget will not render.
+
+```js
+const widgetExample = {
+  api: "{url}/api/{endpoint}",
+  mappings: {
+    // `/api/stats`
+    stats: {
+      endpoint: "stats",
+      validate: ["total", "average"],
+    },
+  },
+};
+```
+
+This configuration will ensure that the API response contains the `total` and `average` keys before the widget is rendered.
+
+#### `params`
+
+The `params` property is an array of strings that represent the keys that should be passed as parameters to the API endpoint. These keys will be replaced with the actual values at runtime.
+
+=== "widget.js"
+
+    ```js
+    const widgetExample = {
+      api: "{url}/api/{endpoint}",
+      mappings: {
+        // `/api/stats?start=...&end=...`
+        stats: {
+          endpoint: "stats",
+          params: ["start", "end"],
+        },
+      },
+    };
+    ```
+
+=== "component.jsx"
+
+      ```js
+      const { data: statsData, error: statsError } = useWidgetAPI(widget, "stats", {
+        start: new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
+        end: new Date(),
+      });
+      ```
+
+This configuration will pass the `start` and `end` keys as parameters to the API endpoint. The values are passed as an object to the `useWidgetAPI` hook.
+
+#### `map`
+
+The `map` property is a function that will be used to transform the API response before it is passed to the widget. This function is passed the raw API response and should return the transformed data.
+
+```js
+import { asJson } from "utils/proxy/api-helpers";
+
+const widgetExample = {
+  api: "{url}/api/{endpoint}",
+  mappings: {
+    // `/api/notices`
+    notices: {
+      endpoint: "notices",
+      map: (data) => {
+        total: asJson(data).length;
+      },
+    },
+    // `/api/notices`
+    warnings: {
+      endpoint: "notices",
+      map: (data) => {
+        total: asJson(data).filter((alert) => alert.type === "warning").length;
+      },
+    },
+  },
+};
+```
+
+#### `method`
+
+The `method` property is a string that represents the HTTP method that should be used to make the API request. The default value is `GET`.
+
+```js
+const widgetExample = {
+  api: "{url}/api/{endpoint}",
+  mappings: {
+    // `/api/stats`
+    stats: {
+      endpoint: "stats",
+      method: "POST",
+    },
+  },
+};
+```
+
+#### `headers`
+
+The `headers` property is an object that contains additional headers that should be included in the API request. If your endpoint requires specific headers, you can include them here.
+
+```js
+const widgetExample = {
+  api: "{url}/api/{endpoint}",
+  mappings: {
+    // `/api/stats`
+    stats: {
+      endpoint: "stats",
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+      },
+    },
+  },
+};
+```
+
+#### `body`
+
+The `body` property is an object that contains the data that should be sent in the request body. This property is only used when the `method` property is set to `POST` or `PUT`.
+
+```js
+const widgetExample = {
+  api: "{url}/api/{endpoint}",
+  mappings: {
+    // `/api/graphql`
+    stats: {
+      endpoint: "graphql",
+      method: "POST",
+      body: {
+        query: `
+          query {
+            stats {
+              total
+              average
+            }
+          }
+        `,
+      },
+      headers: {
+        "Content-Type": "application/json",
+      },
+    },
+  },
+};
+```
+
+### `allowedEndpoints`
+
+The `allowedEndpoints` property is a RegExp that represents the allowed endpoints that the widget can use. If the widget tries to access an endpoint that is not allowed, the request will be blocked.
+
+`allowedEndpoints` can be used when endpoint validation is simple and can be done using a regular expression, and more control is not required.
+
+!!! note "Security Note"
+
+    The `mappings` or `allowedEndpoints` property is required for the widget to fetch data from more than a static URL. Homepage uses a whitelist approach to ensure that widgets only access allowed endpoints.
+
+```js
+const widgetExample = {
+  api: "{url}/api/{endpoint}",
+  allowedEndpoints: /^stats|notices$/,
+};
+```
+
+This configuration will only allow the widget to access the `stats` and `notices` endpoints.

docs/widgets/authoring/proxies.md

@@ -0,0 +1,203 @@
+---
+title: Proxies Guide
+description: Learn about proxy handlers in Homepage, and how to securely fetch data from an API.
+---
+
+Homepage includes a set of built-in proxy handlers that can be used to fetch data from an API. We will go over how to use these proxy handlers and briefly cover how to create your own.
+
+## Available Proxy Handlers
+
+Homepage comes with a few built-in proxy handlers that can be used to fetch data from an API. These handlers are located in the `utils/proxy/handlers` directory.
+
+### `genericProxyHandler`
+
+A proxy handler that makes generally unauthenticated requests to the specified API endpoint.
+
+```js
+import genericProxyHandler from "utils/proxy/handlers/generic";
+
+const widgetExample = {
+  api: "{url}/api/{endpoint}",
+  proxyHandler: genericProxyHandler,
+};
+```
+
+You can also pass API keys from the widget configuration to the proxy handler, for authenticated requests.
+
+=== "widget.js"
+
+    ```js
+    import genericProxyHandler from "utils/proxy/handlers/generic";
+
+    const widgetExample = {
+      api: "{url}/api/{endpoint}?key={key}",
+      proxyHandler: genericProxyHandler,
+    };
+    ```
+
+=== "services.yaml"
+
+    ```yaml
+    # Widget Configuration
+    - Your Widget:
+        icon: yourwidget.svg
+        href: https://example.com/
+        widget:
+          type: yourwidget
+          url: http://example.com
+          key: your-api-key
+    ```
+
+### `credentialedProxyHandler`
+
+A proxy handler that makes authenticated by setting request headers. Credentials are pulled from the widgets configuration.
+
+By default the key is passed as an `X-API-Key` header. If you need to pass the key as something else, either add a case to the credentialedProxyHandler or create a new proxy handler.
+
+=== "widget.js"
+
+    ```js
+    import credentialedProxyHandler from "utils/proxy/handlers/credentialed";
+
+    const widgetExample = {
+      api: "{url}/api/{endpoint}?key={key}",
+      proxyHandler: credentialedProxyHandler,
+    };
+    ```
+
+=== "services.yaml"
+
+    ```yaml
+    - Your Widget:
+        icon: yourwidget.svg
+        href: https://example.com/
+        widget:
+          type: yourwidget
+          url: http://127.0.0.1:1337
+          key: your-api-key
+    ```
+
+### `jsonrpcProxyHandler`
+
+A proxy handler that makes authenticated JSON-RPC requests to the specified API endpoint, either using username + password or an API token.
+The endpoint is the method to call and queryParams are used as the parameters.
+
+=== "component.js"
+
+    ```js
+    import Container from "components/services/widget/container";
+    import useWidgetAPI from "utils/proxy/use-widget-api";
+
+    export default function Component({ service }) {
+      const { widget } = service;
+
+      const { data, error } = useWidgetAPI(widget, 'trigger', { "triggerids": "14062", "output": "extend", "selectFunctions": "extend" });
+    }
+    ```
+
+=== "widget.js"
+
+    ```js
+    import jsonrpcProxyHandler from "utils/proxy/handlers/jsonrpc";
+
+    const widgetExample = {
+      api: "{url}/api/jsonrpc",
+      proxyHandler: jsonrpcProxyHandler,
+
+      mappings: {
+        total: { endpoint: "total" },
+        average: { endpoint: "average" },
+        trigger: { endpoint: "trigger.get" },
+      },
+    };
+    ```
+
+=== "services.yaml"
+
+    ```yaml
+    - Your Widget:
+        icon: yourwidget.svg
+        href: https://example.com/
+        widget:
+          type: yourwidget
+          url: http://127.0.0.1:1337
+          username: your-username
+          password: your-password
+    ```
+
+    ```yaml
+    - Your Widget:
+        icon: yourwidget.svg
+        href: https://example.com/
+        widget:
+          type: yourwidget
+          url: http://127.0.0.1:1337
+          key: your-api-token
+    ```
+
+### `synologyProxyHandler`
+
+A proxy handler that makes authenticated requests to the specified Synology API endpoint. This is used exclusively for Synology DSM services.
+
+=== "widget.js"
+
+    ```js
+    import synologyProxyHandler from "utils/proxy/handlers/synology";
+
+    const widgetExample = {
+      api: "{url}/webapi/{cgiPath}?api={apiName}&version={maxVersion}&method={apiMethod}",
+      proxyHandler: synologyProxyHandler,
+
+      mappings: {
+        system_storage: {
+          apiName: "SYNO.Core.System",
+          apiMethod: 'info&type="storage"',
+          endpoint: "system_storage",
+        }
+      },
+    };
+    ```
+
+=== "services.yaml"
+
+    ```yaml
+    - Your Widget:
+        icon: yourwidget.svg
+        href: https://example.com/
+        widget:
+          type: yourwidget
+          url: http://127.0.0.1:1337
+          username: your-username
+          password: your-password
+    ```
+
+## Creating a Custom Proxy Handler
+
+You can create your own proxy handler to fetch data from an API. A proxy handler is a function that takes a configuration object and returns a function that makes the API request.
+
+The proxy handler function takes three arguments:
+
+- `req`: The request object.
+- `res`: The response object.
+- `map`: A function that maps the API response to the widget data.
+
+The proxy handler function should return a promise that resolves to the API response.
+
+Here is an example of a simple proxy handler that fetches data from an API and passes it to the widget:
+
+```js
+import createLogger from "utils/logger";
+import { httpProxy } from "utils/proxy/http";
+
+const logger = createLogger("customProxyHandler");
+
+export default async function customProxyHandler(req, res, map) {
+  const { url } = req.query;
+
+  const [status, contentType, data] = await httpProxy(url);
+
+  return res.status(status).send(data);
+}
+```
+
+Proxy handlers are a complex topic and require a good understanding of JavaScript and the Homepage codebase. If you are new to Homepage, we recommend using the built-in proxy handlers.

docs/widgets/authoring/translations.md

@@ -0,0 +1,88 @@
+---
+title: Translations Guide
+description: Tips and tricks for translating and localizing Homepage widgets.
+---
+
+All text and numerical content in widgets should be translated and localized. English is the default language, and other languages can be added via [Crowdin](https://crowdin.com/project/gethomepage).
+
+## Translations
+
+Homepage uses the [next-i18next](https://github.com/i18next/next-i18next) library to handle translations. This library provides a set of hooks and utilities to help you localize your widgets, and Homepage has extended this library to support additional features.
+
+=== "component.jsx"
+
+    ```js
+    import { useTranslation } from "next-i18next";
+
+    import Container from "components/services/widget/container";
+    import Block from "components/services/widget/block";
+
+    export default function Component() {
+      const { t } = useTranslation();
+
+      return (
+        <Container service={service}>
+          <Block label="yourwidget.key1" />
+          <Block label="yourwidget.key2" />
+          <Block label="yourwidget.key3" />
+        </Container>
+      );
+    }
+    ```
+
+## Set up translation strings
+
+Homepage uses translated and localized strings for **all text and numerical content** in widgets. English is the default language, and other languages can be added via [Crowdin](https://crowdin.com/project/gethomepage). To add the English translations for your widget, follow these steps:
+
+Open the `public/locales/en/common.js` file.
+
+Add a new object for your widget to the bottom of the list, like this:
+
+```json
+"yourwidget": {
+  "key1": "Value 1",
+  "key2": "Value 2",
+  "key3": "Value 3"
+}
+```
+
+!!! note
+
+    Even if you natively speak another language, you should only add English translations. You can then add translations in your native language via [Crowdin](https://crowdin.com/project/gethomepage), once your widget is merged.
+
+## Common Translations
+
+Homepage provides a set of common translations that you can use in your widgets. These translations are used to format numerical content, dates, and other common elements.
+
+### Numbers
+
+| Key                   | Translation     | Description                      |
+| --------------------- | --------------- | -------------------------------- |
+| `common.bytes`        | `1,000 B`       | Format a number in bytes.        |
+| `common.bits`         | `1,000 bit`     | Format a number in bits.         |
+| `common.bbytes`       | `1 KiB`         | Format a number in binary bytes. |
+| `common.bbits`        | `1 Kibit`       | Format a number in binary bits.  |
+| `common.byterate`     | `1,000 B/s`     | Format a byte rate.              |
+| `common.bibyterate`   | `1 KiB/s`       | Format a binary byte rate.       |
+| `common.bitrate`      | `1,000 bit/s`   | Format a bit rate.               |
+| `common.bibitrate`    | `1 Kibit/s`     | Format a binary bit rate.        |
+| `common.percent`      | `50%`           | Format a percentage.             |
+| `common.number`       | `1,000`         | Format a number.                 |
+| `common.ms`           | `1,000 ms`      | Format a number in milliseconds. |
+| `common.date`         | `2024-01-01`    | Format a date.                   |
+| `common.relativeDate` | `1 day ago`     | Format a relative date.          |
+| `common.uptime`       | `1 day, 1 hour` | Format an uptime.                |
+
+### Text
+
+| Key                | Translation | Description        |
+| ------------------ | ----------- | ------------------ |
+| `resources.cpu`    | `CPU`       | CPU usage.         |
+| `resources.mem`    | `MEM`       | Memory usage.      |
+| `resources.total`  | `Total`     | Total resource.    |
+| `resources.free`   | `Free`      | Free resource.     |
+| `resources.used`   | `Used`      | Used resource.     |
+| `resources.load`   | `Load`      | Load value.        |
+| `resources.temp`   | `TEMP`      | Temperature value. |
+| `resources.max`    | `Max`       | Maximum value.     |
+| `resources.uptime` | `UP`        | Uptime.            |

docs/widgets/authoring/tutorial.md

@@ -0,0 +1,273 @@
+---
+title: Widget Tutorial
+description: Follow along with this guide to learn how to create a custom widget for Homepage. We'll cover the basic structure of a widget, how to use translations, and how to fetch data from an API.
+---
+
+In this guide, we'll walk through the process of creating a custom widget for Homepage. We'll cover the basic structure of a widget, how to use translations, and how to fetch data from an API. By the end of this guide, you'll have a solid understanding of how to build your own custom widget.
+
+**Prerequisites:**
+
+- Basic knowledge of React and JavaScript
+- Familiarity with the Homepage platform
+- Understanding of JSON and API interactions
+
+Throughout this guide, we'll use `yourwidget` as a placeholder for the unique name of your custom widget. Replace `yourwidget` with the actual name of your widget. It should contain only lowercase letters and no spaces.
+
+This guide makes use of a fake API, which would return a JSON response as such, when called with the `v1/info` endpoint:
+
+```json
+{ "key1": 123, "key2": 456, "key3": 789 }
+```
+
+## Set up the widget definition
+
+Create a new folder for your widget in the `src/widgets` directory. Name the folder `yourwidget`.
+
+Inside the `yourwidget` folder, create a new file named `widget.js`. This file will contain the metadata for your widget.
+
+Open the `widget.js` file and add the following code:
+
+```js title="src/widgets/yourwidget/widget.js"
+import genericProxyHandler from "utils/proxy/handlers/generic"; // (1)!
+
+const widget = /* (2)! */ {
+  api: "{url}/{endpoint}" /* (3)! */,
+  proxyHandler: genericProxyHandler /* (1)! */,
+
+  mappings: /* (4)! */ {
+    info: /* (5)! */ {
+      endpoint: "v1/info" /* (6)! */,
+    },
+  },
+};
+
+export default widget;
+```
+
+1. We import the `genericProxyHandler` from the `utils/proxy/handlers/generic` module. The `genericProxyHandler` is a generic handler that can be used to fetch data from an API. We then assign the `genericProxyHandler` to the `proxyHandler` property of the `widget` object. There are other handlers available that you can use depending on your requirements. You can also create custom handlers if needed.
+2. We define a `widget` object that contains the metadata for the widget.
+3. The API endpoint to fetch data from. You can use placeholders like `{url}` and `{endpoint}` to dynamically generate the API endpoint based on the widget configuration.
+4. An object that contains mappings for different endpoints. Each mapping should have an `endpoint` property that specifies the endpoint to fetch data from.
+5. A mapping named `info` that specifies the `v1/info` endpoint to fetch data from. This would be called from the component as such: `#!js useWidgetAPI(widget, "info");`
+6. The `endpoint` property of the `info` mapping specifies the endpoint to fetch data from. There are other properties you can pass to the mapping, such as `method`, `headers`, and `body`.
+
+!!! warning "Important"
+
+    All widgets that fetch data from dynamic endpoints should have either `mappings` or an `allowedEndpoints` property.
+
+## Including translation strings in your widget
+
+Refer to the [translations guide](translations.md) for more details. The Homepage community prides itself on being multilingual, and we strongly encourage you to add translations for your widgets.
+
+## Create the widget component
+
+Create a new file for your widgets component, named `component.jsx`, in the `src/widgets/yourwidget` directory. We'll build the contents of the `component.jsx` file step by step.
+
+First, we'll import the necessary dependencies:
+
+```js title="src/widgets/yourwidget/component.jsx" linenums="1"
+import { useTranslation } from "next-i18next"; // (1)!
+
+import Container from "components/services/widget/container"; // (2)!
+import Block from "components/services/widget/block"; // (3)!
+import useWidgetAPI from "utils/proxy/use-widget-api"; // (4)!
+```
+
+1. `#!js useTranslation()` is a hook provided by `next-i18next` that allows us to access the translation strings
+2. `#!jsx <Container>` and `#!jsx <Block>` are custom components that we'll use to structure our widget.
+3. `#!jsx <Container>` and `#!jsx <Block>` are custom components that we'll use to structure our widget.
+4. `#!js useWidgetAPI(widget, endpoint)` is a custom hook that we'll use to fetch data from an API.
+
+---
+
+Next, we'll define a functional component named `Component` that takes a `service` prop.
+
+```js title="src/widgets/yourwidget/component.jsx" linenums="7"
+export default function Component({ service }) {}
+```
+
+---
+
+We grab the helper functions from the `useTranslation` hook.
+
+```js title="src/widgets/yourwidget/component.jsx" linenums="8"
+const { t } = useTranslation();
+```
+
+---
+
+We destructure the `widget` object from the `service` prop. The `widget` object contains the metadata for the widget, such as the API endpoint to fetch data from.
+
+```js title="src/widgets/yourwidget/component.jsx" linenums="9"
+const { widget } = service;
+```
+
+---
+
+Now, the fun part! We use the `useWidgetAPI` hook to fetch data from an API. The `useWidgetAPI` hook takes two arguments: the `widget` object and the API endpoint to fetch data from. The `useWidgetAPI` hook returns an object with `data` and `error` properties.
+
+```js title="src/widgets/yourwidget/component.jsx" linenums="10"
+const { data, error } = useWidgetAPI(widget, "info");
+```
+
+!!! tip "API Tips"
+
+    You'll see here how part of the API url is built using the `url` and `endpoint` properties from the widget definition.
+
+    In this case, we're fetching data from the `info` endpoint.  The `info` endpoint is defined in the `mappings` object.  So the full API endpoint will be `"{url}/v1/info"`.
+
+    The mapping and endpoint are often the same, but must be defined regardless.
+
+---
+
+Next, we check if there's an error or no data.
+
+If there's an error, we return a `Container` and pass it the `service` and `error` as props. The `Container` component will handle displaying the error message.
+
+```js title="src/widgets/yourwidget/component.jsx" linenums="12"
+if (error) {
+  return <Container service={service} error={error} />;
+}
+```
+
+---
+
+If there's no data, we return a `Container` component with three `Block` components, each with a `label`.
+
+```js title="src/widgets/yourwidget/component.jsx" linenums="16"
+if (!data) {
+  return (
+    <Container service={service}>
+      <Block label="yourwidget.key1" />
+      <Block label="yourwidget.key2" />
+      <Block label="yourwidget.key3" />
+    </Container>
+  );
+}
+```
+
+This will render the widget with placeholders for the data, i.e., a skeleton view.
+
+!!! tip "Translation Tips"
+
+      The `label` prop in the `Block` component corresponds to the translation key we defined earlier in the `common.js` file.  All text and numerical content should be translated.
+
+---
+
+If there is data, we return a `Container` component with three `Block` components, each with a `label` and a `value`.
+
+Here we use the `t` function from the `useTranslation` hook to translate the data values. The `t` function takes the translation key and an object with variables to interpolate into the translation string.
+
+We're using the `common.number` translation key to format the data values as numbers. This allows for easy localization of numbers, such as using commas or periods as decimal separators.
+
+There are a large number of `common` numerical translation keys available, which you can learn more about in the [Translation Guide](translations.md).
+
+```js title="src/widgets/yourwidget/component.jsx" linenums="26"
+return (
+  <Container service={service}>
+    <Block label="yourwidget.key1" value={t("common.number", { value: data.key1 })} />
+    <Block label="yourwidget.key2" value={t("common.number", { value: data.key2 })} />
+    <Block label="yourwidget.key3" value={t("common.number", { value: data.key3 })} />
+  </Container>
+);
+```
+
+---
+
+Here's the complete `component.jsx` file:
+
+```js title="src/widgets/yourwidget/component.jsx" linenums="1"
+import { useTranslation } from "next-i18next";
+
+import Container from "components/services/widget/container";
+import Block from "components/services/widget/block";
+import useWidgetAPI from "utils/proxy/use-widget-api";
+
+export default function Component({ service }) {
+  const { t } = useTranslation();
+  const { widget } = service;
+  const { data, error } = useWidgetAPI(widget, "info");
+
+  if (error) {
+    return <Container service={service} error={error} />;
+  }
+
+  if (!data) {
+    return (
+      <Container service={service}>
+        <Block label="yourwidget.key1" />
+        <Block label="yourwidget.key2" />
+        <Block label="yourwidget.key3" />
+      </Container>
+    );
+  }
+
+  return (
+    <Container service={service}>
+      <Block label="yourwidget.key1" value={t("common.number", { value: data.key1 })} />
+      <Block label="yourwidget.key2" value={t("common.number", { value: data.key2 })} />
+      <Block label="yourwidget.key3" value={t("common.number", { value: data.key3 })} />
+    </Container>
+  );
+}
+```
+
+## Add the widget to the Homepage
+
+To add your widget to the Homepage, you need to register it in the `src/widgets/widgets.js` file.
+
+Open the `src/widgets/widgets.js` file and import the `Component` from your widget's `component.jsx` file. Please keep the alphabetical order.
+
+```js
+// ...
+import yourwidget from "./yourwidget/widget";
+// ...
+```
+
+Add `yourwidget` to the `widgets` object. Please keep the alphabetical order.
+
+```js
+const widgets = {
+  // ...
+  yourwidget: yourwidget,
+  // ...
+};
+```
+
+You also need to add the widget to the `components` object in the `src/widgets/components.js` file.
+
+Open the `src/widgets/components.js` file and import the `Component` from your widget's `component.jsx` file.
+
+Please keep the alphabetical order.
+
+```js
+const components = {
+  // ...
+  yourwidget: dynamic(() => import("./yourwidget/component")),
+  // ...
+};
+```
+
+## Using the widget
+
+You can now use your custom widget in your Homepage. Open your `services.yaml` file and add a new service with the `yourwidget` widget.
+
+```yaml
+- Services:
+    - Your Widget:
+        icon: yourwidget.svg
+        href: https://example.com/
+        widget:
+          type: yourwidget
+          url: http://127.0.0.1:1337
+```
+
+!!! tip "API Tips"
+
+    You'll see here how part of the API url is built using the `url` and `endpoint` properties from the widget definition.
+
+    We defined the api endpoint as `"{url}/{endpoint}"`.  This is where the `url` is defined.  So the full API endpoint will be `http://127.0.0.1:1337/{endpoint}`.
+
+---
+
+That's it! You've successfully created a custom widget for Homepage. If you have any questions or need help, feel free to reach out to the Homepage community for assistance. Happy coding!

docs/widgets/index.md

@@ -0,0 +1,38 @@
+---
+title: Widgets
+description: Find information on how to configure specific widgets in Homepage.
+icon: material/widgets
+---
+
+Homepage has two types of widgets: info and service. Below we'll cover each type and how to configure them.
+
+The left navigation of this site contains links to all available widgets.
+
+## Service Widgets
+
+Service widgets are used to display the status of a service, often a web service or API. Services (and their widgets) are defined in your `services.yaml` file. Here's an example:
+
+```yaml
+- Plex:
+    icon: plex.png
+    href: https://plex.my.host
+    description: Watch movies and TV shows.
+    server: localhost
+    container: plex
+    widget:
+      type: tautulli
+      url: http://172.16.1.1:8181
+      key: aabbccddeeffgghhiijjkkllmmnnoo
+```
+
+## Info Widgets
+
+Info widgets are used to display information in the header, often about your system or environment. Info widgets are defined your `widgets.yaml` file. Here's an example:
+
+```yaml
+- openmeteo:
+    label: Current
+    latitude: 36.66
+    longitude: -117.51
+    cache: 5
+```

docs/widgets/info/datetime.md

@@ -0,0 +1,51 @@
+---
+title: Date & Time
+description: Date & Time Information Widget Configuration
+---
+
+This allows you to display the date and/or time, can be heavily configured using [Intl.DateTimeFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat).
+
+Formatting is locale aware and will present your date in the regional format you expect, for example, `9/16/22, 3:03 PM` for locale `en` and `16.09.22, 15:03` for `de`. You can also specify a locale just for the datetime widget with the `locale` option (see below).
+
+```yaml
+- datetime:
+    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.
+
+Valid text sizes are `4xl`, `3xl`, `2xl`, `xl`, `md`, `sm`, `xs`.
+
+A few examples,
+
+```yaml
+# 13:37
+format:
+  timeStyle: short
+  hourCycle: h23
+```
+
+```yaml
+# 1:37 PM
+format:
+  timeStyle: short
+  hour12: true
+```
+
+```yaml
+# 1/23/22, 1:37 PM
+format:
+  dateStyle: short
+  timeStyle: short
+  hour12: true
+```
+
+```yaml
+# 4 januari 2023 om 13:51:25 PST
+locale: nl
+format:
+  dateStyle: long
+  timeStyle: long
+```

docs/widgets/info/glances.md

@@ -0,0 +1,35 @@
+---
+title: Glances
+description: Glances Information Widget Configuration
+---
+
+_(Find the Glances service widget [here](../services/glances.md))_
+
+The Glances widget allows you to monitor the resources (CPU, memory, storage, temp & uptime) of host or another machine, and is designed to match the `resources` info widget. You can have multiple instances by adding another configuration block. The `cputemp`, `uptime` & `disk` states require separate API calls and thus are not enabled by default. Glances needs to be running in "web server" mode to enable the API, see the [glances docs](https://glances.readthedocs.io/en/latest/quickstart.html#web-server-mode).
+
+```yaml
+- glances:
+    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:
+
+```yaml
+disk:
+  - /
+  - /boot
+  ...
+```
+
+_Added in v0.4.18, updated in v0.6.11, v0.6.21_

docs/widgets/info/greeting.md

@@ -0,0 +1,14 @@
+---
+title: Greeting
+description: Greeting Information Widget Configuration
+---
+
+This allows you to display simple text, can be configured like so:
+
+```yaml
+- greeting:
+    text_size: xl
+    text: Greeting Text
+```
+
+Valid text sizes are `4xl`, `3xl`, `2xl`, `xl`, `md`, `sm`, `xs`.

docs/widgets/info/index.md

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

docs/widgets/info/kubernetes.md

@@ -0,0 +1,31 @@
+---
+title: Kubernetes
+description: Kubernetes Information Widget Configuration
+---
+
+This is very similar to the Resources widget, but provides resource information about a Kubernetes cluster.
+
+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
+```

docs/widgets/info/logo.md

@@ -0,0 +1,13 @@
+---
+title: Logo
+description: Logo Information Widget Configuration
+---
+
+This allows you to display the homepage logo, you can optionally specify your own icon using similar options as other icons, see [service icons](../../configs/services.md#icons).
+
+```yaml
+- logo:
+    icon: https://upload.wikimedia.org/wikipedia/commons/thumb/d/d5/I_Love_New_York.svg/1101px-I_Love_New_York.svg.png # optional
+```
+
+_Added in v0.4.18, updated in 0.X.X_

docs/widgets/info/longhorn.md

@@ -0,0 +1,37 @@
+---
+title: Longhorn
+description: Longhorn Storage Widget Configuration
+---
+
+The Longhorn widget pulls storage utilization metrics from the Longhorn storage driver on Kubernetes.
+It is designed to appear similar to the Resource widget's disk representation.
+
+The exact metrics should be very similar to what is seen on the Longhorn dashboard itself.
+
+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
+```
+
+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

@@ -0,0 +1,20 @@
+---
+title: Open-Meteo
+description: Open-Meteo Information Widget Configuration
+---
+
+No registration is required at all! See [https://open-meteo.com/en/docs](https://open-meteo.com/en/docs)
+
+```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
+    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

@@ -0,0 +1,21 @@
+---
+title: OpenWeatherMap
+description: OpenWeatherMap Information Widget Configuration
+---
+
+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
+    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

@@ -0,0 +1,76 @@
+---
+title: Resources
+description: Resources Information Widget Configuration
+---
+
+You can include all or some of the available resources. If you do not want to see that resource, simply pass `false`.
+
+The disk path is the path reported by `df` (Mounted On), or the mount point of the disk.
+
+The cpu and memory resource information are the container's usage while [glances](glances.md) displays statistics for the host machine on which it is installed.
+
+The resources widget primarily relies on a popular tool called [systeminformation](https://systeminformation.io). Thus, any limitiations of that software apply, for example, BRTFS RAID is not supported for the disk usage. In this case users may want to use the [glances widget](glances.md) instead.
+
+_Note: unfortunately, the package used for getting CPU temp ([systeminformation](https://systeminformation.io)) is not compatible with some setups and will not report any value(s) for CPU temp._
+
+**Any disk you wish to access must be mounted to your container as a volume.**
+
+```yaml
+- resources:
+    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
+
+- resources:
+    label: Storage
+    disk: /mnt/storage
+```
+
+Which produces something like this,
+
+<img width="373" alt="Resource Groups" src="https://user-images.githubusercontent.com/82196/189524699-e9005138-e049-4a9c-8833-ac06e39882da.png">
+
+If you have more than a single disk and would like to group them together under the same label, you can pass an array of paths instead,
+
+```yaml
+- resources:
+    label: Storage
+    disk:
+      - /mnt/storage
+      - /mnt/backup
+      - /mnt/media
+```
+
+To produce something like this,
+
+<img width="369" alt="Screenshot 2022-09-11 at 2 15 42 PM" src="https://user-images.githubusercontent.com/82196/189524583-abdf4cc6-99da-430c-b316-16c567db5639.png">
+
+You can additionally supply an optional `expanded` property set to true in order to show additional details about the resources. By default the expanded property is set to false when not supplied.
+
+```yaml
+- resources:
+    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

@@ -0,0 +1,55 @@
+---
+title: Search
+description: Search Information Widget Configuration
+---
+
+You can add a search bar to your top widget area that can search using Google, Duckduckgo, Bing, Baidu, Brave or any other custom provider that supports the basic `?q=` search query param.
+
+```yaml
+- search:
+    provider: google # google, duckduckgo, bing, baidu, brave or custom
+    focus: true # Optional, will set focus to the search bar on page load
+    showSearchSuggestions: true # Optional, will show search suggestions. Defaults to false
+    target: _blank # One of _self, _blank, _parent or _top
+```
+
+or for a custom search:
+
+```yaml
+- search:
+    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]
+```
+
+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/stocks.md

@@ -0,0 +1,48 @@
+---
+title: Stocks
+description: Stocks Information Widget Configuration
+---
+
+_(Find the Stocks service widget [here](../services/stocks.md))_
+
+The Stocks Information Widget allows you to include basic stock market data in
+your Homepage header. The widget includes the current price of a stock, and the
+change in price for the day.
+
+Finnhub.io is currently the only supported provider for the stocks widget.
+You can sign up for a free api key at [finnhub.io](https://finnhub.io).
+You are encouraged to read finnhub.io's
+[terms of service/privacy policy](https://finnhub.io/terms-of-service) before
+signing up. The documentation for the endpoint that is utilized can be viewed
+[here](https://finnhub.io/docs/api/quote).
+
+You must set `finnhub` as a provider in your `settings.yaml` like below:
+
+```yaml
+providers:
+  finnhub: yourfinnhubapikeyhere
+```
+
+Next, configure the stocks widget in your `widgets.yaml`:
+
+The information widget allows for up to 8 items in the watchlist.
+
+```yaml
+- stocks:
+    provider: finnhub
+    color: true # optional, defaults to true
+    cache: 1 # optional, default caches results for 1 minute
+    watchlist:
+      - GME
+      - AMC
+      - NVDA
+      - AMD
+      - TSM
+      - MSFT
+      - AAPL
+      - BRK.A
+```
+
+The above configuration would result in something like this:
+
+![Example of Stocks Widget](../../assets/widget_stocks_demo.png)

docs/widgets/info/unifi_controller.md

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

docs/widgets/info/weather.md

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

docs/widgets/services/adguard-home.md

@@ -0,0 +1,18 @@
+---
+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
+```

docs/widgets/services/atsumeru.md

@@ -0,0 +1,18 @@
+---
+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
+```

docs/widgets/services/audiobookshelf.md

@@ -0,0 +1,17 @@
+---
+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
+```

docs/widgets/services/authentik.md

@@ -0,0 +1,25 @@
+---
+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 under `Admin Portal` > `Directory` > `Tokens & App passwords`.
+Make sure to set Intent to "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
+```

docs/widgets/services/autobrr.md

@@ -0,0 +1,17 @@
+---
+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
+```

docs/widgets/services/azuredevops.md

@@ -0,0 +1,28 @@
+---
+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.<br>
+   Allowed fields: `["result", "status"]`.
+
+2. Pull Requests: returns the amount of open PRs, the amount of the PRs you have open, and how many PRs that you open are marked as 'Approved' by at least 1 person and not yet completed.<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
+```

docs/widgets/services/bazarr.md

@@ -0,0 +1,17 @@
+---
+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
+```

docs/widgets/services/caddy.md

@@ -0,0 +1,14 @@
+---
+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
+```

docs/widgets/services/calendar.md

@@ -0,0 +1,57 @@
+---
+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.
+
+```yaml
+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, 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

@@ -0,0 +1,18 @@
+---
+title: Calibre-web
+description: Calibre-web Widget Configuration
+---
+
+Learn more about [Calibre-web](https://github.com/janeczku/calibre-web).
+
+**Note: widget requires calibre-web ≥ v0.6.21.**
+
+Allowed fields: `["books", "authors", "categories", "series"]`.
+
+```yaml
+widget:
+  type: calibreweb
+  url: http://your.calibreweb.host:port
+  username: username
+  password: password
+```

docs/widgets/services/changedetectionio.md

@@ -0,0 +1,15 @@
+---
+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
+```

docs/widgets/services/channelsdvrserver.md

@@ -0,0 +1,12 @@
+---
+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://server.host.or.ip:port
+```