docs(mcp): restore custom widget authoring guidance

fix(mcp): harden tool schemas and dispatch (#6815 )
ci: remove automatic test gates and trim test suites (#6816 )
2026-09-10 19:24:32 +02:00 · 2026-09-10 19:19:47 +02:00 · 2026-09-10 19:14:31 +02:00 · 2026-09-10 17:53:38 +02:00 · 2026-09-09 15:04:27 +02:00 · 2026-09-09 12:09:14 +02:00
560 changed files with 17447 additions and 15002 deletions
@@ -32,24 +32,23 @@ Import only from an exported package entrypoint. Do not deep-import `@homarr/com

 ## Root exports

-| Area              | Public exports                                                                                                                                       | Purpose                                                         |
-| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- |
-| Objects           | `objectKeys`, `objectEntries`, `hashObjectBase64`                                                                                                    | Typed key/entry iteration and stable query-key hashing          |
-| Strings           | `capitalize`, `isNullOrWhitespace`, `bestMatch`, `normalizeImageName`, `getImageMatchRank`                                                           | Text normalization and matching                                 |
-| Cookies           | `parseCookies`, `setClientCookie`                                                                                                                    | Cookie parsing and browser cookie serialization                 |
-| Arrays            | `splitToNChunks`, `splitToChunksWithNItems`                                                                                                          | Split by number of groups or maximum group size                 |
-| Dates             | `formatDuration`, `toValidDate`, `isDateWithin`                                                                                                      | Duration formatting, safe date coercion, relative-window checks |
-| Timing            | `Stopwatch`                                                                                                                                          | Elapsed-time measurement and formatting                         |
-| React hooks       | `useTimeAgo`, `useIntegrationConnected`                                                                                                              | Relative time and integration freshness state                   |
-| URLs              | `removeTrailingSlash`, `extractBaseUrlFromHeaders`, `getPortFromUrl`, `isAbsoluteUrl`, `SAFE_NEW_TAB_REL`, `getSafeApplicationUrl`, `getSafeAppHref` | URL normalization, safe navigation, ports, and new-tab policy   |
-| Numbers and bytes | `formatNumber`, `randomInt`, `formatBytes`, `formatBytesPair`, `formatByteRate`, `metricToImperial`, `imperialToMetric`                              | Compact numbers, byte displays, rates, and unit conversion      |
-| Legacy bytes      | `humanFileSize`                                                                                                                                      | Deprecated; use the `formatBytes*` helpers in new code          |
-| Byte types        | `ByteUnitSystem`, `FormatBytesOptions`                                                                                                               | Options for byte formatting                                     |
-| Errors            | `extractErrorMessage`, `FlattenError`                                                                                                                | Unknown-error messages and flattenable domain errors            |
-| Theme             | `getMantineColor`                                                                                                                                    | Resolve a Mantine color and shade                               |
-| Functions         | `isFunction`                                                                                                                                         | Unknown-value function guard                                    |
-| Grid              | `GridAlgorithmItem`, `generateResponsiveGridFor`                                                                                                     | Responsive nested-section grid placement                        |
-| IDs               | `createId`                                                                                                                                           | CUID2 ID creation                                               |
+| Area              | Public exports                                                                                                                                       | Purpose                                                                |
+| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
+| Objects           | `objectKeys`, `objectEntries`, `isRecord`, `hashObjectBase64`                                                                                        | Typed key/entry iteration, record guards, and stable query-key hashing |
+| Strings           | `capitalize`, `isNullOrWhitespace`, `bestMatch`, `normalizeImageName`, `getImageMatchRank`                                                           | Text normalization and matching                                        |
+| Cookies           | `parseCookies`, `setClientCookie`                                                                                                                    | Cookie parsing and browser cookie serialization                        |
+| Arrays            | `splitToNChunks`, `splitToChunksWithNItems`                                                                                                          | Split by number of groups or maximum group size                        |
+| Dates             | `formatDuration`, `toValidDate`, `isDateWithin`                                                                                                      | Duration formatting, safe date coercion, relative-window checks        |
+| Timing            | `Stopwatch`                                                                                                                                          | Elapsed-time measurement and formatting                                |
+| React hooks       | `useTimeAgo`, `useIntegrationConnected`                                                                                                              | Relative time and integration freshness state                          |
+| URLs              | `removeTrailingSlash`, `extractBaseUrlFromHeaders`, `getPortFromUrl`, `isAbsoluteUrl`, `SAFE_NEW_TAB_REL`, `getSafeApplicationUrl`, `getSafeAppHref` | URL normalization, safe navigation, ports, and new-tab policy          |
+| Numbers and bytes | `formatNumber`, `formatBytes`, `formatBytesPair`, `formatByteRate`, `formatBitRate`, `defaultByteUnitSystem`, `metricToImperial`                     | Compact numbers, byte displays, byte/bit rates, and unit conversion    |
+| Byte types        | `ByteUnitSystem`, `FormatBytesOptions`, `FormatBitRateOptions`                                                                                       | Options for byte and bit-rate formatting                               |
+| Errors            | `extractErrorMessage`, `FlattenError`                                                                                                                | Unknown-error messages and flattenable domain errors                   |
+| Theme             | `getMantineColor`                                                                                                                                    | Resolve a Mantine color and shade                                      |
+| Functions         | `isFunction`                                                                                                                                         | Unknown-value function guard                                           |
+| Grid              | `GridAlgorithmItem`, `generateResponsiveGridFor`                                                                                                     | Responsive nested-section grid placement                               |
+| IDs               | `createId`                                                                                                                                           | CUID2 ID creation                                                      |

 The root deliberately does not re-export `types`, `server`, `client`, or `env`; use their named entrypoints.

@@ -1,22 +1,24 @@
 # Since .env is gitignored, you can use .env.example to build a new `.env` file when you clone the repo.
-# Keep this file up-to-date when you add new variables to \`.env\`.
+# Keep this file up-to-date when you add new variables to `.env`.

 # This file will be committed to version control, so make sure not to have any secrets in it.
 # If you are cloning this repo, create a copy of this file named `.env` and populate it with your secrets.

-# The below secret is not used anywhere but required for Auth.js (Would encrypt JWTs and Mail hashes, both not used)
-AUTH_SECRET="supersecret"
+# Generate two different 64-character hex values with `openssl rand -hex 32` before starting Homarr.
+# Never reuse these values or commit the populated `.env` file.
+AUTH_SECRET=

 # The below secret is used to encrypt integration secrets in the database.
-# It should be a 32-byte string, generated by running `openssl rand -hex 32` on Unix
-# or starting the project without any (which will show a randomly generated one).
-SECRET_ENCRYPTION_KEY=0000000000000000000000000000000000000000000000000000000000000000
+# Homarr will reject an empty or invalid value and print a randomly generated candidate.
+SECRET_ENCRYPTION_KEY=

 LOG_LEVEL='info'

 # This is how you can use the sqlite driver:
 DB_DRIVER='better-sqlite3'
-DB_URL='FULL_PATH_TO_YOUR_SQLITE_DB_FILE'
+# Safe local source-development path. SQLite files are ignored by Git.
+# Container images use /appdata/db/db.sqlite by default instead.
+DB_URL='./db.sqlite'

 # Those are the two ways to use the mysql2 driver:
 # 1. Using the URL format:
@@ -63,6 +65,8 @@ UNSAFE_ENABLE_MOCK_INTEGRATION=true

 # Public URL contract. Values must be absolute HTTP(S) URLs without credentials,
 # query strings, or fragments. Trailing slashes are normalized at startup.
+# Public Homarr origin used by MCP OAuth metadata and redirects behind proxies.
+# BASE_URL=https://homarr.example.com
 HOMARR_WEBSITE_URL=https://homarr.dev
 # PocketBase API used by Homarr and by the standalone documentation site.
 # Defaults to HOMARR_WEBSITE_URL.
@@ -4,14 +4,14 @@
  <h3>Homarr</h3>
 </div>

-**Thank you for your contribution. Please ensure that your pull request meets the following pull request:**
+**Thank you for your contribution. Please ensure that your pull request meets the following requirements:**

- [ ] Builds without warnings or errors (`pnpm build`, autofix with `pnpm format:fix`)
- [ ] Pull request targets `dev` branch
+- [ ] Relevant checks pass without warnings or errors
+- [ ] Pull request targets the intended base branch (`dev` by default; `release/v2` for v2 release work)
 - [ ] Commits follow the [conventional commits guideline](https://www.conventionalcommits.org/en/v1.0.0/)
- [ ] No shorthand variable names are used (eg. `x`, `y`, `i` or any abbrevation)
- [ ] Documentation is up to date. Create a pull request [here](https://github.com/homarr-labs/documentation/).
- [ ] When using AI; No temp files are checked in, the code style follows the rest of the project
+- [ ] No shorthand variable names are used (for example, `x`, `y`, `i`, or abbreviations)
+- [ ] User-facing changes include matching documentation updates under `apps/docs`
+- [ ] When using AI, no temporary files are checked in and the code style follows the rest of the project

 **When contributing a new integration or widget:**

@@ -20,7 +20,7 @@ jobs:
        uses: actions/create-github-app-token@v3
        with:
          private-key: ${{ secrets.RENOVATE_APPROVE_PRIVATE_KEY }}
-          client-id: ${{ secrets.RENOVATE_APPROVE_APP_ID }}
+          client-id: ${{ vars.RENOVATE_APPROVE_CLIENT_ID }}
          permission-pull-requests: write # required to enable auto-merge

      - name: Install GitHub CLI
@@ -28,7 +28,7 @@ jobs:
        uses: actions/create-github-app-token@v3
        with:
          private-key: ${{ secrets.RENOVATE_APPROVE_PRIVATE_KEY }}
-          client-id: ${{ secrets.RENOVATE_APPROVE_APP_ID }}
+          client-id: ${{ vars.RENOVATE_APPROVE_CLIENT_ID }}
          permission-pull-requests: write # required to approve a pull request and enable auto-merge

      - name: Install GitHub CLI
@@ -97,17 +97,16 @@ jobs:

      - name: Validate Custom Widget bundle budget
        run: |
-          pnpm --filter nextjs build
+          pnpm turbo run build --filter=@homarr/nextjs
          pnpm check:custom-widget-bundle

-      - name: Run unit tests
-        run: pnpm test
-
  container:
-    name: Container and E2E
+    name: Container build
+    # Same-repository previews already build amd64; only build a fallback when no digest is available.
    needs: [fast-gate, preview-amd64]
    if: |
      !cancelled() && needs.fast-gate.result == 'success' &&
+      needs.preview-amd64.result != 'failure' && needs.preview-amd64.outputs.digest == '' &&
      (
        github.event_name == 'merge_group' ||
        (github.event_name == 'push' && github.ref == 'refs/heads/release/v2') ||
@@ -115,10 +114,9 @@ jobs:
        (github.event_name == 'workflow_dispatch' && (inputs.operation == 'validate' || inputs.operation == 'publish'))
      )
    runs-on: ubuntu-latest
-    timeout-minutes: 30
+    timeout-minutes: 20
    permissions:
      contents: read
-      packages: read
    steps:
      - uses: actions/checkout@v7
        if: "!env.ACT"
@@ -126,23 +124,10 @@ jobs:
          persist-credentials: false
          ref: ${{ github.event_name == 'workflow_dispatch' && inputs.ref || '' }}

-      - name: Setup
-        uses: ./tooling/github/setup
-
      - name: Set up Docker Buildx
-        if: "!env.ACT"
+        if: needs.preview-amd64.outputs.digest == '' && !env.ACT
        uses: docker/setup-buildx-action@v4

-      - name: Reuse amd64 preview image
-        if: needs.preview-amd64.outputs.digest != '' && !env.ACT
-        env:
-          DIGEST: ${{ needs.preview-amd64.outputs.digest }}
-        run: |
-          echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u "${{ github.actor }}" --password-stdin
-          docker pull "${PREVIEW_IMAGE}@${DIGEST}"
-          docker tag "${PREVIEW_IMAGE}@${DIGEST}" homarr-ci
-          docker tag "${PREVIEW_IMAGE}@${DIGEST}" homarr-e2e
-
      - name: Build container once
        if: needs.preview-amd64.outputs.digest == '' && !env.ACT
        uses: docker/build-push-action@v7
@@ -152,9 +137,7 @@ jobs:
          platforms: linux/amd64
          load: true
          push: false
-          tags: |
-            homarr-ci
-            homarr-e2e
+          tags: homarr-ci
          labels: |
            org.opencontainers.image.source=${{ github.server_url }}/${{ github.repository }}
            org.opencontainers.image.revision=${{ github.sha }}
@@ -182,37 +165,7 @@ jobs:
            fi
          done
          DOCKER_BUILDKIT=1 docker build --platform linux/amd64 \
-            --tag homarr-ci --tag homarr-e2e "${secret_args[@]}" .
-
-      - name: Cache Playwright browsers
-        if: "!env.ACT"
-        id: playwright-cache
-        uses: actions/cache@v6
-        with:
-          path: ~/.cache/ms-playwright
-          key: playwright-${{ runner.os }}-${{ hashFiles('pnpm-lock.yaml') }}
-
-      - name: Install Playwright Chromium
-        if: steps.playwright-cache.outputs.cache-hit != 'true' || env.ACT
-        run: pnpm exec playwright install --with-deps chromium
-
-      - name: Install Playwright system deps
-        if: steps.playwright-cache.outputs.cache-hit == 'true'
-        run: pnpm exec playwright install-deps chromium
-
-      - name: Run E2E tests
-        env:
-          NODE_ENV: development
-          CI: "true"
-        run: pnpm exec vitest e2e --retry 1 --maxWorkers 4
-
-      - name: Upload E2E artifacts
-        if: failure() && !env.ACT
-        uses: actions/upload-artifact@v7
-        with:
-          name: playwright-report
-          path: e2e/test-results/
-          retention-days: 7
+            --tag homarr-ci "${secret_args[@]}" .

  preview-amd64:
    name: Build amd64 preview image
@@ -320,10 +273,10 @@ jobs:

  publish-preview:
    name: Publish multi-platform preview image
-    needs: [container, preview-amd64, preview-arm64]
+    needs: [fast-gate, preview-amd64, preview-arm64]
    if: |
      !cancelled() &&
-      needs.container.result == 'success' &&
+      needs.fast-gate.result == 'success' &&
      needs.preview-amd64.result == 'success' &&
      needs.preview-arm64.result == 'success' &&
      (
@@ -22,7 +22,7 @@ jobs:
        uses: actions/create-github-app-token@v3
        with:
          private-key: ${{ secrets.CROWDIN_APP_PRIVATE_KEY }}
-          client-id: ${{ secrets.CROWDIN_APP_ID }}
+          client-id: ${{ vars.CROWDIN_CLIENT_ID }}
          permission-contents: write # required to commit to crowdin branch
          permission-pull-requests: write # required to create pull request

@@ -52,7 +52,7 @@ jobs:
        uses: actions/create-github-app-token@v3
        with:
          private-key: ${{ secrets.RENOVATE_APPROVE_PRIVATE_KEY }}
-          client-id: ${{ secrets.RENOVATE_APPROVE_APP_ID }}
+          client-id: ${{ vars.RENOVATE_APPROVE_CLIENT_ID }}
          permission-pull-requests: write
      - name: Approve PR
        env:
@@ -64,7 +64,7 @@ jobs:
        uses: actions/create-github-app-token@v3
        with:
          private-key: ${{ secrets.RENOVATE_MERGE_PRIVATE_KEY }}
-          client-id: ${{ secrets.RENOVATE_MERGE_APP_ID }}
+          client-id: ${{ vars.RENOVATE_MERGE_CLIENT_ID }}
          permission-contents: write # write to beta branch (due to merge)
          permission-pull-requests: write # merge pull request
      - id: automerge
@@ -40,6 +40,7 @@ jobs:
      version: ${{ steps.read-semver.outputs.version || steps.version-fallback.outputs.version }}
      git_ref: ${{ steps.read-git-ref.outputs.ref || steps.read-semver.outputs.version || github.ref }}
      skipped: ${{ env.SKIP_RELEASE }}
+      upstream_sync: ${{ steps.update-upstream.outcome }}
    steps:
      - run: echo "Manual dispatch redeploys the latest existing release without creating a new one"
        if: env.SKIP_RELEASE == 'true'
@@ -54,7 +55,7 @@ jobs:
        uses: actions/create-github-app-token@v3
        with:
          private-key: ${{ secrets.RENOVATE_MERGE_PRIVATE_KEY }}
-          client-id: ${{ secrets.RENOVATE_MERGE_APP_ID }}
+          client-id: ${{ vars.RENOVATE_MERGE_CLIENT_ID }}
          permission-contents: write # required to commit package.json & changelog changes, merge them to dev / next and publish the release

      - uses: actions/checkout@v7
@@ -115,8 +116,10 @@ jobs:
        run: |
          echo "ref=$(git rev-parse HEAD)" >> "$GITHUB_OUTPUT"
      - name: Update dev / next branch
+        id: update-upstream
        if: env.SKIP_RELEASE == 'false'
-        continue-on-error: true # Prevent pipeline from failing when merge fails
+        # Finish publishing the already-created release, then fail in the publish job if synchronization did not work.
+        continue-on-error: true
        env:
          GITHUB_TOKEN: ${{ steps.obtainToken.outputs.token }}
          UPSTREAM_BRANCH: ${{ github.ref_name == 'main' && 'dev' || 'next' }}
@@ -274,7 +277,7 @@ jobs:
        uses: actions/create-github-app-token@v3
        with:
          private-key: ${{ secrets.RENOVATE_MERGE_PRIVATE_KEY }}
-          client-id: ${{ secrets.RENOVATE_MERGE_APP_ID }}
+          client-id: ${{ vars.RENOVATE_MERGE_CLIENT_ID }}
          permission-contents: write # required to publish the release

      - name: Log in to the Container registry
@@ -311,6 +314,12 @@ jobs:
        run: |
          gh release edit --repo ${{ github.repository }} ${{ needs.release.outputs.version }} --draft=false

+      - name: Verify dev / next synchronization
+        if: needs.release.outputs.skipped == 'false' && needs.release.outputs.upstream_sync != 'success'
+        run: |
+          echo "::error::The released commit was not synchronized back to the upstream development branch."
+          exit 1
+
      - name: Discord notification
        if: github.event_name != 'workflow_dispatch' || inputs['send-notifications']
        env:
@@ -318,3 +327,17 @@ jobs:
        uses: Ilshidur/action-discord@0.4.0
        with:
          args: "Successfully deployed images for branch **${{ github.ref_name }}**. Tagged as **${{env.NEXT_VERSION}}**."
+
+  notify-failure:
+    name: Notify deployment failure
+    if: ${{ always() && (failure() || cancelled()) && (github.event_name != 'workflow_dispatch' || inputs['send-notifications']) }}
+    needs: [release, build-amd64, build-arm64, extract-asset-amd64, extract-asset-arm64, publish]
+    runs-on: ubuntu-latest
+    timeout-minutes: 2
+    steps:
+      - name: Discord failure notification
+        env:
+          DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
+        uses: Ilshidur/action-discord@0.4.0
+        with:
+          args: "The deployment for branch **${{ github.ref_name }}** failed or was cancelled: [run ${{ github.run_number }}](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }})"
@@ -19,10 +19,10 @@ permissions:
 jobs:
  create-and-merge-pr:
    runs-on: ubuntu-latest
-    timeout-minutes: 2
+    timeout-minutes: 10
    steps:
      - name: Discord notification
-        if: ${{ github.event.inputs.send-notifications }}
+        if: ${{ github.event_name == 'schedule' || inputs.send-notifications }}
        env:
          DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
        uses: Ilshidur/action-discord@0.4.0
@@ -38,13 +38,30 @@ jobs:
        with:
          token: ${{ github.token }}
          branch: dev
+          noNewCommitBehavior: silent
+          noVersionBumpBehavior: silent
+      - name: No release needed
+        if: ${{ steps.semver.outputs.bump == '' || steps.semver.outputs.bump == 'none' }}
+        run: echo "No release-worthy commits were found since ${{ steps.semver.outputs.current }}." >> "$GITHUB_STEP_SUMMARY"
      - name: Create pull request
        id: create-pull-request
-        run: 'gh pr create --title "chore(release): automatic release ${{ steps.semver.outputs.next }}" --body "**This is an automatic release**.<br/>Manual action may be required for major bumps.<br/>Detected change to be ``${{ steps.semver.outputs.bump }}``<br/>Bump version from ``${{ steps.semver.outputs.current }}`` to ``${{ steps.semver.outputs.next }}``" --base main --head dev --label automerge'
+        if: ${{ steps.semver.outputs.bump != '' && steps.semver.outputs.bump != 'none' }}
+        run: |
+          pr_url="$(gh pr list --base main --head dev --state open --json url --jq '.[0].url // empty')"
+          if [[ -z "$pr_url" ]]; then
+            pr_url="$(gh pr create \
+              --title "chore(release): automatic release ${{ steps.semver.outputs.next }}" \
+              --body "**This is an automatic release**.<br/>Manual action may be required for major bumps.<br/>Detected change to be ``${{ steps.semver.outputs.bump }}``<br/>Bump version from ``${{ steps.semver.outputs.current }}`` to ``${{ steps.semver.outputs.next }}``" \
+              --base main \
+              --head dev \
+              --label automerge)"
+          fi
+          echo "url=$pr_url" >> "$GITHUB_OUTPUT"
+          echo "pr_number=${pr_url##*/}" >> "$GITHUB_OUTPUT"
        env:
          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
      - name: Discord notification
-        if: ${{ github.event.inputs.send-notifications }}
+        if: ${{ steps.create-pull-request.outcome == 'success' && (github.event_name == 'schedule' || inputs.send-notifications) }}
        env:
          DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
        uses: Ilshidur/action-discord@0.4.0
@@ -52,26 +69,29 @@ jobs:
          args: "Created a release PR ${{ steps.create-pull-request.outputs.url }} for version ${{ steps.semver.outputs.next }} (new behaviour: ${{ steps.semver.outputs.bump }})"
      - name: Obtain token
        id: obtainApprovalToken
+        if: ${{ steps.create-pull-request.outcome == 'success' }}
        uses: actions/create-github-app-token@v3
        with:
          private-key: ${{ secrets.RENOVATE_APPROVE_PRIVATE_KEY }}
-          client-id: ${{ secrets.RENOVATE_APPROVE_APP_ID }}
+          client-id: ${{ vars.RENOVATE_APPROVE_CLIENT_ID }}
          permission-pull-requests: write
      - name: Approve PR
+        if: ${{ steps.create-pull-request.outcome == 'success' }}
        env:
          GITHUB_TOKEN: ${{ steps.obtainApprovalToken.outputs.token }}
        run: |
-          gh pr review --approve --body "Automatically approved by GitHub Action"
+          gh pr review "${{ steps.create-pull-request.outputs.url }}" --approve --body "Automatically approved by GitHub Action"
      - name: Obtain token
        id: obtainMergeToken
+        if: ${{ steps.create-pull-request.outcome == 'success' }}
        uses: actions/create-github-app-token@v3
        with:
          private-key: ${{ secrets.RENOVATE_MERGE_PRIVATE_KEY }}
-          client-id: ${{ secrets.RENOVATE_MERGE_APP_ID }}
+          client-id: ${{ vars.RENOVATE_MERGE_CLIENT_ID }}
          permission-contents: write # write to main branch (due to merge)
          permission-pull-requests: write # merge pull request
      - id: automerge
-        if: ${{ steps.semver.outputs.bump != 'major' }}
+        if: ${{ steps.create-pull-request.outcome == 'success' && steps.semver.outputs.bump != 'major' }}
        name: automerge
        uses: "pascalgn/automerge-action@v0.16.4"
        env:
@@ -85,21 +105,21 @@ jobs:
          MERGE_REQUIRED_APPROVALS: 0 # do not require approvals

      - name: Merged Discord notification
-        if: ${{ steps.automerge.outputs.mergeResult == 'merged' && github.event.inputs.send-notifications }}
+        if: ${{ steps.automerge.outputs.mergeResult == 'merged' && (github.event_name == 'schedule' || inputs.send-notifications) }}
        env:
          DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
        uses: Ilshidur/action-discord@0.4.0
        with:
          args: "Merged PR ${{ steps.create-pull-request.outputs.url }} for release ${{ steps.semver.outputs.next }}"
      - name: Major Bump Discord notification
-        if: ${{ steps.semver.outputs.bump == 'major' && github.event.inputs.send-notifications }}
+        if: ${{ steps.semver.outputs.bump == 'major' && (github.event_name == 'schedule' || inputs.send-notifications) }}
        env:
          DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
        uses: Ilshidur/action-discord@0.4.0
        with:
          args: "The release PR must be manually merged because the next version is a major version: ${{ steps.create-pull-request.outputs.url }} for release ${{ steps.semver.outputs.next }}"
      - name: Discord Fail Notification
-        if: failure() && github.event.inputs.send-notifications
+        if: ${{ failure() && (github.event_name == 'schedule' || inputs.send-notifications) }}
        env:
          DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
        uses: Ilshidur/action-discord@0.4.0
@@ -26,36 +26,8 @@ jobs:
      - name: Copy env
        run: cp .env.example .env

-      - name: Start dev server
-        run: pnpm --filter @homarr/nextjs dev &
-        env:
-          TURBO_TELEMETRY_DISABLED: 1
-          DISABLE_TELEMETRY: 1
-
-      - name: Wait for server and fetch spec
-        run: |
-          set -euo pipefail
-          for i in $(seq 1 30); do
-            if curl -fsS http://localhost:3000/api/openapi -o /tmp/openapi.json 2>/dev/null; then
-              echo "Server is up, spec fetched"
-              break
-            fi
-            echo "Waiting for server... ($i/30)"
-            sleep 3
-          done
-
-          if [ ! -f /tmp/openapi.json ]; then
-            echo "::error::Server failed to start within timeout"
-            exit 1
-          fi
-
-          jq -e '.openapi and .paths' /tmp/openapi.json > /dev/null || {
-            echo "::error::Fetched file is not a valid OpenAPI spec"
-            exit 1
-          }
-
-          cp /tmp/openapi.json apps/docs/static/api/open-api-schema.json
-          echo "OpenAPI spec updated ($(jq '.paths | length' /tmp/openapi.json) paths)"
+      - name: Generate and validate OpenAPI spec
+        run: pnpm scripts:update-openapi

      - name: Commit updated spec
        uses: EndBug/add-and-commit@v10
@@ -5,39 +5,6 @@ on:
    types: [released]

 jobs:
-  trigger-docs-release:
-    name: Trigger Documentation Release
-    runs-on: ubuntu-latest
-    timeout-minutes: 2
-    steps:
-      - name: Obtain token
-        id: obtainToken
-        uses: actions/create-github-app-token@v3
-        with:
-          private-key: ${{ secrets.HOMARR_DOCS_RELEASE_APP_PRIVATE_KEY }}
-          client-id: ${{ vars.HOMARR_DOCS_RELEASE_APP_ID }}
-          owner: homarr-labs
-          repositories: |
-            documentation
-          permission-contents: write # required to dispatch repository workflow
-      - name: Trigger documentation release
-        env:
-          GITHUB_TOKEN: ${{ steps.obtainToken.outputs.token }}
-          SOURCE_TAG: ${{ github.event.release.tag_name }}
-        run: |
-          curl -X POST \
-            -H "Authorization: token $GITHUB_TOKEN" \
-            -H "Accept: application/vnd.github+json" \
-            https://api.github.com/repos/homarr-labs/documentation/dispatches \
-            -d @- <<EOF
-          {
-            "event_type": "trigger-release",
-            "client_payload": {
-              "tag": "${SOURCE_TAG}"
-            }
-          }
-          EOF
-
  update-bug-report-template:
    name: Update Bug Report Template
    runs-on: ubuntu-latest
@@ -48,7 +15,7 @@ jobs:
        uses: actions/create-github-app-token@v3
        with:
          private-key: ${{ secrets.RENOVATE_MERGE_PRIVATE_KEY }}
-          client-id: ${{ secrets.RENOVATE_MERGE_APP_ID }}
+          client-id: ${{ vars.RENOVATE_MERGE_CLIENT_ID }}
          permission-contents: write # required to commit to branch
          permission-pull-requests: write # required to create pr & enable automerge
      - name: Checkout code
@@ -21,7 +21,7 @@ jobs:
        uses: actions/create-github-app-token@v3
        with:
          private-key: ${{ secrets.HOMARR_UPDATE_CONTRIBUTORS_PRIVATE_KEY }}
-          client-id: ${{ vars.HOMARR_UPDATE_CONTRIBUTORS_APP_ID }}
+          client-id: ${{ vars.HOMARR_UPDATE_CONTRIBUTORS_CLIENT_ID }}
          permission-contents: write # required to commit to branch
          permission-pull-requests: write # required to create pr & enable automerge

@@ -24,7 +24,7 @@ jobs:
        uses: actions/create-github-app-token@v3
        with:
          private-key: ${{ secrets.HOMARR_UPDATE_CONTRIBUTORS_PRIVATE_KEY }}
-          client-id: ${{ vars.HOMARR_UPDATE_CONTRIBUTORS_APP_ID }}
+          client-id: ${{ vars.HOMARR_UPDATE_CONTRIBUTORS_CLIENT_ID }}
          permission-contents: write # required to commit to branch
          permission-pull-requests: write # required to create pr & enable automerge
      - name: Checkout code
@@ -2,8 +2,36 @@ name: Workshop

 on:
  pull_request:
+    paths:
+      - ".github/workflows/workshop.yml"
+      - "apps/workshop/**"
+      - "apps/docs/**"
+      - "packages/custom-widgets/**"
+      - "packages/definitions/**"
+      - "packages/workshop/**"
+      - "tooling/typescript/**"
+      - "patches/**"
+      - "package.json"
+      - "pnpm-lock.yaml"
+      - "pnpm-workspace.yaml"
+      - "turbo.json"
+      - ".npmrc"
  push:
    branches: [dev, v2, release/v2, main]
+    paths:
+      - ".github/workflows/workshop.yml"
+      - "apps/workshop/**"
+      - "apps/docs/**"
+      - "packages/custom-widgets/**"
+      - "packages/definitions/**"
+      - "packages/workshop/**"
+      - "tooling/typescript/**"
+      - "patches/**"
+      - "package.json"
+      - "pnpm-lock.yaml"
+      - "pnpm-workspace.yaml"
+      - "turbo.json"
+      - ".npmrc"

 permissions:
  contents: read
@@ -15,21 +43,10 @@ concurrency:
 jobs:
  validate:
    runs-on: ubuntu-24.04
-    timeout-minutes: 30
+    timeout-minutes: 5
    steps:
      - uses: actions/checkout@v7
-      - uses: actions/setup-node@v6
-        with:
-          node-version: 24.18.0
-      - uses: pnpm/action-setup@v6
-        with:
-          run_install: false
-      - run: pnpm install --frozen-lockfile
-      - run: pnpm --filter @homarr/workshop typecheck
-      - run: pnpm --filter @homarr/docs typecheck
      - run: docker compose --env-file apps/workshop/.env.staging.example -f apps/workshop/docker-compose.staging.yml config --quiet
-      - run: pnpm test:workshop
-      - run: pnpm test:workshop-image

  publish-amd64:
    if: github.event_name == 'push' && (github.ref_name == 'v2' || github.ref_name == 'release/v2' || github.ref_name == 'main')
@@ -2,7 +2,7 @@
  "mcpServers": {
    "mantine": {
      "command": "npx",
-      "args": ["-y", "@mantine/mcp-server@9.5.2"]
+      "args": ["-y", "@mantine/mcp-server@9.6.0"]
    }
  }
 }
@@ -10,7 +10,12 @@
    "CHANGELOG.md",
    "apps/docs/.docusaurus/**",
    "apps/docs/build/**",
-    "apps/docs/blog/**",
+    "apps/docs/blog/2022/**",
+    "apps/docs/blog/2023/**",
+    "apps/docs/blog/2024/**",
+    "apps/docs/blog/2025/**",
+    "apps/docs/blog/authors.yml",
+    "apps/docs/static/api/open-api-schema.json",
    "packages/custom-widgets/src/core/component-catalog.generated.json",
    "apps/docs/static/custom-widgets/component-catalog-v1.json"
  ]
@@ -0,0 +1,167 @@
+---
+authors:
+  - ajnart
+tags: [homarr, update, version, assistant, custom widgets, dashboards, docker]
+description: Homarr 2.0 introduces Custom Widgets and Workshop, rebuilt board editing, Assistant tooling, responsive layouts, onboarding, and more.
+image: ./img/homarr-v2-dashboard.webp
+draft: false
+---
+
+# Homarr 2.0.0 - Workshop, Custom Widgets and a rebuilt board
+
+First, thank you.
+
+Many of you used the v2 demo when it was still rough, found bugs and came back to test the next build. Others translated Homarr, answered questions, contributed code or simply kept using it. We would not be shipping this without you.
+
+We are also planning a small batch of **free, limited-edition Homarr swag** for Workshop contributors and a few randomly picked community members. It is not for sale and it is not for profit. No Homarr merch empire, sorry.
+
+Homarr 2.0 is an upgrade, not a brand-new app wearing the same logo. Here is what actually changed.
+
+![A populated Homarr 2.0 dashboard with compact widgets, an Assistant, and an application rail](./img/homarr-v2-dashboard.webp)
+
+<!-- truncate -->
+
+:::warning Back up before upgrading
+
+Database migrations run automatically when Homarr starts. Create a
+[Homarr backup](/docs/management/backup) first. Do not test a prerelease image on your only production volume.
+Backups are boring. Restores are worse.
+
+:::
+
+## Custom Widgets v2 and Workshop
+
+### Build almost any widget
+
+**This is the big one.** We think it is the most important Homarr update we have made.
+
+Custom Widgets v2 lets you build widgets from JSX, API requests, actions and typed settings. Write one yourself or describe it to Assistant, then test it in the workbench. We think this is enough to make almost any dashboard widget—even that oddly specific component only three people need. Those three people no longer have to wait for us.
+
+This was partly inspired by [Google's upcoming Create My Widget feature](https://blog.google/products-and-platforms/platforms/android/gemini-intelligence/): describe a widget in normal language and let AI make it. Coding knowledge is optional. Knowing what the API does still helps; AI has not fixed bad documentation. Yet.
+
+![The Custom Widget v2 workbench after a live exchange-rate request successfully renders its preview](./img/custom-widget-workbench.webp)
+
+A `homarr-custom-widget-v2` definition can use several fixed-origin API sources. Credentials are encrypted separately and stay out of exports and Workshop submissions. Actions support `GET`, `POST`, `PUT`, `PATCH` and `DELETE`; requests have host checks, timeouts, size limits, permissions and rate limits. Custom Widgets remain **Beta** in 2.0.
+
+### Share widgets and Custom CSS
+
+**Workshop is the other half.** Publish and install Custom Widgets, then update, vote on, comment on and report submissions. Workshop is not only for widgets: you can share your **Custom CSS** there too. Deployment URLs and credentials stay on your Homarr instance.
+
+![The Community Workshop catalog inside Custom Widget management](./img/community-workshop.webp)
+
+:::warning Workshop is moderated
+
+AI makes widgets easy to produce. It does not make the first thing it coughs up worth publishing. **Do not dump untested slop into Workshop.** Test it, add a useful screenshot and explain its setup. Workshop is moderated.
+
+:::
+
+### The ultimate Homarr update
+
+We have called this the **"ultimate Homarr update"**. Not because work stops, but because every new service or widget idea no longer needs a full Homarr release; the community can build and share it instead.
+
+## Board editing, rebuilt
+
+### Drag and drop
+
+We threw out the old drag-and-drop system and rebuilt it on [`dnd-kit`](https://dndkit.com/). Moves and eight-direction resizes are transactional: Homarr previews the result, checks collisions and only saves a valid layout. Bad moves roll back instead of wrecking the board. In short: less fighting with your own dashboard.
+
+![A Calendar tile moving across the rebuilt Homarr 2.0 board grid](./img/drag-and-drop.gif)
+
+### Goodbye Groups and sections, bonjour Containers
+
+Groups and dynamic sections did nearly the same job, so **Containers replace both**. They hold apps, widgets and other Containers. Hold <kbd>Ctrl</kbd> or <kbd>Command</kbd> to move several items at once.
+
+### One board, several layouts
+
+Boards also have Base and Mobile layouts, plus optional breakpoints. **Reset from Base** creates a Mobile starting point without duplicating the board.
+
+## Homarr Assistant
+
+### Work with live Homarr data
+
+Assistant reads live Homarr data and has tools for boards, apps, integrations, widgets, Docker and supported services. It can answer questions, make approved changes and build Custom Widgets. It follows your permissions: reads can run automatically, while changes require approval by default.
+
+![The Homarr Assistant expanded over a live dashboard with health, exploration, media, and board actions](./img/assistant-control-surface.webp)
+
+Open it with <kbd>Shift</kbd> + <kbd>A</kbd>. <kbd>Cmd</kbd>/<kbd>Ctrl</kbd> + <kbd>/</kbd> searches it.
+
+### The Homarr provider
+
+:::note
+
+Assistant ships with a **"Homarr provider"**. It is free, will never offer paid plans, and is paid for by [Ajnart](https://github.com/ajnart) using the ad revenue from this website.
+
+It only uses zero-data-retention (ZDR) providers. [The provider is open source](https://github.com/homarr-labs/homarr/blob/release/v2/apps/workshop/homarr_provider.go), and neither prompts nor responses are logged. We are not selling your data. Pinky promise.
+
+:::
+
+### External assistants through MCP
+
+External assistants can use the same permission-checked tools through `/api/mcp`, with an API key or OAuth 2.1 with PKCE.
+
+## The rest (there is a lot)
+
+### Brand-new onboarding
+
+A six-stage setup studio handles the first admin, core settings, Docker discovery, apps, integrations and the first board.
+
+![The Homarr 2.0 setup studio on its Essentials step, with all six setup stages shown](./img/onboarding-studio.webp)
+
+### Board switcher
+
+Boards now live in a searchable gallery with keyboard navigation. Open it from the header or press <kbd>Shift</kbd> + <kbd>C</kbd>.
+
+![A visual board card inside the searchable Homarr board switcher](./img/board-switcher.webp)
+
+### Command menu and keybinds
+
+<kbd>Cmd</kbd>/<kbd>Ctrl</kbd> + <kbd>K</kbd> finds resources, pages, settings, users, groups and commands. More
+keybinds cover Assistant, editing, selection and advanced widget views.
+
+### Customizable header
+
+Pick which buttons appear, put them on the left, center or right, and change their order.
+
+![The Header studio showing left, center, and right zones plus available controls](./img/header-studio.webp)
+
+### Instance branding
+
+Change the name, logo, favicon, colors, corner styles and login page. Global CSS applies instance-wide; board CSS can override it. Only give that power to admins you trust. CSS remains CSS.
+
+![Instance branding controls for application identity, palette, corner style, and global CSS](./img/instance-branding.webp)
+
+### Widgets
+
+Add content without leaving the board. Settings have live previews, and supported widgets have advanced views. Weather and Clock were redesigned; Air Quality, Countdown and Timer are new.
+
+### Docker and Podman
+
+`DOCKER_ENDPOINTS` supports several hosts. Assisted setup and container labels can create apps, integrations, Containers, widgets and health checks.
+
+![Assisted Docker setup listing discovered services that can become apps or integrations](./img/docker-assisted-setup.webp)
+
+Homepage-compatible labels work too.
+
+### Permissions
+
+Groups use a new Viewer, Editor and Admin matrix. The API, Assistant and MCP follow the same rules. LDAP can create users on first sign-in; OIDC can link verified accounts and synchronize groups.
+
+### Performance
+
+Board startup work runs in parallel, heavy screens load when opened, and identical integration requests share work instead of doing it twice.
+
+## Before upgrading
+
+- Keep a backup and use the final release image, not a prerelease tag.
+- Legacy Custom JSX definitions enter a migration state. Homarr keeps encrypted credentials and an archived copy until the v2 definition validates.
+- Mobile layouts place rail content in the main flow instead of displaying rails.
+- Custom Widgets remain Beta.
+- Assistant and MCP do not bypass permissions.
+
+## Links
+
+- Try the [Homarr 2.0 preview](https://app-v2.preview.homarr.dev).
+- Follow the [v2 beta setup guide](/docs/getting-started/upgrade-v2).
+- Follow the [v2 release pull request](https://github.com/homarr-labs/homarr/pull/6545) and [public beta thread](https://github.com/homarr-labs/homarr/issues/6600).
+- Compare [v1.76.2 with the release/v2 branch](https://github.com/homarr-labs/homarr/compare/v1.76.2...release/v2).
+- Read the guides for [Boards](/docs/management/boards), [Custom Widgets](/docs/management/custom-widgets), [Assistant](/docs/management/assistant), [MCP](/docs/management/mcp) and [Docker labels](/docs/integrations/docker-labels).
@@ -148,13 +148,18 @@ homarr images rm feature
 # List data volumes with owner PR/tag and in-use status
 homarr data

-# Delete data volume (safely stops and removes owning container first)
+# Preview deleting a data volume and its owning container
 homarr data rm homarr_feature_data

+# Permanently delete the data after reviewing the preview
+homarr data rm homarr_feature_data --force
+
 # Remove stopped containers (prompts without --force)
 homarr prune --force
 ```

+Forced data deletion removes the derived owner container only when it mounts the exact selected volume. A same-named container that does not own that volume stops the operation.
+
 ### Instance Operations & Diagnostics

 ```bash
@@ -14,4 +14,4 @@ homarr fix-usernames

 This will convert all credential usernames to lowercase and update the database accordingly.

-![](./img/screenshot-cli.png)
+![Terminal output confirming credential usernames were converted to lowercase](./img/screenshot-cli.png)
@@ -1,48 +1,66 @@
 # Command line interface

-The Homarr image ships with a built-in recovery tool. This can be useful, if you do not have access to Homarr or if something is not working.
-Please note that the CLI is an _emergency tool_, not an API tool.
+The Homarr image includes a recovery CLI for operations that cannot be completed in the web interface. It is not an
+application API; use the [API](/docs/management/api) or [MCP endpoint](/docs/management/mcp) for automation.

-:::caution
+Back up the database and stop Homarr before running a command that changes data.
+Failed commands print an error and return a non-zero exit code, so shell scripts can stop safely.

-Using the recovery CLi tool can cause problems when requests are being sent to Homarr while the tool is running. \
-You should also create a backup of the database, in case you break something.
+## Run the recovery CLI

-:::
+Open a shell in the container, then pass a command to `homarr`:

-## Execute CLI with Docker
+```sh
+docker exec -it <container-id> /bin/bash
+homarr <command>
+```

-1. Execute `docker ps | grep homarr` on the root system with Docker to find the container ID of your Homarr container.
-2. Run `docker exec -it <container-id> /bin/bash homarr <your-command-goes-here>`. \
-   Replace `<container-id>` with your container ID from step 1. \
-   Replace `<your-command-goes-here>` with the command you want to execute (see sub-pages).
+### QNAP Container Station

-## Execute CLI with QNAP
+1. Open **Container Station**.

-1. Open Container Station in the QNAP Web Interface ![](img/334116069-e7ec4726-3df7-4dc6-a3e0-b745e7eef17f.png)
-2. Select Containers in the menu bar on the left ![](img/334116205-aa09ce40-0701-4f7d-b9f9-b431b9d207c5.png)
-3. Select your Homarr Container ![](img/334116303-714b5e07-b9de-4ec0-a2bc-def7ee38750f.png)
-4. Click "Execute" in the top right of the Window. ![](img/334116411-df1482f9-3aa9-4686-b77f-e0dca09e60b2.png)
-5. Select /bin/bash and click Execute ![](img/334116518-e1ddb515-99c7-4159-81bf-76e889d1e808.png)
-6. Run the Homarr command and press enter (eg. homarr reset-owner-password) ![](img/334116642-08c4f204-5cd0-4e4e-a785-0142e1b279ca.png)
+![Container Station in the QNAP application menu](./img/334116069-e7ec4726-3df7-4dc6-a3e0-b745e7eef17f.png)
+
+2. Select **Containers**.
+
+![Containers menu in QNAP Container Station](./img/334116205-aa09ce40-0701-4f7d-b9f9-b431b9d207c5.png)
+
+3. Select the Homarr container.
+
+![Homarr container selected in QNAP Container Station](./img/334116303-714b5e07-b9de-4ec0-a2bc-def7ee38750f.png)
+
+4. Select **Execute**.
+
+![Execute action for the Homarr container in QNAP Container Station](./img/334116411-df1482f9-3aa9-4686-b77f-e0dca09e60b2.png)
+
+5. Select `/bin/bash`, then select **Execute**.
+
+![Bash selected in the QNAP execute console](./img/334116518-e1ddb515-99c7-4159-81bf-76e889d1e808.png)
+
+6. Run `homarr <command>` in the console.
+
+![Bash console open for Homarr in QNAP Container Station](./img/334116642-08c4f204-5cd0-4e4e-a785-0142e1b279ca.png)
+
+See the pages in this section for available commands.

 ## Build a local branch harness

-The host-side operations CLI can build the current checkout and run it as a named, browser-ready Docker harness. This is separate from the recovery CLI described above and does not open the interactive developer TUI.
+The repository's host-side CLI can build the current checkout and run it as a named Docker harness:
+
+![Homarr developer CLI showing pull requests, local images, and PR CI status](./img/homarr-dev-cli.png)

 ```sh
 pnpm cli harness setup feature-board
 ```

-The command builds `homarr:feature-board`, starts a container with a persistent data volume, enables demo mode, and keeps demo mutations writable (`DEMO_READ_ONLY=false`). Docker assigns a free host port by default; use the URL printed by the command or query it later:
-
-The demo board includes every widget kind. Integration-backed widgets use the bundled mock integration; media widgets use public stock assets.
+This creates `homarr:feature-board`, starts it with persistent demo data, and prints the assigned URL. Query the port
+again with:

 ```sh
 pnpm cli harness port feature-board
 ```

-Pass environment overrides by repeating `--env`:
+Pass environment overrides with repeated `--env` options:

 ```sh
 pnpm cli harness setup feature-board \
@@ -50,4 +68,4 @@ pnpm cli harness setup feature-board \
  --env FEATURE_FLAG=true
 ```

-Other commands are `harness build <name>`, `harness run <name>`, and `harness stop <name>`. Use the returned URL with a browser automation harness for feature validation; do not assume the host port is `7575`.
+Related commands are `harness build <name>`, `harness run <name>`, and `harness stop <name>`.
@@ -10,10 +10,10 @@ Using this command, you can forcefully reset the password of a user.
 It will be set to a random value and the hash for the user will be updated.
 All sessions for that user will be terminated and the user must re-login.

-![](./img/screenshot-cli.png)
+![Reset-password command help showing that username is required](./img/screenshot-cli.png)

 Using the `--username` parameter, you can specify who you want to reset the password for.
 Executing the command will create a new random password, update the database and display the new password.
 All sessions for this user will be terminated and they must re-login.

-![](./img/screenshot-cli-result.png)
+![Terminal output confirming a password reset and session deletion](./img/screenshot-cli-result.png)
@@ -58,7 +58,7 @@ Use `pnpm docker:dev:up` instead when you only need Redis in the background. Run
 default data; use `pnpm db:seed` to seed it explicitly later.

 Workshop contributors can set up PocketBase and Docusaurus with the dedicated
-[Workshop development guide](../../workshop/development).
+[Workshop development guide](./workshop).

 ### Useful commands

@@ -82,3 +82,25 @@ Workshop contributors can set up PocketBase and Docusaurus with the dedicated
 - `pnpm build` — production monorepo build.
 - `docker build -t homarr .` — build a production Docker image.
 - `docker run -p 7575:7575 -e SECRET_ENCRYPTION_KEY='your_64_character_hex_string' homarr:<name>` — run it.
+
+## CI and focused validation
+
+The main CI workflow runs lint, typechecking, affected workspace builds, workspace configuration checks, OpenAPI validation, and Custom Widget architecture and bundle checks. Unit and E2E suites do not run in CI. Preview images publish after the Fast gate and both architecture builds succeed; browser tests do not block publication. The container job builds an amd64 image when no preview image was built.
+
+Workshop CI runs only when its workflow or Docker build inputs change. It validates Compose configuration and publishes production images on its configured release branches. Its Docker integration and image tests are manual; workspace typechecks run in the main Fast gate.
+
+Choose the smallest relevant suite when changing behavior:
+
+| Command                                           | Scope                                                          | Requirements                                                          |
+| ------------------------------------------------- | -------------------------------------------------------------- | --------------------------------------------------------------------- |
+| `pnpm test <file>`                                | Focused unit or contract tests                                 | Workspace dependencies                                                |
+| `pnpm test`                                       | All unit and contract tests, without Docker integration suites | Workspace dependencies                                                |
+| `pnpm test:coverage`                              | Unit and contract tests with coverage                          | Workspace dependencies                                                |
+| `pnpm test:integration <file>`                    | Docker-backed service and database compatibility tests         | Docker                                                                |
+| `pnpm test:e2e <file>`                            | Browser and container scenarios                                | Docker; Playwright Chromium and system dependencies for browser tests |
+| `pnpm test:docs-screenshots`                      | Regenerate Assistant documentation screenshots                 | Same browser prerequisites                                            |
+| `pnpm test:workshop` / `pnpm test:workshop-image` | Workshop integration / production-image validation             | Docker                                                                |
+
+Omit `<file>` to run all tests in that command's scope. E2E and screenshot commands use a local image tagged `homarr-e2e`, or an image selected with `HOMARR_E2E_IMAGE`. The default commands run once without automatic retries; coverage is opt-in. The screenshot generator is excluded from both unit and E2E commands.
+
+Keep behavioral coverage for authorization, migrations, persistence, and widget execution. Avoid tests that only search source code for particular component names, JSX, CSS, or documentation wording.
@@ -0,0 +1,67 @@
+---
+title: Workshop operator guide
+sidebar_label: Operator guide
+sidebar_position: 3
+tags:
+  - Workshop
+  - Deployment
+  - Environment variables
+  - PocketBase
+---
+
+# Workshop operator guide
+
+Workshop uses PocketBase. The production image serves the Workshop website and API from one origin and stores state in
+`/pb_data`.
+
+## Environment variables
+
+| Variable                               | Purpose                                      | Default                        |
+| -------------------------------------- | -------------------------------------------- | ------------------------------ |
+| `HOMARR_WEBSITE_URL`                   | Documentation/site base used by Homarr links | `https://homarr.dev`           |
+| `WORKSHOP_API_URL`                     | PocketBase API used by Homarr and docs       | `HOMARR_WEBSITE_URL`           |
+| `WORKSHOP_WEB_URL`                     | Public Workshop URL                          | `HOMARR_WEBSITE_URL/workshop`  |
+| `WORKSHOP_PUBLIC_ORIGIN`               | PocketBase-generated links and email         | Required in production         |
+| `PB_ALLOWED_ORIGINS`                   | Allowed browser origins                      | `*`                            |
+| `GITHUB_CLIENT_ID`                     | GitHub OAuth application ID                  | —                              |
+| `GITHUB_CLIENT_SECRET`                 | GitHub OAuth application secret              | —                              |
+| `OPENROUTER_API_KEY`                   | Enables the Homarr Assistant provider        | Provider disabled when empty   |
+| `HOMARR_AI_DAILY_REQUEST_LIMIT`        | Per-user daily request allowance             | `50`                           |
+| `HOMARR_AI_GLOBAL_DAILY_REQUEST_LIMIT` | Shared daily request ceiling                 | `10000`                        |
+| `HOMARR_AI_OPENROUTER_BASE_URL`        | OpenRouter-compatible upstream               | `https://openrouter.ai/api/v1` |
+| `HOMARR_AI_OPENROUTER_MODEL`           | Upstream model behind `homarr/model`         | Selected by the Homarr team    |
+
+Public URL variables accept HTTP(S) origins without embedded credentials, query strings, or fragments. Restart the
+container after changing runtime configuration.
+
+## Authentication and email
+
+Configure both GitHub OAuth variables and use `https://<workshop-host>/api/oauth2-redirect` as the callback. Supplying
+only one OAuth variable is a startup error. Configure SMTP for comment, report, and removal notifications.
+
+For the central community, `PB_ALLOWED_ORIGINS=*` permits requests from self-hosted Homarr origins. A private deployment
+can use a comma-separated allowlist.
+
+## Homarr provider
+
+`OPENROUTER_API_KEY` enables the [Homarr provider](/docs/workshop/homarr-provider). The Workshop server chooses the upstream model and
+enforces per-user and global daily limits. It requests zero-data-retention routing, disables data-collecting providers,
+and does not retain prompts or responses.
+
+Keep an OpenRouter account-level credit limit as the monetary backstop; request limits are not cost limits.
+
+## Deployment
+
+The v2 image is `ghcr.io/homarr-labs/workshop:v2`; immutable `sha-<commit>` tags are preferable for promotion. The
+service listens on port 8090.
+
+When using a reverse proxy, forward the complete hostname, including `/api`, `/_/`, and
+`/workshop-runtime-config.js`. Use a dedicated hostname when Homarr already occupies the intended origin.
+
+Verify `/api/health`, the Workshop page, a public listing request, GitHub sign-in, and one installation after deployment.
+
+## Backup and restore
+
+Stop writes and copy `/pb_data` for a consistent backup. A restore replaces the selected PocketBase data directory, so
+preserve the current volume and verify that the backup contains `data.db` first. Rehearse the restore outside production
+and verify sign-in and one installation afterward.
@@ -0,0 +1,41 @@
+---
+title: Workshop development
+sidebar_position: 4
+tags:
+  - Workshop
+  - Developer
+  - Docusaurus
+  - PocketBase
+---
+
+# Workshop development
+
+See the [main development guide](./getting-started) for repository prerequisites.
+
+Start PocketBase:
+
+```sh
+cp apps/workshop/.env.example apps/workshop/.env
+docker compose --env-file apps/workshop/.env -f apps/workshop/docker-compose.yml up --build workshop
+```
+
+Start Docusaurus in another terminal:
+
+```sh
+WORKSHOP_API_URL=http://127.0.0.1:8090 pnpm dev:docs
+```
+
+PocketBase runs at `http://127.0.0.1:8090`; create the first superuser under `/_/`. Workshop is available at
+`http://127.0.0.1:3003/workshop`.
+
+To connect a local Homarr instance, set:
+
+```dotenv
+HOMARR_WEBSITE_URL=http://127.0.0.1:3003
+WORKSHOP_API_URL=http://127.0.0.1:8090
+WORKSHOP_WEB_URL=http://127.0.0.1:3003/workshop
+```
+
+Restart the affected development process after changing these variables. See
+[`apps/workshop/README.md`](https://github.com/homarr-labs/homarr/blob/HEAD/apps/workshop/README.md) for OAuth,
+moderation, tests, and service maintenance.
@@ -30,7 +30,8 @@ Using the `PUID` and `PGID` will require you to set the correct permissions on t
 | `PUID`                   | User ID to run the container as                                                                                                                                                                                                        | Any valid user ID                   | `0`                           |
 | `PGID`                   | Group ID to run the container as                                                                                                                                                                                                       | Any valid group ID                  | `0`                           |
 | `LOG_LEVEL`              | Log level to use                                                                                                                                                                                                                       | `debug` / `info` / `warn` / `error` | `info`                        |
-| `NO_EXTERNAL_CONNECTION` | Disables Homarr's internet-backed requests, including update checks, weather, and RSS feeds                                                                                                                                            | `true` or `false`                   | `false`                       |
+| `BASE_URL`               | Public Homarr origin used by MCP OAuth metadata and redirects. Set this when a reverse proxy does not preserve the public host and protocol.                                                                                           | HTTP(S) origin without a path       | -                             |
+| `NO_EXTERNAL_CONNECTION` | Disables Homarr's internet-backed requests, including update checks, weather, location search, and RSS feeds                                                                                                                           | `true` or `false`                   | `false`                       |
 | `ENABLE_DNS_CACHING`     | Enables dns caching. Enabled by default, but if you experience issues with IPv6 or static IPs, see [#4006](https://github.com/homarr-labs/homarr/issues/4006) or disable this flag                                                     | `true` or `false`                   | `true`                        |
 | `HOMARR_DISABLE_IPV6`    | Disables the IPv6 listener of the internal nginx proxy, even when the host supports IPv6. IPv6 is normally disabled automatically when the host has no IPv6 configured. See [#4596](https://github.com/homarr-labs/homarr/issues/4596) | `true` or `false`                   | `false`                       |
 | `HOMARR_WEBSITE_URL`     | Main Homarr documentation/site base used by runtime links. Must be an absolute HTTP(S) URL.                                                                                                                                            | HTTP(S) URL                         | `https://homarr.dev`          |
@@ -38,7 +39,7 @@ Using the `PUID` and `PGID` will require you to set the correct permissions on t
 | `WORKSHOP_WEB_URL`       | Public Workshop website used by links in Homarr, Custom Widgets, onboarding, and assistant context.                                                                                                                                    | HTTP(S) URL                         | `HOMARR_WEBSITE_URL/workshop` |

 Workshop service operators can find its server-only configuration in the
-[Workshop operator guide](../../workshop/operator#environment-variables).
+[Workshop operator guide](/docs/advanced/development/workshop-operator#environment-variables).

 ### Workshop service

@@ -53,20 +53,6 @@ Commands at a grid boundary or at the tile's minimum size are ignored and announ

 On touch screens, press and hold a tile before moving it; a quick tap does not start a drag. Resize handles accept direct touch input. During a pointer or touch move or resize, `Esc` cancels the interaction and restores the layout from before it started.

-## Board editing
-
-When a tile is focused in edit mode:
-
-| Shortcut             | Description                                                                 |
-| -------------------- | --------------------------------------------------------------------------- |
-| `Enter` or `Space`   | Starts or stops keyboard editing                                            |
-| Arrow keys           | Moves the focused tile within its current canvas, rail, or Container        |
-| `Shift` + Arrow keys | Resizes from the tile's lower-right corner: Left/Up shrink; Right/Down grow |
-| `Esc`                | Stops keyboard editing without undoing its changes                          |
-
-Keyboard moves and resizes apply immediately. To move an item between a canvas, rail, or Container, drag it there or use **Move / resize item** for precise numeric placement.
-Commands at a grid boundary or at the tile's minimum size are ignored and announced instead of moving or shrinking the tile.
-
 :::tip

 Here `MOD` refers to the modifier key, which is `Ctrl` on Windows and `Cmd` on macOS.
@@ -40,7 +40,7 @@ services:
    volumes:
      - ./homarr/appdata:/appdata
    environment:
-      - BASE_URL=your.internal.dns.address.here.com
+      - BASE_URL=https://your.internal.dns.address.here.com
      - SECRET_ENCRYPTION_KEY=your_64_character_hex_string # <--- can be generated with `openssl rand -hex 32`
    networks:
      - proxy
@@ -143,7 +143,7 @@ networks:
 ```

 :::important
-Homarr needs to be on the same network so you will need to add the following property to your homarr install:
+Homarr and Caddy must share the same Docker network:

 ```yaml
 homarr:
@@ -202,9 +202,9 @@ Homarr supports multiple authentication options, from internal userbase (credent
    | ``AUTH_OIDC_CLIENT_NAME``   | Display name of provider (in login screen)                 | OIDC          |
    | ``AUTH_OIDC_AUTO_LOGIN``    | Automatically redirect to OIDC login                       | false         |
    | ``AUTH_OIDC_SCOPE_OVERWRITE`` | Overwrite default scopes (openid, profile, email)        | openid email profile groups           |
-    | ``AUTH_OIDC_GROUPS_ATTRIBUTE`` | Attribute used for groups (roles) claim                  | groups        |
+    | ``AUTH_OIDC_GROUPS_ATTRIBUTE`` | Attribute used for groups (roles) claim. Dot-separated paths such as `resource_access.homarr.roles` are supported. | groups        |
    | ``AUTH_OIDC_GROUPS_LOCAL_MANAGEMENT`` | Stop syncing group memberships of OIDC users from the groups claim and manage them locally via the group members page instead | false |
-    | ``AUTH_OIDC_NAME_ATTRIBUTE_OVERWRITE`` | Overwrite name attribute. By default it will use preferred_username if it does not contain a `@` and otherwise name. | ---          |
+    | ``AUTH_OIDC_NAME_ATTRIBUTE_OVERWRITE`` | Overwrite name attribute. Dot-separated paths are supported. By default it will use preferred_username if it does not contain a `@` and otherwise name. | ---          |
    | ``AUTH_OIDC_FORCE_USERINFO`` | Force userinfo endpoint to be used for user information.    | false         |
    | ``AUTH_OIDC_ENABLE_DANGEROUS_ACCOUNT_LINKING`` | Enable account linking for OIDC provider. This will link the OIDC accounts by email. Be sure that you have verified emails to prevent stealing accounts. | false |
    | ``AUTH_OIDC_ENABLE_DANGEROUS_CREDENTIALS_LINKING`` | Link an OIDC identity to an existing credentials user with the same email. The credentials login and existing user data are preserved. Requires the OIDC profile to contain `email_verified: true`. | false |
@@ -244,18 +244,21 @@ Homarr supports multiple authentication options, from internal userbase (credent
        - Create a group (e.g., `homarr-admins`) and assign users who require admin access.

        **2. Example .env file:**
+
+        Generate `SECRET_ENCRYPTION_KEY` with `openssl rand -hex 32`; do not copy an example key between installs.
+
        ```env
-        OIDC_CLIENT_ID=identificationid #OIDC client ID
-        OIDC_CLIENT_SECRET=secretsecretsecret #OIDC client secret
+        OIDC_CLIENT_ID=<REPLACE_WITH_OIDC_CLIENT_ID>
+        OIDC_CLIENT_SECRET=<REPLACE_WITH_OIDC_CLIENT_SECRET>
        OIDC_SLUG=homarr #Application slug in Authentik
        AUTH_DOMAIN=auth.example.com #Authentik FQDN
        ADMIN_GROUP=homarr-admins #Authentik group for Homarr admins
        HOMARR_FQDN=homarr.example.com #Homarr FQDN
-        SECRET_ENCRYPTION_KEY=encryptencryptencrypt #Homarr encryption key
+        SECRET_ENCRYPTION_KEY=<REPLACE_WITH_64_HEX_CHARACTERS>
        ```

        **3. Example Docker Compose configuration:**
-        ```yaml {14-26}
+        ```yaml {14-24}
        services:
          homarr:
            image: ghcr.io/homarr-labs/homarr:latest
@@ -269,8 +272,6 @@ Homarr supports multiple authentication options, from internal userbase (credent
            environment:
              - TZ=America/Los_Angeles
              - SECRET_ENCRYPTION_KEY=${SECRET_ENCRYPTION_KEY}
-              - BASE_URL=https://${HOMARR_FQDN}
-              - NEXTAUTH_URL=https://${HOMARR_FQDN}
              - AUTH_PROVIDERS=oidc #(optional: include ',credentials' to keep local accounts as fallback)
              - AUTH_OIDC_CLIENT_ID=${OIDC_CLIENT_ID}
              - AUTH_OIDC_CLIENT_SECRET=${OIDC_CLIENT_SECRET}
@@ -322,15 +323,18 @@ Homarr supports multiple authentication options, from internal userbase (credent
        - Record the `Client-ID` and `Client Key` (secret).

        **2. Example .env file (Homarr):**
+
+        Generate `SECRET_ENCRYPTION_KEY` with `openssl rand -hex 32`; do not copy an example key between installs.
+
        ```env
-        OIDC_CLIENT_ID=identificationid #Google Client-ID
-        OIDC_CLIENT_SECRET=secretsecretsecret #Google Client Key (secret)
+        OIDC_CLIENT_ID=<REPLACE_WITH_GOOGLE_CLIENT_ID>
+        OIDC_CLIENT_SECRET=<REPLACE_WITH_GOOGLE_CLIENT_SECRET>
        HOMARR_FQDN=homarr.example.com #Homarr FQDN
-        SECRET_ENCRYPTION_KEY=encryptencryptencrypt #Homarr encryption key
+        SECRET_ENCRYPTION_KEY=<REPLACE_WITH_64_HEX_CHARACTERS>
        ```

        **3. Example Docker Compose configuration (Homarr):**
-        ```yaml {16-22}
+        ```yaml {14-20}
        services:
          homarr:
            image: ghcr.io/homarr-labs/homarr:latest
@@ -344,8 +348,6 @@ Homarr supports multiple authentication options, from internal userbase (credent
            environment:
              - TZ=Europe/Berlin
              - SECRET_ENCRYPTION_KEY=${SECRET_ENCRYPTION_KEY}
-              - BASE_URL=https://${HOMARR_FQDN}
-              - NEXTAUTH_URL=https://${HOMARR_FQDN}
              - AUTH_PROVIDERS=oidc #(optional: include ',credentials' to keep local accounts as fallback)
              - AUTH_OIDC_CLIENT_ID=${OIDC_CLIENT_ID}
              - AUTH_OIDC_CLIENT_SECRET=${OIDC_CLIENT_SECRET}
@@ -1,102 +1,37 @@
 # Styling

-:::tip
+Homarr uses Mantine and supports custom CSS at two scopes:

-This page is directed at more experienced users with knowledge about CSS and browsers.
-We recommend you to [look into the board customizations instead](/docs/management/boards#appearance),
-if you do not have experience with writing custom styles or CSS.
+- **Global:** **Management → Settings → Instance branding → Custom CSS**.
+- **Board:** **Board settings → Custom CSS**. Board CSS loads after the global stylesheet and can override it.

-:::
+Both editors accept direct CSS and Workshop imports.

 :::warning

-Our support specifically excludes custom CSS, and we will not help you to write CSS.
-However, we may help you by adding new CSS classes if required.
+Custom CSS can break after updates and is not an authorization boundary. Hidden controls remain accessible to users who
+have permission to use them.

 :::

-Homarr uses https://mantine.dev/ under the hood. You can change the look & feel of Homarr
-using custom CSS, that extends or overwrites the styles from Mantine.
+## Target elements

-## Getting into CSS
+Use browser developer tools to inspect the element and test a selector. Prefer stable semantic or Mantine class names;
+avoid generated classes such as `mantine-Card-x2fske`, which change between builds.

-If you don't have any experience with CSS,
-we strongly recommend you to go through the courses here: https://www.w3schools.com/css/.
-Due to the infinite scenarios and setups possible with custom CSS,
-our support team will not provide any support with your own written CSS.
+To target one widget, add a custom class under **Edit item → Advanced options** and use that class in the board CSS.

-## Limitations and dangers
+Use `!important` only when the existing cascade requires it.

-When using custom CSS, you can break the page or certain functionalities.
-Although CSS can improve the design & feel of the page, it **<ins>cannot do any of the following</ins>**:
+## Theme variables

- Implement new features, widgets or integrations
- Securely hide elements you don't want users to interact / have permission to
- Completely revamp the design of the page, only smaller changes are possible
-
-Here are some dangers of using custom CSS:
-
- Updates may contain breaking changes in the structure, built-in styling or how styling is processed. Therefore,
-  custom CSS may break unexpectedly without any warning
- Custom CSS may make certain elements invisible or not possible to click / interact with
- Custom CSS could make readability and accessibility worse for impaired people
-
-## How to inspect the page
-
-When styling the page, you can use the `Inspector` to inspect elements on the page and try out styles.
-This may vary depending on your browser and operating system, but the workflow usually goes like this:
-
- Open the Homarr page
- Press `Ctrl` + `Shift` + `I` at the same time.
-  Alternatively, right-click on the page and choose `Inspect` or `Inspect element`.
- Open the tab `Elements` if it isn't open yet.
- Search the element you want to change in the DOM tree or use the element picker (usually at the top left)
-  to select it by clicking on the page.
- Experiment by changing the CSS code on the right side
-
-When writing custom CSS, it is important to also remember or create a selector, which tells the browser
-which element to apply the styles to. If you accidentally broke something or want to revert your changes in the inspector,
-simply reload the page.
-
-## Using Homarr's classes
-
-Homarr's elements will already have a lot of classes and styles pre-applied.
-You can reuse those classes to apply additional styles or overwrite them.
-When overwriting, remember to add the `!important` flag to your CSS property to tell the browser to use our instruction instead.
-
-Classes with random number suffixes, such as `mantine-Card-x2fske`, should be avoided, since those are dynamic
-CSS classes that will change with every build. This means, every time you update Homarr,
-your styles will no longer apply to them
-
-## Defining custom classes for widgets
-
-If you want to apply the styles only for one widget, you can define custom class names only for that widget.
-To do that, enter edit mode on your board, click the three dots of your widget, click `Edit item` and click `Advanced options`.
-Then, you can enter as many custom classes as you'd like:
-
-![](./img/widget-custom-classes.png)
-
-To save them, click `Save changes` on both modals and exit edit mode.
-
-## Where to enter custom CSS
-
-After you wrote your custom CSS, it is time to permanently save it, so you don't need to use the inspector anymore.
-To do this, enter the board settings:
-
-![](./img/enter-board-settings.png)
-
-Scroll to the **Custom CSS** section on the board settings page. It is part of the unified settings form; enter your CSS
-there and save the board settings to apply it to that board.
-
-![](./img/custom-css-setting.png)
-
-## Using variables
-
-You can also change the values of the theme variables, which are located here: https://mantine.dev/styles/css-variables-list/.
-To do this, see the following example CSS:
+Mantine exposes [CSS variables](https://mantine.dev/styles/css-variables-list/) that can be overridden globally or per
+board:

 ```css
 :root {
  --mantine-primary-color-filled: #ffbb00;
 }
 ```
+
+CSS changes presentation only; use widgets, integrations, permissions, or application code for behavior.
@@ -8,22 +8,7 @@ tags:

 # Donate

-## Why to donate
+Donations fund Homarr's development infrastructure and community services.

-Our team of 4 developers is working on Homarr in their free time.
-Homarr has become a big part of our daily things we work on - and therefore we invest a lot of time into maintaining Homarr,
-providing support and implementing new features.
-We also incur monetary costs while developing Homarr for the tools that we need.
-A few examples include:
-
- Renting for a Cloud VPS for our cloud services (status page, monitoring, email, analytics, [demo instance](https://demo.homarr.dev/), ...)
- Paying for (IDE-) licenses
-
-Using a donation, you help us to cover these expenses and enable the development of Homarr.
-Homarr is completely free to use. We'd highly appreciate if you consider donating, especially if you use Homarr in a commercial environment.
-
-## Where to donate
-
-We accept donations on our official [OpenCollective](https://opencollective.com/homarr).
-You may also sponsor us directly by providing a useful service / product to us other means.
-You can get into contact with us [here](/docs/community/get-in-touch).
+Support the project through [OpenCollective](https://opencollective.com/homarr). For sponsorships or donated services,
+use the private contact listed on [Get in touch](/docs/community/get-in-touch).
@@ -1,110 +1,51 @@
 ---
 title: Frequently Asked Questions
+description: Answers to common Homarr questions about installation, customization, connectivity, support, and commercial use.
 tags:
  - Community
  - Help
 ---

-import Tabs from "@theme/Tabs";
-import TabItem from "@theme/TabItem";
+## Can Homarr run on a Raspberry Pi?

-### Can I install Homarr on a Raspberry Pi?
+Yes, when the device uses a supported `linux/arm64` operating system. `linux/arm/v7` is not supported. See
+[Prerequisites](/docs/getting-started).

-Yes, Homarr is compatible with the architecture of the Raspberry Pi. Have a look in our <a href="/docs/category/installation-1">installation guide</a> on how to do so.
+## Can I use custom app icons?

-### I have a suggestion / idea for improvement or want to report a bug
+Yes. Use a direct image URL, one of Homarr's icon sources, or upload an image. See [Icons](/docs/advanced/icons).

-You can report issues, suggestions, or ideas for improvements <a href="https://github.com/homarr-labs/homarr/issues/new/choose">here</a>.
+## Can I create widgets?

-### Can I use my own custom icons for apps?
+Yes. [Custom Widgets](/docs/management/custom-widgets) use server-side API requests and safe JSX. They can be written in
+the workbench or created with an MCP-connected agent.

-Yes, check out our guide on <a href="/docs/advanced/customizations/icons">how to add your custom icons</a>.
+## Can Homarr be exposed to the internet?

-### Some of my online icons are not working (anymore)
+Homarr supports authenticated and public deployments. Terminate HTTPS at a reverse proxy, keep Homarr updated, and grant
+public board access only when anonymous viewing is intended. See [Board access control](/docs/management/boards#access-control)
+and [Single sign-on](/docs/advanced/single-sign-on).

-It seems the `cdn.jsdelivr.net` database of icon sometimes appear in the lists for DNS-Holes (PiHole, AdGuard Home...). <br />
-So make sure to manually whitelist this address.
+## Where are the logs?

-### Can I add my own widgets? Do I need programming skills?
+Use **Management → Tools → Logs** for retained and live application logs. Container startup failures and older events are
+available through the deployment platform, for example `docker container logs homarr`.

-Yes. A [Custom Widget](/docs/management/custom-widgets) can read a public or private HTTP API.
+Use the browser developer console only for client-side failures. Review logs before sharing them because URLs and other
+deployment details may be present.

-It can show responsive Mantine JSX. It can also use widget options and actions with board permission checks.
+## Why can Homarr not reach a service behind Gluetun?

-Custom JSX v2 is the only Custom Widget format. Write the JSON and JSX in the workbench.
+Gluetun's firewall blocks traffic that is not explicitly allowed. Configure its
+[`FIREWALL_OUTBOUND_SUBNETS`](https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/firewall.md) for the relevant
+LAN or Docker subnet, and use an address reachable from the Homarr container.

-You can also use the AI copy prompt. An MCP agent can validate and preview a definition before it saves the definition.
+## Where do I report a bug or request a feature?

-The workbench reads a pasted AI response. It shows request capabilities and redacted diagnostics.
+Use the [GitHub issue templates](https://github.com/homarr-labs/homarr/issues/new/choose). For community support, see
+[Get in touch](/docs/community/get-in-touch).

-A template cannot import packages or run arbitrary JavaScript. It cannot call browser `fetch`.
+## Can Homarr be used commercially?

-Named requests use the Homarr server. The server applies board permissions and the network policy.
-
-Before installation, examine the origins, methods, permissions, and actions. Use the same review before publication.
-
-### Is it secure to expose Homarr to the web?
-
-Yes, since v0.14.0, we are confident that Homarr is secure enough to be exposed to the web.
-Make sure to enable the "allow anonymous access" [option in the settings](/docs/management/boards#access-control), if you want to allow people without an account to be able to see your dashboard (not edit)
-
-### How do I open the console / log?
-
-There are two different sources of information:
-
- console: This is your client (browser). It can tell us, if there is an issue on the client (crash, bug, ...).
- log: This is your server. It will tell us, if there are issues with connections for the integrations, crashes and errors.
-
-Both variants _can_ contain personal data. It's recommended, that you don't post them publicly or remove personal data from it.
-
-<Tabs>
-  <TabItem value="apple" label="Read console" default>
-
-> Note: This will not work on most mobile browsers.
-
-Open your browser and ensure, that Homarr is your current tab.
-Press `CTRL` + `SHIFT` + `I` on your keyboard. If this shortcut doesn't work, please use one of the alternatives: https://developer.chrome.com/docs/devtools/open/.
-Click on `Console` in the new window, that opened. There, you should see white, orange and sometimes red messages. You can use the Windows Snip & Sketch tool (or your respective tool on Linux / MacOS) to screenshot those messages.
-
-> Please never execute any commands in the console. Scammers are using the console to let you execute harmful commands. If you want to resolve an issue in Homarr, **you'll never have to execute any commands here**
-
-  </TabItem>
-  <TabItem value="orange" label="Read log">
-
-This depends on your installation method. If you use Unraid, you can simply click on the App and on `Log`. If you have a bare Docker install, use `docker container logs homarr`. If you used a different name than `homarr` for your container, you need to replace said argument. Here is some additional information about the command: https://geekflare.com/check-docker-logs/.
-
-  </TabItem>
-</Tabs>
-
-### How do I post logs?
-
-Please check [the section above](#how-do-i-open-the-console--log), on how to obtain logs. Logs should always be posted to https://pastebin.com/ or https://rentry.co/.
-
-### Can I use Homarr at my company?
-
-Yes, you can! But please consider a donation, if our work has been useful to you.
-
-### I think I found a bug. What can I do?
-
-If you think, that you found a bug, please create an issue <a href="https://github.com/homarr-labs/homarr/issues/new/choose">here</a>.
-
-### Why can't I use my custom icons?
-
-You need to restart the Homarr Docker container after adding icons.
-
-### Why can't homarr see/ping containers running locally behind GluetunVPN?
-
-This is because GluetunVPN, and many other docker VPN services, secure their VPN connections with strict firewalls. These firewalls often block access to local containers, even on the same docker network. The workaround for <a href="https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/firewall.md">GluetunVPN</a> is to add "- FIREWALL_OUTBOUND_SUBNETS=192.168.1.0/24" into the environmental variables of the docker compose file. If you are using a firewall on your system, you will need to add a rule that allows requests from ip's in the range of 192.168.xxx.xxx . If you are using UFW the command would be "sudo ufw allow from 192.168.0.0/16".
-Tip: If you are running your torrent client behind a VPN, and running Sonarr (or something similar) normally, make sure to open your torrent client's port in your firewall. If you don't, Sonarr will not be able to see it. Furthermore, use your machines IP (192.168.x.x) rather then 127.0.0.1 or localhost.
-
-### Can I get in touch with you?
-
-Yes, go <a href="/docs/community/get-in-touch">here</a> to get with us in touch.
-
-<hr />
-
-:::tip
-
-Haven't found the solution to your problem / question? We are eager to help you on [our Discord](/docs/community/get-in-touch#discord) or in a [GitHub Issue](https://github.com/homarr-labs/homarr/issues/new/choose).
-
-:::
+Yes. Homarr is licensed under the [Apache License 2.0](/docs/community/license). Commercial users can support development
+through [OpenCollective](/docs/community/donate).
@@ -1,24 +1,23 @@
 ---
-title: Get In Touch
-description: Still have a question? Click here!
+title: Get in touch
+description: Community, support, and private contact channels.
 tags:
  - Help
  - Community
 ---

-We're happy to talk with you! Shoot us a message at the following places:
+# Get in touch

-## E-Mail
+## GitHub

-We are open to discuss sponsorships, security vulnerabilities and other private requests through our email.
-Please do not report any bugs / feature requests here - they will be ignored and deleted.
-
-[homarr-labs@proton.me](mailto:homarr-labs@proton.me)
+Use the [issue templates](https://github.com/homarr-labs/homarr/issues/new/choose) for bugs and feature requests.

 ## Discord

-We have a Discord Server, where we announce new releases, discuss features and bugs and show off our dashboards.
-There are over 4'000 members and we're happy to answer your questions or concerns.
-You're also open to discuss new / upcoming features and any offtopic selfhosting content.
+Use the [Homarr Discord server](https://discord.gg/aCsmEV5RgA) for community support, release discussion, and dashboard
+showcases.

-[_![](https://discordapp.com/api/guilds/972958686051962910/widget.png?style=banner2)_](https://discord.gg/aCsmEV5RgA)
+## Email
+
+Use [homarr-labs@proton.me](mailto:homarr-labs@proton.me) for security reports, sponsorships, and other private matters.
+Bug reports and feature requests belong on GitHub.
@@ -5,51 +5,24 @@ tags:
  - Translations
 ---

-We want to make Homarr accessible for everyone.
-But to do that, we need your help.
-We are running a community program that enables everyone to translate Homarr into their language – no programming required.
-We are using [Crowdin](https://crowdin.com/) to manage our translations.
-You can find the translations [here](https://translate.homarr.dev/).
+# Translations

-## How to translate
+Homarr translations are managed on [Crowdin](https://translate.homarr.dev/). Select a language, translate strings in
+context, and submit them for proofreading. Approved translations ship with a later Homarr release.

-### Using crowdin's online platform
+## Translate from Homarr

-Go to the [Crowdin translations](https://translate.homarr.dev/) and select a language you want to translate.
-You can then enter the translation mode and start translating.
-After you've submitted your translations, a Proofreader will review your changes.
-After a translation has been approved, it will be merged to the language development branch.
-We merge this one periodically to the development branch.
-After the next update of Homarr, all changes from the development branch will be merged, including the changes in the translations.
+Select **Crowdin (live translations)** as the application language, connect a Crowdin account, and choose the target
+language. Select text in Homarr or use Crowdin's in-context panel to edit a string.

-### Using live translate
-
-You can also help translate homarr directly from the app!
-For this you can simply change your language to "Crowdin (live translations)"
-
-![](./img/crowdin-language-select.png)
-
-Then you'll be prompted to connect to your Crowdin account and choose the language in which you want to transalte.
-You can then start translating directly from the app by selecting some text on the app.
-If some text cannot be selected to be edited with the live translation tool, you can still translate it inside of the In-Context popup at the Home tab, it will be red if it's not translated yet.
-
-![](./img/crowdin-live-translate.png)
-
-:::caution
-Although you are translating directly from the app, your translations will not be directly be available inside of your language, they will be in the next update of Homarr, because we have to push the new translations to a new docker image.
-
-If you really want to use them you can enable the "preview transaltions" option in the live translate settings, but be aware that this is not recommended for performance reasons.
-:::
-
-:::tip
-
-Do you want to become a proofreader? [Let us know on our Discord](/docs/community/get-in-touch#discord)! We will add you to the proofreader team. You can then review the translations and approve them. **Note:** You must speak the language fluently, have it as your native language or lots of experience with it.
-
-:::
+Live translation submits changes to Crowdin; it does not update the installed Homarr image. Crowdin's preview option can
+show pending translations before the next Homarr release.

 ## Guidelines

-1. Translate with context: Some translations can't be translated 1:1 - they need context. Ensure that your translations make sense in the context.
-2. Keep things simple and original - no additional characters are needed.
-3. Don't translate the same thing twice - if you see a translation that is already translated, don't translate it again unless you have a better translation.
-4. Keep your translations as close to the original as possible.
+- Preserve the meaning and context of the English source.
+- Keep terminology consistent with existing translations.
+- Do not add punctuation, formatting, or explanatory text that is absent from the source.
+- Improve an existing translation only when the replacement is more accurate.
+
+Contact the [Discord community](/docs/community/get-in-touch#discord) to help proofread a language.
@@ -6,397 +6,76 @@ tags:
  - Configuration
 ---

-import manageBoardNoApp from "./img/manage-board-no-app.png";
-import currentKeyboardTileEditing from "../management/boards/img/keyboard-tile-editing.png";
-import boardDesktopCurrent from "./img/onboarding-board-desktop-current.png";
-import boardEditModeCurrent from "./img/onboarding-board-edit-mode-current.png";
-import addContentMenuCurrent from "./img/onboarding-add-content-menu-current.png";
-import chooseItemCurrent from "./img/onboarding-choose-item-current.png";
-import editItemCurrent from "./img/onboarding-edit-item-current.png";
-import boardsHomeMobileMenu from "./img/onboarding-boards-home-mobile-menu.png";
-import moveResizeMenuCurrent from "./img/onboarding-move-resize-menu-current.png";
-import currentBoardMobileView from "./img/onboarding-board-mobile-current.png";
+On first launch, onboarding creates the administrator, connects optional services, and builds the first board. A
+compatible SQLite backup can also be restored from the welcome screen.

-:::tip
+If onboarding returns after a restart, check that `/appdata` is writable and persisted. See the
+[Docker installation guide](/docs/getting-started/installation/docker).

-Read our [glossary](/docs/getting-started/glossary) if you are new to Homarr.
+## Core concepts

-:::
+### Boards

-Congratulations on installing Homarr. Now it's time to get yourself familiar with the concepts of Homarr and how to use it.
+A **board** is a dashboard page containing apps, widgets, and Containers. Boards can be public or restricted to users
+and groups. Each user can choose a home board.

-## Onboarding
+![Board management with board previews](./img/after-installation-boards.webp)

-Onboarding appears the first time Homarr starts. Its goal is to create a useful responsive board, not merely an
-administrator account. The setup uses one guided studio, so you can keep the safe defaults and finish quickly or review
-every detected service before anything is added to the board.
+See [Boards](/docs/management/boards) for responsive layouts, access control, appearance, and home-board settings.

-:::note
+### Apps

-If you see this screen repeatedly after restarting the Homarr container, your Docker mounting paths may be missing,
-incorrect or read-only. Read [our installation instructions](/docs/getting-started/installation/docker) again to fix this issue.
+An **app** is a saved shortcut: a name, URL, icon, and optional status check. Add an App tile or a Bookmarks widget to
+show apps on a board.

-:::
+![App management with saved shortcuts](./img/after-installation-apps.webp)

-### Restore or start fresh
+See [Apps](/docs/management/apps) or [Icons](/docs/advanced/icons).

-SQLite installations can restore a complete Homarr database backup from the welcome screen. This restores current
-boards, people, apps, integrations, and settings. The pre-1.0 ZIP importer is no longer included.
+### Integrations

-For a new installation, Homarr first creates either a credentials administrator or an administrator group matching your
-LDAP/OIDC provider. The browser that starts setup claims the first-run session; refreshes are safe, while another browser
-cannot change credentials or integrations during that setup.
+An **integration** is a server-side connection from Homarr to a supported service such as Sonarr, Home Assistant, or
+Docker. Integrations provide data and actions to widgets. They can also be linked to apps.

-### Setup studio
+![Integration catalog with compatible widgets](./img/after-installation-integrations.webp)

-The studio keeps related choices together:
+See [Managing integrations](/docs/management/integrations) and the
+[integration catalog](/docs/category/integrations).

-1. **Essentials** sets the default language, color scheme, analytics preference, and the usual host, IP address, domain, or reverse-proxy path used by your services. URL suggestions can use separate ports, subdomains, or one path per service.
-2. **Discover** checks the actual database, Docker-compatible sockets, Kubernetes configuration, Workshop, and Assistant capabilities. Unavailable sources never block manual setup.
-3. **Connect** shows detected integrations and apps first, identifying whether each app came from an explicit [`homarr.*` or Homepage Docker label](/docs/integrations/docker-labels) or image matching. Select several integrations and apps at once, review every URL, and use the service-specific link to open its API-key settings when one is available. If a container has no published port or URL label, add its HTTP or HTTPS address before importing it.
-4. **Board** previews the Base layout, colors, widget radius, sidebars, selected apps, and widgets inferred from integrations or Docker labels. Choose 8 columns for a focused board, 10 for a balanced board, 12 for a wide board, or use the slider for a custom width up to 24 columns. Homarr still creates and reflows the protected Mobile layout automatically. A fast setup adds the integration-free Clock, Weather, and Bookmarks starter widgets.
-5. **Extend** explains and optionally configures Assistant, the community Workshop, and the separate Homarr MCP endpoint.
-6. **Review** tests the selected connections, then saves integrations, apps, widgets, settings, and the exact first board together. If any part fails, the database changes are rolled back and your form stays available to correct.
+### Widgets

-Docker discovery reports each configured host separately. Results from reachable hosts remain selectable if another socket
-is unavailable, which is useful for remote Docker, rootless Docker, Synology, and mixed deployments. On Kubernetes or
-bare-metal installations without a Docker socket, enter services manually and use the same integration catalog.
+A **widget** is a board tile. Some widgets work on their own; others require one or more integrations. Configuration,
+supported integrations, and non-obvious limitations are documented on each widget page.

-After setup, **Open my board** takes you directly to the configured board. The in-product tour then introduces edit mode,
-responsive layouts, widgets, and search without delaying completion.
+![Board in edit mode with the add-content menu](./img/after-installation-widgets.webp)

-## Creating another board
+See the [widget catalog](/docs/category/widgets).

-In Homarr, you organize your apps and widgets on boards.
-Boards use fixed-size tiles so the same widget keeps the same proportions on every screen.
-Drag, resize, and section controls are available in edit mode.
-Onboarding already created the first board. To create another one, navigate to `Manage` > `Boards` > `New board`:
-![](./img/manage-create-board-button.png)
+### Containers and rails

-A board must always have a name and can either be public or private.
-Public boards are also accessible for users, that are not logged in ([see access control for boards](/docs/management/boards/#access-control)).
+A **Container** groups board items and can be nested. A **rail** reserves a fixed area at the left or right of a
+responsive layout. Both are configured in board edit mode.

-![](./img/manage-create-board-modal.png)
+![Board layout settings with fixed sidebars](./img/after-installation-containers-rails.webp)

-Congratulations - you've just created another board. You can see the boards you have access to on this page:
+See [Boards](/docs/management/boards#containers-and-rails).

-<figure>
-  <img
-    src={boardsHomeMobileMenu}
-    alt="Boards management page showing a Home badge and separate desktop and mobile home-board menu entries"
-    style={{ maxWidth: "100%" }}
-  />
-  <figcaption>The Boards page selects the board opened from Home separately for desktop and mobile.</figcaption>
-</figure>
+### Users, groups, and permissions

-The board marked **Home** is the board opened from the desktop Home route. **Set as your mobile board** selects which board
-opens on phones. This is separate from the **Mobile** layout: the home-board setting chooses a board, while **Mobile** and
-**Base** are responsive layouts inside that board. A phone can therefore open a different home board and still use that
-board's Mobile layout.
+Users inherit permissions and default boards from their groups. Resource-specific access can further restrict boards
+and integrations.

-New boards start with **Mobile** and **Base** responsive layouts automatically, so you can edit the board for phones and
-desktops without creating extra layouts first. Mobile starts at `0px` with 3 columns and Base at `768px` with 10 columns.
-Each layout keeps its own tile positions and sizes.
+![Group permission settings](./img/after-installation-users-permissions.webp)

-## Add your first app to Homarr
+See [Users and groups](/docs/management/users) and [single sign-on](/docs/advanced/single-sign-on).

-To add links to your dashboard, you must first add them as an "app".
-Navigate to this page to add an app:
+## Explore further

-![](./img/manage-navigate-apps.png)
+- [Server settings](/docs/management/settings)
+- [Assistant](/docs/management/assistant)
+- [Custom Widgets](/docs/management/custom-widgets)
+- [Community Workshop](/docs/workshop)
+- [API](/docs/management/api) and [MCP](/docs/management/mcp)
+- [Keyboard shortcuts](/docs/advanced/keyboard-shortcuts)

-Next, click on the `New app` button. You'll need to provide a name and an icon to create an app.
-The name must be at least one character long but you can provide any image URL for the icon.
-Homarr ships with over 11K icons - so you can just search by entering a search text instead.
-
-![](./img/manage-add-app-form.png)
-
-After you created the app, you'll see in on the apps page:
-
-![](./img/manage-created-app.png)
-
-## Arrange and organize your board
-
-Let's add your freshly created app, from the previous step, to the board.
-To do this, edit your previously created board by clicking on the big `Open board` button:
-
-<figure>
-  <img src={boardDesktopCurrent} alt="Current Homarr board opened from the Boards page" style={{ maxWidth: "100%" }} />
-  <figcaption>Open a board to view its dashboard, then enter edit mode to arrange its content.</figcaption>
-</figure>
-
-Here you have the following options in the header:
-
-![](./img/manage-board-header.png)
-
- **Search**: Here you can search for data. You can search for integrations, boards, actions, sites and much more. Some actions may be context dependent (eg. will only show when certain widgets are on your page)
- **Edit board**: Clicking this button will toggle edit mode. In this mode you can edit the contents of your board.
- **Settings**: Clicking this button will redirect you to a settings page where you can adjust the board settings (page title, colors, ...).
- **Profile**: This avatar will be visible on every page. Its menu includes the board switcher; press `Shift+C` to open
-  it directly. The current board is left out of the results.
-
-When entering the edit mode, you'll get some additional buttons to work with:
-
-<figure>
-  <img
-    src={boardEditModeCurrent}
-    alt="Current Homarr board editor with tile controls visible"
-    style={{ maxWidth: "100%" }}
-  />
-  <figcaption>The current editor keeps the board visible while its editing controls are available.</figcaption>
-</figure>
-
- **Add board content**: Click this button to create a new item, app, integration, or Container.
- **Save board**: Click this button to save your changes and leave edit mode. If you leave with unsaved changes, Homarr asks whether to discard them.
-
-Outside edit mode, right-click a widget for its live status, refresh, settings, quick options, and supported actions.
-Hold `Shift` while hovering a widget that supports advanced view to expand it in place while the rest of the board
-stays visible but dimmed. Release `Shift` to close it. Hold `Shift` plus `Ctrl` on Windows/Linux or `Cmd` on macOS to
-keep its advanced view open until you close it. Widgets without a distinct advanced experience adapt in place.
-
-To continue, click **New item** in the add-content menu. New content is placed at the first available position on the main
-canvas; it is not inserted at a clicked empty cell or directly into a rail or Container:
-
-<figure>
-  <img
-    src={addContentMenuCurrent}
-    alt="Current add board content menu with item, app, integration, and Container actions"
-    style={{ maxWidth: "100%" }}
-  />
-  <figcaption>The add-content menu provides the four supported ways to place new content on the board.</figcaption>
-</figure>
-
-Next, you can choose what item you'd like to add.
-We will discuss the other options in the following sections - for now choose "App" to continue.
-
-<figure>
-  <img
-    src={chooseItemCurrent}
-    alt="Current item picker showing the App card and other item types"
-    style={{ maxWidth: "100%" }}
-  />
-  <figcaption>Choose the App item from the current picker to add an app tile.</figcaption>
-</figure>
-
-As soon as you chose the app, the modal will close and you'll get the following item on your board:
-
-<img src={manageBoardNoApp} alt="Screenshot of the No app element on the board" />
-
-This is expected, because you haven't told Homarr what app it should show in this item.
-To configure this, click on the small 3 dots at the top of the item in the edit mode and choose "Edit item" in the menu.
-
-<figure>
-  <img
-    src={moveResizeMenuCurrent}
-    alt="Current board tile menu showing Edit item and Move or resize item"
-    style={{ maxWidth: "450px" }}
-  />
-  <figcaption>The tile menu contains the item editor and the separate move-and-resize tools.</figcaption>
-</figure>
-
-In the modal you can edit the app that you want to display:
-
-<figure>
-  <img src={editItemCurrent} alt="Current Edit item modal for an App tile" style={{ maxWidth: "620px" }} />
-  <figcaption>
-    The Edit item workspace previews option changes as you configure the tile. Save changes to apply them to the board.
-  </figcaption>
-</figure>
-
-When adding a widget, set its initial grid width and height directly in the preview. These size controls are only shown before the widget is added.
-
-As soon as you save your changes, the tile on the board will refresh and display your app.
-Resize from any visible edge or corner handle. For a Container, activate its top-left grip before using its resize handles.
-Press and hold a handle, move the pointer, and release it when the tile has the size you want.
-
-To move a tile in edit mode, press and hold its inert content area, move it to the desired position, and release it.
-Widget content is disabled while editing so its controls do not intercept the drag; use the tile's settings button for edit actions.
-The tile snaps to the grid. A single compatible collision may swap the two items when both resulting placements fit;
-otherwise the collision chain reflows neighboring tiles automatically.
-
-Every `1 × 1` tile has a logical content size of `200 × 200` pixels.
-Larger tiles use multiples of that fixed unit, with a consistent gap between cells.
-Homarr scales the complete board uniformly, like zooming a page.
-The complete canvas always fits the available width without horizontal board scrolling. Below 100%, Homarr preserves the
-widget's readable typography and control density instead of shrinking each widget independently.
-It does not squeeze or reflow the content of individual widgets, so a widget keeps the same design and proportions across screen sizes.
-
-On a narrow screen, Homarr uses the **Mobile layout** for the selected board and stacks the board content vertically while
-preserving each widget's fixed logical proportions:
-
-<figure>
-  <img
-    src={currentBoardMobileView}
-    alt="Homarr's Mobile layout in a 390-pixel-wide viewport, with tiles scaled to fit and stacked vertically"
-    style={{ maxWidth: "390px" }}
-  />
-  <figcaption>
-    At phone width, the selected board uses its Mobile layout and fits the complete canvas to the viewport.
-  </figcaption>
-</figure>
-
-:::note
-
-Viewing a board initially uses the lightweight, non-interactive layout.
-For users with edit access, Homarr prepares drag-and-drop and resize controls in the background after the board becomes interactive.
-If you enter edit mode before that finishes, the existing board stays visible until the editor is ready.
-
-:::
-
-:::tip
-
-We recommend you to experiment for a few minutes, before you start building your actual dashboard.
-This helps you to explore the capabilities of Homarr before you build your board in a suboptimal way.
-
-:::
-
-Keyboard users can focus a tile, press Enter or Space, then use arrow keys to move and Shift plus arrow keys to resize
-within its current canvas, rail, or Container. Press Escape to stop keyboard editing. Touch dragging starts after a short
-hold of about `200 ms`; resize handles accept direct touch input. During a pointer or touch move or resize, press Escape
-to cancel and restore the previous layout. For cross-grid moves or precise numeric controls, choose **Move / resize item**
-from the tile's edit menu.
-Keyboard commands at a grid boundary or minimum tile size are ignored and announced; they do not move or shrink the tile.
-
-<img src={currentKeyboardTileEditing} alt="A board tile focused for keyboard editing" style={{ maxWidth: "100%" }} />
-
-Open **Move / resize item** from the tile menu to move the tile to another section or rail and enter precise numeric
-coordinates and dimensions. After making changes, click **Save board** to persist them and leave edit mode.
-
-## Adding your first integration
-
-Now it's time to integrate some basic data into your board.
-To do this, we first need to create an integration.
-An integration is a connection between Homarr and a third party application - usually something that you run and deploy yourself.
-
-Navigate to `Manage` > `Integrations` (for example via your user menu).
-As an example, we are going to use the public demo instance of **Dash.** - a popular application to monitor CPU / hardware usage.
-Choose the **Dash.** integration from the list of available integrations:
-
-![](./img/choose-integration.gif)
-
-Next, choose a name (or leave it at default), enter `https://dash.mauz.dev/` as the URL in the form and click on `Test connection and create`.
-Pressing the save button will perform a test request to the integration, to confirm that the networking setup is working as expected.
-Sometimes invalid configurations, firewalls and other mistakes can lead to connectivity problems - [follow this guide here](/docs/management/integrations/#troubleshooting-connection) if you experience issues.
-
-If connection was successful, you will be redirect back to the list of integrations.
-Now let's embed it to your board (see next section).
-
-:::note
-
-Some integrations may require additional configuration, such as a username, password or API tokens.
-Depending on your networking setup and applications, the connection from Homarr might also get blocked by firewalls,
-the target application or your router.
-
-:::
-
-## Embed integration data using widgets
-
-Let's add your integration, that you have configured in the section above, as a widget to your board.
-First, navigate back to your board that you want to add it to.
-Next, enter edit mode again and add another item to your board:
-
-<figure>
-  <img
-    src={addContentMenuCurrent}
-    alt="Current add board content menu with item, app, integration, and Container actions"
-    style={{ maxWidth: "100%" }}
-  />
-  <figcaption>Use the same add-content menu to place an integration widget on the board.</figcaption>
-</figure>
-
-Instead of choosing an app, let's choose `System Health Monitoring` this time.
-Click on "Add to board":
-
-![](./img/manage-board-header-choose-system-health.png)
-
-Resize the item slightly and then edit it using the three dots menu at the top:
-
-![](./img/edit-system-health-widget.gif)
-
-Next, choose your newly created Dash. integration in the integrations dropdown:
-
-![](./img/manage-board-edit-system-health.png)
-
-:::note
-
-Some widgets may support multiple integrations at the same time.
-If they do not support multiple integrations, you will be unable to select more than one.
-
-:::
-
-Confirm your changes by pressing save.
-Editing a widget will trigger a data update and data will soon appear:
-
-![](./img/widget-system-health.png)
-
-As with every change, click **Save board** to persist your board changes and leave edit mode.
-
-## Organizing items with Containers
-
-Containers are resizable areas for apps, widgets, and nested Containers.
-The same Container works on the main canvas, inside a fixed rail, or inside another Container.
-Each Container can configure:
-
- Its label and whether that label is visible.
- Allow or disable collapsing.
- Show or hide **Open all in new tabs**.
- Change its border color and custom CSS classes.
-
-Open the add-content menu and choose **New container**.
-In edit mode, move and resize it like any other item, then drag items into or out of it.
-Nested content stays within the Container's bounds.
-While resizing, the solid outline follows the pointer continuously and the dashed grid preview shows the size that will be saved on release.
-
-### Collapsing and opening apps
-
-Users can collapse an eligible Container like an accordion in view mode without changing its saved expanded size.
-The full-width header becomes the compact expansion bar, so the half-row state has no empty pill-shaped spacer.
-Expanding it restores its bounds and makes room for its contents.
-If **Open all in new tabs** is enabled, the Container menu can open every app link it contains.
-
-### Fixed rails
-
-Open the board's **Layout** settings to enable the left or right rail for each responsive layout.
-Choose one, two, or three columns with the slider and use the preview to check the remaining canvas width.
-The rail reserves those columns from the dashboard, so Homarr moves canvas items into the next available positions.
-Rail content stays visible while the page scrolls and remains editable.
-Each responsive layout keeps its own rail widths, item positions, and item sizes.
-
-## Guided tours
-
-After completing the onboarding, Homarr provides interactive guided tours to help you discover key features.
-
-### Management tour
-
-When you first visit the management area (`/manage`), Homarr walks you through the main pages: boards, apps, integrations, and users (admin only).
-Each page highlights the list view and the create action so you know where to find and add things.
-
-### Board tour
-
-When you first open a board, a tour highlights the board header elements: search, edit mode, settings, and the user menu.
-
-### Tour controls
-
- Press **Enter** (or click **Next**) to advance through tour steps
- Tours auto-start on first visit and do not repeat once completed
- Tours are skipped on mobile screens (below `sm` breakpoint)
- You can **reset tours** from the user settings page under **Manage > Users > [Your user] > General**
-
-## Next steps
-
-You're done with the basic setup 🔥. Now it's time to organize and customize even more.
-We highly recommend you to experiment with different options, styles and configurations.
-See these curated pages for your next steps:
-
- Create new apps using the [apps management](/docs/management/apps/)
- Customize your board or add more boards using the [boards management](/docs/management/boards/)
- Integrate software that you use using the [integrations management](/docs/management/integrations/)
- Choose from our beautiful and interactive [widgets](/docs/category/widgets)
- See [all supported integrations](/docs/category/integrations)
- Integrate with Homarr with your own application using [the API](/docs/management/api/)
-
-:::danger
-
-The Homarr Team will never ask for your credentials. Do not send people your credentials, as they manage the access to your applications and can cause harm to your device if they are abused.
-
-:::
+See the [glossary](/docs/getting-started/glossary) for a compact list of Homarr terms.
@@ -2,12 +2,19 @@

 This glossary explains Homarr's main components and the terms used for them.

-| Term        | Definition                                                                              |
-| ----------- | --------------------------------------------------------------------------------------- |
-| Apps        | A piece of software that you or a third party hosts (for example, Google)               |
-| Integration | A connection to a service outside of Homarr                                             |
-| Container   | A resizable area that can hold apps, widgets, and nested Containers                     |
-| Widget      | A tile that uses your integrations to display data or enables you to interact with them |
-| Edit mode   | A temporary state where you can drag, resize, edit, or customize your board             |
-| Board       | A customizable page where apps, widgets, and Containers are arranged                    |
-| Tasks       | Workloads that are performed in the background, even if no user is present              |
+| Term            | Definition                                                                       |
+| --------------- | -------------------------------------------------------------------------------- |
+| App             | A saved shortcut with a name, destination, icon, and optional status check       |
+| Assistant       | A conversation interface that can use model responses and Homarr tools           |
+| Board           | A dashboard page where apps, widgets, and Containers are arranged                |
+| Container       | A resizable board area containing apps, widgets, or nested Containers            |
+| Custom Widget   | A validated definition for an API-backed board tile                              |
+| Edit mode       | The board state used to add, move, resize, configure, or remove content          |
+| Homarr provider | An Assistant provider routed through Workshop with a per-user allowance          |
+| Integration     | A server-side connection from Homarr to a supported service                      |
+| Layout          | An arrangement of board items selected for a viewport width                      |
+| Provider        | The model API selected for Assistant                                             |
+| Rail            | A fixed area at the left or right of a non-Mobile board layout                   |
+| Task            | A background workload that runs without an active browser session                |
+| Widget          | A board tile that displays information or provides actions                       |
+| Workshop        | A separate community service for sharing Custom Widget definitions and board CSS |
@@ -1,45 +1,31 @@
 ---
-title: Prerequisites
+title: Getting started
 sidebar_position: 1
 tags:
  - Getting Started
  - Installation
-  - Docker
-  - Unraid
 ---

-import Link from "@docusaurus/Link";
-import { IconArrowRight } from "@tabler/icons-react";
+import {
+  GettingStartedOverview,
+  InstallationPaths,
+} from "@site/src/components/pages/getting-started/getting-started-overview";

-Before you try to install Homarr, please review if your device meets the requirements.
-Installing on an unsupported device may lead to unstable behaviour and no support will be provided.
+<GettingStartedOverview />

-## Hardware
+## Requirements

- At least 500MB RAM
- At least 600MB of free disk space for the Docker image. SSD is preferred.
- Single or dual core CPU
- Stable network connection, Wi-Fi use is not recommended
+- `linux/amd64` or `linux/arm64`;
+- 500 MB RAM;
+- 600 MB free disk space for the container image;
+- a persistent writable `/appdata` directory.

-## Architecture
+`linux/arm/v7` is not supported.

-We build Homarr for a bunch of different architectures, including ARM. Please ensure that your device architecture is supported by Homarr. We won't be able to provide support for unusual or outdated architectures.
+## Choose an installation method

-| Architecture | Supported        |
-| ------------ | ---------------- |
-| linux/amd64  | ✅ Supported     |
-| linux/arm64  | ✅ Supported     |
-| linux/arm/v7 | ❌ Not supported |
+<InstallationPaths />

-## Getting started with installation
-
-<Link
-  data-attr="Go to installation"
-  className={"button button--secondary button--lg rounded-3xl dark:border-zinc-600 dark:bg-zinc-800"}
-  to="/docs/category/installation-1"
->
-  <div className={"flex items-center gap-3"}>
-    <span className={"dark:text-gray-200"}>Go to Installation</span>
-    <IconArrowRight className={"dark:text-gray-200"} size={20} />
-  </div>
-</Link>
+After Homarr starts, open it in a browser and complete onboarding. Then continue with
+[After the installation](/docs/getting-started/after-the-installation) for the core concepts and the most useful next
+links.
@@ -2,106 +2,52 @@ import { DockerInstallSnippet } from "@site/src/components/pages/installation/do

 # Docker

-Docker is our recommended installation method for beginners and professionals.
-It is easy to use, ships with all dependencies inside a single container and is easy to use and maintain.
-It requires at least some basic knowledge of [Docker](https://www.docker.com/).
-We recommend [NetworkChuck's Docker Containers 101](https://www.youtube.com/watch?v=eGz9DS-aIeY) as a good start for complete beginners.
+Docker Compose is the recommended installation method. Install
+[Docker Engine](https://docs.docker.com/engine/install/) and the
+[Compose plugin](https://docs.docker.com/compose/install/).

-## Docker compose
-
-### Prerequisites
-
- A Linux or Windows based system that meets the [hardware prerequisites](/docs/getting-started/#hardware) and [architecture prerequisites](/docs/getting-started/#architecture).
- [Docker](https://docs.docker.com/get-docker/)
- [Docker Compose](https://docs.docker.com/compose/install/) - _preinstalled on many systems nowadays_
-
-### Installation
+## Docker Compose

 <DockerInstallSnippet data-visual-test="blackout" />
-Finally, run ``docker compose up -d`` in the same directory. This will start the Homarr container in the background.

-:::caution
+Start Homarr from the directory containing `docker-compose.yaml`:

-Docker compose creates a network by default. Some integrations may not work (specifically Dash.) when the network internal hostname is used since clients do not know this name. It is recommended that you either use a local network wide hostname or the IP directly. An alternative is to create a DNS record with the same internal compose stack hostname for all clients outside.
+```sh
+docker compose up -d
+```

-:::
+Persist `/appdata`; it contains the database and configuration. Mount the Docker socket only when Homarr needs Docker
+discovery or management.

-### Updating
+Integration URLs must be reachable from the Homarr container. Browser-facing app URLs may use a different hostname;
+see [Managing integrations](/docs/management/integrations#configuration).

-To update, navigate to the directory with the `docker-compose.yaml` located.
+### Update

- Stop Homarr using `docker compose down`
- Pull the newest image of Homarr using `docker compose pull`
- Start Homarr again using `docker compose up -d` (`-d` for detached mode - start in background)
- Delete the old image using `docker image prune` (_Warning: this also removes you other unused images - not just Homarr_)
+```sh
+docker compose pull
+docker compose up -d
+```

-You can automate this process using [Watchtower](https://containrrr.dev/watchtower/).
+### Uninstall

-### Uninstalling
+`docker compose down` removes the containers and Compose network. Delete the configured `/appdata` host directory or
+volume only when the Homarr data is no longer needed.

-To uninstall, navigate to the directory with the `docker-compose.yaml` located.
+## Docker CLI

- Stop Homarr using `docker compose down`
- Delete the created directories & files on your root file system (check `docker-compose.yaml` file for your specific locations)
- Delete compose file using `rm docker-compose.yaml`
- Prune unused Docker images using `docker image prune` (_Warning: this also removes you other unused images - not just Homarr_)
- (Optional): Prune any network or volumes if you use any.
- (Optional): Remove Homarr from your reverse proxy, VPNs or tunnels if you use any.
+The equivalent standalone container is:

-## Docker standalone
-
-:::caution
-
-[Docker Compose](#docker-compose) is easier and recommended for beginners. Consider using compose instead.
-
-:::
-
-### Prerequisites
-
- A Linux or Windows based system that meets the [hardware prerequisites](/docs/getting-started/#hardware) and [architecture prerequisites](/docs/getting-started/#architecture).
- [Docker](https://docs.docker.com/get-docker/)
-
-### Installation
-
-To install Homarr using Docker, simply run the following command.
-
-```bash
-docker run  \
+```sh
+docker run \
  --name homarr \
  --restart unless-stopped \
  -p 7575:7575 \
  -v /var/run/docker.sock:/var/run/docker.sock \
-  -v <your-path>/homarr/appdata:/appdata \
+  -v /absolute/path/to/homarr/appdata:/appdata \
  -e SECRET_ENCRYPTION_KEY='your_64_character_hex_string' \
  -d ghcr.io/homarr-labs/homarr:latest
 ```

-:::note
-
-Docker will mount the configuration files and icons to your host machine. Please make sure to replace `<your-path>` from the docker run command with your desired storage location. The path must be absolute.
-
-:::
-
-### Updating
-
-To update Homarr, you must remove your container first. Make sure that you've mounted your data and that you have access to it, so your configuration doesn't get lost.
-
-1. Run `docker rm homarr` to remove the container.
-2. Pull the latest Homarr image `docker pull ghcr.io/homarr-labs/homarr:latest`.
-3. Re-run the command you used to install Homarr.
-
-This process can get tideous, if you update frequently. Thus, we recommend [using docker-compose](#docker-compose)
-
-:::tip
-
-Want to update all your containers automatically? Checkout [Watchtower](https://containrrr.dev/watchtower/) a service which will automatically update your containers on a set interval.
-
-:::
-
-### Uninstalling
-
-1. Obtain the container ID of your Homarr container using `docker ps | grep homarr`.
-2. Delete the container using `docker rm <your-container-id>`
-3. Prune unused Docker images using `docker image prune` (_Warning: this also removes you other unused images - not just Homarr_)
-4. (Optional): Prune any network or volumes if you use any.
-5. (Optional): Remove Homarr from your reverse proxy, VPNs or tunnels if you use any.
+Remove the Docker socket mount when it is not required. To update, pull the current image, recreate the container with
+the same arguments, and keep the `/appdata` mount and `SECRET_ENCRYPTION_KEY` unchanged.
@@ -2,9 +2,9 @@

 <img src="https://raw.githubusercontent.com/homarr-labs/charts/refs/heads/main/charts/homarr/icon.svg" align="right" width="92" alt="homarr logo">

-![Version: 8.28.1](https://img.shields.io/badge/Version-8.28.1-informational?style=flat)
+![Version: 8.28.2](https://img.shields.io/badge/Version-8.28.2-informational?style=flat)
 ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat)
-![AppVersion: v1.76.1](https://img.shields.io/badge/AppVersion-v1.76.1-informational?style=flat)
+![AppVersion: v1.76.2](https://img.shields.io/badge/AppVersion-v1.76.2-informational?style=flat)

 A Helm chart to deploy homarr for Kubernetes

@@ -437,7 +437,7 @@ All available values are listed on the [artifacthub](https://artifacthub.io/pack
 | httproute.rules[0].matches[0].path.value           | string | `"/"`                                                                                                                                                                                                                                            | Path value to match                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
 | image.pullPolicy                                   | string | `"IfNotPresent"`                                                                                                                                                                                                                                 | Image pull policy                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 | image.repository                                   | string | `"ghcr.io/homarr-labs/homarr"`                                                                                                                                                                                                                   | Image repository                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
-| image.tag                                          | string | `"v1.76.1"`                                                                                                                                                                                                                                      | Overrides the image tag whose default is the chart appVersion                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| image.tag                                          | string | `"v1.76.2"`                                                                                                                                                                                                                                      | Overrides the image tag whose default is the chart appVersion                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
 | imagePullSecrets                                   | list   | `[]`                                                                                                                                                                                                                                             | Secrets for Docker registry                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 | ingress.annotations                                | object | `{}`                                                                                                                                                                                                                                             | Ingress annotations                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
 | ingress.enabled                                    | bool   | `false`                                                                                                                                                                                                                                          | Enable ingress                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
@@ -2,4 +2,4 @@

 Pika Pods is a hosting platform for open source apps. You can deploy Homarr on Pika Pods with just a few clicks:

-[_![Deploy on PikaPods](https://www.pikapods.com/static/run-button.svg)_](https://www.pikapods.com/pods?run=homarr-v1)
+[_![Deploy on PikaPods](https://www.pikapods.com/static/run-button.svg)_](https://www.pikapods.com/pods?run=homarr)
@@ -1,14 +1,8 @@
 # Portainer

-## Portainer Stacks
+## Install with a stack

-### Prerequisites
-
- [Portainer Stacks](https://www.portainer.io/blog/stacks-docker-compose-the-portainer-way)
-
-### Installing
-
-To install Homarr using Portainer Stacks, simply create a new stack and paste the following code into it.
+Create a Portainer stack with this Compose file:

 ```yml title="docker-compose.yml"
 #---------------------------------------------------------------------#
@@ -28,21 +22,12 @@ services:
      - "7575:7575"
 ```

-:::note
-Portainer will mount the files to your host machine. Please make sure to replace `<your-path>` from the docker run command with your desired storage location. The path must be absolute.
-:::
-
-Then, click on `Deploy the stack` and wait until the container has started.
-
-:::tip
-
-If you're unsure how to create a stack, checkout the [Portainer Documentation](https://docs.portainer.io/user/docker/stacks/add).
-
-:::
+Replace `<your-path>` with an absolute host path, generate `SECRET_ENCRYPTION_KEY`, then deploy the stack. See
+[Portainer's stack documentation](https://docs.portainer.io/user/docker/stacks/add) for Portainer-specific options.

 ### Updating

-To update Homarr using Docker Compose or Portainer Stacks, simply pull the latest image and restart the container.
+Pull the current image and redeploy the stack:

 1. Run `docker pull ghcr.io/homarr-labs/homarr:latest` to pull the latest image.
 2. Re-run `docker-compose up -d` or re-deploy the stack in Portainer.
@@ -1,9 +1,11 @@
 # QNAP

 :::caution
-QNAP installation guide has not updated to 1.0 yet. There guide is still for 0.15.10.
+
+The available QNAP guides target Homarr 0.15.10 and have not been updated for 1.0.
+
 :::

-When installing on QNAP, we recommend you to install Homarr using [Container Station](https://www.qnap.com/en/software/container-station) or [this third-party image](https://www.myqnap.org/product/homarr/).
-
-There is also a guide available, but note that it is written in Chinese: https://post.smzdm.com/p/awzm7op2/
+Run Homarr with [Container Station](https://www.qnap.com/en/software/container-station) or the
+[third-party QNAP package](https://www.myqnap.org/product/homarr/). A community
+[Container Station guide](https://post.smzdm.com/p/awzm7op2/) is available in Chinese.
@@ -1,33 +1,12 @@
 # Runtipi

-Runtipi is a self-hosted orchestrator that makes it easy to manage and run multiple services on a single server. It is based on Docker and comes with a simple web interface to manage your services. Runtipi is designed to be easy to use, so you don't have to worry about manual configuration or networking.
+Homarr is available in the default [Runtipi](https://runtipi.io) app store.

-https://runtipi.io
+## Installation

-## Prerequisites
+Install **Homarr** from the Runtipi app store and select either a port or domain for access.

- [Runtipi](https://runtipi.io/docs/getting-started/installation)
+Runtipi manages start, stop, update, backup, and log operations under **My apps → Homarr**. Use a
+[user-config](https://runtipi.io/docs/guides/customize-app-config) to override the generated Compose configuration.

-# Installation
-
-Installing Homarr is pretty untuitive, the app is available in the default appstore :
-
-1. Search for **"Homarr"** in the App-Store page and select it
-2. Click on **"Install"**.
-3. Choose the method you want to access Homarr, through any port or domain name then select **"Install"**
-
-# Maintenance
-
-After installation, all you need is available from the WebUI in **"My apps"** > **"Homarr"** :
-
- Start/Stop
- Update
- Backup
- Logs
-
-If you like to tinker with your apps, you can also edit your app's docker-compose with a [user-config](https://runtipi.io/docs/guides/customize-app-config).
-
-# Getting help
-
- If you are looking for help with anything in Runtipi. They provide support on their [Discord](https://discord.gg/Bu9qEPnHsc) and [forums](https://forums.runtipi.io/). If you found vulnerabilities or bugs, [create a new issue here](https://github.com/runtipi/runtipi-appstore/issues).
- If you are looking to report a bug, vulnerability or request a new feature for Homarr, use https://github.com/homarr-labs/homarr . You can ask for help on our Discord.
+See the [Runtipi installation documentation](https://runtipi.io/docs/getting-started/installation) for host setup.
@@ -38,13 +38,14 @@ This method is only useful, when you want to develop on Homarr or extend it with
    Install all dependencies using <code>pnpm install</code>
  </li>
  <li>
-    Copy the `.env.example` file to `.env` and replace `DB_URL` with the full path you want to use for the sqlite
-    database file. For example `DB_URL='/home/username/homarr/db.sqlite`
+    Copy the `.env.example` file to `.env`. Its `DB_URL='./db.sqlite'` value is ready for local use and stores the
+    database in the cloned repository. Replace it with an absolute writable path such as
+    `DB_URL='/home/username/homarr/db.sqlite'` if you want to store the database elsewhere.
  </li>
  <li>
-    Replace `AUTH_SECRET` and `SECRET_ENCRYPTION_KEY` both with a secure random string by using `openssl rand -hex 32`
+    Run `openssl rand -hex 32` twice and set `AUTH_SECRET` and `SECRET_ENCRYPTION_KEY` to the two different generated
+    values. Keep both values secret and preserve `SECRET_ENCRYPTION_KEY` with your backups.
  </li>
-  <li>Replace `CRON_JOB_API_KEY` with a secure random string by using `openssl rand -base64 32`</li>
  <li>Run `pnpm run db:migration:sqlite:run` and wait that it completes</li>
  <li>Build the source using `pnpm build`</li>
  <li>
@@ -30,7 +30,7 @@ You can install Homarr directly from your Unraid Dashboard, no terminal required

 Don't know whether you have the plugin installed or not? Search for this tab in the navigation:

-![](img/unraid-navigation-app-manager.webp)
+![Unraid navigation with the Apps tab highlighted](img/unraid-navigation-app-manager.webp)
 :::

 #### Installing
@@ -41,7 +41,7 @@ After you've installed the Community Apps Plugin, you can install Homarr from th
 2. Search for "Homarr" and click on the result.
 3. Click on "Install" and adjust the settings to your liking.

-![](img/unraid-apps-homarr.webp)
+![Homarr result in Unraid Community Apps with installation actions](img/unraid-apps-homarr.webp)

 After you've installed Homarr, you can find it under the tab "Docker".

@@ -0,0 +1,88 @@
+---
+title: Try the v2 beta
+sidebar_position: 2
+tags:
+  - Getting started
+  - Upgrade
+  - Migration
+  - Backup
+---
+
+This page covers the temporary Homarr v2 public beta. Try the [live demo](https://app-v2.preview.homarr.dev/)
+without installing anything, or run the beta image published in the
+[public beta announcement](https://github.com/homarr-labs/homarr/issues/6600):
+
+```sh
+docker pull ghcr.io/homarr-labs/homarr-test:v2
+```
+
+For a fresh beta installation, follow the [Docker installation guide](/docs/getting-started/installation/docker),
+use `ghcr.io/homarr-labs/homarr-test:v2` as the image, and use a separate `/appdata` volume.
+Set `WORKSHOP_API_URL=https://v2.preview.homarr.dev` to use the preview Workshop.
+
+Homarr runs database migrations automatically at startup; no manual database migration command is needed.
+Once v2 is released, existing installations can use their normal update process. The beta image below is temporary.
+
+:::danger Back up before starting v2
+
+In Homarr v1, go to **Management → Tools → Backup**, export a backup, and keep the downloaded file somewhere safe
+before starting v2. See [Backup and restore](/docs/management/backup) for details.
+
+:::
+
+## Try the beta with existing v1 data
+
+1. Change the Homarr image to `ghcr.io/homarr-labs/homarr-test:v2`.
+2. Keep the existing `/appdata` mount, database variables, Redis configuration, and `SECRET_ENCRYPTION_KEY` unchanged.
+3. Start one Homarr replica and follow its logs. Startup must reach `Migration complete`; Homarr aborts startup when a
+   database migration fails.
+4. Open Homarr and sign in. Confirm **Management → About** reports v2 before starting additional replicas.
+5. Keep using the beta image for beta updates. To return to v1, restore the pre-beta backup as described below.
+
+Keep your other existing Compose settings, including environment variables. For Docker Compose, update the image and preview Workshop URL before the usual update:
+
+```yaml
+services:
+  homarr:
+    image: ghcr.io/homarr-labs/homarr-test:v2
+    environment:
+      WORKSHOP_API_URL: https://v2.preview.homarr.dev
+```
+
+```sh
+docker compose pull
+docker compose up -d
+docker compose logs --follow homarr
+```
+
+Do not add `-v` when stopping the Compose deployment; that can remove named volumes.
+
+## What v2 migrates
+
+The startup migration:
+
+- creates the Custom Widget v2, Assistant, header preference, and branding storage;
+- adds Base/Mobile layout roles and left/right board gutters;
+- converts legacy Categories and dynamic sections into Containers and rails;
+- preserves legacy Custom Widget definitions, encrypted secrets, and board references for explicit migration.
+
+Legacy Custom Widgets are not silently rewritten. In **Management → Custom Widgets**, entries marked
+**Migration required** provide a credential-free migration prompt. Review and test the resulting v2 definition before
+removing the archived v1 version. See [Custom Widgets: Import and Workshop](/docs/management/custom-widgets#import-and-workshop).
+
+## Verify the upgraded instance
+
+- Sign in with each enabled authentication method and verify administrator access.
+- Open every important board on desktop and mobile. Check Containers, former Categories, rails, item placement, and
+  home-board assignments.
+- Test at least one read and one permitted action for each critical integration. Recheck integration and board access
+  for representative Viewer, Editor, and Admin groups.
+- Check Docker or Podman endpoints, search engines, uploaded media, trusted certificates, scheduled tasks, WebSockets,
+  and external Redis when used.
+- Review every legacy Custom Widget and migrate it only after its v2 preview and requests work.
+- Restart Homarr once more and confirm the logs contain no migration, database, Redis, authentication, or task errors.
+
+## Roll back
+
+Use the backup exported before the upgrade if you need to restore your v1 installation. Do not reuse a database that
+v2 has already migrated with v1.
@@ -5,6 +5,6 @@
  "link": {
    "type": "generated-index",
    "title": "Integrations",
-    "description": "Integration are a principal part of homarr, it's where you can connect your other apps to interact with them with widgets or other capabilities, Homarr currently integrates with the following applications:"
+    "description": "Connect Homarr to supported services so widgets can display data and run actions. Choose an integration to see its setup requirements and compatible widgets."
  }
 }
@@ -1,114 +1,25 @@
 ---
 title: "Docker"
-description: "Docker is a platform where you can run your applications in containers, allowing for easy deployment and management of applications."
+description: "Connect Homarr to Docker-compatible container engines."
 hide_title: true
 ---

 import { IntegrationHeader } from "@site/src/components/integrations/header";
 import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
-import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
-import { IconBrandDocker, IconTool } from "@tabler/icons-react";
 import { dockerIntegration } from ".";
 import { dockerContainersWidget } from "@site/docs/widgets/docker-containers";

 <IntegrationHeader integration={dockerIntegration} categories={["Containers"]} />

-### Widgets & Capabilities
+### Widgets and capabilities

-<IntegrationCapabilites
-  items={[
-    {
-      widget: dockerContainersWidget,
-      note: "This widget can only be used with administrator privileges",
-    },
-  ]}
-/>
+<IntegrationCapabilites items={[{ widget: dockerContainersWidget, note: "Requires administrator access" }]} />

-## Connecting Docker to Homarr
+Docker endpoints are configured with environment variables rather than under **Management → Integrations**.

-Docker connections come directly from Homarr's environment variables. They are automatically available in the Docker management table and Docker widget; you do not create a Docker integration under **Management → Integrations**.
+## Local socket

-If Homarr runs directly on a host with Docker installed, it uses `/var/run/docker.sock` by default. When Homarr runs in a container, mount the [Docker socket](https://docs.docker.com/engine/security/protect-access/) into it so Homarr can interact with Docker.
-
-In Docker Compose, you can simply add this line:
-
-```yaml {10}
-#---------------------------------------------------------------------#
-#     Homarr - A simple, yet powerful dashboard for your server.      #
-#---------------------------------------------------------------------#
-services:
-  homarr:
-    container_name: homarr
-    image: ghcr.io/homarr-labs/homarr:latest
-    restart: unless-stopped
-    volumes:
-      - /var/run/docker.sock:/var/run/docker.sock # <--- add this line here!
-      - ./homarr/appdata:/appdata
-    environment:
-      - SECRET_ENCRYPTION_KEY=your_64_character_hex_string # <--- can be generated with `openssl rand -hex 32`
-    ports:
-      - "7575:7575"
-```
-
-With docker run, add this parameter: `-v /var/run/docker.sock:/var/run/docker.sock`.
-In Windows, you'll need to adjust the slashes: `-v //var/run/docker.sock:/var/run/docker.sock`
-
-### Using Podman
-
-On Linux, Homarr can connect to Podman's [Docker-compatible API](https://docs.podman.io/en/latest/markdown/podman-system-service.1.html).
-The Podman API socket must be running and mounted into the Homarr container.
-The socket grants full access to Podman, including arbitrary code execution as the user running the API, so only mount it into trusted containers.
-
-For rootless Podman, enable the socket for the user that runs Homarr:
-
-```bash
-systemctl --user enable --now podman.socket
-```
-
-The rootless socket is located at `$XDG_RUNTIME_DIR/podman/podman.sock` (usually `/run/user/<uid>/podman/podman.sock`).
-You can confirm the path with:
-
-```bash
-podman info --format '{{.Host.RemoteSocket.Path}}'
-```
-
-Mount that socket into the Homarr container and point `DOCKER_SOCKET_PATHS` to its path **inside** the container:
-
-```yaml
-services:
-  homarr:
-    container_name: homarr
-    image: ghcr.io/homarr-labs/homarr:latest
-    restart: unless-stopped
-    volumes:
-      - ${XDG_RUNTIME_DIR}/podman/podman.sock:/var/run/podman.sock
-      - ./homarr/appdata:/appdata
-    environment:
-      SECRET_ENCRYPTION_KEY: your_64_character_hex_string
-      DOCKER_SOCKET_PATHS: /var/run/podman.sock
-    ports:
-      - "7575:7575"
-```
-
-Start Homarr with `podman compose up -d`.
-Run the compose project as the same user that owns the rootless Podman socket so `$XDG_RUNTIME_DIR` resolves to the correct path.
-To keep the user socket available after logout and across reboots, enable lingering with `loginctl enable-linger <user>`.
-
-For rootful Podman, enable the system socket with `sudo systemctl enable --now podman.socket`.
-Its default path is `/run/podman/podman.sock`; mount that path instead and start Homarr with `sudo podman compose up -d`.
-
-:::note SELinux
-On systems with SELinux enabled, Podman's documentation recommends disabling label separation for a container that accesses the API socket.
-Add the following to the Homarr service:
-
-```yaml
-security_opt:
-  - label=disable
-```
-
-:::
-
-You can connect Homarr to multiple Docker-compatible sockets by mounting each socket and listing their in-container paths, separated by commas:
+Mount the Docker socket into the Homarr container:

 ```yaml
 services:
@@ -116,12 +27,34 @@ services:
    image: ghcr.io/homarr-labs/homarr:latest
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
-      - ${XDG_RUNTIME_DIR}/podman/podman.sock:/var/run/podman.sock
-    environment:
-      DOCKER_SOCKET_PATHS: /var/run/docker.sock,/var/run/podman.sock
+      - ./homarr/appdata:/appdata
 ```

-For remote socket proxies, list the hostnames and matching ports in the same order:
+`/var/run/docker.sock` is the default. For other in-container paths, set a comma-separated list:
+
+```yaml
+environment:
+  DOCKER_SOCKET_PATHS: /var/run/docker.sock,/var/run/podman.sock
+```
+
+## Podman
+
+Homarr uses Podman's Docker-compatible API. Start the Podman socket, mount it, and include its in-container path in
+`DOCKER_SOCKET_PATHS`.
+
+For rootless Podman:
+
+```sh
+systemctl --user enable --now podman.socket
+podman info --format '{{.Host.RemoteSocket.Path}}'
+```
+
+Run Homarr as the user that owns the socket. On SELinux systems, Podman may require `security_opt: [label=disable]` for
+the Homarr container. Rootful Podman normally exposes `/run/podman/podman.sock`.
+
+## Remote endpoints
+
+For Docker socket proxies, list aligned hostnames and ports:

 ```yaml
 environment:
@@ -129,193 +62,71 @@ environment:
  DOCKER_PORTS: 2375,2375
 ```

-Homarr automatically discovers each comma-separated entry as a separate Docker environment. All environments are selected by default; the Docker widget lets you select one or more without any additional setup.
+:::warning Plaintext Docker API
+
+Unauthenticated Docker TCP provides control of the Docker host. Keep a socket proxy on a private network or use TLS.

-:::warning[Plaintext TCP]
-Plaintext Docker TCP can grant unauthenticated control of the Docker host. Prefer a local socket, a least-privilege socket proxy on a private Docker network, or TLS.
 :::

-### Advanced endpoint configuration
-
-Most users should use the comma-separated variables above. Use `DOCKER_ENDPOINTS` only when you need custom names, TLS, or restricted capabilities. It is a JSON array where every endpoint declares its identity, transport, and capabilities:
+Use `DOCKER_ENDPOINTS` for named endpoints, TLS, or restricted capabilities:

 ```yaml
-services:
-  homarr:
-    volumes:
-      - /var/run/docker.sock:/var/run/docker.sock
-      - ./docker-ca.pem:/run/secrets/docker-ca.pem:ro
-    environment:
-      DOCKER_ENDPOINTS: >-
-        [
-          {
-            "id": "local",
-            "name": "Local Docker",
-            "kind": "docker",
-            "transport": { "type": "socket", "path": "/var/run/docker.sock" },
-            "capabilities": ["inventory", "logs", "lifecycle", "remove"]
-          },
-          {
-            "id": "remote-read-only",
-            "name": "Production inventory",
-            "kind": "docker",
-            "transport": {
-              "type": "tls",
-              "host": "docker.example.com",
-              "port": 2376,
-              "caPath": "/run/secrets/docker-ca.pem"
-            },
-            "capabilities": ["inventory", "logs"]
-          }
-        ]
+environment:
+  DOCKER_ENDPOINTS: >-
+    [
+      {
+        "id": "local",
+        "name": "Local Docker",
+        "kind": "docker",
+        "transport": { "type": "socket", "path": "/var/run/docker.sock" },
+        "capabilities": ["inventory", "logs", "lifecycle", "remove"]
+      },
+      {
+        "id": "production",
+        "name": "Production inventory",
+        "kind": "docker",
+        "transport": {
+          "type": "tls",
+          "host": "docker.example.com",
+          "port": 2376,
+          "caPath": "/run/secrets/docker-ca.pem"
+        },
+        "capabilities": ["inventory", "logs"]
+      }
+    ]
 ```

-The stable `id` keeps containers from different endpoints distinct. `name` is shown in the interface, and `kind` can be `docker` or `podman`. Every endpoint must include the `inventory` capability; optionally add `logs`, `lifecycle`, and `remove`. Homarr hides or disables actions the endpoint does not allow and also enforces the same capabilities on the server.
+Each endpoint requires a stable `id`, display `name`, `kind` (`docker` or `podman`), transport, and the `inventory`
+capability. Optional capabilities are `logs`, `lifecycle`, and `remove`.

-Supported transports are:
+| Transport | Required values                                                                     |
+| --------- | ----------------------------------------------------------------------------------- |
+| `socket`  | Absolute in-container `path`                                                        |
+| `tls`     | `host`, `port`, absolute `caPath`; optional `certPath` and `keyPath` for mutual TLS |
+| `tcp`     | `host`, `port`, and `allowInsecure: true`                                           |

- `socket`: an absolute in-container `path`
- `tls`: `host`, `port`, and an absolute `caPath`; add both `certPath` and `keyPath` for mutual TLS
- `tcp`: `host`, `port`, and the explicit acknowledgement `allowInsecure: true`
+`DOCKER_ENDPOINTS` takes precedence over the socket, hostname, and port lists.

-The structured configuration refuses TCP unless `allowInsecure` is explicitly set to `true`. When `DOCKER_ENDPOINTS` is set, it takes precedence over `DOCKER_SOCKET_PATHS`, `DOCKER_HOSTNAMES`, and `DOCKER_PORTS`.
+## Use in Homarr

-### Managing your Docker containers within Homarr
+The Docker management page lists containers from every configured endpoint and can show logs, resource use, and
+permitted lifecycle actions. The Docker widget can include all endpoints or a selected subset.

-Homarr allows you to interact with Docker containers running on your system.
-The collapsed **Assisted Docker setup** helper optionally compares visible containers with your existing Homarr apps and integrations. Open it only when you want setup suggestions; it never blocks normal container management. Every service stays distinct by Docker endpoint and container ID, including multiple containers that use the same integration type.
+Assisted setup compares discovered containers with existing apps and integrations. Discovery is read-only; creating or
+updating a Homarr resource still requires confirmation. If one endpoint is unavailable, containers from healthy
+endpoints remain visible.

-Homarr can show a service as:
+The `homarr.hide` label excludes a container. Other `homarr.*` labels can provide apps, integrations, groups, and widgets
+during onboarding; see [Docker label discovery](../docker-labels).

- **Ready to connect** when its image or name matches a supported integration
- **New service** when it can be added as an app but no integration is recognized
- **Already represented** or **Linked** when an app or integration already matches
- **Address changed** when a service appears to match an integration but its reachable address has changed
+## Security

-Set the usual server address once, then choose whether services normally use different ports, subdomains, or paths. Homarr uses that pattern to prefill every detected service. Each suggestion has one editable URL field with the generated and Docker-reported addresses available as autocomplete options, so you can select a suggestion or type any address directly.
+A Docker or Podman socket grants extensive host control. Prefer a least-privilege socket proxy when lifecycle access is
+not required.

-:::info[Review before changing]
-Service discovery is read-only. Homarr never creates or changes an app or integration automatically. **Set up integration** opens the standard prefilled integration form, while **Create app** opens the existing Docker app form, so you can review and confirm the final setup.
-:::
+Homarr needs `CONTAINERS=1` for inventory and `POST=1` for standard lifecycle actions with common proxies. LSIO's proxy
+can instead expose `ALLOW_START=1`, `ALLOW_STOP=1`, and `ALLOW_RESTARTS=1` while keeping `POST=0`; removal is then
+unavailable.

-Suggestions appear as a compact task list. Expand an item only when you want to edit its URL or inspect relevant setup statuses. Use the filters to focus on services that need attention or those already represented in Homarr. Refresh runs discovery again. Dismissed suggestions are stored in the current browser using their endpoint-qualified service identity and can be restored from the same helper. If multiple existing items could match, Homarr marks the result as ambiguous and does not choose one automatically.
-
-Compact status icons summarize the setup information Homarr can act on. Unknown and non-applicable runtime layers are omitted to keep the helper focused; use the integration form's connection test or the relevant board action for live diagnostics.
-
-If one Docker endpoint is unavailable, Homarr reports that endpoint while continuing to show services from healthy endpoints. An unavailable endpoint is not treated as an empty Docker installation.
-
-Each container row has an action menu with the following options:
-
- **View logs** - opens a dedicated logs page with a live terminal
- **Start** - start a stopped container
- **Stop** - stop a running container
- **Restart** - restart a container
- **Remove** - remove a container
- **Add to Homarr** - create a bookmark app from the container
-
-You can also search and filter containers by **container** or **image** name:
-
-![Container and Image Search](img/container-and-image-search.png)
-
-#### Viewing container logs
-
-You can view the real-time logs of any container by selecting **View logs** from the row action menu.
-This opens a dedicated page with an xterm.js terminal that streams the container's log output.
-
-#### CPU and Memory columns
-
-The Docker management table supports optional **CPU usage** and **Memory usage** columns.
-These columns are hidden by default and can be toggled on from the table column visibility settings.
-
-#### Choosing Docker environments in the widget
-
-The Docker widget can show one or more configured Docker environments. Leave **Docker environments** empty to include every endpoint, which is also the default for existing widgets. Selecting one or more entries limits container and statistics requests to those endpoints.
-
-#### Add apps from containers
-
-Homarr also lets you add apps from containers. You can simply select all containers you want to add an app for and then click the `Add to Homarr` button.
-This will open a dialog where you can specify the web addresses for all of them:
-
-![Dialog for addding apps to Homarr](img/add-to-homarr-dialog.png)
-
-Once you've changed the web addresses, click the `Add` button to add the apps to Homarr.
-They are then available in the app list and can be used as normally added apps.
-
-![Apps added from containers](img/add-to-homarr-apps.png)
-
-### Container labels
-
-`homarr.hide` excludes a container from the Docker Containers widget, tools page, and onboarding discovery whenever the
-label is present.
-
-During first-run onboarding, Homarr can also discover apps, integrations, groups, and compatible widgets from
-`homarr.*` labels, with Homepage labels as a fallback. See the complete [Docker label reference](/docs/integrations/docker-labels).
-
-### Security
-
-Mounting docker sockets can be risky, as they permit full control over your docker service.
-As an example, a thread actor could abuse Homarr use the socket to start, stop or delete containers on your system.
-
-Therefore we recommend the usage of a socket proxy, which can prohibit certain actions.
-A few examples include:
-
- https://github.com/linuxserver/docker-socket-proxy
- https://github.com/Tecnativa/docker-socket-proxy
-
-See documentation of the respective proxies on how to configure them.
-Homarr may behave in unexpected ways when you use proxies.
-
-#### Permissions
-
-Homarr needs the following permissions from the Docker API:
-
- Containers/Start
- Containers/Stop
- Containers/Restart
- Containers/Remove
-
-For socket proxies, you will need these permissions:
-
- `CONTAINERS=1`
- `POST=1`
-
-**Caution:** `POST` access is security critical as it provides extensive capabilities to modify your docker environment. Please leave it disabled if you're concerned about this.
-
-As a workaround, you can use [LSIO's socket proxy](https://github.com/linuxserver/docker-socket-proxy) and set the following:
-
- ALLOW_START=1
- ALLOW_STOP=1
- ALLOW_RESTARTS=1
-
-These will work even with `POST=0`.
-
-You lose the ability to remove containers, but start, stop and restarts should work just fine.
-
-#### Connecting to Docker via Socket Proxies
-
-To connect to Docker via a socket proxy, you'll need to add these two environment variables in the compose file:
-
- `DOCKER_HOSTNAMES=<name of the socket proxy container>`
- `DOCKER_PORTS=<socket proxy port, usually 2375>`
-
-Refer: https://homarr.dev/docs/advanced/environment-variables/
-
-You will also need to add Homarr to the network of your socket proxy. You can do it like this:
-
-1. Add the network to your compose file (with appropriate changes):
-
-```yaml
-networks:
-  socket-proxy:
-    name: socket-proxy # <--- change this to the name of the network as set up by the socket proxy
-    external: true
-```
-
-2. Add the network to the homarr service in the compose file:
-
-```yaml
-networks:
-  - socket-proxy
-```
-
-3. Finally, if it is present, remove the default docker socket connection under `volumes` in the homarr service.
+Add Homarr to the proxy's Docker network and configure its service name and port with `DOCKER_HOSTNAMES` and
+`DOCKER_PORTS`.
@@ -8,7 +8,6 @@ import { IntegrationHeader } from "@site/src/components/integrations/header";
 import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
 import { AddingIntegration } from "@site/src/components/integrations/adding";
 import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
-import { IconZoomQuestion, IconChartBar, IconSearch } from "@tabler/icons-react";
 import { icalIntegration } from ".";
 import { calendarWidget } from "@site/docs/widgets/calendar";

@@ -39,6 +38,5 @@ import { calendarWidget } from "@site/docs/widgets/calendar";
  ]}
 />

-## Using the iCal integration
-
-The iCal integration allows you to add external calendars to Homarr. Any calendar that provides a public iCal URL can be integrated, such as Google Calendar, Apple Calendar, or Outlook.
+The integration accepts any public iCal URL, including calendars published by Google Calendar, Apple Calendar, and
+Outlook.
@@ -1,6 +1,6 @@
 ---
 title: "Immich"
-description: "Self-hosted photo and video management solution"
+description: "Self-hosted photo and video management."
 hide_title: true
 ---

@@ -14,7 +14,7 @@ import { immichServerStatsWidget } from "../../widgets/immich-server-stats";

 <IntegrationHeader integration={immichIntegration} categories={["Photo server"]} />

-### Widgets & Capabilities
+### Widgets and capabilities

 <IntegrationCapabilites items={[{ widget: immichAlbumCarouselWidget }, { widget: immichServerStatsWidget }]} />

@@ -24,34 +24,16 @@ import { immichServerStatsWidget } from "../../widgets/immich-server-stats";

 ### Secrets

-<IntegrationSecrets secrets={[{
-  credentials: ['apiKey'],
-  steps: [
-    'Navigate to your Immich instance', 
-    'Open your account settings or navigate to https://YOUR_IMMICH/user-settings', 
-    'Scroll down to "API Keys"', 
-    'Click "New API Key"', 
-    'Enter a name, e.g. "Homarr"', 
-(
+Create an API key under **Immich user settings → API Keys** with these permissions:

-  <span>
+`album.statistics`, `album.read`, `album.create`, `user.read`, `user.update`, `asset.read`, `asset.view`,
+`asset.download`, `asset.statistics`, `server.statistics`, and `server.about`.

-    Select the following permissions:{" "}
-    <code>album.statistics</code>,{" "}
-    <code>album.read</code>,{" "}
-    <code>album.create</code>,{" "}
-    <code>user.read</code>,{" "}
-    <code>user.update</code>,{" "}
-    <code>asset.read</code>,{" "}
-    <code>asset.view</code>,{" "}
-    <code>asset.download</code>,{" "}
-    <code>asset.statistics</code>,{" "}
-    <code>server.statistics</code>,{" "}
-    <code>server.about</code>.
-
-  </span>
-
-),
-'Create the integration in Homarr and copy the API key to there'
-]
-}]} />
+<IntegrationSecrets
+  secrets={[
+    {
+      credentials: ["apiKey"],
+      steps: ["Create the API key in Immich and copy its value into the Homarr integration."],
+    },
+  ]}
+/>
@@ -1,55 +1,33 @@
 ---
 title: "Kubernetes"
-description: "Kubernetes is a powerful container orchestration platform that automates the deployment, scaling, and management of containerized applications."
+description: "Read Kubernetes resources and cluster metrics in Homarr."
 hide_title: true
 ---

 import { IntegrationHeader } from "@site/src/components/integrations/header";
 import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
-import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
-import { IconBrandDocker, IconTool } from "@tabler/icons-react";
 import { kubernetesIntegration } from ".";

 <IntegrationHeader integration={kubernetesIntegration} categories={["Containers"]} />

-Homarr provides a user-friendly Kubernetes dashboard that offers an overview of your cluster’s resources in a clear and structured interface. It allows users to view key Kubernetes objects, including `Pods`, `Services`, `Ingresses`, `Nodes`, `ConfigMaps`, `Secrets`, `Namespaces`, and `Volumes`, as well as basic metrics when the Kubernetes Metrics Server is enabled.
+Homarr provides a read-only view of pods, services, ingresses, nodes, ConfigMaps, Secrets, namespaces, and volumes.
+Metrics Server is optional; without it, inventory and reserved capacity remain available but live CPU and memory do not.

-Docker service discovery does not convert Kubernetes resources into Homarr apps or integrations. Kubernetes remains a separate, read-only operational view, so a cluster resource is never changed or linked automatically.
+## In-cluster access

-:::warning[Read only]
-This integration is read-only, meaning Homarr does not modify or manage cluster resources but serves as an informational tool to enhance visibility into your Kubernetes environment.
-:::
-
-![Dashboard](img/dashboard.jpeg)
-
-### Prerequisites
-
-Before deploying Homarr in Kubernetes, ensure the following prerequisites are met:
-
- Kubernetes (Version >= 1.24.0)
- Metrics Server ([install from here](https://github.com/kubernetes-sigs/metrics-server)) is optional. Without it, Homarr still shows cluster inventory, node status, and reserved capacity, and identifies live CPU and memory usage as unavailable.
- RBAC Enabled (Required for Homarr Helm chart)
-
-### Configuring RBAC in Helm Chart
-
-To enable RBAC for Homarr, configure the Helm chart values file as follows:
+Enable RBAC in the Homarr Helm values:

 ```yaml
 rbac:
  enabled: true
 ```

-:::tip[What Does rbac.enabled Do?]
-Enabling RBAC in the Helm chart creates the necessary Kubernetes Role-Based Access Control (RBAC) resources to allow Homarr to view various Kubernetes objects. These include:
+The chart creates the service account and read-only Role/ClusterRole bindings used by Homarr. Kubernetes 1.24 or newer is
+required.

- Service Account: A dedicated service account for Homarr.
- Role & RoleBinding: Grants permissions within a specific namespace to list, watch, and get pods, services, secrets, configmaps, and more.
- ClusterRole & ClusterRoleBinding: Extends the same permissions cluster-wide for additional flexibility.
-  :::
+## Kubeconfig contexts

-### Multiple Kubernetes contexts
-
-When Homarr runs outside a cluster, set `KUBECONFIG` explicitly so Homarr loads the contexts from the referenced kubeconfig file or files. Mount the kubeconfig read-only and set the standard `KUBECONFIG` environment variable to its path inside the Homarr container:
+When Homarr runs outside the cluster, mount a kubeconfig read-only and set `KUBECONFIG` to its in-container path:

 ```yaml
 services:
@@ -60,20 +38,7 @@ services:
      KUBECONFIG: /app/config/kubeconfig
 ```

-The Kubernetes management pages include a context selector. The selected context is stored in the page URL, so each React Query cache entry and every API request remains context-specific. Resources with the same namespace and name in two contexts therefore remain separate.
+The management page exposes every configured context. An unavailable context does not hide healthy contexts; a context
+without Metrics Server is marked **Metrics unavailable**.

-Context status is checked independently. If one context is unavailable, the selector still lists healthy contexts. A context is shown as **Metrics unavailable** when its Kubernetes API is reachable but Metrics Server is not; inventory remains available without live CPU and memory usage.
-
-When Homarr runs inside Kubernetes without `KUBECONFIG`, it keeps using the in-cluster service account as the single default context.
-
-### Homarr Dashboard Overview
-
-Once deployed, Homarr provides a dashboard displaying Kubernetes metrics and resource information. The main page includes:
-
- Pods: Lists running and pending pods.
- Services: Shows available services and their configurations.
- Ingresses: Displays ingress rules and associated routes.
- Nodes: Provides an overview of cluster nodes and their status.
- ConfigMaps & Secrets: Lists configuration data and secrets used within the cluster.
- Namespaces: Displays all available namespaces in the cluster.
- Volumes: Shows persistent and ephemeral storage resources.
+Kubernetes resources are not converted into Homarr apps or integrations during Docker discovery.
@@ -1,6 +1,6 @@
 ---
 title: "OPNsense"
-description: "OPNsense is an open-source, easy-to-use, and easy-to-build firewall and routing platform."
+description: "Open-source firewall and routing platform."
 hide_title: true
 ---

@@ -8,22 +8,14 @@ import { IntegrationHeader } from "@site/src/components/integrations/header";
 import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
 import { AddingIntegration } from "@site/src/components/integrations/adding";
 import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
-import { IconHeartRateMonitor } from "@tabler/icons-react";
 import { opnsenseIntegration } from ".";
-import Alert from "@theme/Admonition";
 import { firewallWidget } from "../../widgets/firewall";

 <IntegrationHeader integration={opnsenseIntegration} categories={["Firewall"]} />

-### Widgets & Capabilities
+### Widgets and capabilities

-<IntegrationCapabilites
-  items={[
-    {
-      widget: firewallWidget,
-    },
-  ]}
-/>
+<IntegrationCapabilites items={[{ widget: firewallWidget }]} />

 ### Adding the integration

@@ -31,44 +23,18 @@ import { firewallWidget } from "../../widgets/firewall";

 ### Secrets

+Use a dedicated API-only user with **Lobby: Dashboard** and **Reporting: Traffic** privileges.
+
 <IntegrationSecrets
  secrets={[
    {
-      tabLabel: "ApiKey (Key & Secret)",
+      tabLabel: "API key and secret",
      credentials: ["opnsenseApiKey", "opnsenseApiSecret"],
-      header: (
-        <Alert type="info">
-          This integration does not require full API access to the firewall. The following guide outlines the process
-          for creating a restricted OPNsense user with a scrambled password, designed exclusively for API access. This
-          ensures minimal permissions and prevents local login capability.
-        </Alert>
-      ),
      steps: [
-        "Log in to the OPNsense web interface as an administrator",
-        "Navigate to System → Access → Users",
-        "Click the + (Add) button to create a new user",
-        <>
-          Fill in the user details:
-          <ul>
-            <li>Username: Enter a unique name</li>
-            <li>Password: Leave empty</li>
-            <li>Scrambled Password: Enable this option</li>
-            <li>Full name: (Optional) Add a descriptive name</li>
-          </ul>
-        </>,
-        <>
-          In Privileges section → Select the option below:
-          <ul>
-            <li>Lobby: Dashboard</li>
-            <li>Reporting: Traffic</li>
-          </ul>
-        </>,
-        "Click Save",
-        "Return to the Users list",
-        "Find the user and click the ticket icon in the Commands column",
-        "Click Yes in the popup to confirm",
-        "A txt file will download automatically, containing: Key and Secret",
-        "Save this file securely—this information will only be shown once",
+        "Under System → Access → Users, create a user with Scrambled Password enabled.",
+        "Grant Lobby: Dashboard and Reporting: Traffic privileges, then save the user.",
+        "Use the ticket action for that user and confirm the API key download.",
+        "Copy the downloaded key and secret into Homarr.",
      ],
    },
  ]}
@@ -8,7 +8,6 @@ import { IntegrationHeader } from "@site/src/components/integrations/header";
 import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
 import { AddingIntegration } from "@site/src/components/integrations/adding";
 import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
-import { IconAd, IconDeviceGamepad } from "@tabler/icons-react";
 import Alert from "@theme/Admonition";
 import { dnsHoleSummaryWidget } from "@site/docs/widgets/dns-hole-summary";
 import { dnsHoleControlsWidget } from "@site/docs/widgets/dns-hole-controls";
@@ -44,7 +43,7 @@ import { piHoleIntegration } from ".";
    {
      credentials: ["apiKey"],
      steps: [],
-      body: "Please note, that in v6 of Pi-hole you no longer specify an API key, but instead either a password or application password. We suggest to use the application password when possible.",
+      body: "Pi-hole v6 uses a password or application password instead of an API key. Prefer an application password.",
    },
    {
      credentials: [],
@@ -1,6 +1,6 @@
 ---
 title: "Proxmox"
-description: "Proxmox is a powerful open-source virtualization platform that allows you to run virtual machines and containers."
+description: "Virtual machines and containers managed by Proxmox VE."
 hide_title: true
 ---

@@ -8,15 +8,12 @@ import { IntegrationHeader } from "@site/src/components/integrations/header";
 import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
 import { AddingIntegration } from "@site/src/components/integrations/adding";
 import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
-import { IconHeartRateMonitor } from "@tabler/icons-react";
 import { proxmoxIntegration } from ".";
-import Alert from "@theme/Admonition";
 import { healthMonitoringWidget } from "@site/docs/widgets/health-monitoring";
-import { systemResourcesWidget } from "@site/docs/widgets/system-resources";

 <IntegrationHeader integration={proxmoxIntegration} categories={["System monitoring"]} />

-### Widgets & Capabilities
+### Widgets and capabilities

 <IntegrationCapabilites items={[{ widget: healthMonitoringWidget }]} />

@@ -26,81 +23,23 @@ import { systemResourcesWidget } from "@site/docs/widgets/system-resources";

 ### Secrets

+Use a Proxmox VE (`pve`) user and API token with the `PVEAuditor` role at `/` and **Propagate** enabled. PAM
+authentication may not work with the API.
+
 <IntegrationSecrets
  secrets={[
    {
-      header: (
-        <Alert type="caution">
-          The Proxmox API may not work with Linux PAM standard authentication. It is strongly recommended to use the
-          Proxmox VE authentication server realm when creating your API user.
-        </Alert>
-      ),
      credentials: ["username", "tokenId", "realm", "apiKey"],
      steps: [
-        "Navigate to the Proxmox portal, click on Datacenter",
-        "Expand Permissions, click on Groups",
-        "Click the Create button",
-        "Name the group something informative, like api-users",
-        "Click on the Permissions 'folder'",
-        <>
-          Click Add {"->"} Group Permission
-          <ul>
-            <li>Path: /</li>
-            <li>Group: group from Step 4 above</li>
-            <li>Role: PVEAuditor</li>
-            <li>Propagate: Checked</li>
-          </ul>
-        </>,
-        "Expand Permissions, click on Users",
-        <>
-          Click the Add button
-          <ul>
-            <li>User name: something informative like api</li>
-            <li>Realm: Proxmox VE authentication server</li>
-            <li>Password: create a secure password for the user</li>
-            <li>Confirm Password: re-enter the password</li>
-            <li>Group: group from Step 4 above</li>
-          </ul>
-        </>,
-        "Expand Permissions, click on API Tokens",
-        <>
-          Click the Add button
-          <ul>
-            <li>User: user from Step 8 above</li>
-            <li>Token ID: something informative like the application or purpose like homarr</li>
-            <li>Privilege Separation: unchecked</li>
-          </ul>
-        </>,
-        "Copy the Secret that is shown in Step 10 because it is only shown once",
-        "Go back to the 'Permissions' menu",
-        <>
-          Click Add {"->"} API Token Permission
-          <ul>
-            <li>Path: /</li>
-            <li>API Token: select the API token created in Step 10</li>
-            <li>Role: PVE Auditor</li>
-            <li>Propagate: Checked</li>
-          </ul>
-        </>,
+        "Create a Proxmox VE user or group and grant PVEAuditor at / with Propagate enabled.",
+        "Create an API token for that user. Disable privilege separation to inherit the user permission, or grant the token the same PVEAuditor permission.",
+        "Copy the token secret when Proxmox displays it and enter the user, realm, token ID, and secret in Homarr.",
      ],
      body: (
-        <>
-          <span>
-            Sometimes you'll also find the <code>api@pve!homarr</code> format, within Homarr you'll have to split it up
-            into:
-          </span>
-          <ul>
-            <li>
-              <b>Username:</b> api
-            </li>
-            <li>
-              <b>Realm:</b> pve
-            </li>
-            <li>
-              <b>Token ID:</b> homarr
-            </li>
-          </ul>
-        </>
+        <p>
+          For <code>api@pve!homarr</code>, use username <code>api</code>, realm <code>pve</code>, and token ID{" "}
+          <code>homarr</code>.
+        </p>
      ),
    },
  ]}
@@ -16,7 +16,7 @@ import { networkControllerStatusWidget } from "@site/docs/widgets/network-contro
 <IntegrationHeader integration={unifiControllerIntegration} categories={["Network controller"]} />

 This integration is using the [node-unifi](https://www.npmjs.com/package/node-unifi) library under the hood to connect to the Unifi Controller.
-Therfore it should support CloudKey Gen1, CloudKey Gen2, UnifiOS-based UDM-Pro controllers as well as self-hosted UniFi controllers.
+Therefore it should support CloudKey Gen1, CloudKey Gen2, UnifiOS-based UDM-Pro controllers as well as self-hosted UniFi controllers.

 ### Widgets & Capabilities

@@ -28,6 +28,14 @@ Therfore it should support CloudKey Gen1, CloudKey Gen2, UnifiOS-based UDM-Pro c

 <AddingIntegration />

+Use the local HTTPS address of your controller:
+
+- UniFi OS consoles such as Dream Router, Dream Machine, Cloud Gateway, and CloudKey use `https://<host>` (port 443).
+- Self-hosted UniFi Network Servers normally use `https://<host>:8443`.
+- If you omit the port, Homarr tries port 443 first and then port 8443 when the first port cannot be reached.
+
+Use a local administrator account. Cloud-only accounts and accounts with multi-factor authentication are not supported by the underlying client.
+
 ### Secrets

 <IntegrationSecrets
@@ -6,134 +6,73 @@ tags:
  - Interface
 ---

-Using the Homarr API, you can interface with the application with your own code and business logic.
-It enables you to trigger almost all actions that you can perform from the Homarr UI.
-With the API, you can build resilient systems that automatically update Homarr with data - for example syncing it with
-your deployments in a cluster or dynamically adding integrations depending on how many replicas you run.
+Homarr exposes OpenAPI and tRPC endpoints for automation. Open the generated specification under
+**Management → Tools → API** or use the [interactive API reference](/api-reference).

-This page is language-neutral, and you must implement the API on your own in your desired language.
-It requires you to know your programming language well and have a basic understanding of HTTP, JSON and networking.
-You can test out API endpoints using any OpenAPI client - for example [Yaak](https://yaak.app/).
-
-## Opening the API specification
-
-The specification is implemented according to the OpenAPI standard.
-To access the documentation, you'll need to spin up an instance of Homarr.
-Navigate to `Management` > `Tools` > `API`.
-You can copy the JSON url into your OpenAPI client or try out the endpoints directly from your browser.
-
-Alternatively, you can [open the full interactive API reference](/api-reference) directly in your browser.
+![Homarr's API documentation page](../img/api.png)

 ## Authentication

-Many endpoints will require you to authenticate. At the top of the API reference, you'll find a button to authenticate yourself with an API key.
-You can obtain API keys from the "Authentication" tab at the top of the page.
-API keys will not expire and can be used indefinitely.
-When you create a key, its one-time value is shown inline above the key table. Copy it before closing the notice; the
-creation action remains disabled until the value has been acknowledged. Deletion uses a two-click inline confirmation
-instead of opening a separate dialog.
+Create an API key from the **Authentication** tab. Its value has the form `<id>.<token>` and is shown once.

-### API Key Format
+Send it in the `ApiKey` header:

-API keys are provided in the format `<id>.<token>`. When making requests, include the key in the `ApiKey` header:
-
-```
-ApiKey: abc123def456.xyz789tokenvalue...
+```sh
+curl -H 'ApiKey: <id>.<token>' https://homarr.example.com/api/info
 ```

-### Supported Endpoints
+The same header authenticates tRPC requests under `/api/trpc`. Without a key, browser requests can use the Homarr
+session cookie.

-API key authentication works with both endpoint types:
+API keys do not expire automatically and act as the user that created them. Every request uses that user's group and
+resource permissions.

-| Endpoint Type | Path Pattern    | API Key Support |
-| ------------- | --------------- | --------------- |
-| OpenAPI       | `/api/...`      | ✅ Supported    |
-| tRPC          | `/api/trpc/...` | ✅ Supported    |
+## Invitation dates

-If no API key is provided, Homarr falls back to session cookie authentication (for browser-based access).
+`POST /api/invites` and the tRPC `invite.createInvite` procedure accept `expirationDate` as an ISO 8601 timestamp with a
+timezone, for example `2026-12-01T18:00:00Z`. Homarr validates the timestamp and stores it as a date. tRPC callers should
+send the ISO string rather than a JavaScript `Date` object.

-### Usage Examples
+## Health probes

-**OpenAPI endpoint:**
+The liveness endpoint does not require authentication:

-```bash
-curl -H 'ApiKey: <id>.<token>' http://localhost:7575/api/health/live
+```sh
+curl https://homarr.example.com/api/health/live
 ```

-**tRPC endpoint:**
+It returns JSON with overall and per-component status and latency. HTTP `200` means every dependency is healthy; HTTP
+`500` identifies an unhealthy component without exposing its internal error. Health responses are not cached.

-```bash
-curl -H 'ApiKey: <id>.<token>' http://localhost:7575/api/trpc/app.all
-```
+## Pagination

-### Use Cases
+General paginated endpoints accept at most 100 records per page, and shared search endpoints accept a limit of at most 100. Request subsequent pages instead of using a larger value.

-API key authentication enables programmatic access for:
+## Permission behavior

- Automation scripts and CI/CD pipelines
- Third-party integrations
- Custom dashboards and monitoring tools
- Container orchestration systems that need to sync app definitions
+Unauthorized operations return `FORBIDDEN`. List endpoints filter records on the server when resource-specific access
+applies.

-## Permissions
+App catalog endpoints such as `app.all`, `app.getPaginated`, and `app.search` require **Modify all apps** because they
+include internal URLs. Use `app.selectable` for the reduced board-picker fields.

-API keys act as the user that created them, so every request is subject to that user's group
-permissions. A call that the user is not allowed to make returns `FORBIDDEN`, and list endpoints
-return only the records the user may see rather than failing.
+Integration list and search endpoints return only integrations the key owner can access. Check each integration's
+`hasUseAccess` and `hasInteractAccess` fields before reading data or invoking actions.

-### App endpoints require app management access
+## Board automation

-`GET /api/apps`, `GET /api/apps/paginated` and `GET /api/apps/search` (tRPC `app.all`,
-`app.getPaginated`, `app.search`) require the **modify all apps** permission. They previously
-returned the full app catalogue — including internal URLs — to any authenticated user.
+The API can create, duplicate, rename, delete, and configure boards; manage board content; and set desktop or mobile home
+boards.

-If a script that used to work now returns `FORBIDDEN`, grant **modify all apps** to a group the key
-owner belongs to, or switch to `GET /api/apps/selectable`, which returns the reduced fields used by
-board pickers.
+Each board has exactly one Mobile and one Base layout. Mobile uses breakpoint `0`; all breakpoints are unique. Custom
+layouts can use any other breakpoint, and Homarr selects the highest breakpoint that fits the viewport. Preserve layout
+roles and use the canonical layouts returned by save operations, including generated IDs.

-### Integration endpoints are filtered per key
+Creating or changing an integration-backed widget requires use access to each newly selected integration.

-`integration.all`, `integration.allThatSupportSearch`, `integration.allOfGivenCategory` and
-`integration.search` filter server side. Without a global integration permission, a key only
-receives the integrations its owner has been granted access to, so responses may contain fewer
-records than before rather than returning an error. `integration.search` applies its `limit` after
-filtering, so a scoped key still receives a full page of results.
+## Docker targets

-Each returned integration carries a `permissions` object — check `hasUseAccess` before reading data
-and `hasInteractAccess` before performing actions; `false` means the key owner lacks that level for
-that integration, not that the call failed.
-
-## Board Automation
-
-The OpenAPI and MCP APIs include board management endpoints for common automation workflows:
-
- Create, duplicate, rename and delete boards
- Change board visibility
- Update board visual and behavior settings
- Set desktop and mobile home boards for the current user
- Configure global board defaults such as public home boards and status behavior
-
-Creating, duplicating, or reconfiguring a widget validates its integration selection on the server. The caller needs
-use access for each newly linked integration; unchanged links remain editable through normal board permissions.
-
-Board layout responses identify each layout with a `mobile`, `base`, or `custom` role. Mobile and Base are protected. Layout-saving clients must preserve existing roles, keep Mobile at breakpoint `0`, keep Base as the highest breakpoint, and use unique custom breakpoints between them. The layout save operation returns the canonical saved layouts, including server-generated IDs for new custom layouts. A non-Base layout can be regenerated from Base with the protected reset operation.
-
-The internal `board.getManageOverview` tRPC query returns compact board previews limited to 12 layout rows by default. Callers may provide `previewRowLimit` from 1 through 48; `fullPreview: true` requests the server's 48-row maximum.
-
-Use the interactive API reference to inspect the exact request body for each endpoint under the `boards` and `settings` tags.
-
-## Docker action payload migration
-
-Docker lifecycle and removal actions now identify each container with both its Docker endpoint and container ID. This is a
-breaking change for tRPC and MCP clients that previously sent an `ids` array to the start, stop, restart, or remove action.
-
-Replace the old payload:
-
-```json
-{ "ids": ["container-id"] }
-```
-
-with endpoint-qualified targets:
+Docker actions identify both the configured endpoint and the container:

 ```json
 {
@@ -141,57 +80,21 @@ with endpoint-qualified targets:
 }
 ```

-Read `endpointId` and `id` from `docker.getContainers` (MCP tool `docker_getContainers`) immediately before the action.
-Pass those pairs unchanged to `docker.startAll`, `docker.stopAll`, `docker.restartAll`, or `docker.removeAll`; their MCP tool
-names use underscores, such as `docker_restartAll`. Endpoint qualification prevents identical container IDs on different
-Docker or Podman endpoints from targeting the wrong service.
+Read both values from `docker.getContainers` immediately before calling `docker.startAll`, `stopAll`, `restartAll`, or
+`removeAll`. The endpoint ID prevents collisions between Docker or Podman hosts.

-`docker.getContainers` also accepts an optional `endpointIds` array. Omit it or pass an empty array to query every configured
-Docker environment, or pass one or more IDs returned by `docker.getEndpoints` to query only those Dockerode clients. The
-Docker widget uses the same behavior for its environment selector.
+`docker.getContainers` accepts optional `endpointIds`. Omit it or pass an empty array for every configured endpoint.

-## Partial integration failures
+## Partial upstream failures

-Multi-integration widget queries keep data from integrations that remain available. Calendar and media-server results include
-an optional `error` on a failed integration; media-request responses expose a `failedIntegrations` array, and the latest
-requests endpoint returns its items in `requests`. When every selected integration fails, the query returns an error instead
-of a partial response.
+Queries that combine several integrations can return healthy data alongside failure metadata. The exact response shape
+depends on the endpoint; inspect the generated schema instead of assuming a common `error` field. When every selected
+integration fails, the query returns an error.

-Other widgets use the same settlement pattern with endpoint-specific shapes: a failed integration may appear as a named
-fallback row, in a failure array, or be omitted while healthy results remain. Widget pages should identify the shape they
-render rather than assuming every query exposes an `error` field.
+## Custom Widget resources

-### Saving dashboard layouts
+Authenticated administrators can retrieve the current Custom Widget authoring prompt, schema, component catalog, skill,
+and focused references under `/api/custom-widgets/`.

-The dashboard editor saves item positions and sections as one board update.
-Canvas height follows its content automatically and does not require a separate API setting.
-Responsive layouts store optional left and right gutter widths from zero to three columns.
-Gutter columns are reserved from the layout's total column count, and changing them reflows affected items.
-
-## Get Custom Widget authoring resources
-
-Custom JSX v2 provides focused HTTP discovery endpoints:
-
- `GET /api/custom-widgets/authoring-prompt` returns the current prompt plus MCP and HTTP resource identifiers.
- `GET /api/custom-widgets/schema` returns the canonical widget JSON Schema.
- `GET /api/custom-widgets/components` returns the release-matched static component catalog.
- `GET /api/custom-widgets/skill` returns the concise live `SKILL.md`, a named-reference index, and installation metadata.
- `GET /api/custom-widgets/reference-schema`, `/reference-runtime`, and `/reference-security` return one authoring
-  reference at a time.
-
-Retrieve the schema, component catalog, references, and examples only when needed. Preview creation returns separate
-`queries` and `actions` evidence lists. Each action includes its HTTP method, invocation parameters, minimum board
-permission, confirmation, and invalidated query IDs so clients can simulate and verify mutations before persistence.
-
-For an evidence-driven JSX correction, `customWidget_previewReviseTemplate` accepts only the preview session,
-optional expected revision, and `template` or `templateLines`. It inherits and fully revalidates the manifest, advances
-the session revision, and returns fresh query/action lists without echoing sources, requests, options, or secrets.
-`customWidget_createFromPreview` requires current-revision evidence for every query and action; simulated action checks
-count as evidence without executing the mutation.
-
-MCP clients can call `customWidget_findComponents` with a capability query for a small release-matched component subset
-instead of retrieving the complete component catalog.
-
-Call `customWidget_configurationRequestUser` to create a temporary API source setup URL where the user can confirm their server URL and enter credentials. Do not construct or save this URL.
-
-Authenticated tRPC and MCP procedures support definition management, validation, previews, template patches, and credential writes. An exported definition does not contain credentials.
+Use [Custom Widget agent authoring](../custom-widgets/agent-authoring) for the lifecycle and
+[MCP](../mcp) when the client supports Model Context Protocol.
@@ -7,61 +7,39 @@ tags:
  - Ping
 ---

-Apps are the building blocks of your Homarr board.
-Most of the time they are a simple link to a website, but used on your board they also support a simple ping to check if your service is up.
-Apps are used in the bookmark and app widget.
+import { AppFlowDiagram } from "@site/src/components/pages/core-concepts/technical-diagrams";

-## Create an app
+An **app** is a saved shortcut used by the App and Bookmarks widgets. It contains a name, destination, icon, and
+optional status-check address.

-To create an app you can click on the button on the top right of the apps management page:
+![The Apps management page](../img/apps.png)

-![New app button](./img/new-app-button.png)
+## How an app is used

-Next, you'll need to fill out the required fields to configure the app:
+<AppFlowDiagram />

-![New app form](./img/new-app-form.png)
+## Configuration

-### Name
+Create and manage apps under **Management → Apps**.

-The name must be at least one character long and can be chosen freely.
+| Field       | Purpose                                                                                  |
+| ----------- | ---------------------------------------------------------------------------------------- |
+| Name        | Label shown on the board                                                                 |
+| Icon URL    | Direct image URL, icon-library result, or uploaded image                                 |
+| Description | Optional tooltip                                                                         |
+| URL         | Destination opened from the board; custom URI schemes are supported except `javascript:` |
+| Ping URL    | Optional HTTP(S) address used for status checks when it differs from the destination     |

-### Icon URL
+An app can be linked to an [integration](../integrations). Integration widgets then use the app as their destination
+when they provide a link to the service.

-This is the URL to the icon that will be displayed on the app widget.
-You can paste a direct HTTP(S) URL to an image, search the included icon repositories by name, or upload a local file through the upload button. The app name is pre-filled as the initial library search when no image is selected. Local images appear first, followed by SVG icons and other formats. Direct image URLs are previewed, used as entered, and are not searched in the icon repositories.
+See [Icons](/docs/advanced/icons) for icon sources and uploads.

-![Icon URL](./img/app-icon-url.png)
+## Permissions

-### Description
+- `app-create` creates apps.
+- `app-modify-all` lists and edits every app.
+- `app-full-all` also deletes and uses every app.
+- `app-use-all` allows using every app on boards without granting management access.

-An optional description that can be shown as tooltip on the app widget.
-
-### URL
-
-The URL to the website you want to link to. Clicking on the app widget or bookmark will open this URL.
-
-You can also use custom URI schemes such as `vscode://file/path`, `microsoft-edge:https://example.com`, or `myapp://open` to link to local applications or third-party programs. We trust that you know what you are doing — only `javascript:` URIs are blocked for security reasons.
-
-### Ping URL
-
-When you want to use another url for the simple status check you can set it here.
-This will allow you to set a different URL for the ping than the URL that is opened when clicking on the app widget.
-It's useful when you want to ping the service internally for example with a custom ip but open the website externally.
-Note that the ping URL only accepts `http://` and `https://` URLs — custom URI schemes are not supported for pings.
-
-## List of apps
-
-On the apps management page you find all apps that exist in your Homarr instance. Search by name or URL, open an app
-directly, or use its row actions to edit and delete it. A filtered search can be cleared without leaving the page.
-
-### Accessing the page
-
-The `/manage/apps` page is reachable when you can manage all apps (`app-modify-all`) or create apps (`app-create`):
-
- **Manage all (`app-modify-all`)**: the full list of apps is shown and searchable, and each row can be edited.
- **Create only (`app-create`)**: the page shows an empty "create an app" state instead of the list, so the names and
-  URLs of existing apps are never disclosed. The create action is still available.
- **Neither**: the page is not reachable and returns a not-found page.
-
-Creating an app requires `app-create`, editing requires `app-modify-all`, and deleting requires `app-full-all`;
-board permissions are not required.
+Users with only `app-create` can open the page and create an app, but do not receive the existing app list.
@@ -6,72 +6,53 @@ tags:
  - Administration
 ---

+import { AssistantFlowDiagram } from "@site/src/components/pages/core-concepts/technical-diagrams";
+
 # Assistant

-Assistant can answer questions and manage Homarr for you. It uses the signed-in user's permissions and asks for
-approval before making changes.
+Assistant answers questions and operates Homarr through the signed-in user's permissions. Read-only tools can run
+automatically; changes require approval by default.

-![Assistant conversation with suggested prompts](/img/assistant/conversation.png)
+![The Assistant management page](./img/assistant.png)

-## Set it up
+## Request flow

-Open **Management → Assistant**.
+<AssistantFlowDiagram />

-![Assistant provider, credentials, and model configuration](/img/assistant/configuration.png)
+## Configuration

-1. Select a provider and check its API URL.
-2. Enter an API key when required, then save the connection.
-3. Refresh the model list and select a model.
-4. Enable the assistant and save.
+Under **Management → Assistant**, select a provider, configure its API URL and key when required, select the default
+model, and enable Assistant. Users can choose another available model for a conversation.

-Choose a provider preset or use **Custom endpoint** with an OpenAI-compatible Chat Completions API. The
-[Homarr provider](../workshop/homarr-provider) is the default and needs no administrator API key. The Homarr team pays
-for a limited number of Assistant uses for each user every day; users sign in to the Community Workshop to use them.
+Provider presets cover common APIs. **Custom endpoint** accepts an OpenAI-compatible Chat Completions API. For a model
+server outside the Homarr container, use a hostname that the container can resolve instead of `localhost`.

-:::info Local model servers
+The [Homarr provider](../workshop/homarr-provider) is available through the Community Workshop without an administrator
+API key and has a daily request allowance.

-Inside a container, `localhost` means the Homarr container. Use the model server's container name, local DNS name, or
-host gateway address.
+## Access

-:::
+Open Assistant from the user menu, with `Shift+A`, from search with `Cmd/Ctrl+/`, or through the
+[Assistant widget](../widgets/assistant).

-## Use it
+Assistant can work with boards, apps, integrations, widgets, Custom Widgets, and supported connected services. Mention
+Homarr resources with `@`; the model loads additional live context only when needed.

- Select **Assistant** in the user menu or press `Shift + A`.
- Press `Cmd/Ctrl + /` to ask from search, or use `Cmd/Ctrl + K` and choose the Assistant fallback.
- Add the [Assistant widget](../widgets/assistant) to a board.
+Conversations are stored per user and can be searched, renamed, exported, or deleted.

-The assistant can work with boards, apps, integrations, widgets, Custom Widgets, and connected services. Use `@` to
-add Homarr items as context, `/` for shortcuts, and the paperclip for supported files.
+## Permissions and data

-Use **Conversations** to search, switch, rename, export, or delete threads.
+- Every tool call uses the current user's Homarr permissions.
+- Automatic approvals apply only to the current conversation and reset when switching conversations.
+- Provider keys and custom headers are encrypted and are not returned to the browser.
+- Prompts, attachments, tool definitions, and tool results are sent to the selected model provider.

-Each request includes the user's name, current page and board, home board, server time, browser time zone, and only
-explicitly mentioned Homarr entities. Live status is fetched only when needed. The full Homarr tool catalog remains
-available server-side, while the model receives a small relevant subset and can discover another capability on demand.
-
-When web search is enabled, Assistant uses bounded search context and prefers primary documentation. Custom Widget
-authoring starts with a compact skill and template validator, then discovers schema, preview, reference, and component
-tools only when the task needs them. A response-driven JSX correction revises the existing preview without resending
-its manifest; Homarr then requires fresh query and simulated-action evidence for that preview revision before saving.
-
-## Permissions and privacy
-
- Read-only actions can run automatically. Changes require approval by default. Automatic approvals apply only to the
-  current conversation, turn off when you switch conversations, and never answer questions for you.
- Homarr permissions apply to every tool call and mentioned item.
- API keys and custom headers are encrypted and never returned to the browser.
- Conversations are stored per user and can be exported or deleted.
-
-Prompts, attachments, tool definitions, and tool results are sent to the selected model provider. Review that
-provider's privacy policy before enabling the assistant.
+See [MCP](./mcp) to connect an external AI client and
+[Custom Widget agent authoring](./custom-widgets/agent-authoring) for widget generation.

 ## Troubleshooting

- **No models found:** check the base URL, model discovery path, and API key. You can enter a model ID manually.
+- **No models found:** check the API URL, discovery path, and API key, or enter a model ID manually.
 - **Assistant is unavailable:** enable it and save the configuration.
- **Tool calls stop:** select a model that supports streaming and tool calls.
- **Local endpoint is unreachable:** check container networking and the server's listen address.
-
-See [MCP](./mcp) for external AI clients and [Custom Widget agent authoring](./custom-widgets/agent-authoring) for the
-widget authoring workflow.
+- **Tool calls stop:** use a model that supports streaming and tool calls.
+- **Local endpoint is unreachable:** check container DNS, routing, and the model server's listen address.
@@ -6,78 +6,35 @@ tags:
  - Data
 ---

-# Backup & Restore
+# Backup and restore

-Homarr provides a built-in backup and restore system for **SQLite** instances. You can export your entire database - including apps, integrations, boards, users, and encryption keys - as a ZIP archive, and restore it on the same or a different Homarr instance.
+Administrators using SQLite can export and restore the complete Homarr database under
+**Management → Tools → Backup**. MySQL and PostgreSQL installations must use their database-native backup tools.

-:::warning
+![The Backup and restore management page](./img/backup.png)

-Backup and restore is only available when using the **SQLite** database driver. MySQL and PostgreSQL instances do not show this page.
+## Export

-:::
+The ZIP contains:

-## Accessing the Backup Page
+| File            | Contents                                                    |
+| --------------- | ----------------------------------------------------------- |
+| `db.sqlite`     | Apps, integrations, boards, users, settings, and other data |
+| `metadata.json` | Homarr version, backup timestamp, and encryption metadata   |

-Navigate to `Management` → `Tools` → `Backup`. You must have **admin** permissions to access this page.
+Export requires typing `I understand`. Store the ZIP as sensitive data: it contains the database and the material
+needed to restore encrypted integration credentials.

-## Exporting a Backup
+## Restore

-![Export database card with the Download Backup action](/img/backup/export-database.png)
+Select a Homarr backup ZIP. The browser previews entity counts, board names, and required database migrations before
+the archive is uploaded.

-Click the **Export** button in the export card. You'll be prompted to type `I understand` to confirm. Once confirmed, a ZIP file downloads containing:
+Restoring replaces the current SQLite database and cannot be undone. It also invalidates the current database session.
+After a successful management restore, Homarr waits for the restarted server and sends the administrator to sign in
+again. The first-run onboarding restore keeps its existing board destination.

-| File            | Description                                                         |
-| --------------- | ------------------------------------------------------------------- |
-| `db.sqlite`     | Full SQLite database with all entities                              |
-| `metadata.json` | Backup metadata: Homarr version, creation timestamp, encryption key |
+A backup can be restored on another Homarr instance. When its `SECRET_ENCRYPTION_KEY` differs, Homarr re-encrypts stored
+integration secrets for the target instance. Version metadata is used to apply compatible migrations.

-The backup contains the complete database. It includes Custom Widgets and all other Homarr configuration.
-
-## Restoring a Backup
-
-![Restore database card with the backup ZIP drop zone](/img/backup/restore-database.png)
-
-### 1. Upload
-
-Drag and drop or select a `.zip` backup file. The import card validates that the file contains a valid `db.sqlite` and metadata.
-
-### 2. Preview
-
-Before restoring, Homarr uses **sql.js WASM** to analyze the backup directly in your browser. You'll see:
-
- **Entity counts** - how many apps, integrations, boards, users, etc. are in the backup
- **Board names** - which boards will be restored
- **Migration status** - Drizzle migrations are applied in-browser with a visual timeline showing each migration step
-
-### 3. Confirm
-
-Type `I understand` to acknowledge that restoring will replace your current database. This cannot be undone.
-
-During first-run onboarding, the database is still empty, so the restore preview goes directly to **Restore Database**
-without the extra typed confirmation. After Homarr restarts, onboarding opens the restored default home board.
-
-### 4. Restore
-
-The backup ZIP is sent to the server, validated, and applied. After a successful restore:
-
- **The Next.js server restarts automatically** to reload the new database state
- Nginx and Redis (if running in Docker) stay up - only the Next.js process restarts
- The page reloads once the server is ready
-
-## Cross-Instance Restore
-
-You can restore a backup from one Homarr instance onto another. Homarr handles:
-
- **Encryption key re-encryption** - If the target instance has a different `SECRET_ENCRYPTION_KEY`, integration secrets are decrypted with the old key and re-encrypted with the new one during import
- **Version compatibility** - Backups include the Homarr version they were created with. Backward compatibility is maintained for older backup formats
-
-## Backup During Onboarding
-
-When setting up a new SQLite Homarr instance, the onboarding flow includes a **Restore from SQLite backup** step. You can upload a backup ZIP directly during onboarding to skip manual setup.
-
-## Security
-
- Export requires admin permissions
- The `I understand` confirmation dialog prevents accidental exports and overwrites
- Backups contain encrypted integration secrets - they cannot be read without the `SECRET_ENCRYPTION_KEY`
- Import only works on SQLite instances - the API routes refuse requests from MySQL/PostgreSQL instances
+The same restore flow is available during first-run onboarding, before the target database contains user data.
@@ -9,473 +9,93 @@ tags:
  - Layout
 ---

-import iconColorImage from "./img/icon-color.png";
-import itemRadiusImage from "./img/item-radius.png";
-import layoutSettingsImage from "./img/layout-settings.png";
-import layoutSettingsCustomRailsImage from "./img/layout-settings-custom-rails.png";
-import boardViewModeImage from "./img/board-view-mode.png";
-import boardEditModeImage from "./img/board-edit-mode.png";
-import keyboardTileEditingImage from "./img/keyboard-tile-editing.png";
+import { BoardLayoutsDiagram } from "@site/src/components/pages/core-concepts/technical-diagrams";

-Each dashboard is called a "board".
-You can create as many boards as you want.
-Boards can be restricted to user groups.
-A user may also have a "home board" which they will see at the root path (e.g. my-homarr.com or my-homarr.com/boards).
-Other boards can be viewed by direct links (e.g. my-homarr.com/boards/smart-home) or via the management pages.
-The management page includes a compact structural preview of each board's Base layout so you can recognize it before
-opening it. Containers include their visible widgets and app icons instead of appearing empty.
+A **board** is a dashboard page containing apps, widgets, and Containers. Its name is unique and forms the board URL.
+Boards can be public or restricted to users and groups.

-Names of boards must be unique because this will be used in the URL to load the desired board.
+![The Boards management page](../img/boards.png)

-Press `Shift+C`, or select **Switch board** from the user menu, to open the board switcher. It shows structural
-previews of every board you can access, with your current board at the end. Home-board markers and creator avatars
-match the board management view. Use the search field at the top, or simply start typing, to filter by name. Use the
-arrow keys to move through the results and press `Enter` to open the selected board.
+Create, duplicate, open, and delete boards under **Management → Boards**. Press `Shift+C` from a board to open the
+board switcher.

-## Create a new board
+## Responsive layouts

-Select **New board** on the boards management page. The creation form expands in the page, so you can enter the board
-details without opening a dialog or leaving the board list. The availability of the board name is checked as you type.
+<BoardLayoutsDiagram />

-The board menu also keeps duplication in context: select **Duplicate board**, choose the new name in the form below that
-board, and create the copy without navigating to a separate page.
+Mobile and Base are protected layouts. New boards use three Mobile columns; Base uses the column count selected at
+creation. Additional layouts use unique breakpoints. Homarr selects the layout with the highest breakpoint that fits
+the current viewport.

-### Name
-
-The name must not include any special characters and must be at least one character long.
-Underscores and hyphen-minus are allowed.
-
-### Column count
-
-The column count defines how many fixed-width cells are available in each row.
-One cell contains a `200 × 200` logical-pixel tile.
-Homarr scales the whole board uniformly instead of changing widget proportions, and always fits it to the available width without horizontal scrolling.
-The main canvas and enabled rails stay at least one viewport tall, and the canvas grows automatically while you drag or resize items near its lower edge.
-
-### Public
-
-This will enable public access for everyone - regardless of whether they are logged in or not.
-This can be really useful if you want to have public boards in your company or for family and friends.
-Modifications for public boards must be allowed explicitly using user groups and their permissions.
-
-Deleting a board from the management list uses an inline safeguard. Select **Delete**, then select **Confirm** in the
-same menu item. No separate confirmation dialog is opened.
-
-## Board settings
-
-You navigate to the board settings by clicking on these three dots:
-
-![](./img/navigate-to-settings.png)
-
-Alternatively, you can also navigate from the board page itself using the cog icon at the top right:
-
-![](./img/navigate-to-settings-2.png)
-
-All board settings are edited on a single page. Click the **Save changes** button in the save bar at the bottom to apply them, or **Discard** to restore the last saved values. The save bar only appears when you have unsaved changes. Access control and the Danger zone are independent sections and are applied immediately.
-
-### General
-
-#### Page title
-
-This is the title that will be visible at the top left in the navigation bar:
-
-![](./img/page-title.png)
-
-This field is optional and Homarr will fall back to "Homarr" if nothing is set.
-
-#### Meta title
-
-This is the secondary title of the page that is not directly visible in the page itself.
-Browser will use it to set the title of tabs:
-
-![](./img/meta-title.png)
-
-Homarr will fall back to the board name and a suffix if nothing is set.
-
-#### Logo image URL
-
-This is the URL that is used for the image at the top left.
-Homarr will fall back to the Homarr logo if nothing is set.
-
-#### Favicon image URL
-
-This is the URL that is used for the favicon in the tab title.
-Homarr will fall back to the Homarr logo if nothing is set.
-
-### Layout
-
-In this section you can configure the different responsive layouts. Homarr selects the layout with the highest breakpoint that is not wider than the current screen, then scales its complete fixed-size canvas uniformly.
-
-<img
-  src={layoutSettingsImage}
-  alt="Board settings showing protected Mobile and Base responsive layouts with rail controls"
-  style={{ maxWidth: "100%" }}
-/>
-
-The layout cards show the representative geometry used for planning. This current example also shows a custom layout
-with both fixed rails enabled; the rails reserve columns and the remaining canvas reflows automatically.
-
-<img
-  src={layoutSettingsCustomRailsImage}
-  alt="Board layout settings with a custom layout and both fixed rails enabled"
-  style={{ maxWidth: "100%" }}
-/>
-
-Every board has two protected layouts. Creating a board adds **Mobile** at `0px` with three columns and **Base** at
-`768px` with the column count you choose. Both layouts can be edited, but neither can be removed.
-
-Every `1 × 1` tile has a `200 × 200` logical-pixel content area.
-The `24` logical-pixel gap between tiles is separate from that size.
-A `2 × 1` tile therefore contains two fixed cell widths plus the gap between them.
-Widgets see their logical size, while the board's visual scale makes the complete layout larger or smaller.
-When fitting below 100%, Homarr keeps widget typography and control density at their normal readable size.
-On larger canvases, the complete board grows together like browser zoom.
-The complete canvas always fits the available width and never adds horizontal board scrolling.
-
- **Mobile** starts at `0px` and uses three columns on new boards.
- **Base** is the main layout and starts at `768px` on new boards.
-
-Mobile and Base can be renamed and their column counts can be changed, but they cannot be removed. Mobile has no fixed
-rails; rail configuration is available only on Base and custom layouts. You can add removable custom layouts at any
-unused breakpoint above Mobile.
-
-Each layout stores independent positions and sizes. Moving or resizing a widget while editing Mobile does not move it in
-Base or any custom layout. New custom layouts start from Base's current column count and rail widths; Homarr chooses an
-available breakpoint, and you can then change the breakpoint, columns, and rails.
-
-Older or incomplete boards are repaired automatically. A board with no layouts receives Mobile at `0px` with three
-columns and Base at `768px` with ten columns. A board with one layout keeps it as Base and receives a generated Mobile
-layout. When protected roles are missing from a board with multiple layouts, the narrowest becomes Mobile, the widest
-becomes Base, and intermediate layouts become custom. Once roles exist, breakpoint changes do not reassign them.
-Duplicate breakpoints are normalized without discarding saved positions.
-
-Use **Reset from Base** on Mobile or a custom layout to replace all of its positions and sizes with a newly generated version of Base. The layout's name, breakpoint, and column count are kept.
-
-The canvas is at least one window tall, even when it is empty.
-Its left and right edges are hard drag boundaries, while its bottom edge extends automatically as a tile is dragged or resized downward.
-Nested Containers keep their own resizable bounds.
-New items use their widget's default size and new Containers use a useful `4 × 3` size when space allows.
-
-#### Name
-
-The name of the layout can be chosen freely. It is only used for management and is not displayed on the board.
-
-#### Column count
-
-The total number of columns in the layout. Changing it projects the saved positions and sizes into the new grid width without overlap.
-
-#### Fixed rails
-
-Each responsive layout can enable a fixed left rail, a fixed right rail, or both.
-Set a rail width to zero to disable it for that layout.
-Choose a width from one to three columns with the three-step slider.
-The preview shows how much space remains for the main canvas.
-
-Rail columns are reserved from the layout's total column count.
-For example, a 12-column layout with a two-column left rail leaves ten columns for the canvas.
-The combined rail widths cannot consume the final main-canvas column.
-Enabling or widening a rail reflows canvas items into the remaining columns.
-Disabling a rail moves its contents back into the next available canvas positions.
-
-Rails fill the available window height and remain fixed while the page scrolls. They do not grow or scroll independently.
-Apps, widgets, and Containers inside them still use the same fixed `200 × 200` cells and can be rearranged in edit mode, where each rail shows its name and boundary.
-
-#### Breakpoint
-
-The minimum screen width where the layout is used; a layout is eligible at its breakpoint and above. Mobile is fixed at
-`0px`. Every other breakpoint must be unique, but Base and custom layouts can be ordered at any width. Homarr uses the
-eligible layout with the highest breakpoint, regardless of its role.
-When the initial viewport is not available, Homarr uses its remembered viewport information, client hints, or User-Agent
-fallback to select a layout.
-
-#### View and edit modes
-
-View mode renders a static board without executing the drag-and-drop editor.
-After the board is interactive, Homarr prepares the editor in the background for users who can modify it.
-Entering edit mode keeps the static board visible until that preparation finishes, then enables collision-aware movement and resizing.
-Collapsed Containers are expanded while editing so their contents and controls are reachable.
-
-<img
-  src={boardViewModeImage}
-  alt="A Homarr board in view mode with the dashboard canvas and static widgets visible"
-  style={{ maxWidth: "100%" }}
-/>
-
-Widget content is inert in edit mode, so dragging from the inert widget area moves the tile instead of activating the widget;
-settings and other controls remain usable in the compact header above the tile.
-A single compatible collision can swap two items when both resulting placements fit, including different-sized or lateral moves.
-For other collisions, or when a tile grows into occupied space, nearby tiles are compacted out of the way and collision chains reflow.
-The visible corner controls provide a 44-pixel resize target, and edge controls appear on hover for horizontal or vertical resizing.
-Resize handles stop at the tile's minimum allowed size while the pointer is still moving.
-Use the pencil button in the board header to enter edit mode; click it again to save. If you leave the page with unsaved
-changes, Homarr asks whether to discard them. If the editor cannot load, the board remains in view mode.
-
-<img
-  src={boardEditModeImage}
-  alt="Board in edit mode with the board header controls and editable dashboard tiles visible"
-  style={{ maxWidth: "100%" }}
-/>
-
-While edit mode is active, **Add board content** opens a menu for adding a widget, app, integration, or Container. The
-available actions respect the current user's permissions. Widget setup offers the main canvas, enabled rails, and existing
-Containers as destinations before the widget is created, so the common flow does not require a second move step.
-
-Hold `Ctrl` on Windows or Linux, or `⌘` on macOS, while clicking board items to select several at once. The selection
-toolbar can move the complete selection to another canvas, rail, or Container, delete it with an undo option, or clear the
-selection. A short tip appears after entering edit mode as a reminder of the modifier key. A move is applied only when every
-selected item fits in the destination.
-
-The widget editor also lists its selected integrations. Users with full access can choose **Edit connection** to test,
-diagnose, and repair an integration without leaving the board. A successful repair refreshes the affected widget; the
-saved integration changes apply everywhere that connection is used.
-
-Pointer users can drag from the inert widget area; interactive controls are excluded. Containers use the grab button at their top-left corner.
-Widgets can be resized from any edge or corner handle. Activate a Container's chrome with its top-left grip before using
-its resize handles.
-On a touch screen, press and hold a tile for about `200 ms` before moving it; a quick tap does not start a drag. Resize
-handles support direct touch input.
-Keyboard users can focus a tile, press Enter or Space to start editing, use the arrow keys to move it, and use Shift plus the arrow keys to resize it.
-Press Enter, Space, or Escape to stop keyboard editing.
-Keyboard moves and resizes apply immediately within the current canvas, rail, or Container; they cannot move an item
-between grids. Use pointer drag or **Move / resize item** for that.
-Escape stops keyboard editing without undoing those changes.
-During a pointer or touch interaction, Escape cancels the move or resize and restores the layout from before that interaction.
-Invalid, outside, or otherwise forbidden drops are cancelled in the same way.
-The **Move / resize item** action in the edit menu remains available for precise numeric input.
-
-<img src={keyboardTileEditingImage} alt="A focused board tile in keyboard editing mode" style={{ maxWidth: "100%" }} />
-
-#### Preview
-
-Layout Settings shows a lightweight structural preview for every layout, including saved spans, Containers, widget labels, and app icons.
-It uses a representative viewport width to project the saved geometry; it does not execute widget queries or represent every
-pixel of the screen range where the layout is active.
-
-Choose **Edit layout** to open the real board editor at that representative width on desktop. Save returns to Layout Settings. Cancel discards the local changes. On phones and tablets, the normal board editor continues to use the layout selected by the device width.
+Tiles use fixed `200 × 200` logical-pixel cells with a `24px` gap. Homarr scales the complete layout to the available
+width instead of changing each widget's proportions. **Reset from Base** regenerates a Mobile or custom layout from the
+current Base layout.

 ### Containers and rails

-Containers can hold apps, widgets, and nested Containers.
-The same Container model works on the main canvas, inside a fixed rail, or inside another Container.
-Move and resize Containers directly in edit mode; nested content stays within the Container's local bounds.
-Resize outlines follow the pointer continuously while a dashed preview marks the grid size that will be applied on release.
-Each responsive layout stores its own Container position and size.
+A **Container** groups apps, widgets, and nested Containers. It can have a label, collapse control, app-opening action,
+border color, and CSS classes.

-Each Container can configure:
+Items can occupy the outermost rows and columns of a Container. The drop preview shows the position where the item
+will remain when released.
+Dragging an item onto another item of the same size swaps their positions. Displaced items snap directly to their
+previewed positions without a movement animation and stay there when you release the pointer.

- Its label and whether that label is visible.
- Whether users can collapse and expand it like an accordion.
- Whether its menu shows **Open all in new tabs** for the app links it contains.
- Its border color and custom CSS classes.
+A **rail** reserves one to three columns at the left or right of a non-Mobile layout. Rails stay fixed while the page
+scrolls and store their contents separately for each layout.

-Collapsing a Container reduces its full-width header to a half-row expansion bar and compacts the surrounding layout without losing its expanded size.
-Expanding it smoothly restores those bounds and moves following items out of the way without reloading the widgets inside it.
+## Edit a board

-### Background
+Enter edit mode from the board header to add, move, resize, configure, or remove content. Save the board to persist the
+layout.

-When a background image is set, it always covers at least the full browser window height, even if the board's content is shorter (for example when a Container is collapsed).
+- Drag from an item's inactive content area; Containers use their grip.
+- Hold `Ctrl` on Windows/Linux or `Cmd` on macOS to select several items.
+- Use **Move / resize item** for another canvas, rail, Container, or exact coordinates.
+- Keyboard users can focus a tile, press Enter or Space, then move with arrow keys or resize with Shift + arrow keys.
+- Press Escape during a pointer or touch interaction to restore the item to its previous position.

-#### Background image URL
+The add-content menu can create an app, integration, widget, or Container without leaving the board.
+When adding apps, click one app to add it immediately, or choose **Select multiple** to add several at once. `Ctrl`/`Cmd`
+click remains available as a shortcut.

-Homarr can display a background image behind apps and widgets.
-This URL can be used to define what image should be shown.
+## Board settings

-#### Background image attachment
+Board settings cover:

-This defines whether the background should move when the user scrolls.
+- **General:** page title, browser title, logo, and favicon.
+- **Layout:** responsive layouts, breakpoints, columns, and rails.
+- **Background:** image, attachment, size, and repeat behavior.
+- **Appearance:** colors, opacity, icon color, and item radius.
+- **Custom CSS:** styles applied only to the current board.
+- **Behaviour:** app status and widget context-menu behavior.

-#### Background image size
+See [Styling](/docs/advanced/styling) for board and global CSS.

-This defines whether the background should cover the entire page (and possibly be cropped) or never be cropped but may not cover the entire page.
+Outside edit mode, widgets may expose an advanced view and a context menu for status, refresh, quick options, settings,
+and actions. Available controls depend on the widget and the user's board and integration permissions.

-#### Background image repeat
+## Access control

-This defines whether the background should be repeated if it cannot cover the entire page.
-This option can be useful if you have patterns that can be repeated easily (e.g. patterns):
+Public boards are readable without signing in. Private boards require user, group, or global access.

-![](./img/background-repeat.png)
+| Board access | View | Edit content and settings | Access control, rename, delete |
+| ------------ | ---- | ------------------------- | ------------------------------ |
+| View         | Yes  | No                        | No                             |
+| Modify       | Yes  | Yes                       | No                             |
+| Full         | Yes  | Yes                       | Yes                            |

-### Appearance
+Inherited access comes from group permissions. Resource-specific access can be granted from the board's access-control
+section.

-#### Primary color
+Renaming a board changes its URL without a redirect. Deleting a board is permanent.

-Color that can be chosen freely to give accents to active elements.
+## Home boards

-#### Secondary color
+A **home board** opens at `/` and `/boards`. Desktop and mobile home boards are separate from the responsive layouts
+inside a board.

-Color that can be chosen freely to give accents.
+Defaults can be set for a user, group, or the whole server. User settings take priority, followed by matching groups,
+the `Everyone` group, and server defaults. Server-wide fallback boards must be public.

-#### Opacity
-
-Opacity of the colors.
-
-#### Icon color
-
-Change the color of your bookmark / app icons.
-
-<img src={iconColorImage} height={100} />
-
-#### Item radius
-
-Change the radius of your items and Containers.
-
-<img src={itemRadiusImage} height={100} />
-
-### Custom CSS
-
-This is the field where you can enter custom CSS.
-The styling will only be applied on the respective board page.
-
-When Assistant is enabled, users with modify permission can also ask it to edit the board's General, Background,
-Appearance, Custom CSS, and app-status settings. The assistant reads the current stylesheet first and presents an
-editable review form before requesting approval to save the change. It does not edit responsive layouts, access control,
-or Danger zone actions.
-
-[See this guide on how to work with custom CSS](/docs/advanced/styling/).
-
-### Behaviour
-
-#### Disable app status
-
-This will disable the status check for apps.
-
-#### Work directly from the board
-
-Widgets expose their routine controls without requiring edit mode:
-
- Hold `Shift` while hovering a widget that supports advanced view to expand it in place while the other widgets
-  remain visible but dimmed. Release `Shift` to close it. Hold `Shift` plus `Ctrl` on Windows/Linux or `Cmd` on macOS to
-  keep the view open until you close it. On touch devices, open it from the widget menu. Other widgets adapt in place
-  instead.
- When signed in, outside edit mode, and with **Enable right click on widgets** enabled, right-click a widget to inspect
-  its live query status, refresh its data, change quick options, open settings, or run supported actions. App tiles do
-  not use this widget menu, and available controls follow your board and integration permissions.
-
-The widget context menu follows the **Enable right click on widgets** preference in your user settings. On touch devices,
-use the widget menu where your browser exposes it.
-
-### Access control
-
-With the access control, you can permit a single user or a group to your board.
-The users and groups can have one of these three levels of access:
-
-| **Permission Level** | View board | Edit mode | Settings | Danger zone (eg. delete) |
-| -------------------- | ---------- | --------- | -------- | ------------------------ |
-| View board           | X          |           |          |                          |
-| Modify board         | X          | X         | X        |                          |
-| Full access          | X          | X         | X        | X                        |
-
-The permission level can only be changed after adding the user / group:
-
-![](./img/change-user-permission-level.png)
-
-If the board is private and the user is not added in any of the three tabs, they cannot access the board.
-They also do not see the board on the start page nor do they have access to any links for the board.
-
-Groups that have high permissions (e.g. administrator or all board permissions) will be shown as "inherited".
-They are permitted implicitly due to their permissions.
-
-After editing permissions, the save button below the table must be pressed.
-Otherwise, all changes will be discarded.
-
-### Danger zone
-
-#### Rename
-
-Renaming a board will break all existing links to it permanently with no redirect.
-
-#### Board visibility
-
-By default, boards will be private. This means only authenticated users that are authorized have access.
-Making a board public will expose it to everyone - including unauthenticated users.
-
-#### Delete
-
-This will permanently delete the board.
-This action is irreversible and cannot be undone.
-
-## Delete boards
-
-The deletion of boards is permanent and cannot be undone.
-There are two ways to delete a board:
-
- Navigate to the settings of your board, open the "Danger zone" section and click on the "delete this board" button.
- Navigate to the list of boards in the management pages, click the three dots and click on "delete permanently".
-
-Both actions will execute the same deletion process.
-
-## Duplicate boards
-
-:::note
-Duplicating a board will not copy the users and groups that have access to the board
-nor the integrations the user does not have access to.
-:::
-
-Duplicating a board will create a new board with the same settings, all responsive layouts, and independent positions as the original board.
-Duplicating a board that contains Custom Widgets also requires an administrator.
-You can duplicate a board by clicking on the three dots in the list of boards and selecting "Duplicate board".
-The name form expands below that board card and can be cancelled without leaving the list.
-
-## Setting boards as your home board
-
-The home board is the dashboard, that will be shown at the root path of Homarr or if no board name was passed in the URL.
-All the following paths will lead to the home board:
-
- `my-homarr.com`
- `my-homarr.com/boards`
-
-Your home board will have a special small badge at the top right in the list of boards:
-
-![](./img/home-board-flag.png)
-
-### For yourself
-
-To set the home board yourself, the easiest option is to set it directly in the list of boards:
-
-![](./img/set-as-home-board-menu.png)
-
-Alternatively, you can also define it via your user profile:
-
-1. Click on your user profile at the top right
-2. Click on `Your preferences`
-3. Change the home board in the `home board` dropdown and click on `Save`.
-
-### For other users
-
-1. Navigate to the users: `Management` > `Users` > `Manage`
-2. Click on the username of the user that you want to adjust
-3. Select the desired home board via the dropdown and click on `Save` \
-   ![](./img/set-home-board-other-user.png)
-
-### For user groups
-
-1. Navigate to the user groups: `Management` > `Users` > `Groups` > `Manage`
-2. Go to tab `Settings`
-3. Select the desired home board via the dropdown and click on `Save` \
-   ![](./img/set-home-board-user-group.png)
-
-### For whole server
-
-You can also set a global home board that will be used for all users that have not set a home board themselves.
-It will also be used for anonymous users.
-
-1. Navigate to the settings: `Management` > `Settings` > `Boards`
-2. Select the desired home board via the dropdown and click on `Save` \
-   ![](./img/set-home-board-global.png)
-
-:::note
-For the global home board you can only select boards that are public.
-:::
-
-### Mobile home board
-
-The mobile home board controls which board opens for devices that Homarr detects as mobile from the User-Agent header.
-This is separate from a board's **Mobile layout**, which controls the layout selected inside that board.
-You can set a mobile home board for yourself in your user preferences, for a user or group through management, or for the
-whole server with **Global mobile board** under `Management` > `Settings` > `Boards`.
-
-For signed-in users, Homarr checks the user's mobile home board, then the user's desktop home board, then the mobile and
-desktop defaults for the lowest-position matching group, followed by the mobile and desktop defaults for the `Everyone`
-group, and finally the server-wide mobile and desktop defaults. Anonymous visitors use the server-wide mobile default and
-then the server-wide desktop default. Server-wide fallback boards must be public. See the
-[global board defaults](/docs/management/settings#boards) for the complete precedence and the required public-board rule.
+See [Users and groups](../users) and [Server settings](../settings#boards).
Author	SHA1	Message	Date
ajnart	0f1734d22e	docs(mcp): restore custom widget authoring guidance	2026-09-10 19:24:32 +02:00
Thomas	ea3dac752f	fix(mcp): harden tool schemas and dispatch (#6815 )	2026-09-10 19:19:47 +02:00
Thomas	f994d665d2	ci: remove automatic test gates and trim test suites (#6816 ) * ci: remove automatic test gates and trim test suites * docs: remove CI audit report	2026-09-10 19:14:31 +02:00
Thomas	3358b6337f	fix(mcp): use JSON-compatible invitation dates (#6814 )	2026-09-10 17:53:38 +02:00
Thomas	61d3fd5f08	fix(board): restore container grid geometry (#6808 )	2026-09-09 15:04:27 +02:00
Thomas	3aac106156	docs: correct v2 beta installation guidance (#6809 )	2026-09-09 12:09:14 +02:00
Thomas	9d857377c1	fix: refine release v2 interactions (#6805 )	2026-09-08 11:36:19 +02:00
Thomas	923905c529	fix: keep bookmark density consistent (#6804 ) * fix: keep bookmark density consistent * fix: prioritize bookmark titles in compact rows * fix: preserve compact bookmark text fallback	2026-09-08 10:39:41 +02:00
Thomas	a4a903d7c3	feat: polish release v2 experience (#6800 )	2026-09-07 19:17:37 +02:00
Thomas	925b0fb801	fix: improve bookmark widget density (#6802 ) * fix: improve bookmark widget density * fix: render dense bookmark grids as icons * fix: honor bookmark column density	2026-09-07 13:47:11 +02:00
ajnart	6db26a0d99	docs: restore release article hierarchy	2026-09-06 20:41:55 +02:00
ajnart	bbcbd031fe	docs: clarify Homarr provider terms	2026-09-06 20:37:52 +02:00
ajnart	7024a57f56	docs: tighten Homarr 2.0 release article	2026-09-06 19:57:44 +02:00
Thomas	5121356113	Merge pull request #6794 from homarr-labs/feat/refocus-homarr-v2-article docs: refocus Homarr 2.0 article	2026-09-06 19:20:05 +02:00
ajnart	4f2ab59345	docs: refocus Homarr 2.0 article	2026-09-06 19:19:23 +02:00
Thomas	73bf68c9a8	Merge pull request #6792 from homarr-labs/feat/v2-release-client-ids fix(ci): use GitHub App client IDs	2026-09-06 18:05:28 +02:00
ajnart	dea1de5fee	fix(ci): use GitHub App client IDs	2026-09-06 17:57:35 +02:00
Thomas	2bd538e685	Merge pull request #6791 from homarr-labs/feat/publish-homarr-v2-blog docs: publish Homarr 2.0 article	2026-09-06 17:52:05 +02:00
ajnart	f0c39ea0d2	docs: publish Homarr 2.0 article	2026-09-06 17:51:36 +02:00
Thomas	8a0cf15bf7	docs: finalize Homarr 2.0 release article (#6790 )	2026-09-06 17:48:08 +02:00
Thomas	f1c898efe2	docs: add Homarr 2.0 release article (#6789 )	2026-09-06 15:39:54 +02:00
Thomas	724dee55c5	fix(weather): handle disabled external connections (#6780 )	2026-09-06 15:35:06 +02:00
Thomas	50a3bcce69	fix(ci): restore release automation (#6770 ) * fix(ci): restore release automation * ci: remove obsolete documentation release dispatch * ci: report production deployment failures	2026-09-06 15:32:52 +02:00
Thomasandajnart	ca7be8f3ad	fix(integrations): support UniFi controller default ports (#6787 ) * fix(integrations): use Unifi default port 8443 when no port is given The node-unifi library hardcodes https:// in its base URL and the Unifi controller API only speaks HTTPS. When a user adds the integration with a bare http:// or https:// URL, getPortFromUrl returned 80 or 443, and the library attempted a TLS handshake on the wrong port. The server's plain HTTP response caused 'EPROTO ... wrong version number'. Derive the port from the user's explicit port, or fall back to 8443 (the integration's defaultPort). Closes #6207. * style: auto-fix lint and format * fix(integrations): support UniFi controller default ports * docs(unifi): resolve review leftovers --------- Co-authored-by: ajnart <ajnart@users.noreply.github.com>	2026-09-06 15:32:45 +02:00
Thomas Artur arturict	134ef48848	fix(integrations): preserve Nextcloud subpaths (#6786 ) * fix(integrations): preserve Nextcloud subpaths * Keep existing Nextcloud DAV endpoints intact --------- Co-authored-by: Artur <145776561+arturict@users.noreply.github.com> Co-authored-by: arturict <arturict@users.noreply.github.com>	2026-09-06 15:32:37 +02:00
Thomas Artur arturict	98aa6f01f2	feat(auth): support nested OIDC claim paths (#6785 ) * feat(auth): support nested OIDC claim paths * test(auth): cover OIDC profile name fallbacks * test(auth): cover missing OIDC username fallback * test(auth): preserve OIDC provider guard --------- Co-authored-by: Artur <145776561+arturict@users.noreply.github.com> Co-authored-by: arturict <arturict@users.noreply.github.com>	2026-09-06 15:32:31 +02:00
Thomas	4c88030b0f	fix(downloads): preserve name column width (#6784 )	2026-09-06 15:32:25 +02:00
Thomas	0c11c2785e	docs(helm): sync current chart metadata (#6783 )	2026-09-06 15:32:20 +02:00
Thomas	96a6926b2b	fix(docker): normalize container CPU usage (#6782 )	2026-09-06 15:32:15 +02:00
Thomas	f89487231f	fix(unraid): use byte-based memory metrics (#6781 )	2026-09-06 15:32:09 +02:00
Thomas	a62d11b5cd	fix(mcp): honor public OAuth origin (#6779 )	2026-09-06 15:31:57 +02:00
Thomas	28e242417d	fix(backup): prompt re-login after restore (#6778 )	2026-09-06 15:31:51 +02:00
Thomas	0ffa95c505	docs: make environment examples safe and current (#6777 ) * docs: make SQLite environment example runnable * docs: remove unsafe source secret examples * docs(auth): remove unsafe SSO environment values * docs(auth): clarify OIDC credential placeholders	2026-09-06 15:31:40 +02:00
Thomas	b708f687fa	docs: add v1 to v2 upgrade guide (#6774 ) * docs: add v1 to v2 upgrade guide * docs: simplify v2 backup guidance	2026-09-06 15:31:33 +02:00
Thomas	4fd9b04c61	fix(deps): patch high production advisories (#6788 )	2026-09-06 15:27:14 +02:00
Thomas	378332c8da	docs: update contribution checklist for v2 (#6773 )	2026-09-06 14:31:57 +02:00
Thomas	3d9b8e8ae6	fix(docs): generate valid integration links (#6772 )	2026-09-06 14:31:48 +02:00
Thomas	f7b194fc9f	fix(auth): patch critical Auth.js vulnerabilities (#6775 )	2026-09-06 14:25:09 +02:00
Thomas	eb20b97d5f	fix(deps): patch critical protobufjs vulnerability (#6776 )	2026-09-06 14:25:00 +02:00
Thomas	35155b18b9	feat: adopt Mantine 9.6 components (#6758 )	2026-09-03 18:21:51 +02:00
Thomas	b3aa6155cc	docs: streamline release v2 documentation (#6760 )	2026-09-03 17:03:10 +02:00
Bergasha	ac62e5bfd6	fix(system-resources): divide chart rows evenly via CSS, no board-zoom pixel math (#6756 ) Each visible chart row was hardcoded to a fixed pixel height (110px in advanced mode, 56px-capped in compact) regardless of the widget's actual tile size - resizing the tile taller left the extra height unused, and some visible charts required scrolling to reach. Divide the available height evenly across rows using CSS Grid's grid-auto-rows: 1fr (the Stack fills the tile via a definite pixel height, the SimpleGrid grows into it via flex and divides its rows evenly) rather than computing a per-chart pixel height in JS. Confirmed via live inspection of a deployed board that Mantine's h prop is not safe for this: its rem() converter strips a "px" suffix from any string before checking whether it's a parseable number, so even a literal pixel string passed through h= gets rescaled by rem() * var(--mantine-scale) exactly like a raw number would - style.height is the only way to set an exact, un-rescaled pixel value.	2026-09-01 16:50:00 +10:00
Thomas	f57a660088	feat: add global server custom CSS (#6753 ) * feat: add global server custom CSS * refactor: reuse CodeMirror for CSS editors	2026-08-31 14:26:58 +02:00