refactor: reuse CodeMirror for CSS editors

feat: add global server custom CSS
2026-08-31 14:01:43 +02:00 · 2026-08-31 13:47:37 +02:00
778 changed files with 24371 additions and 25374 deletions
@@ -32,23 +32,24 @@ Import only from an exported package entrypoint. Do not deep-import `@homarr/com

 ## Root exports

-| 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                                                      |
+| 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                                               |

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

@@ -1,6 +1,6 @@
 ---
 name: documentation-sync
-description: Keep Homarr's Fumadocs documentation aligned with user-facing code. Use when adding or changing integrations, widgets, APIs, environment variables, CLI commands, authentication, permissions, cron jobs, settings, or UI behavior that users must understand.
+description: Keep Homarr's Docusaurus documentation aligned with user-facing code. Use when adding or changing integrations, widgets, APIs, environment variables, CLI commands, authentication, permissions, cron jobs, settings, or UI behavior that users must understand.
 ---

 # Documentation Sync
@@ -48,4 +48,4 @@ For a widget:
 2. Keep names, defaults, paths, screenshots, links, and prerequisites consistent with code.
 3. Update every affected page and remove superseded guidance.
 4. Run the narrowest useful docs validation. Use `pnpm turbo build --filter=@homarr/docs` when links, MDX, generated definitions, or navigation can fail; otherwise run the docs package formatter on touched files.
-5. Treat broken links and anchors as failures; run `pnpm --filter @homarr/docs validate:links` after the static build.
+5. Treat broken links and anchors as failures; Docusaurus checks them strictly.
@@ -1,24 +1,22 @@
 # 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.

-# 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 not used anywhere but required for Auth.js (Would encrypt JWTs and Mail hashes, both not used)
+AUTH_SECRET="supersecret"

 # The below secret is used to encrypt integration secrets in the database.
-# Homarr will reject an empty or invalid value and print a randomly generated candidate.
-SECRET_ENCRYPTION_KEY=
+# 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

 LOG_LEVEL='info'

 # This is how you can use the sqlite driver:
 DB_DRIVER='better-sqlite3'
-# 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'
+DB_URL='FULL_PATH_TO_YOUR_SQLITE_DB_FILE'

 # Those are the two ways to use the mysql2 driver:
 # 1. Using the URL format:
@@ -65,8 +63,6 @@ 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 requirements:**
+**Thank you for your contribution. Please ensure that your pull request meets the following pull request:**

- [ ] Relevant checks pass without warnings or errors
- [ ] Pull request targets the intended base branch (`dev` by default; `release/v2` for v2 release work)
+- [ ] Builds without warnings or errors (`pnpm build`, autofix with `pnpm format:fix`)
+- [ ] Pull request targets `dev` branch
 - [ ] Commits follow the [conventional commits guideline](https://www.conventionalcommits.org/en/v1.0.0/)
- [ ] 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
+- [ ] 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

 **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: ${{ vars.RENOVATE_APPROVE_CLIENT_ID }}
+          client-id: ${{ secrets.RENOVATE_APPROVE_APP_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: ${{ vars.RENOVATE_APPROVE_CLIENT_ID }}
+          client-id: ${{ secrets.RENOVATE_APPROVE_APP_ID }}
          permission-pull-requests: write # required to approve a pull request and enable auto-merge

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

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

+      - name: Run unit tests
+        run: pnpm test
+
  container:
-    name: Container build
-    # Same-repository previews already build amd64; only build a fallback when no digest is available.
+    name: Container and E2E
    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') ||
@@ -114,9 +115,10 @@ jobs:
        (github.event_name == 'workflow_dispatch' && (inputs.operation == 'validate' || inputs.operation == 'publish'))
      )
    runs-on: ubuntu-latest
-    timeout-minutes: 20
+    timeout-minutes: 30
    permissions:
      contents: read
+      packages: read
    steps:
      - uses: actions/checkout@v7
        if: "!env.ACT"
@@ -124,10 +126,23 @@ jobs:
          persist-credentials: false
          ref: ${{ github.event_name == 'workflow_dispatch' && inputs.ref || '' }}

+      - name: Setup
+        uses: ./tooling/github/setup
+
      - name: Set up Docker Buildx
-        if: needs.preview-amd64.outputs.digest == '' && !env.ACT
+        if: "!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
@@ -137,7 +152,9 @@ jobs:
          platforms: linux/amd64
          load: true
          push: false
-          tags: homarr-ci
+          tags: |
+            homarr-ci
+            homarr-e2e
          labels: |
            org.opencontainers.image.source=${{ github.server_url }}/${{ github.repository }}
            org.opencontainers.image.revision=${{ github.sha }}
@@ -165,7 +182,37 @@ jobs:
            fi
          done
          DOCKER_BUILDKIT=1 docker build --platform linux/amd64 \
-            --tag homarr-ci "${secret_args[@]}" .
+            --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

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

  publish-preview:
    name: Publish multi-platform preview image
-    needs: [fast-gate, preview-amd64, preview-arm64]
+    needs: [container, preview-amd64, preview-arm64]
    if: |
      !cancelled() &&
-      needs.fast-gate.result == 'success' &&
+      needs.container.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: ${{ vars.CROWDIN_CLIENT_ID }}
+          client-id: ${{ secrets.CROWDIN_APP_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: ${{ vars.RENOVATE_APPROVE_CLIENT_ID }}
+          client-id: ${{ secrets.RENOVATE_APPROVE_APP_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: ${{ vars.RENOVATE_MERGE_CLIENT_ID }}
+          client-id: ${{ secrets.RENOVATE_MERGE_APP_ID }}
          permission-contents: write # write to beta branch (due to merge)
          permission-pull-requests: write # merge pull request
      - id: automerge
@@ -40,7 +40,6 @@ 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'
@@ -55,7 +54,7 @@ jobs:
        uses: actions/create-github-app-token@v3
        with:
          private-key: ${{ secrets.RENOVATE_MERGE_PRIVATE_KEY }}
-          client-id: ${{ vars.RENOVATE_MERGE_CLIENT_ID }}
+          client-id: ${{ secrets.RENOVATE_MERGE_APP_ID }}
          permission-contents: write # required to commit package.json & changelog changes, merge them to dev / next and publish the release

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

      - name: Log in to the Container registry
@@ -314,12 +311,6 @@ 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:
@@ -327,17 +318,3 @@ 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 }})"
@@ -37,16 +37,12 @@ jobs:
        run: pnpm turbo build --filter=@homarr/docs
        env:
          CI: "true"
-      - name: Validate exported links and search
-        run: |
-          pnpm --filter @homarr/docs validate:links
-          pnpm --filter @homarr/docs verify:search
      - name: Setup Pages
        uses: actions/configure-pages@v6
      - name: Upload pages artifact
        uses: actions/upload-pages-artifact@v5
        with:
-          path: "apps/docs/out"
+          path: "apps/docs/build"

  deploy:
    runs-on: ubuntu-latest
@@ -19,10 +19,10 @@ permissions:
 jobs:
  create-and-merge-pr:
    runs-on: ubuntu-latest
-    timeout-minutes: 10
+    timeout-minutes: 2
    steps:
      - name: Discord notification
-        if: ${{ github.event_name == 'schedule' || inputs.send-notifications }}
+        if: ${{ github.event.inputs.send-notifications }}
        env:
          DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
        uses: Ilshidur/action-discord@0.4.0
@@ -38,30 +38,13 @@ 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
-        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"
+        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'
        env:
          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
      - name: Discord notification
-        if: ${{ steps.create-pull-request.outcome == 'success' && (github.event_name == 'schedule' || inputs.send-notifications) }}
+        if: ${{ github.event.inputs.send-notifications }}
        env:
          DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
        uses: Ilshidur/action-discord@0.4.0
@@ -69,29 +52,26 @@ 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: ${{ vars.RENOVATE_APPROVE_CLIENT_ID }}
+          client-id: ${{ secrets.RENOVATE_APPROVE_APP_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 "${{ steps.create-pull-request.outputs.url }}" --approve --body "Automatically approved by GitHub Action"
+          gh pr review --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: ${{ vars.RENOVATE_MERGE_CLIENT_ID }}
+          client-id: ${{ secrets.RENOVATE_MERGE_APP_ID }}
          permission-contents: write # write to main branch (due to merge)
          permission-pull-requests: write # merge pull request
      - id: automerge
-        if: ${{ steps.create-pull-request.outcome == 'success' && steps.semver.outputs.bump != 'major' }}
+        if: ${{ steps.semver.outputs.bump != 'major' }}
        name: automerge
        uses: "pascalgn/automerge-action@v0.16.4"
        env:
@@ -105,21 +85,21 @@ jobs:
          MERGE_REQUIRED_APPROVALS: 0 # do not require approvals

      - name: Merged Discord notification
-        if: ${{ steps.automerge.outputs.mergeResult == 'merged' && (github.event_name == 'schedule' || inputs.send-notifications) }}
+        if: ${{ steps.automerge.outputs.mergeResult == 'merged' && github.event.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_name == 'schedule' || inputs.send-notifications) }}
+        if: ${{ steps.semver.outputs.bump == 'major' && github.event.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_name == 'schedule' || inputs.send-notifications) }}
+        if: failure() && github.event.inputs.send-notifications
        env:
          DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
        uses: Ilshidur/action-discord@0.4.0
@@ -0,0 +1,58 @@
+name: "[Docs] Algolia Recrawl"
+
+on:
+  workflow_run:
+    workflows: ["[Deployment] Documentation"]
+    types: [completed]
+    branches: [dev]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  recrawl:
+    if: >-
+      ${{
+        (github.event.workflow_run.conclusion == 'success' && github.event.workflow_run.event != 'pull_request')
+        || github.event_name == 'workflow_dispatch'
+      }}
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v7
+
+      - name: Setup
+        uses: ./tooling/github/setup
+
+      - name: Check Algolia crawler secrets
+        run: |
+          missing=0
+          for secret in ALGOLIA_CRAWLER_ID ALGOLIA_CRAWLER_USER_ID ALGOLIA_CRAWLER_API_KEY; do
+            if [ -z "${!secret}" ]; then
+              echo "::warning::Missing repository secret: $secret"
+              missing=1
+            fi
+          done
+          if [ "$missing" -eq 1 ]; then
+            echo "Add crawler secrets to enable automatic recrawls."
+            exit 1
+          fi
+        env:
+          ALGOLIA_CRAWLER_ID: ${{ secrets.ALGOLIA_CRAWLER_ID }}
+          ALGOLIA_CRAWLER_USER_ID: ${{ secrets.ALGOLIA_CRAWLER_USER_ID }}
+          ALGOLIA_CRAWLER_API_KEY: ${{ secrets.ALGOLIA_CRAWLER_API_KEY }}
+
+      - name: Wait for GitHub Pages to serve the new deployment
+        run: sleep 60
+
+      - name: Trigger Algolia DocSearch recrawl
+        uses: cssnr/algolia-crawler-action@v2
+        with:
+          crawler_id: ${{ secrets.ALGOLIA_CRAWLER_ID }}
+          crawler_user_id: ${{ secrets.ALGOLIA_CRAWLER_USER_ID }}
+          crawler_api_key: ${{ secrets.ALGOLIA_CRAWLER_API_KEY }}
+
+      - name: Verify search index
+        working-directory: apps/docs
+        run: pnpm verify:search
@@ -33,7 +33,7 @@ jobs:
      - name: Commit updated contributors
        uses: EndBug/add-and-commit@v10
        with:
-          add: "apps/docs/public"
+          add: "apps/docs/static"
          default_author: github_actor
          message: "chore(docs): update contributors"
          push: true
@@ -26,13 +26,41 @@ jobs:
      - name: Copy env
        run: cp .env.example .env

-      - name: Generate and validate OpenAPI spec
-        run: pnpm scripts:update-openapi
+      - 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: Commit updated spec
        uses: EndBug/add-and-commit@v10
        with:
-          add: "apps/docs/public/api/"
+          add: "apps/docs/static/api/"
          default_author: github_actor
          message: "chore(docs): update OpenAPI spec"
          push: true
@@ -5,6 +5,39 @@ 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
@@ -15,7 +48,7 @@ jobs:
        uses: actions/create-github-app-token@v3
        with:
          private-key: ${{ secrets.RENOVATE_MERGE_PRIVATE_KEY }}
-          client-id: ${{ vars.RENOVATE_MERGE_CLIENT_ID }}
+          client-id: ${{ secrets.RENOVATE_MERGE_APP_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_CLIENT_ID }}
+          client-id: ${{ vars.HOMARR_UPDATE_CONTRIBUTORS_APP_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_CLIENT_ID }}
+          client-id: ${{ vars.HOMARR_UPDATE_CONTRIBUTORS_APP_ID }}
          permission-contents: write # required to commit to branch
          permission-pull-requests: write # required to create pr & enable automerge
      - name: Checkout code
@@ -2,36 +2,8 @@ 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
@@ -43,10 +15,21 @@ concurrency:
 jobs:
  validate:
    runs-on: ubuntu-24.04
-    timeout-minutes: 5
+    timeout-minutes: 30
    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.6.0"]
+      "args": ["-y", "@mantine/mcp-server@9.5.2"]
    }
  }
 }
@@ -10,12 +10,7 @@
    "CHANGELOG.md",
    "apps/docs/.docusaurus/**",
    "apps/docs/build/**",
-    "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",
+    "apps/docs/blog/**",
    "packages/custom-widgets/src/core/component-catalog.generated.json",
    "apps/docs/static/custom-widgets/component-catalog-v1.json"
  ]
@@ -6,7 +6,7 @@
 homarr/
 ├── apps/
 │   ├── nextjs/          # Main Next.js application (port 3000)
-│   ├── docs/            # Next.js + Fumadocs documentation site (@homarr/docs)
+│   ├── docs/            # Docusaurus 3 documentation site (@homarr/docs)
 │   ├── tasks/           # Cron-job initialization and scheduling runtime
 │   ├── websocket/       # Standalone tRPC WebSocket server (port 3001)
 │   └── workshop/        # Go/PocketBase Workshop service
@@ -57,7 +57,7 @@ homarr/

 ## Documentation Sync

-The documentation site lives at `apps/docs/` (Next.js + Fumadocs, `@homarr/docs`).
+The documentation site lives at `apps/docs/` (Docusaurus 3, `@homarr/docs`).

 When modifying user-facing code, you MUST also update the corresponding documentation:

@@ -75,7 +75,7 @@ When modifying user-facing code, you MUST also update the corresponding document
 - `pnpm dev:cli -- dev` — run the developer CLI without installing a global binary
 - `pnpm db:seed` — seed default database data explicitly
 - `pnpm docker:dev:up` — start the Redis development service in the background
- `pnpm dev:docs` — Fumadocs site only
+- `pnpm dev:docs` — Docusaurus docs site only
 - `pnpm turbo build` — build all packages
 - `pnpm turbo build --filter=@homarr/docs` — build docs only
 - `pnpm turbo typecheck` — typecheck all packages
@@ -13,7 +13,6 @@
 # next.js
 /.next/
 /out/
-/.source/

 # production
 /build
@@ -56,4 +55,4 @@ static/data/configs

 # CI Stuff
 screenshots
-test-results
+test-results
@@ -1,18 +0,0 @@
-<!-- BEGIN:nextjs-agent-rules -->
-
-# This is NOT the Next.js you know
-
-This version has breaking changes — APIs, conventions, and file structure may all differ from your training data. Read the relevant guide in `node_modules/next/dist/docs/` (resolved from this file's directory; in monorepos the `next` package may not be visible from the repo root) before writing any code. Heed deprecation notices.
-
-This block is written and re-added by `next dev` — verify at `node_modules/next/dist/server/lib/generate-agent-files.js`. Removing it from a diff only re-creates the uncommitted change; committing it with your work keeps the tree clean.
-
-<!-- END:nextjs-agent-rules -->
-
-## Fumadocs workflow
-
- Start with `README.md`, `src/lib/source.ts`, `source.config.ts`, and the matching route under `src/app/`.
- Read current [Fumadocs documentation](https://fumadocs.dev/docs) with Context7 before changing framework APIs. Check the installed version and types; latest examples may use a different search adapter.
- Preserve static export: search uses `staticGET` with the matching static client. Do not introduce a request-time search server into this app.
- Keep integration/widget metadata in the existing typed definitions. Check both rendered HTML and processed Markdown when changing MDX components; JSX alone does not guarantee readable search or AI output.
- Run the README validation commands after content or navigation changes. Search results and table-of-contents links must resolve to rendered anchors.
- Kapa is an independent hosted assistant. Keep its keyboard shortcut disabled so it does not override docs search; follow the README for its build configuration and crawler setup.
@@ -1 +0,0 @@
-@AGENTS.md
@@ -1,37 +0,0 @@
-# Homarr Documentation
-
-## Register
-
-product
-
-## Users
-
-People who run Homarr, administrators configuring self-hosted infrastructure, and contributors extending Homarr. They arrive with a concrete task such as installing Homarr, connecting a service, configuring a widget, managing users, or building a custom widget, and need an answer they can scan and apply quickly.
-
-## Product Purpose
-
-The documentation is the complete, authoritative operating guide for Homarr. It keeps setup steps, configuration contracts, screenshots, generated integration and widget metadata, API references, and Workshop tooling next to the application code. Success means a reader can find the right page quickly, understand the next action, copy reliable instructions, and verify the result without searching elsewhere.
-
-## Brand Personality
-
-Focused, dependable, and approachable. The writing is direct and practical. The interface should feel calm and familiar during long technical sessions while retaining Homarr's red identity.
-
-## Anti-references
-
- Generic marketing layouts that replace Homarr's product identity with unrelated slogans or decorative conversion copy.
- Decorative dashboard aesthetics that compete with reading, including glass effects, large radii, card grids, and gratuitous motion.
- Generic generated-docs styling that obscures Homarr's identity or makes navigation feel detached from the main product.
- Dense reference portals that expose structure without giving readers a clear path through a task.
-
-## Design Principles
-
-1. Put the reader's task first: search, navigation, page outline, and the answer must remain easy to reach.
-2. Preserve one source of truth: typed Homarr metadata and existing custom components stay connected to the monorepo.
-3. Prefer familiar documentation patterns: the interface should disappear while a reader scans, copies, and follows instructions.
-4. Make complete content feel manageable through strong hierarchy, progressive disclosure, and precise cross-links.
-5. Treat machine readers as users through canonical Markdown, structured metadata, and standard LLM discovery endpoints.
-6. Keep the root landing page recognizably Homarr: preserve its self-hosted dashboard promise and real product evidence while documentation routes remain task-first.
-
-## Accessibility & Inclusion
-
-Meet WCAG 2.2 AA for color contrast, keyboard operation, focus visibility, landmarks, headings, and interactive controls. Respect reduced-motion and system color-scheme preferences. Diagrams, screenshots, icons, and emoji must have meaningful text alternatives when they carry information.
@@ -1,84 +1,112 @@
-# Homarr documentation (`@homarr/docs`)
+# Homarr Documentation (`@homarr/docs`)

-The source for [homarr.dev](https://homarr.dev), built with Next.js and Fumadocs UI inside the Homarr monorepo.
+The official [homarr.dev](https://homarr.dev) documentation site, built with [Docusaurus 3](https://docusaurus.io/) and living inside the Homarr monorepo.

-## Develop
+## Why it's in the monorepo

-From the repository root:
+Having documentation alongside the application code enables:
+
+- **Two-way linking** — the docs app imports from `@homarr/definitions` for type-safe integration/widget metadata, and the main app references doc paths via generated sitemap types
+- **Atomic PRs** — code changes and their documentation updates ship in the same pull request
+- **Shared tooling** — same Node version, pnpm catalog, oxlint/oxfmt, CI pipeline
+- **Build-time validation** — Docusaurus strict mode catches broken links and references at build time
+
+## Development
+
+From the **monorepo root**:

 ```bash
+# Start the docs dev server (port 3003)
 pnpm dev:docs
-```

-The site runs on `http://127.0.0.1:3003`. To use a local Workshop API:
+# Or from within this directory
+pnpm dev

-```bash
+# Point the docs at a local PocketBase instance
 WORKSHOP_API_URL=http://127.0.0.1:8090 pnpm dev:docs
 ```

-## Validate
+The standalone docs use `WORKSHOP_API_URL` for PocketBase and `HOMARR_WEBSITE_URL` for the public site origin. The old
+`WORKSHOP_URL` name is a deprecated one-release alias.
+
+## Build

 ```bash
-pnpm --filter @homarr/docs typecheck
-pnpm --filter @homarr/docs build
-pnpm --filter @homarr/docs validate:links
-pnpm --filter @homarr/docs verify:search
+# Build docs only
+pnpm turbo build --filter=@homarr/docs
+
+# Build everything (docs + main app + tasks + websocket)
+pnpm build
 ```

-The static export is written to `out/`. The build validates that every registered integration and widget has a docs
-page. The link check validates internal Markdown and MDX links and rendered anchors against that export.
-The search check exercises the exported index with title, heading, and body queries and verifies result destinations.
+## Lint & Format

-## Write content
+Uses oxlint and oxfmt (same as the rest of the monorepo):

-Documentation lives in `docs/`; project posts live in `blog/`. Navigation is controlled by the nearest `meta.json`.
-Integration and widget folders pair typed `index.ts` metadata with `index.mdx` content.
+```bash
+pnpm lint        # oxlint
+pnpm format      # oxfmt (check)
+pnpm format:fix    # oxfmt (fix)
+```

-Use standard Markdown and MDX. Shared components live in `src/components/`. Mermaid fences, tabs, callouts, zoomable
-images, and syntax-highlighted code are supported by the Fumadocs pipeline.
+## Typecheck

-When a user-facing change affects setup or behavior, update the matching page in the same pull request. See the
-[documentation-sync skill](../../.agents/skills/documentation-sync/SKILL.md) for the code-to-content map.
+```bash
+pnpm typecheck
+```

-## Published formats
+## Content Structure

- `/docs` — searchable documentation with typed navigation
- `/api-reference` — interactive reference generated from the OpenAPI schema
- `/llms.txt` — compact documentation and blog index for agents
- `/llms-full.txt` — complete processed Markdown corpus
- `/llms.mdx/docs/.../content.md` — raw Markdown for each docs page
- `/llms.mdx/blog/.../content.md` — raw Markdown for each blog post
- `/blog/rss.xml` — RSS feed for project posts
+```
+docs/
+├── getting-started/    # Installation guides, glossary, prerequisites
+├── management/         # Boards, apps, users, integrations, settings, tasks, API
+├── integrations/       # 56 integration guides (one folder each)
+├── widgets/            # 43 widget guides (one folder each)
+├── advanced/           # SSO, env vars, proxy, styling, CLI, development
+└── community/          # FAQ, donate, license, translations, get-in-touch
+```

-Every docs page and blog post includes copy-Markdown and view-source actions. Search is generated at build time and
-runs locally in the browser; it does not depend on an external crawler. Markdown exports and search resolve
-integration credentials and widget defaults from the same typed metadata used by the pages.
-The getting-started overview and complete Custom JSX component catalog are also included, with property types,
-binding contracts, and blocked capabilities taken from the published catalog JSON.
+Each integration/widget doc follows a consistent pattern:

-Published Docusaurus `/docs/category/...` addresses remain available as static compatibility pages. They forward to
-the corresponding overview or developer setup guide, preserving query strings and anchors, and provide a direct
-link when JavaScript is disabled. Their canonical metadata points to the destination; compatibility pages are
-excluded from search and the sitemap.
+- `index.ts` — typed metadata (`IntegrationDefinition` / `WidgetDefinition`)
+- `index.mdx` — content using shared React components (`IntegrationHeader`, `WidgetHeader`, etc.)

-## Kapa AI
+## Importing from homarr packages

-The **Ask AI** launcher uses Homarr's existing public Kapa Website ID. The root layout loads the widget once across
-client-side navigation. **Search** and `Ctrl+K` / `Cmd+K` always use Fumadocs search, including when Kapa is unavailable.
+The docs app has `@homarr/definitions` as a workspace dependency. You can import integration kinds, widget kinds, and other definitions directly:

-Set `KAPA_WEBSITE_ID` at build time to use a different Kapa Website Widget integration. An explicitly empty value
-disables the widget, for example `KAPA_WEBSITE_ID= pnpm --filter @homarr/docs build`. This is a public integration ID
-included in exported pages, not a Kapa API key. Rebuild the static export after changing it.
+```typescript
+import { IntegrationKind } from "@homarr/definitions";
+```

-In the Kapa dashboard, confirm the integration is live and enable the production and preview domains. Restoring the
-script does not verify that the historical integration is still active. Follow the
-[Kapa widget setup](https://docs.kapa.ai/integrations/website-widget/quickstart) for domain restrictions and CSP settings.
+This enables type-safe references to homarr domain concepts within documentation code.

-After changing the documentation structure, review the Website Crawl source in Kapa: use the deployed `/docs` URL as
-the start URL and preview `main` as the content selector. Replace any old Docusaurus-specific selector and check that
-titles, headings, code samples, and integration details appear in the extracted Markdown. Docs are exported as HTML;
-the site also publishes `/sitemap.xml` and permits crawling in `/robots.txt`. The `/llms.txt` exports do not configure
-Kapa ingestion automatically. See [Kapa source setup](https://docs.kapa.ai/getting-started/index-your-first-source).
+## Search (Algolia DocSearch)

-Before publishing, check that Ask AI opens after navigating between pages, ask a documentation question, and verify
-its citations point to the current docs. In a separate check, block `widget.kapa.ai` and confirm search still works.
+Search uses the `Docusaurus` Algolia index (crawler `cd77a285-2756-4557-bf21-ee703748df15`). A separate `markdown` index is built for LLM markdown indexing.
+
+Crawler reference config: [`docsearch.config.js`](docsearch.config.js).
+
+**Verify search health:**
+
+```bash
+pnpm verify:search
+```
+
+## Tech Stack
+
+| Layer          | Technology                                  |
+| -------------- | ------------------------------------------- |
+| Site generator | Docusaurus 3 (`@docusaurus/preset-classic`) |
+| Styling        | Tailwind CSS 4 + Docusaurus Infima          |
+| Icons          | `@tabler/icons-react`                       |
+| Diagrams       | Mermaid (`@docusaurus/theme-mermaid`)       |
+| Search         | Algolia DocSearch                           |
+| Analytics      | PostHog                                     |
+| Charts         | @nivo/line                                  |
+
+## Contributing
+
+When a Homarr change affects user-facing behavior, update the corresponding documentation in this app. See the
+[documentation-sync skill](../../.agents/skills/documentation-sync/SKILL.md) for the code-to-documentation mapping.
@@ -1,7 +1,6 @@
 ---
 slug: documentation-migration
 title: Migration of Documentation
-date: 2022-06-22
 authors:
  - ajnart
  - manuel-rw
@@ -13,7 +12,7 @@ The documentation has been re-written partly and includes now many animations, g

 We are still figuring things out and highly depend on your feedback.

-{/* Historical excerpt boundary. */}
+<!-- truncate -->

 ## Why we migrated

@@ -33,4 +32,4 @@ After we've reviewed your changes, we'll merge your PR and this documentation wi

 ## TL;DR

-The documentation on GitHub Wiki will soon disappear. It will be replaced with this Docusaurus-powered website. You'll find much more information here with higher detail and searchability.
+The documentation on GitHub Wiki will soon disappear. It will be replaced with this Docusaurus-powered website. You'll find much more information here with higher detail and searchability.
@@ -1,7 +1,6 @@
 ---
 slug: translations
 title: Help us make Homarr multilingual
-date: 2022-08-28
 authors:
  - ajnart
  - manuel-rw
@@ -14,8 +13,8 @@ We've been working hard to offer Homarr in many languages. The next update of Ho
 ![](img/homarr-we-need-you.webp) <br/>
 Yes, we need **YOU**! We want to make Homarr accessible to as many people as possible. Thus, we need to translate all content into many different languages. We need your help for that! [You can help us now to translate Homarr into as many languages as possible](/docs/community/translations).

-{/* Historical excerpt boundary. */}
+<!-- truncate -->

 ### About global translations / translations per user

-We are aware that many people would like to configure translations globally or configure language per user. Currently, translations are stored in the Cookies, which will expire after some time (currently, it's set to 30 days). We will implement more granular language settings in future versions of Homarr, since it requires major changes to Homarr. Stay tuned! 😎
+We are aware that many people would like to configure translations globally or configure language per user. Currently, translations are stored in the Cookies, which will expire after some time (currently, it's set to 30 days). We will implement more granular language settings in future versions of Homarr, since it requires major changes to Homarr. Stay tuned! 😎
@@ -1,6 +1,5 @@
 ---
 title: "We present: Homarr 0.11 - the most complex Homarr version yet!"
-date: 2023-01-11
 authors:
  - ajnart
  - manuel-rw
@@ -21,7 +20,7 @@ It contains many breaking changes and huge improvements to your favourite dashbo
 - Huge design and usability improvements to older components to Homarr
 - Better handeling of exceptions and unexpected issues

-{/* Historical excerpt boundary. */}
+<!-- truncate -->

 ## Complete implementation of highly customizable drag and drop library "Gridstack"

@@ -1,6 +1,5 @@
 ---
 title: "We present: Homarr 0.12 - The fastest homarr version ever!"
-date: 2023-04-16
 authors:
  - ajnart
  - manuel-rw
@@ -16,12 +15,14 @@ This applies to all widgets, but in the case of the IFrame widget, it enables yo
 - Integrate monitoring tools like Grafana, Splunk or Elasticsearch
 - Integrate your services (for example Sonarr, Radarr and Overseerr) directly into Homarr

+![](https://media.discordapp.net/attachments/988335098493542410/1094665745226539168/update-teaser.png?width=1046&height=666)
+
 ## Edit mode password
 We've added a setting to disable editing completely. This will allow you to restrict edit access without password-protection.
 use the `EDIT_MODE_PASSWORD` ENV variable to set a password for edit mode. 
 turn on `DISABLE_EDIT_MODE=TRUE` to disable edit mode on startup.

-{/* Historical excerpt boundary. */}
+<!-- truncate -->

 ## 😎 Blazingly fast
 We've implemented a new caching system, that will cache all data in your browser, meaning that Homarr will load within milliseconds, as if it was *powered by rust and blazingly fast* !!!
@@ -71,4 +72,4 @@ Now, you can use the following environment variables to configure this:
 - ``DOCKER_HOST``
 - ``DOCKER_PORT``

-**Full Changelog**: https://github.com/ajnart/homarr/compare/v0.11.5...v0.12.0
+**Full Changelog**: https://github.com/ajnart/homarr/compare/v0.11.5...v0.12.0
@@ -1,6 +1,5 @@
 ---
 title: "Authentication in Homarr - 0.14 is here!"
-date: 2023-11-10
 authors:
  - ajnart
  - manuel-rw
@@ -24,7 +23,7 @@ provide you a viable solution today.
 - 📝 Overhauled notepad widget with a complex graphical editor that enables easy editing right from your browser.
 - :globe_with_meridians:  Live Translation on Crowdin that enable you to directly translate using images to see what exactly you're translating

-{/* Historical excerpt boundary. */}
+<!-- truncate -->

 ## Breaking changes

@@ -84,4 +83,4 @@ We are aware that this update has many breaking changes and may confuse some use
 For that reason, we updated our documentation and will enhance it further within the next few weeks.
 We've also added this small button at the bottom of the page were you can ask **your questions** to an AI assistant:

-![image](https://github.com/ajnart/homarr/assets/30572287/a56f721a-d022-42ad-813a-d85c89462a8c)
+![image](https://github.com/ajnart/homarr/assets/30572287/a56f721a-d022-42ad-813a-d85c89462a8c)
@@ -1,6 +1,5 @@
 ---
 title: "Updated documentation with better organization & design"
-date: 2023-12-22
 authors:
  - manuel-rw
 tags: [homarr, documentation, design, docs]
@@ -9,7 +8,7 @@ tags: [homarr, documentation, design, docs]
 We'd like to let you know that we've updated our documentation and reorganized the pages.
 This means, that some links may no longer be valid - we apologise if this causes any inconvenience for you.

-{/* Historical excerpt boundary. */}
+<!-- truncate -->

 A few highlights include:

@@ -19,4 +18,4 @@ A few highlights include:
 - Bug fixes for image zoom
 - Added documentation for management pages and [new CLI tool](/docs/advanced/command-line/password-recovery/)

-Please [let us know](/docs/community/get-in-touch) is something is not working as expected.
+Please [let us know](/docs/community/get-in-touch) is something is not working as expected.
@@ -1,10 +1,9 @@
 ---
-title: Homarr 1.0 - complete rewrite of all systems
-date: 2024-09-23
 authors:
  - manuel-rw
 ---

+# Homarr 1.0 - complete rewrite of all systems
 We proudly present to you - Homarr ``1.0``.
 We have started work on this new version back in 2023 and have worked tirelessly for months on this brand-new dashboard.

@@ -29,7 +28,7 @@ reliability and scalability compared to < ``1.0``.
 - **Improved performance**: We have upgraded the underlying framework of Homarr and take advantage
 of an in-memory message bus and websockets to deliver data near realtime to you.

-{/* Historical excerpt boundary. */}
+<!-- truncate -->

 ## Breaking changes
 :::warning
@@ -1,16 +1,16 @@
 ---
-title: Open Beta 1.0
-date: 2024-12-17
 authors:
  - meierschlumpf
 ---

+# Open Beta 1.0
+
 We are proud to announce the open beta of Homarr 1.0. This is a major milestone for us and we are excited to share it with you.
 The open beta allows us to polish the last rough edges and gather feedback from you.
 We are looking forward to your feedback and hope you enjoy the new features.
 Let us know throgh discord or a [github issues](https://github.com/homarr-labs/homarr/issues/new/choose) if you encounter any issues.

-{/* Historical excerpt boundary. */}
+<!-- truncate -->

 ## How to use the beta with docker

@@ -36,4 +36,4 @@ services:

 Then, run `docker compose up -d` in the same directory. This will start the Homarr container in the background.
 Please note that the mounts have changed and it's not backwards compatible with versions before 1.0.0-beta.1.
-You can find a list of all breaking changes [here](/blog/2024/09/23/version-1.0)
+You can find a list of all breaking changes [here](/blog/2024/09/23/version-1.0)
@@ -1,14 +1,14 @@
 ---
-title: Migrate from 0.15.10+ to 1.0.0
-date: 2025-01-19
 authors:
  - meierschlumpf
 ---

+# Migrate from 0.15.10+ to 1.0.0
+
 In this guide, we will show you how to migrate from Homarr 0.15.10+ to 1.0.0.
 If you are still on a version before 0.15.10, please update to 0.15.10 where we introduced the migration export page.

-{/* Historical excerpt boundary. */}
+<!-- truncate -->

 ## Preserve your old installation

@@ -22,7 +22,7 @@ Plan to recreate your apps, integrations, and boards manually in the new install

 We highly recommend to create a parallel installation of Homarr 1.0.0.
 So if something with for example the import does not quite work, the data in the old installation is still available.
-To do this you can follow the appropriate [installation guide](/docs/getting-started) for your system.
+To do this you can follow the appropriate [installation guide](https://homarr.dev/docs/category/installation-1) for your system.
 Please note that if you are using docker you need to specify a diffrent external port for the new installation as the old one had the same port.
 So in your compose file the ports would be `7576:7575` instead of `7575:7575`.

@@ -1,14 +1,14 @@
 ---
-title: How to use Argus with Homarr
-date: 2025-08-02
 authors:
  - meierschlumpf
 ---

+# How to use Argus with Homarr
+
 In `v1.32.0` we added the endpoint `/api/info` which returns the current version of Homarr and can therefore be used in Argus to watch for updates.
 This guide will show you how to set up a user with apiKey to access the endpoint without providing admin access through it.

-{/* Historical excerpt boundary. */}
+<!-- truncate -->

 ![Argus](./img/argus.png)

@@ -64,4 +64,4 @@ Now you can configure Argus to use the user and apiKey we created.

 ![Argus configuration](./img/argus-configuration.png)

-Replace the `<secret>` with the apiKey you created and the deployed version url with the url of your Homarr instance.
+Replace the `<secret>` with the apiKey you created and the deployed version url with the url of your Homarr instance.
@@ -1,169 +0,0 @@
---
-title: Homarr 2.0.0 - Workshop, Custom Widgets and a rebuilt board
-date: 2026-09-03
-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)
-
-{/* Historical excerpt boundary. */}
-
-:::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).
@@ -5,7 +5,7 @@
  "tsx": true,
  "tailwind": {
    "config": "",
-    "css": "src/app/global.css",
+    "css": "src/css/custom.css",
    "baseColor": "mist",
    "cssVariables": true,
    "prefix": ""
@@ -0,0 +1,9 @@
+{
+  "label": "Advanced",
+  "collapsed": true,
+  "position": 5,
+  "link": {
+    "type": "generated-index",
+    "title": "Advanced Concepts or features"
+  }
+}
@@ -0,0 +1,4 @@
+{
+  "collapsed": true,
+  "label": "Command line interface"
+}
@@ -148,18 +148,13 @@ homarr images rm feature
 # List data volumes with owner PR/tag and in-use status
 homarr data

-# Preview deleting a data volume and its owning container
+# Delete data volume (safely stops and removes owning container first)
 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.

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

-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.
+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.

-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.
+:::caution

-## Run the recovery CLI
+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.

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

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

-### QNAP Container Station
+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).

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

-![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.
+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)

 ## Build a local branch harness

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

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

-This creates `homarr:feature-board`, starts it with persistent demo data, and prints the assigned URL. Query the port
-again with:
+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.

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

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

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

-Related commands are `harness build <name>`, `harness run <name>`, and `harness stop <name>`.
+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`.
@@ -1,4 +0,0 @@
-{
-  "title": "Command line interface",
-  "pages": ["index", "users", "integrations", "password-recovery", "fix-usernames", "development"]
-}
@@ -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.

-![Reset-password command help showing that username is required](./img/screenshot-cli.png)
+![](./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.

-![Terminal output confirming a password reset and session deletion](./img/screenshot-cli-result.png)
+![](./img/screenshot-cli-result.png)
@@ -0,0 +1,8 @@
+{
+  "label": "Developer guides",
+  "position": 6,
+  "collapsed": true,
+  "link": {
+    "type": "generated-index"
+  }
+}
@@ -57,8 +57,8 @@ Homarr becomes the instance administrator.
 Use `pnpm docker:dev:up` instead when you only need Redis in the background. Running the migration also seeds the
 default data; use `pnpm db:seed` to seed it explicitly later.

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

 ### Useful commands

@@ -69,7 +69,7 @@ Workshop contributors can set up PocketBase and Fumadocs with the dedicated
 - `pnpm dev:cli -- build --pr <number>` — build a pull request from a temporary checkout.
 - `pnpm dev:cli -- rebuild <name>` — rebuild an image from its recorded checkout or pull request.
 - `pnpm dev:cli:install` — optionally install the developer CLI as a `homarr` binary.
- `pnpm dev:docs` — Fumadocs on port 3003.
+- `pnpm dev:docs` — Docusaurus only on port 3003.
 - `pnpm docker:dev:up` — Redis development service in the background.
 - `pnpm cli` — Homarr operations CLI.
 - `pnpm db:migration:sqlite:run` — create or update a SQLite database.
@@ -82,43 +82,3 @@ Workshop contributors can set up PocketBase and Fumadocs 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.
-
-## Documentation development
-
-Run `pnpm dev:docs` to open the Next.js and Fumadocs site at `http://127.0.0.1:3003`. Content lives in
-`apps/docs/docs/`; the nearest `meta.json` controls navigation. Keep integration and widget setup metadata in their
-typed `index.ts` files alongside the page.
-
-After changing content, navigation, or shared MDX components, run:
-
-```sh
-pnpm --filter @homarr/docs build
-pnpm --filter @homarr/docs validate:links
-pnpm --filter @homarr/docs verify:search
-```
-
-The build writes a static site to `apps/docs/out/`. Check heading links, search results, and the page's Markdown export
-when changing shared components. The [Fumadocs documentation](https://fumadocs.dev/docs) describes supported components
-and source APIs; match examples to the versions installed in this repository.
@@ -1,4 +0,0 @@
-{
-  "title": "Developer guides",
-  "pages": ["getting-started", "widgets-and-integrations", "kubernetes", "workshop", "workshop-operator"]
-}
@@ -1,82 +0,0 @@
---
-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.
-
-## Documentation search and AI
-
-The documentation uses Fumadocs search with an index generated during the website build. Search runs in the browser
-and needs no hosted search credentials or crawler.
-
-The **Ask AI** launcher connects to Kapa separately. `KAPA_WEBSITE_ID` is a public website integration ID, read when
-building the documentation. The default uses Homarr's integration. For a private deployment, pass your own ID or
-an empty value to disable it: `docker build --build-arg KAPA_WEBSITE_ID= -f apps/workshop/Dockerfile .`.
-Changing this value requires rebuilding the image; setting it on an already-built container has no effect.
-
-For your own Kapa integration, enable the deployment domain in Kapa and configure a Website Crawl source for your
-published docs. Preview the `main` content selector and verify extracted headings, code, and integration details.
-After a migration, refresh the source and check answer citations. `/llms.txt` alone does not configure Kapa ingestion.
-See the [Kapa website widget guide](https://docs.kapa.ai/integrations/website-widget/quickstart).
-
-## 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.
@@ -1,41 +0,0 @@
---
-title: Workshop development
-sidebar_position: 4
-tags:
-  - Workshop
-  - Developer
-  - Fumadocs
-  - PocketBase
---
-
-# Workshop development
-
-See the [main development guide](/docs/advanced/development/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 Fumadocs 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,8 +30,7 @@ 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`                        |
-| `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`                       |
+| `NO_EXTERNAL_CONNECTION` | Disables Homarr's internet-backed requests, including update checks, weather, 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`          |
@@ -39,7 +38,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](/docs/advanced/development/workshop-operator#environment-variables).
+[Workshop operator guide](../../workshop/operator#environment-variables).

 ### Workshop service

@@ -139,4 +138,4 @@ The advanced deployments environment variables should only be used if you know w
 | `DB_MIGRATIONS_DISABLED` | Disable db migrations. For example for helm charts. |

 All public URL variables reject non-HTTP protocols, embedded credentials, query strings, and fragments, and normalize
-trailing slashes when Homarr or the documentation site starts.
+trailing slashes when Homarr or Docusaurus starts.
@@ -1,60 +0,0 @@
---
-title: Advanced configuration
-description: Configure deployment, authentication, networking, styling, automation, and development workflows.
---
-
-import {
-  IconCode,
-  IconIcons,
-  IconKey,
-  IconKeyboard,
-  IconNetwork,
-  IconPalette,
-  IconTerminal2,
-  IconUserCog,
-  IconVariable,
-} from "@tabler/icons-react";
-
-These guides cover changes that affect how Homarr is deployed, secured, operated, or extended.
-
-## Deploy and secure
-
-<Cards>
-  <Card icon={<IconVariable />} title="Environment variables" href="/docs/advanced/environment-variables">
-    Configure Homarr at deployment time.
-  </Card>
-  <Card icon={<IconKey />} title="Single sign-on" href="/docs/advanced/single-sign-on">
-    Connect an external identity provider.
-  </Card>
-  <Card icon={<IconNetwork />} title="Proxies and certificates" href="/docs/advanced/proxy">
-    Run Homarr behind a reverse proxy.
-  </Card>
-  <Card icon={<IconUserCog />} title="Run as a different user" href="/docs/advanced/running-as-different-user">
-    Change the user and group used by the container.
-  </Card>
-</Cards>
-
-## Customize
-
-<Cards>
-  <Card icon={<IconPalette />} title="Custom styling" href="/docs/advanced/styling">
-    Apply custom CSS to Homarr.
-  </Card>
-  <Card icon={<IconIcons />} title="Icons" href="/docs/advanced/icons">
-    Configure icon sources and behavior.
-  </Card>
-  <Card icon={<IconKeyboard />} title="Keyboard shortcuts" href="/docs/advanced/keyboard-shortcuts">
-    Navigate and operate Homarr with the keyboard.
-  </Card>
-</Cards>
-
-## Develop and automate
-
-<Cards>
-  <Card icon={<IconTerminal2 />} title="Command line interface" href="/docs/advanced/command-line">
-    Use administrative commands from the terminal.
-  </Card>
-  <Card icon={<IconCode />} title="Developer guides" href="/docs/advanced/development/getting-started">
-    Set up a development environment and contribute code.
-  </Card>
-</Cards>
@@ -53,6 +53,20 @@ 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.
@@ -1,19 +0,0 @@
-{
-  "title": "Advanced",
-  "defaultOpen": false,
-  "pages": [
-    "index",
-    "---Deploy and secure---",
-    "environment-variables",
-    "single-sign-on",
-    "proxy",
-    "running-as-different-user",
-    "---Customize---",
-    "styling",
-    "icons",
-    "keyboard-shortcuts",
-    "---Develop and automate---",
-    "command-line",
-    "development"
-  ]
-}
@@ -9,14 +9,14 @@ tags:
  - Security
 ---

-import Tabs from "@/components/mdx/legacy-tabs";
-import { TabItem } from "@/components/mdx/legacy-tabs";
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";

 ## Allowing self-signed certificates

 Some users may come across a barrier, where they're unable to receive a 200 response from the Ping widget for some apps, while using self-signed certificates or a local certificate authory.

-:::note[What's going on?]
+:::note What's going on?

 Homarr is trying to communicate to your apps via the integrations.
 It usually doesn't matter if Homarr is running on `http` or `https`.
@@ -40,7 +40,7 @@ services:
    volumes:
      - ./homarr/appdata:/appdata
    environment:
-      - BASE_URL=https://your.internal.dns.address.here.com
+      - BASE_URL=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 and Caddy must share the same Docker network:
+Homarr needs to be on the same network so you will need to add the following property to your homarr install:

 ```yaml
 homarr:
@@ -10,11 +10,14 @@ tags:
  - Active Directory
 ---

+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
+
 # Single Sign On

 Homarr supports multiple authentication options, from internal userbase (credentials), to LDAP (with Active directory support), and OIDC.

-## Common configuration
+### Auth configuration common variables

 | Environment Variable     | Description                                                                                                                                                                                                                                                                                                             | Default Value |
 | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
@@ -23,193 +26,198 @@ Homarr supports multiple authentication options, from internal userbase (credent
 | AUTH_SESSION_EXPIRY_TIME | Time for the session to time out. Can be set as pure number, which will automatically be used in seconds, or followed by s, m, h or d for seconds, minutes, hours or days. (ex: "30m")                                                                                                                                  | "30d"         |
 | AUTH_COOKIE_PREFIX       | Prefix used for all authentication cookies (session, csrf, callback, pkce, state, nonce). Change this if you run another Auth.js/NextAuth app on the same hostname as Homarr (browsers scope cookies by host, not by port) to avoid cookie name collisions. Only letters, numbers, hyphens and underscores are allowed. | `homarr`      |

-## Credentials provider
+<Tabs>
+  <TabItem value="credentials" label="Credentials Provider" default>

-This is the default provider.
+    This is the default provider.

-First user is created using the onboarding process and the rest can be created by this user (see [user management](/docs/management/users))
+    First user is created using the onboarding process and the rest can be created by this user (see [user management](/docs/management/users))

-## LDAP provider
+  </TabItem>
+  <TabItem value="ldap" label="LDAP provider">

-This provider authenticates against an LDAP server.
+    This provider authenticates against an LDAP server.

-Any user in LDAP server that signs in gets created in Homarr database.
+    Any user in LDAP server that signs in gets created in Homarr database.

-Roles are fetched from LDAP groups. Groups with the same name of Homarr will be used to synchronize them.
+    Roles are fetched from LDAP groups. Groups with the same name of Homarr will be used to synchronize them.




-<details>
-  <summary>
-    Example Setup
-  </summary>
-  <div>
+    <details>
+      <summary>
+        Example Setup
+      </summary>
+      <div>

-    In this setup we are using [lldap](https://github.com/lldap/lldap). Install your server using docker or [as a service](https://github.com/lldap/lldap/blob/main/example_configs/lldap.service).
+        In this setup we are using [lldap](https://github.com/lldap/lldap). Install your server using docker or [as a service](https://github.com/lldap/lldap/blob/main/example_configs/lldap.service).

-    Minimal configuration requires 4 env variables, LDAP URI, base, user and password for querying data.
+        Minimal configuration requires 4 env variables, LDAP URI, base, user and password for querying data.

-    There's more variables, but all have defaults corresponding to lldap defaults. These might need to be changed if you have different LDAP provider.
-    ```
-    docker run ...
-    AUTH_PROVIDERS="ldap"
-    AUTH_LDAP_URI="ldap://example.com:3890"
-    AUTH_LDAP_BASE="dc=example,dc=com" // Same as LLDAP_LDAP_BASE_DN
-    AUTH_LDAP_BIND_DN="uid=admin,ou=People,dc=example,dc=com"
-    AUTH_LDAP_BIND_PASSWORD="adminpass" // Same as LLDAP_LDAP_USER_PASS
-    ```
-    ```
-    #Docker compose
-    version: x
-    services:
-      homarr:
-        environment:
-          AUTH_PROVIDERS: ldap
-          AUTH_LDAP_URI: ldap://example.com:3890
-          AUTH_LDAP_BASE: dc=example,dc=com #Same as LLDAP_LDAP_BASE_DN
-          AUTH_LDAP_BIND_DN: uid=admin,ou=People,dc=example,dc=com
-          AUTH_LDAP_BIND_PASSWORD: adminpass #Same as LLDAP_LDAP_USER_PASS
-    ```
+        There's more variables, but all have defaults corresponding to lldap defaults. These might need to be changed if you have different LDAP provider.
+        ```
+        docker run ...
+        AUTH_PROVIDERS="ldap"
+        AUTH_LDAP_URI="ldap://example.com:3890"
+        AUTH_LDAP_BASE="dc=example,dc=com" // Same as LLDAP_LDAP_BASE_DN
+        AUTH_LDAP_BIND_DN="uid=admin,ou=People,dc=example,dc=com"
+        AUTH_LDAP_BIND_PASSWORD="adminpass" // Same as LLDAP_LDAP_USER_PASS
+        ```
+        ```
+        #Docker compose
+        version: x
+        services:
+          homarr:
+            environment:
+              AUTH_PROVIDERS: ldap
+              AUTH_LDAP_URI: ldap://example.com:3890
+              AUTH_LDAP_BASE: dc=example,dc=com #Same as LLDAP_LDAP_BASE_DN
+              AUTH_LDAP_BIND_DN: uid=admin,ou=People,dc=example,dc=com
+              AUTH_LDAP_BIND_PASSWORD: adminpass #Same as LLDAP_LDAP_USER_PASS
+        ```

-    In lldap, create a user and admin group, assign this user to the external admin group configured during onboarding. You can log in using this user and he will be in the group.
+        In lldap, create a user and admin group, assign this user to the external admin group configured during onboarding. You can log in using this user and he will be in the group.

-    Here is another example for Active Directory:
+        Here is another example for Active Directory:

-    ```
-    AUTH_LDAP_URI="ldap://ldap.abc.xyz:389
-    AUTH_LDAP_BASE="DC=abc,DC=xyz"
-    AUTH_LDAP_BIND_DN="CN=Administrator,CN=Users,DC=abc,DC=xyz"
-    AUTH_LDAP_BIND_PASSWORD="YourAdministratorPassword"
-    AUTH_LDAP_USERNAME_ATTRIBUTE="sAMAccountName"
-    AUTH_LDAP_USER_MAIL_ATTRIBUTE="userPrincipalName"
-    AUTH_LDAP_GROUP_CLASS="group"
-    AUTH_LDAP_GROUP_MEMBER_ATTRIBUTE="member"
-    AUTH_LDAP_GROUP_MEMBER_USER_ATTRIBUTE="dn"
-    AUTH_LDAP_SEARCH_SCOPE="sub"
-    AUTH_LDAP_USERNAME_FILTER_EXTRA_ARG="(sAMAccountType=805306368)"
-    ```
-    User mail attribute is set to userPrincipalName as it follows the right schema, but it is recommended to use real emails and the default 'mail' value.
+        ```
+        AUTH_LDAP_URI="ldap://ldap.abc.xyz:389
+        AUTH_LDAP_BASE="DC=abc,DC=xyz"
+        AUTH_LDAP_BIND_DN="CN=Administrator,CN=Users,DC=abc,DC=xyz"
+        AUTH_LDAP_BIND_PASSWORD="YourAdministratorPassword"
+        AUTH_LDAP_USERNAME_ATTRIBUTE="sAMAccountName"
+        AUTH_LDAP_USER_MAIL_ATTRIBUTE="userPrincipalName"
+        AUTH_LDAP_GROUP_CLASS="group"
+        AUTH_LDAP_GROUP_MEMBER_ATTRIBUTE="member"
+        AUTH_LDAP_GROUP_MEMBER_USER_ATTRIBUTE="dn"
+        AUTH_LDAP_SEARCH_SCOPE="sub"
+        AUTH_LDAP_USERNAME_FILTER_EXTRA_ARG="(sAMAccountType=805306368)"
+        ```
+        User mail attribute is set to userPrincipalName as it follows the right schema, but it is recommended to use real emails and the default 'mail' value.

-  </div>
-</details>
+      </div>
+    </details>


-### LDAP configuration
+    ### Configuration

-| Environment Variable                      | Description                                               | Default value       |
-|-------------------------------------------|-----------------------------------------------------------|---------------------|
-| ``AUTH_LDAP_URI``                         | URI of your LDAP server                                   | ---                 |
-| ``AUTH_LDAP_BASE``                        | Base dn of your LDAP server                               | ---                 |
-| ``AUTH_LDAP_BIND_DN``                     | User used for finding users and groups                    | ---                 |
-| ``AUTH_LDAP_BIND_PASSWORD``               | Password for bind user                                    | ---                 |
-| ``AUTH_LDAP_USERNAME_ATTRIBUTE``          | Attribute used for username                               | uid                 |
-| ``AUTH_LDAP_USER_MAIL_ATTRIBUTE``         | Attribute used for mail field                             | mail                |
-| ``AUTH_LDAP_GROUP_CLASS``                 | Class used for querying groups                            | groupOfUniqueNames  |
-| ``AUTH_LDAP_GROUP_MEMBER_ATTRIBUTE``      | Attribute used for querying group member                  | member              |
-| ``AUTH_LDAP_GROUP_MEMBER_USER_ATTRIBUTE`` | User attribute used for comparing with group member       | dn                  |
-| ``AUTH_LDAP_SEARCH_SCOPE``                | Serach scopes between base, one and sub                   | base                |
-| ``AUTH_LDAP_USERNAME_FILTER_EXTRA_ARG``   | Extra arguments for user search filter (& based)          | ---                 |
-| ``AUTH_LDAP_GROUP_FILTER_EXTRA_ARG``      | Extra arguments for user's groups search filter (& based) | ---                 |
+    | Environment Variable                      | Description                                               | Default value       |
+    |-------------------------------------------|-----------------------------------------------------------|---------------------|
+    | ``AUTH_LDAP_URI``                         | URI of your LDAP server                                   | ---                 |
+    | ``AUTH_LDAP_BASE``                        | Base dn of your LDAP server                               | ---                 |
+    | ``AUTH_LDAP_BIND_DN``                     | User used for finding users and groups                    | ---                 |
+    | ``AUTH_LDAP_BIND_PASSWORD``               | Password for bind user                                    | ---                 |
+    | ``AUTH_LDAP_USERNAME_ATTRIBUTE``          | Attribute used for username                               | uid                 |
+    | ``AUTH_LDAP_USER_MAIL_ATTRIBUTE``         | Attribute used for mail field                             | mail                |
+    | ``AUTH_LDAP_GROUP_CLASS``                 | Class used for querying groups                            | groupOfUniqueNames  |
+    | ``AUTH_LDAP_GROUP_MEMBER_ATTRIBUTE``      | Attribute used for querying group member                  | member              |
+    | ``AUTH_LDAP_GROUP_MEMBER_USER_ATTRIBUTE`` | User attribute used for comparing with group member       | dn                  |
+    | ``AUTH_LDAP_SEARCH_SCOPE``                | Serach scopes between base, one and sub                   | base                |
+    | ``AUTH_LDAP_USERNAME_FILTER_EXTRA_ARG``   | Extra arguments for user search filter (& based)          | ---                 |
+    | ``AUTH_LDAP_GROUP_FILTER_EXTRA_ARG``      | Extra arguments for user's groups search filter (& based) | ---                 |

-## OIDC provider
+  </TabItem>
+  <TabItem value="oidc" label="OIDC provider">

-This provider authenticates using OIDC protocol.
+    This provider authenticates using OIDC protocol.

-Users signed in using OIDC are created in Homarr.
+    Users signed in using OIDC are created in Homarr.

-Roles are fetched from group claims. This can also be changed to roles for example added to a azure app registration by using the `AUTH_OIDC_GROUPS_ATTRIBUTE`.
+    Roles are fetched from group claims. This can also be changed to roles for example added to a azure app registration by using the `AUTH_OIDC_GROUPS_ATTRIBUTE`.

-If you'd rather manage group memberships for OIDC users locally (instead of via the IdP), set `AUTH_OIDC_GROUPS_LOCAL_MANAGEMENT=true`. While enabled, Homarr stops syncing OIDC users' group memberships from the groups claim, and admins can add/remove OIDC users on a group's members page. If you turn this back to `false`, the next login of each user resumes the regular sync and reconciles their groups with the IdP's claim again, which may remove memberships that were added manually while local management was enabled.
+    If you'd rather manage group memberships for OIDC users locally (instead of via the IdP), set `AUTH_OIDC_GROUPS_LOCAL_MANAGEMENT=true`. While enabled, Homarr stops syncing OIDC users' group memberships from the groups claim, and admins can add/remove OIDC users on a group's members page. If you turn this back to `false`, the next login of each user resumes the regular sync and reconciles their groups with the IdP's claim again, which may remove memberships that were added manually while local management was enabled.

-To let an existing credentials user also sign in with OIDC, set `AUTH_OIDC_ENABLE_DANGEROUS_CREDENTIALS_LINKING=true`. On the first OIDC sign-in, Homarr links a credentials user with the same email address instead of creating a second user. The user keeps their password login, local username and profile, groups, permissions, boards, settings, and API keys. OIDC profile and group claims do not overwrite the credentials-owned data. Homarr requires the OIDC profile to contain `email_verified: true` while this option is enabled. Only enable this when your OIDC provider verifies email addresses, because a matching email could otherwise be used to take over an existing account.
+    To let an existing credentials user also sign in with OIDC, set `AUTH_OIDC_ENABLE_DANGEROUS_CREDENTIALS_LINKING=true`. On the first OIDC sign-in, Homarr links a credentials user with the same email address instead of creating a second user. The user keeps their password login, local username and profile, groups, permissions, boards, settings, and API keys. OIDC profile and group claims do not overwrite the credentials-owned data. Homarr requires the OIDC profile to contain `email_verified: true` while this option is enabled. Only enable this when your OIDC provider verifies email addresses, because a matching email could otherwise be used to take over an existing account.

-<details>
-  <summary>
-    Example Setup
-  </summary>
-  <div>
+    <details>
+      <summary>
+        Example Setup
+      </summary>
+      <div>

-    In this example we will be using [Authelia](https://github.com/authelia/authelia).
+        In this example we will be using [Authelia](https://github.com/authelia/authelia).

-    You can use any setup, but the simplest is [local](https://github.com/authelia/authelia/blob/master/examples/compose/local/authelia/configuration.yml).
+        You can use any setup, but the simplest is [local](https://github.com/authelia/authelia/blob/master/examples/compose/local/authelia/configuration.yml).

-    You also have to [enable OIDC in Authelia](https://www.authelia.com/configuration/identity-providers/open-id-connect/).
+        You also have to [enable OIDC in Authelia](https://www.authelia.com/configuration/identity-providers/open-id-connect/).

-    Create a client for homarr. To generate client secret you can [use authelia](https://www.authelia.com/integration/openid-connect/frequently-asked-questions/#how-do-i-generate-client-secrets). This is an example config:
+        Create a client for homarr. To generate client secret you can [use authelia](https://www.authelia.com/integration/openid-connect/frequently-asked-questions/#how-do-i-generate-client-secrets). This is an example config:

-    ```yaml
-    identity_providers:
-    oidc:
-    ...
-    clients:
-    - id: homarr
-    secret: <secret_hash>
-    public: false
-    authorization_policy: one_factor
-    redirect_uris:
-    - https://example.com/api/auth/callback/oidc
-    - http://localhost:3000/api/auth/callback/oidc
-    scopes:
-    - openid
-    - groups
-    - profile
-    - email
-    userinfo_signing_algorithm: none
-    consent_mode: implicit # self hosted
-    ```
+        ```yaml
+        identity_providers:
+        oidc:
+        ...
+        clients:
+        - id: homarr
+        secret: <secret_hash>
+        public: false
+        authorization_policy: one_factor
+        redirect_uris:
+        - https://example.com/api/auth/callback/oidc
+        - http://localhost:3000/api/auth/callback/oidc
+        scopes:
+        - openid
+        - groups
+        - profile
+        - email
+        userinfo_signing_algorithm: none
+        consent_mode: implicit # self hosted
+        ```

-    In Homarr use following env variables.
+        In Homarr use following env variables.

-    ```
-    AUTH_PROVIDERS="oidc"
-    AUTH_OIDC_ISSUER="https://auth.example.com"
-    AUTH_OIDC_CLIENT_SECRET="client_secret"
-    AUTH_OIDC_CLIENT_ID="homarr"
-    AUTH_OIDC_CLIENT_NAME="Authelia"
-    AUTH_OIDC_FORCE_USERINFO="true" --> from v4.39 of authelia and above this is required
-    ```
+        ```
+        AUTH_PROVIDERS="oidc"
+        AUTH_OIDC_ISSUER="https://auth.example.com"
+        AUTH_OIDC_CLIENT_SECRET="client_secret"
+        AUTH_OIDC_CLIENT_ID="homarr"
+        AUTH_OIDC_CLIENT_NAME="Authelia"
+        AUTH_OIDC_FORCE_USERINFO="true" --> from v4.39 of authelia and above this is required
+        ```

-    For an azure app registration the setup could look like this:
+        For an azure app registration the setup could look like this:

-    ```
-    AUTH_PROVIDERS="oidc"
-    AUTH_OIDC_ISSUER="https://login.microsoftonline.com/<teanant-id>/v2.0"
-    AUTH_OIDC_CLIENT_SECRET="<client-secret>"
-    AUTH_OIDC_CLIENT_ID="<client-id>"
-    AUTH_OIDC_CLIENT_NAME="Azure"
-    AUTH_OIDC_SCOPE_OVERWRITE="openid email profile" # Groups scope does not exist in azure
-    AUTH_OIDC_GROUPS_ATTRIBUTE="roles" # We use the roles of the app registration so that we don't need to use uuids as our groups
-    ```
+        ```
+        AUTH_PROVIDERS="oidc"
+        AUTH_OIDC_ISSUER="https://login.microsoftonline.com/<teanant-id>/v2.0"
+        AUTH_OIDC_CLIENT_SECRET="<client-secret>"
+        AUTH_OIDC_CLIENT_ID="<client-id>"
+        AUTH_OIDC_CLIENT_NAME="Azure"
+        AUTH_OIDC_SCOPE_OVERWRITE="openid email profile" # Groups scope does not exist in azure
+        AUTH_OIDC_GROUPS_ATTRIBUTE="roles" # We use the roles of the app registration so that we don't need to use uuids as our groups
+        ```

-  </div>
-</details>
+      </div>
+    </details>


-### OIDC configuration
+    ### Configuration

-| Environment Variable        | Description                                                | Default value |
-|-----------------------------|------------------------------------------------------------|---------------|
-| ``AUTH_OIDC_ISSUER``        | Issuer URI of OIDC provider. This has generally to be **without trailing slash** except for **Authentik** | ---           |
-| ``AUTH_OIDC_CLIENT_ID``     | ID of OIDC client (application)                            | ---           |
-| ``AUTH_OIDC_CLIENT_SECRET`` | Secret of OIDC client (application)                        | ---           |
-| ``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. 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. 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 |
-| ``AUTH_OIDC_TOKEN_ENDPOINT_AUTH_METHOD`` | Override method for the token endpoint authentication. Supported values are `client_secret_basic`, `client_secret_post`, `client_secret_jwt` and `none`. | client_secret_basic |
+    | Environment Variable        | Description                                                | Default value |
+    |-----------------------------|------------------------------------------------------------|---------------|
+    | ``AUTH_OIDC_ISSUER``        | Issuer URI of OIDC provider. This has generally to be **without trailing slash** except for **Authentik** | ---           |
+    | ``AUTH_OIDC_CLIENT_ID``     | ID of OIDC client (application)                            | ---           |
+    | ``AUTH_OIDC_CLIENT_SECRET`` | Secret of OIDC client (application)                        | ---           |
+    | ``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_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_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 |
+    | ``AUTH_OIDC_TOKEN_ENDPOINT_AUTH_METHOD`` | Override method for the token endpoint authentication. Supported values are `client_secret_basic`, `client_secret_post`, `client_secret_jwt` and `none`. | client_secret_basic |

-### OIDC permissions
+    ### Permission System

-To give a user special permissions, first create a new group in homarr and assign the permission desired.
-For example if the group on homarr is called `homarr-admins` a new group on the oidc provider, for example authentik needs to be created with the same name, that would be `homarr-admins`.
-After assigning the group on the oidc provider to the user, and logging again into homarr, the user should automatically get placed in that group and inherit the permissions defined.
+    To give a user special permissions, first create a new group in homarr and assign the permission desired.
+    For example if the group on homarr is called `homarr-admins` a new group on the oidc provider, for example authentik needs to be created with the same name, that would be `homarr-admins`.
+    After assigning the group on the oidc provider to the user, and logging again into homarr, the user should automatically get placed in that group and inherit the permissions defined.

+  </TabItem>
+</Tabs>

 ## Example setups

@@ -236,21 +244,18 @@ After assigning the group on the oidc provider to the user, and logging again in
        - 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.
-
-        ```bash
-        OIDC_CLIENT_ID=<REPLACE_WITH_OIDC_CLIENT_ID>
-        OIDC_CLIENT_SECRET=<REPLACE_WITH_OIDC_CLIENT_SECRET>
+        ```env
+        OIDC_CLIENT_ID=identificationid #OIDC client ID
+        OIDC_CLIENT_SECRET=secretsecretsecret #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=<REPLACE_WITH_64_HEX_CHARACTERS>
+        SECRET_ENCRYPTION_KEY=encryptencryptencrypt #Homarr encryption key
        ```

        **3. Example Docker Compose configuration:**
-        ```yaml {14-24}
+        ```yaml {14-26}
        services:
          homarr:
            image: ghcr.io/homarr-labs/homarr:latest
@@ -264,6 +269,8 @@ After assigning the group on the oidc provider to the user, and logging again in
            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}
@@ -290,7 +297,7 @@ After assigning the group on the oidc provider to the user, and logging again in
      </div>
    </details>

-    See [OIDC configuration](#oidc-configuration) for additional options.
+    Additional OIDC configuration options are described in the OIDC tab above.

  </TabItem>
  <TabItem value="google" label="Google (OIDC) Example" default>
@@ -315,18 +322,15 @@ After assigning the group on the oidc provider to the user, and logging again in
        - 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.
-
-        ```bash
-        OIDC_CLIENT_ID=<REPLACE_WITH_GOOGLE_CLIENT_ID>
-        OIDC_CLIENT_SECRET=<REPLACE_WITH_GOOGLE_CLIENT_SECRET>
+        ```env
+        OIDC_CLIENT_ID=identificationid #Google Client-ID
+        OIDC_CLIENT_SECRET=secretsecretsecret #Google Client Key (secret)
        HOMARR_FQDN=homarr.example.com #Homarr FQDN
-        SECRET_ENCRYPTION_KEY=<REPLACE_WITH_64_HEX_CHARACTERS>
+        SECRET_ENCRYPTION_KEY=encryptencryptencrypt #Homarr encryption key
        ```

        **3. Example Docker Compose configuration (Homarr):**
-        ```yaml {14-20}
+        ```yaml {16-22}
        services:
          homarr:
            image: ghcr.io/homarr-labs/homarr:latest
@@ -340,6 +344,8 @@ After assigning the group on the oidc provider to the user, and logging again in
            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}
@@ -356,7 +362,7 @@ After assigning the group on the oidc provider to the user, and logging again in
      </div>
    </details>

-    See [OIDC configuration](#oidc-configuration) for additional options.
+    Additional OIDC configuration options are described in the OIDC tab above.

  </TabItem>
 </Tabs>
@@ -1,37 +1,105 @@
 # Styling

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

- **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
-
-Custom CSS can break after updates and is not an authorization boundary. Hidden controls remain accessible to users who
-have permission to use them.
+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.

 :::

-## Target elements
+:::warning

-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.
+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.

-To target one widget, add a custom class under **Edit item → Advanced options** and use that class in the board CSS.
+:::

-Use `!important` only when the existing cascade requires it.
+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.

-## Theme variables
+## Getting into CSS

-Mantine exposes [CSS variables](https://mantine.dev/styles/css-variables-list/) that can be overridden globally or per
-board:
+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.
+
+## Limitations and dangers
+
+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>**:
+
+- 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)
+
+Administrators can add instance-wide CSS under **Management → Settings → Branding → Custom CSS**. Enter CSS directly
+or import a community theme from the Workshop, then save the server settings to apply it to every page.
+
+For board-specific styling, scroll to the **Custom CSS** section on the board settings page. Enter your CSS there and
+save the board settings to apply it to that board. Board CSS is loaded after the global stylesheet and can override it.
+
+![](./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:

 ```css
 :root {
  --mantine-primary-color-filled: #ffbb00;
 }
 ```
-
-CSS changes presentation only; use widgets, integrations, permissions, or application code for behavior.
@@ -0,0 +1,8 @@
+{
+  "label": "Community",
+  "position": 6,
+  "collapsed": true,
+  "link": {
+    "type": "generated-index"
+  }
+}
@@ -8,7 +8,22 @@ tags:

 # Donate

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

-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).
+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).
@@ -1,51 +1,110 @@
 ---
 title: Frequently Asked Questions
-description: Answers to common Homarr questions about installation, customization, connectivity, support, and commercial use.
 tags:
  - Community
  - Help
 ---

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

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

-## Can I use custom app icons?
+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.

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

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

-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.
+### Can I use my own custom icons for apps?

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

-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).
+### Some of my online icons are not working (anymore)

-## Where are the logs?
+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.

-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`.
+### Can I add my own widgets? Do I need programming skills?

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

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

-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.
+Custom JSX v2 is the only Custom Widget format. Write the JSON and JSX in the workbench.

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

-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).
+The workbench reads a pasted AI response. It shows request capabilities and redacted diagnostics.

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

-Yes. Homarr is licensed under the [Apache License 2.0](/docs/community/license). Commercial users can support development
-through [OpenCollective](/docs/community/donate).
+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).
+
+:::
@@ -1,23 +1,24 @@
 ---
-title: Get in touch
-description: Community, support, and private contact channels.
+title: Get In Touch
+description: Still have a question? Click here!
 tags:
  - Help
  - Community
 ---

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

-## GitHub
+## E-Mail

-Use the [issue templates](https://github.com/homarr-labs/homarr/issues/new/choose) for bugs and feature requests.
+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)

 ## Discord

-Use the [Homarr Discord server](https://discord.gg/aCsmEV5RgA) for community support, release discussion, and dashboard
-showcases.
+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.

-## 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.
+[_![](https://discordapp.com/api/guilds/972958686051962910/widget.png?style=banner2)_](https://discord.gg/aCsmEV5RgA)
@@ -1,10 +0,0 @@
---
-title: Community
-description: Get help, contribute to Homarr, and support the project.
---
-
- [Frequently asked questions](/docs/community/faq): resolve common setup and operation issues.
- [Get in touch](/docs/community/get-in-touch): choose the right support or discussion channel.
- [Translations](/docs/community/translations): improve Homarr in your language.
- [Donate](/docs/community/donate): support ongoing development.
- [License](/docs/community/license): understand how Homarr is licensed.
@@ -1,5 +0,0 @@
-{
-  "title": "Community",
-  "defaultOpen": false,
-  "pages": ["index", "faq", "get-in-touch", "translations", "donate", "license"]
-}
@@ -5,24 +5,51 @@ tags:
  - Translations
 ---

-# 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/).

-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.
+## How to translate

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

-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.
+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.

-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.
+### 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.
+
+:::

 ## Guidelines

- 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.
+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.
@@ -0,0 +1,9 @@
+{
+  "label": "Getting started",
+  "position": 1,
+  "collapsed": false,
+  "link": {
+    "type": "generated-index",
+    "title": "Getting started"
+  }
+}
@@ -6,133 +6,397 @@ tags:
  - Configuration
 ---

-import {
-  IconAdjustments,
-  IconChecklist,
-  IconLayoutDashboard,
-  IconPlugConnected,
-  IconSearch,
-  IconSparkles,
-} from "@tabler/icons-react";
+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";

-import onboardingWelcome from "./img/onboarding-v2-welcome.png";
-import onboardingBoard from "./img/onboarding-v2-board.png";
-import onboardingReview from "./img/onboarding-v2-review.png";
+:::tip

-After Homarr starts, open its URL. An unfinished installation redirects to the onboarding screen at `/init`. Choose
-**Get started** for a new installation or **Restore backup** to import a compatible SQLite backup.
+Read our [glossary](/docs/getting-started/glossary) if you are new to Homarr.

-<Callout type="info" title="Persist /appdata before you continue">
-  Onboarding writes the administrator and board configuration to the database. If onboarding returns after a restart,
-  check that `/appdata` is writable and persisted. See the
-  [Docker installation guide](/docs/getting-started/installation/docker).
-</Callout>
+:::

-## Complete onboarding
+Congratulations on installing Homarr. Now it's time to get yourself familiar with the concepts of Homarr and how to use it.

-Onboarding is split into six short sections. Integrations, Workshop, Assistant, and MCP are optional; skip them when you
-only need a working board.
+## Onboarding

-<Cards>
-  <Card icon={<IconAdjustments />} title="1. Essentials">
-    Choose the language, theme, usual server address, and anonymous analytics preference.
-  </Card>
-  <Card icon={<IconSearch />} title="2. Discover">
-    Review the database, Docker, Kubernetes, Assistant, and Workshop capabilities Homarr can reach.
-  </Card>
-  <Card icon={<IconPlugConnected />} title="3. Connect">
-    Import detected services or add integrations manually. Unfinished integrations can be skipped.
-  </Card>
-  <Card icon={<IconLayoutDashboard />} title="4. Board">
-    Set the board name, colors, corner radius, column count, and optional sidebars.
-  </Card>
-  <Card icon={<IconSparkles />} title="5. Extend">
-    Optionally connect the Workshop, configure an Assistant provider, or review the MCP endpoint.
-  </Card>
-  <Card icon={<IconChecklist />} title="6. Review">
-    Check the final summary, then build the board. Homarr opens the exact board it configured.
-  </Card>
-</Cards>
+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.

-The final screen links directly to the new board and the management area. Board layout, integrations, apps, and
-appearance can all be changed later.
+:::note

-<Cards>
-  <Card title="Start or restore">
-    <img src={onboardingWelcome.src} alt="Homarr onboarding welcome screen with Get started and Restore backup actions" />
-  </Card>
-  <Card title="Configure the board">
-    <img src={onboardingBoard.src} alt="Board onboarding section for colors, columns, corner radius, and sidebars" />
-  </Card>
-  <Card title="Review before building">
-    <img src={onboardingReview.src} alt="Onboarding review showing the board settings Homarr will create" />
-  </Card>
-</Cards>
+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.

-## Core concepts
+:::

-### Boards
+### Restore or start fresh

-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.
+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.

-![Board management with board previews](./img/after-installation-boards.webp)
+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.

-See [Boards](/docs/management/boards) for responsive layouts, access control, appearance, and home-board settings.
+### Setup studio

-### Apps
+The studio keeps related choices together:

-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.
+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.

-![App management with saved shortcuts](./img/after-installation-apps.webp)
+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.

-See [Apps](/docs/management/apps) or [Icons](/docs/advanced/icons).
+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.

-### Integrations
+## Creating another board

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

-![Integration catalog with compatible widgets](./img/after-installation-integrations.webp)
+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)).

-See [Managing integrations](/docs/management/integrations) and the
-[integration catalog](/docs/integrations).
+![](./img/manage-create-board-modal.png)

-### Widgets
+Congratulations - you've just created another board. You can see the boards you have access to on this page:

-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.
+<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>

-![Board in edit mode with the add-content menu](./img/after-installation-widgets.webp)
+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.

-See the [widget catalog](/docs/widgets).
+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.

-### Containers and rails
+## Add your first app to Homarr

-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.
+To add links to your dashboard, you must first add them as an "app".
+Navigate to this page to add an app:

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

-See [Boards](/docs/management/boards#containers-and-rails).
+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.

-### Users, groups, and permissions
+![](./img/manage-add-app-form.png)

-Users inherit permissions and default boards from their groups. Resource-specific access can further restrict boards
-and integrations.
+After you created the app, you'll see in on the apps page:

-![Group permission settings](./img/after-installation-users-permissions.webp)
+![](./img/manage-created-app.png)

-See [Users and groups](/docs/management/users) and [single sign-on](/docs/advanced/single-sign-on).
+## Arrange and organize your board

-## Explore further
+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:

- [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)
+<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>

-See the [glossary](/docs/getting-started/glossary) for a compact list of Homarr terms.
+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.
+
+:::
@@ -2,19 +2,12 @@

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

-| 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 |
+| 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              |
Author	SHA1	Message	Date
ajnart	dc7a8579dc	refactor: reuse CodeMirror for CSS editors	2026-08-31 14:01:43 +02:00
ajnart	e617a47395	feat: add global server custom CSS	2026-08-31 13:47:37 +02:00