diff --git a/.agents/skills/homarr-custom-widget/SKILL.md b/.agents/skills/homarr-custom-widget/SKILL.md
new file mode 100644
index 000000000..3121374ab
--- /dev/null
+++ b/.agents/skills/homarr-custom-widget/SKILL.md
@@ -0,0 +1,28 @@
+---
+name: homarr-custom-widget
+description: Author safe Homarr Custom JSX v2 widgets from API documentation.
+---
+
+# Homarr Custom Widget
+
+Author one widget at a time. When connected to Homarr, retrieve `homarr://custom-widgets/schema` and only the component resources needed for the design. The live resources are authoritative for the installed release.
+
+1. Read the API documentation.
+2. Create one credential-free widget with keyed `sources`, keyed `requests`, optional keyed `options`, and safe JSX `template`.
+3. Validate, preview, test queries and simulated actions, visually inspect, and iterate.
+4. Configure deployment-specific source URLs and request credentials through Homarr; never repeat plaintext.
+5. Save only after narrow/wide, light/dark, loading, empty, error, and success states work.
+
+Use `{option:name}` or `$option` for saved options. Use `{param:name}` or `$param` for values supplied by `SubFetch`, `ActionButton`, or `ToggleSwitch`. Load queries cannot use invocation parameters. Templates read `data`, `status`, `options`, and temporary `inputs`.
+
+`SubFetch` with `trigger="manual"` renders its own load button. Pass a card or image through `triggerContent` with `triggerAriaLabel` when that content should launch the request. Its callback is `(result, meta)`; never author `onClick` or a fetch callback.
+
+Use standard Mantine compound names and deliberate visual hierarchy, spacing, restrained semantic color, and responsive layouts. Avoid excessive nested cards.
+
+Do not use imports, hooks, refs, raw HTML, raw event callbacks, browser requests, arbitrary functions, eval, bigint, npm packages, authored statement blocks, IIFEs, or recursion. Do not pretend MCP tools exist in an offline chat session.
+
+To install an existing widget, use `customWidget_workshopSearch`, inspect it with `customWidget_workshopGet`, then use `customWidget_workshopInstall`. Configure each self-hosted source afterward with `customWidget_sourceConfigure`, or call `customWidget_configurationRequestUser` so the user can enter the server URL and credentials directly in Homarr.
+
+Preview-scoped configuration expires with the preview. To persist user-entered values for a new widget, create the widget first, request configuration for its definition ID, then create a final preview with that definition ID so Homarr loads the stored credentials.
+
+When this skill is installed from the repository, optional offline details are in `references/schema.md`, `references/runtime.md`, and `references/security.md`. MCP-only clients should use the live Homarr resources instead.
diff --git a/.agents/skills/homarr-custom-widget/references/runtime.md b/.agents/skills/homarr-custom-widget/references/runtime.md
new file mode 100644
index 000000000..7c2cab770
--- /dev/null
+++ b/.agents/skills/homarr-custom-widget/references/runtime.md
@@ -0,0 +1,16 @@
+# Runtime
+
+Templates read `data.requestId`, `status.requestId`, `options.name`, and temporary `inputs.name`. Status contains `loading`, `ok`, `status`, `statusText`, and `error`.
+
+`bind="search"` creates an in-memory input. It is never persisted. Supply invocation values only through `params`, for example:
+
+```jsx
+
+
+ {(items) => {(items ?? []).map(item => {item.name})}}
+
+```
+
+`SubFetch` with `trigger="manual"` renders its own load button. To make a card or image launch the request, pass that node through `triggerContent` and provide `triggerAriaLabel`; Homarr supplies the click and keyboard behavior. Its optional second callback argument contains `{ ok, status, statusText, loading: false }`; loading and request failures are rendered by `SubFetch` before the callback runs. Do not author `onClick` or a fetch callback.
+
+Use expression callbacks for supported collection methods and trusted slots. Do not use callback blocks, IIFEs, authored recursion, or raw events. Bounded regex literals work only with safe string matching/replacement operations.
diff --git a/.agents/skills/homarr-custom-widget/references/schema.md b/.agents/skills/homarr-custom-widget/references/schema.md
new file mode 100644
index 000000000..ad1a1b1a0
--- /dev/null
+++ b/.agents/skills/homarr-custom-widget/references/schema.md
@@ -0,0 +1,22 @@
+# Schema
+
+```ts
+interface HomarrCustomWidgetV2 {
+ $schema: "homarr-custom-widget-v2";
+ name: string;
+ description?: string;
+ iconUrl?: string;
+ sources: Record;
+ requests: Record;
+ options?: Record;
+ template: string;
+}
+```
+
+Sources require `default`. A request defaults to the default source, query, GET, load, inherited auth, and view permission. An action defaults to manual and modify permission. DELETE uses full permission and confirmation.
+
+Use stable real URLs for public APIs and clear suggested URLs for self-hosted services. Homarr collects the installer's server URL, network scope, and credentials as source setup; credentials remain outside the manifest.
+
+Paths use `{option:name}` and `{param:name}`. Query/body data uses `{ "$option": "name" }` and `{ "$param": "name" }`. Load queries cannot use params. Runtime parameter names and primitive values are inferred from references.
+
+Every option has `label`, `control`, and `default`. Optional fields are `description`, `choices`, `choicesFrom`, `min`, `max`, `step`, `advanced`, and `group`.
diff --git a/.agents/skills/homarr-custom-widget/references/security.md b/.agents/skills/homarr-custom-widget/references/security.md
new file mode 100644
index 000000000..1abec790b
--- /dev/null
+++ b/.agents/skills/homarr-custom-widget/references/security.md
@@ -0,0 +1,7 @@
+# Security
+
+All requests use Homarr's protected server executor. Source origin, network scope, DNS, redirects, SSRF, rate limits, permissions, size limits, timeouts, and encrypted credential injection remain enforced.
+
+The JSX interpreter blocks imports, hooks, refs, raw event callbacks, browser requests, eval, arbitrary functions, prototype access, unsafe URLs, global CSS escape, arbitrary portals, bigint, statement blocks, IIFEs, and recursion. Regex literals must be bounded and reject backreferences, lookbehind, nested quantifiers, excessive length, and unsupported flags.
+
+Credentials are stored separately and never exported or returned to an agent. A published self-hosted source URL is only a suggestion: installers must confirm or replace private and loopback URLs for their own Homarr deployment. Source origins cannot be controlled through widget options.
diff --git a/.dockerignore b/.dockerignore
index 521c55109..c0f2129a3 100644
--- a/.dockerignore
+++ b/.dockerignore
@@ -17,7 +17,8 @@ coverage
dev
.build
e2e
-apps/docs
+apps/docs/*
+!apps/docs/package.json
apps/nextjs/.next
.env
.env.*
diff --git a/.env.example b/.env.example
index 22dca3adb..997d60865 100644
--- a/.env.example
+++ b/.env.example
@@ -61,9 +61,30 @@ TURBO_TELEMETRY_DISABLED=1
# Enable mock integration
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.
+HOMARR_WEBSITE_URL=https://homarr.dev
+# PocketBase API used by Homarr and by the standalone documentation site.
+# Defaults to HOMARR_WEBSITE_URL.
+# WORKSHOP_API_URL=https://homarr.dev
+# Public Workshop page opened from Homarr. Defaults to HOMARR_WEBSITE_URL/workshop.
+# WORKSHOP_WEB_URL=https://homarr.dev/workshop
+
+# Documentation and PocketBase deployment settings.
+# WORKSHOP_PUBLIC_ORIGIN=https://homarr.dev
+# PB_ALLOWED_ORIGINS=*
+
+# Local Workshop stack:
+# 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
+# WORKSHOP_PUBLIC_ORIGIN=http://127.0.0.1:3003
+# Optional: GITHUB_CLIENT_ID=
+# Optional: GITHUB_CLIENT_SECRET=
+
# Enable demo mode (seeds a demo user "demo"/"demo", a sample board and a mock integration)
# DEMO_MODE=true
# Whether demo mode is read-only. Defaults to true (the public demo blocks all mutations).
# Set to false for writable preview deployments so the demo user can modify the dashboard.
-# DEMO_READ_ONLY=false
\ No newline at end of file
+# DEMO_READ_ONLY=false
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index 0d8b33a33..d4b730726 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -33,6 +33,7 @@ body:
options:
# The below comment is used to insert a new version with on-release.yml
#NEXT_VERSION#
+ - 1.74.0
- 1.73.0
- 1.72.0
- 1.71.0
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index ed325c9a8..d227e66d7 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -16,6 +16,6 @@
**When contributing a new integration or widget:**
- [ ] I confirmed manually that the integration or widget is working with a real system and performed basic smoke
- tests (e.g. what happens if it is offline)
+ tests (e.g. what happens if it is offline)
- [ ] Optional but recommended: I confirm that I am willing to be added to the `CODEOWNERS` of this feature and will
- provide support and maintain the integration (e.g. in case of breaking or failure)
\ No newline at end of file
+ provide support and maintain the integration (e.g. in case of breaking or failure)
diff --git a/.github/workflows/autofix.yml b/.github/workflows/autofix.yml
index 9d54d9669..733e21eb9 100644
--- a/.github/workflows/autofix.yml
+++ b/.github/workflows/autofix.yml
@@ -1,4 +1,4 @@
-name: Auto-fix lint and format
+name: Formatting
on:
pull_request:
@@ -6,42 +6,30 @@ on:
branches: ["*"]
permissions:
- contents: write
+ contents: read
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number }}
cancel-in-progress: true
jobs:
- autofix:
- name: Auto-fix
- if: github.event.pull_request.head.repo.id == github.repository_id
+ format:
+ name: Check formatting
runs-on: ubuntu-latest
timeout-minutes: 5
steps:
- uses: actions/checkout@v7
with:
fetch-depth: 0
- ref: ${{ github.head_ref }}
+ persist-credentials: false
- name: Setup
uses: ./tooling/github/setup
- - name: Get changed files
- id: changed
+ - name: Check changed files
env:
BASE_REF: ${{ github.base_ref }}
run: |
- git diff --name-only --diff-filter=ACMR "origin/${BASE_REF}...HEAD" -- '*.ts' '*.tsx' '*.js' '*.jsx' > /tmp/changed-files
- echo "count=$(wc -l < /tmp/changed-files | tr -d '[:space:]')" >> $GITHUB_OUTPUT
-
- - name: Auto-fix lint + format
- if: steps.changed.outputs.count != '0'
- run: |
- xargs -r -a /tmp/changed-files pnpm exec oxlint --fix || true
- xargs -r -a /tmp/changed-files pnpm exec oxfmt --write
-
- - name: Commit fixes
- uses: stefanzweifel/git-auto-commit-action@v7
- with:
- commit_message: "style: auto-fix lint and format"
+ git diff --name-only --diff-filter=ACMR -z "origin/${BASE_REF}...HEAD" -- \
+ '*.css' '*.js' '*.json' '*.jsonc' '*.jsx' '*.md' '*.mdx' '*.scss' '*.ts' '*.tsx' '*.yaml' '*.yml' \
+ | xargs -0 -r pnpm exec oxfmt --check --
diff --git a/.github/workflows/automatic-approval.yml b/.github/workflows/automatic-approval.yml
deleted file mode 100644
index 9e246f838..000000000
--- a/.github/workflows/automatic-approval.yml
+++ /dev/null
@@ -1,35 +0,0 @@
-name: "[Dependency Updates] Auto Approve"
-on:
- pull_request:
- types: [opened, synchronize]
-
-permissions: {}
-
-jobs:
- approve-automatic-prs:
- runs-on: ubuntu-latest
- timeout-minutes: 2
- # 158783068: homarr-renovate[bot]
- # 190541745: homarr-crowdin[bot]
- # 210161987: homarr-update-contributors[bot]
- # 175486441: homarr-releases[bot]
- # Extracted from https://api.github.com/users/
- if: github.actor_id == 158783068 || github.actor_id == 190541745 || github.actor_id == 210161987 || github.actor_id == 175486441
- steps:
- - name: Checkout code
- uses: actions/checkout@v7
- - name: Obtain token
- id: obtainToken
- uses: actions/create-github-app-token@v3
- with:
- private-key: ${{ secrets.RENOVATE_APPROVE_PRIVATE_KEY }}
- client-id: ${{ secrets.RENOVATE_APPROVE_APP_ID }}
- permission-pull-requests: write # required to approve pull request
-
- - name: Install GitHub CLI
- run: sudo apt-get install -y gh
- - name: Approve automatic PRs
- env:
- GITHUB_TOKEN: ${{ steps.obtainToken.outputs.token }}
- run: |
- gh pr review ${{github.event.pull_request.number}} --approve --body "Automatically approved by GitHub Action"
diff --git a/.github/workflows/bot-auto-merge-reconcile.yml b/.github/workflows/bot-auto-merge-reconcile.yml
new file mode 100644
index 000000000..d82f759f5
--- /dev/null
+++ b/.github/workflows/bot-auto-merge-reconcile.yml
@@ -0,0 +1,43 @@
+name: "[Bots] Reconcile Auto-merge"
+
+on:
+ schedule:
+ - cron: "*/30 * * * *"
+ workflow_dispatch:
+
+permissions: {}
+
+jobs:
+ reconcile:
+ runs-on: ubuntu-latest
+ timeout-minutes: 15
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v7
+
+ - name: Obtain token
+ id: obtainToken
+ uses: actions/create-github-app-token@v3
+ with:
+ private-key: ${{ secrets.RENOVATE_APPROVE_PRIVATE_KEY }}
+ client-id: ${{ secrets.RENOVATE_APPROVE_APP_ID }}
+ permission-pull-requests: write # required to enable auto-merge
+
+ - name: Install GitHub CLI
+ run: sudo apt-get install -y gh
+
+ - name: Re-enable auto-merge for prepared bot PRs
+ env:
+ GITHUB_TOKEN: ${{ steps.obtainToken.outputs.token }}
+ run: |
+ # 158783068: homarr-renovate[bot]
+ # 190541745: homarr-crowdin[bot]
+ # 210161987: homarr-update-contributors[bot]
+ # 175441: homarr-releases[bot]
+ gh pr list --repo "${{ github.repository }}" --base dev --state open --limit 100 \
+ --json number,author,reviewDecision,mergeStateStatus,autoMergeRequest \
+ --jq '.[] | select(.author.login as $login | ["app/homarr-renovate", "app/homarr-crowdin", "app/homarr-update-contributors", "app/homarr-releases"] | index($login)) | select(.reviewDecision == "APPROVED") | select(.mergeStateStatus == "CLEAN") | select(.autoMergeRequest == null) | .number' \
+ | while read -r pr; do
+ echo "Re-enabling auto-merge on PR #$pr"
+ gh pr merge "$pr" --auto --squash
+ done
diff --git a/.github/workflows/bot-pr-automerge.yml b/.github/workflows/bot-pr-automerge.yml
new file mode 100644
index 000000000..35c5461fa
--- /dev/null
+++ b/.github/workflows/bot-pr-automerge.yml
@@ -0,0 +1,47 @@
+name: "[Bots] Approve and Auto-merge"
+
+on:
+ pull_request:
+ types: [opened, synchronize, reopened, ready_for_review]
+
+permissions: {}
+
+jobs:
+ approve-and-automerge:
+ runs-on: ubuntu-latest
+ timeout-minutes: 5
+ # 158783068: homarr-renovate[bot]
+ # 190541745: homarr-crowdin[bot]
+ # 210161987: homarr-update-contributors[bot]
+ # 175441: homarr-releases[bot]
+ # Extracted from https://api.github.com/users/
+ if: |
+ (github.actor_id == 158783068 || github.actor_id == 190541745 || github.actor_id == 210161987 || github.actor_id == 175441) &&
+ github.event.pull_request.head.repo.full_name == github.repository &&
+ github.event.pull_request.base.ref == 'dev'
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v7
+
+ - name: Obtain token
+ id: obtainToken
+ uses: actions/create-github-app-token@v3
+ with:
+ private-key: ${{ secrets.RENOVATE_APPROVE_PRIVATE_KEY }}
+ 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
+ run: sudo apt-get install -y gh
+
+ - name: Approve and enable auto-merge
+ env:
+ GITHUB_TOKEN: ${{ steps.obtainToken.outputs.token }}
+ run: |
+ PR_NUMBER="${{ github.event.pull_request.number }}"
+ if [ "$(gh pr view "$PR_NUMBER" --json reviewDecision --jq .reviewDecision)" != "APPROVED" ]; then
+ gh pr review "$PR_NUMBER" --approve --body "Automatically approved by Homarr bot policy"
+ fi
+ if [ "$(gh pr view "$PR_NUMBER" --json autoMergeRequest --jq '.autoMergeRequest != null')" != "true" ]; then
+ gh pr merge "$PR_NUMBER" --auto --squash
+ fi
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index addcf5e7d..643c4f436 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -8,7 +8,7 @@ on:
types: [closed]
branches: ["*"]
push:
- branches: [main, dev, beta, next]
+ branches: [main, dev, beta, next, v2]
merge_group:
workflow_dispatch:
inputs:
@@ -34,8 +34,10 @@ permissions:
contents: read
concurrency:
- group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.event.pull_request.number || inputs.pr_number || github.ref }}
- cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
+ # Every event for a PR shares one group so a close event cancels stale image
+ # publication and a newer synchronize run cannot be overwritten by an older run.
+ group: ${{ github.workflow }}-${{ github.event.pull_request.number || inputs.pr_number || github.ref }}
+ cancel-in-progress: ${{ github.event_name == 'pull_request' || github.event_name == 'pull_request_target' || github.event_name == 'workflow_dispatch' || github.ref != 'refs/heads/main' }}
env:
FORCE_COLOR: 3
@@ -82,11 +84,22 @@ jobs:
run: cp .env.example .env
- name: Lint, typecheck, and build affected workspaces
- run: pnpm turbo run lint typecheck build --affected --continue=dependencies-successful --concurrency=4
+ run: pnpm turbo run lint typecheck build --affected --continue=dependencies-successful --concurrency=2
- name: Validate workspace configuration
run: pnpm lint:ws
+ - name: Validate Custom Widget architecture
+ run: pnpm check:custom-widgets
+
+ - name: Validate checked-in OpenAPI schema
+ run: pnpm check:openapi
+
+ - name: Validate Custom Widget bundle budget
+ run: |
+ pnpm --filter nextjs build
+ pnpm check:custom-widget-bundle
+
- name: Run unit tests
run: pnpm test
@@ -102,6 +115,8 @@ jobs:
permissions:
contents: read
packages: write
+ outputs:
+ digest: ${{ steps.preview-build.outputs.digest }}
steps:
- uses: actions/checkout@v7
if: "!env.ACT"
@@ -184,38 +199,166 @@ jobs:
path: e2e/test-results/
retention-days: 7
- - name: Determine preview tag
- id: preview
+ - name: Log in to GHCR for preview publication
if: |
!env.ACT &&
(
(github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository) ||
(github.event_name == 'workflow_dispatch' && inputs.operation == 'publish')
)
- env:
- PR_NUMBER: ${{ github.event.pull_request.number || inputs.pr_number }}
- run: echo "tag=pr-${PR_NUMBER}" >> "$GITHUB_OUTPUT"
-
- - name: Log in to GHCR
- if: steps.preview.outputs.tag != ''
uses: docker/login-action@v4
with:
registry: ${{ env.REGISTRY }}
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- - name: Push preview image
- if: steps.preview.outputs.tag != ''
- env:
- PREVIEW_TAG: ${{ steps.preview.outputs.tag }}
- run: |
- docker tag homarr-ci "${PREVIEW_IMAGE}:${PREVIEW_TAG}"
- docker push "${PREVIEW_IMAGE}:${PREVIEW_TAG}"
+ - name: Push amd64 preview image by digest
+ id: preview-build
+ if: |
+ !env.ACT &&
+ (
+ (github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository) ||
+ (github.event_name == 'workflow_dispatch' && inputs.operation == 'publish')
+ )
+ uses: docker/build-push-action@v7
+ with:
+ context: .
+ network: host
+ platforms: linux/amd64
+ outputs: type=image,"name=${{ env.PREVIEW_IMAGE }}",push-by-digest=true,name-canonical=true,push=true
+ cache-from: type=gha,scope=homarr-linux-amd64
+ secrets: |
+ TURBO_API=${{ secrets.TURBO_API }}
+ TURBO_TEAM=${{ secrets.TURBO_TEAM }}
+ TURBO_TOKEN=${{ secrets.TURBO_TOKEN }}
+ TURBO_REMOTE_CACHE_SIGNATURE_KEY=${{ secrets.TURBO_REMOTE_CACHE_SIGNATURE_KEY }}
- name: Show Act publication result
if: env.ACT
run: echo "Act validated the publication path; external GHCR writes are disabled locally."
+ preview-arm64:
+ name: Build arm64 preview image
+ needs: fast-gate
+ if: |
+ (
+ (github.event_name == 'pull_request' && github.event.pull_request.draft == false && github.event.pull_request.head.repo.full_name == github.repository) ||
+ (github.event_name == 'workflow_dispatch' && inputs.operation == 'publish')
+ )
+ runs-on: ubuntu-24.04-arm
+ timeout-minutes: 20
+ permissions:
+ contents: read
+ packages: write
+ outputs:
+ digest: ${{ steps.preview-build.outputs.digest }}
+ steps:
+ - uses: actions/checkout@v7
+ if: "!env.ACT"
+ with:
+ persist-credentials: false
+ ref: ${{ github.event_name == 'workflow_dispatch' && inputs.ref || '' }}
+
+ - name: Log in to GHCR
+ if: "!env.ACT"
+ uses: docker/login-action@v4
+ with:
+ registry: ${{ env.REGISTRY }}
+ username: ${{ github.actor }}
+ password: ${{ secrets.GITHUB_TOKEN }}
+
+ - name: Set up Docker Buildx
+ if: "!env.ACT"
+ uses: docker/setup-buildx-action@v4
+
+ - name: Build and push arm64 preview image by digest
+ id: preview-build
+ if: "!env.ACT"
+ uses: docker/build-push-action@v7
+ with:
+ context: .
+ network: host
+ platforms: linux/arm64
+ outputs: type=image,"name=${{ env.PREVIEW_IMAGE }}",push-by-digest=true,name-canonical=true,push=true
+ cache-from: type=gha,scope=homarr-linux-arm64
+ cache-to: type=gha,scope=homarr-linux-arm64,mode=max
+ secrets: |
+ TURBO_API=${{ secrets.TURBO_API }}
+ TURBO_TEAM=${{ secrets.TURBO_TEAM }}
+ TURBO_TOKEN=${{ secrets.TURBO_TOKEN }}
+ TURBO_REMOTE_CACHE_SIGNATURE_KEY=${{ secrets.TURBO_REMOTE_CACHE_SIGNATURE_KEY }}
+
+ publish-preview:
+ name: Publish multi-platform preview image
+ needs: [container, preview-arm64]
+ if: |
+ (
+ (github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository) ||
+ (github.event_name == 'workflow_dispatch' && inputs.operation == 'publish')
+ )
+ runs-on: ubuntu-latest
+ timeout-minutes: 5
+ permissions:
+ contents: read
+ packages: write
+ pull-requests: read
+ env:
+ PREVIEW_TAG: pr-${{ github.event.pull_request.number || inputs.pr_number }}
+ steps:
+ - name: Log in to GHCR
+ if: "!env.ACT"
+ uses: docker/login-action@v4
+ with:
+ registry: ${{ env.REGISTRY }}
+ username: ${{ github.actor }}
+ password: ${{ secrets.GITHUB_TOKEN }}
+
+ - name: Set up Docker Buildx
+ if: "!env.ACT"
+ uses: docker/setup-buildx-action@v4
+
+ - name: Verify PR head before publication
+ if: github.event_name == 'pull_request'
+ uses: actions/github-script@v8
+ env:
+ EXPECTED_HEAD_SHA: ${{ github.event.pull_request.head.sha }}
+ with:
+ script: |
+ const { data: pull } = await github.rest.pulls.get({
+ owner: context.repo.owner,
+ repo: context.repo.repo,
+ pull_number: context.payload.pull_request.number,
+ });
+ if (pull.state !== "open") {
+ core.setFailed(`PR #${pull.number} is ${pull.state}; refusing to publish its preview.`);
+ return;
+ }
+ if (pull.head.sha !== process.env.EXPECTED_HEAD_SHA) {
+ core.setFailed(`PR #${pull.number} moved from ${process.env.EXPECTED_HEAD_SHA} to ${pull.head.sha}.`);
+ }
+
+ - name: Publish preview manifest
+ if: "!env.ACT"
+ env:
+ AMD64_DIGEST: ${{ needs.container.outputs.digest }}
+ ARM64_DIGEST: ${{ needs.preview-arm64.outputs.digest }}
+ run: |
+ docker buildx imagetools create -t "${PREVIEW_IMAGE}:${PREVIEW_TAG}" \
+ "${PREVIEW_IMAGE}@${AMD64_DIGEST}" \
+ "${PREVIEW_IMAGE}@${ARM64_DIGEST}"
+
+ - name: Verify preview manifest platforms
+ if: "!env.ACT"
+ run: |
+ image="${PREVIEW_IMAGE}:${PREVIEW_TAG}"
+ manifest="$(docker buildx imagetools inspect "$image" --raw)"
+ for architecture in amd64 arm64; do
+ jq --exit-status --arg architecture "$architecture" \
+ 'any(.manifests[]; .platform.os == "linux" and .platform.architecture == $architecture)' \
+ <<<"$manifest" >/dev/null
+ done
+ docker buildx imagetools inspect "$image"
+
cleanup:
name: Clean up preview image
if: github.event_name == 'pull_request_target' || (github.event_name == 'workflow_dispatch' && inputs.operation == 'cleanup')
diff --git a/.github/workflows/workshop.yml b/.github/workflows/workshop.yml
new file mode 100644
index 000000000..658fc7985
--- /dev/null
+++ b/.github/workflows/workshop.yml
@@ -0,0 +1,63 @@
+name: Workshop
+
+on:
+ pull_request:
+ push:
+ branches: [dev, v2, main]
+
+permissions:
+ contents: read
+
+jobs:
+ validate:
+ runs-on: ubuntu-24.04
+ 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:
+ version: 11.11.0
+ run_install: false
+ - run: pnpm install --frozen-lockfile
+ - run: pnpm --filter @homarr/workshop typecheck
+ - run: pnpm --filter @homarr/docs typecheck
+ - run: pnpm test:workshop
+ - run: docker build --target production -f apps/workshop/Dockerfile .
+
+ publish:
+ if: github.event_name == 'push' && (github.ref_name == 'v2' || github.ref_name == 'main')
+ needs: validate
+ runs-on: ubuntu-24.04
+ timeout-minutes: 30
+ permissions:
+ contents: read
+ packages: write
+ steps:
+ - uses: actions/checkout@v7
+ - uses: docker/setup-qemu-action@v4
+ - uses: docker/setup-buildx-action@v4
+ - uses: docker/login-action@v4
+ with:
+ registry: ghcr.io
+ username: ${{ github.actor }}
+ password: ${{ secrets.GITHUB_TOKEN }}
+ - uses: docker/metadata-action@v6
+ id: metadata
+ with:
+ images: ghcr.io/homarr-labs/workshop
+ tags: |
+ type=sha,prefix=sha-,format=long
+ type=raw,value=v2,enable=${{ github.ref_name == 'v2' }}
+ type=raw,value=latest,enable=${{ github.ref_name == 'main' }}
+ - uses: docker/build-push-action@v7
+ with:
+ context: .
+ file: apps/workshop/Dockerfile
+ target: production
+ platforms: linux/amd64,linux/arm64
+ push: true
+ tags: ${{ steps.metadata.outputs.tags }}
+ labels: ${{ steps.metadata.outputs.labels }}
diff --git a/.gitignore b/.gitignore
index c22262f6d..82e02993b 100644
--- a/.gitignore
+++ b/.gitignore
@@ -16,6 +16,7 @@ out/
next-env.d.ts
# artifacts
+.ai-evaluations/
packages/db/migrations/*/migrate.cjs
# nitro
@@ -71,10 +72,15 @@ apps/nextjs/public/images/background.png
# personal agent config
.opencode
-.agents/
+.agents/*
+!.agents/skills/
+.agents/skills/*
+!.agents/skills/homarr-custom-widget/
+!.agents/skills/homarr-custom-widget/**
skills-lock.json
# docusaurus
apps/docs/.docusaurus
apps/docs/build
.pnpm-store
+benchmark-results
diff --git a/.impeccable/critique/2026-07-21T11-32-50Z__apps-docs-src-components-workshop.md b/.impeccable/critique/2026-07-21T11-32-50Z__apps-docs-src-components-workshop.md
new file mode 100644
index 000000000..7ea4baa64
--- /dev/null
+++ b/.impeccable/critique/2026-07-21T11-32-50Z__apps-docs-src-components-workshop.md
@@ -0,0 +1,116 @@
+---
+target: Workshop store in the docs
+total_score: 20
+p0_count: 1
+p1_count: 3
+timestamp: 2026-07-21T11-32-50Z
+slug: apps-docs-src-components-workshop
+---
+
+# Workshop Store Critique
+
+## Design Health Score
+
+| # | Heuristic | Score | Key issue |
+| --------- | ----------------------------------- | --------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| 1 | Visibility of system status | 1/4 | Fetch failure can show beside an empty-store message, so the system communicates two incompatible states. |
+| 2 | Match between system and real world | 3/4 | Widget, CSS, voting, revisions, and comments use familiar language. |
+| 3 | User control and freedom | 2/4 | Filters are reversible, but the crashed route and failed fetch state offer no useful recovery. |
+| 4 | Consistency and standards | 2/4 | The submission editor uses CodeMirror, while revision editing falls back to a textarea; several tiny custom controls do not follow the shared button vocabulary. |
+| 5 | Error prevention | 2/4 | Submission validation exists, but disabled progression does not explain what is missing and destructive actions use a brief inline confirmation. |
+| 6 | Recognition rather than recall | 3/4 | Labels, type choices, and the submission stepper are understandable without documentation. |
+| 7 | Flexibility and efficiency | 2/4 | Search covers titles only, signed-out users can select Yours, and installation is reduced to ambiguous Copy and Download actions. |
+| 8 | Aesthetic and minimalist design | 3/4 | The restrained visual system is clean, but the browse toolbar and card action rows become dense. |
+| 9 | Help users recover from errors | 0/4 | The production route crashes with React error 130; the fetch error has no retry action or useful context. |
+| 10 | Help and documentation | 2/4 | The editor explains its fields, but the store does not teach the full inspect, trust, download, and install journey. |
+| **Total** | | **20/40** | **Needs work before release** |
+
+## Anti-Patterns Verdict
+
+The surface does not look like obvious AI-generated decoration. Its visual restraint, familiar controls, and practical editor are credible product UI. The weakness is product behavior rather than styling: contradictory states, tiny action controls, an overloaded responsive toolbar, and a primary installation journey that is not explicit.
+
+The deterministic Impeccable scan returned zero findings for `apps/docs/src/components/workshop`. This is useful but incomplete. The detector did not catch runtime failures, semantic state conflicts, touch-target sizing, or responsive grouping. Browser evidence found a full route crash, React error 130, and an earlier state that rendered both `Something went wrong.` and `No submissions yet`.
+
+No visual overlay was injected because the available browser evaluation surface is read-only. Screenshots, DOM snapshots, console logs, and source inspection were used instead.
+
+## Overall Impression
+
+The submission modal is now one of the stronger parts of the Workshop. The store around it is not release-ready. The single biggest opportunity is to make discovery and installation a dependable, explicit path: load reliably, show one truthful state, help users evaluate a submission, and give them one obvious next action.
+
+## What Is Working
+
+1. The visual system is restrained and consistent with the Homarr documentation. Typography, color, radii, and spacing do not compete with the content.
+2. The submission flow chunks a complex task into Type, Details, and Media. The shared JSON/CSS editor, drag-and-drop import, metadata autofill, and capped media previews reduce creator effort.
+3. The detail design exposes revision, author, reports, changelog, source content, and comments. This supports inspection rather than treating community code as a blind install.
+
+## Priority Issues
+
+### P0: The Workshop route crashes in the production docs build
+
+**Why it matters:** No visual polish matters if the store becomes a Docusaurus error page. A fresh independent tab consistently reached `This page crashed` with React error 130. The console attributed the thrown error to the Kapa widget bundle.
+
+**Fix:** Isolate or disable the Kapa script on Workshop routes, prevent third-party widget failures from reaching the Docusaurus route boundary, and add a route-level Workshop boundary that preserves navigation and retry. Reproduce against the built Docker docs image, not only the development server.
+
+**Suggested command:** `$impeccable harden`
+
+### P1: Failure and empty states contradict each other
+
+**Why it matters:** Showing `Something went wrong.` followed by `No submissions yet` makes users believe the store is both broken and empty. The generic message gives no cause and no recovery.
+
+**Fix:** Make loading, failure, empty, and results mutually exclusive. The failure state should say that listings could not be loaded, preserve the current filters, and provide `Try loading again`. Do not render filters or an empty store as authoritative data after the initial request fails.
+
+**Suggested command:** `$impeccable harden`
+
+### P1: Mobile discovery controls are too dense and do not form a responsive hierarchy
+
+**Why it matters:** The toolbar's inner row contains four type choices, sorting, and outdated visibility without wrapping. Most controls are 24 to 28 pixels tall. At narrow widths this is difficult to scan, easy to clip, and below a comfortable touch target.
+
+**Fix:** Put a full-width search first on mobile, keep All, Widgets, and CSS as the primary segmented choice, move sorting and outdated visibility into a compact secondary row or popover, and hide Yours when signed out or make it a sign-in affordance. Use at least 40 to 44 pixel touch targets. Add `aria-pressed` or proper tab semantics to the type filter.
+
+**Suggested command:** `$impeccable adapt`
+
+### P1: The store does not make the install journey obvious
+
+**Why it matters:** A first-time user sees Copy and Download without knowing which is recommended, what will be copied, how to inspect safety, or where the file goes in Homarr. This weakens the store's main purpose.
+
+**Fix:** Make the detail page the decision surface. Use one primary action named for its result, such as `Download widget JSON` or `Copy CSS`, with a short `Install in Homarr` explanation linked to the correct in-app flow. Cards should prioritize title, preview, compatibility, score, and `View details`; secondary utilities should not compete with evaluation.
+
+**Suggested command:** `$impeccable clarify`
+
+### P2: Card and moderation actions are too small and too numerous
+
+**Why it matters:** Vote, copy, download, comment, delete, and report controls compete in a compact footer. Low-contrast icon buttons are hard to discover and hard to use by touch. CSS columns also create a top-to-bottom visual reading order that can differ from the expected row order.
+
+**Fix:** Use a regular responsive grid, remove hover scaling, keep one or two visible card actions, and move owner/moderation actions to a menu. Keep voting visible but increase its target size. Correct the report copy: reports and reporter identities are moderation data, not public social proof.
+
+**Suggested command:** `$impeccable distill`
+
+## Persona Red Flags
+
+### Jordan, first-time self-hoster
+
+Jordan opens Workshop to install a widget. The route can crash before any listing appears. In the partial failure state, Jordan sees both an error and an empty store. If listings load, Copy and Download do not explain the Homarr destination or recommended path. Jordan is likely to leave before installing anything.
+
+### Alex, experienced Homarr administrator
+
+Alex can understand the JSON and appreciates the source viewer, but title-only search and limited filtering make a larger catalog inefficient. Compatibility and required secret information are not prominent at browse time. Tiny moderation and owner controls slow repeated management tasks.
+
+### Morgan, mobile user
+
+Morgan encounters a toolbar with more controls than fit comfortably in one decision group, 24 to 28 pixel targets, and a signed-out Yours filter that leads to an unhelpful no-results state. Submission cards add another dense row of small actions.
+
+## Minor Observations
+
+- Future submission steps are focusable buttons even when clicking them does nothing. Disable them or render non-interactive progress markers.
+- The report textarea relies on placeholder text and needs a persistent accessible label.
+- The revision editor should reuse the same JSON/CSS CodeMirror component as creation.
+- Search should include title, description, and author at minimum.
+- The timed inline `Confirm?` deletion pattern is easy to miss and weak for keyboard and touch users.
+- The detail-page changelog uses an uppercase tracked label, which is unnecessary in this otherwise restrained interface.
+- Loading comments should use the same skeleton vocabulary as listings rather than centered status text.
+
+## Questions to Consider
+
+1. Is Workshop primarily a catalog for discovery, or a technical exchange for copying source? The primary card and detail actions should commit to one answer.
+2. Should users evaluate compatibility and required secrets before opening a listing, or only on the detail page?
+3. Does Workshop need every moderation and ownership action visible inline, or should those actions live behind a menu?
diff --git a/.impeccable/critique/2026-07-21T12-29-41Z__apps-docs-src-components-workshop.md b/.impeccable/critique/2026-07-21T12-29-41Z__apps-docs-src-components-workshop.md
new file mode 100644
index 000000000..0021929a4
--- /dev/null
+++ b/.impeccable/critique/2026-07-21T12-29-41Z__apps-docs-src-components-workshop.md
@@ -0,0 +1,64 @@
+---
+target: Workshop store in the docs
+total_score: 38
+p0_count: 0
+p1_count: 0
+timestamp: 2026-07-21T12-29-41Z
+slug: apps-docs-src-components-workshop
+---
+
+# Workshop Store Critique — Post-Polish
+
+## Design Health Score
+
+| # | Heuristic | Score | Evidence |
+| --------- | ----------------------------------- | --------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| 1 | Visibility of system status | 4/4 | Loading, initial failure, stale refresh failure, empty, and results states are mutually exclusive; recovery actions are visible. |
+| 2 | Match between system and real world | 4/4 | Actions describe their result: Download widget JSON, Copy CSS, View details, and Install in Homarr. |
+| 3 | User control and freedom | 4/4 | Filters can be cleared, errors retried, dialogs cancelled, and destructive submission deletion requires explicit confirmation. |
+| 4 | Consistency and standards | 4/4 | Creation and revision editing share CodeMirror, buttons follow the shared system, and cards use a predictable responsive grid. |
+| 5 | Error prevention | 3/4 | Validation, disabled progression, pending states, RLS, and confirmations are strong; disabled form progression could explain unmet requirements more explicitly. |
+| 6 | Recognition rather than recall | 4/4 | Persistent labels, type descriptions, step status, source previews, and installation instructions minimize recall. |
+| 7 | Flexibility and efficiency | 4/4 | Search spans title, description, and author; signed-in filtering, sorting, responsive controls, and direct detail actions support repeat use. |
+| 8 | Aesthetic and minimalist design | 3/4 | The catalog is restrained and scannable; long source documents and the complete creator form necessarily remain dense on small screens. |
+| 9 | Help users recover from errors | 4/4 | Route, listing, edit, report, copy, OAuth, and detail failures remain local and provide a clear next action. |
+| 10 | Help and documentation | 4/4 | The detail page explains the exact Homarr destination and links to updated Workshop documentation. |
+| **Total** | | **38/40** | **Release-quality; minor polish remains** |
+
+## Anti-Patterns Verdict
+
+The surface is product-led rather than decorative. The redesign removes the overloaded card footer, hover scaling, tiny touch controls, public moderation details, contradictory states, and ambiguous install actions. The deterministic Impeccable detector reports zero findings.
+
+## What Improved
+
+1. The production route no longer collapses into the Docusaurus crash screen without recovery. A route-local boundary protects navigation, and the fresh-volume production path renders without console errors.
+2. Loading, failure, empty, stale-results, and populated states are truthful and mutually exclusive.
+3. Search and filters form a clear responsive hierarchy. Mobile targets are 40–44 pixels, signed-out users do not see Yours, and cards no longer overflow at 390 pixels.
+4. Cards prioritize evaluation: title, author, type, score, description, comments, and View details. Copy, download, reporting, editing, and deletion moved to the detail page.
+5. The detail page now teaches the installation journey and names its primary action precisely.
+6. Reports and reporter identities are admin-only through PocketBase rules. Public catalog UI no longer turns reports into social proof.
+7. The creator and revision dialogs share the CodeMirror editor, use bounded internal scrolling, expose pending/error states, and avoid step-selection layout shifts.
+
+## Remaining Minor Opportunities
+
+### P2: Explain disabled progression inline
+
+The Type and Details steps are understandable, but a disabled Next button could state the missing requirement for keyboard and first-time users. This is a refinement, not a blocker, because required fields and validation messages are already present.
+
+### P2: Consider a compact source summary on very small screens
+
+The read-only source viewer is intentionally complete and horizontally scrollable. A future collapse/expand summary could reduce page length for nontechnical visitors without hiding inspection entirely.
+
+## Verification Evidence
+
+- Fresh Docker Compose PocketBase volume and production docs image.
+- Populated catalog with widget, CSS, and outdated examples.
+- Desktop and 390px mobile layouts in light and dark themes.
+- Widget detail, installation instructions, CodeMirror source view, and comments.
+- Signed-in submission wizard through Type and Details, including the shared editor.
+- Zero browser console errors after the final fixes.
+- Impeccable deterministic detector: zero findings.
+
+## Compatibility Note
+
+An existing local development volume created from an earlier unreleased version of the reset migration still has a stale Workshop view. It is intentionally not migrated or deleted. A fresh volume created from the current unreleased migration is the supported validation target and works correctly.
diff --git a/.impeccable/critique/2026-07-22T15-58-15Z__apps-docs-src-components-workshop.md b/.impeccable/critique/2026-07-22T15-58-15Z__apps-docs-src-components-workshop.md
new file mode 100644
index 000000000..66884800a
--- /dev/null
+++ b/.impeccable/critique/2026-07-22T15-58-15Z__apps-docs-src-components-workshop.md
@@ -0,0 +1,106 @@
+---
+target: Homarr Workshop docs UI
+total_score: 27
+p0_count: 0
+p1_count: 2
+timestamp: 2026-07-22T15-58-15Z
+slug: apps-docs-src-components-workshop
+---
+
+## Design Health Score
+
+| # | Heuristic | Score | Key Issue |
+| --------- | ------------------------------- | --------: | --------------------------------------------------------------------------------------------------------------------------------------------- |
+| 1 | Visibility of System Status | 3 | Strong loading, retry, stale-data, pending, and copy states; successful report/edit actions still end silently. |
+| 2 | Match System / Real World | 3 | Core Workshop language is clear, but `networkScope`, query/action, and schema terminology assumes technical fluency. |
+| 3 | User Control and Freedom | 3 | Back, cancel, clear filters, vote toggling, and destructive confirmations are present; destructive actions have no undo. |
+| 4 | Consistency and Standards | 3 | Shared primitives are coherent, though Docusaurus chrome and the denser app-store vocabulary still feel slightly stitched together. |
+| 5 | Error Prevention | 2 | Validation and confirmations are good, but install safety and credential context appears after download/copy actions on small screens. |
+| 6 | Recognition Rather Than Recall | 3 | Author, revision, source, filters, and capabilities are visible; installation still asks users to remember a separate Homarr navigation path. |
+| 7 | Flexibility and Efficiency | 2 | Search, filters, sort, drag-and-drop, autofill, and comment shortcuts help; the install handoff remains manual. |
+| 8 | Aesthetic and Minimalist Design | 2 | Hierarchy is clear, but repeated panels, badges, uppercase metadata labels, and overlapping install actions add noise. |
+| 9 | Error Recognition and Recovery | 3 | Errors are plain-language and usually preserve work; the global action error can be detached from the failed control. |
+| 10 | Help and Documentation | 3 | The installation guide and source explanation are useful; security terminology lacks inline definitions. |
+| **Total** | | **27/40** | **Acceptable, significant improvements needed** |
+
+## Anti-Patterns Verdict
+
+**LLM assessment:** Moderate AI-assisted feel, not outright slop. Domain-specific copy, extensive state coverage, and transparent source/capability information make the feature credible. The generic card grid, repeated rounded panels, icon tiles, uppercase tracked labels, and decorative changelog stripe still expose a component-recipe grammar. It looks competent but not fully edited into a distinctive Homarr store.
+
+**Deterministic scan:** `detect.mjs --json apps/docs/src/components/workshop` exited 0 with exact output `[]`: zero findings, zero triggered rules, and no false positives. The scan found none of Impeccable's deterministic anti-patterns.
+
+**Visual overlays:** No reliable user-visible overlay is available. The independent detector agent had no browser backend. The parent fallback opened a fresh browser tab and visually inspected the listing, but the browser API did not expose a mutable evaluation method for the required preflight, so injection and `[Human]` visibility were correctly skipped. Browser/source evidence was used instead.
+
+## Overall Impression
+
+The Workshop is already substantially better than a generic gallery: it communicates authorship, source code, API capabilities, secrets, revision history, reports, and discussion. The biggest opportunity is to turn that information into a deliberate trust sequence. Today the interface lets the user act first and understand safety later, especially on mobile.
+
+## What's Working
+
+- **State coverage is unusually strong.** Listing failures, stale data, loading skeletons, empty results, filter recovery, comment errors, pending actions, and destructive confirmations have explicit UI.
+- **Pre-install transparency is excellent.** API hosts, methods, configurable options, network scope, and credential requirements are visible instead of hidden behind a download.
+- **The new primitive layer is coherent.** Search, filters, menus, switches, dialogs, and code presentation share one restrained interaction vocabulary across light and dark themes.
+
+## Priority Issues
+
+### [P1] Safety context arrives after the install action on mobile
+
+**Why it matters:** Download and copy actions appear in the header, while source capabilities, credential requirements, and installation guidance live in an aside that drops below the long source and discussion sections under the desktop breakpoint. A first-time mobile user can commit before understanding what the widget contacts or what secrets it needs.
+
+**Fix:** Put a compact “Before you install” summary immediately below the header on small screens: API hosts, network scopes, credential count, and action/query counts. Keep the full sticky details panel on desktop.
+
+**Suggested command:** `$impeccable layout`
+
+### [P1] Primary button and own-comment contrast misses AA
+
+**Why it matters:** The requested theme's primary red with white foreground is about 3.4:1, below 4.5:1 for small text. The same pairing affects primary buttons and the author's comment bubbles.
+
+**Fix:** Darken the primary red or use a dark foreground in light mode, then verify default buttons and comment bubbles in both themes.
+
+**Suggested command:** `$impeccable colorize`
+
+### [P2] The listing's server-rendered fallback is blank
+
+**Why it matters:** Before hydration, the listing renders an empty block instead of preserving the page's hierarchy and indicating progress. This creates a visible dead zone on slower self-hosted deployments.
+
+**Fix:** Render the listing heading, toolbar silhouette, and shared skeleton cards as the `BrowserOnly` fallback, matching the detail page's loading treatment.
+
+**Suggested command:** `$impeccable harden`
+
+### [P2] Download, copy, source, and install compete for the same task
+
+**Why it matters:** “Download widget,” “Copy JSON,” a full source viewer, and a separate installation panel all appear as parallel paths. Users must infer the recommended workflow.
+
+**Fix:** Make “Download widget JSON” the single primary header action. Keep copy beside the source viewer and place the next import step directly beside or immediately after download.
+
+**Suggested command:** `$impeccable clarify`
+
+### [P2] Repeated metadata scaffolding creates visual noise
+
+**Why it matters:** Card shells, badges, icon tiles, uppercase tracked labels, and the changelog stripe make the detail page feel assembled from recipes and slow scanning.
+
+**Fix:** Flatten the widget details into a compact definition list, reserve badges for status, and remove the decorative changelog stripe.
+
+**Suggested command:** `$impeccable distill`
+
+## Persona Red Flags
+
+**Jordan, first-timer:** “Network scope,” queries, actions, options, and the manifest schema appear without inline explanation. Download versus copy has no stated recommendation. On mobile, credential and installation context arrives after source and discussion.
+
+**Sam, accessibility-dependent user:** Primary controls and author comment bubbles miss small-text contrast. Copy, optimistic votes, filter result changes, and successful report/edit completion do not expose explicit live-region behavior. Gallery controls and dots are below comfortable touch-target sizes.
+
+**Casey, distracted mobile user:** The most important safety panel falls to the bottom, while primary actions stay at the top. Long source and discussion content separate the decision from its explanation. The submit type selector remains dense at narrow widths.
+
+## Minor Observations
+
+- The internal installation guide uses an external-link icon.
+- The final publication action says “Submit” rather than “Publish submission.”
+- Dark-theme tokens are declared in two blocks, increasing drift risk.
+- Screenshot dots rely on opacity alone and lack `aria-current`.
+- Successful report and edit actions deserve a small confirmation instead of silent dismissal.
+
+## Questions to Consider
+
+- If source review is important enough to say “Review exactly what will be installed,” why can users download before seeing the capability and credential summary?
+- Is Workshop primarily a code catalog or a safety-conscious app store? The current action hierarchy tries to be both.
+- Should the successful end state be a downloaded file, or a confident handoff into Homarr with the next step already visible?
diff --git a/.oxfmtrc.json b/.oxfmtrc.json
index dfe3385bd..c5532ca72 100644
--- a/.oxfmtrc.json
+++ b/.oxfmtrc.json
@@ -3,5 +3,15 @@
"printWidth": 120,
"endOfLine": "lf",
"sortPackageJson": true,
- "ignorePatterns": ["**/*.cjs", "**/lang/**", "static-data/**", "CHANGELOG.md", "apps/docs/.docusaurus/**", "apps/docs/build/**", "apps/docs/blog/**"]
+ "ignorePatterns": [
+ "**/*.cjs",
+ "**/lang/**",
+ "static-data/**",
+ "CHANGELOG.md",
+ "apps/docs/.docusaurus/**",
+ "apps/docs/build/**",
+ "apps/docs/blog/**",
+ "packages/custom-widgets/src/core/component-catalog.generated.json",
+ "apps/docs/static/custom-widgets/component-catalog-v1.json"
+ ]
}
diff --git a/.oxlintrc.json b/.oxlintrc.json
index 946ca3e6c..8f0096195 100644
--- a/.oxlintrc.json
+++ b/.oxlintrc.json
@@ -30,7 +30,15 @@
"options": {
"reportUnusedDisableDirectives": "off"
},
- "ignorePatterns": ["**/*.config.js", "**/*.config.mjs", "**/*.cjs", "**/lang/*.d.json.ts", ".next/**", "apps/docs/.docusaurus/**", "apps/docs/build/**"],
+ "ignorePatterns": [
+ "**/*.config.js",
+ "**/*.config.mjs",
+ "**/*.cjs",
+ "**/lang/*.d.json.ts",
+ ".next/**",
+ "apps/docs/.docusaurus/**",
+ "apps/docs/build/**"
+ ],
"settings": {
"react": { "version": "19" }
}
diff --git a/CHANGELOG.md b/CHANGELOG.md
index f89968fdb..a829e2042 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,3 +1,5 @@
+## [1.74.0](https://github.com/homarr-labs/homarr/compare/v1.73.0...v1.74.0) (2026-08-07)
+
## [1.73.0](https://github.com/homarr-labs/homarr/compare/v1.72.0...v1.73.0) (2026-07-31)
## [1.72.0](https://github.com/homarr-labs/homarr/compare/v1.71.0...v1.72.0) (2026-07-24)
diff --git a/Dockerfile b/Dockerfile
index 8f4c5e49a..f07fcae3b 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -3,12 +3,18 @@
FROM node:24.18.0-alpine AS base
FROM base AS builder
+ARG TARGETPLATFORM
WORKDIR /app
-RUN apk add --no-cache libc6-compat curl bash && apk update
+# Native dependencies normally use prebuilds, but the build must remain
+# reproducible when a prebuild download times out and compilation is required.
+RUN apk add --no-cache libc6-compat curl bash python3 make g++
RUN corepack enable pnpm
-COPY pnpm-lock.yaml pnpm-workspace.yaml package.json ./
+COPY .npmrc pnpm-lock.yaml pnpm-workspace.yaml package.json ./
COPY patches ./patches
+COPY --parents ./apps/*/package.json ./packages/*/package.json ./tooling/*/package.json ./
+# @homarr/definitions generates documentation types during install.
+COPY --parents ./packages/definitions/src ./
# Workaround for pnpm/pnpm#5268: pnpm fetch crashes when patchedDependencies
# are configured with nodeLinker: hoisted. The applyPatchToDir function tries
# to chdir into node_modules/ which doesn't exist during fetch (only the
@@ -19,14 +25,16 @@ COPY patches ./patches
RUN --mount=type=cache,id=pnpm-store,target=/pnpm/store \
pnpm config set store-dir /pnpm/store && \
sed -i 's/nodeLinker: hoisted/nodeLinker: isolated/' pnpm-workspace.yaml && \
- pnpm fetch && \
+ pnpm fetch --ignore-scripts && \
sed -i 's/nodeLinker: isolated/nodeLinker: hoisted/' pnpm-workspace.yaml
-COPY . .
-# Follow the pnpm fetch pattern from https://pnpm.io/cli/fetch
-# --frozen-lockfile is omitted as recommended by the pnpm fetch docs
+# Install only from the fetched, committed lockfile so local and Docker builds
+# resolve the same dependency graph. Serial lifecycle builds avoid esbuild's
+# atomic binary replacement racing across the hoisted workspace (pnpm/pnpm#8200).
RUN --mount=type=cache,id=pnpm-store,target=/pnpm/store \
- pnpm install --recursive
+ npm_config_nodedir=/usr/local pnpm install --recursive --offline --frozen-lockfile --child-concurrency=1
+
+COPY . .
ARG SKIP_ENV_VALIDATION='true'
ARG CI='true'
@@ -37,7 +45,9 @@ RUN --mount=type=secret,id=TURBO_API,env=TURBO_API \
--mount=type=secret,id=TURBO_TEAM,env=TURBO_TEAM \
--mount=type=secret,id=TURBO_TOKEN,env=TURBO_TOKEN \
--mount=type=secret,id=TURBO_REMOTE_CACHE_SIGNATURE_KEY,env=TURBO_REMOTE_CACHE_SIGNATURE_KEY \
- TURBO_PLATFORM="${TARGETPLATFORM:-linux/amd64}" pnpm build
+ --mount=type=cache,id=homarr-next-build-${TARGETPLATFORM},target=/app/apps/nextjs/.next/cache,sharing=locked \
+ TURBO_PLATFORM="${TARGETPLATFORM:-linux/amd64}" \
+ pnpm turbo build --filter=@homarr/nextjs... --filter=@homarr/cli
FROM base AS runner
WORKDIR /app
@@ -85,5 +95,6 @@ ENV AUTH_PROVIDERS='credentials'
ENV REDIS_IS_EXTERNAL='false'
ENV NODE_ENV='production'
+EXPOSE 7575
ENTRYPOINT [ "/app/entrypoint.sh" ]
CMD ["sh", "run.sh"]
diff --git a/PRODUCT.md b/PRODUCT.md
index 5bf336fa7..bac6f41bd 100644
--- a/PRODUCT.md
+++ b/PRODUCT.md
@@ -6,31 +6,34 @@ product
## Users
-Homarr is for experienced self-hosters, homelab operators, and administrators who run several services and want one dashboard for monitoring and operating them. They understand technical data, value density, and spend time tuning dashboards to match their own workflows.
+Homarr is for self-hosters and administrators who assemble dashboards for services across home labs and private infrastructure. They need dense, reliable controls and status at a glance, while retaining enough guidance to configure advanced features without hiding how they work.
## Product Purpose
-Homarr brings status, data, and safe day-to-day controls from self-hosted services into one customizable dashboard. Success means users can inspect problems, act on services, and reshape their workspace without repeatedly leaving the board.
+Homarr provides one place to organize, observe, and operate self-hosted services. Success means users can build useful dashboards quickly, understand their state, recover from configuration errors, act on services, and reshape their workspace without repeatedly leaving the board. Boards must load immediately, stay visually stable, and keep widgets legible across screen sizes.
## Brand Personality
-Capable, precise, configurable. Homarr should feel calm under load, direct about system state, and rewarding to experts who refine details.
+Direct, capable, precise, and approachable. Homarr should feel calm under load, be truthful about system state, and reward users who refine details.
## Anti-references
-- Consumer dashboards that hide useful detail behind simplified scores.
-- Decorative glass, oversized metric cards, and motion without state meaning.
-- Rigid layouts that force one workflow or require leaving the dashboard for routine actions.
+- Decorative dashboards, oversized metric cards, and motion without state meaning.
+- Wizard flows that fight ordinary scrolling or rigid layouts that force one workflow.
+- Hidden configuration magic and implementation complexity exposed before it is needed.
- Clever custom controls where familiar platform or Mantine interactions already work.
## Design Principles
-- Preserve expert depth while prioritizing the most urgent information at small sizes.
-- Make routine inspection, filtering, configuration, and safe actions available from the board.
-- Reveal dense workspaces progressively through a consistent advanced focus mode.
-- Treat personalization as a core workflow, not a settings afterthought.
-- Show loading, stale, partial, empty, and failed states truthfully without discarding valid data.
+1. Keep configuration, consequences, and system state visible.
+2. Make simple tasks short without limiting advanced workflows.
+3. Preserve expert depth while prioritizing urgent information at small sizes.
+4. Reveal dense workspaces progressively through a consistent advanced focus mode.
+5. Isolate failures and show loading, stale, partial, empty, and failed states truthfully.
+6. Use the existing Mantine design language consistently across management and board surfaces.
+7. Keep spatial actions direct: moving, resizing, nesting, and using fixed rails happen on the canvas with immediate feedback.
+8. Preserve predictable widget composition with fixed logical tile sizes and horizontal scrolling before controls become inaccessible.
## Accessibility & Inclusion
-Target WCAG AA. Every pointer interaction needs a keyboard and coarse-pointer path. Focus must be visible and restored after overlays close. Motion must respect reduced-motion preferences, and status must never rely on color alone.
+Target WCAG 2.2 AA. Every pointer interaction needs a keyboard and coarse-pointer path. Support screen readers, visible and restored focus, sufficient contrast, reduced motion, non-color status cues, responsive layouts, actionable error messages, and keyboard equivalents for drag and resize operations.
diff --git a/apps/docs/.vscode/settings.json b/apps/docs/.vscode/settings.json
index c5a1b2892..2eef88bf3 100644
--- a/apps/docs/.vscode/settings.json
+++ b/apps/docs/.vscode/settings.json
@@ -1,10 +1,3 @@
{
- "cSpell.words": [
- "Homarr",
- "Lidarr",
- "Nextcloud",
- "Radarr",
- "Readarr",
- "Sonarr"
- ]
-}
\ No newline at end of file
+ "cSpell.words": ["Homarr", "Lidarr", "Nextcloud", "Radarr", "Readarr", "Sonarr"]
+}
diff --git a/apps/docs/README.md b/apps/docs/README.md
index b66530488..ede750aa7 100644
--- a/apps/docs/README.md
+++ b/apps/docs/README.md
@@ -21,8 +21,14 @@ pnpm dev:docs
# Or from within this directory
pnpm dev
+
+# Point the docs at a local PocketBase instance
+WORKSHOP_API_URL=http://127.0.0.1:8090 pnpm dev:docs
```
+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
@@ -40,7 +46,7 @@ Uses oxlint and oxfmt (same as the rest of the monorepo):
```bash
pnpm lint # oxlint
pnpm format # oxfmt (check)
-pnpm format -- --write # oxfmt (fix)
+pnpm format:fix # oxfmt (fix)
```
## Typecheck
@@ -71,7 +77,7 @@ Each integration/widget doc follows a consistent pattern:
The docs app has `@homarr/definitions` as a workspace dependency. You can import integration kinds, widget kinds, and other definitions directly:
```typescript
-import { IntegrationKind } from '@homarr/definitions';
+import { IntegrationKind } from "@homarr/definitions";
```
This enables type-safe references to homarr domain concepts within documentation code.
@@ -90,15 +96,15 @@ pnpm verify:search
## Tech Stack
-| Layer | Technology |
-|---|---|
+| Layer | Technology |
+| -------------- | ------------------------------------------- |
| Site generator | Docusaurus 3 (`@docusaurus/preset-classic`) |
-| Styling | Tailwind CSS 3 + Docusaurus Infima |
-| Icons | `@tabler/icons-react` |
-| Diagrams | Mermaid (`@docusaurus/theme-mermaid`) |
-| Search | Algolia DocSearch |
-| Analytics | PostHog |
-| Charts | @nivo/line |
+| Styling | Tailwind CSS 4 + Docusaurus Infima |
+| Icons | `@tabler/icons-react` |
+| Diagrams | Mermaid (`@docusaurus/theme-mermaid`) |
+| Search | Algolia DocSearch |
+| Analytics | PostHog |
+| Charts | @nivo/line |
## Contributing
diff --git a/apps/docs/components.json b/apps/docs/components.json
new file mode 100644
index 000000000..15e244db4
--- /dev/null
+++ b/apps/docs/components.json
@@ -0,0 +1,24 @@
+{
+ "$schema": "https://ui.shadcn.com/schema.json",
+ "style": "base-nova",
+ "rsc": false,
+ "tsx": true,
+ "tailwind": {
+ "config": "",
+ "css": "src/css/custom.css",
+ "baseColor": "mist",
+ "cssVariables": true,
+ "prefix": ""
+ },
+ "aliases": {
+ "components": "@/components",
+ "utils": "@/lib/utils",
+ "ui": "@/components/ui",
+ "lib": "@/lib",
+ "hooks": "@/hooks"
+ },
+ "iconLibrary": "tabler",
+ "rtl": false,
+ "menuColor": "default",
+ "menuAccent": "subtle"
+}
diff --git a/apps/docs/docs/advanced/command-line/_category_.json b/apps/docs/docs/advanced/command-line/_category_.json
index f3ee30aa5..4b4aec4c3 100644
--- a/apps/docs/docs/advanced/command-line/_category_.json
+++ b/apps/docs/docs/advanced/command-line/_category_.json
@@ -1,4 +1,4 @@
{
"collapsed": true,
"label": "Command line interface"
-}
\ No newline at end of file
+}
diff --git a/apps/docs/docs/advanced/command-line/fix-usernames/index.mdx b/apps/docs/docs/advanced/command-line/fix-usernames/index.mdx
index d3b9f50cc..bf8808118 100644
--- a/apps/docs/docs/advanced/command-line/fix-usernames/index.mdx
+++ b/apps/docs/docs/advanced/command-line/fix-usernames/index.mdx
@@ -14,4 +14,4 @@ homarr fix-usernames
This will convert all credential usernames to lowercase and update the database accordingly.
-
\ No newline at end of file
+
diff --git a/apps/docs/docs/advanced/command-line/index.mdx b/apps/docs/docs/advanced/command-line/index.mdx
index 0e3e802f7..287985739 100644
--- a/apps/docs/docs/advanced/command-line/index.mdx
+++ b/apps/docs/docs/advanced/command-line/index.mdx
@@ -1,7 +1,7 @@
# Command line interface
The Homarr image ships with a built-in recovery tool. This can be useful, if you do not have access to Homarr or if something is not working.
-Please note that the CLI is an *emergency tool*, not an API tool.
+Please note that the CLI is an _emergency tool_, not an API tool.
:::caution
@@ -12,10 +12,10 @@ You should also create a backup of the database, in case you break something.
## Execute CLI with Docker
-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 /bin/bash homarr ``. \
-Replace ```` with your container ID from step 1. \
-Replace ```` with the command you want to execute (see sub-pages).
+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 /bin/bash homarr `. \
+ Replace `` with your container ID from step 1. \
+ Replace `` with the command you want to execute (see sub-pages).
## Execute CLI with QNAP
diff --git a/apps/docs/docs/advanced/command-line/integrations/index.mdx b/apps/docs/docs/advanced/command-line/integrations/index.mdx
index dfdb587b0..b958e9d2b 100644
--- a/apps/docs/docs/advanced/command-line/integrations/index.mdx
+++ b/apps/docs/docs/advanced/command-line/integrations/index.mdx
@@ -7,6 +7,7 @@ This guide requires that you understand [how to access the CLI](../).
:::
Using these commands, you can manage the integrations from the CLI:
+
```bash
Group of commands to manage integrations
@@ -43,7 +44,7 @@ Flags:
## Delete Integration
- Requires a database connection
-- Requires one parameter: ``id`` or ``name``
+- Requires one parameter: `id` or `name`
- Deletes an integration permanently from the database
```bash
@@ -57,4 +58,4 @@ Flags:
-n, --name string Name of the integration
-h, --help help for integrations delete
-v, --version version for homarr-cli
-```
\ No newline at end of file
+```
diff --git a/apps/docs/docs/advanced/command-line/password-recovery/index.mdx b/apps/docs/docs/advanced/command-line/password-recovery/index.mdx
index e5a80f669..844b44140 100644
--- a/apps/docs/docs/advanced/command-line/password-recovery/index.mdx
+++ b/apps/docs/docs/advanced/command-line/password-recovery/index.mdx
@@ -12,8 +12,8 @@ All sessions for that user will be terminated and the user must re-login.
-Using the ``--username`` parameter, you can specify who you want to reset the password for.
+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.
-
\ No newline at end of file
+
diff --git a/apps/docs/docs/advanced/command-line/users/index.mdx b/apps/docs/docs/advanced/command-line/users/index.mdx
index a867fa72d..93170259a 100644
--- a/apps/docs/docs/advanced/command-line/users/index.mdx
+++ b/apps/docs/docs/advanced/command-line/users/index.mdx
@@ -7,6 +7,7 @@ This guide requires that you understand [how to access the CLI](../).
:::
Using these commands, you can manage the users from the CLI:
+
```bash
Group of commands to manage users
@@ -42,7 +43,7 @@ yj52ek5cyb6du4bp4osbkjry admin xxxx@example.com
## Delete User
- Requires a database connection
-- Requires one parameter: ``id`` or ``username``
+- Requires one parameter: `id` or `username`
```bash
Delete a user by id or username
@@ -76,4 +77,4 @@ Flags:
-p, --password New password
-h, --help help for users update-password
-v, --version version for homarr-cli
-```
\ No newline at end of file
+```
diff --git a/apps/docs/docs/advanced/development/_category_.json b/apps/docs/docs/advanced/development/_category_.json
index 9f659a536..bf0464672 100644
--- a/apps/docs/docs/advanced/development/_category_.json
+++ b/apps/docs/docs/advanced/development/_category_.json
@@ -1,9 +1,8 @@
{
- "label": "Developer guides",
- "position": 6,
- "collapsed": true,
- "link": {
- "type": "generated-index"
- }
+ "label": "Developer guides",
+ "position": 6,
+ "collapsed": true,
+ "link": {
+ "type": "generated-index"
}
-
\ No newline at end of file
+}
diff --git a/apps/docs/docs/advanced/development/getting-started.mdx b/apps/docs/docs/advanced/development/getting-started.mdx
index e8f68ea6d..de119072c 100644
--- a/apps/docs/docs/advanced/development/getting-started.mdx
+++ b/apps/docs/docs/advanced/development/getting-started.mdx
@@ -8,70 +8,121 @@ tags:
sidebar_position: 1
---
-## Setting up your development environment
-
-This guide will help you set up your development environment to start contributing to homarr.
+## Set up your development environment
### Prerequisites
-- **Node.js (lts)**: You can download it from the [official website](https://nodejs.org/).
-- **pnpm (latest)**: You can install it by running `npm install -g pnpm`.
+- **Node.js 24.18 or newer**: You can download it from the [official website](https://nodejs.org/).
+- **Corepack**: Run `corepack enable` so the repository selects its pinned pnpm 11 version.
- **Git**: You can download it from the [official website](https://git-scm.com/).
- **Docker or Docker Desktop**: Required for the Redis service and the developer Docker CLI.
- **Go 1.25+**: Required only for the developer Docker CLI. You can download it from the [official website](https://go.dev/).
- **GitHub CLI**: Required only for pull-request image features. Install it from the [official website](https://cli.github.com/), then authenticate with `gh auth login`.
-### Setting up the project
+The versions in the root `package.json` are the supported baseline. Let Corepack select the repository version instead
+of installing an unrelated global pnpm:
-1. Fork the repository by clicking on the "Fork" button on the top right corner of the repository page.
+```sh
+corepack enable
+corepack install
+pnpm install --frozen-lockfile
+```
-
+### Run the Homarr application
-2. Clone the repository to your local machine with `git clone`. You can find the url to use by clicking on the "Code" button on the top right corner of your forks repository page.
+1. Copy `.env.example` to `.env`.
+2. Set `DB_URL` to an absolute writable SQLite file path.
+3. Keep Redis and the optional local databases running in one terminal.
+4. Apply migrations and start Next.js in another terminal.
-
+```sh
+cp .env.example .env
+```
-3. Change directory to the project folder with `cd homarr`.
+Terminal 1:
-4. Install the dependencies with `pnpm install`.
+```sh
+pnpm docker:dev
+```
-5. Create `.env` from `.env.example`. In a POSIX shell, run `cp .env.example .env`; in PowerShell, run `Copy-Item .env.example .env`. Set `DB_URL` to an absolute path for your SQLite file.
+Terminal 2:
-6. Start Redis in the background with `pnpm docker:dev:up` if your development workflow needs it.
+```sh
+pnpm db:migration:sqlite:run
+pnpm dev
+```
-7. Create or update the database with `pnpm db:migration:sqlite:run`. This also seeds the default data. To run the seed explicitly later, use `pnpm db:seed`.
+The infrastructure command remains in the foreground. Open `http://127.0.0.1:3000`; the first user created through
+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.
-8. Start the development server with `pnpm dev` and wait for a message that says `✓ Ready in 10.7s`
+### Run PocketBase and documentation
-9. Open your browser and navigate to [http://localhost:3000](http://localhost:3000). (Loading the page might take up to 2 minutes the first time)
+Start PocketBase in another terminal:
-### Useful npm scripts
+```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
+```
-#### During development
+Then start Docusaurus in a third terminal:
-- `pnpm dev`: Start the development server.
-- `pnpm dev:cli -- dev`: Browse and run local images and remote pull-request images.
-- `pnpm dev:cli -- build `: Build the current checkout as `homarr:`.
-- `pnpm dev:cli -- build --pr `: Build a pull request locally from a temporary checkout.
-- `pnpm dev:cli -- rebuild `: Rebuild a local image from its recorded checkout or pull request.
-- `pnpm dev:cli:install`: Optionally install the developer CLI as a `homarr` binary.
-- `pnpm cli`: Run cli commands.
-- `pnpm db:migration:sqlite:run`: Run the migrations to create or update the sqlite db file.
-- `pnpm db:seed`: Explicitly seed the default database data.
-- `pnpm docker:dev:up`: Start the Redis development service in the background.
-- `pnpm db:migration:sqlite:generate`: Generate a new migration file for the sqlite db. Also works with `mysql`.
-- `pnpm db:studio`: Open a visual studio for the database.
-- `pnpm package:new`: Create a new package in the monorepo.
+```sh
+WORKSHOP_API_URL=http://127.0.0.1:8090 pnpm dev:docs
+```
-#### Checking code quality
+PocketBase runs on port 8090 and Docusaurus on port 3003. Stopping the services preserves the PocketBase volume.
-- `pnpm lint`: Run the linter to check for code quality issues.
-- `pnpm format:fix`: Run the formatter to fix code style issues.
-- `pnpm test`: Run the tests. You can also use `pnpm test:ui` to get a UI for the tests.
-- `pnpm typecheck`: Run the typescript type checker.
+Open `http://127.0.0.1:8090/_/` and create the first PocketBase superuser. The Workshop UI is available at
+`http://127.0.0.1:3003/workshop`.
-#### Building the project
+Point Homarr at the local services with:
-- `pnpm build`: Build the project for production.
-- `pnpm dev:cli -- build `: Build a `homarr:` image and record its checkout for later rebuilds.
-- `docker run -p 7575:7575 -e SECRET_ENCRYPTION_KEY='your_64_character_hex_string' homarr:`: Run the created docker image.
+```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 `pnpm dev` after changing `.env`. GitHub OAuth is optional locally. See
+[`apps/workshop/README.md`](https://github.com/homarr-labs/homarr/blob/HEAD/apps/workshop/README.md) for OAuth,
+Workshop moderator promotion, logs, tests, backup, restore, stopping, and intentional volume reset.
+
+### URL testing
+
+Docusaurus reads `HOMARR_WEBSITE_URL` and `WORKSHOP_API_URL` when it starts or builds. Homarr also reads
+`WORKSHOP_WEB_URL` when its server starts, so these values do not rely on `NEXT_PUBLIC_*` build variables. Test a
+separate API origin before release:
+
+```sh
+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 \
+pnpm dev:docs
+```
+
+### Useful commands
+
+- `pnpm dev` — Next.js on port 3000.
+- `pnpm dev:benchmark` — authenticated-board benchmark; readiness-only `--smoke` runs are not performance claims.
+- `pnpm dev:cli -- dev` — browse and run local images and remote pull-request images.
+- `pnpm dev:cli -- build ` — build the current checkout as `homarr:`.
+- `pnpm dev:cli -- build --pr ` — build a pull request from a temporary checkout.
+- `pnpm dev:cli -- rebuild ` — 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` — Docusaurus only on port 3003.
+- `pnpm docker:workshop` — local PocketBase through Docker Compose.
+- `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.
+- `pnpm db:seed` — seed the default database data explicitly.
+- `pnpm db:studio` — inspect the database.
+- `pnpm format` / `pnpm format:fix` — check or apply oxfmt.
+- `pnpm lint` / `pnpm lint:fix` — check or apply oxlint.
+- `pnpm typecheck` — typecheck all workspaces.
+- `pnpm test` — unit and contract suites.
+- `pnpm test:workshop` — disposable Workshop integration suite.
+- `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:` — run it.
diff --git a/apps/docs/docs/advanced/development/kubernetes.mdx b/apps/docs/docs/advanced/development/kubernetes.mdx
index e27b3ccbc..ff58b6c0a 100644
--- a/apps/docs/docs/advanced/development/kubernetes.mdx
+++ b/apps/docs/docs/advanced/development/kubernetes.mdx
@@ -132,4 +132,4 @@ This command should return CPU and memory usage statistics for each node.
## Conclusion
-You have successfully set up a multi-node Kubernetes cluster using kind and installed the Metrics Server for monitoring resource usage. This setup is useful for local development and testing Kubernetes workloads before deploying them to a production environment.
\ No newline at end of file
+You have successfully set up a multi-node Kubernetes cluster using kind and installed the Metrics Server for monitoring resource usage. This setup is useful for local development and testing Kubernetes workloads before deploying them to a production environment.
diff --git a/apps/docs/docs/advanced/environment-variables/index.mdx b/apps/docs/docs/advanced/environment-variables/index.mdx
index ad249e734..3c6d0f1a6 100644
--- a/apps/docs/docs/advanced/environment-variables/index.mdx
+++ b/apps/docs/docs/advanced/environment-variables/index.mdx
@@ -25,15 +25,17 @@ This is especially useful for [docker secrets](https://docs.docker.com/engine/sw
Using the `PUID` and `PGID` will require you to set the correct permissions on the mounted volumes and if used the docker socket. See more in the [Running as a different user](/docs/advanced/running-as-different-user) documentation.
:::
-| Environment Variable | Description | Possible values | Default |
-| ------------------------ | ----------- | --------------- | ------- |
-| ``PUID`` | User ID to run the container as | Any valid user ID | ``0`` |
-| ``PGID`` | Group ID to run the container as | Any valid group ID | ``0`` |
-| ``LOG_LEVEL`` | Log level to use | ``debug`` / ``info`` / ``warn`` / ``error`` | ``info`` |
-| ``NO_EXTERNAL_CONNECTION`` | Disables some requests that need internet connection | `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` |
-
-
+| Environment Variable | Description | Possible values | Default |
+| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | ----------------------------- |
+| `PUID` | User ID to run the container as | Any valid user ID | `0` |
+| `PGID` | Group ID to run the container as | Any valid group ID | `0` |
+| `LOG_LEVEL` | Log level to use | `debug` / `info` / `warn` / `error` | `info` |
+| `NO_EXTERNAL_CONNECTION` | Disables Homarr's internet-backed requests, including update checks, weather, and RSS feeds | `true` or `false` | `false` |
+| `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` |
+| `WORKSHOP_API_URL` | PocketBase API used by Homarr and standalone documentation. | HTTP(S) URL | `HOMARR_WEBSITE_URL` |
+| `WORKSHOP_WEB_URL` | Public Workshop page opened from Homarr. | HTTP(S) URL | `HOMARR_WEBSITE_URL/workshop` |
## Authentication
@@ -43,9 +45,9 @@ See [Single Sign-On](/docs/advanced/single-sign-on) for more informations.
The `SECRET_ENCRYPTION_KEY` is required. If none is specified before starting the container, a random key will be shown in the error message and the container will exit.
-| Environment Variable | Description | Possible values | Default |
-| ------------------------ | ----------- | --------------- | ------- |
-| ``SECRET_ENCRYPTION_KEY`` | Secret used to encrypt secrets in database. | 64 character hex string | - |
+| Environment Variable | Description | Possible values | Default |
+| ----------------------- | ------------------------------------------- | ----------------------- | ------- |
+| `SECRET_ENCRYPTION_KEY` | Secret used to encrypt secrets in database. | 64 character hex string | - |
:::info
A random secret can be generated by using the following command: `openssl rand -hex 32`
@@ -53,27 +55,27 @@ A random secret can be generated by using the following command: `openssl rand -
## Docker
-| Environment Variable | Description | Possible values | Default |
-| ------------------------ | ----------- | --------------- | ------- |
-| ``DOCKER_HOSTNAMES`` | Comma-separated list of hostnames to connect to | For example `localhost,docker.example.com` | - |
-| ``DOCKER_PORTS`` | Comma-separated list of ports to connect to | For example `2375,2376` | - |
-| ``DOCKER_SOCKET_PATHS`` | Comma-separated list of mounted Docker-compatible socket paths. See the [Docker and Podman integration guide](/docs/integrations/docker) | For example `/var/run/docker.sock,/var/run/podman.sock` | - |
+| Environment Variable | Description | Possible values | Default |
+| --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | ------- |
+| `DOCKER_HOSTNAMES` | Comma-separated list of hostnames to connect to | For example `localhost,docker.example.com` | - |
+| `DOCKER_PORTS` | Comma-separated list of ports to connect to | For example `2375,2376` | - |
+| `DOCKER_SOCKET_PATHS` | Comma-separated list of mounted Docker-compatible socket paths. See the [Docker and Podman integration guide](/docs/integrations/docker) | For example `/var/run/docker.sock,/var/run/podman.sock` | - |
## Database
-| Environment Variable | Description | Possible values | Default |
-| ------------------------ | ----------- | --------------- | ------- |
-| ``DB_DRIVER`` | Database driver to use. Currently `better-sqlite3` is used for sqlite, `mysql2` for mysql and `node-postgres` for postgresql | ``better-sqlite3`` / ``mysql2`` / ``node-postgres`` | ``better-sqlite3`` |
-| ``DB_DIALECT`` | Database dialect to use. | ``sqlite`` / ``mysql`` / ``postgresql`` | ``sqlite`` |
-| ``DB_URL`` | Database URL to connect to. | Any valid database URL | ``/appdata/db/db.sqlite`` |
-| ``DB_HOST`` | Database host to connect to. | Any valid database host | - |
-| ``DB_PORT`` | Database port to connect to. | Any valid database port | - |
-| ``DB_NAME`` | Database name to connect to. | Any valid database name | - |
-| ``DB_USER`` | Database user to connect with. | Any valid database user | - |
-| ``DB_PASSWORD`` | Database password to connect with. | Any valid database password | - |
+
+| Environment Variable | Description | Possible values | Default |
+| -------------------- | ---------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | ----------------------- |
+| `DB_DRIVER` | Database driver to use. Currently `better-sqlite3` is used for sqlite, `mysql2` for mysql and `node-postgres` for postgresql | `better-sqlite3` / `mysql2` / `node-postgres` | `better-sqlite3` |
+| `DB_DIALECT` | Database dialect to use. | `sqlite` / `mysql` / `postgresql` | `sqlite` |
+| `DB_URL` | Database URL to connect to. | Any valid database URL | `/appdata/db/db.sqlite` |
+| `DB_HOST` | Database host to connect to. | Any valid database host | - |
+| `DB_PORT` | Database port to connect to. | Any valid database port | - |
+| `DB_NAME` | Database name to connect to. | Any valid database name | - |
+| `DB_USER` | Database user to connect with. | Any valid database user | - |
+| `DB_PASSWORD` | Database password to connect with. | Any valid database password | - |
You can either use the url or host, port, name and credentials combined. The URL will be prioritized over the other values.
-
## Redis
By default Redis is running within the installation. (for example in Docker).
@@ -83,25 +85,23 @@ However for example for K8s it can be useful to use an external Redis instance.
External redis is currently not supported with Proxmox Community Scripts
:::
-| Environment Variable | Description | Possible values | Default |
-| ------------------------ | ----------- | --------------- | ------- |
-| `REDIS_IS_EXTERNAL` | Whether Redis is running externally. | `true` / `false` | `false` |
-| `REDIS_HOST` | Hostname of the Redis instance. | Any valid hostname | - |
-| `REDIS_PORT` | Port of the Redis instance. | Any valid port | `6379` |
-| `REDIS_USERNAME` | Username to connect to the Redis instance. | Any valid username | - |
-| `REDIS_PASSWORD` | Password to connect to the Redis instance. | Any valid password | - |
-| `REDIS_DATABASE_INDEX` | Select which database of your redis instance should be used. | Any numeric index | - |
-| `REDIS_TLS_CA` | CA certificate for Redis TLS connections. If a certificate is specified the connection will use TLS. | Any valid CA certificate | - |
-
+| Environment Variable | Description | Possible values | Default |
+| ---------------------- | ---------------------------------------------------------------------------------------------------- | ------------------------ | ------- |
+| `REDIS_IS_EXTERNAL` | Whether Redis is running externally. | `true` / `false` | `false` |
+| `REDIS_HOST` | Hostname of the Redis instance. | Any valid hostname | - |
+| `REDIS_PORT` | Port of the Redis instance. | Any valid port | `6379` |
+| `REDIS_USERNAME` | Username to connect to the Redis instance. | Any valid username | - |
+| `REDIS_PASSWORD` | Password to connect to the Redis instance. | Any valid password | - |
+| `REDIS_DATABASE_INDEX` | Select which database of your redis instance should be used. | Any numeric index | - |
+| `REDIS_TLS_CA` | CA certificate for Redis TLS connections. If a certificate is specified the connection will use TLS. | Any valid CA certificate | - |
## Proxy
-| Environment Variable | Description | Possible values | Default |
-| ------------------------ | ----------- | --------------- | ------- |
-| ``HTTP_PROXY`` | HTTP proxy to use | Any valid HTTP proxy URL | - |
-| ``HTTPS_PROXY`` | HTTPS proxy to use | Any valid HTTPS proxy URL | - |
-| ``NO_PROXY`` | Comma separated list of hosts that should be excluded from proxying | Any valid hostnames | - |
-
+| Environment Variable | Description | Possible values | Default |
+| -------------------- | ------------------------------------------------------------------- | ------------------------- | ------- |
+| `HTTP_PROXY` | HTTP proxy to use | Any valid HTTP proxy URL | - |
+| `HTTPS_PROXY` | HTTPS proxy to use | Any valid HTTPS proxy URL | - |
+| `NO_PROXY` | Comma separated list of hosts that should be excluded from proxying | Any valid hostnames | - |
## Advanced deployments
@@ -109,6 +109,12 @@ External redis is currently not supported with Proxmox Community Scripts
The advanced deployments environment variables should only be used if you know what you are doing.
:::
-| Environment Variable | Description |
-| ------------------------ | ----------- |
-| ``DB_MIGRATIONS_DISABLED`` | Disable db migrations. For example for helm charts |
+| Environment Variable | Description |
+| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------- |
+| `DB_MIGRATIONS_DISABLED` | Disable db migrations. For example for helm charts. |
+| `WORKSHOP_PUBLIC_ORIGIN` | Origin used in PocketBase-generated links and email. It must be set explicitly in production. |
+| `PB_ALLOWED_ORIGINS` | Browser origins accepted by PocketBase. The central public community defaults to `*` so self-hosted Homarr instances can use OAuth. |
+
+All public URL variables reject non-HTTP protocols, embedded credentials, query strings, and fragments, and normalize
+trailing slashes when Homarr or Docusaurus starts. The Docusaurus-only `WORKSHOP_URL` name is accepted as a deprecated alias for
+`WORKSHOP_API_URL` for one release. `WORKSHOP_API_URL` takes precedence.
diff --git a/apps/docs/docs/advanced/icons/index.mdx b/apps/docs/docs/advanced/icons/index.mdx
index b73d49e02..4fd21d95f 100644
--- a/apps/docs/docs/advanced/icons/index.mdx
+++ b/apps/docs/docs/advanced/icons/index.mdx
@@ -9,14 +9,16 @@ tags:
---
## Icon picker
+
Icons in Homarr are automatically requested from multiple sources:
- - [Dashboard Icons](https://dashboardicons.com/) - Our recommended source with over 1888+ curated, high-quality icons
- - [selfh.st icons](https://github.com/selfhst/icons)
- - [Simple icons](https://github.com/simple-icons/simple-icons)
- - [Tabler icons](https://tabler-icons.io/)
- - [Papirus icons](https://github.com/PapirusDevelopmentTeam/papirus-icon-theme)
- - [Homelab Svg assets](https://github.com/loganmarchione/homelab-svg-assets)
- - **Local icons**: automatically fetched from the [medias feature](/docs/management/media/)
+
+- [Dashboard Icons](https://dashboardicons.com/) - Our recommended source with over 1888+ curated, high-quality icons
+- [selfh.st icons](https://github.com/selfhst/icons)
+- [Simple icons](https://github.com/simple-icons/simple-icons)
+- [Tabler icons](https://tabler-icons.io/)
+- [Papirus icons](https://github.com/PapirusDevelopmentTeam/papirus-icon-theme)
+- [Homelab Svg assets](https://github.com/loganmarchione/homelab-svg-assets)
+- **Local icons**: automatically fetched from the [medias feature](/docs/management/media/)
Using these icon sources, Homarr provides a total collection of over 11,000 icons at your fingertips.
The icon picker is a fast searcher that helps you to find your desired icon simply by entering a search term.
@@ -30,5 +32,6 @@ If you can't find the icon you're looking for in Homarr's built-in picker, we st
Icons that are high quality and printable ([SVG](https://wikipedia.org/wiki/Scalable_Vector_Graphics)) are marked with a red badge "SVG" at the top right.
### Using external icons
+
If you don't find the icon you're looking for on Dashboard Icons or wish to use a different source, you can simply enter a URL that points to an icon.
Direct HTTP(S) image URLs are used as entered instead of being searched in the built-in repositories. It is important that the URL directly points to the file without any advertisements or elements around it.
diff --git a/apps/docs/docs/advanced/keyboard-shortcuts/index.mdx b/apps/docs/docs/advanced/keyboard-shortcuts/index.mdx
index 2896b7a97..8436de8a2 100644
--- a/apps/docs/docs/advanced/keyboard-shortcuts/index.mdx
+++ b/apps/docs/docs/advanced/keyboard-shortcuts/index.mdx
@@ -1,28 +1,29 @@
---
+
title: Keyboard Shortcuts
tags:
- - Advanced
+
+- Advanced
+
---
Homarr has the following keyboard shortcuts:
-| Shortcut | Description |
-| ---------------------------------------------- | ---------------------------------------------------------- |
-| `MOD` + `K` | Opens the search bar |
-| `MOD` + `J` | Toggles Dark Mode |
-| `MOD` + `E` | Toggles Edit Mode |
-| Hold `Shift` while hovering a supported widget | Opens its temporary advanced view |
-| `Shift` + `Enter` on a supported widget | Opens its advanced view until it is closed |
-| `Esc` | Closes an open advanced view or board menu |
-| `Shift` + `F10` on a focused board section | Opens the precise add-item menu at the next available cell |
+| Shortcut | Description |
+| ---------------------------------------------- | ------------------------------------------ |
+| `MOD` + `K` | Opens the search bar |
+| `MOD` + `J` | Toggles Dark Mode |
+| `MOD` + `E` | Toggles Edit Mode |
+| Hold `Shift` while hovering a supported widget | Opens its temporary advanced view |
+| `Shift` + `Enter` on a supported widget | Opens its advanced view until it is closed |
+| `Esc` | Closes an open advanced view or board menu |
:::tip
Here `MOD` refers to the modifier key, which is `Ctrl` on Windows and `Cmd` on macOS.
-Advanced view and precise placement are available outside edit mode. Widgets without a distinct advanced experience
-adapt to their normal dimensions instead. Precise placement still requires permission to change the board and the
-right-click interaction preference to be enabled.
+Advanced view is available outside edit mode. Widgets without a distinct advanced experience adapt to their normal
+dimensions instead.
:::
diff --git a/apps/docs/docs/advanced/proxy/index.mdx b/apps/docs/docs/advanced/proxy/index.mdx
index ef4e41f1d..fbe33bfa4 100644
--- a/apps/docs/docs/advanced/proxy/index.mdx
+++ b/apps/docs/docs/advanced/proxy/index.mdx
@@ -9,16 +9,17 @@ tags:
- Security
---
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
+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?
Homarr is trying to communicate to your apps via the integrations.
-It usually doesn't matter if Homarr is running on ``http`` or ``https``.
+It usually doesn't matter if Homarr is running on `http` or `https`.
Your apps have a self-signed certificate - Homarr will recognize that the certificate was signed by an unknown authority and requests will be blocked.
:::
@@ -28,8 +29,9 @@ To allow self-signed certificates, you can configure them on the certificates ma
## Securing Homarr with Traefik
Copying the configuration straight from the docker-compose file won't work if you are running Homarr behind Traefik, such as a Portainer setup, or docker-swarm. In that case, you should use the following slightly modified configuration:
+
```yaml
-version: '3'
+version: "3"
services:
homarr:
container_name: homarr
@@ -47,18 +49,18 @@ services:
traefik.http.routers.homarr.rule: Host(`your.internal.dns.address.here.com`)
traefik.http.routers.homarr.entrypoints: websecure
traefik.http.routers.homarr-secure.app: homarr
- traefik.http.apps.homarr.loadbalancer.server.port: 7575
networks:
proxy:
external: true
```
-
+
A sample Traefik docker-compose.yml using Cloudflare for certificate generation that works with the configuration above would be:
+
```yaml
-version: '3'
+version: "3"
apps:
traefik:
@@ -104,7 +106,6 @@ networks:
external: true
```
-
:::tip
Of particular note here is that both configurations explicitly define which network they are using, in this case "proxy", but it can be named anything. It just has to be the same across all apps for which Traefik is serving as a proxy. These are marked as external because the proxy network was manually created by running: `docker network create proxy` but this might be unnecessary depending on HOW exactly you are running Traefik. For example, if running [Traefik with Portainer](https://docs.portainer.io/advanced/reverse-proxy/traefik#deploying-in-a-docker-standalone-scenario), you can follow their official docs on how to set up Traefik and Portainer together, and you can just focus on the Homarr docker labels instead.
:::
@@ -115,7 +116,6 @@ If you are using Caddy as the reverse proxy for your setup, your `docker-compose
```yaml
services:
-
# <-- [Homarr installation]
caddy:
@@ -141,14 +141,17 @@ networks:
proxy:
external: true
```
+
:::important
Homarr needs to be on the same network so you will need to add the following property to your homarr install:
+
```yaml
homarr:
...
networks:
- proxy
```
+
:::
Next, create a file named `Caddyfile` at the same level as your `docker-compose.yml` file with the following content:
diff --git a/apps/docs/docs/advanced/running-as-different-user/index.mdx b/apps/docs/docs/advanced/running-as-different-user/index.mdx
index a4ebcf0f4..91c02fb9d 100644
--- a/apps/docs/docs/advanced/running-as-different-user/index.mdx
+++ b/apps/docs/docs/advanced/running-as-different-user/index.mdx
@@ -8,7 +8,7 @@ tags:
- PUID
---
-By default the container is running with user `root` and group `root`.
+By default the container is running with user `root` and group `root`.
You can change the user and group by using the `PUID` and `PGID` environment variables.
Important to note is, that you'll also need to change the permissions for the mounted directories accordingly.
@@ -32,11 +32,11 @@ services:
volumes:
- ./homarr/appdata:/appdata
environment:
- - SECRET_ENCRYPTION_KEY=your_64_character_hex_string # <--- can be generated with `openssl rand -hex 32`
- - PUID=1000
- - PGID=1000
+ - SECRET_ENCRYPTION_KEY=your_64_character_hex_string # <--- can be generated with `openssl rand -hex 32`
+ - PUID=1000
+ - PGID=1000
ports:
- - '7575:7575'
+ - "7575:7575"
```
After that you'll need to create the appdata directory and set the correct permissions:
@@ -76,11 +76,11 @@ services:
- /var/run/docker.sock:/var/run/docker.sock
- ./homarr/appdata:/appdata
environment:
- - SECRET_ENCRYPTION_KEY=your_64_character_hex_string # <--- can be generated with `openssl rand -hex 32`
- - PUID=1000
- - PGID=999
+ - SECRET_ENCRYPTION_KEY=your_64_character_hex_string # <--- can be generated with `openssl rand -hex 32`
+ - PUID=1000
+ - PGID=999
ports:
- - '7575:7575'
+ - "7575:7575"
```
And set the permissions for the mounted directories:
@@ -90,4 +90,4 @@ mkdir -p ./homarr/appdata
chown -R 1000:999 ./homarr/appdata
```
-Important here is that the group ID is set to `999` as we created the `docker` group with this ID.
\ No newline at end of file
+Important here is that the group ID is set to `999` as we created the `docker` group with this ID.
diff --git a/apps/docs/docs/advanced/single-sign-on/index.mdx b/apps/docs/docs/advanced/single-sign-on/index.mdx
index ae1d9ca31..505fe9867 100644
--- a/apps/docs/docs/advanced/single-sign-on/index.mdx
+++ b/apps/docs/docs/advanced/single-sign-on/index.mdx
@@ -10,20 +10,21 @@ tags:
- Active Directory
---
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
+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.
### Auth configuration common variables
-| Environment Variable | Description | Default Value |
-|---------------------------|-------------|---------------|
-| AUTH_PROVIDERS | Select Which provider to use between *credentials*, *ldap* and *oidc*. Multiple providers can be enabled with by separating them with `,`, (ex. `AUTH_PROVIDERS=credentials,oidc`, it is highly recommended to just enable one provider). | credentials |
-| AUTH_LOGOUT_REDIRECT_URL | URL to redirect to after clicking logging out. | --- |
-| 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` |
+
+| Environment Variable | Description | Default Value |
+| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
+| AUTH_PROVIDERS | Select Which provider to use between _credentials_, _ldap_ and _oidc_. Multiple providers can be enabled with by separating them with `,`, (ex. `AUTH_PROVIDERS=credentials,oidc`, it is highly recommended to just enable one provider). | credentials |
+| AUTH_LOGOUT_REDIRECT_URL | URL to redirect to after clicking logging out. | --- |
+| 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` |
diff --git a/apps/docs/docs/advanced/styling/index.mdx b/apps/docs/docs/advanced/styling/index.mdx
index 9be382ec3..56d4305e5 100644
--- a/apps/docs/docs/advanced/styling/index.mdx
+++ b/apps/docs/docs/advanced/styling/index.mdx
@@ -19,12 +19,14 @@ Homarr uses https://mantine.dev/ under the hood. You can change the look & feel
using custom CSS, that extends or overwrites the styles from Mantine.
## Getting into CSS
+
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 **cannot do any of the following**:
@@ -33,21 +35,23 @@ Although CSS can improve the design & feel of the page, it **cannot do any
- 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 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.
+
+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.
+- 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.
+ 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
@@ -55,17 +59,19 @@ which element to apply the styles to. If you accidentally broke something or wan
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.
+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
+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``.
+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:
@@ -73,6 +79,7 @@ Then, you can enter as many custom classes as you'd like:
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:
@@ -84,11 +91,12 @@ Here you can enter your CSS code, which will be applied on the respective board
## 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;
+ --mantine-primary-color-filled: #ffbb00;
}
-```
\ No newline at end of file
+```
diff --git a/apps/docs/docs/community/donate.mdx b/apps/docs/docs/community/donate.mdx
index aeb95dcac..3651a2a7b 100644
--- a/apps/docs/docs/community/donate.mdx
+++ b/apps/docs/docs/community/donate.mdx
@@ -7,12 +7,15 @@ tags:
---
# Donate
+
## Why to donate
+
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
@@ -20,6 +23,7 @@ Using a donation, you help us to cover these expenses and enable the development
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).
\ No newline at end of file
+You can get into contact with us [here](/docs/community/get-in-touch).
diff --git a/apps/docs/docs/community/faq.mdx b/apps/docs/docs/community/faq.mdx
index 465c7bbaf..19f2cd0e0 100644
--- a/apps/docs/docs/community/faq.mdx
+++ b/apps/docs/docs/community/faq.mdx
@@ -5,43 +5,57 @@ tags:
- Help
---
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
### Can I install Homarr on a Raspberry Pi?
+
Yes, Homarr is compatible with the architecture of the Raspberry Pi. Have a look in our installation guide on how to do so.
### I have a suggestion / idea for improvement or want to report a bug
+
You can report issues, suggestions, or ideas for improvements here.
### Can I use my own custom icons for apps?
+
Yes, check out our guide on how to add your custom icons.
### Some of my online icons are not working (anymore)
+
It seems the `cdn.jsdelivr.net` database of icon sometimes appear in the lists for DNS-Holes (PiHole, AdGuard Home...).
So make sure to manually whitelist this address.
### Can I add my own widgets? Do I need programming skills?
-We have decided, not to support custom widgets, until Homarr is in a stable and highly polished state.
-Enabling users to write their own widgets is easy at the first glance, but there are some major issues with it:
-- There are mainly two options for adding plugins or custom widgets to Homarr. The first option is, to allow and inject custom code in Homarr. Apps like Nextcloud can do this easily, because they use the Runtime to render all components of the application (In reality, the process is still a bit more complicated). In contrast, Homarr is using Next.js - a framework that needs to be compiled in production. That means, that each time you would modify a custom widget or plugin, the app would have to be restarted. There are options to avoid this, but they are quite flakey and bring disadvantages in our experience. The second option is, to write widgets declaratively instead of imperatively. This way, we would be able to render and modify widgets without any restarting at all. However, we'd have to write our own interpreter for said declarative schema. This is totally possible, but requires a lot of planning and architecture design to function properly. The required work to implement either option is therefore quite substantial.
-- Custom widgets would need to be able to request data, so they work properly. We use tRPC for this. Many APIs use different formats and we'd have to convert and read those.
-- Using custom widgets, one could easily create harmful widgets, leak your personal data (potentially including your tokens) and trick your users. A proper implementation (eg. official plugin store, where we can ban harmful widgets from) would resolve this problem to a certain extent, but again requires additional work and time to be put in.
+Yes. A [Custom Widget](/docs/management/custom-widgets) can read a public or private HTTP API.
-If you still want to add a widget, please consider to contribute it directly to Homarr. For that, basic programming skills are required. Our [Developer Guides](/docs/advanced/development/getting-started) explain this even more detailed.
+It can show responsive Mantine JSX. It can also use widget options and actions with board permission checks.
+
+Custom JSX v2 is the only Custom Widget format. Write the JSON and JSX in the workbench.
+
+You can also use the AI copy prompt. An MCP agent can validate and preview a definition before it saves the definition.
+
+The workbench reads a pasted AI response. It shows request capabilities and redacted diagnostics.
+
+A template cannot import packages or run arbitrary JavaScript. It cannot call browser `fetch`.
+
+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.
+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.
+Both variants _can_ contain personal data. It's recommended, that you don't post them publicly or remove personal data from it.
@@ -49,39 +63,45 @@ Both variants *can* contain personal data. It's recommended, that you don't post
> 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.
+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**
-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/.
+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/.
### 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 here.
### 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 GluetunVPN 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 here to get with us in touch.
-
+
:::tip
diff --git a/apps/docs/docs/community/get-in-touch.mdx b/apps/docs/docs/community/get-in-touch.mdx
index 7651f5ea2..eecd2e1f3 100644
--- a/apps/docs/docs/community/get-in-touch.mdx
+++ b/apps/docs/docs/community/get-in-touch.mdx
@@ -9,16 +9,16 @@ tags:
We're happy to talk with you! Shoot us a message at the following places:
## E-Mail
+
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
+
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.
[__](https://discord.gg/aCsmEV5RgA)
-
-
diff --git a/apps/docs/docs/community/license.mdx b/apps/docs/docs/community/license.mdx
index e36a5d684..3d1f82890 100644
--- a/apps/docs/docs/community/license.mdx
+++ b/apps/docs/docs/community/license.mdx
@@ -7,6 +7,7 @@ tags:
Homarr is licensed under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0).
## TL;DR
+
| Action | Allowed |
| -------------- | ------- |
| Copy | ✅ |
@@ -24,8 +25,6 @@ Please consider [making a donation](/docs/community/donate) to Homarr, if this p
:::
-
-
## Full License
```txt
diff --git a/apps/docs/docs/community/translations.mdx b/apps/docs/docs/community/translations.mdx
index 074db939d..68eea8a1e 100644
--- a/apps/docs/docs/community/translations.mdx
+++ b/apps/docs/docs/community/translations.mdx
@@ -5,30 +5,31 @@ tags:
- Translations
---
-We want to make Homarr accessible for everyone.
-But to do that, we need your help.
-We are running a community program that enables everyone to translate Homarr into their language – no programming required.
-We are using [Crowdin](https://crowdin.com/) to manage our translations.
+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/).
## How to translate
-
### Using crowdin's online platform
-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.
+
+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.
### 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)"
-Then you'll be prompted to connect to your Crowdin account and choose the language in which you want to transalte.
+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.
@@ -47,7 +48,8 @@ Do you want to become a proofreader? [Let us know on our Discord](/docs/communit
:::
## Guidelines
+
1. Translate with context: Some translations can't be translated 1:1 - they need context. Ensure that your translations make sense in the context.
2. Keep things simple and original - no additional characters are needed.
3. Don't translate the same thing twice - if you see a translation that is already translated, don't translate it again unless you have a better translation.
-5. Keep your translations as close to the original as possible.
+4. Keep your translations as close to the original as possible.
diff --git a/apps/docs/docs/getting-started/after-the-installation.mdx b/apps/docs/docs/getting-started/after-the-installation.mdx
index 2148af841..e922bb5e1 100644
--- a/apps/docs/docs/getting-started/after-the-installation.mdx
+++ b/apps/docs/docs/getting-started/after-the-installation.mdx
@@ -1,9 +1,12 @@
---
+
title: After the installation
sidebar_position: 3
tags:
- - Getting started
- - Configuration
+
+- Getting started
+- Configuration
+
---
import imageStartFromScratchStepServerSettings from "./img/onboarding-from-scratch-step-server-settings.png";
@@ -137,7 +140,8 @@ It is important that you first migrate correctly using [the list of breaking cha
## Creating your first board
In Homarr, you organize your apps and widgets on boards.
-Boards can be organized using the interactive drag and drop.
+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.
Let's create your first board by navigating here: `Manage` > `Boards` > `New board`:
@@ -193,9 +197,7 @@ When entering the edit mode, you'll get some additional buttons to work with:
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. You can also focus that widget and press `Shift` + `Enter` to
-keep its advanced view open until you close it. Widgets without a distinct advanced experience adapt in place. If you
-can change the board, right-click empty grid space to add an item at that position.
-On a touch device, touch and hold empty grid space for the same precise-placement menu.
+keep its advanced view open until you close it. Widgets without a distinct advanced experience adapt in place.
To continue, click the option "New Item":
@@ -220,21 +222,28 @@ In the modal you can edit the app that you want to display:
As soon as you save your changes, the tile on the board will refresh and display your app.
-Using the small bidirectional arrow at the bottom right you can resize the element.
-Start pressing with your mouse button down, move your mouse to resize and release your finger as soon your you're happy with the size.
+Use the resize handle at the bottom right to resize the tile.
+Press and hold the handle, move the pointer, and release it when the tile has the size you want.
-To move your item to a different position on the board, simply hold the mouse button anywhere on the item and move with the mouse to the desired position.
-As soon as you release your finger, the item will snap in place in the grid.
+To move a tile in edit mode, press and hold its content, 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. Equally-sized tiles swap when one is dropped into the other's slot, while other neighboring tiles move out of the way 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.
+It stops shrinking at 75% and lets you scroll horizontally instead of making text and controls too small.
+It does not squeeze or reflow the content of individual widgets, so a widget keeps the same design and proportions across screen sizes.
+
:::note
-You cannot move items freely on the vertical axis.
-We always align all items to the top of the page to simply organization.
-To move items to the bottom, you must add more items or resize items.
+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.
:::
@@ -245,8 +254,10 @@ This helps you to explore the capabilities of Homarr before you build your board
:::
-Users on touch or mobile devices may not be able to drag and drop or move items.
-They can use the "Move / resize item" option in the edit menu of items instead:
+Keyboard users can focus a tile, press Enter or Space, then use arrow keys to move and Shift plus arrow keys to resize.
+Press Escape to stop.
+For precise numeric controls or touch input, choose **Move / resize item** from the tile's edit menu.
+The dialog can also move the tile to another section or fixed sidebar:
@@ -318,43 +329,36 @@ As with every change, don't forget to save your changes using the exit edit mode
-## Grouping your items
+## Organizing items with Containers
-As the last step, let's organize your freshly created items using two different options.
-You can choose either or both of them on your boards.
+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:
-### Using dynamic sections
+- 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.
-Dynamic sections are a simple, resizable visual group to group items.
+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
-After adding a dynamic section, you can simply drag and drop items into the section:
+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
-### Using categories
-
-Categories are more advanced and complicated than dynamic sections.
-To create a category, open the add item modal and choose "new category":
-
-
-
-Every category must have a name. After you click "Add category", you will get a new item on your board:
-
-
-
-You can drag and drop items in to this category in the edit mode.
-Categories will have a big space before and after them in the edit mode to
-enable you to drag and drop items outside the category.
-You can also collapse or open categories in edit mode to facilitate your editing process.
-
-:::note
-
-A current limitation of categories is, that they will always have a width of 100%.
-You cannot reduce their horizontal width.
-
-:::
+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
diff --git a/apps/docs/docs/getting-started/glossary.mdx b/apps/docs/docs/getting-started/glossary.mdx
index 8d690245c..989c71e1c 100644
--- a/apps/docs/docs/getting-started/glossary.mdx
+++ b/apps/docs/docs/getting-started/glossary.mdx
@@ -1,12 +1,13 @@
# Glossary
-In the glossary, you'll learn the different components and their names of Homarr.
-| Term | Definition |
-|-----------------|----------------------------------------------------------------------------------------------------------------|
-| Apps | An piece of software that you or a third party hosts (eg. Google) |
-| Integration | A connection to a service outside of Homarr |
-| Dynamic section | Resizeable area where items on your board can be placed and grouped |
-| Widget | A tile that uses your integrations to display data or enables you to interact with with them |
-| Edit mode | Temporary state that you can enter where you can drag and drop, edit or customize your board |
-| Board | Customizable page which can be edited using the edit mode. This is where apps, sections and widgets are placed |
-| Tasks | Workloads that are performed in the background - even if there is no user present |
+This glossary explains Homarr's main components and the terms used for them.
+
+| Term | Definition |
+| ----------- | --------------------------------------------------------------------------------------- |
+| Apps | A piece of software that you or a third party hosts (for example, Google) |
+| Integration | A connection to a service outside of Homarr |
+| Container | A resizable area that can hold apps, widgets, and nested Containers |
+| Widget | A tile that uses your integrations to display data or enables you to interact with them |
+| Edit mode | A temporary state where you can drag, resize, edit, or customize your board |
+| Board | A customizable page where apps, widgets, and Containers are arranged |
+| Tasks | Workloads that are performed in the background, even if no user is present |
diff --git a/apps/docs/docs/getting-started/index.mdx b/apps/docs/docs/getting-started/index.mdx
index 4dc986658..0d6a44a4e 100644
--- a/apps/docs/docs/getting-started/index.mdx
+++ b/apps/docs/docs/getting-started/index.mdx
@@ -8,13 +8,14 @@ tags:
- Unraid
---
-import Link from '@docusaurus/Link';
-import { IconArrowRight } from '@tabler/icons-react';
+import Link from "@docusaurus/Link";
+import { IconArrowRight } from "@tabler/icons-react";
Before you try to install Homarr, please review if your device meets the requirements.
Installing on an unsupported device may lead to unstable behaviour and no support will be provided.
## Hardware
+
- At least 500MB RAM
- At least 600MB of free disk space for the Docker image. SSD is preferred.
- Single or dual core CPU
@@ -24,8 +25,8 @@ Installing on an unsupported device may lead to unstable behaviour and no suppor
We build Homarr for a bunch of different architectures, including ARM. Please ensure that your device architecture is supported by Homarr. We won't be able to provide support for unusual or outdated architectures.
-| Architecture | Supported |
-|--------------|-----------------|
+| Architecture | Supported |
+| ------------ | ---------------- |
| linux/amd64 | ✅ Supported |
| linux/arm64 | ✅ Supported |
| linux/arm/v7 | ❌ Not supported |
@@ -34,10 +35,10 @@ We build Homarr for a bunch of different architectures, including ARM. Please en
-
+
Go to Installation
diff --git a/apps/docs/docs/getting-started/installation/docker.mdx b/apps/docs/docs/getting-started/installation/docker.mdx
index 956a6c2d6..5a56a848a 100644
--- a/apps/docs/docs/getting-started/installation/docker.mdx
+++ b/apps/docs/docs/getting-started/installation/docker.mdx
@@ -1,21 +1,23 @@
-import { DockerInstallSnippet } from '@site/src/components/pages/installation/docker/dynamic-docker-install'
+import { DockerInstallSnippet } from "@site/src/components/pages/installation/docker/dynamic-docker-install";
# Docker
+
Docker is our recommended installation method for beginners and professionals.
It is easy to use, ships with all dependencies inside a single container and is easy to use and maintain.
It requires at least some basic knowledge of [Docker](https://www.docker.com/).
We recommend [NetworkChuck's Docker Containers 101](https://www.youtube.com/watch?v=eGz9DS-aIeY) as a good start for complete beginners.
## Docker compose
+
### Prerequisites
- A Linux or Windows based system that meets the [hardware prerequisites](/docs/getting-started/#hardware) and [architecture prerequisites](/docs/getting-started/#architecture).
- [Docker](https://docs.docker.com/get-docker/)
-- [Docker Compose](https://docs.docker.com/compose/install/) - *preinstalled on many systems nowadays*
+- [Docker Compose](https://docs.docker.com/compose/install/) - _preinstalled on many systems nowadays_
### Installation
-
+
Finally, run ``docker compose up -d`` in the same directory. This will start the Homarr container in the background.
:::caution
@@ -26,27 +28,26 @@ Docker compose creates a network by default. Some integrations may not work (spe
### Updating
-To update, navigate to the directory with the ``docker-compose.yaml`` located.
+To update, navigate to the directory with the `docker-compose.yaml` located.
-- Stop Homarr using ``docker compose down``
-- Pull the newest image of Homarr using ``docker compose pull``
-- Start Homarr again using ``docker compose up -d`` (``-d`` for detached mode - start in background)
-- Delete the old image using ``docker image prune`` (*Warning: this also removes you other unused images - not just Homarr*)
+- Stop Homarr using `docker compose down`
+- Pull the newest image of Homarr using `docker compose pull`
+- Start Homarr again using `docker compose up -d` (`-d` for detached mode - start in background)
+- Delete the old image using `docker image prune` (_Warning: this also removes you other unused images - not just Homarr_)
You can automate this process using [Watchtower](https://containrrr.dev/watchtower/).
### Uninstalling
-To uninstall, navigate to the directory with the ``docker-compose.yaml`` located.
+To uninstall, navigate to the directory with the `docker-compose.yaml` located.
-- Stop Homarr using ``docker compose down``
-- Delete the created directories & files on your root file system (check ``docker-compose.yaml`` file for your specific locations)
-- Delete compose file using ``rm docker-compose.yaml``
-- Prune unused Docker images using ``docker image prune`` (*Warning: this also removes you other unused images - not just Homarr*)
+- Stop Homarr using `docker compose down`
+- Delete the created directories & files on your root file system (check `docker-compose.yaml` file for your specific locations)
+- Delete compose file using `rm docker-compose.yaml`
+- Prune unused Docker images using `docker image prune` (_Warning: this also removes you other unused images - not just Homarr_)
- (Optional): Prune any network or volumes if you use any.
- (Optional): Remove Homarr from your reverse proxy, VPNs or tunnels if you use any.
-
## Docker standalone
:::caution
@@ -77,15 +78,16 @@ docker run \
:::note
-Docker will mount the configuration files and icons to your host machine. Please make sure to replace ```` from the docker run command with your desired storage location. The path must be absolute.
+Docker will mount the configuration files and icons to your host machine. Please make sure to replace `` from the docker run command with your desired storage location. The path must be absolute.
:::
### Updating
+
To update Homarr, you must remove your container first. Make sure that you've mounted your data and that you have access to it, so your configuration doesn't get lost.
-1. Run ``docker rm homarr`` to remove the container.
-2. Pull the latest Homarr image ``docker pull ghcr.io/homarr-labs/homarr:latest``.
+1. Run `docker rm homarr` to remove the container.
+2. Pull the latest Homarr image `docker pull ghcr.io/homarr-labs/homarr:latest`.
3. Re-run the command you used to install Homarr.
This process can get tideous, if you update frequently. Thus, we recommend [using docker-compose](#docker-compose)
@@ -98,8 +100,8 @@ Want to update all your containers automatically? Checkout [Watchtower](https://
### Uninstalling
-1. Obtain the container ID of your Homarr container using ``docker ps | grep homarr``.
-2. Delete the container using ``docker rm ``
-3. Prune unused Docker images using ``docker image prune`` (*Warning: this also removes you other unused images - not just Homarr*)
+1. Obtain the container ID of your Homarr container using `docker ps | grep homarr`.
+2. Delete the container using `docker rm `
+3. Prune unused Docker images using `docker image prune` (_Warning: this also removes you other unused images - not just Homarr_)
4. (Optional): Prune any network or volumes if you use any.
5. (Optional): Remove Homarr from your reverse proxy, VPNs or tunnels if you use any.
diff --git a/apps/docs/docs/getting-started/installation/helm.md b/apps/docs/docs/getting-started/installation/helm.md
index 051c38955..f3ad08b66 100644
--- a/apps/docs/docs/getting-started/installation/helm.md
+++ b/apps/docs/docs/getting-started/installation/helm.md
@@ -2,9 +2,9 @@
-
+
-
+
A Helm chart to deploy homarr for Kubernetes
@@ -12,7 +12,7 @@ A Helm chart to deploy homarr for Kubernetes
## Source Code
-*
+-
## Requirements
@@ -76,38 +76,38 @@ To avoid including sensitive information in plain text within your version contr
Below is an exhaustive list of all secrets:
-| FEATURE | SECRET NAME | SECRET KEYS | Required |
-|-----------|-------------------------|-----------------------------------------|----------|
-| OIDC | auth-oidc-secret | oidc-client-id oidc-client-secret | No |
-| LDAP | auth-ldap-secret | bind-password | No |
-| DATABASE | db-secret | db-url | No |
-| DATABASE | db-encryption | db-encryption-key | yes |
+| FEATURE | SECRET NAME | SECRET KEYS | Required |
+| -------- | ---------------- | ------------------------------------ | -------- |
+| OIDC | auth-oidc-secret | oidc-client-id oidc-client-secret | No |
+| LDAP | auth-ldap-secret | bind-password | No |
+| DATABASE | db-secret | db-url | No |
+| DATABASE | db-encryption | db-encryption-key | yes |
### Database
You have multiple options for configuring the database:
-| DRIVER TYPE | Persistence mode |
-|----------------|---------------------------------|
-| better-sqlite3 | Pod disk |
-| better-sqlite3 | homarr-database PVC |
-| mysql2 | External MySql database |
-| node-postgres | External Postgresql database |
+| DRIVER TYPE | Persistence mode |
+| -------------- | ---------------------------- |
+| better-sqlite3 | Pod disk |
+| better-sqlite3 | homarr-database PVC |
+| mysql2 | External MySql database |
+| node-postgres | External Postgresql database |
#### Pod disk
-No additional configuration is required. However, keep in mind that if the pod restarts, all data will be lost. This setup is not *recommended* for production use.
+No additional configuration is required. However, keep in mind that if the pod restarts, all data will be lost. This setup is not _recommended_ for production use.
To create the necessary database secret, execute the following command:
Required Secrets
-````yaml
+```yaml
kubectl create secret generic db-encryption \
--from-literal=db-encryption-key='' \
--namespace homarr
-````
+```
@@ -120,11 +120,11 @@ Associated secret to create :
DB Required Secrets
-````yaml
+```yaml
kubectl create secret generic db-encryption \
--from-literal=db-encryption-key='' \
--namespace homarr
-````
+```
@@ -133,13 +133,13 @@ Bellow an example of the override value file :
values.yaml
-````yaml
+```yaml
persistence:
homarrDatabase:
enabled: true
storageClassName: "default"
size: "1Gi"
-````
+```
@@ -150,17 +150,18 @@ To create the necessary database secrets, execute the following command:
Required Secrets
-````yaml
+```yaml
kubectl create secret generic db-encryption \
--from-literal=db-encryption-key='' \
--namespace homarr
-````
+```
-````yaml
+```yaml
kubectl create secret generic db-secret \
--from-literal=db-url='mysql://user:password@host:port/homarrdb' \
--namespace homarr
-````
+```
+
Below is an example of the override values file:
@@ -168,10 +169,11 @@ Below is an example of the override values file:
values.yaml
-````yaml
+```yaml
database:
type: mysql
-````
+```
+
#### External Postgresql database
@@ -181,17 +183,17 @@ To create the necessary database secrets, execute the following command:
Required Secrets
-````yaml
+```yaml
kubectl create secret generic db-encryption \
--from-literal=db-encryption-key='' \
--namespace homarr
-````
+```
-````yaml
+```yaml
kubectl create secret generic db-secret \
--from-literal=db-url='postgresql://user:password@host:port/homarrdb' \
--namespace homarr
-````
+```
@@ -200,10 +202,11 @@ Below is an example of the override values file:
values.yaml
-````yaml
+```yaml
database:
type: postgresql
-````
+```
+
### Ingress
@@ -213,7 +216,7 @@ The ingress section in the values.yaml file allows you to configure how external
values.yaml
-````yaml
+```yaml
service:
enabled: true # Ensure the service is enabled for Ingress to route traffic
ingress:
@@ -231,7 +234,8 @@ ingress:
- "homarr.homelab.dev"
- "www.homarr.homelab.dev"
secretName: homelab-tls
-````
+```
+
### HTTPRoute (Gateway API)
@@ -242,9 +246,9 @@ This provides a more expressive and future-proof alternative to Ingress, with su
values.yaml
-````yaml
+```yaml
service:
- enabled: true # must be enabled for HTTPRoute to forward traffic
+ enabled: true # must be enabled for HTTPRoute to forward traffic
httproute:
enabled: true
parentRefs:
@@ -267,7 +271,7 @@ httproute:
- parentRefs: the Gateway(s) this route attaches to. Gateways must already exist.
- hostnames: domain names this route applies to.
-- rules: each rule can define matches (paths, headers, queries), optional filters, and backendRefs to services
+- rules: each rule can define matches (paths, headers, queries), optional filters, and backendRefs to services
- TLS must be configured on the Gateway (not on HTTPRoute). For example, the Gateway can have a TLS listener for homarr.homelab.dev, and this route will automatically apply once matched.
### Certificates
@@ -284,7 +288,7 @@ Use inline certificates to generate a ConfigMap, mounted as individual files.
values.yaml
-````yaml
+```yaml
persistence:
homarrTrustedCerts:
enabled: true
@@ -298,7 +302,8 @@ persistence:
-----BEGIN CERTIFICATE-----
MIID...EFGH==
-----END CERTIFICATE-----
-````
+```
+
Behavior:
@@ -313,7 +318,7 @@ Use inline certificates to generate a Kubernetes Secret, mounted as files.
values.yaml
-````yaml
+```yaml
persistence:
homarrTrustedCerts:
enabled: true
@@ -327,7 +332,8 @@ persistence:
-----BEGIN CERTIFICATE-----
MIIC...XYZ==
-----END CERTIFICATE-----
-````
+```
+
Behavior:
@@ -342,16 +348,17 @@ Use an existing Kubernetes Secret, assuming its keys are filenames.
values.yaml
-````yaml
+```yaml
persistence:
homarrTrustedCerts:
enabled: true
type: existingSecret
existingSecretName: "existingSecretName"
existingSecretKeys:
- - cert3.crt
- - cert4.crt
-````
+ - cert3.crt
+ - cert4.crt
+```
+
Behavior:
@@ -429,7 +436,7 @@ All available values are listed on the [artifacthub](https://artifacthub.io/pack
| httproute.rules[0].matches[0].path.value | string | `"/"` | Path value to match |
| image.pullPolicy | string | `"IfNotPresent"` | Image pull policy |
| image.repository | string | `"ghcr.io/homarr-labs/homarr"` | Image repository |
-| image.tag | string | `"v1.73.0"` | Overrides the image tag whose default is the chart appVersion |
+| image.tag | string | `"v1.74.0"` | Overrides the image tag whose default is the chart appVersion |
| imagePullSecrets | list | `[]` | Secrets for Docker registry |
| ingress.annotations | object | `{}` | Ingress annotations |
| ingress.enabled | bool | `false` | Enable ingress |
@@ -482,4 +489,5 @@ All available values are listed on the [artifacthub](https://artifacthub.io/pack
| tolerations | list | `[]` | Node tolerations for pod scheduling |
---
+
Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)
diff --git a/apps/docs/docs/getting-started/installation/home-assistant.mdx b/apps/docs/docs/getting-started/installation/home-assistant.mdx
index 9f5a50f52..9ba9c5d01 100644
--- a/apps/docs/docs/getting-started/installation/home-assistant.mdx
+++ b/apps/docs/docs/getting-started/installation/home-assistant.mdx
@@ -14,7 +14,7 @@ Homarr can be seamlessly integrated into your Home Assistant setup with this add
## Installation
1. **Add Repository**: Navigate to your Home Assistant Supervisor panel, and go to the Add-on Store. Add the following repository URL: `https://github.com/Wiggen94/ha-homarr-v1-server` or click this button
-[](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2FWiggen94%2Fha-homarr-v1-server)
+ [](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2FWiggen94%2Fha-homarr-v1-server)
2. **Install the Add-on**: Search for "Homarr Server" in the Add-on Store and select it. Click on "Install" to start the installation process.
diff --git a/apps/docs/docs/getting-started/installation/portainer.mdx b/apps/docs/docs/getting-started/installation/portainer.mdx
index f816d77fe..0442b215e 100644
--- a/apps/docs/docs/getting-started/installation/portainer.mdx
+++ b/apps/docs/docs/getting-started/installation/portainer.mdx
@@ -1,5 +1,7 @@
# Portainer
+
## Portainer Stacks
+
### Prerequisites
- [Portainer Stacks](https://www.portainer.io/blog/stacks-docker-compose-the-portainer-way)
@@ -23,15 +25,14 @@ services:
environment:
- SECRET_ENCRYPTION_KEY=your_64_character_hex_string # <--- can be generated with `openssl rand -hex 32`
ports:
- - '7575:7575'
+ - "7575:7575"
```
-
:::note
-Portainer will mount the files to your host machine. Please make sure to replace ```` from the docker run command with your desired storage location. The path must be absolute.
+Portainer will mount the files to your host machine. Please make sure to replace `` from the docker run command with your desired storage location. The path must be absolute.
:::
-Then, click on ``Deploy the stack`` and wait until the container has started.
+Then, click on `Deploy the stack` and wait until the container has started.
:::tip
@@ -43,5 +44,5 @@ If you're unsure how to create a stack, checkout the [Portainer Documentation](h
To update Homarr using Docker Compose or Portainer Stacks, simply pull the latest image and restart the container.
-1. Run ``docker pull ghcr.io/homarr-labs/homarr:latest`` to pull the latest image.
-2. Re-run ``docker-compose up -d`` or re-deploy the stack in Portainer.
+1. Run `docker pull ghcr.io/homarr-labs/homarr:latest` to pull the latest image.
+2. Re-run `docker-compose up -d` or re-deploy the stack in Portainer.
diff --git a/apps/docs/docs/getting-started/installation/proxmox.mdx b/apps/docs/docs/getting-started/installation/proxmox.mdx
index f6f5fb120..bd33b4040 100644
--- a/apps/docs/docs/getting-started/installation/proxmox.mdx
+++ b/apps/docs/docs/getting-started/installation/proxmox.mdx
@@ -31,7 +31,7 @@ After you've installed Homarr, you can find a new LXC "homarr".
# Updating
-Updating is as simple as executing
+Updating is as simple as executing
```bash
update
@@ -49,17 +49,19 @@ Some Homarr features require setting environment variables. When installing Homa
# Troubleshooting
-If something does not work after an update, please first try rebooting the LXC or the homarr Service with
+If something does not work after an update, please first try rebooting the LXC or the homarr Service with
```bash
systemctl restart homarr
```
# Getting help
+
- If you are looking for help with the script, updating the LXC or troubleshooting the installer, please get in contact with the support of the community scripts. They provide support on their [Discord](https://discord.gg/2wvnMDgdnU). If you found vulnerabilities, bugs or have a request for the script, [create a new issue here](https://github.com/community-scripts/ProxmoxVE/issues/new/choose).
- If you are looking to report a bug, vulnerability or request a new feature, use https://github.com/homarr-labs/homarr . You can ask for help on our Discord.
# How to find logs
+
Homarr runs under a system service called `homarr`, so getting the logs is a simple as using the following command inside the LXC (Container) Shell
```bash
diff --git a/apps/docs/docs/getting-started/installation/qnap.mdx b/apps/docs/docs/getting-started/installation/qnap.mdx
index a655db5b3..b8c1f977b 100644
--- a/apps/docs/docs/getting-started/installation/qnap.mdx
+++ b/apps/docs/docs/getting-started/installation/qnap.mdx
@@ -4,6 +4,6 @@
QNAP installation guide has not updated to 1.0 yet. There guide is still for 0.15.10.
:::
-When installing on QNAP, we recommend you to install Homarr using [Container Station]( https://www.qnap.com/en/software/container-station) or [this third-party image](https://www.myqnap.org/product/homarr/).
+When installing on QNAP, we recommend you to install Homarr using [Container Station](https://www.qnap.com/en/software/container-station) or [this third-party image](https://www.myqnap.org/product/homarr/).
There is also a guide available, but note that it is written in Chinese: https://post.smzdm.com/p/awzm7op2/
diff --git a/apps/docs/docs/getting-started/installation/runtipi.mdx b/apps/docs/docs/getting-started/installation/runtipi.mdx
index 53a669c90..c2b2823b7 100644
--- a/apps/docs/docs/getting-started/installation/runtipi.mdx
+++ b/apps/docs/docs/getting-started/installation/runtipi.mdx
@@ -1,4 +1,4 @@
-# Runtipi
+# Runtipi
Runtipi is a self-hosted orchestrator that makes it easy to manage and run multiple services on a single server. It is based on Docker and comes with a simple web interface to manage your services. Runtipi is designed to be easy to use, so you don't have to worry about manual configuration or networking.
@@ -11,6 +11,7 @@ https://runtipi.io
# Installation
Installing Homarr is pretty untuitive, the app is available in the default appstore :
+
1. Search for **"Homarr"** in the App-Store page and select it
2. Click on **"Install"**.
3. Choose the method you want to access Homarr, through any port or domain name then select **"Install"**
@@ -18,13 +19,15 @@ Installing Homarr is pretty untuitive, the app is available in the default appst
# Maintenance
After installation, all you need is available from the WebUI in **"My apps"** > **"Homarr"** :
- - Start/Stop
- - Update
- - Backup
- - Logs
-
+
+- Start/Stop
+- Update
+- Backup
+- Logs
+
If you like to tinker with your apps, you can also edit your app's docker-compose with a [user-config](https://runtipi.io/docs/guides/customize-app-config).
# Getting help
+
- If you are looking for help with anything in Runtipi. They provide support on their [Discord](https://discord.gg/Bu9qEPnHsc) and [forums](https://forums.runtipi.io/). If you found vulnerabilities or bugs, [create a new issue here](https://github.com/runtipi/runtipi-appstore/issues).
-- If you are looking to report a bug, vulnerability or request a new feature for Homarr, use https://github.com/homarr-labs/homarr . You can ask for help on our Discord.
\ No newline at end of file
+- If you are looking to report a bug, vulnerability or request a new feature for Homarr, use https://github.com/homarr-labs/homarr . You can ask for help on our Discord.
diff --git a/apps/docs/docs/getting-started/installation/saltbox.mdx b/apps/docs/docs/getting-started/installation/saltbox.mdx
index 2f284d72b..88805eafb 100644
--- a/apps/docs/docs/getting-started/installation/saltbox.mdx
+++ b/apps/docs/docs/getting-started/installation/saltbox.mdx
@@ -5,6 +5,7 @@ Saltbox installation command has not updated to 1.0 yet. There command still run
:::
You can also use this to install on Saltbox:
+
```bash
sb install sandbox-homarr
-```
\ No newline at end of file
+```
diff --git a/apps/docs/docs/getting-started/installation/source.mdx b/apps/docs/docs/getting-started/installation/source.mdx
index 933b264dd..838f0d0a2 100644
--- a/apps/docs/docs/getting-started/installation/source.mdx
+++ b/apps/docs/docs/getting-started/installation/source.mdx
@@ -28,15 +28,29 @@ This method is only useful, when you want to develop on Homarr or extend it with
## Steps
-
Clone the Repository using git clone https://github.com/homarr-labs/homarr.git
-
Enter the created directory using cd homarr
-
Install all dependencies using pnpm install
-
Copy the `.env.example` file to `.env` and replace `DB_URL` with the full path you want to use for the sqlite database file. For example `DB_URL='/home/username/homarr/db.sqlite`
-
Replace `AUTH_SECRET` and `SECRET_ENCRYPTION_KEY` both with a secure random string by using `openssl rand -hex 32`
+
+ Clone the Repository using git clone https://github.com/homarr-labs/homarr.git
+
+
+ Enter the created directory using cd homarr
+
+
+ Install all dependencies using pnpm install
+
+
+ Copy the `.env.example` file to `.env` and replace `DB_URL` with the full path you want to use for the sqlite
+ database file. For example `DB_URL='/home/username/homarr/db.sqlite`
+
+
+ Replace `AUTH_SECRET` and `SECRET_ENCRYPTION_KEY` both with a secure random string by using `openssl rand -hex 32`
+
Replace `CRON_JOB_API_KEY` with a secure random string by using `openssl rand -base64 32`
Run `pnpm run db:migration:sqlite:run` and wait that it completes
Build the source using `pnpm build`
-
Copy better-sqlite3.node files with `mkdir build` and `cp ./node_modules/better-sqlite3/build/Release/better_sqlite3.node ./build/better_sqlite3.node`
+
+ Copy better-sqlite3.node files with `mkdir build` and `cp
+ ./node_modules/better-sqlite3/build/Release/better_sqlite3.node ./build/better_sqlite3.node`
+
Start a redis server using `redis-server`
Run the server using `pnpm start`
Open `http://localhost:3000` in your browser
diff --git a/apps/docs/docs/getting-started/installation/unraid.mdx b/apps/docs/docs/getting-started/installation/unraid.mdx
index 5fa7cc9b0..18588c5d4 100644
--- a/apps/docs/docs/getting-started/installation/unraid.mdx
+++ b/apps/docs/docs/getting-started/installation/unraid.mdx
@@ -1,5 +1,5 @@
-import Link from '@docusaurus/Link';
-import { IconDownload } from '@tabler/icons-react';
+import Link from "@docusaurus/Link";
+import { IconDownload } from "@tabler/icons-react";
# Unraid
@@ -14,17 +14,17 @@ You can install Homarr directly from your Unraid Dashboard, no terminal required
-
+
Install community applications plugin
-
-
+
+
:::tip
@@ -46,4 +46,3 @@ After you've installed the Community Apps Plugin, you can install Homarr from th
After you've installed Homarr, you can find it under the tab "Docker".
The official support thread is located [here](https://forums.unraid.net/topic/123478-support-smartphonelover-homarr/), but we prefer to communicate over GitHub and Discord instead.
-
diff --git a/apps/docs/docs/integrations/adguard-home/index.mdx b/apps/docs/docs/integrations/adguard-home/index.mdx
index b4cb6cdb6..52b26f66f 100644
--- a/apps/docs/docs/integrations/adguard-home/index.mdx
+++ b/apps/docs/docs/integrations/adguard-home/index.mdx
@@ -1,37 +1,44 @@
---
-title: 'AdGuard Home'
+title: "AdGuard Home"
description: "AdGuard Home is a network-wide software for blocking ads and trackers, providing a safer and faster internet experience."
hide_title: true
---
-import { IntegrationHeader } from '@site/src/components/integrations/header';
-import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
-import { AddingIntegration } from '@site/src/components/integrations/adding';
-import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
+import { IntegrationHeader } from "@site/src/components/integrations/header";
+import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
+import { AddingIntegration } from "@site/src/components/integrations/adding";
+import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconAd, IconDeviceGamepad } from "@tabler/icons-react";
-import { adguardHomeIntegration } from '.';
-import { dnsHoleSummaryWidget } from '@site/docs/widgets/dns-hole-summary';
-import { dnsHoleControlsWidget } from '@site/docs/widgets/dns-hole-controls';
+import { adguardHomeIntegration } from ".";
+import { dnsHoleSummaryWidget } from "@site/docs/widgets/dns-hole-summary";
+import { dnsHoleControlsWidget } from "@site/docs/widgets/dns-hole-controls";
-
+
### Widgets & Capabilities
+
### Adding the integration
+
### Secrets
-
\ No newline at end of file
+
+
diff --git a/apps/docs/docs/integrations/anchor/index.mdx b/apps/docs/docs/integrations/anchor/index.mdx
index e4d897767..2e43195cc 100644
--- a/apps/docs/docs/integrations/anchor/index.mdx
+++ b/apps/docs/docs/integrations/anchor/index.mdx
@@ -1,40 +1,45 @@
---
-title: 'Anchor'
+title: "Anchor"
description: "Anchor is a self-hosted note-taking application."
hide_title: true
---
-import { IntegrationHeader } from '@site/src/components/integrations/header';
-import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
-import { AddingIntegration } from '@site/src/components/integrations/adding';
-import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
-import { anchorIntegration } from '.';
-import { anchorNoteWidget } from '@site/docs/widgets/anchor-note';
+import { IntegrationHeader } from "@site/src/components/integrations/header";
+import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
+import { AddingIntegration } from "@site/src/components/integrations/adding";
+import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
+import { anchorIntegration } from ".";
+import { anchorNoteWidget } from "@site/docs/widgets/anchor-note";
-
-
+
The Anchor integration lets Homarr connect to your Anchor instance so you can display and edit selected notes directly from your dashboard.
### Widgets & Capabilities
+
### Adding the integration
+
### Secrets
-
+
+
diff --git a/apps/docs/docs/integrations/aria2/index.mdx b/apps/docs/docs/integrations/aria2/index.mdx
index 9950fec2f..8ec92a5d0 100644
--- a/apps/docs/docs/integrations/aria2/index.mdx
+++ b/apps/docs/docs/integrations/aria2/index.mdx
@@ -1,38 +1,43 @@
---
-title: 'Aria2'
+title: "Aria2"
description: "Lightweight multiprotocol & multi-source command-line download utility. It supports HTTP/HTTPS, FTP, SFTP, BitTorrent and Metalink"
hide_title: true
---
-import { IntegrationHeader } from '@site/src/components/integrations/header';
-import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
-import { AddingIntegration } from '@site/src/components/integrations/adding';
-import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
-import { aria2Integration } from '.';
-import { downloadsWidget } from '@site/docs/widgets/downloads';
+import { IntegrationHeader } from "@site/src/components/integrations/header";
+import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
+import { AddingIntegration } from "@site/src/components/integrations/adding";
+import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
+import { aria2Integration } from ".";
+import { downloadsWidget } from "@site/docs/widgets/downloads";
-
+
### Widgets & Capabilities
+
### Adding the integration
+
### Secrets
-
\ No newline at end of file
+
+
diff --git a/apps/docs/docs/integrations/audiobookshelf/index.mdx b/apps/docs/docs/integrations/audiobookshelf/index.mdx
index 156525ba5..a052d2fff 100644
--- a/apps/docs/docs/integrations/audiobookshelf/index.mdx
+++ b/apps/docs/docs/integrations/audiobookshelf/index.mdx
@@ -1,41 +1,40 @@
---
-title: 'Audiobookshelf'
+title: "Audiobookshelf"
description: "Audiobookshelf is a self-hosted audiobook and podcast server that lets you manage and stream your audio library."
hide_title: true
---
-import { IntegrationHeader } from '@site/src/components/integrations/header';
-import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
-import { AddingIntegration } from '@site/src/components/integrations/adding';
-import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
-import { audiobookshelfIntegration } from '.';
-import { audioStatsWidget } from '@site/docs/widgets/audio-stats';
+import { IntegrationHeader } from "@site/src/components/integrations/header";
+import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
+import { AddingIntegration } from "@site/src/components/integrations/adding";
+import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
+import { audiobookshelfIntegration } from ".";
+import { audioStatsWidget } from "@site/docs/widgets/audio-stats";
-
-
+
Audiobookshelf provides library statistics including audiobook and podcast counts, listening time, and active sessions.
### Widgets & Capabilities
-
+
+
### Adding the integration
+
### Secrets
-
+
+
diff --git a/apps/docs/docs/integrations/bazarr/index.mdx b/apps/docs/docs/integrations/bazarr/index.mdx
index f9400a45e..7e1ad2d64 100644
--- a/apps/docs/docs/integrations/bazarr/index.mdx
+++ b/apps/docs/docs/integrations/bazarr/index.mdx
@@ -1,31 +1,30 @@
---
-title: 'Bazarr'
+title: "Bazarr"
description: "Bazarr is a companion application to Sonarr and Radarr that manages and downloads subtitles."
hide_title: true
---
-import { IntegrationHeader } from '@site/src/components/integrations/header';
-import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
-import { AddingIntegration } from '@site/src/components/integrations/adding';
-import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
-import { bazarrIntegration } from '.';
-import { bazarrWidget } from '@site/docs/widgets/bazarr';
+import { IntegrationHeader } from "@site/src/components/integrations/header";
+import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
+import { AddingIntegration } from "@site/src/components/integrations/adding";
+import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
+import { bazarrIntegration } from ".";
+import { bazarrWidget } from "@site/docs/widgets/bazarr";
-
+
Bazarr complements Sonarr and Radarr by managing subtitle downloads. The Homarr integration uses your Bazarr API key to fetch missing subtitle counts and health badges.
### Screenshots
-import apiKeySettings from './img/api-key-settings.png';
-import widgetOverview from '@site/docs/widgets/bazarr/img/widget-overview.png';
+import apiKeySettings from "./img/api-key-settings.png";
+import widgetOverview from "@site/docs/widgets/bazarr/img/widget-overview.png";
-
API key location in Bazarr (Settings → General → Security):
+
+ API key location in Bazarr (Settings → General → Security):
+
@@ -35,20 +34,25 @@ import widgetOverview from '@site/docs/widgets/bazarr/img/widget-overview.png';
### Widgets & Capabilities
-
+
+
### Adding the integration
+
### Secrets
+
You can find your Bazarr API key under **Settings → General → Security**.
-
+
diff --git a/apps/docs/docs/integrations/beszel/index.mdx b/apps/docs/docs/integrations/beszel/index.mdx
index 0c93cdc9f..8ddda77c6 100644
--- a/apps/docs/docs/integrations/beszel/index.mdx
+++ b/apps/docs/docs/integrations/beszel/index.mdx
@@ -1,25 +1,22 @@
---
-title: 'Beszel'
+title: "Beszel"
description: "Beszel is a lightweight server monitoring platform with Docker stats, historical data, and alert functions."
hide_title: true
---
-import { IntegrationHeader } from '@site/src/components/integrations/header';
-import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
-import { AddingIntegration } from '@site/src/components/integrations/adding';
-import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
-import { beszelIntegration } from '.';
-import { beszelSystemStatsWidget } from '@site/docs/widgets/beszel-system-stats';
-import { beszelSystemGridWidget } from '@site/docs/widgets/beszel-system-grid';
-import { beszelSystemTableWidget } from '@site/docs/widgets/beszel-system-table';
-import { beszelAlertsWidget } from '@site/docs/widgets/beszel-alerts';
+import { IntegrationHeader } from "@site/src/components/integrations/header";
+import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
+import { AddingIntegration } from "@site/src/components/integrations/adding";
+import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
+import { beszelIntegration } from ".";
+import { beszelSystemStatsWidget } from "@site/docs/widgets/beszel-system-stats";
+import { beszelSystemGridWidget } from "@site/docs/widgets/beszel-system-grid";
+import { beszelSystemTableWidget } from "@site/docs/widgets/beszel-system-table";
+import { beszelAlertsWidget } from "@site/docs/widgets/beszel-alerts";
-import beszelDashboard from './img/beszel-dashboard.png';
+import beszelDashboard from "./img/beszel-dashboard.png";
-
+
Beszel monitors your servers in real time via lightweight agents, collecting CPU, memory, disk, network, GPU, temperature, and Docker container metrics. It stores historical data and supports configurable alerts.
@@ -28,26 +25,33 @@ Beszel monitors your servers in real time via lightweight agents, collecting CPU
### Widgets & Capabilities
+
### Adding the integration
+
### Secrets
-
+
+
:::tip
Beszel uses PocketBase under the hood. The default admin credentials are set during the initial Beszel setup.
diff --git a/apps/docs/docs/integrations/coolify/index.mdx b/apps/docs/docs/integrations/coolify/index.mdx
index 56e5e6c29..7b828cc18 100644
--- a/apps/docs/docs/integrations/coolify/index.mdx
+++ b/apps/docs/docs/integrations/coolify/index.mdx
@@ -1,29 +1,24 @@
---
-title: 'Coolify'
-description: 'Self-hosted PaaS and deployment platform'
+title: "Coolify"
+description: "Self-hosted PaaS and deployment platform"
hide_title: true
---
-import { IntegrationHeader } from '@site/src/components/integrations/header';
-import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
-import { AddingIntegration } from '@site/src/components/integrations/adding';
-import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
-import { coolifyIntegration } from '.';
-import { coolifyWidget } from '../../widgets/coolify';
+import { IntegrationHeader } from "@site/src/components/integrations/header";
+import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
+import { AddingIntegration } from "@site/src/components/integrations/adding";
+import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
+import { coolifyIntegration } from ".";
+import { coolifyWidget } from "../../widgets/coolify";
-
+
### Widgets & Capabilities
-
+
+
### Adding the integration
+
:::info URL configuration
@@ -31,16 +26,28 @@ Use the root URL of your Coolify instance, for example `https://coolify.example.
:::
### Secrets
-Enable API access under Settings > Advanced if it is disabled.),
- (Go to Security > API Tokens.),
- 'Enter a name, e.g. "Homarr".',
- (Select the read permission. The Coolify widget only reads version, server, project, application, and service data.),
- 'Click "Create".',
- 'Copy the generated token immediately. Coolify only shows it once.',
- 'Paste the token into the API Key field in Homarr.'
- ]
-}]} />
+
+
+ Enable API access under Settings > Advanced if it is disabled.
+ ,
+
+ Go to Security > API Tokens.
+ ,
+ 'Enter a name, e.g. "Homarr".',
+
+ Select the read permission. The Coolify widget only reads version, server, project, application,
+ and service data.
+ ,
+ 'Click "Create".',
+ "Copy the generated token immediately. Coolify only shows it once.",
+ "Paste the token into the API Key field in Homarr.",
+ ],
+ },
+ ]}
+/>
diff --git a/apps/docs/docs/integrations/dash-dot/index.mdx b/apps/docs/docs/integrations/dash-dot/index.mdx
index 512bc6c8d..9c400321c 100644
--- a/apps/docs/docs/integrations/dash-dot/index.mdx
+++ b/apps/docs/docs/integrations/dash-dot/index.mdx
@@ -1,32 +1,33 @@
---
-title: 'Dash.'
+title: "Dash."
description: "Dash. is a system performance and resource monitoring tool"
hide_title: true
---
-import { IntegrationHeader } from '@site/src/components/integrations/header';
-import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
-import { AddingIntegration } from '@site/src/components/integrations/adding';
-import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
+import { IntegrationHeader } from "@site/src/components/integrations/header";
+import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
+import { AddingIntegration } from "@site/src/components/integrations/adding";
+import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconHeartRateMonitor } from "@tabler/icons-react";
-import { dashDotIntegration } from '.';
-import { healthMonitoringWidget } from '@site/docs/widgets/health-monitoring';
-import { systemResourcesWidget } from '@site/docs/widgets/system-resources';
+import { dashDotIntegration } from ".";
+import { healthMonitoringWidget } from "@site/docs/widgets/health-monitoring";
+import { systemResourcesWidget } from "@site/docs/widgets/system-resources";
-
-
+
### Widgets & Capabilities
+
### Adding the integration
-
\ No newline at end of file
+
+
diff --git a/apps/docs/docs/integrations/deluge/index.mdx b/apps/docs/docs/integrations/deluge/index.mdx
index 24aadb910..89f906c0c 100644
--- a/apps/docs/docs/integrations/deluge/index.mdx
+++ b/apps/docs/docs/integrations/deluge/index.mdx
@@ -1,36 +1,41 @@
---
-title: 'Deluge'
+title: "Deluge"
description: "Deluge is a lightweight, Free Software, cross-platform BitTorrent client."
hide_title: true
---
-import { IntegrationHeader } from '@site/src/components/integrations/header';
-import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
-import { AddingIntegration } from '@site/src/components/integrations/adding';
-import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
+import { IntegrationHeader } from "@site/src/components/integrations/header";
+import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
+import { AddingIntegration } from "@site/src/components/integrations/adding";
+import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconDownload } from "@tabler/icons-react";
-import Alert from '@theme/Admonition';
-import { delugeIntegration } from '.';
-import { downloadsWidget } from '@site/docs/widgets/downloads';
+import Alert from "@theme/Admonition";
+import { delugeIntegration } from ".";
+import { downloadsWidget } from "@site/docs/widgets/downloads";
-
-
+
### Widgets & Capabilities
+
### Adding the integration
+
### Secrets
-
\ No newline at end of file
+
+
diff --git a/apps/docs/docs/integrations/docker/index.mdx b/apps/docs/docs/integrations/docker/index.mdx
index 2af43c67e..40ade4912 100644
--- a/apps/docs/docs/integrations/docker/index.mdx
+++ b/apps/docs/docs/integrations/docker/index.mdx
@@ -1,32 +1,31 @@
---
-title: 'Docker'
+title: "Docker"
description: "Docker is a platform where you can run your applications in containers, allowing for easy deployment and management of applications."
hide_title: true
---
-import { IntegrationHeader } from '@site/src/components/integrations/header';
-import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
-import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
+import { IntegrationHeader } from "@site/src/components/integrations/header";
+import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
+import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconBrandDocker, IconTool } from "@tabler/icons-react";
-import { dockerIntegration } from '.';
-import { dockerContainersWidget } from '@site/docs/widgets/docker-containers';
+import { dockerIntegration } from ".";
+import { dockerContainersWidget } from "@site/docs/widgets/docker-containers";
-
-
+
### Widgets & Capabilities
+
-
## Enabling the Docker integration
+
This integration must first be enabled.
If you directly run on the host system and you have docker installed, it will be enabled by default.
Otherwise, you'll need to mount the [docker socket](https://docs.docker.com/engine/security/protect-access/) to the Homarr container,
@@ -49,7 +48,7 @@ services:
environment:
- SECRET_ENCRYPTION_KEY=your_64_character_hex_string # <--- can be generated with `openssl rand -hex 32`
ports:
- - '7575:7575'
+ - "7575:7575"
```
With docker run, add this parameter: `-v /var/run/docker.sock:/var/run/docker.sock`.
@@ -124,8 +123,10 @@ services:
```
### Managing your Docker containers within Homarr
+
Homarr allows you to interact with Docker containers running on your system.
Each container row has an action menu with the following options:
+
- **View logs** - opens a dedicated logs page with a live terminal
- **Start** - start a stopped container
- **Stop** - stop a running container
@@ -166,11 +167,13 @@ Currently Homarr supports one label for configuration of the containers:
- **homarr.hide:** If set to any value, the container will be hidden from the Docker Containers widget and tools page.
### Security
+
Mounting docker sockets can be risky, as they permit full control over your docker service.
As an example, a thread actor could abuse Homarr use the socket to start, stop or delete containers on your system.
Therefore we recommend the usage of a socket proxy, which can prohibit certain actions.
A few examples include:
+
- https://github.com/linuxserver/docker-socket-proxy
- https://github.com/Tecnativa/docker-socket-proxy
@@ -178,36 +181,44 @@ See documentation of the respective proxies on how to configure them.
Homarr may behave in unexpected ways when you use proxies.
#### Permissions
+
Homarr needs the following permissions from the Docker API:
+
- Containers/Start
- Containers/Stop
- Containers/Restart
- Containers/Remove
For socket proxies, you will need these permissions:
+
- `CONTAINERS=1`
- `POST=1`
**Caution:** `POST` access is security critical as it provides extensive capabilities to modify your docker environment. Please leave it disabled if you're concerned about this.
As a workaround, you can use [LSIO's socket proxy](https://github.com/linuxserver/docker-socket-proxy) and set the following:
+
- ALLOW_START=1
- ALLOW_STOP=1
- ALLOW_RESTARTS=1
-These will work even with `POST=0`.
+These will work even with `POST=0`.
You lose the ability to remove containers, but start, stop and restarts should work just fine.
#### Connecting to Docker via Socket Proxies
+
To connect to Docker via a socket proxy, you'll need to add these two environment variables in the compose file:
+
- `DOCKER_HOSTNAMES=`
- `DOCKER_PORTS=`
Refer: https://homarr.dev/docs/advanced/environment-variables/
You will also need to add Homarr to the network of your socket proxy. You can do it like this:
+
1. Add the network to your compose file (with appropriate changes):
+
```yaml
networks:
socket-proxy:
@@ -216,6 +227,7 @@ networks:
```
2. Add the network to the homarr service in the compose file:
+
```yaml
networks:
- socket-proxy
diff --git a/apps/docs/docs/integrations/emby/index.mdx b/apps/docs/docs/integrations/emby/index.mdx
index 907d2bd96..2426a1561 100644
--- a/apps/docs/docs/integrations/emby/index.mdx
+++ b/apps/docs/docs/integrations/emby/index.mdx
@@ -1,37 +1,35 @@
---
-title: 'Emby'
+title: "Emby"
description: "Emby is a media server platform that allows you to organize, manage, and stream your personal media collection."
hide_title: true
---
-import { IntegrationHeader } from '@site/src/components/integrations/header';
-import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
-import { AddingIntegration } from '@site/src/components/integrations/adding';
-import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
+import { IntegrationHeader } from "@site/src/components/integrations/header";
+import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
+import { AddingIntegration } from "@site/src/components/integrations/adding";
+import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconVideo, IconTicket } from "@tabler/icons-react";
-import { embyIntegration } from '.';
-import { mediaServerWidget } from '@site/docs/widgets/media-server';
-import { mediaReleasesWidget } from '@site/docs/widgets/media-releases';
+import { embyIntegration } from ".";
+import { mediaServerWidget } from "@site/docs/widgets/media-server";
+import { mediaReleasesWidget } from "@site/docs/widgets/media-releases";
-
-
+
### Widgets & Capabilities
-
+
+
### Adding the integration
+
### Secrets
-
\ No newline at end of file
+
+
diff --git a/apps/docs/docs/integrations/glances/index.mdx b/apps/docs/docs/integrations/glances/index.mdx
index 2639f87e5..bd047e81d 100644
--- a/apps/docs/docs/integrations/glances/index.mdx
+++ b/apps/docs/docs/integrations/glances/index.mdx
@@ -1,37 +1,43 @@
---
-title: 'Glances'
+title: "Glances"
description: "Glances is a cross-platform system monitoring tool."
hide_title: true
---
-import { IntegrationHeader } from '@site/src/components/integrations/header';
-import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
-import { AddingIntegration } from '@site/src/components/integrations/adding';
-import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
-import { glancesIntegration } from '.';
-import { systemResourcesWidget } from '@site/docs/widgets/system-resources';
-import { healthMonitoringWidget } from '@site/docs/widgets/health-monitoring';
+import { IntegrationHeader } from "@site/src/components/integrations/header";
+import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
+import { AddingIntegration } from "@site/src/components/integrations/adding";
+import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
+import { glancesIntegration } from ".";
+import { systemResourcesWidget } from "@site/docs/widgets/system-resources";
+import { healthMonitoringWidget } from "@site/docs/widgets/health-monitoring";
-
-
+
### Widgets & Capabilities
+
### Adding the integration
+
### Secrets
-
\ No newline at end of file
+
+
diff --git a/apps/docs/docs/integrations/gluetun/index.mdx b/apps/docs/docs/integrations/gluetun/index.mdx
index 7c936fc1f..dca490781 100644
--- a/apps/docs/docs/integrations/gluetun/index.mdx
+++ b/apps/docs/docs/integrations/gluetun/index.mdx
@@ -1,20 +1,17 @@
---
-title: 'Gluetun'
-description: 'Connect Gluetun to Homarr as a VPN integration.'
+title: "Gluetun"
+description: "Connect Gluetun to Homarr as a VPN integration."
hide_title: true
---
-import { IntegrationHeader } from '@site/src/components/integrations/header';
-import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
-import { AddingIntegration } from '@site/src/components/integrations/adding';
-import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
-import { gluetunIntegration } from '.';
-import { vpnWidget } from '@site/docs/widgets/vpn';
+import { IntegrationHeader } from "@site/src/components/integrations/header";
+import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
+import { AddingIntegration } from "@site/src/components/integrations/adding";
+import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
+import { gluetunIntegration } from ".";
+import { vpnWidget } from "@site/docs/widgets/vpn";
-
+
[Gluetun](https://github.com/qdm12/gluetun) exposes a control server that Homarr can query to report the VPN tunnel
status, DNS status, public IP address, and active provider details in the VPN widget.
@@ -22,9 +19,11 @@ status, DNS status, public IP address, and active provider details in the VPN wi
### Widgets & Capabilities
### Setting up the Gluetun control server
@@ -40,13 +39,20 @@ Refer to the [Gluetun control server documentation](https://github.com/qdm12/glu
Gluetun's control server can be left unprotected or secured with either an API key or HTTP Basic authentication.
Choose the option that matches how your Gluetun instance integration is set up.
-
+
diff --git a/apps/docs/docs/integrations/gotify/index.mdx b/apps/docs/docs/integrations/gotify/index.mdx
index 09c81265b..43cde77b0 100644
--- a/apps/docs/docs/integrations/gotify/index.mdx
+++ b/apps/docs/docs/integrations/gotify/index.mdx
@@ -1,33 +1,39 @@
---
-title: 'Gotify'
+title: "Gotify"
description: "Gotify is a simple, self-hosted server for sending and receiving messages in real time."
hide_title: true
---
-import { notificationsWidget } from '@site/docs/widgets/notifications';
-import { AddingIntegration } from '@site/src/components/integrations/adding';
-import { IntegrationHeader } from '@site/src/components/integrations/header';
-import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
-import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
-import { gotifyIntegration } from '.';
+import { notificationsWidget } from "@site/docs/widgets/notifications";
+import { AddingIntegration } from "@site/src/components/integrations/adding";
+import { IntegrationHeader } from "@site/src/components/integrations/header";
+import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
+import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
+import { gotifyIntegration } from ".";
-
+
### Widgets & Capabilities
+
### Adding the integration
+
### Secrets
-
+
+
diff --git a/apps/docs/docs/integrations/home-assistant/index.mdx b/apps/docs/docs/integrations/home-assistant/index.mdx
index 98ad591d6..65d09d166 100644
--- a/apps/docs/docs/integrations/home-assistant/index.mdx
+++ b/apps/docs/docs/integrations/home-assistant/index.mdx
@@ -1,45 +1,51 @@
---
-title: 'Home Assistant'
+title: "Home Assistant"
description: "Home Assistant is an open-source home automation platform that focuses on privacy and local control, allowing you to automate and control your smart home devices."
hide_title: true
---
-import { IntegrationHeader } from '@site/src/components/integrations/header';
-import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
-import { AddingIntegration } from '@site/src/components/integrations/adding';
-import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
+import { IntegrationHeader } from "@site/src/components/integrations/header";
+import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
+import { AddingIntegration } from "@site/src/components/integrations/adding";
+import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconBinaryTree } from "@tabler/icons-react";
-import { homeAssistantIntegration } from '.';
-import { smartHomeEntityStateWidget } from '@site/docs/widgets/smart-home-entity-state';
-import { smartHomeExecuteAutomationWidget } from '@site/docs/widgets/smart-home-execute-automation';
+import { homeAssistantIntegration } from ".";
+import { smartHomeEntityStateWidget } from "@site/docs/widgets/smart-home-entity-state";
+import { smartHomeExecuteAutomationWidget } from "@site/docs/widgets/smart-home-execute-automation";
-
-
+
### Widgets & Capabilities
+
### Adding the integration
+
### Secrets
-
\ No newline at end of file
+ ],
+ },
+ ]}
+/>
diff --git a/apps/docs/docs/integrations/ical/index.mdx b/apps/docs/docs/integrations/ical/index.mdx
index 5f5ffc422..475229a34 100644
--- a/apps/docs/docs/integrations/ical/index.mdx
+++ b/apps/docs/docs/integrations/ical/index.mdx
@@ -1,38 +1,44 @@
---
-title: 'iCal'
+title: "iCal"
description: "iCal is a standard for calendar data exchange, allowing users to share and manage calendar events across different platforms."
hide_title: true
---
-import { IntegrationHeader } from '@site/src/components/integrations/header';
-import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
-import { AddingIntegration } from '@site/src/components/integrations/adding';
-import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
+import { IntegrationHeader } from "@site/src/components/integrations/header";
+import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
+import { AddingIntegration } from "@site/src/components/integrations/adding";
+import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconZoomQuestion, IconChartBar, IconSearch } from "@tabler/icons-react";
-import { icalIntegration } from '.';
-import { calendarWidget } from '@site/docs/widgets/calendar';
+import { icalIntegration } from ".";
+import { calendarWidget } from "@site/docs/widgets/calendar";
-
+
### Widgets & Capabilities
+
### Adding the integration
+
### Secrets
-
+
+
## Using the iCal integration
-The iCal integration allows you to add external calendars to Homarr. Any calendar that provides a public iCal URL can be integrated, such as Google Calendar, Apple Calendar, or Outlook.
\ No newline at end of file
+The iCal integration allows you to add external calendars to Homarr. Any calendar that provides a public iCal URL can be integrated, such as Google Calendar, Apple Calendar, or Outlook.
diff --git a/apps/docs/docs/integrations/immich/index.mdx b/apps/docs/docs/integrations/immich/index.mdx
index a0a351f15..d29e6cdab 100644
--- a/apps/docs/docs/integrations/immich/index.mdx
+++ b/apps/docs/docs/integrations/immich/index.mdx
@@ -1,36 +1,29 @@
---
-title: 'Immich'
+title: "Immich"
description: "Self-hosted photo and video management solution"
hide_title: true
---
-import { immichAlbumCarouselWidget } from '../../widgets/immich-album-carousel';import {
- IntegrationHeader
-} from '@site/src/components/integrations/header';
-import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
-import { AddingIntegration } from '@site/src/components/integrations/adding';
-import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
-import { immichIntegration } from '.';
-import { immichServerStatsWidget } from '../../widgets/immich-server-stats';
+import { immichAlbumCarouselWidget } from "../../widgets/immich-album-carousel";
+import { IntegrationHeader } from "@site/src/components/integrations/header";
+import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
+import { AddingIntegration } from "@site/src/components/integrations/adding";
+import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
+import { immichIntegration } from ".";
+import { immichServerStatsWidget } from "../../widgets/immich-server-stats";
-
-
+
### Widgets & Capabilities
-
+
+
### Adding the integration
+
### Secrets
+
),
- 'Create the integration in Homarr and copy the API key to there'
- ]
+'Create the integration in Homarr and copy the API key to there'
+]
}]} />
diff --git a/apps/docs/docs/integrations/jellyfin/index.mdx b/apps/docs/docs/integrations/jellyfin/index.mdx
index 4826386b8..83e23fd45 100644
--- a/apps/docs/docs/integrations/jellyfin/index.mdx
+++ b/apps/docs/docs/integrations/jellyfin/index.mdx
@@ -1,40 +1,39 @@
---
-title: 'Jellyfin'
+title: "Jellyfin"
description: "Jellyfin is a free and open-source media server software that allows you to organize, manage, and share your media files."
hide_title: true
---
-import { IntegrationHeader } from '@site/src/components/integrations/header';
-import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
-import { AddingIntegration } from '@site/src/components/integrations/adding';
-import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
+import { IntegrationHeader } from "@site/src/components/integrations/header";
+import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
+import { AddingIntegration } from "@site/src/components/integrations/adding";
+import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconVideo, IconTicket } from "@tabler/icons-react";
-import { jellyfinIntegration } from '.';
-import { mediaServerWidget } from '@site/docs/widgets/media-server';
-import { mediaReleasesWidget } from '@site/docs/widgets/media-releases';
+import { jellyfinIntegration } from ".";
+import { mediaServerWidget } from "@site/docs/widgets/media-server";
+import { mediaReleasesWidget } from "@site/docs/widgets/media-releases";
-
-
+
### Widgets & Capabilities
-
+
+
### Adding the integration
+
### Secrets
-
\ No newline at end of file
+
+
diff --git a/apps/docs/docs/integrations/jellyseerr/index.mdx b/apps/docs/docs/integrations/jellyseerr/index.mdx
index a85d7bd9f..e752906bb 100644
--- a/apps/docs/docs/integrations/jellyseerr/index.mdx
+++ b/apps/docs/docs/integrations/jellyseerr/index.mdx
@@ -1,45 +1,52 @@
---
-title: 'Jellyseerr'
+title: "Jellyseerr"
description: "Jellyseerr is a self-hosted media request management system that integrates with Jellyfin and other media servers."
hide_title: true
---
-import { IntegrationHeader } from '@site/src/components/integrations/header';
-import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
-import { AddingIntegration } from '@site/src/components/integrations/adding';
-import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
+import { IntegrationHeader } from "@site/src/components/integrations/header";
+import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
+import { AddingIntegration } from "@site/src/components/integrations/adding";
+import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconZoomQuestion, IconChartBar, IconSearch } from "@tabler/icons-react";
-import { jellyseerrIntegration } from '.';
-import { mediaRequestListWidget } from '@site/docs/widgets/media-request-list';
-import { mediaRequestStatsWidget } from '@site/docs/widgets/media-request-stats';
+import { jellyseerrIntegration } from ".";
+import { mediaRequestListWidget } from "@site/docs/widgets/media-request-list";
+import { mediaRequestStatsWidget } from "@site/docs/widgets/media-request-stats";
-
-
+
### Widgets & Capabilities
+
### Adding the integration
+
### Secrets
-
\ No newline at end of file
+
+
diff --git a/apps/docs/docs/integrations/kubernetes/index.mdx b/apps/docs/docs/integrations/kubernetes/index.mdx
index 899c60931..662874467 100644
--- a/apps/docs/docs/integrations/kubernetes/index.mdx
+++ b/apps/docs/docs/integrations/kubernetes/index.mdx
@@ -1,20 +1,16 @@
---
-title: 'Kubernetes'
+title: "Kubernetes"
description: "Kubernetes is a powerful container orchestration platform that automates the deployment, scaling, and management of containerized applications."
hide_title: true
---
-import { IntegrationHeader } from '@site/src/components/integrations/header';
-import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
-import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
+import { IntegrationHeader } from "@site/src/components/integrations/header";
+import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
+import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconBrandDocker, IconTool } from "@tabler/icons-react";
-import { kubernetesIntegration } from '.';
+import { kubernetesIntegration } from ".";
-
-
+
Homarr provides a user-friendly Kubernetes dashboard that offers an overview of your cluster’s resources in a clear and structured interface. It allows users to view key Kubernetes objects, including `Pods`, `Services`, `Ingresses`, `Nodes`, `ConfigMaps`, `Secrets`, `Namespaces`, and `Volumes`, as well as basic metrics when the Kubernetes Metrics Server is enabled.
@@ -47,7 +43,7 @@ Enabling RBAC in the Helm chart creates the necessary Kubernetes Role-Based Acce
- Service Account: A dedicated service account for Homarr.
- Role & RoleBinding: Grants permissions within a specific namespace to list, watch, and get pods, services, secrets, configmaps, and more.
- ClusterRole & ClusterRoleBinding: Extends the same permissions cluster-wide for additional flexibility.
-:::
+ :::
### Homarr Dashboard Overview
diff --git a/apps/docs/docs/integrations/lidarr/index.mdx b/apps/docs/docs/integrations/lidarr/index.mdx
index 498503617..ad5916a3f 100644
--- a/apps/docs/docs/integrations/lidarr/index.mdx
+++ b/apps/docs/docs/integrations/lidarr/index.mdx
@@ -1,35 +1,40 @@
---
-title: 'Lidarr'
+title: "Lidarr"
description: "Lidarr is a music management tool that automates the process of downloading, sorting, and renaming music."
hide_title: true
---
-import { IntegrationHeader } from '@site/src/components/integrations/header';
-import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
-import { AddingIntegration } from '@site/src/components/integrations/adding';
-import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
+import { IntegrationHeader } from "@site/src/components/integrations/header";
+import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
+import { AddingIntegration } from "@site/src/components/integrations/adding";
+import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconCalendar } from "@tabler/icons-react";
-import { lidarrIntegration } from '.';
-import { calendarWidget } from '@site/docs/widgets/calendar';
+import { lidarrIntegration } from ".";
+import { calendarWidget } from "@site/docs/widgets/calendar";
-
-
+
### Widgets & Capabilities
+
### Adding the integration
+
### Secrets
-
\ No newline at end of file
+
+
diff --git a/apps/docs/docs/integrations/navidrome/index.mdx b/apps/docs/docs/integrations/navidrome/index.mdx
index 6a9f4059e..2f623f009 100644
--- a/apps/docs/docs/integrations/navidrome/index.mdx
+++ b/apps/docs/docs/integrations/navidrome/index.mdx
@@ -1,5 +1,5 @@
---
-title: 'Navidrome'
+title: "Navidrome"
description: "Navidrome is a self-hosted music server and streamer compatible with the Subsonic API."
hide_title: true
---
@@ -29,13 +29,19 @@ Navidrome provides music library statistics including artist, album, and song co
/>
### Adding the integration
+
### Secrets
-
+
+
diff --git a/apps/docs/docs/integrations/nextcloud/index.mdx b/apps/docs/docs/integrations/nextcloud/index.mdx
index ba5ab8ee9..f7d7e05fa 100644
--- a/apps/docs/docs/integrations/nextcloud/index.mdx
+++ b/apps/docs/docs/integrations/nextcloud/index.mdx
@@ -1,40 +1,43 @@
---
-title: 'Nextcloud'
+title: "Nextcloud"
description: "Nextcloud is a self-hosted productivity platform that provides file storage, collaboration tools, and more."
hide_title: true
---
-import { IntegrationHeader } from '@site/src/components/integrations/header';
-import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
-import { AddingIntegration } from '@site/src/components/integrations/adding';
-import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
+import { IntegrationHeader } from "@site/src/components/integrations/header";
+import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
+import { AddingIntegration } from "@site/src/components/integrations/adding";
+import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconCalendar } from "@tabler/icons-react";
-import Alert from '@theme/Admonition';
-import { nextcloudIntegration } from '.';
-import { calendarWidget } from '@site/docs/widgets/calendar';
-import { notificationsWidget } from '@site/docs/widgets/notifications';
+import Alert from "@theme/Admonition";
+import { nextcloudIntegration } from ".";
+import { calendarWidget } from "@site/docs/widgets/calendar";
+import { notificationsWidget } from "@site/docs/widgets/notifications";
-
+
### Widgets & Capabilities
-
+
+
### Adding the integration
+
### Secrets
-
- Users who use 2FA will have to use Nextcloud's App Password tool to grant Homarr access, as 2FA breaks the traditional process. For more information, see [Nextcloud's Documentation](https://docs.nextcloud.com/server/stable/admin_manual/configuration_user/authentication.html#app-passwords)
- ,
-}]} />
+
+
+ Users who use 2FA will have to use Nextcloud's App Password tool to grant Homarr access, as 2FA breaks the
+ traditional process. For more information, see [Nextcloud's
+ Documentation](https://docs.nextcloud.com/server/stable/admin_manual/configuration_user/authentication.html#app-passwords)
+
+ ),
+ },
+ ]}
+/>
diff --git a/apps/docs/docs/integrations/ntfy/index.mdx b/apps/docs/docs/integrations/ntfy/index.mdx
index 4b21d16a4..a132de923 100644
--- a/apps/docs/docs/integrations/ntfy/index.mdx
+++ b/apps/docs/docs/integrations/ntfy/index.mdx
@@ -1,37 +1,44 @@
---
-title: 'Ntfy'
+title: "Ntfy"
description: "Ntfy is a simple, open-source notification service that allows you to send and receive notifications across devices."
hide_title: true
---
-import { notificationsWidget } from '@site/docs/widgets/notifications';
-import { AddingIntegration } from '@site/src/components/integrations/adding';
-import { IntegrationHeader } from '@site/src/components/integrations/header';
-import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
-import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
+import { notificationsWidget } from "@site/docs/widgets/notifications";
+import { AddingIntegration } from "@site/src/components/integrations/adding";
+import { IntegrationHeader } from "@site/src/components/integrations/header";
+import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
+import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { IconMessage } from "@tabler/icons-react";
-import { ntfyIntegration } from '.';
+import { ntfyIntegration } from ".";
-
+
### Widgets & Capabilities
+
### Adding the integration
+
### Secrets
-
\ No newline at end of file
+
+
diff --git a/apps/docs/docs/integrations/nzbget/index.mdx b/apps/docs/docs/integrations/nzbget/index.mdx
index 3479f317a..1b7c23a1f 100644
--- a/apps/docs/docs/integrations/nzbget/index.mdx
+++ b/apps/docs/docs/integrations/nzbget/index.mdx
@@ -1,36 +1,41 @@
---
-title: 'NZBGet'
+title: "NZBGet"
description: "NZBGet is a lightweight and efficient Usenet downloader."
hide_title: true
---
-import { IntegrationHeader } from '@site/src/components/integrations/header';
-import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
-import { AddingIntegration } from '@site/src/components/integrations/adding';
-import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
+import { IntegrationHeader } from "@site/src/components/integrations/header";
+import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
+import { AddingIntegration } from "@site/src/components/integrations/adding";
+import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconDownload } from "@tabler/icons-react";
-import { nzbgetIntegration } from '.';
-import Alert from '@theme/Admonition';
-import { downloadsWidget } from '@site/docs/widgets/downloads';
+import { nzbgetIntegration } from ".";
+import Alert from "@theme/Admonition";
+import { downloadsWidget } from "@site/docs/widgets/downloads";
-
-
+
### Widgets & Capabilities
+
### Adding the integration
+
### Secrets
-
\ No newline at end of file
+
+
diff --git a/apps/docs/docs/integrations/open-media-vault/index.mdx b/apps/docs/docs/integrations/open-media-vault/index.mdx
index ac0a42290..b934bf797 100644
--- a/apps/docs/docs/integrations/open-media-vault/index.mdx
+++ b/apps/docs/docs/integrations/open-media-vault/index.mdx
@@ -1,42 +1,52 @@
---
-title: 'Open Media Vault'
+title: "Open Media Vault"
description: "Open Media Vault is a free network-attached storage server based on the Debian operating system."
hide_title: true
---
-import { IntegrationHeader } from '@site/src/components/integrations/header';
-import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
-import { AddingIntegration } from '@site/src/components/integrations/adding';
-import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
+import { IntegrationHeader } from "@site/src/components/integrations/header";
+import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
+import { AddingIntegration } from "@site/src/components/integrations/adding";
+import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconHeartRateMonitor } from "@tabler/icons-react";
-import { openMediaVaultIntegration } from '.';
-import Alert from '@theme/Admonition'
-import { healthMonitoringWidget } from '@site/docs/widgets/health-monitoring';
-import { systemResourcesWidget } from '@site/docs/widgets/system-resources';
+import { openMediaVaultIntegration } from ".";
+import Alert from "@theme/Admonition";
+import { healthMonitoringWidget } from "@site/docs/widgets/health-monitoring";
+import { systemResourcesWidget } from "@site/docs/widgets/system-resources";
-
+
### Widgets & Capabilities
+
### Adding the integration
+
### Secrets
-
- The user used here must have administrative permissions or Homarr won't be able to read the system performance and resource data.
-
-}]} />
\ No newline at end of file
+
+
+ The user used here must have administrative permissions or Homarr won't be able to read the system performance
+ and resource data.
+
+ ),
+ },
+ ]}
+/>
diff --git a/apps/docs/docs/integrations/opnsense/index.mdx b/apps/docs/docs/integrations/opnsense/index.mdx
index 37e9a78c6..9a3a2b1ee 100644
--- a/apps/docs/docs/integrations/opnsense/index.mdx
+++ b/apps/docs/docs/integrations/opnsense/index.mdx
@@ -1,65 +1,75 @@
---
-title: 'OPNsense'
+title: "OPNsense"
description: "OPNsense is an open-source, easy-to-use, and easy-to-build firewall and routing platform."
hide_title: true
---
-import { IntegrationHeader } from '@site/src/components/integrations/header';
-import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
-import { AddingIntegration } from '@site/src/components/integrations/adding';
-import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
+import { IntegrationHeader } from "@site/src/components/integrations/header";
+import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
+import { AddingIntegration } from "@site/src/components/integrations/adding";
+import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconHeartRateMonitor } from "@tabler/icons-react";
-import { opnsenseIntegration } from '.';
-import Alert from '@theme/Admonition'
-import { firewallWidget } from '../../widgets/firewall';
+import { opnsenseIntegration } from ".";
+import Alert from "@theme/Admonition";
+import { firewallWidget } from "../../widgets/firewall";
-
+
### Widgets & Capabilities
+
### Adding the integration
+
### Secrets
-
- This integration does not require full API access to the firewall. The following guide outlines the process for creating a restricted OPNsense user with a scrambled password, designed exclusively for API access. This ensures minimal permissions and prevents local login capability.
- ,
- steps: [
+
+
+ This integration does not require full API access to the firewall. The following guide outlines the process
+ for creating a restricted OPNsense user with a scrambled password, designed exclusively for API access. This
+ ensures minimal permissions and prevents local login capability.
+
+ ),
+ steps: [
"Log in to the OPNsense web interface as an administrator",
"Navigate to System → Access → Users",
"Click the + (Add) button to create a new user",
<>
- Fill in the user details:
-
-
Username: Enter a unique name
-
Password: Leave empty
-
Scrambled Password: Enable this option
-
Full name: (Optional) Add a descriptive name
-
+ Fill in the user details:
+
+
Username: Enter a unique name
+
Password: Leave empty
+
Scrambled Password: Enable this option
+
Full name: (Optional) Add a descriptive name
+
,
<>
- In Privileges section → Select the option below:
-
-
Lobby: Dashboard
-
Reporting: Traffic
-
+ In Privileges section → Select the option below:
+
+
Lobby: Dashboard
+
Reporting: Traffic
+
,
"Click Save",
"Return to the Users list",
"Find the user and click the ticket icon in the Commands column",
"Click Yes in the popup to confirm",
"A txt file will download automatically, containing: Key and Secret",
- "Save this file securely—this information will only be shown once"
- ],
-}]} />
\ No newline at end of file
+ "Save this file securely—this information will only be shown once",
+ ],
+ },
+ ]}
+/>
diff --git a/apps/docs/docs/integrations/overseerr/index.mdx b/apps/docs/docs/integrations/overseerr/index.mdx
index ce9e0a3e5..2dd2d7c8a 100644
--- a/apps/docs/docs/integrations/overseerr/index.mdx
+++ b/apps/docs/docs/integrations/overseerr/index.mdx
@@ -1,45 +1,52 @@
---
-title: 'Overseerr'
+title: "Overseerr"
description: "Overseerr is a self-hosted media request management system that integrates with Plex."
hide_title: true
---
-import { IntegrationHeader } from '@site/src/components/integrations/header';
-import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
-import { AddingIntegration } from '@site/src/components/integrations/adding';
-import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
+import { IntegrationHeader } from "@site/src/components/integrations/header";
+import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
+import { AddingIntegration } from "@site/src/components/integrations/adding";
+import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconZoomQuestion, IconChartBar, IconSearch } from "@tabler/icons-react";
-import { overseerrIntegration } from '.';
-import { mediaRequestListWidget } from '@site/docs/widgets/media-request-list';
-import { mediaRequestStatsWidget } from '@site/docs/widgets/media-request-stats';
+import { overseerrIntegration } from ".";
+import { mediaRequestListWidget } from "@site/docs/widgets/media-request-list";
+import { mediaRequestStatsWidget } from "@site/docs/widgets/media-request-stats";
-
-
+
### Widgets & Capabilities
+
### Adding the integration
+
### Secrets
-
\ No newline at end of file
+
+
diff --git a/apps/docs/docs/integrations/paperless-ngx/index.mdx b/apps/docs/docs/integrations/paperless-ngx/index.mdx
index e08840110..175fdb15a 100644
--- a/apps/docs/docs/integrations/paperless-ngx/index.mdx
+++ b/apps/docs/docs/integrations/paperless-ngx/index.mdx
@@ -1,41 +1,40 @@
---
-title: 'Paperless-ngx'
+title: "Paperless-ngx"
description: "Paperless-ngx is a document management system that transforms your physical documents into a searchable online archive."
hide_title: true
---
-import { IntegrationHeader } from '@site/src/components/integrations/header';
-import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
-import { AddingIntegration } from '@site/src/components/integrations/adding';
-import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
-import { paperlessNgxIntegration } from '.';
-import { paperlessNgxWidget } from '@site/docs/widgets/paperless-ngx';
+import { IntegrationHeader } from "@site/src/components/integrations/header";
+import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
+import { AddingIntegration } from "@site/src/components/integrations/adding";
+import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
+import { paperlessNgxIntegration } from ".";
+import { paperlessNgxWidget } from "@site/docs/widgets/paperless-ngx";
-
-
+
Paperless-ngx provides document statistics including total documents, inbox count, correspondents, tags, and document types.
### Widgets & Capabilities
-
+
+
### Adding the integration
+
### Secrets
-
+
+
diff --git a/apps/docs/docs/integrations/patchmon/index.mdx b/apps/docs/docs/integrations/patchmon/index.mdx
index 95b827df0..b60c20962 100644
--- a/apps/docs/docs/integrations/patchmon/index.mdx
+++ b/apps/docs/docs/integrations/patchmon/index.mdx
@@ -1,43 +1,42 @@
---
-title: 'PatchMon'
+title: "PatchMon"
description: "PatchMon is a patch management and monitoring solution for Linux hosts."
hide_title: true
---
-import { IntegrationHeader } from '@site/src/components/integrations/header';
-import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
-import { AddingIntegration } from '@site/src/components/integrations/adding';
-import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
-import { patchmonIntegration } from '.';
-import { patchmonWidget } from '@site/docs/widgets/patchmon';
+import { IntegrationHeader } from "@site/src/components/integrations/header";
+import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
+import { AddingIntegration } from "@site/src/components/integrations/adding";
+import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
+import { patchmonIntegration } from ".";
+import { patchmonWidget } from "@site/docs/widgets/patchmon";
-
-
+
PatchMon provides host and package update statistics including total hosts, hosts needing updates, and security update counts.
The PatchMon widget requires users to be **signed in to Homarr**; see the [PatchMon widget documentation](/docs/widgets/patchmon#authentication) for details on authentication and public boards.
### Widgets & Capabilities
-
+
+
### Adding the integration
+
### Secrets
-
+
+
diff --git a/apps/docs/docs/integrations/peanut/index.mdx b/apps/docs/docs/integrations/peanut/index.mdx
index 751200bed..7eb7b845b 100644
--- a/apps/docs/docs/integrations/peanut/index.mdx
+++ b/apps/docs/docs/integrations/peanut/index.mdx
@@ -1,48 +1,53 @@
---
-title: 'PeaNUT'
-description: 'A tiny dashboard for Network UPS Tools (NUT) servers.'
+title: "PeaNUT"
+description: "A tiny dashboard for Network UPS Tools (NUT) servers."
hide_title: true
---
-import { IntegrationHeader } from '@site/src/components/integrations/header';
-import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
-import { AddingIntegration } from '@site/src/components/integrations/adding';
-import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
-import { peaNutIntegration } from '.';
-import { upsWidget } from '@site/docs/widgets/ups';
+import { IntegrationHeader } from "@site/src/components/integrations/header";
+import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
+import { AddingIntegration } from "@site/src/components/integrations/adding";
+import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
+import { peaNutIntegration } from ".";
+import { upsWidget } from "@site/docs/widgets/ups";
-
+
[PeaNUT](https://github.com/Brandawg93/PeaNUT) exposes the data of your [Network UPS Tools](https://networkupstools.org/) servers
over a REST API, which Homarr reads to display the status of your UPS devices.
### Widgets & Capabilities
+
### Adding the integration
+
### Secrets
+
PeaNUT secures its API with HTTP Basic authentication when the `WEB_USERNAME` and `WEB_PASSWORD` environment variables
are set on the PeaNUT instance. Provide the same credentials here. If the instance runs with `AUTH_DISABLED=true`, no
secrets are required.
-
+
diff --git a/apps/docs/docs/integrations/pi-hole/index.mdx b/apps/docs/docs/integrations/pi-hole/index.mdx
index ca2b400e7..d724b026d 100644
--- a/apps/docs/docs/integrations/pi-hole/index.mdx
+++ b/apps/docs/docs/integrations/pi-hole/index.mdx
@@ -1,47 +1,54 @@
---
-title: 'Pi-hole'
+title: "Pi-hole"
description: "Pi-hole is a network-wide ad blocker that acts as a DNS sinkhole, blocking unwanted content and improving your browsing experience."
hide_title: true
---
-import { IntegrationHeader } from '@site/src/components/integrations/header';
-import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
-import { AddingIntegration } from '@site/src/components/integrations/adding';
-import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
+import { IntegrationHeader } from "@site/src/components/integrations/header";
+import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
+import { AddingIntegration } from "@site/src/components/integrations/adding";
+import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconAd, IconDeviceGamepad } from "@tabler/icons-react";
-import Alert from '@theme/Admonition';
-import { dnsHoleSummaryWidget } from '@site/docs/widgets/dns-hole-summary';
-import { dnsHoleControlsWidget } from '@site/docs/widgets/dns-hole-controls';
-import { piHoleIntegration } from '.';
+import Alert from "@theme/Admonition";
+import { dnsHoleSummaryWidget } from "@site/docs/widgets/dns-hole-summary";
+import { dnsHoleControlsWidget } from "@site/docs/widgets/dns-hole-controls";
+import { piHoleIntegration } from ".";
+
-
-
-
- Homarr supports both Pi-hole v5 and v6. It automatically detects the version and uses the correct API.
+
+ Homarr supports both Pi-hole v5 and v6. It automatically detects the version and uses the correct API.
### Widgets & Capabilities
+
### Adding the integration
+
### Secrets
-
\ No newline at end of file
+
+
diff --git a/apps/docs/docs/integrations/plex/index.mdx b/apps/docs/docs/integrations/plex/index.mdx
index b6394b918..b6e35a6e3 100644
--- a/apps/docs/docs/integrations/plex/index.mdx
+++ b/apps/docs/docs/integrations/plex/index.mdx
@@ -1,41 +1,47 @@
---
-title: 'Plex'
+title: "Plex"
description: "Plex is a media server platform that allows you to organize, manage, and stream your personal media collection."
hide_title: true
---
-import { IntegrationHeader } from '@site/src/components/integrations/header';
-import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
-import { AddingIntegration } from '@site/src/components/integrations/adding';
-import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
+import { IntegrationHeader } from "@site/src/components/integrations/header";
+import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
+import { AddingIntegration } from "@site/src/components/integrations/adding";
+import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconVideo, IconTicket } from "@tabler/icons-react";
-import { plexIntegration } from '.';
-import { mediaServerWidget } from '@site/docs/widgets/media-server';
-import { mediaReleasesWidget } from '@site/docs/widgets/media-releases';
+import { plexIntegration } from ".";
+import { mediaServerWidget } from "@site/docs/widgets/media-server";
+import { mediaReleasesWidget } from "@site/docs/widgets/media-releases";
-
-
+
### Widgets & Capabilities
-
+
+
### Adding the integration
+
### Secrets
-
- Follow the official Plex documentation to find your authentication token.
-
- ]
-}]} />
\ No newline at end of file
+ Follow the official{" "}
+
+ Plex documentation
+ {" "}
+ to find your authentication token.
+ ,
+ ],
+ },
+ ]}
+/>
diff --git a/apps/docs/docs/integrations/prowlarr/index.mdx b/apps/docs/docs/integrations/prowlarr/index.mdx
index 0c5561f91..b3624a97e 100644
--- a/apps/docs/docs/integrations/prowlarr/index.mdx
+++ b/apps/docs/docs/integrations/prowlarr/index.mdx
@@ -1,32 +1,34 @@
---
-title: 'Prowlarr'
+title: "Prowlarr"
description: "Prowlarr is an indexer manager for Usenet and BitTorrent, providing a unified interface to manage your indexers."
hide_title: true
---
-import { IntegrationHeader } from '@site/src/components/integrations/header';
-import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
-import { AddingIntegration } from '@site/src/components/integrations/adding';
-import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
+import { IntegrationHeader } from "@site/src/components/integrations/header";
+import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
+import { AddingIntegration } from "@site/src/components/integrations/adding";
+import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconHeartRateMonitor } from "@tabler/icons-react";
-import { prowlarrIntegration } from '.';
-import { indexerManagerWidget } from '@site/docs/widgets/indexer-manager';
+import { prowlarrIntegration } from ".";
+import { indexerManagerWidget } from "@site/docs/widgets/indexer-manager";
-
+
### Widgets & Capabilities
-
+
+
### Adding the integration
+
### Secrets
-
\ No newline at end of file
+
+
diff --git a/apps/docs/docs/integrations/proxmox/index.mdx b/apps/docs/docs/integrations/proxmox/index.mdx
index 4ea8eda98..f038dd007 100644
--- a/apps/docs/docs/integrations/proxmox/index.mdx
+++ b/apps/docs/docs/integrations/proxmox/index.mdx
@@ -1,103 +1,107 @@
---
-title: 'Proxmox'
+title: "Proxmox"
description: "Proxmox is a powerful open-source virtualization platform that allows you to run virtual machines and containers."
hide_title: true
---
-import { IntegrationHeader } from '@site/src/components/integrations/header';
-import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
-import { AddingIntegration } from '@site/src/components/integrations/adding';
-import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
+import { IntegrationHeader } from "@site/src/components/integrations/header";
+import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
+import { AddingIntegration } from "@site/src/components/integrations/adding";
+import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { IconHeartRateMonitor } from "@tabler/icons-react";
-import { proxmoxIntegration } from '.';
-import Alert from '@theme/Admonition'
-import { healthMonitoringWidget } from '@site/docs/widgets/health-monitoring';
-import { systemResourcesWidget } from '@site/docs/widgets/system-resources';
+import { proxmoxIntegration } from ".";
+import Alert from "@theme/Admonition";
+import { healthMonitoringWidget } from "@site/docs/widgets/health-monitoring";
+import { systemResourcesWidget } from "@site/docs/widgets/system-resources";
-
+
### Widgets & Capabilities
-
+
+
### Adding the integration
+
### Secrets
-
- The Proxmox API may not work with Linux PAM standard authentication. It is strongly recommended to use the Proxmox VE authentication server realm when creating your API user.
- ,
- credentials: ['username', 'tokenId', 'realm', 'apiKey'],
- steps: [
+
+
+ The Proxmox API may not work with Linux PAM standard authentication. It is strongly recommended to use the
+ Proxmox VE authentication server realm when creating your API user.
+
+ ),
+ credentials: ["username", "tokenId", "realm", "apiKey"],
+ steps: [
"Navigate to the Proxmox portal, click on Datacenter",
"Expand Permissions, click on Groups",
"Click the Create button",
"Name the group something informative, like api-users",
"Click on the Permissions 'folder'",
<>
- Click Add {"->"} Group Permission
-
-
Path: /
-
Group: group from Step 4 above
-
Role: PVEAuditor
-
Propagate: Checked
-
+ Click Add {"->"} Group Permission
+
+
Path: /
+
Group: group from Step 4 above
+
Role: PVEAuditor
+
Propagate: Checked
+
,
"Expand Permissions, click on Users",
<>
- Click the Add button
-
-
User name: something informative like api
-
Realm: Proxmox VE authentication server
-
Password: create a secure password for the user
-
Confirm Password: re-enter the password
-
Group: group from Step 4 above
-
+ Click the Add button
+
+
User name: something informative like api
+
Realm: Proxmox VE authentication server
+
Password: create a secure password for the user
+
Confirm Password: re-enter the password
+
Group: group from Step 4 above
+
,
"Expand Permissions, click on API Tokens",
<>
- Click the Add button
-
-
User: user from Step 8 above
-
Token ID: something informative like the application or purpose like homarr
-
Privilege Separation: unchecked
-
+ Click the Add button
+
+
User: user from Step 8 above
+
Token ID: something informative like the application or purpose like homarr
+
Privilege Separation: unchecked
+
,
"Copy the Secret that is shown in Step 10 because it is only shown once",
"Go back to the 'Permissions' menu",
<>
- Click Add {"->"} API Token Permission
-
-
Path: /
-
API Token: select the API token created in Step 10
-
Role: PVE Auditor
-
Propagate: Checked
-
+ Click Add {"->"} API Token Permission
+
+
Path: /
+
API Token: select the API token created in Step 10
+
Role: PVE Auditor
+
Propagate: Checked
+
,
- ],
- body: <>
-
- Sometimes you'll also find the api@pve!homarr format,
- within Homarr you'll have to split it up into:
-
-
+ ],
+ body: (
+ <>
+
+ Sometimes you'll also find the api@pve!homarr format, within Homarr you'll have to split it up
+ into:
+
+
+ Every available component also receives these {catalog.globalProps.length} generated global, ARIA, data, and
+ safe style props. Component cards below list only their component-specific additions.
+
-
+
-
+
A Helm chart to deploy homarr for Kubernetes
@@ -12,7 +12,7 @@ A Helm chart to deploy homarr for Kubernetes
## Source Code
-*