feat!: release v2 (#6545)

Co-authored-by: Artur <145776561+arturict@users.noreply.github.com> Co-authored-by: arturict <arturict@users.noreply.github.com> Co-authored-by: Thomas <thomas@ajnart.fr> Co-authored-by: Afonso Jorge Ramos <afonsojorgeramos@gmail.com> Co-authored-by: Danura30082 <danura30082+github@gmail.com> Co-authored-by: Kushie <122986913+kushiemoon-dev@users.noreply.github.com> Co-authored-by: ajnart <thomas@ajnart.fr> Co-authored-by: ajnart <thomas@ajnart.dev> Co-authored-by: chenjun <chenjun@foxmail.com> Co-authored-by: Wikibear <wikibear@users.noreply.github.com> Co-authored-by: Bergasha <bergasha@gmail.com> Co-authored-by: leafyelin <43306196+leafyelin@users.noreply.github.com> Co-authored-by: Lucas Araujo <lucas.lra@gmail.com> Co-authored-by: GreenMonito <86085570+GreenMonito@users.noreply.github.com> Co-authored-by: Nerdy-Technician <roffo@nerdy-technician.social> Co-authored-by: Jun <34545896+jcstrong@users.noreply.github.com> Co-authored-by: Edmond Abraham <54119952+gitedmond@users.noreply.github.com> Co-authored-by: thrawnx <tight.bulb9384@fastmail.com> Co-authored-by: Chris <58918656+nordada@users.noreply.github.com> Co-authored-by: yi111 <153097222+Yi-111-a@users.noreply.github.com> Co-authored-by: Yanis <naamaneyanis@gmail.com> Co-authored-by: Wikibear <me@sej.de> Co-authored-by: alessiottavo <93441886+alessiottavo@users.noreply.github.com>
2026-10-02 21:00:14 +02:00
1 parent 3a53bb77aa
commit fcd7c979df
@@ -13,6 +13,7 @@
 # next.js
 /.next/
 /out/
+/.source/

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

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

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

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

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

 ```bash
-# Start the docs dev server (port 3003)
 pnpm dev:docs
-
-# Or from within this directory
-pnpm dev
 ```

-## Build
+The site runs on `http://127.0.0.1:3003`. To use a local Workshop API:

 ```bash
-# Build docs only
-pnpm turbo build --filter=@homarr/docs
-
-# Build everything (docs + main app + tasks + websocket)
-pnpm build
+WORKSHOP_API_URL=http://127.0.0.1:8090 pnpm dev:docs
 ```

-## Lint & Format
-
-Uses oxlint and oxfmt (same as the rest of the monorepo):
+## Validate

 ```bash
-pnpm lint        # oxlint
-pnpm format      # oxfmt (check)
-pnpm format -- --write  # oxfmt (fix)
+pnpm --filter @homarr/docs typecheck
+pnpm --filter @homarr/docs build
+pnpm --filter @homarr/docs validate:links
+pnpm --filter @homarr/docs verify:search
+pnpm --filter @homarr/docs verify:seo
 ```

-## Typecheck
+The static export is written to `out/`. The build validates docs pages and typed metadata for integrations and widgets
+that declare a documentation slug. Set the slug to `null` when a page would add no useful information for advanced users.
+CI enforces coverage alongside schema drift and export validation. The link check validates internal Markdown and MDX
+links and rendered anchors against the export.
+The search check exercises the exported index with title, heading, and body queries and verifies result destinations.
+The SEO check validates canonical URLs, descriptions, social metadata, heading structure, and sitemap coverage in the
+exported HTML. These tags are generated at build time; set `HOMARR_WEBSITE_URL` before building for a different origin.
+
+## Preview the static export with PocketBase
+
+After building the docs, run from the repository root:

 ```bash
-pnpm typecheck
+sh apps/workshop/preview-docs.sh
 ```

-## Content Structure
+Open `http://127.0.0.1:8093/docs/`. This starts an isolated PocketBase container with temporary local data and serves
+the export directly, including search, Markdown, and the custom 404 page. Workshop browser requests use the configured
+backend; a trailing `/api/` is removed because the PocketBase SDK appends its API paths. The preview does not copy or
+migrate another database. Set `WORKSHOP_API_URL` to a remote PocketBase origin when testing against one;
+`WORKSHOP_REMOTE_API_URL` can override the server-side metadata source independently. Direct item links then use that
+source for titles and social metadata. Missing remote items return 404; an unavailable backend returns 503.

-```
-docs/
-├── getting-started/    # Installation guides, glossary, prerequisites
-├── management/         # Boards, apps, users, integrations, settings, tasks, API
-├── integrations/       # 56 integration guides (one folder each)
-├── widgets/            # 43 widget guides (one folder each)
-├── advanced/           # SSO, env vars, proxy, styling, CLI, development
-└── community/          # FAQ, donate, license, translations, get-in-touch
-```
-
-Each integration/widget doc follows a consistent pattern:
-
- `index.ts` — typed metadata (`IntegrationDefinition` / `WidgetDefinition`)
- `index.mdx` — content using shared React components (`IntegrationHeader`, `WidgetHeader`, etc.)
-
-## Importing from homarr packages
-
-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';
-```
-
-This enables type-safe references to homarr domain concepts within documentation code.
-
-## Search (Algolia DocSearch)
-
-Search uses the `Docusaurus` Algolia index (crawler `cd77a285-2756-4557-bf21-ee703748df15`). A separate `markdown` index is built for LLM markdown indexing.
-
-Crawler reference config: [`docsearch.config.js`](docsearch.config.js).
-
-**Verify search health:**
+Verify public item pages without changing the remote database:

 ```bash
-pnpm verify:search
+REMOTE_WORKSHOP_URL=https://workshop.example.com
+WORKSHOP_TEST_URL=http://127.0.0.1:8093 WORKSHOP_REMOTE_API_URL="$REMOTE_WORKSHOP_URL" \
+  node apps/workshop/tests/remote-workshop.integration.mjs
 ```

-## Tech Stack
+Stop it with `docker stop homarr-docs-static-preview`. Rebuild and restart the preview after changing source files;
+startup recreates the runtime configuration. `DOCS_PREVIEW_PORT`, `DOCS_PREVIEW_HOST`, and `DOCS_PREVIEW_NAME` override
+the defaults. Set the host to this machine's Tailscale address to access it from your other devices.

-| 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 |
+## Write content

-## Contributing
+Documentation lives in `docs/`; project posts live in `blog/`. Navigation is controlled by the nearest `meta.json`.
+Integration and widget folders pair typed `index.ts` metadata with `index.mdx` content.

-When making changes to the homarr codebase that affect user-facing behavior, **always update the corresponding documentation in this app**. See `.cursor/rules/documentation-sync.mdc` for the complete mapping of code changes to doc locations.
+Use standard Markdown and MDX. Shared components live in `src/components/`. Mermaid fences, tabs, callouts, zoomable
+images, and syntax-highlighted code are supported by the Fumadocs pipeline.
+
+Update docs in the same pull request only when a smart, advanced user cannot infer the changed behavior from the UI or
+generated API schema. Routine or self-explanatory changes need no docs update. See the
+[documentation-sync skill](../../.agents/skills/documentation-sync/SKILL.md) for target paths.
+
+## Published formats
+
+- `/docs` — searchable documentation with typed navigation
+- `/api-reference` — interactive reference generated from the OpenAPI schema
+- `/llms.txt` — compact documentation and blog index for agents
+- `/llms-full.txt` — complete processed Markdown corpus
+- `/llms.mdx/docs/.../content.md` — raw Markdown for each docs page
+- `/llms.mdx/blog/.../content.md` — raw Markdown for each blog post
+- `/llms.mdx/api-reference/.../content.md` — operation parameters, bodies, responses, and authentication
+- `/blog/rss.xml` — RSS feed for project posts
+- `/search?q=...` — opens documentation search with the supplied query, including existing Homarr search-engine links
+
+Every docs page and blog post includes copy-Markdown and view-source actions. Search is generated at build time and
+runs locally in the browser; it does not depend on an external crawler. Markdown exports and search resolve
+integration credentials and widget defaults from the same typed metadata used by the pages.
+The search dialog and its client-side engine load when search is first opened. Fumadocs caches the downloaded index
+for subsequent queries. The docs index, individual Markdown pages, and full corpus share the `llms()` renderer.
+API operations are indexed alongside docs and exported as Markdown from the same OpenAPI schema. The reference uses
+Fumadocs with Scalar: select an instance URL and API key, then explicitly send a request. Authentication is not
+persisted in local storage. Browser access requires the documented REST CORS configuration.
+
+The Custom JSX guide includes a lazily loaded, editable example using the application renderer and real component
+registry. Its bindings work locally; configured widget queries and actions do not run.
+
+The getting-started overview and complete Custom JSX component catalog are also included, with property types,
+binding contracts, and blocked capabilities taken from the published catalog JSON.
+
+Published Docusaurus `/docs/category/...` addresses remain available as static compatibility pages. They forward to
+the corresponding overview or developer setup guide, preserving query strings and anchors, and provide a direct
+link when JavaScript is disabled. Their canonical metadata points to the destination; compatibility pages are
+excluded from search and the sitemap.
+
+## Fumadocs upgrade notes
+
+The September 2026 update moves Core/UI from 16.15.4 to 16.15.12, MDX from 15.4.0 to 15.4.3, and OpenAPI from
+11.3.5 to 12.0.1. Review the upstream [Core](https://github.com/fuma-nama/fumadocs/blob/dev/packages/core/CHANGELOG.md),
+[UI](https://github.com/fuma-nama/fumadocs/blob/dev/packages/radix-ui/CHANGELOG.md),
+[MDX](https://github.com/fuma-nama/fumadocs/blob/dev/packages/mdx/CHANGELOG.md), and
+[OpenAPI](https://github.com/fuma-nama/fumadocs/blob/dev/packages/openapi/CHANGELOG.md) changelogs when upgrading.
+
+- Core/UI and MDX now declare side effects for better tree shaking. UI also fixes tabs reverting to the URL hash.
+- Core's `llms({ renderPage })` API provides the shared `index()`, `page()`, and `full()` exports.
+- OpenAPI 12 replaces several custom renderer options and hooks. This site uses `createOpenAPIPage()` and
+  `getOpenAPIPageProps()` without those removed overrides; the built-in renderer retains all request languages.
+  The Scalar adapter receives an equivalent nonrecursive union for unconstrained JSON values to avoid recursive
+  schema expansion during rendering. The generated public OpenAPI document remains unchanged.
+- MDX 15.4.3 fixes duplicate compilation output when its experimental build cache is enabled. We leave that cache
+  disabled: its current key checks source content without accounting for all compiler configuration changes.
+- The existing macro collections, processed-Markdown component adapters, and static search remain supported.
+  Typed version roots and server-side MCP tools are available upstream but are not needed by this static site.
+
+## Kapa AI
+
+The compact Homarr mascot in the bottom-right opens **Ask AI**. It slowly spins when idle and gives a subtle claw movement and wink on hover. Animation respects reduced motion.
+
+The launcher uses Homarr's existing public Kapa Website ID. The root layout loads the widget once across
+client-side navigation and follows the docs light or dark theme. **Search** and `Ctrl+K` / `Cmd+K` always use Fumadocs search, including when Kapa is unavailable.
+
+Set `KAPA_WEBSITE_ID` at build time to use a different Kapa Website Widget integration. An explicitly empty value
+disables the widget, for example `KAPA_WEBSITE_ID= pnpm --filter @homarr/docs build`. This is a public integration ID
+included in exported pages, not a Kapa API key. Rebuild the static export after changing it.
+
+In the Kapa dashboard, confirm the integration is live and enable the production and preview domains. Restoring the
+script does not verify that the historical integration is still active. Follow the
+[Kapa widget setup](https://docs.kapa.ai/integrations/website-widget/quickstart) for domain restrictions and CSP settings.
+
+After changing the documentation structure, review the Website Crawl source in Kapa: use the deployed `/docs` URL as
+the start URL and preview `main` as the content selector. Replace any old Docusaurus-specific selector and check that
+titles, headings, code samples, and integration details appear in the extracted Markdown. Docs are exported as HTML;
+the site also publishes `/sitemap.xml` and permits crawling in `/robots.txt`. The `/llms.txt` exports do not configure
+Kapa ingestion automatically. See [Kapa source setup](https://docs.kapa.ai/getting-started/index-your-first-source).
+
+Before publishing, check that Ask AI opens after navigating between pages, ask a documentation question, and verify
+its citations point to the current docs. In a separate check, block `widget.kapa.ai` and confirm search still works.
+
+## Release verification
+
+The production image compiles the docs itself; it does not depend on a host `out/` directory.
+Build-time `HOMARR_WEBSITE_URL` controls canonical metadata. Runtime URL overrides configure Workshop connections
+but do not rewrite already-exported canonical URLs.
+
+PostHog records SPA pageviews, installation clicks, searches with no results (including the search query), and Workshop
+content downloads and submission starts/completions through `hog.homarr.dev`. Downloads include JSON files and
+successful JSON/CSS clipboard copies. All events carry `site` and `source_path`. Autocapture, page-leave events, and
+session replay are disabled; tracked URL query strings and fragments are removed. Localhost and `?analytics_test`
+traffic carries `verification=true`; exclude it from production reports.
+
+Carbon loads one visible placement after the desktop TOC, below API examples, or below content on other layouts.
+The homepage is excluded at every viewport size. Navigation reloads the ad script; resizing changes placement only when crossing its breakpoint. Ad blockers
+or no-fill responses must not prevent content, navigation, or search from working.
+
+To preview Carbon locally, start docs with `NEXT_PUBLIC_ENABLE_CARBON_ADS=true pnpm dev:docs`. Production builds
+enable ads automatically. When the TOC collapses into a toggle, the ad appears below the content before “Edit this page”.
@@ -1,6 +1,7 @@
 ---
 slug: documentation-migration
 title: Migration of Documentation
+date: 2022-06-22
 authors:
  - ajnart
  - manuel-rw
@@ -12,7 +13,7 @@ The documentation has been re-written partly and includes now many animations, g

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

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

 ## Why we migrated

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

 ## TL;DR

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

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

 ### About global translations / translations per user

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

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

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

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

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

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

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

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

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

 ## Breaking changes

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

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

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

 A few highlights include:

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

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

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

@@ -13,8 +14,6 @@ This will be a one time occurrence and version > ``1.0`` will have less breaking
 This time more important than every; **read the breaking changes** list and **create a backup** before updating.
 Some third party installation methods may take multiple days or weeks to update to the new version.

-See [this guide on how to import your previous Homarr dashboard](/docs/getting-started/after-the-installation#importing-a-zip-from-version-before-100)
-
 ## Changes at a glance
 - **Asynchronous integrations system**: In versions prior to ``1.0``, we fetched data upon each request synchronously.
 This means that the user had to wait for the requests to finish so any data would appear.
@@ -30,14 +29,14 @@ reliability and scalability compared to < ``1.0``.
 - **Improved performance**: We have upgraded the underlying framework of Homarr and take advantage
 of an in-memory message bus and websockets to deliver data near realtime to you.

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

 ## Breaking changes
-:::warning
+<Alert type="warning">

 Please consult the breaking changes list & upgrade guide if you used third-party installation methods.

-:::
+</Alert>

 - Docker Image
  - Removed support for ``arm/v7`` -> upgrade to newer architectures as an alternative
@@ -1,16 +1,16 @@
 ---
+title: Open Beta 1.0
+date: 2024-12-17
 authors:
  - meierschlumpf
 ---

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

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

 ## How to use the beta with docker

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

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

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

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

-## Export your data
+## Preserve your old installation

-As 1.0 is a complete rewrite of Homarr and therefor not compatible with the old docker mounts, we need to export your data first.
-For this you can navigate to the `Migrate to 1.0` page which you can find under `Management` > `Tools` > `Migrate to 1.0`.
-Here you can select which things you want to export and download the zip file.
-It will also show you a secret key which you will need to import the secret data like user password hashes, salts and integration secrets.
+Homarr 1.0 is a complete rewrite and cannot reuse the old Docker mounts. Keep the 0.15 installation and its data intact while you build the replacement. The historical `Management` > `Tools` > `Migrate to 1.0` export can still be kept as a record, but current Homarr releases cannot import that ZIP or its secret key.
+
+Plan to recreate your apps, integrations, and boards manually in the new installation. A SQLite database backup can be restored from the onboarding welcome screen only when it was created by a compatible current Homarr release; it is not a conversion path for a 0.15 database.

 ![Export page](./img/old-homarr-export-data.png)

@@ -23,33 +22,20 @@ It will also show you a secret key which you will need to import the secret data

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

 ## Import your data
-Once the installation is completed you can access the new installation. During the onboarding you'll need to select `Import from Homarr before 1.0`.

-![Onboarding initial step](./img/onboarding-step-1.png)
+<Alert type="warning" title="Legacy guide">

-After that you can upload the zip file you downloaded in the first step.
+The pre-1.0 ZIP importer is no longer included in current Homarr releases. Keep the old installation available until you have manually verified the replacement. Compatible SQLite backups from current releases can still be restored from the onboarding welcome screen.

-![Onboarding import dropzone](./img/old-homarr-import-dropzone.png)
-
-After that you'll get a list with all your boards that can be imported. You can configure how it should be imported and can select which screensizes it should import.
-
-![Onboarding import list](./img/old-homarr-import-choose-imported-data.png)
-
-Once you have selected everything you can click on `Confirm import and continue` which will open the encryption key input dialog where you can input the secret key you got during the export.
-
-![Onboarding import key input](./img/old-homarr-import-decryption-token.png)
-
-After that you can continue the onboarding and you should see all your boards and data in the new installation.
-
-See [After the installation](https://homarr.dev/docs/getting-started/after-the-installation) for more information.
+</Alert>

 ## Remove the old installation

 After you are happy with the new installation and everything is working as expected you can remove the old installation.
 Please make sure to backup the data before you remove the old installation.
-Also once the port 7575 is free again you can change the port mapping of the new installation to `7575:7575` if you want to.
+Also once the port 7575 is free again you can change the port mapping of the new installation to `7575:7575` if you want to.
@@ -1,14 +1,14 @@
 ---
+title: How to use Argus with Homarr
+date: 2025-08-02
 authors:
  - meierschlumpf
 ---

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

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

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

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

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

-Replace the `<secret>` with the apiKey you created and the deployed version url with the url of your Homarr instance.
+Replace the `<secret>` with the apiKey you created and the deployed version url with the url of your Homarr instance.
@@ -0,0 +1,437 @@
+---
+title: Homarr 2.0.0 - Workshop, Custom Widgets and a rebuilt board
+date: 2026-10-02
+authors:
+  - ajnart
+tags: [homarr, update, version, assistant, custom widgets, dashboards, docker, mcp]
+description: Homarr 2.0 introduces Custom Widgets and Workshop, rebuilt board editing, Assistant and MCP tooling that turns Homarr into the front door to your homelab, responsive layouts, onboarding, and more.
+image: ./img/homarr-v2-recap.webp
+draft: false
+---
+
+# Homarr 2.0.0 - Workshop, Custom Widgets and a rebuilt board
+
+![Homarr v2 release recap showing Custom Widgets v2, Workshop, Homarr Assistant, advanced views and 31 new integrations](./img/homarr-v2-recap.webp)
+
+First, thank you.
+
+Many of you used the v2 demo when it was still rough, found bugs and came back to test the next build. Others translated Homarr, answered questions, contributed code or simply kept using it. We would not be shipping this without you.
+
+We are also planning a small batch of **free, limited-edition Homarr swag** for Workshop contributors and a few randomly picked community members. It is not for sale and it is not for profit. No Homarr merch empire, sorry.
+
+If you're thinking, “I ain't reading all dat,” don't worry. We made a video for your short attention span.
+
+<figure style={{ margin: "1.5rem 0" }}>
+  <video
+    controls
+    playsInline
+    preload="metadata"
+    poster={require("./img/homarr-v2-recap.webp").default.src}
+    width={1920}
+    height={1080}
+    style={{ width: "100%", height: "auto", borderRadius: "0.5rem" }}
+    aria-label="Homarr 2.0 feature overview."
+  >
+    <source src="https://media.homarr.dev/videos/homarr-2.0/homarr-v2-showreel.mp4" type="video/mp4" />
+  </video>
+  <figcaption>Homarr 2.0 in under two minutes.</figcaption>
+</figure>
+
+Homarr 2.0 builds on the dashboard you already use. Here is what changed.
+
+![A populated Homarr 2.0 dashboard with compact widgets, an Assistant, and an application rail](./img/homarr-v2-dashboard.webp)
+
+{/* Historical excerpt boundary. */}
+
+SQLite and PostgreSQL users can update their Homarr image as usual; database migrations run automatically at startup. **MySQL users must convert before upgrading**, as explained below. Workshop uses the production service by default, with no preview URL configuration required.
+
+## Database support in v2
+
+Homarr v2 drops MySQL support and keeps SQLite (the default) and PostgreSQL. Supporting fewer database engines lets us focus migration testing on those two. Existing MySQL installations have a standalone conversion script to move their data to SQLite before upgrading.
+
+<details>
+<summary>Using MySQL? How to migrate</summary>
+
+1. Update to the latest stable v1 release, then back up your MySQL database, appdata, and encryption key.
+2. Stop Homarr and run the MySQL-to-SQLite converter. It checks the copied data and leaves MySQL unchanged.
+3. Start v2 with the converted database, your existing appdata, and the **same `SECRET_ENCRYPTION_KEY`**.
+
+The converter is verified against the v1.77.1 schema and rejects unknown schemas. See the [migration guide](/docs/advanced/mysql-to-sqlite) for commands, supported inputs, and rollback instructions.
+
+</details>
+
+## Custom Widgets v2 and Workshop
+
+### Build almost any widget
+
+**This is the big one.** We think it is the most important Homarr update we have made.
+
+Custom Widgets v2 lets you build widgets from JSX, API requests, actions and typed settings. Write one yourself or describe it to Assistant, then test it in the workbench. We think this is enough to make almost any dashboard widget—even that oddly specific component only three people need. Those three people no longer have to wait for us.
+
+This was partly inspired by [Google's upcoming Create My Widget feature](https://blog.google/products-and-platforms/platforms/android/gemini-intelligence/): describe a widget in normal language and let AI make it. Coding knowledge is optional. Knowing what the API does still helps; AI has not fixed bad documentation. Yet.
+
+![The Custom Widget workbench displaying a Sonarr response through a saved integration](./img/custom-widget-workbench.png)
+
+![A working Pokédex Custom Widget on a local Homarr dashboard, with a search field, Pokémon artwork and stats](./img/custom-widget-dashboard.webp)
+
+A `homarr-custom-widget-v2` definition can use several fixed-origin API sources. Credentials are encrypted separately and stay out of exports and Workshop submissions. Actions support `GET`, `POST`, `PUT`, `PATCH` and `DELETE`; requests have host checks, timeouts, size limits, permissions and rate limits.
+
+### Share widgets and Custom CSS
+
+**Workshop is the other half.** Publish and install Custom Widgets, then update, vote on, comment on and report submissions. Workshop is not only for widgets: you can share your **Custom CSS** there too. Deployment URLs and credentials stay on your Homarr instance.
+
+![The Community Workshop catalog inside Custom Widget management](./img/community-workshop.webp)
+
+<Alert type="warning" title="Workshop is moderated">
+
+AI makes widgets easy to produce. It does not make the first thing it coughs up worth publishing. **Do not dump untested slop into Workshop.** Test it, add a useful screenshot and explain its setup. Workshop is moderated.
+
+</Alert>
+
+### Docusaurus + PocketBase for the docs and Workshop
+
+Our docs and Workshop now share a Docusaurus + PocketBase deployment. Docusaurus compiles the website into static HTML, CSS and JavaScript at build time. A Go service built on PocketBase serves those files and provides the Workshop backend for accounts, submissions, votes, comments and moderation.
+
+The production image packages both together under the same origin. Node.js is used to build the website, but is not needed to serve it in production. Workshop's persistent data lives separately in `/pb_data`, so replacing the image does not replace community content. This is the website and Workshop architecture; your self-hosted Homarr dashboard remains a separate application.
+
+### The ultimate Homarr update
+
+We have called this the **"ultimate Homarr update"**. Not because work stops, but because every new service or widget idea no longer needs a full Homarr release; the community can build and share it instead.
+
+## Board editing, rebuilt
+
+### Drag and drop
+
+We threw out the old drag-and-drop system and rebuilt it on [`dnd-kit`](https://dndkit.com/). Moves and eight-direction resizes are transactional: Homarr previews the result, checks collisions and only saves a valid layout. Bad moves roll back instead of wrecking the board. In short: less fighting with your own dashboard.
+
+<figure style={{ margin: "1.5rem 0" }}>
+  <video
+    controls
+    muted
+    playsInline
+    preload="none"
+    poster={require("./img/drag-and-resize-poster.webp").default.src}
+    width={1770}
+    height={706}
+    style={{ width: "100%", height: "auto", borderRadius: "0.5rem" }}
+    aria-label="Move and resize a tile with the new drag-and-drop system."
+  >
+    <source src="https://media.homarr.dev/videos/homarr-2.0/drag-and-resize.mp4" type="video/mp4" />
+    <track kind="captions" src="/media/homarr-2.0/drag-and-resize.vtt" srcLang="en" label="English" />
+  </video>
+  <figcaption>Move and resize a tile with the new drag-and-drop system.</figcaption>
+</figure>
+
+### Goodbye Groups and sections, bonjour Containers
+
+Groups and dynamic sections did nearly the same job, so **Containers replace both**. They hold apps, widgets and other Containers. Move a Container with its contents, or collapse it when you need the space.
+
+<figure style={{ margin: "1.5rem 0" }}>
+  <video
+    controls
+    muted
+    playsInline
+    preload="none"
+    poster={require("./img/containers-poster.webp").default.src}
+    width={1770}
+    height={716}
+    style={{ width: "100%", height: "auto", borderRadius: "0.5rem" }}
+    aria-label="Move, collapse and reopen a Container without rearranging its contents."
+  >
+    <source src="https://media.homarr.dev/videos/homarr-2.0/containers.mp4" type="video/mp4" />
+    <track kind="captions" src="/media/homarr-2.0/containers.vtt" srcLang="en" label="English" />
+  </video>
+  <figcaption>Move, collapse and reopen a Container without rearranging its contents.</figcaption>
+</figure>
+
+Hold <kbd>Ctrl</kbd> or <kbd>Command</kbd> while clicking to select several items, then use **Move to** to put them in a Container.
+
+<figure style={{ margin: "1.5rem 0" }}>
+  <video
+    controls
+    muted
+    playsInline
+    preload="none"
+    poster={require("./img/multi-select-poster.webp").default.src}
+    width={1770}
+    height={716}
+    style={{ width: "100%", height: "auto", borderRadius: "0.5rem" }}
+    aria-label="Command-click two apps, then move them into the same Container."
+  >
+    <source src="https://media.homarr.dev/videos/homarr-2.0/multi-select.mp4" type="video/mp4" />
+    <track kind="captions" src="/media/homarr-2.0/multi-select.vtt" srcLang="en" label="English" />
+  </video>
+  <figcaption>Command-click two apps, then move them into the same Container.</figcaption>
+</figure>
+
+### One board, several layouts
+
+Boards also have Base and Mobile layouts, plus optional breakpoints. **Reset from Base** creates a Mobile starting point without duplicating the board.
+
+### Fixed sidebars
+
+Keep app shortcuts or widgets in a sidebar while the main board scrolls. Enable a sidebar and choose its width in board settings.
+
+<figure style={{ margin: "1.5rem 0" }}>
+  <video
+    controls
+    muted
+    playsInline
+    preload="none"
+    poster={require("./img/sidebar-settings-poster.webp").default.src}
+    width={1600}
+    height={700}
+    style={{ width: "100%", height: "auto", borderRadius: "0.5rem" }}
+    aria-label="Enable the right sidebar and set its width."
+  >
+    <source src="https://media.homarr.dev/videos/homarr-2.0/sidebar-settings.mp4" type="video/mp4" />
+    <track kind="captions" src="/media/homarr-2.0/sidebar-settings.vtt" srcLang="en" label="English" />
+  </video>
+  <figcaption>Enable the right sidebar and set its width.</figcaption>
+</figure>
+
+<figure style={{ margin: "1.5rem 0" }}>
+  <video
+    controls
+    muted
+    playsInline
+    preload="none"
+    poster={require("./img/fixed-sidebar-poster.webp").default.src}
+    width={1580}
+    height={640}
+    style={{ width: "100%", height: "auto", borderRadius: "0.5rem" }}
+    aria-label="The board scrolls; the app shortcuts stay in place."
+  >
+    <source src="https://media.homarr.dev/videos/homarr-2.0/fixed-sidebar.mp4" type="video/mp4" />
+    <track kind="captions" src="/media/homarr-2.0/fixed-sidebar.vtt" srcLang="en" label="English" />
+  </video>
+  <figcaption>The board scrolls; the app shortcuts stay in place.</figcaption>
+</figure>
+
+## Homarr Assistant
+
+### Work with live Homarr data
+
+Assistant reads live Homarr data and has tools for boards, apps, integrations, widgets, Docker and supported services. It can answer questions, make approved changes and build Custom Widgets. It follows your permissions: reads can run automatically, while changes require approval by default.
+
+![The Homarr Assistant expanded over a live dashboard with health, exploration, media, and board actions](./img/assistant-control-surface.webp)
+
+Open it with <kbd>Shift</kbd> + <kbd>A</kbd>. <kbd>Cmd</kbd>/<kbd>Ctrl</kbd> + <kbd>/</kbd> searches it.
+
+### The Homarr provider
+
+<Alert type="note">
+
+Assistant ships with a **"Homarr provider"**. It is free, will never offer paid plans, and is paid for by [Ajnart](https://github.com/ajnart) using the ad revenue from this website.
+
+It only uses zero-data-retention (ZDR) providers. [The provider is open source](https://github.com/homarr-labs/homarr/blob/release/v2/apps/workshop/homarr_provider.go), and neither prompts nor responses are logged. We are not selling your data. Pinky promise.
+
+</Alert>
+
+### External assistants through MCP
+
+External assistants can use the same permission-checked tools through `/api/mcp`, with an API key or OAuth 2.1 with PKCE.
+The most powerful one gets its own section.
+
+## The front door to your homelab
+
+Homarr already knows how to reach your services: their URLs, API keys and auth headers. v2 adds one API endpoint that
+lets you use them without ever seeing them.
+
+`POST /api/integrations/request` calls **any HTTP endpoint** on a saved integration. It is also available as tRPC
+`integration.request` and MCP `integration_request`. You send the integration, a method and a path, authenticated with
+your Homarr API key or session. Homarr checks your access, adds the credentials it stores and hands back the service's
+answer:
+
+![A request from a Custom Widget or an agent goes to Homarr with your API key. Homarr authenticates you, checks full integration access, adds the saved Sonarr API key from its encrypted vault, calls Sonarr on its saved URL and returns the response](./img/front-door-diagram.gif)
+
+The secrets stay in Homarr. API keys, passwords and tokens are stored encrypted, no API returns them, and Homarr redacts
+them from responses. If a service's API can do something, you can do it through Homarr, even when Homarr has no button
+for it:
+
+- **Custom Widgets** bind a saved integration as a [source](/docs/management/integrations#beyond-native-widgets) and call
+  its endpoints, so you never paste credentials into widget code.
+- **Agents** act on your behalf through MCP. The agent reads the service's official API docs, tells you which integration
+  it will use and what the call changes, then reports the result.
+
+It stays inside the lines:
+
+- Paths stay within the saved integration URL, and redirects are rejected.
+- Every request needs **full integration access**. `DELETE` needs explicit confirmation, and in Assistant every request,
+  even a `GET`, waits for your approval.
+
+### One prompt, seven services
+
+We asked a local model, through Homarr's MCP server:
+
+> Could you install a notification provider and then set it up everywhere it's supported in my installed integrations?
+
+It checked the Docker endpoint, asked which provider to use (it recommended ntfy), deployed ntfy and reported back:
+
+| Service     | How                                                                       | Verified                                   |
+| ----------- | ------------------------------------------------------------------------- | ------------------------------------------ |
+| Sonarr      | Native ntfy connection for grabs, downloads, upgrades and health          | Test fired ✓                               |
+| Radarr      | Native ntfy connection, plus movie added                                  | Test fired ✓                               |
+| Seerr       | Webhook with a JSON payload for readable titles                           | Fires on request, approve, available, fail |
+| SABnzbd     | 5.1.3 has no ntfy support, so a completion script on the default category | Dry run ✓                                  |
+| qBittorrent | `[AutoRun]` completion hook in `qBittorrent.conf`                         | Persisted after restart                    |
+| Bazarr      | ntfy provider enabled for subtitle events                                 | Restarted ✓                                |
+| Beszel      | Webhook with status, CPU, memory and disk alerts on all eight systems     | 29 alerts created                          |
+
+Two test notifications later, the phone buzzed. It cost $0: Qwen3.8-27B ran locally through MLX. The only side effect
+was warm feet.
+
+See [authenticated integration requests](/docs/management/mcp#authenticated-integration-requests) and the
+[API contract](/docs/management/api#call-any-integration-api-endpoint) for selectors, limits and the services that
+cannot use it.
+
+## The rest (there is a lot)
+
+### Brand-new onboarding
+
+A six-stage setup studio handles the first admin, core settings, Docker discovery, apps, integrations and the first board.
+
+![The Homarr 2.0 setup studio on its Essentials step, with all six setup stages shown](./img/onboarding-studio.webp)
+
+### Board switcher
+
+Boards now live in a searchable gallery with keyboard navigation. Open it from the header or press <kbd>Shift</kbd> + <kbd>C</kbd>.
+
+<figure style={{ margin: "1.5rem 0" }}>
+  <video
+    controls
+    muted
+    playsInline
+    preload="none"
+    poster={require("./img/board-switcher-poster.webp").default.src}
+    width={1920}
+    height={778}
+    style={{ width: "100%", height: "auto", borderRadius: "0.5rem" }}
+    aria-label="Open the switcher, filter by name and press Enter to open a board."
+  >
+    <source src="https://media.homarr.dev/videos/homarr-2.0/board-switcher.mp4" type="video/mp4" />
+    <track kind="captions" src="/media/homarr-2.0/board-switcher.vtt" srcLang="en" label="English" />
+  </video>
+  <figcaption>Open the switcher, filter by name and press Enter to open a board.</figcaption>
+</figure>
+
+### Command menu and keybinds
+
+<kbd>Cmd</kbd>/<kbd>Ctrl</kbd> + <kbd>K</kbd> finds resources, pages, settings, users, groups and commands. More
+keybinds cover Assistant, editing, selection and advanced widget views.
+
+### Customizable header
+
+Add direct links to boards and shortcuts to features such as search, Docker and settings. Put them on the left, center or right, and change their order.
+
+![A customized header with a board link on the left, board switching and search in the center, and Docker, theme and settings on the right](./img/customized-header.webp)
+
+<details>
+<summary>Arrange it in the Header studio</summary>
+
+![The Header studio showing left, center, and right zones plus available controls](./img/header-studio.webp)
+
+</details>
+
+### Instance branding
+
+Change the name, logo, favicon, colors, corner styles and login page. Global CSS applies instance-wide; board CSS can override it. Only give that power to admins you trust. CSS remains CSS.
+
+![Instance branding controls for application identity, palette, corner style, and global CSS](./img/instance-branding.webp)
+
+### Widgets
+
+Add content without leaving the board. Settings have live previews. Weather and Clock were redesigned; Air Quality, Countdown and Timer are new.
+
+![The Air Quality widget showing the current AQI and a location trend](./img/air-quality.webp)
+
+![The Countdown widget showing time remaining until an event](./img/countdown.webp)
+
+<figure style={{ margin: "1.5rem 0" }}>
+  <video
+    controls
+    muted
+    playsInline
+    preload="none"
+    poster={require("./img/timer-poster.webp").default.src}
+    width={950}
+    height={500}
+    style={{ width: "100%", height: "auto", borderRadius: "0.5rem" }}
+    aria-label="Start, pause and reset Timer without leaving the board."
+  >
+    <source src="https://media.homarr.dev/videos/homarr-2.0/timer.mp4" type="video/mp4" />
+    <track kind="captions" src="/media/homarr-2.0/timer.vtt" srcLang="en" label="English" />
+  </video>
+  <figcaption>Start, pause and reset Timer without leaving the board.</figcaption>
+</figure>
+
+Supported widgets also have **advanced views**. Hover over a widget and hold <kbd>Shift</kbd> for **half a second** to open one.
+
+<figure style={{ margin: "1.5rem 0" }}>
+  <video
+    controls
+    muted
+    playsInline
+    preload="none"
+    poster={require("./img/advanced-widget-poster.webp").default.src}
+    width={864}
+    height={600}
+    style={{ width: "100%", height: "auto", borderRadius: "0.5rem" }}
+    aria-label="Hold Shift for half a second over Downloads to open its advanced view."
+  >
+    <source src="https://media.homarr.dev/videos/homarr-2.0/advanced-widget.mp4" type="video/mp4" />
+    <track kind="captions" src="/media/homarr-2.0/advanced-widget.vtt" srcLang="en" label="English" />
+  </video>
+  <figcaption>Hold Shift for half a second over Downloads to open its advanced view.</figcaption>
+</figure>
+
+### Statistics and 31 new integrations
+
+The new [Statistics widget](/docs/widgets/stats) combines fields from different services in one grid: Sonarr shows beside Paperless-ngx documents, Navidrome songs or Homebox inventory. Choose cards, compact rows or tables grouped by integration. Click a metric for related fields, or open **Advanced view** from the context menu to see every available field from the selected sources.
+
+Add your services in **Management → Integrations**, then select them and their metrics in Statistics settings. Labels, order and abbreviated values are configurable; the widget's local view controls let you try a different arrangement without changing the shared board. The demo board includes mocked cards, rows and tables.
+
+This release adds:
+
+- **Media and libraries:** Autobrr, FileFlows, Jackett, Jellystat, Komga, Maintainerr, RomM, Stash, Tube Archivist, Unmanic, xTeVe and Your Spotify.
+- **Monitoring and networking:** Caddy, Changedetection.io, Frigate, Gatus, Healthchecks, NetAlertX, Netdata, Prometheus, Scrutiny and Syncthing Relay.
+- **Collections and home:** Homebox, Karakeep, Linkwarden, Mealie, Miniflux, Plant-it, Spoolman, Tandoor and Trilium.
+
+The [integration and metric reference](/docs/widgets/stats#new-service-integrations-in-v2) links to each setup guide. Jackett also joins the Indexer Manager widget. Existing supported integrations reuse their Homarr clients.
+
+Statistics keeps saved snapshots until you refresh them. Multiple metrics from one source share retrieval, and dashboard loads read cached data instead of refetching every service. **Right-click → Refresh** retrieves new source data and shows the oldest saved snapshot's age; unsuccessful refreshes keep the previous values. These are on-demand snapshots, not live monitoring.
+
+### Docker and Podman
+
+`DOCKER_ENDPOINTS` supports several hosts. Assisted setup and container labels can create apps, integrations, Containers, widgets and health checks.
+
+![Assisted Docker setup listing discovered services that can become apps or integrations](./img/docker-assisted-setup.webp)
+
+Homepage-compatible labels work too.
+
+### Permissions
+
+Groups use a new Viewer, Editor and Admin matrix. The API, Assistant and MCP follow the same rules. LDAP can create users on first sign-in; OIDC can link verified accounts and synchronize groups.
+
+### Performance
+
+Board startup work runs in parallel, heavy screens load when opened, and identical integration requests share work instead of doing it twice.
+
+## Deploy on Hostinger
+
+[Hostinger now offers a one-click Docker deployment of Homarr](https://www.hostg.xyz/aff_c?offer_id=815&aff_id=244277&url_id=6861) on its VPS plans. They maintain the deployment template, and you manage the resulting VPS and Homarr instance. Our new [Hostinger installation guide](/docs/getting-started/installation/hostinger) walks through deployment and first setup.
+
+We deploy the Homarr Workshop and the compiled documentation website on the VPS provided by Hostinger. Thank you for hosting this part of Homarr's infrastructure. We have an affiliate partnership as well: purchases through a referral link may support Homarr.
+
+## Compatibility notes
+
+- Legacy Custom JSX definitions enter a migration state. Homarr keeps encrypted credentials and an archived copy until the v2 definition validates.
+- Mobile layouts place rail content in the main flow instead of displaying rails.
+- Assistant and MCP do not bypass permissions.
+
+## Links
+
+- Try the [live demo](https://demo.homarr.dev/).
+- See [installation and update instructions](/docs/getting-started/installation/docker).
+- Browse [Workshop](https://homarr.dev/workshop).
+- Read the guides for [Boards](/docs/management/boards), [Custom Widgets](/docs/management/custom-widgets), [Assistant](/docs/management/assistant), [MCP](/docs/management/mcp) and [Docker labels](/docs/integrations/docker-labels).
@@ -0,0 +1,24 @@
+{
+  "$schema": "https://ui.shadcn.com/schema.json",
+  "style": "base-nova",
+  "rsc": false,
+  "tsx": true,
+  "tailwind": {
+    "config": "",
+    "css": "src/app/global.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"
+}
@@ -1,9 +0,0 @@
-{
-  "label": "Advanced",
-  "collapsed": true,
-  "position": 4,
-  "link": {
-    "type": "generated-index",
-    "title": "Advanced Concepts or features"
-  }
-}
@@ -1,4 +0,0 @@
-{
-  "collapsed": true,
-  "label": "Command line interface"
-}
@@ -1,41 +1,180 @@
 # Developer Docker CLI

-The host-side developer CLI builds and runs local Homarr images and pull-request previews. Run it directly from a checkout with `pnpm dev:cli -- ...`; no shell-specific setup script is required. It is separate from the recovery CLI included in production images.
+The host-side developer CLI builds and runs local Homarr images and pull-request previews with non-blocking background operations. Run it directly from a checkout with `pnpm dev:cli -- ...`; no shell-specific setup script is required. It is separate from the recovery CLI included in production images.

-To install an optional `homarr` binary, run `pnpm dev:cli:install` and make your Go bin directory available on `PATH`. GitHub CLI authentication is only needed for pull-request features.
+To install an optional `homarr` binary, run `pnpm dev:cli:install` and make your Go bin directory available on `PATH`. GitHub CLI authentication (`gh auth login`) is only needed for pull-request features.

-## Browse development images
+## Requirements
+
+- Docker or OrbStack
+- Go 1.25+ (when building the CLI from source)
+- GitHub CLI authenticated with `gh auth login` (for pull-request and CI features)
+- A [Nerd Font](https://www.nerdfonts.com/) enabled in your terminal (recommended for icons, status indicators, and TUI glyphs)
+
+## Interactive Development Browser

 ```bash
 pnpm dev:cli --
+# or with global binary:
+homarr
 ```

-The main screen combines local `homarr:*` images with open pull requests and their GHCR preview status. Select an image to start or stop it, use `R` to build a remote pull request locally in the background or rebuild a local image, or use `p` to force a remote preview pull. Press `d` to switch to the instance dashboard and `d` again to return without losing the browser state. The explicit `dev` and `dash` subcommands start on either screen.
+The main browser combines local `homarr:*` images with open pull requests and their GHCR preview status. Select an image to start or stop it, use `R` to build a remote pull request locally in the background or rebuild a local image, or use `p` to force a remote preview pull. Press `d` (or `1`/`2`) to toggle between the image browser and the instance dashboard.

-A locally built PR image is folded into its remote PR row only when its recorded revision exactly matches the current GitHub head SHA. The row is marked `◆ local`, and starting it prefers that local image without a registry pull. Outdated local builds remain separate rows. Navigation and dashboard switching remain available during background builds.
+A locally built PR image is folded into its remote PR row only when its recorded revision matches the current GitHub head SHA (marked `◆ local`). When the matching GHCR image is also available, pressing `Enter` opens a local/remote selector with local preselected. Outdated local builds remain separate rows.

-## Build images
+### Multi-Source Sidebar
+
+Press `Tab` to cycle between sidebar tabs:
+
+- **`[logs]`**: Live container output streams (press `f` to follow/pause, `L` to pin to the selected container, `Page Up`/`Page Down` to scroll).
+- **`[build]`**: Real-time BuildKit step streaming for active local builds.
+- **`[ci]`**: GitHub Actions CI check statuses, run duration, and workflow links for pull requests.
+
+### Background Task Overlay
+
+Pulls and builds run asynchronously in the background. Press `t` to open the tasks overlay, showing:
+
+- Layer-by-layer download progress and transfer speeds (via Docker Engine API).
+- Active build stages and logs.
+- Task cancellation and status.
+
+### Browser Shortcuts
+
+| Key                    | Action                                                                                        |
+| ---------------------- | --------------------------------------------------------------------------------------------- |
+| `/`                    | Filter rows by PR number, title, author, branch, CI, image, state, or port                    |
+| `↑` / `↓` or `j` / `k` | Navigate rows                                                                                 |
+| `Enter` or `Space`     | Start the available image; choose local or remote when both exist; stop if running            |
+| `R`                    | Build locally in background (or rebuild local image)                                          |
+| `p`                    | Pull remote PR image in background and start container                                        |
+| `m`                    | Manage mode (`b` rebuild, `i` delete image, `d` delete data, `c` remove container, `p` prune) |
+| `t`                    | Toggle background tasks overlay                                                               |
+| `Tab`                  | Cycle sidebar tabs (`[logs]`, `[build]`, `[ci]`)                                              |
+| `l` / `L`              | Toggle sidebar visibility / Pin logs to selected instance                                     |
+| `f`                    | Follow or pause logs                                                                          |
+| `M`                    | Toggle demo mode for next launch                                                              |
+| `b`                    | Toggle bot pull requests                                                                      |
+| `o` / `a`              | Open PR on GitHub / Open running instance in browser                                          |
+| `c`                    | Copy instance URL to clipboard                                                                |
+| `r`                    | Refresh data                                                                                  |
+| `1` / `2` / `d`        | Switch screen (development browser / instance dashboard)                                      |
+| `?` / `q`              | Help overlay / Quit (cancels active background tasks)                                         |
+
+## Instance Dashboard

 ```bash
-pnpm dev:cli -- build <name>
-pnpm dev:cli -- build --pr <number> [name]
+homarr dash
+# or
+pnpm dev:cli -- dash
 ```

-The first command builds the current checkout as `homarr:<name>`. The pull-request form uses a depth-one clone in a temporary directory and defaults to `homarr:pr-<number>` when `name` is omitted.
+The instance dashboard displays all running and stopped Homarr containers, published ports, health states, and resource volumes.

-## Rebuild images
+| Key                | Action                                   |
+| ------------------ | ---------------------------------------- |
+| `Enter` or `Space` | Start or stop selected instance          |
+| `s` / `S`          | Stop / Restart instance                  |
+| `x`                | Remove container (preserves data volume) |
+| `m`                | Manage mode for selected instance        |
+| `R`                | Rebuild from recorded build provenance   |
+
+## CLI Commands
+
+The commands below use the installed `homarr` binary. Without global installation, prefix each command with `pnpm dev:cli --` (for example, `pnpm dev:cli -- list`).
+
+### Launch Instances

 ```bash
-pnpm dev:cli -- rebuild <name>
+homarr run dev
+homarr run --detach dev
+homarr run --pr 6441
+homarr run --pr 6441 --demo
+homarr --pr 6441 --env WORKSHOP_WEB_URL=https://workshop.example.com/workshop
 ```

-Images built by this CLI record their source checkout, revision, and optional pull-request number. Rebuild uses that provenance to select the original checkout or create a fresh temporary pull-request checkout.
+- `--pr <number>`: Pull and run a PR image from GHCR (shorthand: `homarr --pr <number>`).
+- `--demo` (`-m`): Start with mock integrations and sample data.
+- `--detach`: Start container in background.
+- `--env` (`-e`): Pass additional environment variables (repeatable: `--env KEY=VALUE`).

-## Run images
+### Build & Rebuild

 ```bash
-homarr run <name>
-homarr run --pr <number>
+# Build current checkout as homarr:<name>
+homarr build feature
+
+# Build a pull request locally in a temporary checkout
+homarr build --pr 6441
+
+# Rebuild an existing image from recorded provenance
+homarr rebuild feature
 ```

-Add `--detach` to run in the background, `--demo` to enable demo data, or repeat `--env KEY=VALUE` to provide additional environment variables.
+Images built with the CLI record their source checkout, revision SHA, and optional PR number. `homarr rebuild` reads this provenance to reconstruct the build without manual configuration.
+
+### GitHub CI Checks
+
+```bash
+# View CI checks for a specific PR
+homarr ci 6441
+
+# View CI checks for the current branch
+homarr ci
+
+# Watch CI checks until completion
+homarr ci 6441 --watch
+```
+
+### Interactive Shell
+
+```bash
+# Open interactive shell in running container
+homarr shell homarr-dev
+
+# Run specific command in container
+homarr shell homarr-dev pnpm db:migration:sqlite:run
+```
+
+### Image & Volume Management
+
+```bash
+# List local images with build provenance (source, revision, PR)
+homarr images
+
+# Delete local image
+homarr images rm feature
+
+# List data volumes with owner PR/tag and in-use status
+homarr data
+
+# Preview deleting a data volume and its owning container
+homarr data rm homarr_feature_data
+
+# Permanently delete the data after reviewing the preview
+homarr data rm homarr_feature_data --force
+
+# Remove stopped containers (prompts without --force)
+homarr prune --force
+```
+
+Forced data deletion removes the derived owner container only when it mounts the exact selected volume. A same-named container that does not own that volume stops the operation.
+
+### Instance Operations & Diagnostics
+
+```bash
+# List instances in a script-friendly table
+homarr list
+
+# Follow container logs
+homarr logs homarr-dev
+
+# Stop, restart, remove, or open container in browser
+homarr stop homarr-dev
+homarr restart homarr-dev
+homarr remove homarr-dev
+homarr open homarr-dev
+
+# Verify Docker daemon, Engine API, GHCR access, and gh CLI authentication
+homarr doctor
+```
@@ -1,10 +1,10 @@
 # Fix usernames

-:::info
+<Alert type="info">

 This guide requires that you understand [how to access the CLI](../).

-:::
+</Alert>

 If you somehow get into a situation where you have users with usernames that contain uppercase characters and you are no longer able to log in, you can use the following command to fix the usernames.

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

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

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

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

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

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

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

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

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

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

-1. Open Container Station in the QNAP Web Interface ![](img/334116069-e7ec4726-3df7-4dc6-a3e0-b745e7eef17f.png)
-2. Select Containers in the menu bar on the left ![](img/334116205-aa09ce40-0701-4f7d-b9f9-b431b9d207c5.png)
-3. Select your Homarr Container ![](img/334116303-714b5e07-b9de-4ec0-a2bc-def7ee38750f.png)
-4. Click "Execute" in the top right of the Window. ![](img/334116411-df1482f9-3aa9-4686-b77f-e0dca09e60b2.png)
-5. Select /bin/bash and click Execute ![](img/334116518-e1ddb515-99c7-4159-81bf-76e889d1e808.png)
-6. Run the Homarr command and press enter (eg. homarr reset-owner-password) ![](img/334116642-08c4f204-5cd0-4e4e-a785-0142e1b279ca.png)
+![Container Station in the QNAP application menu](./img/334116069-e7ec4726-3df7-4dc6-a3e0-b745e7eef17f.png)
+
+2. Select **Containers**.
+
+![Containers menu in QNAP Container Station](./img/334116205-aa09ce40-0701-4f7d-b9f9-b431b9d207c5.png)
+
+3. Select the Homarr container.
+
+![Homarr container selected in QNAP Container Station](./img/334116303-714b5e07-b9de-4ec0-a2bc-def7ee38750f.png)
+
+4. Select **Execute**.
+
+![Execute action for the Homarr container in QNAP Container Station](./img/334116411-df1482f9-3aa9-4686-b77f-e0dca09e60b2.png)
+
+5. Select `/bin/bash`, then select **Execute**.
+
+![Bash selected in the QNAP execute console](./img/334116518-e1ddb515-99c7-4159-81bf-76e889d1e808.png)
+
+6. Run `homarr <command>` in the console.
+
+![Bash console open for Homarr in QNAP Container Station](./img/334116642-08c4f204-5cd0-4e4e-a785-0142e1b279ca.png)
+
+See the pages in this section for available commands.
+
+## Build a local branch harness
+
+The repository's host-side CLI can build the current checkout and run it as a named Docker harness:
+
+![Homarr developer CLI showing pull requests, local images, and PR CI status](./img/homarr-dev-cli.png)
+
+```sh
+pnpm cli harness setup feature-board
+```
+
+This creates `homarr:feature-board`, starts it with persistent demo data, and prints the assigned URL. Query the port
+again with:
+
+```sh
+pnpm cli harness port feature-board
+```
+
+Pass environment overrides with repeated `--env` options:
+
+```sh
+pnpm cli harness setup feature-board \
+  --env WORKSHOP_WEB_URL=https://example.test \
+  --env FEATURE_FLAG=true
+```
+
+Related commands are `harness build <name>`, `harness run <name>`, and `harness stop <name>`.
@@ -1,12 +1,13 @@
 # Integrations

-:::info
+<Alert type="info">

 This guide requires that you understand [how to access the CLI](../).

-:::
+</Alert>

 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
-```
+```
@@ -0,0 +1,4 @@
+{
+  "title": "Command line interface",
+  "pages": ["index", "users", "integrations", "password-recovery", "fix-usernames", "development"]
+}
@@ -1,19 +1,19 @@
 # Password Recovery

-:::info
+<Alert type="info">

 This guide requires that you understand [how to access the CLI](../).

-:::
+</Alert>

 Using this command, you can forcefully reset the password of a user.
 It will be set to a random value and the hash for the user will be updated.
 All sessions for that user will be terminated and the user must re-login.

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

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

-![](./img/screenshot-cli-result.png)
+![Terminal output confirming a password reset and session deletion](./img/screenshot-cli-result.png)
@@ -1,12 +1,13 @@
 # Users

-:::info
+<Alert type="info">

 This guide requires that you understand [how to access the CLI](../).

-:::
+</Alert>

 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
-```
+```
@@ -1,9 +0,0 @@
-{
-    "label": "Developer guides",
-    "position": 6,
-    "collapsed": true,
-    "link": {
-      "type": "generated-index"
-    }
-  }
-  
@@ -8,74 +8,136 @@ 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 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 version.
+- **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
+```

-![Fork button](./img/fork.png)
+### 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. Run `openssl rand -hex 32` twice. Set `AUTH_SECRET` and `SECRET_ENCRYPTION_KEY` to the two different generated
+   values in `.env`; the example leaves both empty. Keep this file private and preserve `SECRET_ENCRYPTION_KEY`
+   when reusing a database.
+3. Set `DB_URL` to an absolute writable SQLite file path. Migration and application commands run from different
+   workspace directories, so a relative path can point them at different databases.
+4. Keep Redis and the optional local databases running in one terminal.
+5. Apply migrations and start Next.js in another terminal.

-![Clone button](./img/clone.png)
+```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`
+`pnpm dev` starts only Next.js. When your work needs scheduled tasks or live subscriptions, run the relevant service
+in a separate terminal alongside it:

-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)
+```sh
+pnpm --filter @homarr/tasks dev
+```

-### Useful npm scripts
+```sh
+pnpm --filter @homarr/websocket dev
+```

-#### During development
+The WebSocket service listens on port 3001. Production startup embeds both services, so these extra commands are
+only needed for development.

- `pnpm dev`: Start the Next.js development server.
- `pnpm dev:benchmark`: Run the local authenticated-board benchmark. Set `DEV_BENCHMARK_BOARD_URL` and
-  `DEV_BENCHMARK_STORAGE_STATE`; readiness-only measurements require the explicit `--smoke` flag and are not
-  suitable for performance claims.
- `pnpm dev:cli -- dev`: Browse and run local images and remote pull-request images.
- `pnpm dev:cli -- build <name>`: Build the current checkout as `homarr:<name>`.
- `pnpm dev:cli -- build --pr <number>`: Build a pull request locally from a temporary checkout.
- `pnpm dev:cli -- rebuild <name>`: 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.
+Workshop contributors can set up PocketBase and Fumadocs with the dedicated
+[Workshop development guide](/docs/advanced/development/workshop).

-#### Checking code quality
+### Useful commands

- `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.
+- `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 <name>` — build the current checkout as `homarr:<name>`.
+- `pnpm dev:cli -- build --pr <number>` — build a pull request from a temporary checkout.
+- `pnpm dev:cli -- rebuild <name>` — rebuild an image from its recorded checkout or pull request.
+- `pnpm dev:cli:install` — optionally install the developer CLI as a `homarr` binary.
+- `pnpm dev:docs` — Fumadocs on port 3003.
+- `pnpm 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 build` — production monorepo build.
+- `docker build -t homarr:local .` — build a production Docker image.
+- `docker run -p 7575:7575 -e SECRET_ENCRYPTION_KEY='your_64_character_hex_string' homarr:local` — run it.

-#### Building the project
+## CI and focused validation

- `pnpm build`: Build the project for production.
- `pnpm dev:cli -- build <name>`: Build a `homarr:<name>` image and record its checkout for later rebuilds.
- `docker build -t homarr .`: Build a docker image for the project.
- `docker run -p 7575:7575 -e SECRET_ENCRYPTION_KEY='your_64_character_hex_string' homarr:<name>`: Run the created docker image.
+The main CI workflow runs lint, typechecking, affected workspace builds, workspace configuration checks, OpenAPI validation, and Custom Widget architecture and bundle checks. Unit and E2E suites do not run in CI. Preview images publish after the Fast gate and both architecture builds succeed; browser tests do not block publication. The container job builds an amd64 image when no preview image was built.
+
+Workshop CI runs only when its workflow or Docker build inputs change. It validates Compose configuration and publishes production images on its configured release branches. Its Docker integration and image tests are manual; workspace typechecks run in the main Fast gate.
+
+Choose the smallest relevant suite when changing behavior:
+
+| Command                                           | Scope                                                          | Requirements                                                          |
+| ------------------------------------------------- | -------------------------------------------------------------- | --------------------------------------------------------------------- |
+| `pnpm test <file>`                                | Focused unit or contract tests                                 | Workspace dependencies                                                |
+| `pnpm test`                                       | All unit and contract tests, without Docker integration suites | Workspace dependencies                                                |
+| `pnpm test:coverage`                              | Unit and contract tests with coverage                          | Workspace dependencies                                                |
+| `pnpm test:integration <file>`                    | Docker-backed service and database compatibility tests         | Docker                                                                |
+| `pnpm test:e2e <file>`                            | Browser and container scenarios                                | Docker; Playwright Chromium and system dependencies for browser tests |
+| `pnpm test:docs-screenshots`                      | Regenerate Assistant documentation screenshots                 | Same browser prerequisites                                            |
+| `pnpm test:workshop` / `pnpm test:workshop-image` | Workshop integration / production-image validation             | Docker                                                                |
+
+Omit `<file>` to run all tests in that command's scope. E2E and screenshot commands use a local image tagged `homarr-e2e`, or an image selected with `HOMARR_E2E_IMAGE`. The default commands run once without automatic retries; coverage is opt-in. The screenshot generator is excluded from both unit and E2E commands.
+
+Keep behavioral coverage for authorization, migrations, persistence, and widget execution. Avoid tests that only search source code for particular component names, JSX, CSS, or documentation wording.
+
+## Documentation development
+
+Run `pnpm dev:docs` to open the Next.js and Fumadocs site at `http://127.0.0.1:3003`. Content lives in
+`apps/docs/docs/`; the nearest `meta.json` controls navigation. Keep integration and widget setup metadata in their
+typed `index.ts` files alongside the page.
+
+After changing content, navigation, or shared MDX components, run:
+
+```sh
+pnpm --filter @homarr/docs build
+pnpm --filter @homarr/docs validate:links
+pnpm --filter @homarr/docs verify:search
+pnpm --filter @homarr/docs verify:seo
+```
+
+The build writes a static site to `apps/docs/out/`. Check heading links, search results, and the page's Markdown export
+when changing shared components. The [Fumadocs documentation](https://fumadocs.dev/docs) describes supported components
+and source APIs; match examples to the versions installed in this repository.
@@ -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.
+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.
@@ -0,0 +1,4 @@
+{
+  "title": "Developer guides",
+  "pages": ["getting-started", "widgets-and-integrations", "kubernetes", "workshop", "workshop-operator"]
+}
@@ -0,0 +1,104 @@
+---
+title: Widgets and integrations
+tags:
+  - Developer
+  - Technical documentation
+  - Widgets
+  - Integrations
+sidebar_position: 2
+---
+
+Homarr keeps feature registration explicit and typed. Feature registration has no generator or generated registry.
+A new feature is available when its typed metadata and lazy loader are registered.
+
+## Add a widget
+
+Keep the UI, options, helpers, and tests together in `packages/widgets/src/<widget>/`. The usual folder only needs an
+`index.ts` definition and a lazily imported `component.tsx`; complex widgets can add local files as needed.
+
+1. Add the stable kind to `packages/definitions/src/widget.ts` and its documentation slug or `null` to the direct typed
+   map in `packages/definitions/src/docs/widget-doc-slugs.ts`.
+2. Export `definition` and `componentLoader` from `packages/widgets/src/<widget>/index.ts` with
+   `createWidgetDefinition`. The local definition owns its icon, query keys, refresh interval, options, matchers, and
+   errors. Keep the component behind `withDynamicImport` so adding a widget does not load it on every dashboard.
+3. For an integration-backed widget, add its integration kinds and selection rules once to
+   `packages/definitions/src/widget-integration-map.ts`, then spread `getWidgetIntegrationConfig(kind)` into the local
+   definition. This server-safe config is also the API authorization boundary, avoiding a package cycle without
+   duplicating widget metadata.
+4. Register the widget in both explicit literal loader maps and the type-only module map in
+   `packages/widgets/src/registry.ts`, then add its icon to `packages/ui/src/widget-icons.ts`. The module and component
+   loaders must both use literal import paths. Keeping them separate lets a cold widget load request its definition
+   and component chunks in parallel; the type-only map preserves exact option and component inference. Keep all three
+   maps in the same order so drift is obvious in review.
+5. If the widget needs server data, add its tRPC router under `packages/api/src/router/widgets/` and add its explicit
+   lazy import to `packages/api/src/router/widgets/index.ts`. Keep upstream requests and Redis response caching in
+   `@homarr/request-handler`. Use the widget integration middleware for integration-backed procedures.
+6. If advanced users need non-obvious setup or behavior explained, add a concise page in `apps/docs/docs/widgets/<slug>/`;
+   otherwise leave the widget's docs slug as `null`.
+
+Weather is the small integration-free example. Downloads shows integration selection, polling, server caching,
+mutations, partial upstream failures, and a larger options surface.
+
+## Add an integration
+
+Keep the HTTP client and its capability-specific types in `packages/integrations/src/<integration>/`.
+
+1. Add the typed definition to `packages/definitions/src/integration.ts`, including credential alternatives, categories,
+   ports, Docker aliases, and onboarding metadata when relevant. Set `documentationSlug` to a page slug or `null`.
+2. Add an explicit lazy creator to `packages/integrations/src/base/creator.ts`. The literal import keeps the
+   implementation out of the initial server bundle and makes the registration easy to find.
+3. Implement only the interfaces required by the widgets that use the service.
+4. When advanced users need non-obvious setup or behavior explained, add a concise page in
+   `apps/docs/docs/integrations/<slug>/`. Its `index.ts` must satisfy `IntegrationDefinition`; use a type-only import
+   and `satisfies IntegrationDefinition` rather than a cast.
+
+Beszel is a compact example with several widgets sharing one integration client.
+
+## User documentation
+
+Add a page only when a smart, advanced user cannot infer setup or behavior from the UI or generated schema. Keep it short
+and operational.
+
+- Start with one sentence describing what the integration or widget adds to Homarr.
+- Include prerequisites, credentials, permissions, destructive actions, and non-obvious limits only when they matter.
+- Use numbered steps only when order matters. Prefer the exact UI labels a user must select.
+- Do not add marketing, implementation history, architecture internals, or explanations of basic self-hosting concepts.
+- End when the user can configure and verify the feature; do not repeat the same information in a summary.
+
+The usual page needs only an introduction and a `Configuration` section. Add `Notes` or `Troubleshooting` only for
+real caveats.
+
+## Data and errors
+
+- TanStack Query owns browser caching and refresh behavior. Redis owns shared server response caching for bounded key
+  spaces. Public handlers whose keys come from arbitrary URLs, domains, symbols, or coordinates stay in the bounded
+  process-local cache.
+- Cache raw service responses, never authorization decisions or decrypted credentials. Integration-backed cache keys
+  include keyed credential fingerprints and the complete integration identity, and are invalidated after mutations.
+  The fingerprints change with credentials without exposing their values in Redis keys.
+- Give upstream requests a finite deadline and pass the request handler's `AbortSignal` into clients that support it.
+  Admission is bounded per handler. Request deduplication and distributed lock ownership remain active until the
+  upstream settles or a bounded cleanup grace expires, while unresolved upstream work stays separately capped.
+- Keep validation and authorization on the server. Client-side checks improve UX but do not replace tRPC guards.
+- Use the shared logger with safe identifiers, operation names, duration, and the original error cause. Never log
+  secrets or full upstream payloads.
+- Multi-integration reads should return successful providers when one service fails and surface a clear error when all
+  providers fail.
+
+Registration files intentionally contain boring, explicit imports. This small amount of repetition preserves exact
+TypeScript inference, gives Next.js discoverable lazy chunks, and keeps Ctrl+click navigation reliable.
+
+## Registry imports
+
+Use `@homarr/widgets/manifest` to load registered widgets. `loadWidgetDefinition` is the metadata-only path;
+`loadWidgetComponent` loads only the UI module; and `loadWidgetResources` requests both paths in parallel. These
+loaders cache in-flight and successful promises and remove rejected promises so a later request can retry.
+
+The former root `widgetImports` and `loadWidgetDynamic` exports are intentionally not compatibility aliases.
+`widgetImports` synchronously imported every widget module, and `loadWidgetDynamic` depended on that eager map.
+Restoring them at the package root would defeat lazy definition chunks or add client-only runtime dependencies to
+every root consumer. Migrate metadata consumers to `loadWidgetDefinition`, renderers to `loadWidgetResources`, and
+type-only registry consumers from the removed internal `WidgetImportRecord` helper to the root `WidgetImports` type.
+
+`@homarr/widgets/catalog` remains as a deprecated compatibility subpath for `widgetCatalogIcons`. New imports should
+use `@homarr/ui/widget-icons`, which is the canonical server-safe icon catalog.
@@ -0,0 +1,95 @@
+---
+title: Workshop operator guide
+sidebar_label: Operator guide
+sidebar_position: 3
+tags:
+  - Workshop
+  - Deployment
+  - Environment variables
+  - PocketBase
+---
+
+# Workshop operator guide
+
+Workshop uses PocketBase. The production image serves the Workshop website and API from one origin and stores state in
+`/pb_data`.
+
+## Environment variables
+
+| Variable                               | Purpose                                      | Default                        |
+| -------------------------------------- | -------------------------------------------- | ------------------------------ |
+| `HOMARR_WEBSITE_URL`                   | Documentation/site base used by Homarr links | `https://homarr.dev`           |
+| `WORKSHOP_API_URL`                     | PocketBase API used by Homarr and docs       | `HOMARR_WEBSITE_URL`           |
+| `WORKSHOP_WEB_URL`                     | Public Workshop URL                          | `HOMARR_WEBSITE_URL/workshop`  |
+| `WORKSHOP_PUBLIC_ORIGIN`               | PocketBase-generated links and email         | Required in production         |
+| `PB_ALLOWED_ORIGINS`                   | Allowed browser origins                      | `*`                            |
+| `GITHUB_CLIENT_ID`                     | GitHub OAuth application ID                  | —                              |
+| `GITHUB_CLIENT_SECRET`                 | GitHub OAuth application secret              | —                              |
+| `OPENROUTER_API_KEY`                   | Enables the Homarr Assistant provider        | Provider disabled when empty   |
+| `HOMARR_AI_DAILY_REQUEST_LIMIT`        | Per-user daily request allowance             | `50`                           |
+| `HOMARR_AI_GLOBAL_DAILY_REQUEST_LIMIT` | Shared daily request ceiling                 | `10000`                        |
+| `HOMARR_AI_OPENROUTER_BASE_URL`        | OpenRouter-compatible upstream               | `https://openrouter.ai/api/v1` |
+| `HOMARR_AI_OPENROUTER_MODEL`           | Upstream model behind `homarr/model`         | `openai/gpt-6-luna`            |
+
+Public URL variables accept HTTP(S) origins without embedded credentials, query strings, or fragments. Restart the
+container after changing runtime configuration.
+
+## Documentation search and AI
+
+The documentation uses Fumadocs search with an index generated during the website build. Search runs in the browser
+and needs no hosted search credentials or crawler.
+
+The **Ask AI** launcher connects to Kapa separately. `KAPA_WEBSITE_ID` is a public website integration ID, read when
+building the documentation. The default uses Homarr's integration. For a private deployment, pass your own ID or
+an empty value to disable it: `docker build --build-arg KAPA_WEBSITE_ID= -f apps/workshop/Dockerfile .`.
+Changing this value requires rebuilding the image; setting it on an already-built container has no effect.
+
+For your own Kapa integration, enable the deployment domain in Kapa and configure a Website Crawl source for your
+published docs. Preview the `main` content selector and verify extracted headings, code, and integration details.
+After a migration, refresh the source and check answer citations. `/llms.txt` alone does not configure Kapa ingestion.
+See the [Kapa website widget guide](https://docs.kapa.ai/integrations/website-widget/quickstart).
+
+## Authentication and email
+
+Configure both GitHub OAuth variables and use `https://<workshop-host>/api/oauth2-redirect` as the callback. Supplying
+only one OAuth variable is a startup error. Configure SMTP for comment, report, and removal notifications.
+
+For the central community, `PB_ALLOWED_ORIGINS=*` permits requests from self-hosted Homarr origins. A private deployment
+can use a comma-separated allowlist.
+
+## Homarr provider
+
+`OPENROUTER_API_KEY` enables the [Homarr provider](/docs/workshop/homarr-provider). The default is `openai/gpt-6-luna`
+with Max reasoning and a 32K combined reasoning/output budget. Remove an old `HOMARR_AI_OPENROUTER_MODEL` override or set
+it explicitly to this model when upgrading. OpenRouter selects an eligible provider for the model; Workshop does not
+pin a provider. Provider fallbacks remain disabled.
+
+For [BYOK](https://openrouter.ai/docs/guides/overview/auth/byok), configure your OpenAI key as a prioritized key in the
+same OpenRouter workspace as `OPENROUTER_API_KEY`. Set **Shared capacity fallback** to **Never use shared capacity for
+any model on this provider**. The request's `allow_fallbacks: false` prevents retrying another provider, but does not
+pin the initial provider or guarantee OpenAI BYOK billing. Use OpenRouter provider restrictions if required. Store the
+OpenAI key in OpenRouter, not in Workshop or Homarr clients.
+
+Workshop retains zero-data-retention routing and denies data collection. Your BYOK key must be eligible under those
+policies; configure any provider-agreement declaration only if it reflects your actual OpenAI agreement. An ineligible
+or unavailable key cannot make a non-ZDR route eligible. Other eligible providers may serve the model.
+
+Workshop does not retain prompts or responses and enforces per-user and global daily request limits. Keep spending
+controls on both the OpenAI account and OpenRouter workspace: request limits are not monetary limits, and OpenRouter
+fees can still apply to BYOK requests. Streaming responses include upstream token usage when reported.
+
+## Deployment
+
+The v2 image is `ghcr.io/homarr-labs/workshop:v2`; immutable `sha-<commit>` tags are preferable for promotion. The
+service listens on port 8090.
+
+When using a reverse proxy, forward the complete hostname, including `/api`, `/_/`, and
+`/workshop-runtime-config.js`. Use a dedicated hostname when Homarr already occupies the intended origin.
+
+Verify `/api/health`, the Workshop page, a public listing request, GitHub sign-in, and one installation after deployment.
+
+## Backup and restore
+
+Stop writes and copy `/pb_data` for a consistent backup. A restore replaces the selected PocketBase data directory, so
+preserve the current volume and verify that the backup contains `data.db` first. Rehearse the restore outside production
+and verify sign-in and one installation afterward.
@@ -0,0 +1,41 @@
+---
+title: Workshop development
+sidebar_position: 4
+tags:
+  - Workshop
+  - Developer
+  - Fumadocs
+  - PocketBase
+---
+
+# Workshop development
+
+See the [main development guide](/docs/advanced/development/getting-started) for repository prerequisites.
+
+Start PocketBase:
+
+```sh
+cp apps/workshop/.env.example apps/workshop/.env
+docker compose --env-file apps/workshop/.env -f apps/workshop/docker-compose.yml up --build workshop
+```
+
+Start Fumadocs in another terminal:
+
+```sh
+WORKSHOP_API_URL=http://127.0.0.1:8090 pnpm dev:docs
+```
+
+PocketBase runs at `http://127.0.0.1:8090`; create the first superuser under `/_/`. Workshop is available at
+`http://127.0.0.1:3003/workshop`.
+
+To connect a local Homarr instance, set:
+
+```dotenv
+HOMARR_WEBSITE_URL=http://127.0.0.1:3003
+WORKSHOP_API_URL=http://127.0.0.1:8090
+WORKSHOP_WEB_URL=http://127.0.0.1:3003/workshop
+```
+
+Restart the affected development process after changing these variables. See
+[`apps/workshop/README.md`](https://github.com/homarr-labs/homarr/blob/HEAD/apps/workshop/README.md) for OAuth,
+moderation, tests, and service maintenance.
@@ -14,25 +14,60 @@ tags:

 Homarr offers a few environment variables, which can be used to configure the container.

-:::info
+<Alert type="info">
+
 With docker you can add the `_FILE` suffix to any environment variable, which will read the value from a file.
 This is especially useful for [docker secrets](https://docs.docker.com/engine/swarm/secrets/#use-secrets-in-compose).
-:::
+
+</Alert>

 ## General

-:::warning
-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.
-:::
+<Alert type="warning">

-| 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` |
+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.
+
+</Alert>
+
+| 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`                        |
+| `BASE_URL`               | Public Homarr origin used by MCP OAuth metadata and redirects. Set this when a reverse proxy does not preserve the public host and protocol.                                                                                           | HTTP(S) origin without a path       | -                             |
+| `NO_EXTERNAL_CONNECTION` | Disables Homarr's internet-backed requests, including update checks, weather, location search, and RSS feeds                                                                                                                           | `true` or `false`                   | `false`                       |
+| `ENABLE_DNS_CACHING`     | Enables dns caching. Enabled by default, but if you experience issues with IPv6 or static IPs, see [#4006](https://github.com/homarr-labs/homarr/issues/4006) or disable this flag                                                     | `true` or `false`                   | `true`                        |
+| `HOMARR_DISABLE_IPV6`    | Disables the IPv6 listener of the internal nginx proxy, even when the host supports IPv6. IPv6 is normally disabled automatically when the host has no IPv6 configured. See [#4596](https://github.com/homarr-labs/homarr/issues/4596) | `true` or `false`                   | `false`                       |
+| `HOMARR_WEBSITE_URL`     | Main Homarr documentation/site base used by runtime links. Must be an absolute HTTP(S) URL.                                                                                                                                            | HTTP(S) URL                         | `https://homarr.dev`          |
+| `WORKSHOP_API_URL`       | PocketBase API used by Homarr and standalone documentation.                                                                                                                                                                            | HTTP(S) URL                         | `HOMARR_WEBSITE_URL`          |
+| `WORKSHOP_WEB_URL`       | Public Workshop website used by links in Homarr, Custom Widgets, onboarding, and assistant context.                                                                                                                                    | HTTP(S) URL                         | `HOMARR_WEBSITE_URL/workshop` |
+
+Workshop service operators can find its server-only configuration in the
+[Workshop operator guide](/docs/advanced/development/workshop-operator#environment-variables).
+
+### Demo mode
+
+`DEMO_MODE=true` seeds demo data and makes Assistant return a fixed response without calling a model provider. `DEMO_READ_ONLY` defaults to `true`, blocking dashboard and configuration changes. Authenticated users can still save and manage their own Assistant conversations so canned chats work. Set `DEMO_READ_ONLY=false` for editable preview deployments.
+
+### Workshop service
+
+These variables configure the separate Workshop service, not the Homarr application container.
+
+| Environment Variable                        | Description                                                               | Default                           |
+| ------------------------------------------- | ------------------------------------------------------------------------- | --------------------------------- |
+| `WORKSHOP_PUBLIC_ORIGIN`                    | Public origin used in PocketBase links and email                          | Required in production            |
+| `PB_ALLOWED_ORIGINS`                        | Browser origins allowed to call PocketBase                                | `*` for the public community      |
+| `WORKSHOP_IMAGE`                            | Workshop image used by the staging Compose file                           | `ghcr.io/homarr-labs/workshop:v2` |
+| `WORKSHOP_EXPOSE_PORT`                      | Host port for the combined staging service                                | `8090`                            |
+| `PB_EXPOSE_PORT`                            | Host port for local PocketBase development                                | `8090`                            |
+| `DOCS_EXPOSE_PORT`                          | Host port for local documentation development                             | `3003`                            |
+| `GITHUB_CLIENT_ID` / `GITHUB_CLIENT_SECRET` | Optional GitHub OAuth application credentials                             | -                                 |
+| `OPENROUTER_API_KEY`                        | Server-only upstream key that enables the Homarr Assistant provider       | Provider disabled                 |
+| `HOMARR_AI_DAILY_REQUEST_LIMIT`             | Daily Assistant request units per user                                    | `50`                              |
+| `HOMARR_AI_GLOBAL_DAILY_REQUEST_LIMIT`      | Daily Assistant request units shared by all users                         | `10000`                           |
+| `HOMARR_AI_OPENROUTER_BASE_URL`             | OpenRouter-compatible provider endpoint                                   | `https://openrouter.ai/api/v1`    |
+| `HOMARR_AI_OPENROUTER_MODEL`                | OpenRouter model exposed through `homarr/model`                           | `openai/gpt-6-luna`               |
+| `HOMARR_AI_ALLOW_INSECURE_UPSTREAM`         | Allows an HTTP upstream for local provider tests; never use in production | `false`                           |

 ## Authentication

@@ -46,30 +81,35 @@ The `SECRET_ENCRYPTION_KEY` is required. If none is specified before starting th
 | ----------------------- | ------------------------------------------- | ----------------------- | ------- |
 | `SECRET_ENCRYPTION_KEY` | Secret used to encrypt secrets in database. | 64 character hex string | -       |

-:::info
+<Alert type="info">
+
 A random secret can be generated by using the following command: `openssl rand -hex 32`
-:::
+
+</Alert>

 ## 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_SOCKET_PATHS` | Comma-separated mounted Docker-compatible socket paths. Homarr discovers each path as a selectable Docker environment                                                                                                | For example `/var/run/docker.sock,/var/run/podman.sock` | -       |
+| `DOCKER_HOSTNAMES`    | Comma-separated plaintext TCP hostnames. Pair each hostname with the port in the same position in `DOCKER_PORTS`                                                                                                     | For example `localhost,docker.example.com`              | -       |
+| `DOCKER_PORTS`        | Comma-separated plaintext TCP ports paired with `DOCKER_HOSTNAMES`                                                                                                                                                   | For example `2375,2376`                                 | -       |
+| `DOCKER_ENDPOINTS`    | Optional advanced JSON configuration for custom names, TLS, or restricted capabilities. It takes precedence over the simple variables above. See the [Docker and Podman connection guide](/docs/integrations/docker) | A JSON array of endpoint descriptors                    | -       |

 ## 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                   | -                       |
+SQLite is the default; PostgreSQL is also supported. Existing MySQL installations must [convert to SQLite before upgrading to v2](/docs/advanced/mysql-to-sqlite).
+
+| Environment Variable | Description                                                                               | Possible values                    | Default                 |
+| -------------------- | ----------------------------------------------------------------------------------------- | ---------------------------------- | ----------------------- |
+| `DB_DRIVER`          | Database driver to use. Use `better-sqlite3` for SQLite or `node-postgres` for PostgreSQL | `better-sqlite3` / `node-postgres` | `better-sqlite3`        |
+| `DB_DIALECT`         | Database dialect to use.                                                                  | `sqlite` / `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.

@@ -78,9 +118,11 @@ You can either use the url or host, port, name and credentials combined. The URL
 By default Redis is running within the installation. (for example in Docker).
 However for example for K8s it can be useful to use an external Redis instance.

-:::note
+<Alert type="note">
+
 External redis is currently not supported with Proxmox Community Scripts
-:::
+
+</Alert>

 | Environment Variable   | Description                                                                                          | Possible values          | Default |
 | ---------------------- | ---------------------------------------------------------------------------------------------------- | ------------------------ | ------- |
@@ -102,10 +144,15 @@ External redis is currently not supported with Proxmox Community Scripts

 ## Advanced deployments

-:::warning
-The advanced deployments environment variables should only be used if you know what you are doing.
-:::
+<Alert type="warning">

-| Environment Variable     | Description                                        |
-| ------------------------ | -------------------------------------------------- |
-| `DB_MIGRATIONS_DISABLED` | Disable db migrations. For example for helm charts |
+The advanced deployments environment variables should only be used if you know what you are doing.
+
+</Alert>
+
+| Environment Variable     | Description                                         |
+| ------------------------ | --------------------------------------------------- |
+| `DB_MIGRATIONS_DISABLED` | Disable db migrations. For example for helm charts. |
+
+All public URL variables reject non-HTTP protocols, embedded credentials, query strings, and fragments, and normalize
+trailing slashes when Homarr or the documentation site starts.
@@ -0,0 +1,64 @@
+---
+title: Advanced configuration
+description: Configure deployment, authentication, networking, styling, automation, and development workflows.
+---
+
+import {
+  IconCode,
+  IconIcons,
+  IconKey,
+  IconKeyboard,
+  IconNetwork,
+  IconPalette,
+  IconTerminal2,
+  IconUserCog,
+  IconVariable,
+} from "@tabler/icons-react";
+
+These guides cover changes that affect how Homarr is deployed, secured, operated, or extended.
+
+## Dashboard data cache
+
+Homarr keeps eligible integration responses in Redis. It also retains a bounded, board-scoped snapshot of selected integration widget queries for up to three days. Authorized viewers receive the last snapshot while the server refreshes those queries and streams updated values to the browser. Embedded images and large results are excluded. The browser keeps TanStack Query data in memory only; dashboard query data is not saved in browser storage.
+
+## Deploy and secure
+
+<Cards>
+  <Card icon={<IconVariable />} title="Environment variables" href="/docs/advanced/environment-variables">
+    Configure Homarr at deployment time.
+  </Card>
+  <Card icon={<IconKey />} title="Single sign-on" href="/docs/advanced/single-sign-on">
+    Connect an external identity provider.
+  </Card>
+  <Card icon={<IconNetwork />} title="Proxies and certificates" href="/docs/advanced/proxy">
+    Run Homarr behind a reverse proxy.
+  </Card>
+  <Card icon={<IconUserCog />} title="Run as a different user" href="/docs/advanced/running-as-different-user">
+    Change the user and group used by the container.
+  </Card>
+</Cards>
+
+## Customize
+
+<Cards>
+  <Card icon={<IconPalette />} title="Custom styling" href="/docs/advanced/styling">
+    Apply custom CSS to Homarr.
+  </Card>
+  <Card icon={<IconIcons />} title="Icons" href="/docs/advanced/icons">
+    Configure icon sources and behavior.
+  </Card>
+  <Card icon={<IconKeyboard />} title="Keyboard shortcuts" href="/docs/advanced/keyboard-shortcuts">
+    Navigate and operate Homarr with the keyboard.
+  </Card>
+</Cards>
+
+## Develop and automate
+
+<Cards>
+  <Card icon={<IconTerminal2 />} title="Command line interface" href="/docs/advanced/command-line">
+    Use administrative commands from the terminal.
+  </Card>
+  <Card icon={<IconCode />} title="Developer guides" href="/docs/advanced/development/getting-started">
+    Set up a development environment and contribute code.
+  </Card>
+</Cards>
@@ -6,22 +6,63 @@ tags:

 Homarr has the following keyboard shortcuts:

-| Shortcut | Description |
-| -------- | ----------- |
-| `MOD` + `K` | Opens the search bar |
-| `MOD` + `J` | Toggles Dark Mode |
-| `MOD` + `E` | Toggles Edit Mode |
+| Shortcut                                            | Description                                                                                                                |
+| --------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
+| `MOD` + `K`                                         | Opens search, including local apps, boards, integrations, pages, commands, and preferences                                 |
+| `MOD` + `P`                                         | Opens app search                                                                                                           |
+| `MOD` + `/`                                         | Opens Homarr Assistant inside search                                                                                       |
+| `MOD` + `Shift` + `/` (`MOD` + `?`)                 | Opens preference search                                                                                                    |
+| `Shift` + `A`                                       | Opens the full Homarr Assistant                                                                                            |
+| `MOD` + `J`                                         | Toggles Dark Mode                                                                                                          |
+| `MOD` + `E`                                         | Toggles Edit Mode                                                                                                          |
+| Hold `Shift` for 500 ms over a supported widget     | Opens its temporary advanced view                                                                                          |
+| Hold `Shift` + `Ctrl`/`Cmd` over a supported widget | Keeps its advanced view open until it is closed                                                                            |
+| `Esc`                                               | Stops keyboard tile editing, cancels an active pointer or touch move/resize, or closes an open advanced view or board menu |

-:::tip
+## Search and commands
+
+Search is designed as the fastest route to Homarr. Start typing after `MOD` + `K` to find local apps, boards,
+integrations, pages, commands, and preferences without entering a separate mode first. Local Homarr results appear
+before configured search-engine actions and Assistant fallbacks. Commands include opening the board switcher without
+leaving the keyboard. Type `!` to enter Web mode when you want to browse configured engine shortcuts or discover
+DuckDuckGo bangs; bang discovery is excluded from ordinary Search results.
+
+Use the dedicated shortcuts above to start in apps, Assistant, or preferences. Inside search, choose a mode to narrow
+the same query when needed. Media request search is available only when a supported Seerr integration is configured.
+
+## Widget advanced view
+
+Supported widgets open a temporary advanced view when you hold `Shift` over them for 500 ms. Hold `Shift` plus `Ctrl`
+on Windows/Linux or `Cmd` on macOS over the widget to keep the advanced view open, or use its menu.
+
+## Board editing
+
+`MOD` + `E` enters edit mode. Homarr keeps the current board visible while the editor prepares; movement and resizing become available when it is ready.
+
+When a tile is focused in edit mode:
+
+| Shortcut             | Description                                                                 |
+| -------------------- | --------------------------------------------------------------------------- |
+| `Enter` or `Space`   | Starts or stops keyboard editing                                            |
+| Arrow keys           | Moves the focused tile within its current canvas, rail, or Container        |
+| `Shift` + Arrow keys | Resizes from the tile's lower-right corner: Left/Up shrink; Right/Down grow |
+| `Esc`                | Stops keyboard editing without undoing its changes                          |
+
+Keyboard moves and resizes apply immediately. To move an item between a canvas, rail, or Container, drag it there or use **Move / resize item** for precise numeric placement.
+Commands at a grid boundary or at the tile's minimum size are ignored and announced instead of moving or shrinking the tile.
+
+On touch screens, press and hold a tile before moving it; a quick tap does not start a drag. Resize handles accept direct touch input. During a pointer or touch move or resize, `Esc` cancels the interaction and restores the layout from before it started.
+
+<Alert type="tip">

 Here `MOD` refers to the modifier key, which is `Ctrl` on Windows and `Cmd` on macOS.

-:::
+</Alert>

-:::note
+<Alert type="note">

 The focus of your browser must be set on Homarr. If you click outside of Homarr, you might need to click once somewhere in Homarr to send all keystrokes again to Homarr.

 If the shortcuts are not working, ensure that you have selected the correct keyboard layout.

-:::
+</Alert>
@@ -0,0 +1,20 @@
+{
+  "title": "Advanced",
+  "defaultOpen": false,
+  "pages": [
+    "index",
+    "---Deploy and secure---",
+    "environment-variables",
+    "mysql-to-sqlite",
+    "single-sign-on",
+    "proxy",
+    "running-as-different-user",
+    "---Customize---",
+    "styling",
+    "icons",
+    "keyboard-shortcuts",
+    "---Develop and automate---",
+    "command-line",
+    "development"
+  ]
+}
@@ -0,0 +1,66 @@
+---
+title: Move from MySQL to SQLite
+---
+
+# Move from MySQL to SQLite
+
+Homarr v2 supports SQLite (the default) and PostgreSQL. MySQL installations must convert before upgrading to v2.
+
+The standalone converter is tested against the **Homarr v1.77.1 database schema** and writes its corresponding SQLite database. Homarr v2 applies its normal migrations when it first opens that file. The converter does not modify the source database.
+
+## Before converting
+
+1. Back up the MySQL database, `/appdata`, your deployment configuration, and `SECRET_ENCRYPTION_KEY`. Keep the previous Homarr image available for rollback.
+2. Upgrade to the latest stable v1 release (**v1.77.1** at the tested baseline) first and let its migrations finish successfully. Back up that database before continuing.
+3. Stop every Homarr instance that writes to this database. Leave MySQL running and keep Homarr stopped throughout conversion and cutover.
+
+The converter validates the schema and migration journal against v1.77.1; it does not identify the application binary version. Older releases with identical schemas are compatible. Different schemas, incomplete migrations, and existing output files are rejected.
+
+## Convert
+
+From a checkout containing `tools/mysql-to-sqlite`, build the converter:
+
+```sh
+docker build -t homarr-mysql-to-sqlite tools/mysql-to-sqlite
+mkdir -p converted
+```
+
+Create `mysql-conversion.env` with credentials for the source database:
+
+```dotenv
+MYSQL_HOST=mysql.example.com
+MYSQL_PORT=3306
+MYSQL_USER=homarr
+MYSQL_PASSWORD=replace-with-your-password
+MYSQL_DATABASE=homarr
+```
+
+`MYSQL_PORT` defaults to `3306`. Use a host reachable from the converter container; `localhost` refers to the container itself. Keep this credentials file out of version control.
+
+Run the converter after stopping Homarr:
+
+```sh
+docker run --rm --user "$(id -u):$(id -g)" --env-file mysql-conversion.env \
+  -v "$(pwd)/converted:/output" \
+  homarr-mysql-to-sqlite --output /output/db.sqlite --homarr-stopped
+```
+
+Running as your user keeps the output file readable by you. The required `--homarr-stopped` flag confirms that you stopped Homarr; it does not stop your deployment. Wait for the converter to exit successfully before using `converted/db.sqlite`.
+
+For a TLS connection, add `MYSQL_SSL_CA=/certs/mysql-ca.pem` to the env file and mount the PEM certificate with `-v "$(pwd)/mysql-ca.pem:/certs/mysql-ca.pem:ro"`. The certificate file must be readable by the container user.
+
+## Start Homarr v2
+
+1. Keep a separate copy of the converted file before the first v2 startup.
+2. Place `db.sqlite` at `/appdata/db/db.sqlite` in the appdata volume used by Homarr. Ensure the Homarr process can write to the file and its directory.
+3. Set `DB_DRIVER=better-sqlite3` and `DB_URL=/appdata/db/db.sqlite`. Remove the previous MySQL connection settings; if you explicitly set `DB_DIALECT`, change it to `sqlite`.
+4. Preserve the original `/appdata` files and **the same `SECRET_ENCRYPTION_KEY`**. The converter copies encrypted values without re-encrypting them; a different key will make those secrets unreadable.
+5. Start Homarr v2 and wait for its database migrations to finish. Check the startup logs, sign in, and verify your boards, users, integrations, and uploaded files.
+
+The converter output is a raw SQLite database. Do not upload it to the backup ZIP import page.
+
+## Roll back
+
+Stop Homarr v2, then restore your previous deployment configuration, image, appdata backup, and encryption key, pointing it at the preserved MySQL database. Do not open the v2 SQLite database with the older Homarr image.
+
+Changes made after switching to SQLite are not synchronized back to MySQL. Keep the original database and backups until you have verified the new installation.
@@ -9,27 +9,29 @@ tags:
  - Security
 ---

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

 ## 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?
+<Alert type="note" title="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.

-:::
+</Alert>

 To allow self-signed certificates, you can configure them on the certificates management page. You can find more informations on the dedicated page: [Certificates](/docs/management/certificates/)

 ## 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
@@ -38,7 +40,7 @@ services:
    volumes:
      - ./homarr/appdata:/appdata
    environment:
-      - BASE_URL=your.internal.dns.address.here.com
+      - BASE_URL=https://your.internal.dns.address.here.com
      - SECRET_ENCRYPTION_KEY=your_64_character_hex_string # <--- can be generated with `openssl rand -hex 32`
    networks:
      - proxy
@@ -53,11 +55,12 @@ networks:
    external: true
 ```

-<br/>
+<br />

 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:
@@ -103,10 +106,11 @@ networks:
    external: true
 ```

+<Alert type="tip">

-:::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.
-:::
+
+</Alert>

 ## Securing Homarr with Caddy

@@ -114,7 +118,6 @@ If you are using Caddy as the reverse proxy for your setup, your `docker-compose

 ```yaml
 services:
-  
  # <-- [Homarr installation]

  caddy:
@@ -140,15 +143,19 @@ 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:
+
+<Alert type="warning" title="Important">
+
+Homarr and Caddy must share the same Docker network:
+
 ```yaml
 homarr:
  ...
  networks:
    - proxy
 ```
-:::
+
+</Alert>

 Next, create a file named `Caddyfile` at the same level as your `docker-compose.yml` file with the following content:

@@ -8,13 +8,16 @@ 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.

-:::info
-When starting up an updated version of the container it will have about **10 seconds longer to start** as it has to change the permissions of the app directories
-:::
+<Alert type="info">
+
+At startup, Homarr updates ownership of its data directories and runtime caches for the selected user and group.
+Startup time depends on the amount of persistent data; application code and dependencies do not need ownership changes.
+
+</Alert>

 ## Without mounted Docker socket

@@ -32,11 +35,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 +79,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 +93,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.
+Important here is that the group ID is set to `999` as we created the `docker` group with this ID.
@@ -10,213 +10,204 @@ tags:
  - Active Directory
 ---

-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-
 # Single Sign On

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

-### Auth configuration common variables
-| Environment Variable      | Description | Default Value |
-|---------------------------|-------------|---------------|
-| AUTH_PROVIDERS             | Select Which provider to use between *credentials*, *ldap* and *oidc*. <br /> 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`  |
+## Common configuration

-<Tabs>
-  <TabItem value="credentials" label="Credentials Provider" default>
+| Environment Variable     | Description                                                                                                                                                                                                                                                                                                             | Default Value |
+| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
+| AUTH_PROVIDERS           | Select Which provider to use between _credentials_, _ldap_ and _oidc_. <br /> 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`      |

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

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

-  </TabItem>
-  <TabItem value="ldap" label="LDAP provider">
+First user is created using the onboarding process and the rest can be created by this user (see [user management](/docs/management/users))

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

-    Any user in LDAP server that signs in gets created in Homarr database.
+This provider authenticates against an LDAP server.

-    Roles are fetched from LDAP groups. Groups with the same name of Homarr will be used to synchronize them.
+Any user in LDAP server that signs in gets created in Homarr database.

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

+LDAP users whose distinguished names contain non-ASCII characters can sign in and have their groups resolved.

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

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

-        In this setup we are using [lldap](https://github.com/lldap/lldap). Install your server using docker or [as a service](https://github.com/lldap/lldap/blob/main/example_configs/lldap.service).
+    Minimal configuration requires 4 env variables, LDAP URI, base, user and password for querying data.

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

-        There's more variables, but all have defaults corresponding to lldap defaults. These might need to be changed if you have different LDAP provider.
-        ```
-        docker run ...
-        AUTH_PROVIDERS="ldap"
-        AUTH_LDAP_URI="ldap://example.com:3890"
-        AUTH_LDAP_BASE="dc=example,dc=com" // Same as LLDAP_LDAP_BASE_DN
-        AUTH_LDAP_BIND_DN="uid=admin,ou=People,dc=example,dc=com"
-        AUTH_LDAP_BIND_PASSWORD="adminpass" // Same as LLDAP_LDAP_USER_PASS
-        ```
-        ```
-        #Docker compose
-        version: x
-        services:
-          homarr:
-            environment:
-              AUTH_PROVIDERS: ldap
-              AUTH_LDAP_URI: ldap://example.com:3890
-              AUTH_LDAP_BASE: dc=example,dc=com #Same as LLDAP_LDAP_BASE_DN
-              AUTH_LDAP_BIND_DN: uid=admin,ou=People,dc=example,dc=com
-              AUTH_LDAP_BIND_PASSWORD: adminpass #Same as LLDAP_LDAP_USER_PASS
-        ```
+    In lldap, create a user and admin group, assign this user to the external admin group configured during onboarding. You can log in using this user and he will be in the group.

-        In lldap, create a user and admin group, assign this user to the external admin group configured during onboarding. You can log in using this user and he will be in the group.
+    Here is another example for Active Directory:

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

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

-      </div>
-    </details>
+### LDAP configuration

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

-    ### Configuration
+## OIDC provider

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

-  </TabItem>
-  <TabItem value="oidc" label="OIDC provider">
+Users signed in using OIDC are created in Homarr.

-    This provider authenticates using OIDC protocol.
+When signing out, Homarr completes the redirect to the configured logout URL after clearing its local session.

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

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

-    If you'd rather manage group memberships for OIDC users locally (instead of via the IdP), set `AUTH_OIDC_GROUPS_LOCAL_MANAGEMENT=true`. While enabled, Homarr stops syncing OIDC users' group memberships from the groups claim, and admins can add/remove OIDC users on a group's members page. If you turn this back to `false`, the next login of each user resumes the regular sync and reconciles their groups with the IdP's claim again, which may remove memberships that were added manually while local management was enabled.
+To let an existing credentials user also sign in with OIDC, set `AUTH_OIDC_ENABLE_DANGEROUS_CREDENTIALS_LINKING=true`. On the first OIDC sign-in, Homarr links a credentials user with the same email address instead of creating a second user. The user keeps their password login, local username and profile, groups, permissions, boards, settings, and API keys. OIDC profile and group claims do not overwrite the credentials-owned data. Homarr requires the OIDC profile to contain `email_verified: true` while this option is enabled. Only enable this when your OIDC provider verifies email addresses, because a matching email could otherwise be used to take over an existing account.

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

-    <details>
-      <summary>
-        Example Setup
-      </summary>
-      <div>
+    In this example we will be using [Authelia](https://github.com/authelia/authelia).

-        In this example we will be using [Authelia](https://github.com/authelia/authelia).
+    You can use any setup, but the simplest is [local](https://github.com/authelia/authelia/blob/master/examples/compose/local/authelia/configuration.yml).

-        You can use any setup, but the simplest is [local](https://github.com/authelia/authelia/blob/master/examples/compose/local/authelia/configuration.yml).
+    You also have to [enable OIDC in Authelia](https://www.authelia.com/configuration/identity-providers/open-id-connect/).

-        You also have to [enable OIDC in Authelia](https://www.authelia.com/configuration/identity-providers/open-id-connect/).
+    Create a client for homarr. To generate client secret you can [use authelia](https://www.authelia.com/integration/openid-connect/frequently-asked-questions/#how-do-i-generate-client-secrets). This is an example config:

-        Create a client for homarr. To generate client secret you can [use authelia](https://www.authelia.com/integration/openid-connect/frequently-asked-questions/#how-do-i-generate-client-secrets). This is an example config:
+    ```yaml
+    identity_providers:
+    oidc:
+    ...
+    clients:
+    - id: homarr
+    secret: <secret_hash>
+    public: false
+    authorization_policy: one_factor
+    redirect_uris:
+    - https://example.com/api/auth/callback/oidc
+    - http://localhost:3000/api/auth/callback/oidc
+    scopes:
+    - openid
+    - groups
+    - profile
+    - email
+    userinfo_signing_algorithm: none
+    consent_mode: implicit # self hosted
+    ```

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

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

-        ```
-        AUTH_PROVIDERS="oidc"
-        AUTH_OIDC_ISSUER="https://auth.example.com"
-        AUTH_OIDC_CLIENT_SECRET="client_secret"
-        AUTH_OIDC_CLIENT_ID="homarr"
-        AUTH_OIDC_CLIENT_NAME="Authelia"
-        AUTH_OIDC_FORCE_USERINFO="true" --> from v4.39 of authelia and above this is required
-        ```
+    For an azure app registration the setup could look like this:

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

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

-      </div>
-    </details>
+### OIDC configuration

+| Environment Variable                             | Description                                                                                                                                                                                         | Default value               |
+| ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- |
+| `AUTH_OIDC_ISSUER`                               | Issuer URI of OIDC provider. This has generally to be **without trailing slash** except for **Authentik**                                                                                           | ---                         |
+| `AUTH_OIDC_CLIENT_ID`                            | ID of OIDC client (application)                                                                                                                                                                     | ---                         |
+| `AUTH_OIDC_CLIENT_SECRET`                        | Secret of OIDC client (application)                                                                                                                                                                 | ---                         |
+| `AUTH_OIDC_CLIENT_NAME`                          | Display name of provider (in login screen)                                                                                                                                                          | OIDC                        |
+| `AUTH_OIDC_AUTO_LOGIN`                           | Automatically redirect to OIDC login                                                                                                                                                                | false                       |
+| `AUTH_OIDC_SCOPE_OVERWRITE`                      | Overwrite default scopes (openid, profile, email)                                                                                                                                                   | openid email profile groups |
+| `AUTH_OIDC_GROUPS_ATTRIBUTE`                     | Attribute used for groups (roles) claim. Dot-separated paths such as `resource_access.homarr.roles` are supported.                                                                                  | groups                      |
+| `AUTH_OIDC_GROUPS_LOCAL_MANAGEMENT`              | Stop syncing group memberships of OIDC users from the groups claim and manage them locally via the group members page instead                                                                       | false                       |
+| `AUTH_OIDC_NAME_ATTRIBUTE_OVERWRITE`             | Overwrite name attribute. Dot-separated paths are supported. By default it will use preferred_username if it does not contain a `@` and otherwise name.                                             | ---                         |
+| `AUTH_OIDC_FORCE_USERINFO`                       | Force userinfo endpoint to be used for user information.                                                                                                                                            | false                       |
+| `AUTH_OIDC_ENABLE_DANGEROUS_ACCOUNT_LINKING`     | Enable account linking for OIDC provider. This will link the OIDC accounts by email. Be sure that you have verified emails to prevent stealing accounts.                                            | false                       |
+| `AUTH_OIDC_ENABLE_DANGEROUS_CREDENTIALS_LINKING` | Link an OIDC identity to an existing credentials user with the same email. The credentials login and existing user data are preserved. Requires the OIDC profile to contain `email_verified: true`. | false                       |
+| `AUTH_OIDC_TOKEN_ENDPOINT_AUTH_METHOD`           | Override method for the token endpoint authentication. Supported values are `client_secret_basic`, `client_secret_post`, `client_secret_jwt` and `none`.                                            | client_secret_basic         |

-    ### Configuration
+### OIDC permissions

-    | Environment Variable        | Description                                                | Default value |
-    |-----------------------------|------------------------------------------------------------|---------------|
-    | ``AUTH_OIDC_ISSUER``        | Issuer URI of OIDC provider. This has generally to be **without trailing slash** except for **Authentik** | ---           |
-    | ``AUTH_OIDC_CLIENT_ID``     | ID of OIDC client (application)                            | ---           |
-    | ``AUTH_OIDC_CLIENT_SECRET`` | Secret of OIDC client (application)                        | ---           |
-    | ``AUTH_OIDC_CLIENT_NAME``   | Display name of provider (in login screen)                 | OIDC          |
-    | ``AUTH_OIDC_AUTO_LOGIN``    | Automatically redirect to OIDC login                       | false         |
-    | ``AUTH_OIDC_SCOPE_OVERWRITE`` | Overwrite default scopes (openid, profile, email)        | openid email profile groups           |
-    | ``AUTH_OIDC_GROUPS_ATTRIBUTE`` | Attribute used for groups (roles) claim                  | groups        |
-    | ``AUTH_OIDC_GROUPS_LOCAL_MANAGEMENT`` | Stop syncing group memberships of OIDC users from the groups claim and manage them locally via the group members page instead | false |
-    | ``AUTH_OIDC_NAME_ATTRIBUTE_OVERWRITE`` | Overwrite name attribute. By default it will use preferred_username if it does not contain a `@` and otherwise name. | ---          |
-    | ``AUTH_OIDC_FORCE_USERINFO`` | Force userinfo endpoint to be used for user information.    | false         |
-    | ``AUTH_OIDC_ENABLE_DANGEROUS_ACCOUNT_LINKING`` | Enable account linking for OIDC provider. This will link the OIDC accounts by email. Be sure that you have verified emails to prevent stealing accounts. | false |
-    | ``AUTH_OIDC_ENABLE_DANGEROUS_CREDENTIALS_LINKING`` | Link an OIDC identity to an existing credentials user with the same email. The credentials login and existing user data are preserved. Requires the OIDC profile to contain `email_verified: true`. | false |
-    | ``AUTH_OIDC_TOKEN_ENDPOINT_AUTH_METHOD`` | Override method for the token endpoint authentication. Supported values are `client_secret_basic`, `client_secret_post`, `client_secret_jwt` and `none`. | client_secret_basic |
-
-    ### Permission System
-
-    To give a user special permissions, first create a new group in homarr and assign the permission desired.
-    For example if the group on homarr is called `homarr-admins` a new group on the oidc provider, for example authentik needs to be created with the same name, that would be `homarr-admins`.
-    After assigning the group on the oidc provider to the user, and logging again into homarr, the user should automatically get placed in that group and inherit the permissions defined.
-
-  </TabItem>
-</Tabs>
+To give a user special permissions, first create a new group in homarr and assign the permission desired.
+For example if the group on homarr is called `homarr-admins` a new group on the oidc provider, for example authentik needs to be created with the same name, that would be `homarr-admins`.
+After assigning the group on the oidc provider to the user, and logging again into homarr, the user should automatically get placed in that group and inherit the permissions defined.

 ## Example setups

@@ -243,18 +234,21 @@ Homarr supports multiple authentication options, from internal userbase (credent
        - Create a group (e.g., `homarr-admins`) and assign users who require admin access.

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

        **3. Example Docker Compose configuration:**
-        ```yaml {14-26}
+        ```yaml {14-24}
        services:
          homarr:
            image: ghcr.io/homarr-labs/homarr:latest
@@ -268,8 +262,6 @@ Homarr supports multiple authentication options, from internal userbase (credent
            environment:
              - TZ=America/Los_Angeles
              - SECRET_ENCRYPTION_KEY=${SECRET_ENCRYPTION_KEY}
-              - BASE_URL=https://${HOMARR_FQDN}
-              - NEXTAUTH_URL=https://${HOMARR_FQDN}
              - AUTH_PROVIDERS=oidc #(optional: include ',credentials' to keep local accounts as fallback)
              - AUTH_OIDC_CLIENT_ID=${OIDC_CLIENT_ID}
              - AUTH_OIDC_CLIENT_SECRET=${OIDC_CLIENT_SECRET}
@@ -296,7 +288,7 @@ Homarr supports multiple authentication options, from internal userbase (credent
      </div>
    </details>

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

  </TabItem>
  <TabItem value="google" label="Google (OIDC) Example" default>
@@ -321,15 +313,18 @@ Homarr supports multiple authentication options, from internal userbase (credent
        - Record the `Client-ID` and `Client Key` (secret).

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

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

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

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

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

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

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

-:::warning
+<Alert type="warning">

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

-:::
+</Alert>

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

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

-## Limitations and dangers
-When using custom CSS, you can break the page or certain functionalities.
-Although CSS can improve the design & feel of the page, it **<ins>cannot do any of the following</ins>**:
+To target one widget, add a custom class under **Edit item → Advanced options** and use that class in the board CSS.

- Implement new features, widgets or integrations
- Securely hide elements you don't want users to interact / have permission to
- Completely revamp the design of the page, only smaller changes are possible
+Use `!important` only when the existing cascade requires it.

-Here are some dangers of using custom CSS:
- Updates may contain breaking changes in the structure, built-in styling or how styling is processed. Therefore,
-custom CSS may break unexpectedly without any warning
- Custom CSS may make certain elements invisible or not possible to click / interact with
- Custom CSS could make readability and accessibility worse for impaired people
+## Theme variables

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

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

-Using a donation, you help us to cover these expenses and enable the development of Homarr.
-Homarr is completely free to use. We'd highly appreciate if you consider donating, especially if you use Homarr in a commercial environment.
+Donations fund Homarr's development infrastructure and community services.

-## Where to donate
-We accept donations on our official [OpenCollective](https://opencollective.com/homarr).
-You may also sponsor us directly by providing a useful service / product to us other means.
-You can get into contact with us [here](/docs/community/get-in-touch).
+Support the project through [OpenCollective](https://opencollective.com/homarr). For sponsorships or donated services,
+use the private contact listed on [Get in touch](/docs/community/get-in-touch).
@@ -1,90 +1,51 @@
 ---
 title: Frequently Asked Questions
+description: Answers to common Homarr questions about installation, customization, connectivity, support, and commercial use.
 tags:
  - Community
  - Help
 ---

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

-### Can I install Homarr on a Raspberry Pi?
-Yes, Homarr is compatible with the architecture of the Raspberry Pi. Have a look in our <a href="/docs/category/installation-1">installation guide</a> on how to do so.
+Yes, when the device uses a supported `linux/arm64` operating system. `linux/arm/v7` is not supported. See
+[Prerequisites](/docs/getting-started).

-### I have a suggestion / idea for improvement or want to report a bug
-You can report issues, suggestions, or ideas for improvements <a href="https://github.com/homarr-labs/homarr/issues/new/choose">here</a>.
+## Can I use custom app icons?

-### Can I use my own custom icons for apps?
-Yes, check out our guide on <a href="/docs/advanced/customizations/icons">how to add your custom icons</a>.
+Yes. Use a direct image URL, one of Homarr's icon sources, or upload an image. See [Icons](/docs/advanced/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...). <br />
-So make sure to manually whitelist this address.
+## Can I create widgets?

-### 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:
+Yes. [Custom Widgets](/docs/management/custom-widgets) use server-side API requests and safe JSX. They can be written in
+the workbench or created with an MCP-connected agent.

- 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.
+## Can Homarr be exposed to the internet?

-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.
+Homarr supports authenticated and public deployments. Terminate HTTPS at a reverse proxy, keep Homarr updated, and grant
+public board access only when anonymous viewing is intended. See [Board access control](/docs/management/boards#access-control)
+and [Single sign-on](/docs/advanced/single-sign-on).

-### Is it secure to expose Homarr to the web?
+## Where are the logs?

-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)
+Use **Management → Tools → Logs** for retained and live application logs. Container startup failures and older events are
+available through the deployment platform, for example `docker container logs homarr`.

-### 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.
+Use the browser developer console only for client-side failures. Review logs before sharing them because URLs and other
+deployment details may be present.

-Both variants *can* contain personal data. It's recommended, that you don't post them publicly or remove personal data from it.
+## Why can Homarr not reach a service behind Gluetun?

-<Tabs>
-  <TabItem value="apple" label="Read console" default>
+Gluetun's firewall blocks traffic that is not explicitly allowed. Configure its
+[`FIREWALL_OUTBOUND_SUBNETS`](https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/firewall.md) for the relevant
+LAN or Docker subnet, and use an address reachable from the Homarr container.

-> Note: This will not work on most mobile browsers.
+## Where do I report a bug or request a feature?

-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.
+Use the [GitHub issue templates](https://github.com/homarr-labs/homarr/issues/new/choose). For community support, see
+[Get in touch](/docs/community/get-in-touch).

-> 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**
+## Can Homarr be used commercially?

-  </TabItem>
-  <TabItem value="orange" label="Read log">
-
-This depends on your installation method. If you use Unraid, you can simply click on the App and on ``Log``. If you have a bare Docker install, use ``docker container logs homarr``. If you used a different name than ``homarr`` for your container, you need to replace said argument. Here is some additional information about the command: https://geekflare.com/check-docker-logs/.
-
-  </TabItem>
-</Tabs>
-
-### How do I post logs?
-Please check [the section above](#how-do-i-open-the-console--log), on how to obtain logs. Logs should always be posted to https://pastebin.com/ or https://rentry.co/.
-
-### Can I use Homarr at my company?
-Yes, you can! But please consider a donation, if our work has been useful to you.
-
-### I think I found a bug. What can I do?
-If you think, that you found a bug, please create an issue <a href="https://github.com/homarr-labs/homarr/issues/new/choose">here</a>.
-
-### Why can't I use my custom icons?
-You need to restart the Homarr Docker container after adding icons.
-
-### Why can't homarr see/ping containers running locally behind GluetunVPN?
-This is because GluetunVPN, and many other docker VPN services, secure their VPN connections with strict firewalls. These firewalls often block access to local containers, even on the same docker network. The workaround for <a href="https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/firewall.md">GluetunVPN</a> is to add "- FIREWALL_OUTBOUND_SUBNETS=192.168.1.0/24" into the environmental variables of the docker compose file. If you are using a firewall on your system, you will need to add a rule that allows requests from ip's in the range of 192.168.xxx.xxx . If you are using UFW the command would be "sudo ufw allow from 192.168.0.0/16".
-Tip: If you are running your torrent client behind a VPN, and running Sonarr (or something similar) normally, make sure to open your torrent client's port in your firewall. If you don't, Sonarr will not be able to see it. Furthermore, use your machines IP (192.168.x.x) rather then 127.0.0.1 or localhost.
-
-### Can I get in touch with you?
-Yes, go <a href="/docs/community/get-in-touch">here</a> to get with us in touch.
-
-<hr/>
-
-:::tip
-
-Haven't found the solution to your problem / question? We are eager to help you on [our Discord](/docs/community/get-in-touch#discord) or in a [GitHub Issue](https://github.com/homarr-labs/homarr/issues/new/choose).
-
-:::
+Yes. Homarr is licensed under the [Apache License 2.0](/docs/community/license). Commercial users can support development
+through [OpenCollective](/docs/community/donate).
@@ -1,24 +1,23 @@
 ---
-title: Get In Touch
-description: Still have a question? Click here!
+title: Get in touch
+description: Community, support, and private contact channels.
 tags:
  - Help
  - Community
 ---

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

-## E-Mail
-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.
+## GitHub

-[homarr-labs@proton.me](mailto:homarr-labs@proton.me)
+Use the [issue templates](https://github.com/homarr-labs/homarr/issues/new/choose) for bugs and feature requests.

 ## Discord
-We have a Discord Server, where we announce new releases, discuss features and bugs and show off our dashboards.
-There are over 4'000 members and we're happy to answer your questions or concerns.
-You're also open to discuss new / upcoming features and any offtopic selfhosting content.

-[_![](https://discordapp.com/api/guilds/972958686051962910/widget.png?style=banner2)_](https://discord.gg/aCsmEV5RgA)
+Use the [Homarr Discord server](https://discord.gg/aCsmEV5RgA) for community support, release discussion, and dashboard
+showcases.

+## Email

+Use [homarr-labs@proton.me](mailto:homarr-labs@proton.me) for security reports, sponsorships, and other private matters.
+Bug reports and feature requests belong on GitHub.
@@ -0,0 +1,10 @@
+---
+title: Community
+description: Get help, contribute to Homarr, and support the project.
+---
+
+- [Frequently asked questions](/docs/community/faq): resolve common setup and operation issues.
+- [Get in touch](/docs/community/get-in-touch): choose the right support or discussion channel.
+- [Translations](/docs/community/translations): improve Homarr in your language.
+- [Donate](/docs/community/donate): support ongoing development.
+- [License](/docs/community/license): understand how Homarr is licensed.
@@ -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           | ✅      |
@@ -18,13 +19,11 @@ Homarr is licensed under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.
 | Liability      | ❌      |
 | Warranty       | ❌      |

-:::note
+<Alert type="note">

 Please consider [making a donation](/docs/community/donate) to Homarr, if this project has been useful for your needs. Donations help us to keep Homarr up to date, implement new features and help our users with problems and questions.

-:::
-
-
+</Alert>

 ## Full License

@@ -0,0 +1,5 @@
+{
+  "title": "Community",
+  "defaultOpen": false,
+  "pages": ["index", "faq", "get-in-touch", "translations", "donate", "license"]
+}
@@ -5,49 +5,24 @@ tags:
  - Translations
 ---

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

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

+## Translate from Homarr

-### 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. 
-After the next update of Homarr, all changes from the development branch will be merged, including the changes in the translations.
+Select **Crowdin (live translations)** as the application language, connect a Crowdin account, and choose the target
+language. Select text in Homarr or use Crowdin's in-context panel to edit a string.

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

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

-import imageStartFromScratchStepServerSettings from "./img/onboarding-from-scratch-step-server-settings.png";
-import imageStartFromScratchStepAdminUser from "./img/onboarding-from-scratch-step-admin-user.png";
-import imageStartFromScratchStepExternalAdminGroup from "./img/onboarding-from-scratch-step-external-admin-group.png";
-import imageStartFromScratchStepFinish from "./img/onboarding-from-scratch-step-finish.png";
-import manageBoardHeaderEditMode from "./img/manage-board-header-edit-mode.png";
-import manageBoardHeaderAddItem from "./img/manage-board-header-add-item-menu.png";
-import manageBoardHeaderChooseItem from "./img/manage-board-header-choose-item.png";
-import manageBoardNoApp from "./img/manage-board-no-app.png";
-import manageExportOldHomarr from "./img/old-homarr-export-data.png";
-import manageImportOldHomarrDropzone from "./img/old-homarr-import-dropzone.png";
-import manageImportOldHomarrChooseData from "./img/old-homarr-import-choose-imported-data.png";
-import manageImportDecryptionToken from "./img/old-homarr-import-decryption-token.png";
+import {
+  IconAdjustments,
+  IconChecklist,
+  IconLayoutDashboard,
+  IconPlugConnected,
+  IconSearch,
+  IconSparkles,
+} from "@tabler/icons-react";

-:::tip
+After Homarr starts, open its URL. An unfinished installation redirects to the onboarding screen at `/init`. Choose
+**Get started** for a new installation or **Restore backup** to import a compatible SQLite backup.

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

-:::
+## Complete onboarding

-Congratulations on installing Homarr. Now it's time to get yourself familiar with the concepts of Homarr and how to use it.
+Onboarding is split into six short sections. Integrations, Workshop, Assistant, and MCP are optional; skip them when you
+only need a working board.

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

-The onboard will show the first time you start Homarr.
-This process will help you with your first steps and adding some initial data, such as the administrator account.
+The final screen links directly to the new board and the management area. Board layout, integrations, apps, and
+appearance can all be changed later.

-:::note
+<Cards>
+  <Card title="Start or restore">
+    ![Homarr onboarding welcome screen with Get started and Restore backup actions](./img/onboarding-v2-welcome.png)
+  </Card>
+  <Card title="Configure the board">
+    ![Board onboarding section for colors, columns, corner radius, and sidebars](./img/onboarding-v2-board.png)
+  </Card>
+  <Card title="Review before building">
+    ![Onboarding review showing the board settings Homarr will create](./img/onboarding-v2-review.png)
+  </Card>
+</Cards>

-If you see this screen repeatitly after you restarted the Homarr container, your Docker mounting paths may be missing,
-incorrect or read-only. Read [our installation instructions](/docs/getting-started/installation/docker) again to fix this issue.
+## Core concepts

-:::
+### Boards

-You can either import a previous dashboard using the ZIP archive or start from scratch:
+A **board** is a dashboard page containing apps, widgets, and Containers. Boards can be public or restricted to users
+and groups. Each user can choose a home board.

-![Screenshot of Step 1 onboarding](./img/onboarding-step-1.png)
+![Board management with board previews](./img/after-installation-boards.webp)

-You may refresh anytime and continue from a different device - the onboarding is saved immediately on the server for your convenience.
+See [Boards](/docs/management/boards) for responsive layouts, access control, appearance, and home-board settings.

-### Starting from scratch
+### Apps

-Depending on your auth provider configuration you will either first see the admin user creation form or the external group creation form.
-If the credentials provider was selected, you'll be prompted to create an admin user for Homarr.
-This user cannot be deleted and has full control over Homarr and all of its boards.
-You must choose a username and password (both can later be changed).
-We enforce strict password requirements when you enter your password to protect your instance if you accidentally
-expose it to the internet.
+An **app** is a saved shortcut: a name, URL, icon, and optional status check. Add an App tile or a Bookmarks widget to
+show apps on a board.

-<img
-  src={imageStartFromScratchStepAdminUser}
-  alt={"Screenshot form to create admin user"}
-  width={300}
-/>
+![App management with saved shortcuts](./img/after-installation-apps.webp)

-If you selected external providers (such as LDAP or OIDC), you'll be prompted to create an admin group.
-This group will be used to synchronize users from your provider to Homarr.
-When a user logs in through the provider, any of their groups that match groups in Homarr will be assigned to the user.
-The name of the group must match exactly the name of the group in the provider.
+See [Apps](/docs/management/apps) or [Icons](/docs/advanced/icons).

-<img
-  src={imageStartFromScratchStepExternalAdminGroup}
-  alt={"Screenshot form to create external admin group"}
-  width={300}
-/>
+### Integrations

-Next, you can configure some basic settings for Homarr. We recommend to leave all settings at default for most users.
-Here you can also disable analytics. Please note that our analytics are completly anonymous and is fully compliant with GDPR and PECR.
+An **integration** is a server-side connection from Homarr to a supported service such as Sonarr, Home Assistant, or
+Docker. Integrations provide data and actions to widgets. They can also be linked to apps.

-<img
-  src={imageStartFromScratchStepServerSettings}
-  alt={"Screenshot of analytics and indexing settings in the onboarding"}
-  width={300}
-/>
+![Integration catalog with compatible widgets](./img/after-installation-integrations.webp)

-### Setting up integrations
+See [Managing integrations](/docs/management/integrations) and the
+[integration catalog](/docs/integrations).

-After configuring server settings, the onboarding guides you through setting up your integrations.
+### Widgets

-#### Docker service discovery
+A **widget** is a board tile. Some widgets work on their own; others require one or more integrations. Configuration,
+supported integrations, and non-obvious limitations are documented on each widget page.

-If Docker is available (socket mounted), Homarr automatically detects running containers and matches them to known integration types.
-Matching integrations are pre-selected in the integration list, saving you from manually picking each one.
+![Board in edit mode with the add-content menu](./img/after-installation-widgets.webp)

-#### URL templating
+See the [widget catalog](/docs/widgets).

-You can define a base URL template to auto-fill integration URLs in bulk.
-Two modes are supported:
+### Containers and rails

- **Subdomain mode** - e.g. `{app}.example.com` where `{app}` is replaced with the integration name
- **Port mode** - e.g. `192.168.1.1:{port}` where `{port}` is replaced with the integration's default port
+A **Container** groups board items and can be nested. A **rail** reserves a fixed area at the left or right of a
+responsive layout. Both are configured in board edit mode.

-#### API key helper links
+![Board layout settings with fixed sidebars](./img/after-installation-containers-rails.webp)

-For integrations that require API keys (such as Sonarr, Radarr, SABnzbd, or Seerr), a helper link opens the relevant settings page in the target application so you can quickly copy your key.
+See [Boards](/docs/management/boards#containers-and-rails).

-#### Creating apps from Docker containers
+### Users, groups, and permissions

-You can optionally auto-create bookmark apps for all discovered Docker containers, making them immediately available on your board.
+Users inherit permissions and default boards from their groups. Resource-specific access can further restrict boards
+and integrations.

-:::note
+![Group permission settings](./img/after-installation-users-permissions.webp)

-Release providers and Search.ch are configured directly in their widgets instead of the integrations page.
+See [Users and groups](/docs/management/users) and [single sign-on](/docs/advanced/single-sign-on).

-:::
+## Explore further

-After this step, you finished the onboarding.
-The onboarding can no longer be started again.
-From here you can click on one of the provided links to continue your journey.
-We recommend you to continue with the section [creating your first board on this page](#creating-your-first-board).
+- [Server settings](/docs/management/settings)
+- [Assistant](/docs/management/assistant)
+- [Custom Widgets](/docs/management/custom-widgets)
+- [Community Workshop](/docs/workshop)
+- [API](/docs/management/api) and [MCP](/docs/management/mcp)
+- [Keyboard shortcuts](/docs/advanced/keyboard-shortcuts)

-<img
-  src={imageStartFromScratchStepFinish}
-  alt={"Screenshot of the finish onboarding process with links"}
-  width={300}
-/>
-
-### Importing a ZIP from version before 1.0.0
-
-This is recommended when you used Homarr before and want to re-import your data.
-It is important that you first migrate correctly using [the list of breaking changes for 1.0](/blog/2024/09/23/version-1.0).
-
-<img
-  src={manageExportOldHomarr}
-  alt="Export from old Homarr"
-  style={{ maxWidth: 500 }}
-/>
-
-**How to export and import data**
-
-1. Navigate to your old Homarr, open your management pages, open the tools submenu and open `Migrate to 1.0`.
-2. Check the contents that you want to export. We recommend you to export all data.
-3. Click on the export data button
-4. Save the ZIP file, that is being downloaded, on your device. If you selected "integrations" or "users", you also get an encryption / decryption key.
-   Copy it and do not loose it!
-5. Go to your new >1.0.0 Homarr instance and start the onboarding. Choose `Import from Homarr before 1.0`
-6. Drag and drop your previously downloaded ZIP archive into the file upload: <br/><img src={manageImportOldHomarrDropzone} style={{ maxWidth: 500 }} />
-7. Next, choose the data that you want to import and how to import it. Since screen sizes were removed in 1.0, we create a new board for every screen size by default. We recommend you to only keep the best layout and adjust it later in 1.0.0 - but you can also import all of them and pick later.<br/><img src={manageImportOldHomarrChooseData} style={{ maxWidth: 500 }} />
-8. If you previously exported integrations or users, you will be asked to decrypt the data safely using your obtained encryption token. Paste into the modal and confirm your action.<br/><img src={manageImportDecryptionToken} style={{ maxWidth: 500 }} />
-9. Next, you can [follow the same setup as when starting from scratch](#starting-from-scratch). After you completed the onboarding, all of your data will be migrated and available.
-
-## Creating your first board
-
-In Homarr, you organize your apps and widgets on boards.
-Boards can be organized using the interactive drag and drop.
-Let's create your first board by navigating here: `Manage` > `Boards` > `New board`:
-![](./img/manage-create-board-button.png)
-
-A board must always have a name and can either be public or private.
-Public boards are also accessible for users, that are not logged in ([see access control for boards](/docs/management/boards/#access-control)).
-
-![](./img/manage-create-board-modal.png)
-
-Congratulations - you've just created your first board. You can see boards, that you have access to, on this page:
-
-![](./img/manage-view-board.png)
-
-## Add your first app to Homarr
-
-To add links to your dashboard, you must first add them as an "app".
-Navigate to this page to add an app:
-
-![](./img/manage-navigate-apps.png)
-
-Next, click on the `New app` button. You'll need to provide a name and an icon to create an app.
-The name must be at least one character long but you can provide any image URL for the icon.
-Homarr ships with over 11K icons - so you can just search by entering a search text instead.
-
-![](./img/manage-add-app-form.png)
-
-After you created the app, you'll see in on the apps page:
-
-![](./img/manage-created-app.png)
-
-## Arrange and organize your board
-
-Let's add your freshly created app, from the previous step, to the board.
-To do this, edit your previously created board by clicking on the big `Open board` button:
-
-![](./img/manage-view-board.png)
-
-Here you have the following options in the header:
-
-![](./img/manage-board-header.png)
-
- **Search**: Here you can search for data. You can search for integrations, boards, actions, sites and much more. Some actions may be context dependent (eg. will only show when certain widgets are on your page)
- **Edit mode**: Clicking this button will toggle the edit mode. In this mode you can edit the contents of your board.
- **Settings**: Clicking this button will redirect you to a settings page where you can adjust the board settings (page title, colors, ...).
- **Profile**: This avatar will be visible on every page. Clicking it will show a menu with actions.
-
-When entering the edit mode, you'll get some additional buttons to work with:
-
-<img
-  src={manageBoardHeaderEditMode}
-  alt={"Screenshot of buttons in the edit mode"}
-  width={200}
-/>
-
- **Add item**: Click this button to add new elements to your page.
- **Exit edit mode**: Click this btuton to save your changes and exit edit mode.
-
-To continue, click the option "New Item":
-
-<img
-  src={manageBoardHeaderAddItem}
-  alt={"Screenshot of the add item menu"}
-  width={200}
-/>
-
-Next, you can choose what item you'd like to add.
-We will discuss the other options in the following sections - for now choose "App" to continue.
-
-<img
-  src={manageBoardHeaderChooseItem}
-  alt={"Screenshot of choosing the app item in the modal"}
-  width={300}
-/>
-
-As soon as you chose the app, the modal will close and you'll get the following item on your board:
-
-<img
-  src={manageBoardNoApp}
-  alt="Screenshot of the No app element on the board"
-/>
-
-This is expected, because you haven't told Homarr what app it should show in this item.
-To configure this, click on the small 3 dots at the top of the item in the edit mode and choose "Edit item" in the menu.
-
-![](./img/manage-board-edit-app.gif)
-
-In the modal you can edit the app that you want to display:
-
-![](./img/manage-board-choose-app.png)
-
-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.
-
-![](./img/resize-item.gif)
-
-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.
-
-![](./img/move-item.gif)
-
-:::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.
-
-:::
-
-:::tip
-
-We recommend you to experiment for a few minutes, before you start building your actual dashboard.
-This helps you to explore the capabilities of Homarr before you build your board in a suboptimal way.
-
-:::
-
-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:
-
-![](./img/manage-board-move-resize-item-menu.png)
-
-Be sure to save your changes by exiting edit mode!
-
-![](./img/exit-edit-mode.png)
-
-## Adding your first integration
-
-Now it's time to integrate some basic data into your board.
-To do this, we first need to create an integration.
-An integration is a connection between Homarr and a third party application - usually something that you run and deploy yourself.
-
-Navigate to `Manage` > `Integrations` (for example via your user menu).
-As an example, we are going to use the public demo instance of **Dash.** - a popular application to monitor CPU / hardware usage.
-Choose the **Dash.** integration from the list of available integrations:
-
-![](./img/choose-integration.gif)
-
-Next, choose a name (or leave it at default), enter `https://dash.mauz.dev/` as the URL in the form and click on `Test connection and create`.
-Pressing the save button will perform a test request to the integration, to confirm that the networking setup is working as expected.
-Sometimes invalid configurations, firewalls and other mistakes can lead to connectivity problems - [follow this guide here](/docs/management/integrations/#troubleshooting-connection) if you experience issues.
-
-If connection was successful, you will be redirect back to the list of integrations.
-Now let's embed it to your board (see next section).
-
-:::note
-
-Some integrations may require additional configuration, such as a username, password or API tokens.
-Depending on your networking setup and applications, the connection from Homarr might also get blocked by firewalls,
-the target application or your router.
-
-:::
-
-## Embed integration data using widgets
-
-Let's add your integration, that you have configured in the section above, as a widget to your board.
-First, navigate back to your board that you want to add it to.
-Next, enter edit mode again and add another item to your board:
-
-![](./img/manage-board-header-add-item-menu.png)
-
-Instead of choosing an app, let's choose `System Health Monitoring` this time.
-Click on "Add to board":
-
-![](./img/manage-board-header-choose-system-health.png)
-
-Resize the item slightly and then edit it using the three dots menu at the top:
-
-![](./img/edit-system-health-widget.gif)
-
-Next, choose your newly created Dash. integration in the integrations dropdown:
-
-![](./img/manage-board-edit-system-health.png)
-
-:::note
-
-Some widgets may support multiple integrations at the same time.
-If they do not support multiple integrations, you will be unable to select more than one.
-
-:::
-
-Confirm your changes by pressing save.
-Editing a widget will trigger a data update and data will soon appear:
-
-![](./img/widget-system-health.png)
-
-As with every change, don't forget to save your changes using the exit edit mode button:
-
-![](./img/exit-edit-mode.png)
-
-## Grouping your items
-
-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.
-
-### Using dynamic sections
-
-Dynamic sections are a simple, resizable visual group to group items.
-
-![](./img/create-dynamic-section.png)
-
-After adding a dynamic section, you can simply drag and drop items into the section:
-
-![](./img/dynamic-section.gif)
-
-### Using categories
-
-Categories are more advanced and complicated than dynamic sections.
-To create a category, open the add item modal and choose "new category":
-
-![](./img/add-category.png)
-
-Every category must have a name. After you click "Add category", you will get a new item on your board:
-
-![](./img/category.gif)
-
-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.
-
-:::
-
-## Guided tours
-
-After completing the onboarding, Homarr provides interactive guided tours to help you discover key features.
-
-### Management tour
-
-When you first visit the management area (`/manage`), Homarr walks you through the main pages: boards, apps, integrations, and users (admin only).
-Each page highlights the list view and the create action so you know where to find and add things.
-
-### Board tour
-
-When you first open a board, a tour highlights the board header elements: search, edit mode, settings, board switcher, and user menu.
-
-### Tour controls
-
- Press **Enter** (or click **Next**) to advance through tour steps
- Tours auto-start on first visit and do not repeat once completed
- Tours are skipped on mobile screens (below `sm` breakpoint)
- You can **reset tours** from the user settings page under **Manage > Users > [Your user] > General**
-
-## Next steps
-
-You're done with the basic setup 🔥. Now it's time to organize and customize even more.
-We highly recommend you to experiment with different options, styles and configurations.
-See these curated pages for your next steps:
-
- Create new apps using the [apps management](/docs/management/apps/)
- Customize your board or add more boards using the [boards management](/docs/management/boards/)
- Integrate software that you use using the [integrations management](/docs/management/integrations/)
- Choose from our beautiful and interactive [widgets](/docs/category/widgets)
- See [all supported integrations](/docs/category/integrations)
- Integrate with Homarr with your own application using [the API](/docs/management/api/)
-
-:::danger
-
-The Homarr Team will never ask for your credentials. Do not send people your credentials, as they manage the access to your applications and can cause harm to your device if they are abused.
-
-:::
+See the [glossary](/docs/getting-started/glossary) for a compact list of Homarr terms.
@@ -1,12 +1,20 @@
 # 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                                                                       |
+| --------------------------------------------------------- | -------------------------------------------------------------------------------- |
+| [App](/docs/management/apps)                              | A saved shortcut with a name, destination, icon, and optional status check       |
+| [Assistant](/docs/management/assistant)                   | A conversation interface that can use model responses and Homarr tools           |
+| [Board](/docs/management/boards)                          | A dashboard page where apps, widgets, and Containers are arranged                |
+| [Container](/docs/management/boards#containers-and-rails) | A resizable board area containing apps, widgets, or nested Containers            |
+| [Custom Widget](/docs/management/custom-widgets)          | A validated definition for an API-backed board tile                              |
+| [Edit mode](/docs/management/boards#edit-a-board)         | The board state used to add, move, resize, configure, or remove content          |
+| [Homarr provider](/docs/workshop/homarr-provider)         | An Assistant provider routed through Workshop with a per-user allowance          |
+| [Integration](/docs/management/integrations)              | A server-side connection from Homarr to a supported service                      |
+| [Layout](/docs/management/boards#responsive-layouts)      | An arrangement of board items selected for a viewport width                      |
+| [Provider](/docs/management/assistant#configuration)      | The model API selected for Assistant                                             |
+| [Rail](/docs/management/boards#containers-and-rails)      | A fixed area at the left or right of a non-Mobile board layout                   |
+| [Task](/docs/management/tasks)                            | A background workload that runs without an active browser session                |
+| [Widget](/docs/widgets)                                   | A board tile that displays information or provides actions                       |
+| [Workshop](/docs/workshop)                                | A separate community service for sharing Custom Widget definitions and board CSS |