Compare commits
19
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ae2a1df453 | ||
|
|
ca7e50fb96 | ||
|
|
db6aa0b26e | ||
|
|
d096aecd59 | ||
|
|
49a41431b9 | ||
|
|
df587ec76a | ||
|
|
3b450eb04a | ||
|
|
406fb4c0b6 | ||
|
|
f23c35645c | ||
|
|
667bf62396 | ||
|
|
c5a056b8e5 | ||
|
|
934b6e69f4 | ||
|
|
c8c5dbc506 | ||
|
|
b1e79e4641 | ||
|
|
5b04ed1ab5 | ||
|
|
b733ed6a79 | ||
|
|
ae3e9f7793 | ||
|
|
c8485ed7fc | ||
|
|
e97eb7fc58 |
No files matched your search
@@ -1,44 +0,0 @@
|
|||||||
---
|
|
||||||
name: documentation-sync
|
|
||||||
description: Keep Homarr documentation in sync with code changes. Use when modifying code that affects user-facing behavior, or when adding/modifying widgets, integrations, cron jobs, API routes, env vars, permissions, auth providers, or UI in apps/docs. Covers the docs/ mapping table, integration doc pattern, and widget doc pattern.
|
|
||||||
---
|
|
||||||
|
|
||||||
# Documentation Sync
|
|
||||||
|
|
||||||
When modifying code that affects user-facing behavior, you MUST also update the documentation in `apps/docs/`.
|
|
||||||
|
|
||||||
## What triggers a doc update
|
|
||||||
|
|
||||||
| Code change | Doc location |
|
|
||||||
| ---------------------- | ----------------------------------------------------------- |
|
|
||||||
| New integration | `apps/docs/docs/integrations/<slug>/index.mdx` + `index.ts` |
|
|
||||||
| New widget | `apps/docs/docs/widgets/<slug>/index.mdx` + `index.ts` |
|
|
||||||
| Changed API surface | `apps/docs/docs/management/api.mdx` |
|
|
||||||
| New/changed env vars | `apps/docs/docs/advanced/` |
|
|
||||||
| New CLI commands | `apps/docs/docs/advanced/command-line/` |
|
|
||||||
| Changed auth providers | `apps/docs/docs/advanced/` SSO pages |
|
|
||||||
| UI/UX changes | Relevant getting-started or management pages |
|
|
||||||
| New cron job | `apps/docs/docs/management/tasks.mdx` |
|
|
||||||
| Changed permissions | `apps/docs/docs/management/users.mdx` |
|
|
||||||
|
|
||||||
## Integration doc pattern
|
|
||||||
|
|
||||||
Each integration has a folder under `apps/docs/docs/integrations/<slug>/`:
|
|
||||||
|
|
||||||
- `index.ts` — exports a typed `IntegrationDefinition` with name, description, iconUrl, path
|
|
||||||
- `index.mdx` — uses shared components: `IntegrationHeader`, `IntegrationCapabilites`, `IntegrationSecrets`
|
|
||||||
- Import metadata from `@homarr/definitions` where possible
|
|
||||||
|
|
||||||
## Widget doc pattern
|
|
||||||
|
|
||||||
Each widget has a folder under `apps/docs/docs/widgets/<slug>/`:
|
|
||||||
|
|
||||||
- `index.ts` — exports a typed `WidgetDefinition` with icon, name, description, path, configuration
|
|
||||||
- `index.mdx` — uses shared components: `WidgetHeader`, `WidgetConfig`, `WidgetAdding`
|
|
||||||
|
|
||||||
## Development
|
|
||||||
|
|
||||||
- Run docs locally: `pnpm dev:docs` from root
|
|
||||||
- Build docs: `pnpm turbo build --filter=@homarr/docs`
|
|
||||||
- The docs app can import from `@homarr/definitions` for type-safe integration/widget metadata
|
|
||||||
- Docusaurus strict mode throws on broken links — fix any broken references before committing
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
../.agents/skills
|
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
name: codebase-context
|
description: Comprehensive Homarr codebase architecture and conventions reference
|
||||||
description: Comprehensive Homarr codebase architecture and conventions reference. Use when orienting in the monorepo, understanding package dependency layers, the three runtime services and ports, tRPC router structure, multi-database support, widget/integration/cron system architecture, routing, auth providers, env vars, or key patterns before writing code.
|
alwaysApply: true
|
||||||
---
|
---
|
||||||
|
|
||||||
# Homarr Codebase Context
|
# Homarr Codebase Context
|
||||||
@@ -27,7 +27,7 @@ Homarr is an open-source, self-hosted dashboard for managing homelab services. I
|
|||||||
|
|
||||||
## Repository Structure
|
## Repository Structure
|
||||||
|
|
||||||
```text
|
```
|
||||||
homarr/
|
homarr/
|
||||||
├── apps/
|
├── apps/
|
||||||
│ ├── nextjs/ # Main Next.js application (port 3000)
|
│ ├── nextjs/ # Main Next.js application (port 3000)
|
||||||
@@ -66,6 +66,8 @@ homarr/
|
|||||||
│ ├── analytics/ # Server-side analytics (Umami)
|
│ ├── analytics/ # Server-side analytics (Umami)
|
||||||
│ ├── server-settings/ # Server setting keys/types
|
│ ├── server-settings/ # Server setting keys/types
|
||||||
│ ├── settings/ # User-facing settings UI context
|
│ ├── settings/ # User-facing settings UI context
|
||||||
|
│ ├── old-import/ # Legacy Homarr import
|
||||||
|
│ ├── old-schema/ # Legacy Homarr zod schemas
|
||||||
│ └── cli/ # Node CLI for ops (brocli)
|
│ └── cli/ # Node CLI for ops (brocli)
|
||||||
├── tooling/
|
├── tooling/
|
||||||
│ ├── typescript/ # Base tsconfig
|
│ ├── typescript/ # Base tsconfig
|
||||||
@@ -77,11 +79,11 @@ homarr/
|
|||||||
|
|
||||||
## Three Runtime Services
|
## Three Runtime Services
|
||||||
|
|
||||||
| Service | Port | Role |
|
| Service | Port | Role |
|
||||||
| --------- | ---- | -------------------------------------------- |
|
|---------|------|------|
|
||||||
| Next.js | 3000 | Main web app (SSR + API routes) |
|
| Next.js | 3000 | Main web app (SSR + API routes) |
|
||||||
| WebSocket | 3001 | tRPC subscriptions via `ws` |
|
| WebSocket | 3001 | tRPC subscriptions via `ws` |
|
||||||
| Tasks | 3002 | Cron job runner + management API via Fastify |
|
| Tasks | 3002 | Cron job runner + management API via Fastify |
|
||||||
|
|
||||||
In Docker, nginx listens on **7575** and proxies to all three. The tasks service authenticates via `CRON_JOB_API_KEY` header.
|
In Docker, nginx listens on **7575** and proxies to all three. The tasks service authenticates via `CRON_JOB_API_KEY` header.
|
||||||
|
|
||||||
@@ -110,7 +112,6 @@ In Docker, nginx listens on **7575** and proxies to all three. The tasks service
|
|||||||
### Multi-Database Support
|
### Multi-Database Support
|
||||||
|
|
||||||
Drizzle schemas exist in three parallel implementations:
|
Drizzle schemas exist in three parallel implementations:
|
||||||
|
|
||||||
- `packages/db/schema/sqlite.ts`
|
- `packages/db/schema/sqlite.ts`
|
||||||
- `packages/db/schema/mysql.ts`
|
- `packages/db/schema/mysql.ts`
|
||||||
- `packages/db/schema/postgresql.ts`
|
- `packages/db/schema/postgresql.ts`
|
||||||
@@ -120,7 +121,6 @@ Selected at runtime via `DB_DRIVER` env (`better-sqlite3` | `mysql2` | `node-pos
|
|||||||
### Widget System
|
### Widget System
|
||||||
|
|
||||||
Widgets are registered in `packages/widgets/src/index.tsx` as `widgetImports` (must satisfy `Record<WidgetKind, ...>`). Each widget:
|
Widgets are registered in `packages/widgets/src/index.tsx` as `widgetImports` (must satisfy `Record<WidgetKind, ...>`). Each widget:
|
||||||
|
|
||||||
- Has a `definition` created via `createWidgetDefinition(kind, { icon, createOptions, supportedIntegrations? })`
|
- Has a `definition` created via `createWidgetDefinition(kind, { icon, createOptions, supportedIntegrations? })`
|
||||||
- Uses `optionsBuilder.from(factory => ({ ... }))` for typed options
|
- Uses `optionsBuilder.from(factory => ({ ... }))` for typed options
|
||||||
- Loads dynamically via `next/dynamic`
|
- Loads dynamically via `next/dynamic`
|
||||||
@@ -133,7 +133,6 @@ Integrations are defined in `packages/definitions/src/integration.ts` (`integrat
|
|||||||
### Cron Job System
|
### Cron Job System
|
||||||
|
|
||||||
Jobs defined in `packages/cron-jobs/src/jobs/`. Each job:
|
Jobs defined in `packages/cron-jobs/src/jobs/`. Each job:
|
||||||
|
|
||||||
- Uses `createCronJob` with a cron expression
|
- Uses `createCronJob` with a cron expression
|
||||||
- Publishes results to Redis channels
|
- Publishes results to Redis channels
|
||||||
- Widget subscriptions consume those channels via tRPC subscriptions
|
- Widget subscriptions consume those channels via tRPC subscriptions
|
||||||
@@ -161,7 +160,6 @@ Configured via `AUTH_PROVIDERS` env. Supports: `credentials` (local), `ldap`, `o
|
|||||||
## Environment Variables
|
## Environment Variables
|
||||||
|
|
||||||
Key env vars (from `.env.example`):
|
Key env vars (from `.env.example`):
|
||||||
|
|
||||||
- `DB_DRIVER`: `better-sqlite3` | `mysql2` | `node-postgres`
|
- `DB_DRIVER`: `better-sqlite3` | `mysql2` | `node-postgres`
|
||||||
- `DB_URL`: Database connection string
|
- `DB_URL`: Database connection string
|
||||||
- `AUTH_SECRET`: NextAuth secret
|
- `AUTH_SECRET`: NextAuth secret
|
||||||
@@ -193,3 +191,16 @@ Key env vars (from `.env.example`):
|
|||||||
- Drag-and-drop via `@dnd-kit/*`
|
- Drag-and-drop via `@dnd-kit/*`
|
||||||
- `typescript.ignoreBuildErrors: true` in next.config (types checked separately via `typecheck`)
|
- `typescript.ignoreBuildErrors: true` in next.config (types checked separately via `typecheck`)
|
||||||
- `serverExternalPackages`: `dockerode`, `isomorphic-dompurify`, `jsdom`
|
- `serverExternalPackages`: `dockerode`, `isomorphic-dompurify`, `jsdom`
|
||||||
|
|
||||||
|
## Documentation (`apps/docs`)
|
||||||
|
|
||||||
|
Docusaurus 3 site at `apps/docs/`, package name `@homarr/docs`.
|
||||||
|
|
||||||
|
- Run with `pnpm dev:docs` from root
|
||||||
|
- Build with `pnpm turbo build --filter=@homarr/docs`
|
||||||
|
- Uses Tailwind CSS 3 for custom pages (not Mantine)
|
||||||
|
- Imports `@homarr/definitions` for type-safe integration/widget metadata
|
||||||
|
- When adding or modifying widgets, integrations, cron jobs, API routes, env vars, or user-facing features, you MUST also update corresponding docs in `apps/docs/docs/`
|
||||||
|
- Integration docs: `apps/docs/docs/integrations/<slug>/index.mdx` + `index.ts`
|
||||||
|
- Widget docs: `apps/docs/docs/widgets/<slug>/index.mdx` + `index.ts`
|
||||||
|
- Strict link checking: broken links/anchors cause build failure
|
||||||
@@ -0,0 +1,50 @@
|
|||||||
|
---
|
||||||
|
description: Keep documentation in sync with code changes
|
||||||
|
globs:
|
||||||
|
- packages/definitions/src/**
|
||||||
|
- packages/widgets/src/**
|
||||||
|
- packages/integrations/src/**
|
||||||
|
- packages/api/src/**
|
||||||
|
- apps/nextjs/src/**
|
||||||
|
- apps/docs/**
|
||||||
|
---
|
||||||
|
|
||||||
|
# Documentation Sync Rule
|
||||||
|
|
||||||
|
When modifying code that affects user-facing behavior, you MUST also update the documentation in `apps/docs/`.
|
||||||
|
|
||||||
|
## What triggers a doc update
|
||||||
|
|
||||||
|
| Code change | Doc location |
|
||||||
|
|---|---|
|
||||||
|
| New integration | `apps/docs/docs/integrations/<slug>/index.mdx` + `index.ts` |
|
||||||
|
| New widget | `apps/docs/docs/widgets/<slug>/index.mdx` + `index.ts` |
|
||||||
|
| Changed API surface | `apps/docs/docs/management/api.mdx` |
|
||||||
|
| New/changed env vars | `apps/docs/docs/advanced/` |
|
||||||
|
| New CLI commands | `apps/docs/docs/advanced/command-line/` |
|
||||||
|
| Changed auth providers | `apps/docs/docs/advanced/` SSO pages |
|
||||||
|
| UI/UX changes | Relevant getting-started or management pages |
|
||||||
|
| New cron job | `apps/docs/docs/management/tasks.mdx` |
|
||||||
|
| Changed permissions | `apps/docs/docs/management/users.mdx` |
|
||||||
|
|
||||||
|
## Integration doc pattern
|
||||||
|
|
||||||
|
Each integration has a folder under `apps/docs/docs/integrations/<slug>/`:
|
||||||
|
|
||||||
|
- `index.ts` — exports a typed `IntegrationDefinition` with name, description, iconUrl, path
|
||||||
|
- `index.mdx` — uses shared components: `IntegrationHeader`, `IntegrationCapabilites`, `IntegrationSecrets`
|
||||||
|
- Import metadata from `@homarr/definitions` where possible
|
||||||
|
|
||||||
|
## Widget doc pattern
|
||||||
|
|
||||||
|
Each widget has a folder under `apps/docs/docs/widgets/<slug>/`:
|
||||||
|
|
||||||
|
- `index.ts` — exports a typed `WidgetDefinition` with icon, name, description, path, configuration
|
||||||
|
- `index.mdx` — uses shared components: `WidgetHeader`, `WidgetConfig`, `WidgetAdding`
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
|
- Run docs locally: `pnpm dev:docs` from root
|
||||||
|
- Build docs: `pnpm turbo build --filter=@homarr/docs`
|
||||||
|
- The docs app can import from `@homarr/definitions` for type-safe integration/widget metadata
|
||||||
|
- Docusaurus strict mode throws on broken links — fix any broken references before committing
|
||||||
+73
-142
@@ -1,8 +1,3 @@
|
|||||||
---
|
|
||||||
name: datatable-migration
|
|
||||||
description: Playbook for migrating tables from mantine-react-table (MRT) to mantine-datatable. Use when converting any table component from mantine-react-table to mantine-datatable, working on DataTable column/sort/expansion/context-menu code, or implementing responsive column visibility, column persistence, or transparent tables in widgets.
|
|
||||||
---
|
|
||||||
|
|
||||||
# Migrating Tables from mantine-react-table to mantine-datatable
|
# Migrating Tables from mantine-react-table to mantine-datatable
|
||||||
|
|
||||||
This document captures every pattern, fix, and decision from the downloads widget rework (PR #6430). Use it as a playbook when porting other tables.
|
This document captures every pattern, fix, and decision from the downloads widget rework (PR #6430). Use it as a playbook when porting other tables.
|
||||||
@@ -12,12 +7,10 @@ This document captures every pattern, fix, and decision from the downloads widge
|
|||||||
Current `mantine-react-table` consumers that could be migrated:
|
Current `mantine-react-table` consumers that could be migrated:
|
||||||
|
|
||||||
**Widgets (in `packages/widgets/`):**
|
**Widgets (in `packages/widgets/`):**
|
||||||
|
|
||||||
- `docker/component.tsx` — Docker container table
|
- `docker/component.tsx` — Docker container table
|
||||||
- `media-server/component.tsx` — Media server sessions
|
- `media-server/component.tsx` — Media server sessions
|
||||||
|
|
||||||
**Admin pages (in `apps/nextjs/src/app/[locale]/manage/`):**
|
**Admin pages (in `apps/nextjs/src/app/[locale]/manage/`):**
|
||||||
|
|
||||||
- `tools/docker/docker-table.tsx`
|
- `tools/docker/docker-table.tsx`
|
||||||
- `tools/tasks/_components/tasks-table.tsx`
|
- `tools/tasks/_components/tasks-table.tsx`
|
||||||
- `tools/api/components/api-keys.tsx`
|
- `tools/api/components/api-keys.tsx`
|
||||||
@@ -26,13 +19,13 @@ Current `mantine-react-table` consumers that could be migrated:
|
|||||||
- `tools/kubernetes/` — 8 Kubernetes resource tables
|
- `tools/kubernetes/` — 8 Kubernetes resource tables
|
||||||
|
|
||||||
**Modals:**
|
**Modals:**
|
||||||
|
|
||||||
- `packages/modals-collection/src/search-engines/request-media-modal.tsx`
|
- `packages/modals-collection/src/search-engines/request-media-modal.tsx`
|
||||||
|
|
||||||
**Shared hook to remove once all migrated:**
|
**Shared hook to remove once all migrated:**
|
||||||
|
|
||||||
- `packages/ui/src/hooks/use-translated-mantine-react-table.ts`
|
- `packages/ui/src/hooks/use-translated-mantine-react-table.ts`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## 1. Core Migration: mantine-react-table → mantine-datatable
|
## 1. Core Migration: mantine-react-table → mantine-datatable
|
||||||
|
|
||||||
### Import changes
|
### Import changes
|
||||||
@@ -74,7 +67,6 @@ const columns: DataTableColumn<MyRow>[] = [
|
|||||||
```
|
```
|
||||||
|
|
||||||
Key differences:
|
Key differences:
|
||||||
|
|
||||||
- `accessorKey` → `accessor`
|
- `accessorKey` → `accessor`
|
||||||
- `header` → `title`
|
- `header` → `title`
|
||||||
- `size` → `width`
|
- `size` → `width`
|
||||||
@@ -126,6 +118,8 @@ const sortedData = useMemo(() => {
|
|||||||
<DataTable records={sortedData} sortStatus={sortStatus} onSortStatusChange={setSortStatus} />
|
<DataTable records={sortedData} sortStatus={sortStatus} onSortStatusChange={setSortStatus} />
|
||||||
```
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## 2. Making Tables Transparent (Widget Context)
|
## 2. Making Tables Transparent (Widget Context)
|
||||||
|
|
||||||
Widgets sit inside board cards that have user-controlled opacity. The table must be fully transparent so the card background shows through. mantine-datatable defaults to `var(--mantine-color-body)` which is opaque.
|
Widgets sit inside board cards that have user-controlled opacity. The table must be fully transparent so the card background shows through. mantine-datatable defaults to `var(--mantine-color-body)` which is opaque.
|
||||||
@@ -150,21 +144,13 @@ Create a CSS file alongside the component:
|
|||||||
|
|
||||||
/* Hover: translucent instead of opaque */
|
/* Hover: translucent instead of opaque */
|
||||||
.my-table .mantine-datatable-table tbody tr:hover {
|
.my-table .mantine-datatable-table tbody tr:hover {
|
||||||
background-color: color-mix(
|
background-color: color-mix(in srgb, var(--mantine-color-default-hover) 40%, transparent) !important;
|
||||||
in srgb,
|
|
||||||
var(--mantine-color-default-hover) 40%,
|
|
||||||
transparent
|
|
||||||
) !important;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/* Headers: frosted glass effect */
|
/* Headers: frosted glass effect */
|
||||||
.my-table th {
|
.my-table th {
|
||||||
white-space: nowrap;
|
white-space: nowrap;
|
||||||
background-color: color-mix(
|
background-color: color-mix(in srgb, var(--mantine-color-body) 60%, transparent) !important;
|
||||||
in srgb,
|
|
||||||
var(--mantine-color-body) 60%,
|
|
||||||
transparent
|
|
||||||
) !important;
|
|
||||||
backdrop-filter: blur(8px);
|
backdrop-filter: blur(8px);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -186,16 +172,14 @@ Create a CSS file alongside the component:
|
|||||||
|
|
||||||
/* Row expansion area */
|
/* Row expansion area */
|
||||||
.my-table .mantine-datatable-row-expansion-cell {
|
.my-table .mantine-datatable-row-expansion-cell {
|
||||||
background-color: color-mix(
|
background-color: color-mix(in srgb, var(--mantine-color-body) 40%, transparent) !important;
|
||||||
in srgb,
|
|
||||||
var(--mantine-color-body) 40%,
|
|
||||||
transparent
|
|
||||||
) !important;
|
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Import it: `import "./styles.css";` and apply via `className="my-table"`.
|
Import it: `import "./styles.css";` and apply via `className="my-table"`.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## 3. Responsive Column Visibility
|
## 3. Responsive Column Visibility
|
||||||
|
|
||||||
Use a lookup table of width breakpoints instead of media queries. The widget receives `width` as a prop.
|
Use a lookup table of width breakpoints instead of media queries. The widget receives `width` as a prop.
|
||||||
@@ -211,38 +195,11 @@ interface SizeConfig {
|
|||||||
}
|
}
|
||||||
|
|
||||||
const SIZE_BREAKPOINTS: { maxWidth: number; config: SizeConfig }[] = [
|
const SIZE_BREAKPOINTS: { maxWidth: number; config: SizeConfig }[] = [
|
||||||
{
|
{ maxWidth: 300, config: { fontSize: "xs", iconSize: 12, cellPadding: 2, showSpeedColumns: false, showTimeColumn: false, showStateColumn: false } },
|
||||||
maxWidth: 300,
|
{ maxWidth: 500, config: { fontSize: "xs", iconSize: 14, cellPadding: 4, showSpeedColumns: false, showTimeColumn: true, showStateColumn: false } },
|
||||||
config: {
|
|
||||||
fontSize: "xs",
|
|
||||||
iconSize: 12,
|
|
||||||
cellPadding: 2,
|
|
||||||
showSpeedColumns: false,
|
|
||||||
showTimeColumn: false,
|
|
||||||
showStateColumn: false,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
maxWidth: 500,
|
|
||||||
config: {
|
|
||||||
fontSize: "xs",
|
|
||||||
iconSize: 14,
|
|
||||||
cellPadding: 4,
|
|
||||||
showSpeedColumns: false,
|
|
||||||
showTimeColumn: true,
|
|
||||||
showStateColumn: false,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
];
|
];
|
||||||
|
|
||||||
const DEFAULT_SIZE_CONFIG: SizeConfig = {
|
const DEFAULT_SIZE_CONFIG: SizeConfig = { fontSize: "sm", iconSize: 14, cellPadding: 4, showSpeedColumns: true, showTimeColumn: true, showStateColumn: true };
|
||||||
fontSize: "sm",
|
|
||||||
iconSize: 14,
|
|
||||||
cellPadding: 4,
|
|
||||||
showSpeedColumns: true,
|
|
||||||
showTimeColumn: true,
|
|
||||||
showStateColumn: true,
|
|
||||||
};
|
|
||||||
|
|
||||||
function getSizeConfig(width: number): SizeConfig {
|
function getSizeConfig(width: number): SizeConfig {
|
||||||
for (const { maxWidth, config } of SIZE_BREAKPOINTS) {
|
for (const { maxWidth, config } of SIZE_BREAKPOINTS) {
|
||||||
@@ -258,9 +215,7 @@ const size = useMemo(() => getSizeConfig(width), [width]);
|
|||||||
Then use a visibility check lookup table for columns:
|
Then use a visibility check lookup table for columns:
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
const columnVisibilityChecks: Partial<
|
const columnVisibilityChecks: Partial<Record<string, (ctx: ColumnContext) => boolean>> = {
|
||||||
Record<string, (ctx: ColumnContext) => boolean>
|
|
||||||
> = {
|
|
||||||
upSpeed: (ctx) => ctx.hasTorrents && ctx.size.showSpeedColumns,
|
upSpeed: (ctx) => ctx.hasTorrents && ctx.size.showSpeedColumns,
|
||||||
downSpeed: (ctx) => ctx.size.showSpeedColumns,
|
downSpeed: (ctx) => ctx.size.showSpeedColumns,
|
||||||
time: (ctx) => ctx.size.showTimeColumn,
|
time: (ctx) => ctx.size.showTimeColumn,
|
||||||
@@ -275,6 +230,8 @@ function shouldIncludeColumn(accessor: string, ctx: ColumnContext): boolean {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## 4. Column Persistence (Drag/Resize → Server)
|
## 4. Column Persistence (Drag/Resize → Server)
|
||||||
|
|
||||||
`useDataTableColumns` stores column order and widths in localStorage by default. For widgets, this must persist server-side so it works across devices.
|
`useDataTableColumns` stores column order and widths in localStorage by default. For widgets, this must persist server-side so it works across devices.
|
||||||
@@ -306,6 +263,15 @@ Even hidden options need translation keys or the translation test fails:
|
|||||||
"widget.mywidget.option.columnWidths.label": "Column widths"
|
"widget.mywidget.option.columnWidths.label": "Column widths"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Old-import mappings
|
||||||
|
|
||||||
|
Add to `packages/old-import/src/widgets/options.ts`:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
columnOrder: () => undefined,
|
||||||
|
columnWidths: () => undefined,
|
||||||
|
```
|
||||||
|
|
||||||
### Dynamic storeKey
|
### Dynamic storeKey
|
||||||
|
|
||||||
Use a key that includes `itemId` and sorted column names. This prevents cross-widget localStorage bleeding:
|
Use a key that includes `itemId` and sorted column names. This prevents cross-widget localStorage bleeding:
|
||||||
@@ -319,13 +285,8 @@ const storeKey = `mytable-${itemId ?? "preview"}-${[...options.columns].toSorted
|
|||||||
On mount, seed `useDataTableColumns` with server-persisted values. Use a `hydrated` ref to prevent the persist effect from immediately writing defaults back:
|
On mount, seed `useDataTableColumns` with server-persisted values. Use a `hydrated` ref to prevent the persist effect from immediately writing defaults back:
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
const {
|
const { effectiveColumns, columnsOrder, columnsWidth, setColumnsOrder, setMultipleColumnWidths } =
|
||||||
effectiveColumns,
|
useDataTableColumns<MyRow>({ key: storeKey, columns });
|
||||||
columnsOrder,
|
|
||||||
columnsWidth,
|
|
||||||
setColumnsOrder,
|
|
||||||
setMultipleColumnWidths,
|
|
||||||
} = useDataTableColumns<MyRow>({ key: storeKey, columns });
|
|
||||||
|
|
||||||
const lastStoreKey = useRef(storeKey);
|
const lastStoreKey = useRef(storeKey);
|
||||||
const hydrated = useRef(false);
|
const hydrated = useRef(false);
|
||||||
@@ -339,22 +300,11 @@ useEffect(() => {
|
|||||||
if (savedOrder.length > 0) setColumnsOrder(savedOrder);
|
if (savedOrder.length > 0) setColumnsOrder(savedOrder);
|
||||||
if (Object.keys(savedWidths).length > 0) {
|
if (Object.keys(savedWidths).length > 0) {
|
||||||
setMultipleColumnWidths(
|
setMultipleColumnWidths(
|
||||||
Object.entries(savedWidths).map(([accessor, w]) => ({
|
Object.entries(savedWidths).map(([accessor, w]) => ({ accessor, width: w })),
|
||||||
accessor,
|
|
||||||
width: w,
|
|
||||||
})),
|
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
requestAnimationFrame(() => {
|
requestAnimationFrame(() => { hydrated.current = true; });
|
||||||
hydrated.current = true;
|
}, [storeKey, savedOrder, savedWidths, setColumnsOrder, setMultipleColumnWidths]);
|
||||||
});
|
|
||||||
}, [
|
|
||||||
storeKey,
|
|
||||||
savedOrder,
|
|
||||||
savedWidths,
|
|
||||||
setColumnsOrder,
|
|
||||||
setMultipleColumnWidths,
|
|
||||||
]);
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Persist localStorage → server
|
### Persist localStorage → server
|
||||||
@@ -367,26 +317,22 @@ const prevWidths = useRef(columnsWidth);
|
|||||||
|
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
if (!hydrated.current) return;
|
if (!hydrated.current) return;
|
||||||
const orderChanged =
|
const orderChanged = JSON.stringify(columnsOrder) !== JSON.stringify(prevOrder.current);
|
||||||
JSON.stringify(columnsOrder) !== JSON.stringify(prevOrder.current);
|
const widthsChanged = JSON.stringify(columnsWidth) !== JSON.stringify(prevWidths.current);
|
||||||
const widthsChanged =
|
|
||||||
JSON.stringify(columnsWidth) !== JSON.stringify(prevWidths.current);
|
|
||||||
prevOrder.current = columnsOrder;
|
prevOrder.current = columnsOrder;
|
||||||
prevWidths.current = columnsWidth;
|
prevWidths.current = columnsWidth;
|
||||||
|
|
||||||
if (!orderChanged && !widthsChanged) return;
|
if (!orderChanged && !widthsChanged) return;
|
||||||
|
|
||||||
if (orderChanged)
|
if (orderChanged) persistOption({ columnOrder: JSON.stringify(columnsOrder) });
|
||||||
persistOption({ columnOrder: JSON.stringify(columnsOrder) });
|
|
||||||
if (widthsChanged) {
|
if (widthsChanged) {
|
||||||
const widthMap: Record<string, number> = {};
|
const widthMap: Record<string, number> = {};
|
||||||
for (const entry of columnsWidth) {
|
for (const entry of columnsWidth) {
|
||||||
const key = Object.keys(entry)[0];
|
const key = Object.keys(entry)[0];
|
||||||
if (!key) continue;
|
if (!key) continue;
|
||||||
const v = entry[key as keyof typeof entry];
|
const w = entry[key as keyof typeof entry];
|
||||||
if (typeof v === "number") widthMap[key] = v;
|
if (typeof w === "number") widthMap[key] = w;
|
||||||
else if (typeof v === "string" && v.endsWith("px"))
|
else if (typeof w === "string" && w.endsWith("px")) widthMap[key] = parseInt(w, 10);
|
||||||
widthMap[key] = parseInt(v, 10);
|
|
||||||
}
|
}
|
||||||
persistOption({ columnWidths: JSON.stringify(widthMap) });
|
persistOption({ columnWidths: JSON.stringify(widthMap) });
|
||||||
}
|
}
|
||||||
@@ -395,6 +341,8 @@ useEffect(() => {
|
|||||||
|
|
||||||
The `persistOption` helper calls both `setOptions` (local state) and `saveItemOptions` (server mutation).
|
The `persistOption` helper calls both `setOptions` (local state) and `saveItemOptions` (server mutation).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## 5. Context Menu (Right-Click)
|
## 5. Context Menu (Right-Click)
|
||||||
|
|
||||||
Do NOT install `mantine-contextmenu`. Use Mantine's `Menu` + `Portal` directly:
|
Do NOT install `mantine-contextmenu`. Use Mantine's `Menu` + `Portal` directly:
|
||||||
@@ -426,41 +374,15 @@ const handleContextMenu = useCallback(
|
|||||||
The menu component uses `Portal` for correct z-index:
|
The menu component uses `Portal` for correct z-index:
|
||||||
|
|
||||||
```tsx
|
```tsx
|
||||||
function RowContextMenu({
|
function RowContextMenu({ state, onClose }: { state: ContextMenuState; onClose: () => void }) {
|
||||||
state,
|
|
||||||
onClose,
|
|
||||||
}: {
|
|
||||||
state: ContextMenuState;
|
|
||||||
onClose: () => void;
|
|
||||||
}) {
|
|
||||||
return (
|
return (
|
||||||
<Portal>
|
<Portal>
|
||||||
<Menu
|
<Menu opened onClose={onClose} closeOnItemClick={false} position="right-start" offset={0}>
|
||||||
opened
|
|
||||||
onClose={onClose}
|
|
||||||
closeOnItemClick={false}
|
|
||||||
position="right-start"
|
|
||||||
offset={0}
|
|
||||||
>
|
|
||||||
<Menu.Target>
|
<Menu.Target>
|
||||||
<Box
|
<Box style={{ position: "fixed", left: state.x, top: state.y, width: 0, height: 0 }} />
|
||||||
style={{
|
|
||||||
position: "fixed",
|
|
||||||
left: state.x,
|
|
||||||
top: state.y,
|
|
||||||
width: 0,
|
|
||||||
height: 0,
|
|
||||||
}}
|
|
||||||
/>
|
|
||||||
</Menu.Target>
|
</Menu.Target>
|
||||||
<Menu.Dropdown>
|
<Menu.Dropdown>
|
||||||
<Menu.Item
|
<Menu.Item onClick={() => { /* action */ onClose(); }}>Action</Menu.Item>
|
||||||
onClick={() => {
|
|
||||||
/* action */ onClose();
|
|
||||||
}}
|
|
||||||
>
|
|
||||||
Action
|
|
||||||
</Menu.Item>
|
|
||||||
</Menu.Dropdown>
|
</Menu.Dropdown>
|
||||||
</Menu>
|
</Menu>
|
||||||
</Portal>
|
</Portal>
|
||||||
@@ -470,6 +392,8 @@ function RowContextMenu({
|
|||||||
|
|
||||||
**Key fix:** Use `closeOnItemClick={false}` if any menu item needs a two-step confirmation (like delete → confirm). Close the menu on scroll: `onScroll={() => { if (contextMenu) closeContextMenu(); }}`.
|
**Key fix:** Use `closeOnItemClick={false}` if any menu item needs a two-step confirmation (like delete → confirm). Close the menu on scroll: `onScroll={() => { if (contextMenu) closeContextMenu(); }}`.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## 6. Row Expansion
|
## 6. Row Expansion
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
@@ -489,6 +413,8 @@ function RowContextMenu({
|
|||||||
|
|
||||||
**Critical:** Do NOT set `onRowClick` when using `rowExpansion` with `trigger: "click"`. They conflict and the expansion won't work.
|
**Critical:** Do NOT set `onRowClick` when using `rowExpansion` with `trigger: "click"`. They conflict and the expansion won't work.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## 7. Common Pitfalls & Fixes
|
## 7. Common Pitfalls & Fixes
|
||||||
|
|
||||||
### Status indicator dots
|
### Status indicator dots
|
||||||
@@ -549,11 +475,8 @@ Always wrap in try/catch:
|
|||||||
```typescript
|
```typescript
|
||||||
function parseJsonOption<T>(value: string | undefined, fallback: T): T {
|
function parseJsonOption<T>(value: string | undefined, fallback: T): T {
|
||||||
if (!value) return fallback;
|
if (!value) return fallback;
|
||||||
try {
|
try { return JSON.parse(value) as T; }
|
||||||
return JSON.parse(value) as T;
|
catch { return fallback; }
|
||||||
} catch {
|
|
||||||
return fallback;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -571,19 +494,20 @@ If the widget has configurable default sort, sync it:
|
|||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
setSortStatus({
|
setSortStatus({ columnAccessor: options.defaultSort, direction: defaultSortDirection });
|
||||||
columnAccessor: options.defaultSort,
|
|
||||||
direction: defaultSortDirection,
|
|
||||||
});
|
|
||||||
}, [options.defaultSort, defaultSortDirection]);
|
}, [options.defaultSort, defaultSortDirection]);
|
||||||
```
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## 8. Accessibility
|
## 8. Accessibility
|
||||||
|
|
||||||
- All `ActionIcon` components need `aria-label`
|
- All `ActionIcon` components need `aria-label`
|
||||||
- Filter toggles (client badges, status badges) need `aria-pressed={isActive}`
|
- Filter toggles (client badges, status badges) need `aria-pressed={isActive}`
|
||||||
- `textSelectionDisabled` on DataTable prevents accidental text selection during drag/resize
|
- `textSelectionDisabled` on DataTable prevents accidental text selection during drag/resize
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## 9. Error Handling
|
## 9. Error Handling
|
||||||
|
|
||||||
- Every mutation needs an `onError` callback with `showErrorNotification`
|
- Every mutation needs an `onError` callback with `showErrorNotification`
|
||||||
@@ -594,14 +518,12 @@ useEffect(() => {
|
|||||||
```typescript
|
```typescript
|
||||||
const mutationOptions = {
|
const mutationOptions = {
|
||||||
onSettled: () => void utils.myQuery.invalidate(),
|
onSettled: () => void utils.myQuery.invalidate(),
|
||||||
onError: () =>
|
onError: () => showErrorNotification({ title: t("errors.actionFailed"), message: t("errors.actionFailedMessage") }),
|
||||||
showErrorNotification({
|
|
||||||
title: t("errors.actionFailed"),
|
|
||||||
message: t("errors.actionFailedMessage"),
|
|
||||||
}),
|
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## 10. i18n
|
## 10. i18n
|
||||||
|
|
||||||
- No hardcoded strings. Every user-visible string goes through `useScopedI18n`
|
- No hardcoded strings. Every user-visible string goes through `useScopedI18n`
|
||||||
@@ -612,6 +534,8 @@ const mutationOptions = {
|
|||||||
- Errors: `t("errors.{errorKey}")`
|
- Errors: `t("errors.{errorKey}")`
|
||||||
- Hidden options still need `.label` translation keys
|
- Hidden options still need `.label` translation keys
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## 11. Edit Mode
|
## 11. Edit Mode
|
||||||
|
|
||||||
Disable pointer events on the table during edit mode to prevent conflicts with the board's drag-and-drop:
|
Disable pointer events on the table during edit mode to prevent conflicts with the board's drag-and-drop:
|
||||||
@@ -626,6 +550,8 @@ if (isEditMode) rowContextMenuHandler = undefined;
|
|||||||
<DataTable style={{ pointerEvents: tablePointerEvents }} />
|
<DataTable style={{ pointerEvents: tablePointerEvents }} />
|
||||||
```
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## 12. DataTable Props Reference (Commonly Used)
|
## 12. DataTable Props Reference (Commonly Used)
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
@@ -664,6 +590,8 @@ if (isEditMode) rowContextMenuHandler = undefined;
|
|||||||
/>
|
/>
|
||||||
```
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## 13. Layout Stability
|
## 13. Layout Stability
|
||||||
|
|
||||||
- Don't use `table-layout: fixed` — it fights mantine-datatable's resize logic
|
- Don't use `table-layout: fixed` — it fights mantine-datatable's resize logic
|
||||||
@@ -672,6 +600,8 @@ if (isEditMode) rowContextMenuHandler = undefined;
|
|||||||
- Names should truncate at the cell boundary, not a character count, so the layout is stable regardless of content length
|
- Names should truncate at the cell boundary, not a character count, so the layout is stable regardless of content length
|
||||||
- `flexShrink: 0` on badges/icons prevents them from being squeezed by long names
|
- `flexShrink: 0` on badges/icons prevents them from being squeezed by long names
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## 14. Checklist for Each Migration
|
## 14. Checklist for Each Migration
|
||||||
|
|
||||||
1. Replace imports (`mantine-react-table` → `mantine-datatable`)
|
1. Replace imports (`mantine-react-table` → `mantine-datatable`)
|
||||||
@@ -680,12 +610,13 @@ if (isEditMode) rowContextMenuHandler = undefined;
|
|||||||
4. Add CSS file for transparent backgrounds (if widget context)
|
4. Add CSS file for transparent backgrounds (if widget context)
|
||||||
5. Add responsive column visibility (if widget context)
|
5. Add responsive column visibility (if widget context)
|
||||||
6. Add hidden options + hydration logic (if column persistence needed)
|
6. Add hidden options + hydration logic (if column persistence needed)
|
||||||
7. Add translation keys (including hidden option labels)
|
7. Add old-import mappings for new options
|
||||||
8. Add context menu if row actions exist
|
8. Add translation keys (including hidden option labels)
|
||||||
9. Add row expansion if detail view exists
|
9. Add context menu if row actions exist
|
||||||
10. Add error handling on all mutations
|
10. Add row expansion if detail view exists
|
||||||
11. Add accessibility attributes
|
11. Add error handling on all mutations
|
||||||
12. Test at multiple widget widths
|
12. Add accessibility attributes
|
||||||
13. Update docs in `apps/docs/docs/widgets/` if applicable
|
13. Test at multiple widget widths
|
||||||
14. Run `pnpm turbo typecheck`
|
14. Update docs in `apps/docs/docs/widgets/` if applicable
|
||||||
15. Run translation spec — catches missing keys
|
15. Run `pnpm turbo typecheck` — catches old-import mismatches
|
||||||
|
16. Run translation spec — catches missing keys
|
||||||
@@ -1,14 +1,13 @@
|
|||||||
---
|
---
|
||||||
name: mcp-integration
|
description: How to expose tRPC procedures as MCP tools for AI clients
|
||||||
description: Expose tRPC procedures as MCP tools for AI clients. Use when modifying procedures in packages/api/src/router, adding a new tRPC procedure or router, or deciding what to expose via Homarr's MCP interface. Covers .meta({ mcp }), router registration in packages/api/src/mcp.ts, input schema rules, and what to expose vs skip.
|
globs: packages/api/src/router/**/*.ts
|
||||||
|
alwaysApply: false
|
||||||
---
|
---
|
||||||
|
|
||||||
# MCP Integration
|
# MCP Integration Guide
|
||||||
|
|
||||||
Every new tRPC procedure that provides useful functionality should be exposed as an MCP tool so AI assistants (Claude, Cursor, etc.) can use it. This is a first-class feature of Homarr.
|
Every new tRPC procedure that provides useful functionality should be exposed as an MCP tool so AI assistants (Claude, Cursor, etc.) can use it. This is a first-class feature of Homarr.
|
||||||
|
|
||||||
Exposing a procedure makes it callable by any AI client with an API key. Before adding `.meta({ mcp })`, review what the tool exposes: authorization requirements, sensitive data, tenant isolation, auditability, and whether the action is destructive. Prefer exposing read-only queries over mutations unless the mutation is safe and permission-scoped. When in doubt, ask for a security review before shipping a new MCP tool.
|
|
||||||
|
|
||||||
## Adding MCP to a procedure
|
## Adding MCP to a procedure
|
||||||
|
|
||||||
Add `.meta({ mcp: { enabled: true, description: "..." } })` to the procedure chain:
|
Add `.meta({ mcp: { enabled: true, description: "..." } })` to the procedure chain:
|
||||||
@@ -17,7 +16,7 @@ Add `.meta({ mcp: { enabled: true, description: "..." } })` to the procedure cha
|
|||||||
// Read-only tool (query)
|
// Read-only tool (query)
|
||||||
myProcedure: protectedProcedure
|
myProcedure: protectedProcedure
|
||||||
.meta({ mcp: { enabled: true, description: "Get all items with their status and metadata" } })
|
.meta({ mcp: { enabled: true, description: "Get all items with their status and metadata" } })
|
||||||
.input(z.object({ limit: z.number().default(10) }))
|
.input(z.object({ limit: z.number().default(50) }))
|
||||||
.query(async ({ ctx, input }) => { ... })
|
.query(async ({ ctx, input }) => { ... })
|
||||||
|
|
||||||
// Write tool (mutation)
|
// Write tool (mutation)
|
||||||
@@ -39,27 +38,23 @@ The `.meta()` call must come **before** `.input()` and `.query()`/`.mutation()`
|
|||||||
The description is the **only thing** an AI sees to decide when and how to use the tool. Write it like you're explaining to a colleague who has never used Homarr.
|
The description is the **only thing** an AI sees to decide when and how to use the tool. Write it like you're explaining to a colleague who has never used Homarr.
|
||||||
|
|
||||||
**Must include:**
|
**Must include:**
|
||||||
|
|
||||||
- What the tool returns or does
|
- What the tool returns or does
|
||||||
- Which integrations/services it works with (if applicable)
|
- Which integrations/services it works with (if applicable)
|
||||||
- How to get required IDs (e.g., "Use integration_all to get the integrationId")
|
- How to get required IDs (e.g., "Use integration_all to get the integrationId")
|
||||||
- Permission requirements (if non-obvious)
|
- Permission requirements (if non-obvious)
|
||||||
|
|
||||||
**Good:**
|
**Good:**
|
||||||
|
```
|
||||||
```text
|
|
||||||
"Get calendar events for upcoming and recent media releases. Fetches from all connected Sonarr (TV), Radarr (movies), Lidarr (music), and Readarr (books) integrations. Requires integrationIds from integration_all"
|
"Get calendar events for upcoming and recent media releases. Fetches from all connected Sonarr (TV), Radarr (movies), Lidarr (music), and Readarr (books) integrations. Requires integrationIds from integration_all"
|
||||||
```
|
```
|
||||||
|
|
||||||
**Bad:**
|
**Bad:**
|
||||||
|
```
|
||||||
```text
|
|
||||||
"Get calendar events"
|
"Get calendar events"
|
||||||
```
|
```
|
||||||
|
|
||||||
**For tools that return permission fields**, explain what they mean:
|
**For tools that return permission fields**, explain what they mean:
|
||||||
|
```
|
||||||
```text
|
|
||||||
"List all integrations. Returns permissions.hasUseAccess (read) and permissions.hasInteractAccess (actions) — false means the API key lacks that permission, not an error"
|
"List all integrations. Returns permissions.hasUseAccess (read) and permissions.hasInteractAccess (actions) — false means the API key lacks that permission, not an error"
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -82,13 +77,11 @@ export const mcpRouter = createTRPCRouter({
|
|||||||
## What to expose vs. what to skip
|
## What to expose vs. what to skip
|
||||||
|
|
||||||
**Expose:**
|
**Expose:**
|
||||||
|
|
||||||
- Data queries (list, search, get by ID)
|
- Data queries (list, search, get by ID)
|
||||||
- Actions users would ask an AI to do (toggle, create, delete, approve)
|
- Actions users would ask an AI to do (toggle, create, delete, approve)
|
||||||
- Status checks (health, stats, summaries)
|
- Status checks (health, stats, summaries)
|
||||||
|
|
||||||
**Skip:**
|
**Skip:**
|
||||||
|
|
||||||
- Subscriptions (WebSocket-only, not supported by MCP)
|
- Subscriptions (WebSocket-only, not supported by MCP)
|
||||||
- Internal procedures (session management, onboarding steps)
|
- Internal procedures (session management, onboarding steps)
|
||||||
- File upload/download procedures
|
- File upload/download procedures
|
||||||
+1
-2
@@ -17,8 +17,7 @@ coverage
|
|||||||
dev
|
dev
|
||||||
.build
|
.build
|
||||||
e2e
|
e2e
|
||||||
apps/docs/*
|
apps/docs
|
||||||
!apps/docs/package.json
|
|
||||||
apps/nextjs/.next
|
apps/nextjs/.next
|
||||||
.env
|
.env
|
||||||
.env.*
|
.env.*
|
||||||
|
|||||||
@@ -33,11 +33,6 @@ body:
|
|||||||
options:
|
options:
|
||||||
# The below comment is used to insert a new version with on-release.yml
|
# The below comment is used to insert a new version with on-release.yml
|
||||||
#NEXT_VERSION#
|
#NEXT_VERSION#
|
||||||
- 1.76.2
|
|
||||||
- 1.76.1
|
|
||||||
- 1.76.0
|
|
||||||
- 1.75.0
|
|
||||||
- 1.74.0
|
|
||||||
- 1.73.0
|
- 1.73.0
|
||||||
- 1.72.0
|
- 1.72.0
|
||||||
- 1.71.0
|
- 1.71.0
|
||||||
|
|||||||
@@ -1,131 +0,0 @@
|
|||||||
name: Homarr v2 beta feedback
|
|
||||||
description: Report a specific bug, unexpected behavior, or improvement for the Homarr v2 beta
|
|
||||||
title: "feedback(v2): "
|
|
||||||
labels: ["needs triage"]
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
Thanks for testing Homarr v2. It will become the default when it is ready, and every detailed report helps us get there.
|
|
||||||
|
|
||||||
We cannot guess what you wanted from “this looks wrong.” Tell us exactly which feature is affected, what happened, why it is wrong for your use case, and what you expected instead. Add screenshots or a short recording whenever possible.
|
|
||||||
|
|
||||||
**Not useful:** “The board looks wrong.”
|
|
||||||
|
|
||||||
**Useful:** “The container changes from four columns to three after I move a widget at 1440 × 900 and 100% browser zoom. I expected it to keep four columns.”
|
|
||||||
|
|
||||||
- type: dropdown
|
|
||||||
id: feedback-type
|
|
||||||
attributes:
|
|
||||||
label: Feedback type
|
|
||||||
options:
|
|
||||||
- Bug
|
|
||||||
- Upgrade or migration
|
|
||||||
- Usability or design
|
|
||||||
- Performance
|
|
||||||
- Other
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
|
|
||||||
- type: input
|
|
||||||
id: version
|
|
||||||
attributes:
|
|
||||||
label: Homarr v2 version or image tag
|
|
||||||
description: Copy the version from the About page or provide the exact Docker image tag you tested.
|
|
||||||
placeholder: ghcr.io/homarr-labs/homarr-test:v2
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
|
|
||||||
- type: input
|
|
||||||
id: affected-area
|
|
||||||
attributes:
|
|
||||||
label: Affected page, feature, or widget
|
|
||||||
description: Name the exact page, widget, integration, container, sidebar, or action involved.
|
|
||||||
placeholder: "Board editor: moving a widget into a container"
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
|
|
||||||
- type: textarea
|
|
||||||
id: behavior
|
|
||||||
attributes:
|
|
||||||
label: What happened, why is it wrong, and what should happen instead?
|
|
||||||
description: Describe the actual result, why it does not work for you, and the exact result you expected.
|
|
||||||
placeholder: |
|
|
||||||
What happened:
|
|
||||||
Why this is wrong for my use case:
|
|
||||||
What I expected instead:
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
|
|
||||||
- type: textarea
|
|
||||||
id: reproduction
|
|
||||||
attributes:
|
|
||||||
label: Exact steps to reproduce
|
|
||||||
description: Start from the page you opened and list every click, keypress, drag, setting, and value needed to reproduce it.
|
|
||||||
placeholder: |
|
|
||||||
1. Open...
|
|
||||||
2. Set...
|
|
||||||
3. Drag or click...
|
|
||||||
4. Observe...
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
|
|
||||||
- type: textarea
|
|
||||||
id: visual-evidence
|
|
||||||
attributes:
|
|
||||||
label: Screenshots or screen recordings
|
|
||||||
description: Drag screenshots or a recording into this field. Include the full page for context and a close-up of the problem. Blur secrets and personal data. If you cannot add visuals, explain why.
|
|
||||||
placeholder: Drag screenshots or a recording here, or explain why none are available.
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
|
|
||||||
- type: textarea
|
|
||||||
id: environment
|
|
||||||
attributes:
|
|
||||||
label: Device and Homarr environment
|
|
||||||
description: Provide every detail that could affect the result.
|
|
||||||
placeholder: |
|
|
||||||
Device type and model:
|
|
||||||
Operating system and version:
|
|
||||||
Browser and version:
|
|
||||||
Installation method (Docker, Unraid, Kubernetes, other):
|
|
||||||
Database (SQLite, MySQL, PostgreSQL):
|
|
||||||
Reverse proxy and version, if used:
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
|
|
||||||
- type: textarea
|
|
||||||
id: board-context
|
|
||||||
attributes:
|
|
||||||
label: Board and display context
|
|
||||||
description: Include the layout details even when you are not sure they matter.
|
|
||||||
placeholder: |
|
|
||||||
Display resolution:
|
|
||||||
Browser zoom:
|
|
||||||
Desktop or mobile layout:
|
|
||||||
Board column count:
|
|
||||||
Approximate number of items:
|
|
||||||
Container or sidebar nesting:
|
|
||||||
Relevant board or widget settings:
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
|
|
||||||
- type: textarea
|
|
||||||
id: additional-information
|
|
||||||
attributes:
|
|
||||||
label: Logs and additional information
|
|
||||||
description: Add relevant browser console errors, Homarr logs, integration details, or anything else that may help. Remove secrets and personal information first.
|
|
||||||
|
|
||||||
- type: checkboxes
|
|
||||||
id: checks
|
|
||||||
attributes:
|
|
||||||
label: Before submitting
|
|
||||||
options:
|
|
||||||
- label: I added screenshots or a recording where possible, or explained why I could not.
|
|
||||||
required: true
|
|
||||||
- label: I described both what happened and the exact result I expected.
|
|
||||||
required: true
|
|
||||||
- label: I searched the existing issues for the same feedback.
|
|
||||||
required: true
|
|
||||||
- label: I removed passwords, API keys, tokens, and other private information.
|
|
||||||
required: true
|
|
||||||
@@ -0,0 +1,35 @@
|
|||||||
|
name: "[Dependency Updates] Auto Approve"
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
types: [opened, synchronize]
|
||||||
|
|
||||||
|
permissions: {}
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
approve-automatic-prs:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
timeout-minutes: 2
|
||||||
|
# 158783068: homarr-renovate[bot]
|
||||||
|
# 190541745: homarr-crowdin[bot]
|
||||||
|
# 210161987: homarr-update-contributors[bot]
|
||||||
|
# 175486441: homarr-releases[bot]
|
||||||
|
# Extracted from https://api.github.com/users/<username>
|
||||||
|
if: github.actor_id == 158783068 || github.actor_id == 190541745 || github.actor_id == 210161987 || github.actor_id == 175486441
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v7
|
||||||
|
- name: Obtain token
|
||||||
|
id: obtainToken
|
||||||
|
uses: actions/create-github-app-token@v3
|
||||||
|
with:
|
||||||
|
private-key: ${{ secrets.RENOVATE_APPROVE_PRIVATE_KEY }}
|
||||||
|
client-id: ${{ secrets.RENOVATE_APPROVE_APP_ID }}
|
||||||
|
permission-pull-requests: write # required to approve pull request
|
||||||
|
|
||||||
|
- name: Install GitHub CLI
|
||||||
|
run: sudo apt-get install -y gh
|
||||||
|
- name: Approve automatic PRs
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ steps.obtainToken.outputs.token }}
|
||||||
|
run: |
|
||||||
|
gh pr review ${{github.event.pull_request.number}} --approve --body "Automatically approved by GitHub Action"
|
||||||
@@ -1,43 +0,0 @@
|
|||||||
name: "[Bots] Reconcile Auto-merge"
|
|
||||||
|
|
||||||
on:
|
|
||||||
schedule:
|
|
||||||
- cron: "*/30 * * * *"
|
|
||||||
workflow_dispatch:
|
|
||||||
|
|
||||||
permissions: {}
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
reconcile:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
timeout-minutes: 15
|
|
||||||
steps:
|
|
||||||
- name: Checkout code
|
|
||||||
uses: actions/checkout@v7
|
|
||||||
|
|
||||||
- name: Obtain token
|
|
||||||
id: obtainToken
|
|
||||||
uses: actions/create-github-app-token@v3
|
|
||||||
with:
|
|
||||||
private-key: ${{ secrets.RENOVATE_APPROVE_PRIVATE_KEY }}
|
|
||||||
client-id: ${{ secrets.RENOVATE_APPROVE_APP_ID }}
|
|
||||||
permission-pull-requests: write # required to enable auto-merge
|
|
||||||
|
|
||||||
- name: Install GitHub CLI
|
|
||||||
run: sudo apt-get install -y gh
|
|
||||||
|
|
||||||
- name: Re-enable auto-merge for prepared bot PRs
|
|
||||||
env:
|
|
||||||
GITHUB_TOKEN: ${{ steps.obtainToken.outputs.token }}
|
|
||||||
run: |
|
|
||||||
# 158783068: homarr-renovate[bot]
|
|
||||||
# 190541745: homarr-crowdin[bot]
|
|
||||||
# 210161987: homarr-update-contributors[bot]
|
|
||||||
# 175441: homarr-releases[bot]
|
|
||||||
gh pr list --repo "${{ github.repository }}" --base dev --state open --limit 100 \
|
|
||||||
--json number,author,reviewDecision,mergeStateStatus,autoMergeRequest \
|
|
||||||
--jq '.[] | select(.author.login as $login | ["app/homarr-renovate", "app/homarr-crowdin", "app/homarr-update-contributors", "app/homarr-releases"] | index($login)) | select(.reviewDecision == "APPROVED") | select(.mergeStateStatus == "CLEAN") | select(.autoMergeRequest == null) | .number' \
|
|
||||||
| while read -r pr; do
|
|
||||||
echo "Re-enabling auto-merge on PR #$pr"
|
|
||||||
gh pr merge "$pr" --auto --squash
|
|
||||||
done
|
|
||||||
@@ -1,47 +0,0 @@
|
|||||||
name: "[Bots] Approve and Auto-merge"
|
|
||||||
|
|
||||||
on:
|
|
||||||
pull_request:
|
|
||||||
types: [opened, synchronize, reopened, ready_for_review]
|
|
||||||
|
|
||||||
permissions: {}
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
approve-and-automerge:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
timeout-minutes: 5
|
|
||||||
# 158783068: homarr-renovate[bot]
|
|
||||||
# 190541745: homarr-crowdin[bot]
|
|
||||||
# 210161987: homarr-update-contributors[bot]
|
|
||||||
# 175441: homarr-releases[bot]
|
|
||||||
# Extracted from https://api.github.com/users/<username>
|
|
||||||
if: |
|
|
||||||
(github.actor_id == 158783068 || github.actor_id == 190541745 || github.actor_id == 210161987 || github.actor_id == 175441) &&
|
|
||||||
github.event.pull_request.head.repo.full_name == github.repository &&
|
|
||||||
github.event.pull_request.base.ref == 'dev'
|
|
||||||
steps:
|
|
||||||
- name: Checkout code
|
|
||||||
uses: actions/checkout@v7
|
|
||||||
|
|
||||||
- name: Obtain token
|
|
||||||
id: obtainToken
|
|
||||||
uses: actions/create-github-app-token@v3
|
|
||||||
with:
|
|
||||||
private-key: ${{ secrets.RENOVATE_APPROVE_PRIVATE_KEY }}
|
|
||||||
client-id: ${{ secrets.RENOVATE_APPROVE_APP_ID }}
|
|
||||||
permission-pull-requests: write # required to approve a pull request and enable auto-merge
|
|
||||||
|
|
||||||
- name: Install GitHub CLI
|
|
||||||
run: sudo apt-get install -y gh
|
|
||||||
|
|
||||||
- name: Approve and enable auto-merge
|
|
||||||
env:
|
|
||||||
GITHUB_TOKEN: ${{ steps.obtainToken.outputs.token }}
|
|
||||||
run: |
|
|
||||||
PR_NUMBER="${{ github.event.pull_request.number }}"
|
|
||||||
if [ "$(gh pr view "$PR_NUMBER" --json reviewDecision --jq .reviewDecision)" != "APPROVED" ]; then
|
|
||||||
gh pr review "$PR_NUMBER" --approve --body "Automatically approved by Homarr bot policy"
|
|
||||||
fi
|
|
||||||
if [ "$(gh pr view "$PR_NUMBER" --json autoMergeRequest --jq '.autoMergeRequest != null')" != "true" ]; then
|
|
||||||
gh pr merge "$PR_NUMBER" --auto --squash
|
|
||||||
fi
|
|
||||||
@@ -82,7 +82,7 @@ jobs:
|
|||||||
run: cp .env.example .env
|
run: cp .env.example .env
|
||||||
|
|
||||||
- name: Lint, typecheck, and build affected workspaces
|
- name: Lint, typecheck, and build affected workspaces
|
||||||
run: pnpm turbo run lint typecheck build --affected --continue=dependencies-successful --concurrency=2
|
run: pnpm turbo run lint typecheck build --affected --continue=dependencies-successful
|
||||||
|
|
||||||
- name: Validate workspace configuration
|
- name: Validate workspace configuration
|
||||||
run: pnpm lint:ws
|
run: pnpm lint:ws
|
||||||
|
|||||||
@@ -68,6 +68,8 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
node-version: 24.18.0
|
node-version: 24.18.0
|
||||||
package-manager-cache: false
|
package-manager-cache: false
|
||||||
|
- run: npm i -g pnpm
|
||||||
|
if: env.SKIP_RELEASE == 'false'
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
if: env.SKIP_RELEASE == 'false'
|
if: env.SKIP_RELEASE == 'false'
|
||||||
run: |
|
run: |
|
||||||
|
|||||||
+1
-3
@@ -71,12 +71,10 @@ apps/nextjs/public/images/background.png
|
|||||||
|
|
||||||
# personal agent config
|
# personal agent config
|
||||||
.opencode
|
.opencode
|
||||||
.agents/*
|
.agents/
|
||||||
!.agents/skills/
|
|
||||||
skills-lock.json
|
skills-lock.json
|
||||||
|
|
||||||
# docusaurus
|
# docusaurus
|
||||||
apps/docs/.docusaurus
|
apps/docs/.docusaurus
|
||||||
apps/docs/build
|
apps/docs/build
|
||||||
.pnpm-store
|
.pnpm-store
|
||||||
benchmark-results
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
{
|
|
||||||
"mcpServers": {
|
|
||||||
"mantine": {
|
|
||||||
"command": "npx",
|
|
||||||
"args": ["-y", "@mantine/mcp-server"]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -84,16 +84,6 @@ When modifying user-facing code, you MUST also update the corresponding document
|
|||||||
- Lint: oxlint (not ESLint)
|
- Lint: oxlint (not ESLint)
|
||||||
- Format: oxfmt (not Prettier)
|
- Format: oxfmt (not Prettier)
|
||||||
- UI: Mantine (not Tailwind) — Tailwind is only used in docs app
|
- UI: Mantine (not Tailwind) — Tailwind is only used in docs app
|
||||||
- Mantine: use the `mantine` MCP server (configured in `.mcp.json`; tools `get_item_doc` / `get_item_props` / `search_docs`) for current v9 APIs before writing component code. Prefer built-in primitives (`Combobox`/`useCombobox` for selects, the polymorphic `component` prop, `@mantine/hooks`) over hand-rolled equivalents. Check `packages/ui/` for existing conventions first.
|
|
||||||
|
|
||||||
## MCP servers
|
|
||||||
|
|
||||||
`.mcp.json` at the repo root declares project-scoped MCP servers (the standard Claude Code layout; other tools can import the same `mcpServers` block). See the `mantine` entry there for the Mantine v9 server, and the upstream docs at https://mantine.dev/guides/llms/ for per-tool setup (OpenCode: `.opencode/opencode.json`, Codex: `.codex/config.toml`). Only keyless server definitions belong in `.mcp.json`; anything needing secrets stays in local dotfiles.
|
|
||||||
|
|
||||||
## Agent Skills
|
|
||||||
|
|
||||||
Portable agent skills live in `.agents/skills/` (the Agent Skills open standard). Cursor, Codex, and OpenCode read `.agents/skills/` natively. Claude Code does not scan it, so `.claude/skills/` is a symlink back to `.agents/skills/`. Install skills at `.agents/skills/<name>/SKILL.md` — that single copy is used everywhere. See `.agents/skills/` for available skills (documentation-sync, mcp-integration, codebase-context, datatable-migration).
|
|
||||||
|
|
||||||
- Icons: @tabler/icons-react
|
- Icons: @tabler/icons-react
|
||||||
- Docs app can import from `@homarr/definitions` for shared types
|
- Docs app can import from `@homarr/definitions` for shared types
|
||||||
- Run `pnpm dev:cli -- dev` to browse local `homarr:*` images and remote PR images.
|
- Run `pnpm dev:cli -- dev` to browse local `homarr:*` images and remote PR images.
|
||||||
|
|||||||
@@ -1,13 +1,3 @@
|
|||||||
## [1.76.2](https://github.com/homarr-labs/homarr/compare/v1.76.1...v1.76.2) (2026-08-27)
|
|
||||||
|
|
||||||
## [1.76.1](https://github.com/homarr-labs/homarr/compare/v1.76.0...v1.76.1) (2026-08-26)
|
|
||||||
|
|
||||||
## [1.76.0](https://github.com/homarr-labs/homarr/compare/v1.75.0...v1.76.0) (2026-08-21)
|
|
||||||
|
|
||||||
## [1.75.0](https://github.com/homarr-labs/homarr/compare/v1.74.0...v1.75.0) (2026-08-14)
|
|
||||||
|
|
||||||
## [1.74.0](https://github.com/homarr-labs/homarr/compare/v1.73.0...v1.74.0) (2026-08-07)
|
|
||||||
|
|
||||||
## [1.73.0](https://github.com/homarr-labs/homarr/compare/v1.72.0...v1.73.0) (2026-07-31)
|
## [1.73.0](https://github.com/homarr-labs/homarr/compare/v1.72.0...v1.73.0) (2026-07-31)
|
||||||
|
|
||||||
## [1.72.0](https://github.com/homarr-labs/homarr/compare/v1.71.0...v1.72.0) (2026-07-24)
|
## [1.72.0](https://github.com/homarr-labs/homarr/compare/v1.71.0...v1.72.0) (2026-07-24)
|
||||||
|
|||||||
@@ -206,14 +206,6 @@ packages/integrations/src/unraid @manuel-rw
|
|||||||
apps/docs/docs/integrations/uptime-kuma @ajnart
|
apps/docs/docs/integrations/uptime-kuma @ajnart
|
||||||
packages/integrations/src/uptime-kuma @ajnart
|
packages/integrations/src/uptime-kuma @ajnart
|
||||||
|
|
||||||
# What's Up Docker (WUD) - introduced in https://github.com/homarr-labs/homarr/pull/6523 by @tiimonn
|
|
||||||
apps/docs/docs/integrations/whats-up-docker @tiimonn
|
|
||||||
apps/docs/docs/widgets/whats-up-docker @tiimonn
|
|
||||||
packages/api/src/router/widgets/wud.ts @tiimonn
|
|
||||||
packages/integrations/src/wud @tiimonn
|
|
||||||
packages/request-handler/src/wud.ts @tiimonn
|
|
||||||
packages/widgets/src/wud @tiimonn
|
|
||||||
|
|
||||||
# Traefik - by @Nerdy-Technician
|
# Traefik - by @Nerdy-Technician
|
||||||
apps/docs/docs/integrations/traefik @Nerdy-Technician
|
apps/docs/docs/integrations/traefik @Nerdy-Technician
|
||||||
apps/docs/docs/widgets/traefik @Nerdy-Technician
|
apps/docs/docs/widgets/traefik @Nerdy-Technician
|
||||||
|
|||||||
+8
-19
@@ -3,18 +3,12 @@
|
|||||||
FROM node:24.18.0-alpine AS base
|
FROM node:24.18.0-alpine AS base
|
||||||
|
|
||||||
FROM base AS builder
|
FROM base AS builder
|
||||||
ARG TARGETPLATFORM
|
|
||||||
WORKDIR /app
|
WORKDIR /app
|
||||||
# Native dependencies normally use prebuilds, but the build must remain
|
RUN apk add --no-cache libc6-compat curl bash && apk update
|
||||||
# reproducible when a prebuild download times out and compilation is required.
|
|
||||||
RUN apk add --no-cache libc6-compat curl bash python3 make g++
|
|
||||||
|
|
||||||
RUN corepack enable pnpm
|
RUN corepack enable pnpm
|
||||||
COPY .npmrc pnpm-lock.yaml pnpm-workspace.yaml package.json ./
|
COPY pnpm-lock.yaml pnpm-workspace.yaml package.json ./
|
||||||
COPY patches ./patches
|
COPY patches ./patches
|
||||||
COPY --parents ./apps/*/package.json ./packages/*/package.json ./tooling/*/package.json ./
|
|
||||||
# @homarr/definitions generates documentation types during install.
|
|
||||||
COPY --parents ./packages/definitions/src ./
|
|
||||||
# Workaround for pnpm/pnpm#5268: pnpm fetch crashes when patchedDependencies
|
# Workaround for pnpm/pnpm#5268: pnpm fetch crashes when patchedDependencies
|
||||||
# are configured with nodeLinker: hoisted. The applyPatchToDir function tries
|
# are configured with nodeLinker: hoisted. The applyPatchToDir function tries
|
||||||
# to chdir into node_modules/<pkg> which doesn't exist during fetch (only the
|
# to chdir into node_modules/<pkg> which doesn't exist during fetch (only the
|
||||||
@@ -25,16 +19,14 @@ COPY --parents ./packages/definitions/src ./
|
|||||||
RUN --mount=type=cache,id=pnpm-store,target=/pnpm/store \
|
RUN --mount=type=cache,id=pnpm-store,target=/pnpm/store \
|
||||||
pnpm config set store-dir /pnpm/store && \
|
pnpm config set store-dir /pnpm/store && \
|
||||||
sed -i 's/nodeLinker: hoisted/nodeLinker: isolated/' pnpm-workspace.yaml && \
|
sed -i 's/nodeLinker: hoisted/nodeLinker: isolated/' pnpm-workspace.yaml && \
|
||||||
pnpm fetch --ignore-scripts && \
|
pnpm fetch && \
|
||||||
sed -i 's/nodeLinker: isolated/nodeLinker: hoisted/' pnpm-workspace.yaml
|
sed -i 's/nodeLinker: isolated/nodeLinker: hoisted/' pnpm-workspace.yaml
|
||||||
|
|
||||||
# Install only from the fetched, committed lockfile so local and Docker builds
|
|
||||||
# resolve the same dependency graph. Serial lifecycle builds avoid esbuild's
|
|
||||||
# atomic binary replacement racing across the hoisted workspace (pnpm/pnpm#8200).
|
|
||||||
RUN --mount=type=cache,id=pnpm-store,target=/pnpm/store \
|
|
||||||
npm_config_nodedir=/usr/local pnpm install --recursive --offline --frozen-lockfile --child-concurrency=1
|
|
||||||
|
|
||||||
COPY . .
|
COPY . .
|
||||||
|
# Follow the pnpm fetch pattern from https://pnpm.io/cli/fetch
|
||||||
|
# --frozen-lockfile is omitted as recommended by the pnpm fetch docs
|
||||||
|
RUN --mount=type=cache,id=pnpm-store,target=/pnpm/store \
|
||||||
|
pnpm install --recursive
|
||||||
|
|
||||||
ARG SKIP_ENV_VALIDATION='true'
|
ARG SKIP_ENV_VALIDATION='true'
|
||||||
ARG CI='true'
|
ARG CI='true'
|
||||||
@@ -45,9 +37,7 @@ RUN --mount=type=secret,id=TURBO_API,env=TURBO_API \
|
|||||||
--mount=type=secret,id=TURBO_TEAM,env=TURBO_TEAM \
|
--mount=type=secret,id=TURBO_TEAM,env=TURBO_TEAM \
|
||||||
--mount=type=secret,id=TURBO_TOKEN,env=TURBO_TOKEN \
|
--mount=type=secret,id=TURBO_TOKEN,env=TURBO_TOKEN \
|
||||||
--mount=type=secret,id=TURBO_REMOTE_CACHE_SIGNATURE_KEY,env=TURBO_REMOTE_CACHE_SIGNATURE_KEY \
|
--mount=type=secret,id=TURBO_REMOTE_CACHE_SIGNATURE_KEY,env=TURBO_REMOTE_CACHE_SIGNATURE_KEY \
|
||||||
--mount=type=cache,id=homarr-next-build-${TARGETPLATFORM},target=/app/apps/nextjs/.next/cache,sharing=locked \
|
TURBO_PLATFORM="${TARGETPLATFORM:-linux/amd64}" pnpm build
|
||||||
TURBO_PLATFORM="${TARGETPLATFORM:-linux/amd64}" \
|
|
||||||
pnpm turbo build --filter=@homarr/nextjs... --filter=@homarr/cli
|
|
||||||
|
|
||||||
FROM base AS runner
|
FROM base AS runner
|
||||||
WORKDIR /app
|
WORKDIR /app
|
||||||
@@ -95,6 +85,5 @@ ENV AUTH_PROVIDERS='credentials'
|
|||||||
ENV REDIS_IS_EXTERNAL='false'
|
ENV REDIS_IS_EXTERNAL='false'
|
||||||
ENV NODE_ENV='production'
|
ENV NODE_ENV='production'
|
||||||
|
|
||||||
EXPOSE 7575
|
|
||||||
ENTRYPOINT [ "/app/entrypoint.sh" ]
|
ENTRYPOINT [ "/app/entrypoint.sh" ]
|
||||||
CMD ["sh", "run.sh"]
|
CMD ["sh", "run.sh"]
|
||||||
+2
-2
@@ -55,8 +55,8 @@ pnpm typecheck
|
|||||||
docs/
|
docs/
|
||||||
├── getting-started/ # Installation guides, glossary, prerequisites
|
├── getting-started/ # Installation guides, glossary, prerequisites
|
||||||
├── management/ # Boards, apps, users, integrations, settings, tasks, API
|
├── management/ # Boards, apps, users, integrations, settings, tasks, API
|
||||||
├── integrations/ # 56 integration guides (one folder each)
|
├── integrations/ # 55 integration guides (one folder each)
|
||||||
├── widgets/ # 43 widget guides (one folder each)
|
├── widgets/ # 42 widget guides (one folder each)
|
||||||
├── advanced/ # SSO, env vars, proxy, styling, CLI, development
|
├── advanced/ # SSO, env vars, proxy, styling, CLI, development
|
||||||
└── community/ # FAQ, donate, license, translations, get-in-touch
|
└── community/ # FAQ, donate, license, translations, get-in-touch
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -14,8 +14,8 @@ This guide will help you set up your development environment to start contributi
|
|||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
|
|
||||||
- **Node.js 24.18 or newer**: You can download it from the [official website](https://nodejs.org/).
|
- **Node.js (lts)**: You can download it from the [official website](https://nodejs.org/).
|
||||||
- **Corepack**: Run `corepack enable` so the repository selects its pinned pnpm version.
|
- **pnpm (latest)**: You can install it by running `npm install -g pnpm`.
|
||||||
- **Git**: You can download it from the [official website](https://git-scm.com/).
|
- **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.
|
- **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/).
|
- **Go 1.25+**: Required only for the developer Docker CLI. You can download it from the [official website](https://go.dev/).
|
||||||
@@ -49,10 +49,7 @@ This guide will help you set up your development environment to start contributi
|
|||||||
|
|
||||||
#### During development
|
#### During development
|
||||||
|
|
||||||
- `pnpm dev`: Start the Next.js development server.
|
- `pnpm dev`: Start the 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 -- 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 <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 -- build --pr <number>`: Build a pull request locally from a temporary checkout.
|
||||||
@@ -77,5 +74,4 @@ This guide will help you set up your development environment to start contributi
|
|||||||
|
|
||||||
- `pnpm build`: Build the project for production.
|
- `pnpm build`: Build the project for production.
|
||||||
- `pnpm dev:cli -- build <name>`: Build a `homarr:<name>` image and record its checkout for later rebuilds.
|
- `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.
|
- `docker run -p 7575:7575 -e SECRET_ENCRYPTION_KEY='your_64_character_hex_string' homarr:<name>`: Run the created docker image.
|
||||||
@@ -25,14 +25,15 @@ This is especially useful for [docker secrets](https://docs.docker.com/engine/sw
|
|||||||
Using the `PUID` and `PGID` will require you to set the correct permissions on the mounted volumes and if used the docker socket. See more in the [Running as a different user](/docs/advanced/running-as-different-user) documentation.
|
Using the `PUID` and `PGID` will require you to set the correct permissions on the mounted volumes and if used the docker socket. See more in the [Running as a different user](/docs/advanced/running-as-different-user) documentation.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
| Environment Variable | Description | Possible values | Default |
|
| Environment Variable | Description | Possible values | Default |
|
||||||
| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | ------- |
|
| ------------------------ | ----------- | --------------- | ------- |
|
||||||
| `PUID` | User ID to run the container as | Any valid user ID | `0` |
|
| ``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` |
|
| ``PGID`` | Group ID to run the container as | Any valid group ID | ``0`` |
|
||||||
| `LOG_LEVEL` | Log level to use | `debug` / `info` / `warn` / `error` | `info` |
|
| ``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` |
|
| ``NO_EXTERNAL_CONNECTION`` | Disables some requests that need internet connection | `true` or `false` | `false` |
|
||||||
| `ENABLE_DNS_CACHING` | Enables dns caching. Enabled by default, but if you experience issues with IPv6 or static IPs, see [#4006](https://github.com/homarr-labs/homarr/issues/4006) or disable this flag | `true` or `false` | `true` |
|
| ``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` |
|
|
||||||
|
|
||||||
|
|
||||||
## Authentication
|
## Authentication
|
||||||
|
|
||||||
@@ -42,9 +43,9 @@ See [Single Sign-On](/docs/advanced/single-sign-on) for more informations.
|
|||||||
|
|
||||||
The `SECRET_ENCRYPTION_KEY` is required. If none is specified before starting the container, a random key will be shown in the error message and the container will exit.
|
The `SECRET_ENCRYPTION_KEY` is required. If none is specified before starting the container, a random key will be shown in the error message and the container will exit.
|
||||||
|
|
||||||
| Environment Variable | Description | Possible values | Default |
|
| Environment Variable | Description | Possible values | Default |
|
||||||
| ----------------------- | ------------------------------------------- | ----------------------- | ------- |
|
| ------------------------ | ----------- | --------------- | ------- |
|
||||||
| `SECRET_ENCRYPTION_KEY` | Secret used to encrypt secrets in database. | 64 character hex string | - |
|
| ``SECRET_ENCRYPTION_KEY`` | Secret used to encrypt secrets in database. | 64 character hex string | - |
|
||||||
|
|
||||||
:::info
|
:::info
|
||||||
A random secret can be generated by using the following command: `openssl rand -hex 32`
|
A random secret can be generated by using the following command: `openssl rand -hex 32`
|
||||||
@@ -52,27 +53,27 @@ A random secret can be generated by using the following command: `openssl rand -
|
|||||||
|
|
||||||
## Docker
|
## Docker
|
||||||
|
|
||||||
| Environment Variable | Description | Possible values | Default |
|
| Environment Variable | Description | Possible values | Default |
|
||||||
| --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | ------- |
|
| ------------------------ | ----------- | --------------- | ------- |
|
||||||
| `DOCKER_HOSTNAMES` | Comma-separated list of hostnames to connect to | For example `localhost,docker.example.com` | - |
|
| ``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_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` | - |
|
| ``DOCKER_SOCKET_PATHS`` | Comma-separated list of mounted Docker-compatible socket paths. See the [Docker and Podman integration guide](/docs/integrations/docker) | For example `/var/run/docker.sock,/var/run/podman.sock` | - |
|
||||||
|
|
||||||
## Database
|
## Database
|
||||||
|
| Environment Variable | Description | Possible values | Default |
|
||||||
| 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_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_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_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_HOST` | Database host to connect to. | Any valid database host | - |
|
| ``DB_PORT`` | Database port to connect to. | Any valid database port | - |
|
||||||
| `DB_PORT` | Database port to connect to. | Any valid database port | - |
|
| ``DB_NAME`` | Database name to connect to. | Any valid database name | - |
|
||||||
| `DB_NAME` | Database name to connect to. | Any valid database name | - |
|
| ``DB_USER`` | Database user to connect with. | Any valid database user | - |
|
||||||
| `DB_USER` | Database user to connect with. | Any valid database user | - |
|
| ``DB_PASSWORD`` | Database password to connect with. | Any valid database password | - |
|
||||||
| `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.
|
You can either use the url or host, port, name and credentials combined. The URL will be prioritized over the other values.
|
||||||
|
|
||||||
|
|
||||||
## Redis
|
## Redis
|
||||||
|
|
||||||
By default Redis is running within the installation. (for example in Docker).
|
By default Redis is running within the installation. (for example in Docker).
|
||||||
@@ -82,23 +83,25 @@ However for example for K8s it can be useful to use an external Redis instance.
|
|||||||
External redis is currently not supported with Proxmox Community Scripts
|
External redis is currently not supported with Proxmox Community Scripts
|
||||||
:::
|
:::
|
||||||
|
|
||||||
| Environment Variable | Description | Possible values | Default |
|
| Environment Variable | Description | Possible values | Default |
|
||||||
| ---------------------- | ---------------------------------------------------------------------------------------------------- | ------------------------ | ------- |
|
| ------------------------ | ----------- | --------------- | ------- |
|
||||||
| `REDIS_IS_EXTERNAL` | Whether Redis is running externally. | `true` / `false` | `false` |
|
| `REDIS_IS_EXTERNAL` | Whether Redis is running externally. | `true` / `false` | `false` |
|
||||||
| `REDIS_HOST` | Hostname of the Redis instance. | Any valid hostname | - |
|
| `REDIS_HOST` | Hostname of the Redis instance. | Any valid hostname | - |
|
||||||
| `REDIS_PORT` | Port of the Redis instance. | Any valid port | `6379` |
|
| `REDIS_PORT` | Port of the Redis instance. | Any valid port | `6379` |
|
||||||
| `REDIS_USERNAME` | Username to connect to the Redis instance. | Any valid username | - |
|
| `REDIS_USERNAME` | Username to connect to the Redis instance. | Any valid username | - |
|
||||||
| `REDIS_PASSWORD` | Password to connect to the Redis instance. | Any valid password | - |
|
| `REDIS_PASSWORD` | Password to connect to the Redis instance. | Any valid password | - |
|
||||||
| `REDIS_DATABASE_INDEX` | Select which database of your redis instance should be used. | Any numeric index | - |
|
| `REDIS_DATABASE_INDEX` | Select which database of your redis instance should be used. | Any numeric index | - |
|
||||||
| `REDIS_TLS_CA` | CA certificate for Redis TLS connections. If a certificate is specified the connection will use TLS. | Any valid CA certificate | - |
|
| `REDIS_TLS_CA` | CA certificate for Redis TLS connections. If a certificate is specified the connection will use TLS. | Any valid CA certificate | - |
|
||||||
|
|
||||||
|
|
||||||
## Proxy
|
## Proxy
|
||||||
|
|
||||||
| Environment Variable | Description | Possible values | Default |
|
| Environment Variable | Description | Possible values | Default |
|
||||||
| -------------------- | ------------------------------------------------------------------- | ------------------------- | ------- |
|
| ------------------------ | ----------- | --------------- | ------- |
|
||||||
| `HTTP_PROXY` | HTTP proxy to use | Any valid HTTP proxy URL | - |
|
| ``HTTP_PROXY`` | HTTP proxy to use | Any valid HTTP proxy URL | - |
|
||||||
| `HTTPS_PROXY` | HTTPS proxy to use | Any valid HTTPS proxy URL | - |
|
| ``HTTPS_PROXY`` | HTTPS proxy to use | Any valid HTTPS proxy URL | - |
|
||||||
| `NO_PROXY` | Comma separated list of hosts that should be excluded from proxying | Any valid hostnames | - |
|
| ``NO_PROXY`` | Comma separated list of hosts that should be excluded from proxying | Any valid hostnames | - |
|
||||||
|
|
||||||
|
|
||||||
## Advanced deployments
|
## Advanced deployments
|
||||||
|
|
||||||
@@ -106,6 +109,6 @@ External redis is currently not supported with Proxmox Community Scripts
|
|||||||
The advanced deployments environment variables should only be used if you know what you are doing.
|
The advanced deployments environment variables should only be used if you know what you are doing.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
| Environment Variable | Description |
|
| Environment Variable | Description |
|
||||||
| ------------------------ | -------------------------------------------------- |
|
| ------------------------ | ----------- |
|
||||||
| `DB_MIGRATIONS_DISABLED` | Disable db migrations. For example for helm charts |
|
| ``DB_MIGRATIONS_DISABLED`` | Disable db migrations. For example for helm charts |
|
||||||
@@ -9,19 +9,17 @@ tags:
|
|||||||
---
|
---
|
||||||
|
|
||||||
## Icon picker
|
## Icon picker
|
||||||
|
|
||||||
Icons in Homarr are automatically requested from multiple sources:
|
Icons in Homarr are automatically requested from multiple sources:
|
||||||
|
- [Dashboard Icons](https://dashboardicons.com/) - Our recommended source with over 1888+ curated, high-quality icons
|
||||||
- [Dashboard Icons](https://dashboardicons.com/) - Our recommended source with more than 1,888 curated, high-quality icons
|
- [selfh.st icons](https://github.com/selfhst/icons)
|
||||||
- [selfh.st icons](https://github.com/selfhst/icons)
|
- [Simple icons](https://github.com/simple-icons/simple-icons)
|
||||||
- [Simple icons](https://github.com/simple-icons/simple-icons)
|
- [Tabler icons](https://tabler-icons.io/)
|
||||||
- [Tabler icons](https://tabler-icons.io/)
|
- [Papirus icons](https://github.com/PapirusDevelopmentTeam/papirus-icon-theme)
|
||||||
- [Papirus icons](https://github.com/PapirusDevelopmentTeam/papirus-icon-theme)
|
- [Homelab Svg assets](https://github.com/loganmarchione/homelab-svg-assets)
|
||||||
- [Homelab Svg assets](https://github.com/loganmarchione/homelab-svg-assets)
|
- **Local icons**: automatically fetched from the [medias feature](/docs/management/media/)
|
||||||
- **Local icons**: automatically fetched from the [medias feature](/docs/management/media/)
|
|
||||||
|
|
||||||
Using these icon sources, Homarr provides a total collection of over 11,000 icons at your fingertips.
|
Using these icon sources, Homarr provides a total collection of over 11,000 icons at your fingertips.
|
||||||
The image picker searches this collection after a short typing delay. When a name is available, such as an app or search engine name, the picker uses it as the initial search. Results show your locally uploaded images first, followed by SVG icons and then other image formats.
|
The icon picker is a fast searcher that helps you to find your desired icon simply by entering a search term.
|
||||||
|
|
||||||
### Finding Missing Icons
|
### Finding Missing Icons
|
||||||
|
|
||||||
@@ -31,13 +29,6 @@ If you can't find the icon you're looking for in Homarr's built-in picker, we st
|
|||||||
|
|
||||||
Icons that are high quality and printable ([SVG](https://wikipedia.org/wiki/Scalable_Vector_Graphics)) are marked with a red badge "SVG" at the top right.
|
Icons that are high quality and printable ([SVG](https://wikipedia.org/wiki/Scalable_Vector_Graphics)) are marked with a red badge "SVG" at the top right.
|
||||||
|
|
||||||
You can clear the selected image with the clear button or the usual keyboard shortcut for deleting a line (Command+Backspace on macOS or Control+Backspace on other platforms). Clearing the field does not restore the previous image.
|
|
||||||
|
|
||||||
### Using external icons
|
### Using external icons
|
||||||
|
|
||||||
If you don't find the icon you're looking for on Dashboard Icons or wish to use a different source, you can simply enter a URL that points to an icon.
|
If you don't find the icon you're looking for on Dashboard Icons or wish to use a different source, you can simply enter a URL that points to an icon.
|
||||||
Direct HTTP(S) image URLs are used as entered instead of being searched in the built-in repositories. The picker previews the image and shows whether it loaded successfully. It is important that the URL directly points to the file without any advertisements or elements around it.
|
Direct HTTP(S) image URLs are used as entered instead of being searched in the built-in repositories. It is important that the URL directly points to the file without any advertisements or elements around it.
|
||||||
|
|
||||||
### Uploading a local image
|
|
||||||
|
|
||||||
Users with media upload permission can select **Upload image** next to the field. After the upload finishes, the new local image is selected immediately and is available at the top of future searches.
|
|
||||||
@@ -47,6 +47,7 @@ services:
|
|||||||
traefik.http.routers.homarr.rule: Host(`your.internal.dns.address.here.com`)
|
traefik.http.routers.homarr.rule: Host(`your.internal.dns.address.here.com`)
|
||||||
traefik.http.routers.homarr.entrypoints: websecure
|
traefik.http.routers.homarr.entrypoints: websecure
|
||||||
traefik.http.routers.homarr-secure.app: homarr
|
traefik.http.routers.homarr-secure.app: homarr
|
||||||
|
traefik.http.apps.homarr.loadbalancer.server.port: 7575
|
||||||
|
|
||||||
networks:
|
networks:
|
||||||
proxy:
|
proxy:
|
||||||
|
|||||||
@@ -11,12 +11,6 @@ tags:
|
|||||||
import Link from '@docusaurus/Link';
|
import Link from '@docusaurus/Link';
|
||||||
import { IconArrowRight } from '@tabler/icons-react';
|
import { IconArrowRight } from '@tabler/icons-react';
|
||||||
|
|
||||||
:::info Homarr v2 beta is available
|
|
||||||
|
|
||||||
We've been working on Homarr's v2 update for a while now. There is no fixed release date yet, it will be ready when it's ready. We **need your help** and feedback to help us become confident enough to release it for everyone. Read [what is new](https://v2.preview.homarr.dev/blog/2026/09/03/homarr-2.0), browse the [v2 documentation](https://v2.preview.homarr.dev/docs/getting-started/) and [Workshop](https://v2.preview.homarr.dev/workshop), or try the [hosted preview](https://app-v2.preview.homarr.dev). If anything breaks or does not feel right, [tell us on Discord](https://discord.com/invite/aCsmEV5RgA) in the dedicated v2 channel for the fastest response, or [open a dedicated GitHub issue](https://github.com/homarr-labs/homarr/issues/new?template=v2_beta_feedback.yml). SQLite administrators can download a full backup directly from the beta announcement before changing images.
|
|
||||||
|
|
||||||
:::
|
|
||||||
|
|
||||||
Before you try to install Homarr, please review if your device meets the requirements.
|
Before you try to install Homarr, please review if your device meets the requirements.
|
||||||
Installing on an unsupported device may lead to unstable behaviour and no support will be provided.
|
Installing on an unsupported device may lead to unstable behaviour and no support will be provided.
|
||||||
|
|
||||||
|
|||||||
@@ -2,9 +2,9 @@
|
|||||||
|
|
||||||
<img src="https://raw.githubusercontent.com/homarr-labs/charts/refs/heads/main/charts/homarr/icon.svg" align="right" width="92" alt="homarr logo">
|
<img src="https://raw.githubusercontent.com/homarr-labs/charts/refs/heads/main/charts/homarr/icon.svg" align="right" width="92" alt="homarr logo">
|
||||||
|
|
||||||

|

|
||||||

|

|
||||||

|

|
||||||
|
|
||||||
A Helm chart to deploy homarr for Kubernetes
|
A Helm chart to deploy homarr for Kubernetes
|
||||||
|
|
||||||
@@ -429,7 +429,7 @@ All available values are listed on the [artifacthub](https://artifacthub.io/pack
|
|||||||
| httproute.rules[0].matches[0].path.value | string | `"/"` | Path value to match |
|
| httproute.rules[0].matches[0].path.value | string | `"/"` | Path value to match |
|
||||||
| image.pullPolicy | string | `"IfNotPresent"` | Image pull policy |
|
| image.pullPolicy | string | `"IfNotPresent"` | Image pull policy |
|
||||||
| image.repository | string | `"ghcr.io/homarr-labs/homarr"` | Image repository |
|
| image.repository | string | `"ghcr.io/homarr-labs/homarr"` | Image repository |
|
||||||
| image.tag | string | `"v1.76.1"` | Overrides the image tag whose default is the chart appVersion |
|
| image.tag | string | `"v1.73.0"` | Overrides the image tag whose default is the chart appVersion |
|
||||||
| imagePullSecrets | list | `[]` | Secrets for Docker registry |
|
| imagePullSecrets | list | `[]` | Secrets for Docker registry |
|
||||||
| ingress.annotations | object | `{}` | Ingress annotations |
|
| ingress.annotations | object | `{}` | Ingress annotations |
|
||||||
| ingress.enabled | bool | `false` | Enable ingress |
|
| ingress.enabled | bool | `false` | Enable ingress |
|
||||||
|
|||||||
@@ -27,8 +27,6 @@ import Alert from '@theme/Admonition';
|
|||||||
]}
|
]}
|
||||||
/>
|
/>
|
||||||
|
|
||||||
The storage values shown by these widgets come from each pool's root ZFS dataset, so they already account for RAIDZ parity overhead and dataset limits and match what `zfs list` and the TrueNAS web interface report. When a pool cannot report its dataset space, Homarr falls back to the pool's physical values, which read higher on RAIDZ.
|
|
||||||
|
|
||||||
### Adding the integration
|
### Adding the integration
|
||||||
<AddingIntegration />
|
<AddingIntegration />
|
||||||
|
|
||||||
|
|||||||
@@ -1,48 +0,0 @@
|
|||||||
---
|
|
||||||
title: "What's Up Docker"
|
|
||||||
description: "What's Up Docker (WUD) watches your Docker containers and reports which ones have newer image versions available."
|
|
||||||
hide_title: true
|
|
||||||
---
|
|
||||||
|
|
||||||
import { IntegrationHeader } from "@site/src/components/integrations/header";
|
|
||||||
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
|
|
||||||
import { AddingIntegration } from "@site/src/components/integrations/adding";
|
|
||||||
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
|
|
||||||
import { wudIntegration } from ".";
|
|
||||||
import { wudWidget } from "@site/docs/widgets/whats-up-docker";
|
|
||||||
|
|
||||||
<IntegrationHeader integration={wudIntegration} categories={["Health Monitoring"]} />
|
|
||||||
|
|
||||||
The What's Up Docker integration lets Homarr connect to your [WUD](https://github.com/getwud/wud) instance so you can see how many of your watched containers have image updates available directly from your dashboard.
|
|
||||||
|
|
||||||
### Widgets & Capabilities
|
|
||||||
|
|
||||||
<IntegrationCapabilites items={[{ widget: wudWidget }]} />
|
|
||||||
|
|
||||||
### Adding the integration
|
|
||||||
|
|
||||||
<AddingIntegration />
|
|
||||||
|
|
||||||
:::info URL configuration
|
|
||||||
Use the root URL of your WUD instance, for example `https://wud.example.com`. Homarr calls the `/api/app` and `/api/containers` endpoints under that URL automatically.
|
|
||||||
:::
|
|
||||||
|
|
||||||
### Secrets
|
|
||||||
|
|
||||||
WUD does not require authentication by default. If your instance is protected with [Basic Authentication](https://github.com/getwud/wud/blob/main/docs/configuration/authentications/basic/README.md), you can provide a username and password.
|
|
||||||
|
|
||||||
<IntegrationSecrets
|
|
||||||
secrets={[
|
|
||||||
{
|
|
||||||
credentials: [],
|
|
||||||
steps: [],
|
|
||||||
},
|
|
||||||
{
|
|
||||||
credentials: ["username", "password"],
|
|
||||||
steps: [
|
|
||||||
"Open your WUD instance's configuration and configure a WUD_AUTH_BASIC_* user as described in the WUD documentation",
|
|
||||||
"Enter that username and password in Homarr — Basic authentication is handled automatically",
|
|
||||||
],
|
|
||||||
},
|
|
||||||
]}
|
|
||||||
/>
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
import { IntegrationDefinition } from "@site/src/types";
|
|
||||||
|
|
||||||
export const wudIntegration: IntegrationDefinition = {
|
|
||||||
name: "What's Up Docker",
|
|
||||||
description:
|
|
||||||
"What's Up Docker (WUD) watches your Docker containers and reports which ones have newer image versions available.",
|
|
||||||
iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/whats-up-docker.svg",
|
|
||||||
path: "../../integrations/whats-up-docker",
|
|
||||||
};
|
|
||||||
@@ -28,7 +28,7 @@ The name must be at least one character long and can be chosen freely.
|
|||||||
### Icon URL
|
### Icon URL
|
||||||
|
|
||||||
This is the URL to the icon that will be displayed on the app widget.
|
This is the URL to the icon that will be displayed on the app widget.
|
||||||
You can paste a direct HTTP(S) URL to an image, search the included icon repositories by name, or upload a local file through the upload button. The app name is pre-filled as the initial library search when no image is selected. Local images appear first, followed by SVG icons and other formats. Direct image URLs are previewed, used as entered, and are not searched in the icon repositories.
|
You can paste a direct HTTP(S) URL to an image, search the included icon repositories by name, or upload a local file through the upload button. Direct image URLs are used as entered and are not searched in the icon repositories.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
@@ -40,14 +40,11 @@ An optional description that can be shown as tooltip on the app widget.
|
|||||||
|
|
||||||
The URL to the website you want to link to. Clicking on the app widget or bookmark will open this URL.
|
The URL to the website you want to link to. Clicking on the app widget or bookmark will open this URL.
|
||||||
|
|
||||||
You can also use custom URI schemes such as `vscode://file/path`, `microsoft-edge:https://example.com`, or `myapp://open` to link to local applications or third-party programs. We trust that you know what you are doing — only `javascript:` URIs are blocked for security reasons.
|
|
||||||
|
|
||||||
### Ping URL
|
### Ping URL
|
||||||
|
|
||||||
When you want to use another url for the simple status check you can set it here.
|
When you want to use another url for the simple status check you can set it here.
|
||||||
This will allow you to set a different URL for the ping than the URL that is opened when clicking on the app widget.
|
This will allow you to set a different URL for the ping than the URL that is opened when clicking on the app widget.
|
||||||
It's useful when you want to ping the service internally for example with a custom ip but open the website externally.
|
It's useful when you want to ping the service internally for example with a custom ip but open the website externally.
|
||||||
Note that the ping URL only accepts `http://` and `https://` URLs — custom URI schemes are not supported for pings.
|
|
||||||
|
|
||||||
## List of apps
|
## List of apps
|
||||||
|
|
||||||
|
|||||||
@@ -9,11 +9,11 @@ tags:
|
|||||||
- Layout
|
- Layout
|
||||||
---
|
---
|
||||||
|
|
||||||
import iconColorImage from "./img/icon-color.png";
|
import iconColorImage from './img/icon-color.png'
|
||||||
import itemRadiusImage from "./img/item-radius.png";
|
import itemRadiusImage from './img/item-radius.png'
|
||||||
import layoutLargeImage from "./img/layout-large.png";
|
import layoutLargeImage from './img/layout-large.png'
|
||||||
import layoutMediumImage from "./img/layout-medium.png";
|
import layoutMediumImage from './img/layout-medium.png'
|
||||||
import layoutSmallImage from "./img/layout-small.png";
|
import layoutSmallImage from './img/layout-small.png'
|
||||||
|
|
||||||
Each dashboard is called a "board".
|
Each dashboard is called a "board".
|
||||||
You can create as many boards as you want.
|
You can create as many boards as you want.
|
||||||
@@ -24,29 +24,24 @@ Other boards can be viewed by direct links (e.g. my-homarr.com/board/smart-home)
|
|||||||
Names of boards must be unique because this will be used in the URL to load the desired board.
|
Names of boards must be unique because this will be used in the URL to load the desired board.
|
||||||
|
|
||||||
## Create a new board
|
## Create a new board
|
||||||
|
|
||||||
When creating a board, the availability of the board name will be checked for you.
|
When creating a board, the availability of the board name will be checked for you.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
### Name
|
### Name
|
||||||
|
|
||||||
The name must not include any special characters and must be at least one character long.
|
The name must not include any special characters and must be at least one character long.
|
||||||
Underscores and hyphen-minus are allowed.
|
Underscores and hyphen-minus are allowed.
|
||||||
|
|
||||||
### Column count
|
### Column count
|
||||||
|
Homarr has a complex drag and drop system that can be used from the browser.
|
||||||
Homarr has a complex drag-and-drop system that can be used from the browser.
|
|
||||||
The column count defines how many horizontal columns are available to drag and drop elements to.
|
The column count defines how many horizontal columns are available to drag and drop elements to.
|
||||||
|
|
||||||
### Public
|
### Public
|
||||||
|
|
||||||
This will enable public access for everyone - regardless of whether they are logged in or not.
|
This will enable public access for everyone - regardless of whether they are logged in or not.
|
||||||
This can be really useful if you want to have public boards in your company or for family and friends.
|
This can be really useful if you want to have public boards in your company or for family and fiends.
|
||||||
Modifications for public boards must be allowed explicitly using user groups and their permissions.
|
Modifications for public boards must be allowed explicitly using user groups and their permissions.
|
||||||
|
|
||||||
## Board settings
|
## Board settings
|
||||||
|
|
||||||
You navigate to the board settings by clicking on these three dots:
|
You navigate to the board settings by clicking on these three dots:
|
||||||
|
|
||||||

|

|
||||||
@@ -55,12 +50,8 @@ Alternatively, you can also navigate from the board page itself using the cog ic
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
All board settings are edited on a single page. Click the **Save changes** button in the save bar at the bottom to apply them, or **Discard** to restore the last saved values. The save bar only appears when you have unsaved changes. Access control and the Danger zone are independent sections and are applied immediately.
|
|
||||||
|
|
||||||
### General
|
### General
|
||||||
|
|
||||||
#### Page title
|
#### Page title
|
||||||
|
|
||||||
This is the title that will be visible at the top left in the navigation bar:
|
This is the title that will be visible at the top left in the navigation bar:
|
||||||
|
|
||||||

|

|
||||||
@@ -68,7 +59,6 @@ This is the title that will be visible at the top left in the navigation bar:
|
|||||||
This field is optional and Homarr will fall back to "Homarr" if nothing is set.
|
This field is optional and Homarr will fall back to "Homarr" if nothing is set.
|
||||||
|
|
||||||
#### Meta title
|
#### Meta title
|
||||||
|
|
||||||
This is the secondary title of the page that is not directly visible in the page itself.
|
This is the secondary title of the page that is not directly visible in the page itself.
|
||||||
Browser will use it to set the title of tabs:
|
Browser will use it to set the title of tabs:
|
||||||
|
|
||||||
@@ -77,12 +67,10 @@ Browser will use it to set the title of tabs:
|
|||||||
Homarr will fall back to the board name and a suffix if nothing is set.
|
Homarr will fall back to the board name and a suffix if nothing is set.
|
||||||
|
|
||||||
#### Logo image URL
|
#### Logo image URL
|
||||||
|
|
||||||
This is the URL that is used for the image at the top left.
|
This is the URL that is used for the image at the top left.
|
||||||
Homarr will fall back to the Homarr logo if nothing is set.
|
Homarr will fall back to the Homarr logo if nothing is set.
|
||||||
|
|
||||||
#### Favicon image URL
|
#### Favicon image URL
|
||||||
|
|
||||||
This is the URL that is used for the favicon in the tab title.
|
This is the URL that is used for the favicon in the tab title.
|
||||||
Homarr will fall back to the Homarr logo if nothing is set.
|
Homarr will fall back to the Homarr logo if nothing is set.
|
||||||
|
|
||||||
@@ -107,64 +95,50 @@ Amount of columns for this layout. Defines how many items can be placed in a row
|
|||||||
#### Breakpoint
|
#### Breakpoint
|
||||||
|
|
||||||
Minimum width of the screen where the layout will be used.
|
Minimum width of the screen where the layout will be used.
|
||||||
Once the minimum of the next layout is reached the layout will change.
|
Once the minmum of the next layout is reached the layout will change.
|
||||||
|
|
||||||
#### Preview
|
#### Preview
|
||||||
|
|
||||||
<img src={layoutSmallImage} height={256} />
|
<img src={layoutSmallImage} height={256} />
|
||||||
<img src={layoutMediumImage} height={256} />
|
<img src={layoutMediumImage} height={256} />
|
||||||
<img src={layoutLargeImage} height={256} />
|
<img src={layoutLargeImage} height={256} />
|
||||||
|
|
||||||
### Background
|
### Background
|
||||||
|
|
||||||
#### Background image URL
|
#### Background image URL
|
||||||
|
|
||||||
Homarr can display a background image behind apps and widgets.
|
Homarr can display a background image behind apps and widgets.
|
||||||
This URL can be used to define what image should be shown.
|
This URL can be used to define what image should be shown.
|
||||||
|
|
||||||
#### Background image attachment
|
#### Background image attachment
|
||||||
|
|
||||||
This defines whether the background should move when the user scrolls.
|
This defines whether the background should move when the user scrolls.
|
||||||
|
|
||||||
#### Background image size
|
#### Background image size
|
||||||
|
|
||||||
This defines whether the background should cover the entire page (and possibly be cropped) or never be cropped but may not cover the entire page.
|
This defines whether the background should cover the entire page (and possibly be cropped) or never be cropped but may not cover the entire page.
|
||||||
|
|
||||||
#### Background image repeat
|
#### Background image repeat
|
||||||
|
|
||||||
This defines whether the background should be repeated if it cannot cover the entire page.
|
This defines whether the background should be repeated if it cannot cover the entire page.
|
||||||
This option can be useful if you have patterns that can be repeated easily (e.g. patterns):
|
This option can be useful if you have patterns that can be repeated easily (e.g. patterns):
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
### Appearance
|
### Appearance
|
||||||
|
|
||||||
#### Primary color
|
#### Primary color
|
||||||
|
|
||||||
Color that can be chosen freely to give accents to active elements.
|
Color that can be chosen freely to give accents to active elements.
|
||||||
|
|
||||||
#### Secondary color
|
#### Secondary color
|
||||||
|
|
||||||
Color that can be chosen freely to give accents.
|
Color that can be chosen freely to give accents.
|
||||||
|
|
||||||
#### Opacity
|
#### Opacity
|
||||||
|
|
||||||
Opacity of the colors.
|
Opacity of the colors.
|
||||||
|
|
||||||
#### Icon color
|
#### Icon color
|
||||||
|
|
||||||
Change the color of your bookmark / app icons.
|
Change the color of your bookmark / app icons.
|
||||||
|
|
||||||
<img src={iconColorImage} height={100} />
|
<img src={iconColorImage} height={100} />
|
||||||
|
|
||||||
#### Item radius
|
#### Item radius
|
||||||
|
|
||||||
Change the radius of your items / categories.
|
Change the radius of your items / categories.
|
||||||
|
|
||||||
<img src={itemRadiusImage} height={100} />
|
<img src={itemRadiusImage} height={100} />
|
||||||
|
|
||||||
|
|
||||||
### Custom CSS
|
### Custom CSS
|
||||||
|
|
||||||
This is the field where you can enter custom CSS.
|
This is the field where you can enter custom CSS.
|
||||||
The styling will only be applied on the respective board page.
|
The styling will only be applied on the respective board page.
|
||||||
|
|
||||||
@@ -173,16 +147,14 @@ The styling will only be applied on the respective board page.
|
|||||||
### Behaviour
|
### Behaviour
|
||||||
|
|
||||||
#### Disable app status
|
#### Disable app status
|
||||||
|
|
||||||
This will disable the status check for apps.
|
This will disable the status check for apps.
|
||||||
|
|
||||||
### Access control
|
### Access control
|
||||||
|
|
||||||
With the access control, you can permit a single user or a group to your board.
|
With the access control, you can permit a single user or a group to your board.
|
||||||
The users and groups can have one of these three levels of access:
|
The users and groups can have one of these three levels of access:
|
||||||
|
|
||||||
| **Permission Level** | View board | Edit mode | Settings | Danger zone (eg. delete) |
|
| **Permission Level** | View board | Edit mode | Settings | Danger zone (eg. delete) |
|
||||||
| -------------------- | ---------- | --------- | -------- | ------------------------ |
|
|----------------------|------------|-----------|----------|--------------------------|
|
||||||
| View board | X | | | |
|
| View board | X | | | |
|
||||||
| Modify board | X | X | X | |
|
| Modify board | X | X | X | |
|
||||||
| Full access | X | X | X | X |
|
| Full access | X | X | X | X |
|
||||||
@@ -201,27 +173,22 @@ After editing permissions, the save button below the table must be pressed.
|
|||||||
Otherwise, all changes will be discarded.
|
Otherwise, all changes will be discarded.
|
||||||
|
|
||||||
### Danger zone
|
### Danger zone
|
||||||
|
|
||||||
#### Rename
|
#### Rename
|
||||||
|
|
||||||
Renaming a board will break all existing links to it permanently with no redirect.
|
Renaming a board will break all existing links to it permanently with no redirect.
|
||||||
|
|
||||||
#### Board visibility
|
#### Board visibility
|
||||||
|
|
||||||
By default, boards will be private. This means only authenticated users that are authorized have access.
|
By default, boards will be private. This means only authenticated users that are authorized have access.
|
||||||
Making a board public will expose it to everyone - including unauthenticated users.
|
Making a board public will expose it to everyone - including unauthenticated users.
|
||||||
|
|
||||||
#### Delete
|
#### Delete
|
||||||
|
|
||||||
This will permanently delete the board.
|
This will permanently delete the board.
|
||||||
This action is irreversible and cannot be undone.
|
This action is irreversible and cannot be undone.
|
||||||
|
|
||||||
## Delete boards
|
## Delete boards
|
||||||
|
|
||||||
The deletion of boards is permanent and cannot be undone.
|
The deletion of boards is permanent and cannot be undone.
|
||||||
There are two ways to delete a board:
|
There are two ways to delete a board:
|
||||||
|
|
||||||
- Navigate to the settings of your board, open the "Danger zone" section and click on the "delete this board" button.
|
- Navigate to the settings of your board, open the "Danger zone" dropdown and click on the "delete this board" button.
|
||||||
- Navigate to the list of boards in the management pages, click the three dots and click on "delete permanently".
|
- Navigate to the list of boards in the management pages, click the three dots and click on "delete permanently".
|
||||||
|
|
||||||
Both actions will execute the same deletion process.
|
Both actions will execute the same deletion process.
|
||||||
@@ -239,51 +206,47 @@ You can duplicate a board by clicking on the three dots in the list of boards an
|
|||||||

|

|
||||||
|
|
||||||
## Setting boards as your home board
|
## Setting boards as your home board
|
||||||
|
|
||||||
The home board is the dashboard, that will be shown at the root path of Homarr or if no board name was passed in the URL.
|
The home board is the dashboard, that will be shown at the root path of Homarr or if no board name was passed in the URL.
|
||||||
All the following paths will lead to the home board:
|
All the following paths will lead to the home board:
|
||||||
|
- ``my-homarr.com``
|
||||||
- `my-homarr.com`
|
- ``my-homarr.com/boards``
|
||||||
- `my-homarr.com/boards`
|
|
||||||
|
|
||||||
Your home board will have a special small badge at the top right in the list of boards:
|
Your home board will have a special small badge at the top right in the list of boards:
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
### For yourself
|
### For yourself
|
||||||
|
|
||||||
To set the home board yourself, the easiest option is to set it directly in the list of boards:
|
To set the home board yourself, the easiest option is to set it directly in the list of boards:
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
Alternatively, you can also define it via your user profile:
|
Alternatively, you can also define it via your user profile:
|
||||||
|
|
||||||
1. Click on your user profile at the top right
|
1. Click on your user profile at the top right
|
||||||
2. Click on `Your preferences`
|
2. Click on ``Your preferences``
|
||||||
3. Change the home board in the `home board` dropdown and click on `Save`.
|
3. Change the home board in the ``home board`` dropdown and click on ``Save``.
|
||||||
|
|
||||||
### For other users
|
### For other users
|
||||||
|
|
||||||
1. Navigate to the users: `Management` > `Users` > `Manage`
|
1. Navigate to the users: ``Management`` > ``Users`` > ``Manage``
|
||||||
2. Click on the username of the user that you want to adjust
|
2. Click on the username of the user that you want to adjust
|
||||||
3. Select the desired home board via the dropdown and click on `Save` \
|
3. Select the desired home board via the dropdown and click on ``Save`` \
|
||||||

|

|
||||||
|
|
||||||
### For user groups
|
### For user groups
|
||||||
|
|
||||||
1. Navigate to the user groups: `Management` > `Users` > `Groups` > `Manage`
|
1. Navigate to the user groups: ``Management`` > ``Users`` > ``Groups`` > ``Manage``
|
||||||
2. Go to tab `Settings`
|
2. Go to tab ``Settings``
|
||||||
3. Select the desired home board via the dropdown and click on `Save` \
|
3. Select the desired home board via the dropdown and click on ``Save`` \
|
||||||

|

|
||||||
|
|
||||||
### For whole server
|
### For whole server
|
||||||
|
|
||||||
You can also set a global home board that will be used for all users that have not set a home board themselves.
|
You can also set a global home board that will be used for all users that have not set a home board themselves.
|
||||||
It will also be used for anonymous users.
|
It will also be used for anonymous users.
|
||||||
|
|
||||||
1. Navigate to the settings: `Management` > `Settings` > `Boards`
|
1. Navigate to the settings: ``Management`` > ``Settings`` > ``Boards``
|
||||||
2. Select the desired home board via the dropdown and click on `Save` \
|
2. Select the desired home board via the dropdown and click on ``Save`` \
|
||||||

|

|
||||||
|
|
||||||
:::note
|
:::note
|
||||||
For the global home board you can only select boards that are public.
|
For the global home board you can only select boards that are public.
|
||||||
|
|||||||
@@ -52,21 +52,14 @@ The certificates are stored in the `/appdata/trusted-certificates` directory whi
|
|||||||
This means you can automate the update of the certificates by simply replacing or adding a new file in the directory.
|
This means you can automate the update of the certificates by simply replacing or adding a new file in the directory.
|
||||||
|
|
||||||
## Obtaining certificates
|
## Obtaining certificates
|
||||||
|
|
||||||
Every integration has its own way of obtaining certificates.
|
Every integration has its own way of obtaining certificates.
|
||||||
Generally it is recommended to search for the documentation of the integration you are using.
|
Generally it is recommended to search for the documentation of the integration you are using.
|
||||||
Most of the time you can find the certificate in the file system of the integration.
|
Most of the time you can find the certificate in the file system of the integration.
|
||||||
The certificate file needs to be uploaded to Homarr. To first get the file on your computer you can either:
|
|
||||||
- use `scp user@host:/path/to/file ./certificate.pem`
|
|
||||||
- use `cat /path/to/file` to print the certificate. Then recreate the file on your machine.
|
|
||||||
|
|
||||||
Below you can find instructions for some of the integrations.
|
Below you can find instructions for some of the integrations.
|
||||||
|
|
||||||
### Pi-hole (v6)
|
### Pi-hole (v6)
|
||||||
Since version 6 of Pi-hole, the web interface can be accessed through HTTPS.
|
|
||||||
The certificate can be found in the path `/etc/pihole/tls_ca.crt`.
|
|
||||||
You can find more details regarding SSL / TLS for Pi-hole [here](https://docs.pi-hole.net/api/tls/).
|
|
||||||
|
|
||||||
### Proxmox
|
Since version 6 of Pi-hole, the web interface can be accessed through HTTPS.
|
||||||
By default, Proxmox VE uses a node certificate signed by the cluster. You only need to configure Homarr with the certificate of a single node.
|
The certificate can be found in the path `/etc/pihole/tls_ca.crt`. To add the certificate, this file needs to be copied and uploaded to Homarr.
|
||||||
The certificate can be found in any node on the path `/etc/pve/pve-root-ca.pem`.
|
You can find more details regarding SSL / TLS for Pi-hole [here](https://docs.pi-hole.net/api/tls/).
|
||||||
You can learn more about certificate management in Proxmox [here](https://pve.proxmox.com/wiki/Certificate_Management).
|
|
||||||
@@ -9,127 +9,97 @@ tags:
|
|||||||
---
|
---
|
||||||
|
|
||||||
# Settings
|
# Settings
|
||||||
|
The settings page has a few options that will be applied to the entire Homarr application.
|
||||||
The settings page applies options to the whole Homarr application.
|
They may require a full page reload for changes to apply.
|
||||||
Some changes need a full page reload before they take effect.
|
|
||||||
|
|
||||||
All changes are collected in a single form. Click the **Save changes** button in the save bar at the bottom of the page to apply them. The save bar only appears when you have unsaved changes, and the **Discard** button reverts your changes.
|
|
||||||
|
|
||||||
## Analytics
|
## Analytics
|
||||||
|
By default, Homarr is collecting anonymous analytics to identify issues and prioritize bugfixes and improvements.
|
||||||
|
The data is never shared with any third-parties and is fully GDPR & CCPA compliant.
|
||||||
|
The software being used is [Umami Analytics](https://umami.is/) which is fully open source.
|
||||||
|
The main server software can be found [here](https://github.com/umami-software/umami) and [this node library](https://github.com/umami-software/node) to perform server side calls to the API.
|
||||||
|
|
||||||
Homarr uses [PostHog](https://posthog.com/) to collect anonymous usage data.
|
A full list of the collected data by default can be found here: https://umami.is/docs/metric-definitions.
|
||||||
We collect this data to see what features people ACTUALLY use.
|
|
||||||
We use this data to decide where we spend our development time.
|
|
||||||
|
|
||||||
We do not sell the data. We do not share the data with third parties.
|
We understand that you might not want Homarr to communicate with our services.
|
||||||
The data does not contain personal information and does not identify you or your installation.
|
By unchecking the ``Send anonymous analytics`` checkbox and reloading the full page, all communication by Umami will be disabled and no data will be collected.
|
||||||
|
If you are paranoid, you can permanently block ``umami.homarr.dev`` from your DNS / firewall.
|
||||||
|
|
||||||
Homarr sends the data to our own PostHog server at `https://hog.homarr.dev`.
|
Additionally, you opt in to more data collection to help us provide more useful data.
|
||||||
The server sends the data once a week and when the server starts.
|
|
||||||
|
|
||||||
### What we collect
|
### Integration data
|
||||||
|
Enabling this optional data will send the types of integrations (e.g. SABnzbd, Sonarr, ...) and how many you have configured of them.
|
||||||
|
This will not include any URLs, names, secrets, errors and others. This is disabled by default.
|
||||||
|
|
||||||
Homarr collects technical data about your installation:
|
### Widget data
|
||||||
|
Enabling this optional data will send the types of widgets (e.g. downloads, media streams, iframe, ...) and how many you have configured of them.
|
||||||
|
This will not include any URLs, names, secrets, errors and others. This is disabled by default.
|
||||||
|
|
||||||
- Your Homarr version
|
### Users data
|
||||||
- Your database type (SQLite, MySQL, or PostgreSQL)
|
Enabling this optional data will send the count of users and whether you activated SSO.
|
||||||
- Whether Docker or Kubernetes is enabled
|
This will not include any usernames, passwords, emails, URLs, authentication flows or client IDs.
|
||||||
- Your enabled authentication providers
|
This is disabled by default.
|
||||||
- Your operating system and CPU architecture
|
|
||||||
- Your default language
|
|
||||||
- The number of boards, apps, sections, layouts, users, groups, search engines, icon repositories, cron jobs, API keys, invites, sessions, and accounts
|
|
||||||
- The integration types you use and how many you have of each (for example, Sonarr or SABnzbd)
|
|
||||||
- The widget types you use and how many you have of each
|
|
||||||
|
|
||||||
Homarr does NOT collect:
|
|
||||||
|
|
||||||
- URLs
|
|
||||||
- Names
|
|
||||||
- Usernames, emails, or passwords
|
|
||||||
- Integration secrets or API keys
|
|
||||||
- Error messages or logs
|
|
||||||
- Any data that can identify you
|
|
||||||
|
|
||||||
Each installation gets a random ID. We use this ID only to count unique installations. We cannot use this ID to identify you.
|
|
||||||
|
|
||||||
Homarr does not use cookies for analytics. Homarr does not track page views automatically. Homarr only sends the data listed above.
|
|
||||||
|
|
||||||
### Disable analytics
|
|
||||||
|
|
||||||
Analytics are enabled by default. To disable analytics:
|
|
||||||
|
|
||||||
1. Open the Settings page.
|
|
||||||
2. Uncheck the "Help us improve Homarr" checkbox.
|
|
||||||
3. Reload the full page.
|
|
||||||
|
|
||||||
When analytics are disabled, Homarr does not send any data to PostHog.
|
|
||||||
|
|
||||||
You can also set the `NO_EXTERNAL_CONNECTION` environment variable to `true`. This stops all external requests, including analytics. See the [environment variables](/docs/advanced/environment-variables) page for more information.
|
|
||||||
|
|
||||||
You can block `hog.homarr.dev` in your DNS or firewall. Homarr cannot send data when this address is blocked.
|
|
||||||
|
|
||||||
## Search Engine Optimization (SEO)
|
## Search Engine Optimization (SEO)
|
||||||
|
Big companies [like Google, Microsoft, Baidu and Yandex](https://de.wikipedia.org/wiki/Web-Index) will use [web crawlers](https://de.wikipedia.org/wiki/Webcrawler) to index the Internet for new websites & pages.
|
||||||
Search engines use web crawlers to index websites. This can cause unwanted traffic to your dashboard.
|
This is desirable in many cases (for example when selling products in an online shop) but can lead to unwanted traffic and attention to your personal dashboard.
|
||||||
Homarr asks crawlers to not index your instance by default. Use these settings to change this request.
|
Homarr is requesting the crawlers to not index Homarr instances by default for this reason.
|
||||||
|
If you use Homarr as a public website and want it to be searchable on these search engines, you can disable these settings.
|
||||||
Homarr cannot control what the crawlers do. A crawler can ignore the request. Your website can still appear in an index.
|
Please note that Homarr doesn't have control over what the crawlers do; it is a mere request to them to not perform these actions but will not guarantee that your website doesn't land on some index.
|
||||||
|
|
||||||
### No index
|
### No index
|
||||||
|
This will ask crawlers to not index your Homarr instance on any indexes.
|
||||||
This setting asks crawlers to not index your instance.
|
It is up to the crawler to properly respect this request.
|
||||||
This setting is enabled by default. Disable this setting to allow indexing.
|
By default, this setting is enabled. Disabling it will allow indexing.
|
||||||
|
|
||||||
### No follow
|
### No follow
|
||||||
|
If indexing is allowed, crawlers will also attempt to follow any links on your page to further "discover" new parts of the Internet and on your website.
|
||||||
Crawlers follow links to discover new pages.
|
By default, this setting is enabled and will ask crawlers to not follow any links.
|
||||||
This setting asks crawlers to not follow links. This setting is enabled by default.
|
Crawler of different companies may behave differently when indexing is prohibited and following is allowed.
|
||||||
Crawler behavior can differ between search engines.
|
|
||||||
|
|
||||||
### No translate
|
### No translate
|
||||||
|
Google and Chrome on Android will prompt users to translate pages that are not in their device language.
|
||||||
Some browsers offer to translate pages.
|
This can lead to some shifting and can be undesired in some cases. By enabling this,
|
||||||
This setting asks crawlers to not offer translation. Some browsers ignore this setting.
|
you ask crawlers to never translate and never prompt users for translation.
|
||||||
|
It should be noted that some browsers will ignore this and translate regardless.
|
||||||
|
|
||||||
### No site links search box
|
### No site links search box
|
||||||
|
This setting is exclusive to Google.
|
||||||
This setting applies to Google only.
|
[Google will create a box below your domain](https://developers.google.com/search/docs/appearance/structured-data/sitelinks-searchbox) that lists the paths that were discovered by the "folowing".
|
||||||
Google can show a search box below your domain.
|
The user can search them directly in Google.
|
||||||
This setting asks Google to not show this box. This setting is disabled by default.
|
You can ask the crawlers to not allow searches by enabling this setting.
|
||||||
|
This setting is disabled by default.
|
||||||
|
|
||||||
## Boards
|
## Boards
|
||||||
|
|
||||||
### Global home board
|
### Global home board
|
||||||
|
You can set a global home board that will be used for all users that have not set a home board themselves.
|
||||||
You can set a global home board.
|
It will also be used for anonymous users.
|
||||||
This board is the fallback for users without their own home board. It is also the fallback for anonymous users.
|
Note that the board must be public to be used as a global home board.
|
||||||
The board must be public.
|
|
||||||
|
|
||||||
### Global mobile board
|
### Global mobile board
|
||||||
|
|
||||||
You can set a global mobile board.
|
You can set a global mobile board. It will be shown instead of the global home board on mobile devices that can be detected by Homarr. (Using the User-Agent header).
|
||||||
Homarr shows this board on mobile devices instead of the global home board.
|
It will similar to the global home board be as fallback for normal users and for any anonymous users.
|
||||||
Homarr detects mobile devices with the User-Agent header.
|
It also has to be public.
|
||||||
The board must be public.
|
|
||||||
|
|
||||||
### App status
|
### App status
|
||||||
|
|
||||||
#### Enable status by default
|
#### Enable status by default
|
||||||
|
|
||||||
You can decide if app status is enabled when you add a new app.
|
You can decide if the app status should be enabled by default when adding a new app to the board.
|
||||||
|
|
||||||
#### Force disable status
|
#### Force disable status
|
||||||
|
|
||||||
You can decide if app status is disabled on all boards.
|
You can decide if the app status should be disabled for all boards.
|
||||||
|
|
||||||
|
###
|
||||||
|
|
||||||
## Appearance
|
## Appearance
|
||||||
|
|
||||||
### Default color scheme
|
### Default color scheme
|
||||||
|
You can set the default color scheme for all users that have not set a color scheme themselves.
|
||||||
You can set the default color scheme for users without their own color scheme.
|
|
||||||
|
|
||||||
## Culture
|
## Culture
|
||||||
|
|
||||||
### Default language
|
### Default language
|
||||||
|
You can set the default language for all users that have not set a language themselves.
|
||||||
You can set the default language for users without their own language.
|
|
||||||
@@ -1,27 +1,30 @@
|
|||||||
---
|
---
|
||||||
title: "App"
|
title: 'App'
|
||||||
description: "Embeds an app into the board."
|
description: 'Embeds an app into the board.'
|
||||||
hide_title: true
|
hide_title: true
|
||||||
---
|
---
|
||||||
|
|
||||||
import { AddingWidget } from "@site/src/components/widgets/adding";
|
import { AddingWidget } from '@site/src/components/widgets/adding';
|
||||||
import { WidgetConfig } from "@site/src/components/widgets/configuration";
|
import { WidgetConfig } from '@site/src/components/widgets/configuration';
|
||||||
import { WidgetHeader } from "@site/src/components/widgets/header";
|
import { WidgetHeader } from '@site/src/components/widgets/header';
|
||||||
import { appWidget } from ".";
|
import { appWidget } from '.';
|
||||||
|
|
||||||
<WidgetHeader widget={appWidget} categories={["Links", "Apps"]} />
|
|
||||||
|
<WidgetHeader
|
||||||
|
widget={appWidget}
|
||||||
|
categories={['Links', 'Apps']}
|
||||||
|
/>
|
||||||
|
|
||||||
The app widget allows you to add a link to an application or a website that you want to access quickly from your Homarr board.
|
The app widget allows you to add a link to an application or a website that you want to access quickly from your Homarr board.
|
||||||
It also supports a status check to indicate whether Homarr can reach the application or website.
|
It also supports a status check to indicate whether Homarr can reach the application or website.
|
||||||
In view mode, right-clicking uses the browser's link menu. Homarr's widget menu remains available in edit mode.
|
|
||||||
|
|
||||||
### Screenshots
|
### Screenshots
|
||||||
|
|
||||||
import githubApp from "./img/github.png";
|
import githubApp from './img/github.png';
|
||||||
import jellyseerrApp from "./img/jellyseerr-description-tooltip.png";
|
import jellyseerrApp from './img/jellyseerr-description-tooltip.png';
|
||||||
import piHoleApp from "./img/pi-hole-ping-icon.png";
|
import piHoleApp from './img/pi-hole-ping-icon.png';
|
||||||
|
|
||||||
<div className="flex gap-1">
|
<div className='flex gap-1'>
|
||||||
<img src={githubApp} alt="app github with-status-check" width={128 * 1.5} height={128 * 1.5} />
|
<img src={githubApp} alt="app github with-status-check" width={128 * 1.5} height={128 * 1.5} />
|
||||||
<img src={piHoleApp} alt="app pi-hole with-status-check status-check-icon" width={128 * 1.5} height={128 * 1.5} />
|
<img src={piHoleApp} alt="app pi-hole with-status-check status-check-icon" width={128 * 1.5} height={128 * 1.5} />
|
||||||
<img src={jellyseerrApp} alt="app jellyseerr with-description-tooltip" height={128 * 1.5} />
|
<img src={jellyseerrApp} alt="app jellyseerr with-description-tooltip" height={128 * 1.5} />
|
||||||
@@ -31,5 +34,4 @@ import piHoleApp from "./img/pi-hole-ping-icon.png";
|
|||||||
<AddingWidget />
|
<AddingWidget />
|
||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
|
|
||||||
<WidgetConfig configuration={appWidget.configuration} />
|
<WidgetConfig configuration={appWidget.configuration} />
|
||||||
@@ -1,26 +1,29 @@
|
|||||||
---
|
---
|
||||||
title: "Bookmarks"
|
title: 'Bookmarks'
|
||||||
description: "Displays multiple app links"
|
description: 'Displays multiple app links'
|
||||||
hide_title: true
|
hide_title: true
|
||||||
---
|
---
|
||||||
|
|
||||||
import { AddingWidget } from "@site/src/components/widgets/adding";
|
import { AddingWidget } from '@site/src/components/widgets/adding';
|
||||||
import { WidgetConfig } from "@site/src/components/widgets/configuration";
|
import { WidgetConfig } from '@site/src/components/widgets/configuration';
|
||||||
import { WidgetHeader } from "@site/src/components/widgets/header";
|
import { WidgetHeader } from '@site/src/components/widgets/header';
|
||||||
import { bookmarksWidget } from ".";
|
import { bookmarksWidget } from '.';
|
||||||
|
|
||||||
<WidgetHeader widget={bookmarksWidget} categories={["Links", "Apps"]} />
|
|
||||||
|
<WidgetHeader
|
||||||
|
widget={bookmarksWidget}
|
||||||
|
categories={['Links', 'Apps']}
|
||||||
|
/>
|
||||||
|
|
||||||
The bookmarks widget allows you to display multiple app links in a single widget.
|
The bookmarks widget allows you to display multiple app links in a single widget.
|
||||||
You can add links to your favorite applications, websites, or any other resources you want quick access to.
|
You can add links to your favorite applications, websites, or any other resources you want quick access to.
|
||||||
In view mode, right-clicking uses the browser's link menu. Homarr's widget menu remains available in edit mode.
|
|
||||||
|
|
||||||
### Screenshots
|
### Screenshots
|
||||||
|
|
||||||
import gridIconsOnly from "./img/grid-icons-only.png";
|
import gridIconsOnly from './img/grid-icons-only.png';
|
||||||
import gridWithTitle from "./img/grid-with-title.png";
|
import gridWithTitle from './img/grid-with-title.png';
|
||||||
import verticalListAll from "./img/vertical-list-all.png";
|
import verticalListAll from './img/vertical-list-all.png';
|
||||||
import vericalListSimple from "./img/vertical-list-simple.png";
|
import vericalListSimple from './img/vertical-list-simple.png';
|
||||||
|
|
||||||
<div className='flex gap-1'>
|
<div className='flex gap-1'>
|
||||||
<div className='flex flex-col gap-1'>
|
<div className='flex flex-col gap-1'>
|
||||||
@@ -30,13 +33,12 @@ import vericalListSimple from "./img/vertical-list-simple.png";
|
|||||||
|
|
||||||
<img src={gridWithTitle} alt="bookmarks grid with-title" width={256 + 4} height={256 + 4} />
|
<img src={gridWithTitle} alt="bookmarks grid with-title" width={256 + 4} height={256 + 4} />
|
||||||
<img src={verticalListAll} alt="bookmarks vertical-list all-elements" width={128} height={256 + 4} />
|
<img src={verticalListAll} alt="bookmarks vertical-list all-elements" width={128} height={256 + 4} />
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
### Adding the widget
|
### Adding the widget
|
||||||
|
|
||||||
<AddingWidget />
|
<AddingWidget />
|
||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
|
|
||||||
<WidgetConfig configuration={bookmarksWidget.configuration} />
|
<WidgetConfig configuration={bookmarksWidget.configuration} />
|
||||||
@@ -43,7 +43,6 @@ import temperature from './img/temperature.png';
|
|||||||
### Interactions
|
### Interactions
|
||||||
|
|
||||||
- Toggle entity state by clicking on the entity (only when clickable enabled).
|
- Toggle entity state by clicking on the entity (only when clickable enabled).
|
||||||
- After a successful toggle, the displayed state refreshes immediately.
|
|
||||||
|
|
||||||
### Adding the widget
|
### Adding the widget
|
||||||
|
|
||||||
|
|||||||
@@ -47,7 +47,4 @@ import withDisplayname from './img/with-displayname.png';
|
|||||||
<AddingWidget />
|
<AddingWidget />
|
||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
|
|
||||||
Use the Home Assistant entity ID (for example, `automation.turn_on_lights`) in the **Automation ID** field, not the automation's internal ID.
|
|
||||||
|
|
||||||
<WidgetConfig configuration={smartHomeExecuteAutomationWidget.configuration} />
|
<WidgetConfig configuration={smartHomeExecuteAutomationWidget.configuration} />
|
||||||
@@ -1,35 +0,0 @@
|
|||||||
---
|
|
||||||
title: "What's Up Docker"
|
|
||||||
description: "Displays how many watched containers have image updates available."
|
|
||||||
hide_title: true
|
|
||||||
---
|
|
||||||
|
|
||||||
import { WidgetHeader } from "@site/src/components/widgets/header";
|
|
||||||
import { AddingWidget } from "@site/src/components/widgets/adding";
|
|
||||||
import { WidgetConfig } from "@site/src/components/widgets/configuration";
|
|
||||||
import { WidgetIntegrations } from "@site/src/components/widgets/integrations";
|
|
||||||
import { wudWidget } from ".";
|
|
||||||
import { wudIntegration } from "@site/docs/integrations/whats-up-docker";
|
|
||||||
|
|
||||||
<WidgetHeader widget={wudWidget} categories={["Health Monitoring"]} />
|
|
||||||
|
|
||||||
This widget shows two stats from your WUD instance: the total number of monitored containers, and how many of them currently have an image update available. Optionally, it can also list each outdated container with its current and new version, linking to the release notes when WUD provides one.
|
|
||||||
|
|
||||||
### Supported Integrations
|
|
||||||
|
|
||||||
<WidgetIntegrations
|
|
||||||
items={[
|
|
||||||
{
|
|
||||||
integration: wudIntegration,
|
|
||||||
note: "Displays monitored container and available-update counts",
|
|
||||||
},
|
|
||||||
]}
|
|
||||||
/>
|
|
||||||
|
|
||||||
### Adding the widget
|
|
||||||
|
|
||||||
<AddingWidget />
|
|
||||||
|
|
||||||
### Configuration
|
|
||||||
|
|
||||||
<WidgetConfig configuration={wudWidget.configuration} />
|
|
||||||
@@ -1,37 +0,0 @@
|
|||||||
import { WidgetDefinition } from "@site/src/types";
|
|
||||||
import { IconBrandDocker } from "@tabler/icons-react";
|
|
||||||
|
|
||||||
export const wudWidget: WidgetDefinition = {
|
|
||||||
icon: IconBrandDocker,
|
|
||||||
name: "What's Up Docker",
|
|
||||||
description: "Displays how many watched containers have image updates available.",
|
|
||||||
path: "../../widgets/whats-up-docker",
|
|
||||||
configuration: {
|
|
||||||
items: [
|
|
||||||
{
|
|
||||||
name: "Show title",
|
|
||||||
description: "Displays the icon and \"What's Up Docker\" label above the stats",
|
|
||||||
values: { type: "boolean" },
|
|
||||||
defaultValue: "yes",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "Show update ring",
|
|
||||||
description: "Displays a ring showing the percentage of monitored containers with a pending update",
|
|
||||||
values: { type: "boolean" },
|
|
||||||
defaultValue: "yes",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "Layout",
|
|
||||||
description: "Arrange the two stats side by side (Horizontal) or stacked (Vertical)",
|
|
||||||
values: { type: "select", options: ["Horizontal", "Vertical"] },
|
|
||||||
defaultValue: "Horizontal",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "Show container update list",
|
|
||||||
description: "Lists each monitored container that has an image update available, linking to its release notes when known",
|
|
||||||
values: { type: "boolean" },
|
|
||||||
defaultValue: "no",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
},
|
|
||||||
};
|
|
||||||
+11
-22
@@ -1,6 +1,4 @@
|
|||||||
// Importing env files here to validate on build
|
// Importing env files here to validate on build
|
||||||
import path from "node:path";
|
|
||||||
|
|
||||||
import "@homarr/auth/env";
|
import "@homarr/auth/env";
|
||||||
import "@homarr/core/infrastructure/db/env";
|
import "@homarr/core/infrastructure/db/env";
|
||||||
import "@homarr/common/env";
|
import "@homarr/common/env";
|
||||||
@@ -15,21 +13,7 @@ const withNextIntl = createNextIntlPlugin({
|
|||||||
requestConfig: "../../packages/translation/src/request.ts",
|
requestConfig: "../../packages/translation/src/request.ts",
|
||||||
});
|
});
|
||||||
|
|
||||||
const getDevelopmentServiceAliases = () => {
|
|
||||||
if (process.env.NODE_ENV !== "development") {
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
|
|
||||||
return {
|
|
||||||
"@homarr/tasks": "./src/instrumentation-noop.ts",
|
|
||||||
"@homarr/websocket": "./src/instrumentation-noop.ts",
|
|
||||||
};
|
|
||||||
};
|
|
||||||
|
|
||||||
const nextConfig: NextConfig = {
|
const nextConfig: NextConfig = {
|
||||||
// Next previews otherwise create agent instruction files in the application
|
|
||||||
// directory during development.
|
|
||||||
agentRules: false,
|
|
||||||
env: {
|
env: {
|
||||||
HOMARR_VERSION: process.env.HOMARR_VERSION ?? "unknown",
|
HOMARR_VERSION: process.env.HOMARR_VERSION ?? "unknown",
|
||||||
},
|
},
|
||||||
@@ -46,14 +30,19 @@ const nextConfig: NextConfig = {
|
|||||||
serverExternalPackages: ["dockerode", "isomorphic-dompurify", "jsdom", "better-sqlite3"],
|
serverExternalPackages: ["dockerode", "isomorphic-dompurify", "jsdom", "better-sqlite3"],
|
||||||
experimental: {
|
experimental: {
|
||||||
optimizePackageImports: ["@mantine/core", "@mantine/hooks", "@tabler/icons-react"],
|
optimizePackageImports: ["@mantine/core", "@mantine/hooks", "@tabler/icons-react"],
|
||||||
turbopackFileSystemCacheForBuild: true,
|
turbopackFileSystemCacheForDev: true,
|
||||||
useTypeScriptCli: true,
|
webpackMemoryOptimizations: true,
|
||||||
},
|
},
|
||||||
turbopack: {
|
turbopack: {
|
||||||
root: path.resolve(import.meta.dirname, "../.."),
|
// ponytail: known Turbopack NFT warning from path.join(process.cwd(), …) in
|
||||||
// Development runs tasks and WebSocket as separate processes. These aliases
|
// src/app/api/backup/{route,shared}.ts. No working placement in 16.2.x
|
||||||
// keep their production-only instrumentation imports out of the dev graph.
|
// (see vercel/next.js#95125). Suppress until upstream fix lands.
|
||||||
resolveAlias: getDevelopmentServiceAliases(),
|
ignoreIssue: [
|
||||||
|
{
|
||||||
|
path: "**/*",
|
||||||
|
title: "Encountered unexpected file in NFT list",
|
||||||
|
},
|
||||||
|
],
|
||||||
},
|
},
|
||||||
transpilePackages: ["@homarr/ui", "@homarr/notifications", "@homarr/modals", "@homarr/spotlight", "@homarr/widgets"],
|
transpilePackages: ["@homarr/ui", "@homarr/notifications", "@homarr/modals", "@homarr/spotlight", "@homarr/widgets"],
|
||||||
images: {
|
images: {
|
||||||
|
|||||||
@@ -59,10 +59,11 @@
|
|||||||
"@modelcontextprotocol/sdk": "catalog:",
|
"@modelcontextprotocol/sdk": "catalog:",
|
||||||
"@scalar/api-reference-react": "catalog:",
|
"@scalar/api-reference-react": "catalog:",
|
||||||
"@tabler/icons-react": "catalog:",
|
"@tabler/icons-react": "catalog:",
|
||||||
"@tanstack/react-devtools": "catalog:",
|
"@tanstack/query-async-storage-persister": "catalog:",
|
||||||
"@tanstack/react-query": "catalog:",
|
"@tanstack/react-query": "catalog:",
|
||||||
"@tanstack/react-query-devtools": "catalog:",
|
"@tanstack/react-query-devtools": "catalog:",
|
||||||
"@tanstack/react-query-next-experimental": "catalog:",
|
"@tanstack/react-query-next-experimental": "catalog:",
|
||||||
|
"@tanstack/react-query-persist-client": "catalog:",
|
||||||
"@trpc/client": "catalog:",
|
"@trpc/client": "catalog:",
|
||||||
"@trpc/next": "catalog:",
|
"@trpc/next": "catalog:",
|
||||||
"@trpc/react-query": "catalog:",
|
"@trpc/react-query": "catalog:",
|
||||||
|
|||||||
@@ -1,120 +0,0 @@
|
|||||||
"use client";
|
|
||||||
|
|
||||||
import { useEffect, useState } from "react";
|
|
||||||
import { usePathname } from "next/navigation";
|
|
||||||
import { TanStackDevtools } from "@tanstack/react-devtools";
|
|
||||||
import type { TanStackDevtoolsReactPlugin } from "@tanstack/react-devtools";
|
|
||||||
import type { QueryClient } from "@tanstack/react-query";
|
|
||||||
import { useQueryClient } from "@tanstack/react-query";
|
|
||||||
import { ReactQueryDevtoolsPanel } from "@tanstack/react-query-devtools";
|
|
||||||
|
|
||||||
const valueStyle = { fontFamily: "monospace", overflowWrap: "anywhere" } as const;
|
|
||||||
const metricStyle = {
|
|
||||||
background: "color-mix(in srgb, currentColor 4%, transparent)",
|
|
||||||
border: "1px solid color-mix(in srgb, currentColor 18%, transparent)",
|
|
||||||
borderRadius: 8,
|
|
||||||
padding: 12,
|
|
||||||
} as const;
|
|
||||||
|
|
||||||
const readDiagnostics = (queryClient: QueryClient) => {
|
|
||||||
const queries = queryClient.getQueryCache().getAll();
|
|
||||||
const mutations = queryClient.getMutationCache().getAll();
|
|
||||||
const board = document.querySelector("[data-homarr-dev-benchmark-board]");
|
|
||||||
const widgetItems = board?.querySelectorAll('[data-type="item"]').length ?? 0;
|
|
||||||
const readyWidgets = board?.querySelectorAll("[data-homarr-widget-ready]").length ?? 0;
|
|
||||||
const resources = performance.getEntriesByType("resource") as PerformanceResourceTiming[];
|
|
||||||
|
|
||||||
return {
|
|
||||||
active: queries.filter((query) => query.getObserversCount() > 0).length,
|
|
||||||
errors: queries.filter((query) => query.state.status === "error").length,
|
|
||||||
fetching: queries.filter((query) => query.state.fetchStatus === "fetching").length,
|
|
||||||
pendingMutations: mutations.filter((mutation) => mutation.state.status === "pending").length,
|
|
||||||
stale: queries.filter((query) => query.isStale()).length,
|
|
||||||
total: queries.length,
|
|
||||||
readyWidgets,
|
|
||||||
widgetItems,
|
|
||||||
scriptKiB: Math.round(
|
|
||||||
resources
|
|
||||||
.filter((resource) => resource.initiatorType === "script")
|
|
||||||
.reduce((total, resource) => total + resource.decodedBodySize, 0) / 1024,
|
|
||||||
),
|
|
||||||
};
|
|
||||||
};
|
|
||||||
|
|
||||||
const Metric = ({ label, value }: { label: string; value: number | string }) => (
|
|
||||||
<div style={metricStyle}>
|
|
||||||
<div style={{ fontSize: 12, opacity: 0.7 }}>{label}</div>
|
|
||||||
<output style={{ ...valueStyle, display: "block", fontSize: 22, fontWeight: 600, marginTop: 4 }}>{value}</output>
|
|
||||||
</div>
|
|
||||||
);
|
|
||||||
|
|
||||||
const HomarrDevtoolsPanel = ({ active }: { active: boolean }) => {
|
|
||||||
const pathname = usePathname();
|
|
||||||
const queryClient = useQueryClient();
|
|
||||||
const [diagnostics, setDiagnostics] = useState(() => readDiagnostics(queryClient));
|
|
||||||
|
|
||||||
useEffect(() => {
|
|
||||||
if (!active) return;
|
|
||||||
|
|
||||||
const update = () => setDiagnostics(readDiagnostics(queryClient));
|
|
||||||
let frame: number | undefined;
|
|
||||||
const scheduleUpdate = () => {
|
|
||||||
if (frame !== undefined) return;
|
|
||||||
frame = window.requestAnimationFrame(() => {
|
|
||||||
frame = undefined;
|
|
||||||
update();
|
|
||||||
});
|
|
||||||
};
|
|
||||||
const unsubscribeQueries = queryClient.getQueryCache().subscribe(scheduleUpdate);
|
|
||||||
const unsubscribeMutations = queryClient.getMutationCache().subscribe(scheduleUpdate);
|
|
||||||
const observer = new MutationObserver(scheduleUpdate);
|
|
||||||
observer.observe(document.body, { childList: true, subtree: true });
|
|
||||||
update();
|
|
||||||
|
|
||||||
return () => {
|
|
||||||
unsubscribeQueries();
|
|
||||||
unsubscribeMutations();
|
|
||||||
observer.disconnect();
|
|
||||||
if (frame !== undefined) window.cancelAnimationFrame(frame);
|
|
||||||
};
|
|
||||||
}, [active, pathname, queryClient]);
|
|
||||||
|
|
||||||
if (!active) return null;
|
|
||||||
|
|
||||||
return (
|
|
||||||
<section data-homarr-devtools-panel style={{ fontFamily: "system-ui, sans-serif", padding: 16 }}>
|
|
||||||
<header style={{ marginBottom: 16 }}>
|
|
||||||
<h2 style={{ margin: 0 }}>Homarr performance</h2>
|
|
||||||
<p style={{ marginBlock: "4px 0", opacity: 0.7 }}>Live state for {pathname}</p>
|
|
||||||
</header>
|
|
||||||
<div style={{ display: "grid", gap: 8, gridTemplateColumns: "repeat(auto-fit, minmax(110px, 1fr))" }}>
|
|
||||||
<Metric label="Queries" value={diagnostics.total} />
|
|
||||||
<Metric label="Active" value={diagnostics.active} />
|
|
||||||
<Metric label="Fetching" value={diagnostics.fetching} />
|
|
||||||
<Metric label="Stale" value={diagnostics.stale} />
|
|
||||||
<Metric label="Errors" value={diagnostics.errors} />
|
|
||||||
<Metric label="Mutations" value={diagnostics.pendingMutations} />
|
|
||||||
<Metric label="Widgets ready" value={`${diagnostics.readyWidgets}/${diagnostics.widgetItems}`} />
|
|
||||||
<Metric label="Script KiB" value={diagnostics.scriptKiB} />
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
);
|
|
||||||
};
|
|
||||||
|
|
||||||
const developmentToolsPlugins = [
|
|
||||||
{
|
|
||||||
id: "tanstack-query",
|
|
||||||
name: "TanStack Query",
|
|
||||||
render: () => <ReactQueryDevtoolsPanel />,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
id: "homarr-performance",
|
|
||||||
name: "Homarr",
|
|
||||||
defaultOpen: true,
|
|
||||||
render: (_element, { devtoolsOpen }) => <HomarrDevtoolsPanel active={devtoolsOpen} />,
|
|
||||||
},
|
|
||||||
] satisfies TanStackDevtoolsReactPlugin[];
|
|
||||||
|
|
||||||
export const DevelopmentTools = () => (
|
|
||||||
<TanStackDevtools config={{ position: "bottom-right", hideUntilHover: true }} plugins={developmentToolsPlugins} />
|
|
||||||
);
|
|
||||||
@@ -0,0 +1,32 @@
|
|||||||
|
import { createAsyncStoragePersister } from "@tanstack/query-async-storage-persister";
|
||||||
|
import superjson from "superjson";
|
||||||
|
|
||||||
|
import { fetchApi } from "@homarr/api/client";
|
||||||
|
import { getActiveQueryCacheBoardId, queryCacheStoragePrefix } from "@homarr/api/query-cache";
|
||||||
|
|
||||||
|
const queryCacheStorage = {
|
||||||
|
getItem: (_key: string) => null as string | null,
|
||||||
|
async setItem(_key: string, value: string) {
|
||||||
|
const boardId = getActiveQueryCacheBoardId();
|
||||||
|
if (!boardId) return;
|
||||||
|
await fetchApi.queryCache.setItem.mutate({ boardId, value }).catch((error) => {
|
||||||
|
console.warn("[query-cache] persist failed", error);
|
||||||
|
});
|
||||||
|
},
|
||||||
|
async removeItem(_key: string) {
|
||||||
|
const boardId = getActiveQueryCacheBoardId();
|
||||||
|
if (!boardId) return;
|
||||||
|
await fetchApi.queryCache.removeItem.mutate({ boardId }).catch((error) => {
|
||||||
|
console.warn("[query-cache] remove failed", error);
|
||||||
|
});
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
export const createWidgetQueryPersister = () =>
|
||||||
|
createAsyncStoragePersister({
|
||||||
|
storage: typeof window === "undefined" ? undefined : queryCacheStorage,
|
||||||
|
key: queryCacheStoragePrefix,
|
||||||
|
throttleTime: 2000,
|
||||||
|
serialize: (data) => superjson.stringify(data),
|
||||||
|
deserialize: (data) => superjson.parse(data),
|
||||||
|
});
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
import { describe, expect, it } from "vitest";
|
|
||||||
import { TRPCClientError } from "@trpc/client";
|
|
||||||
|
|
||||||
import { createQueryRetry } from "./query-retry";
|
|
||||||
|
|
||||||
const createTrpcError = (code: string) => {
|
|
||||||
const error = Object.assign(new Error(code), { data: { code } });
|
|
||||||
Object.setPrototypeOf(error, TRPCClientError.prototype);
|
|
||||||
return error;
|
|
||||||
};
|
|
||||||
|
|
||||||
describe("createQueryRetry", () => {
|
|
||||||
it.each(["BAD_REQUEST", "UNAUTHORIZED", "FORBIDDEN", "NOT_FOUND", "UNPROCESSABLE_CONTENT"])(
|
|
||||||
"does not retry the permanent %s response",
|
|
||||||
(code) => {
|
|
||||||
expect(createQueryRetry(3)(0, createTrpcError(code))).toBe(false);
|
|
||||||
},
|
|
||||||
);
|
|
||||||
|
|
||||||
it("retries transient and network failures only up to the configured limit", () => {
|
|
||||||
const retry = createQueryRetry(3);
|
|
||||||
|
|
||||||
expect(retry(0, createTrpcError("INTERNAL_SERVER_ERROR"))).toBe(true);
|
|
||||||
expect(retry(2, new Error("connection reset"))).toBe(true);
|
|
||||||
expect(retry(3, new Error("connection reset"))).toBe(false);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
import { TRPCClientError } from "@trpc/client";
|
|
||||||
|
|
||||||
const nonRetryableTrpcCodes = new Set([
|
|
||||||
"PARSE_ERROR",
|
|
||||||
"BAD_REQUEST",
|
|
||||||
"UNAUTHORIZED",
|
|
||||||
"FORBIDDEN",
|
|
||||||
"NOT_FOUND",
|
|
||||||
"METHOD_NOT_SUPPORTED",
|
|
||||||
"CONFLICT",
|
|
||||||
"PRECONDITION_FAILED",
|
|
||||||
"PAYLOAD_TOO_LARGE",
|
|
||||||
"UNPROCESSABLE_CONTENT",
|
|
||||||
]);
|
|
||||||
|
|
||||||
export const createQueryRetry = (maxRetries: number) => (failureCount: number, error: unknown) => {
|
|
||||||
if (failureCount >= maxRetries) return false;
|
|
||||||
if (error instanceof TRPCClientError && error.data?.code && nonRetryableTrpcCodes.has(error.data.code)) return false;
|
|
||||||
return true;
|
|
||||||
};
|
|
||||||
@@ -1,52 +0,0 @@
|
|||||||
// @vitest-environment jsdom
|
|
||||||
|
|
||||||
import { act, createElement } from "react";
|
|
||||||
import { createRoot } from "react-dom/client";
|
|
||||||
import { describe, expect, it, vi } from "vitest";
|
|
||||||
|
|
||||||
import { getSessionQueryScope, SessionQueryScopeGuard } from "./session-query-scope";
|
|
||||||
|
|
||||||
describe("getSessionQueryScope", () => {
|
|
||||||
it("is stable when permission order changes", () => {
|
|
||||||
expect(getSessionQueryScope({ user: { id: "user-a", permissions: ["board-view", "integration-use"] } })).toBe(
|
|
||||||
getSessionQueryScope({ user: { id: "user-a", permissions: ["integration-use", "board-view"] } }),
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("changes for a different user or permission set", () => {
|
|
||||||
const original = getSessionQueryScope({ user: { id: "user-a", permissions: ["board-view"] } });
|
|
||||||
|
|
||||||
expect(getSessionQueryScope({ user: { id: "user-b", permissions: ["board-view"] } })).not.toBe(original);
|
|
||||||
expect(getSessionQueryScope({ user: { id: "user-a", permissions: [] } })).not.toBe(original);
|
|
||||||
expect(getSessionQueryScope(null)).toBeNull();
|
|
||||||
});
|
|
||||||
|
|
||||||
it("removes the previous session subtree before requesting a document reload", async () => {
|
|
||||||
const host = document.createElement("div");
|
|
||||||
const root = createRoot(host);
|
|
||||||
const onScopeChange = vi.fn();
|
|
||||||
const renderScope = async (currentScope: string) => {
|
|
||||||
await act(async () => {
|
|
||||||
root.render(
|
|
||||||
createElement(
|
|
||||||
SessionQueryScopeGuard,
|
|
||||||
{ currentScope, initialScope: "a", onScopeChange },
|
|
||||||
createElement("span", null, "session-a-secret"),
|
|
||||||
),
|
|
||||||
);
|
|
||||||
});
|
|
||||||
};
|
|
||||||
|
|
||||||
try {
|
|
||||||
await renderScope("a");
|
|
||||||
expect(host.textContent).toBe("session-a-secret");
|
|
||||||
|
|
||||||
await renderScope("b");
|
|
||||||
expect(host.textContent).not.toContain("session-a-secret");
|
|
||||||
expect(host.querySelector('[role="status"]')?.getAttribute("aria-busy")).toBe("true");
|
|
||||||
expect(onScopeChange).toHaveBeenCalledOnce();
|
|
||||||
} finally {
|
|
||||||
await act(async () => root.unmount());
|
|
||||||
}
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -1,39 +0,0 @@
|
|||||||
import type { PropsWithChildren } from "react";
|
|
||||||
import { createElement, useEffect } from "react";
|
|
||||||
|
|
||||||
interface QuerySession {
|
|
||||||
user: {
|
|
||||||
id: string;
|
|
||||||
permissions: string[];
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
export const getSessionQueryScope = (session: QuerySession | null | undefined) =>
|
|
||||||
session ? JSON.stringify([session.user.id, session.user.permissions.toSorted()]) : null;
|
|
||||||
|
|
||||||
interface SessionQueryScopeGuardProps {
|
|
||||||
initialScope: string | null;
|
|
||||||
currentScope: string | null;
|
|
||||||
onScopeChange: () => void;
|
|
||||||
}
|
|
||||||
|
|
||||||
export const SessionQueryScopeGuard = ({
|
|
||||||
initialScope,
|
|
||||||
currentScope,
|
|
||||||
onScopeChange,
|
|
||||||
children,
|
|
||||||
}: PropsWithChildren<SessionQueryScopeGuardProps>) => {
|
|
||||||
const hasScopeChanged = initialScope !== currentScope;
|
|
||||||
useEffect(() => {
|
|
||||||
if (hasScopeChanged) onScopeChange();
|
|
||||||
}, [hasScopeChanged, onScopeChange]);
|
|
||||||
|
|
||||||
if (!hasScopeChanged) return children;
|
|
||||||
|
|
||||||
return createElement("div", {
|
|
||||||
"aria-busy": true,
|
|
||||||
"aria-label": "Refreshing session",
|
|
||||||
role: "status",
|
|
||||||
style: { minHeight: "100dvh" },
|
|
||||||
});
|
|
||||||
};
|
|
||||||
@@ -1,10 +1,12 @@
|
|||||||
"use client";
|
"use client";
|
||||||
|
|
||||||
import type { PropsWithChildren } from "react";
|
import type { PropsWithChildren } from "react";
|
||||||
import { useEffect, useMemo, useState } from "react";
|
import { useState } from "react";
|
||||||
import dynamic from "next/dynamic";
|
import type { QueryKey } from "@tanstack/react-query";
|
||||||
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
|
import { QueryClient } from "@tanstack/react-query";
|
||||||
|
import { ReactQueryDevtools } from "@tanstack/react-query-devtools";
|
||||||
import { ReactQueryStreamedHydration } from "@tanstack/react-query-next-experimental";
|
import { ReactQueryStreamedHydration } from "@tanstack/react-query-next-experimental";
|
||||||
|
import { PersistQueryClientProvider } from "@tanstack/react-query-persist-client";
|
||||||
import {
|
import {
|
||||||
createWSClient,
|
createWSClient,
|
||||||
httpBatchStreamLink,
|
httpBatchStreamLink,
|
||||||
@@ -23,24 +25,18 @@ import { TRPCClientError } from "@trpc/client";
|
|||||||
import type { AppRouter } from "@homarr/api";
|
import type { AppRouter } from "@homarr/api";
|
||||||
import { clientApi } from "@homarr/api/client";
|
import { clientApi } from "@homarr/api/client";
|
||||||
import {
|
import {
|
||||||
dashboardSupportingQueryPolicies,
|
isPersistableWidgetQueryKey,
|
||||||
|
queryCacheBuster,
|
||||||
queryCacheDefaultGcTimeMs,
|
queryCacheDefaultGcTimeMs,
|
||||||
queryCacheDefaultRefetchIntervalMs,
|
queryCacheDefaultRefetchIntervalMs,
|
||||||
queryCacheDefaultStaleTimeMs,
|
queryCacheDefaultStaleTimeMs,
|
||||||
} from "@homarr/api/query-cache";
|
} from "@homarr/api/query-cache";
|
||||||
import { createHeadersCallbackForSource, getTrpcUrl } from "@homarr/api/shared";
|
import { createHeadersCallbackForSource, getTrpcUrl } from "@homarr/api/shared";
|
||||||
import { useSession } from "@homarr/auth/client";
|
|
||||||
import { env } from "@homarr/common/env";
|
import { env } from "@homarr/common/env";
|
||||||
import { showWarningNotification } from "@homarr/notifications";
|
import { showWarningNotification } from "@homarr/notifications";
|
||||||
import { widgetQueryRefetchIntervals } from "@homarr/widgets/refetch-intervals";
|
import { widgetImports } from "@homarr/widgets";
|
||||||
|
|
||||||
import { getSessionQueryScope, SessionQueryScopeGuard } from "./session-query-scope";
|
import { createWidgetQueryPersister } from "./query-cache-persister";
|
||||||
import { createQueryRetry } from "./query-retry";
|
|
||||||
|
|
||||||
const DevelopmentTools =
|
|
||||||
process.env.NODE_ENV === "development"
|
|
||||||
? dynamic(() => import("./development-tools").then(({ DevelopmentTools: Tools }) => Tools), { ssr: false })
|
|
||||||
: () => null;
|
|
||||||
|
|
||||||
const getWebSocketProtocol = () => {
|
const getWebSocketProtocol = () => {
|
||||||
if (typeof window === "undefined") {
|
if (typeof window === "undefined") {
|
||||||
@@ -63,46 +59,21 @@ const constructWebsocketUrl = () => {
|
|||||||
return `${getWebSocketProtocol()}://${window.location.hostname}:${window.location.port}/websockets`;
|
return `${getWebSocketProtocol()}://${window.location.hostname}:${window.location.port}/websockets`;
|
||||||
};
|
};
|
||||||
|
|
||||||
export function TRPCReactProvider({ children }: PropsWithChildren) {
|
const wsClient = createWSClient({
|
||||||
const { data: session } = useSession();
|
url: constructWebsocketUrl(),
|
||||||
const sessionQueryScope = getSessionQueryScope(session);
|
});
|
||||||
const [initialSessionQueryScope] = useState(() => sessionQueryScope);
|
|
||||||
|
|
||||||
return (
|
export function TRPCReactProvider(props: PropsWithChildren) {
|
||||||
<SessionQueryScopeGuard
|
const [persister] = useState(() => createWidgetQueryPersister());
|
||||||
initialScope={initialSessionQueryScope}
|
|
||||||
currentScope={sessionQueryScope}
|
|
||||||
onScopeChange={reloadPage}
|
|
||||||
>
|
|
||||||
<ScopedTRPCReactProvider>{children}</ScopedTRPCReactProvider>
|
|
||||||
</SessionQueryScopeGuard>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
const reloadPage = () => window.location.reload();
|
|
||||||
|
|
||||||
const ScopedTRPCReactProvider = ({ children }: PropsWithChildren) => {
|
|
||||||
const wsClient = useMemo(
|
|
||||||
() =>
|
|
||||||
createWSClient({
|
|
||||||
url: constructWebsocketUrl(),
|
|
||||||
lazy: { enabled: true, closeMs: 30_000 },
|
|
||||||
}),
|
|
||||||
[],
|
|
||||||
);
|
|
||||||
useEffect(
|
|
||||||
() => () => {
|
|
||||||
void wsClient.close();
|
|
||||||
},
|
|
||||||
[wsClient],
|
|
||||||
);
|
|
||||||
const [queryClient] = useState(() => {
|
const [queryClient] = useState(() => {
|
||||||
const client = new QueryClient({
|
const client = new QueryClient({
|
||||||
defaultOptions: {
|
defaultOptions: {
|
||||||
queries: {
|
queries: {
|
||||||
staleTime: queryCacheDefaultStaleTimeMs,
|
staleTime: queryCacheDefaultStaleTimeMs,
|
||||||
gcTime: queryCacheDefaultGcTimeMs,
|
gcTime: queryCacheDefaultGcTimeMs,
|
||||||
retry: createQueryRetry(env.NODE_ENV === "development" ? 1 : 3),
|
refetchOnWindowFocus: false,
|
||||||
|
refetchOnReconnect: false,
|
||||||
|
retry: 3,
|
||||||
},
|
},
|
||||||
mutations: {
|
mutations: {
|
||||||
onError(error) {
|
onError(error) {
|
||||||
@@ -120,29 +91,23 @@ const ScopedTRPCReactProvider = ({ children }: PropsWithChildren) => {
|
|||||||
},
|
},
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
client.setQueryDefaults([["widget"]], {
|
client.setQueryDefaults([["widget"]], { refetchInterval: queryCacheDefaultRefetchIntervalMs });
|
||||||
refetchInterval: queryCacheDefaultRefetchIntervalMs,
|
for (const { definition } of Object.values(widgetImports)) {
|
||||||
refetchOnWindowFocus: false,
|
const def = definition as { refetchInterval?: number | null; queryKey?: QueryKey; kind: string };
|
||||||
refetchOnReconnect: false,
|
if (def.refetchInterval === undefined) continue;
|
||||||
});
|
const key = def.queryKey ?? [["widget", def.kind]];
|
||||||
for (const { queryKey, intervalSeconds } of widgetQueryRefetchIntervals) {
|
const interval = def.refetchInterval === null ? false : def.refetchInterval * 1000;
|
||||||
client.setQueryDefaults(queryKey, {
|
client.setQueryDefaults(key, { refetchInterval: interval });
|
||||||
refetchInterval: intervalSeconds === null ? false : intervalSeconds * 1000,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
for (const { queryKey, ...policy } of dashboardSupportingQueryPolicies) {
|
|
||||||
client.setQueryDefaults(queryKey, policy);
|
|
||||||
}
|
}
|
||||||
return client;
|
return client;
|
||||||
});
|
});
|
||||||
|
|
||||||
useEffect(() => () => queryClient.clear(), [queryClient]);
|
const [trpcClient] = useState(() => {
|
||||||
|
|
||||||
const trpcClient = useMemo(() => {
|
|
||||||
return clientApi.createClient({
|
return clientApi.createClient({
|
||||||
links: [
|
links: [
|
||||||
loggerLink({
|
loggerLink({
|
||||||
enabled: (opts) => opts.direction === "down" && opts.result instanceof Error,
|
enabled: (opts) =>
|
||||||
|
env.NODE_ENV === "development" || (opts.direction === "down" && opts.result instanceof Error),
|
||||||
}),
|
}),
|
||||||
splitLink({
|
splitLink({
|
||||||
condition: ({ type }) => type === "subscription",
|
condition: ({ type }) => type === "subscription",
|
||||||
@@ -182,14 +147,25 @@ const ScopedTRPCReactProvider = ({ children }: PropsWithChildren) => {
|
|||||||
}),
|
}),
|
||||||
],
|
],
|
||||||
});
|
});
|
||||||
}, [wsClient]);
|
});
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<clientApi.Provider client={trpcClient} queryClient={queryClient}>
|
<clientApi.Provider client={trpcClient} queryClient={queryClient}>
|
||||||
<QueryClientProvider client={queryClient}>
|
<PersistQueryClientProvider
|
||||||
<ReactQueryStreamedHydration transformer={superjson}>{children}</ReactQueryStreamedHydration>
|
client={queryClient}
|
||||||
{process.env.NODE_ENV === "development" && <DevelopmentTools />}
|
persistOptions={{
|
||||||
</QueryClientProvider>
|
persister,
|
||||||
|
buster: queryCacheBuster,
|
||||||
|
maxAge: queryCacheDefaultGcTimeMs,
|
||||||
|
dehydrateOptions: {
|
||||||
|
shouldDehydrateQuery: (query) =>
|
||||||
|
query.state.status === "success" && isPersistableWidgetQueryKey(query.queryKey),
|
||||||
|
},
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
<ReactQueryStreamedHydration transformer={superjson}>{props.children}</ReactQueryStreamedHydration>
|
||||||
|
<ReactQueryDevtools initialIsOpen={false} />
|
||||||
|
</PersistQueryClientProvider>
|
||||||
</clientApi.Provider>
|
</clientApi.Provider>
|
||||||
);
|
);
|
||||||
};
|
}
|
||||||
@@ -1,9 +1,9 @@
|
|||||||
import { getHomeBoardAsync } from "@homarr/api/board-server";
|
import { api } from "@homarr/api/server";
|
||||||
|
|
||||||
import { createBoardContentPage } from "../_creator";
|
import { createBoardContentPage } from "../_creator";
|
||||||
|
|
||||||
export default createBoardContentPage<{ locale: string }>({
|
export default createBoardContentPage<{ locale: string }>({
|
||||||
async getInitialBoardAsync() {
|
async getInitialBoardAsync() {
|
||||||
return await getHomeBoardAsync();
|
return await api.board.getHomeBoard();
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
@@ -1,9 +1,9 @@
|
|||||||
import { getBoardByNameAsync } from "@homarr/api/board-server";
|
import { api } from "@homarr/api/server";
|
||||||
|
|
||||||
import { createBoardContentPage } from "../../_creator";
|
import { createBoardContentPage } from "../../_creator";
|
||||||
|
|
||||||
export default createBoardContentPage<{ locale: string; name: string }>({
|
export default createBoardContentPage<{ locale: string; name: string }>({
|
||||||
async getInitialBoardAsync({ name }) {
|
async getInitialBoardAsync({ name }) {
|
||||||
return await getBoardByNameAsync(name);
|
return await api.board.getBoardByName({ name });
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
@@ -1,84 +0,0 @@
|
|||||||
"use client";
|
|
||||||
|
|
||||||
import { useCallback } from "react";
|
|
||||||
import { Group, Menu } from "@mantine/core";
|
|
||||||
import { IconBox, IconBoxAlignTop, IconChevronDown, IconPlug, IconPlus, IconResize } from "@tabler/icons-react";
|
|
||||||
|
|
||||||
import { useSession } from "@homarr/auth/client";
|
|
||||||
import { useModalAction } from "@homarr/modals";
|
|
||||||
import { AppSelectModal } from "@homarr/modals-collection";
|
|
||||||
import { useI18n } from "@homarr/translation/client";
|
|
||||||
|
|
||||||
import { useItemActions } from "~/components/board/items/item-actions";
|
|
||||||
import { ItemSelectModal } from "~/components/board/items/item-select-modal";
|
|
||||||
import { useCategoryActions } from "~/components/board/sections/category/category-actions";
|
|
||||||
import { CategoryEditModal } from "~/components/board/sections/category/category-edit-modal";
|
|
||||||
import { useDynamicSectionActions } from "~/components/board/sections/dynamic/dynamic-actions";
|
|
||||||
import { IntegrationSelectModal } from "~/components/integration/integration-select-modal";
|
|
||||||
import { HeaderButton } from "~/components/layout/header/button";
|
|
||||||
|
|
||||||
export const BoardAddMenu = () => {
|
|
||||||
const { data: session } = useSession();
|
|
||||||
const { openModal: openCategoryEditModal } = useModalAction(CategoryEditModal);
|
|
||||||
const { openModal: openItemSelectModal } = useModalAction(ItemSelectModal);
|
|
||||||
const { openModal: openAppSelectModal } = useModalAction(AppSelectModal);
|
|
||||||
const { openModal: openIntegrationSelectModal } = useModalAction(IntegrationSelectModal);
|
|
||||||
const { addCategoryToEnd } = useCategoryActions();
|
|
||||||
const { addDynamicSection } = useDynamicSectionActions();
|
|
||||||
const { createItem } = useItemActions();
|
|
||||||
const t = useI18n();
|
|
||||||
|
|
||||||
const handleAddCategory = useCallback(
|
|
||||||
() =>
|
|
||||||
openCategoryEditModal(
|
|
||||||
{
|
|
||||||
category: { id: "new", name: "" },
|
|
||||||
onSuccess({ name }) {
|
|
||||||
addCategoryToEnd({ name });
|
|
||||||
},
|
|
||||||
submitLabel: t("section.category.create.submit"),
|
|
||||||
},
|
|
||||||
{ title: (translate) => translate("section.category.create.title") },
|
|
||||||
),
|
|
||||||
[addCategoryToEnd, openCategoryEditModal, t],
|
|
||||||
);
|
|
||||||
|
|
||||||
return (
|
|
||||||
<Menu position="bottom-end">
|
|
||||||
<Menu.Target>
|
|
||||||
<HeaderButton w="auto" px={4}>
|
|
||||||
<Group gap={4} wrap="nowrap">
|
|
||||||
<IconPlus stroke={1.5} />
|
|
||||||
<IconChevronDown color="gray" size={16} />
|
|
||||||
</Group>
|
|
||||||
</HeaderButton>
|
|
||||||
</Menu.Target>
|
|
||||||
<Menu.Dropdown style={{ transform: "translate(-3px, 0)" }}>
|
|
||||||
<Menu.Item leftSection={<IconResize size={20} />} onClick={() => openItemSelectModal()}>
|
|
||||||
{t("item.action.create")}
|
|
||||||
</Menu.Item>
|
|
||||||
<Menu.Item
|
|
||||||
leftSection={<IconBox size={20} />}
|
|
||||||
onClick={() =>
|
|
||||||
openAppSelectModal({
|
|
||||||
onSelect: (app) => createItem({ kind: "app", options: { appId: app.id } }),
|
|
||||||
withCreate: session?.user.permissions.includes("app-create") ?? false,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
>
|
|
||||||
{t("app.action.add")}
|
|
||||||
</Menu.Item>
|
|
||||||
<Menu.Item leftSection={<IconPlug size={20} />} onClick={() => openIntegrationSelectModal({})}>
|
|
||||||
{t("integration.action.create")}
|
|
||||||
</Menu.Item>
|
|
||||||
<Menu.Divider />
|
|
||||||
<Menu.Item leftSection={<IconBoxAlignTop size={20} />} onClick={handleAddCategory}>
|
|
||||||
{t("section.category.action.create")}
|
|
||||||
</Menu.Item>
|
|
||||||
<Menu.Item leftSection={<IconResize size={20} />} onClick={addDynamicSection}>
|
|
||||||
{t("section.dynamic.action.create")}
|
|
||||||
</Menu.Item>
|
|
||||||
</Menu.Dropdown>
|
|
||||||
</Menu>
|
|
||||||
);
|
|
||||||
};
|
|
||||||
@@ -14,10 +14,10 @@ export const ClientBoard = () => {
|
|||||||
|
|
||||||
const fullWidthSortedSections = board.sections
|
const fullWidthSortedSections = board.sections
|
||||||
.filter((section) => section.kind === "empty" || section.kind === "category")
|
.filter((section) => section.kind === "empty" || section.kind === "category")
|
||||||
.toSorted((sectionA, sectionB) => sectionA.yOffset - sectionB.yOffset);
|
.sort((sectionA, sectionB) => sectionA.yOffset - sectionB.yOffset);
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<Box h="100%" pos="relative" data-homarr-dev-benchmark-board>
|
<Box h="100%" pos="relative">
|
||||||
<BoardBackgroundVideo />
|
<BoardBackgroundVideo />
|
||||||
<Stack h="100%">
|
<Stack h="100%">
|
||||||
{fullWidthSortedSections.map((section) =>
|
{fullWidthSortedSections.map((section) =>
|
||||||
|
|||||||
@@ -1,12 +1,15 @@
|
|||||||
import type { Metadata } from "next";
|
import type { Metadata } from "next";
|
||||||
import { cache } from "react";
|
import { Suspense } from "react";
|
||||||
import { TRPCError } from "@trpc/server";
|
import { TRPCError } from "@trpc/server";
|
||||||
|
|
||||||
// Placed here because gridstack styles are used for board content
|
// Placed here because gridstack styles are used for board content
|
||||||
import "~/styles/gridstack.scss";
|
import "~/styles/gridstack.scss";
|
||||||
|
|
||||||
import { dehydrate, HydrationBoundary } from "@tanstack/react-query";
|
import { dehydrate, HydrationBoundary } from "@tanstack/react-query";
|
||||||
import { makeQueryClient } from "@homarr/api/shared";
|
import type { PersistedClient } from "@tanstack/react-query-persist-client";
|
||||||
|
import superjson from "superjson";
|
||||||
|
import { queryCacheBuster } from "@homarr/api/query-cache";
|
||||||
|
import { getQueryClient } from "@homarr/api/server";
|
||||||
import { IntegrationProvider } from "@homarr/auth/client";
|
import { IntegrationProvider } from "@homarr/auth/client";
|
||||||
import { auth } from "@homarr/auth/next";
|
import { auth } from "@homarr/auth/next";
|
||||||
import { getIntegrationsWithPermissionsAsync } from "@homarr/auth/server";
|
import { getIntegrationsWithPermissionsAsync } from "@homarr/auth/server";
|
||||||
@@ -14,6 +17,7 @@ import { isNullOrWhitespace } from "@homarr/common";
|
|||||||
import { createLogger } from "@homarr/core/infrastructure/logs";
|
import { createLogger } from "@homarr/core/infrastructure/logs";
|
||||||
import { ErrorWithMetadata } from "@homarr/core/infrastructure/logs/error";
|
import { ErrorWithMetadata } from "@homarr/core/infrastructure/logs/error";
|
||||||
import type { WidgetKind } from "@homarr/definitions";
|
import type { WidgetKind } from "@homarr/definitions";
|
||||||
|
import { getQueryCacheAsync } from "@homarr/redis";
|
||||||
import { getI18n } from "@homarr/translation/server";
|
import { getI18n } from "@homarr/translation/server";
|
||||||
import { prefetchForKindAsync } from "@homarr/widgets/prefetch";
|
import { prefetchForKindAsync } from "@homarr/widgets/prefetch";
|
||||||
|
|
||||||
@@ -25,7 +29,6 @@ import { DynamicClientBoard } from "./_dynamic-client";
|
|||||||
import { BoardContentHeaderActions } from "./_header-actions";
|
import { BoardContentHeaderActions } from "./_header-actions";
|
||||||
|
|
||||||
const logger = createLogger({ module: "createBoardContentPage" });
|
const logger = createLogger({ module: "createBoardContentPage" });
|
||||||
const getQueryClient = cache(makeQueryClient);
|
|
||||||
|
|
||||||
export type Params = Record<string, unknown>;
|
export type Params = Record<string, unknown>;
|
||||||
|
|
||||||
@@ -58,6 +61,7 @@ export const createBoardContentPage = <TParams extends Record<string, unknown>>(
|
|||||||
}
|
}
|
||||||
return acc;
|
return acc;
|
||||||
}, new Map<WidgetKind, Item[]>());
|
}, new Map<WidgetKind, Item[]>());
|
||||||
|
|
||||||
const [integrations] = await Promise.all([
|
const [integrations] = await Promise.all([
|
||||||
getIntegrationsWithPermissionsAsync(session),
|
getIntegrationsWithPermissionsAsync(session),
|
||||||
...Array.from(itemsMap).map(([kind, items]) =>
|
...Array.from(itemsMap).map(([kind, items]) =>
|
||||||
@@ -73,12 +77,19 @@ export const createBoardContentPage = <TParams extends Record<string, unknown>>(
|
|||||||
),
|
),
|
||||||
]);
|
]);
|
||||||
|
|
||||||
|
const userId = session?.user.id ?? "anonymous";
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<HydrationBoundary state={dehydrate(queryClient)}>
|
<>
|
||||||
<IntegrationProvider integrations={integrations}>
|
<Suspense>
|
||||||
<DynamicClientBoard />
|
<QueryCacheHydration userId={userId} boardId={board.id} />
|
||||||
</IntegrationProvider>
|
</Suspense>
|
||||||
</HydrationBoundary>
|
<HydrationBoundary state={dehydrate(queryClient)}>
|
||||||
|
<IntegrationProvider integrations={integrations}>
|
||||||
|
<DynamicClientBoard />
|
||||||
|
</IntegrationProvider>
|
||||||
|
</HydrationBoundary>
|
||||||
|
</>
|
||||||
);
|
);
|
||||||
},
|
},
|
||||||
generateMetadataAsync: async ({ params }: { params: Promise<TParams> }): Promise<Metadata> => {
|
generateMetadataAsync: async ({ params }: { params: Promise<TParams> }): Promise<Metadata> => {
|
||||||
@@ -109,3 +120,19 @@ export const createBoardContentPage = <TParams extends Record<string, unknown>>(
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
|
async function QueryCacheHydration({ userId, boardId }: { userId: string; boardId: string }) {
|
||||||
|
try {
|
||||||
|
const serialized = await getQueryCacheAsync(userId, boardId);
|
||||||
|
if (!serialized) return null;
|
||||||
|
|
||||||
|
const persisted = superjson.parse<PersistedClient | undefined>(serialized);
|
||||||
|
if (!persisted || persisted.buster !== queryCacheBuster) return null;
|
||||||
|
if (!persisted.clientState?.queries?.length) return null;
|
||||||
|
|
||||||
|
return <HydrationBoundary state={persisted.clientState} />;
|
||||||
|
} catch (error) {
|
||||||
|
logger.warn(new ErrorWithMetadata("Failed to hydrate query cache", { userId, boardId }, { cause: error }));
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,24 +1,7 @@
|
|||||||
"use client";
|
"use client";
|
||||||
|
|
||||||
import dynamic from "next/dynamic";
|
import dynamic from "next/dynamic";
|
||||||
import { SimpleGrid, Skeleton, Stack } from "@mantine/core";
|
|
||||||
|
|
||||||
const BoardLoadingShell = () => (
|
|
||||||
<Stack h="100%" p="md" aria-busy aria-label="Loading dashboard" role="status">
|
|
||||||
<SimpleGrid cols={{ base: 1, sm: 2, lg: 3 }} spacing="md">
|
|
||||||
{[2, 1, 2, 2, 1, 2].map((rows, index) => (
|
|
||||||
<Skeleton
|
|
||||||
key={index}
|
|
||||||
data-homarr-dev-benchmark-board-shell
|
|
||||||
height={rows * 96}
|
|
||||||
radius="var(--mantine-radius-default)"
|
|
||||||
/>
|
|
||||||
))}
|
|
||||||
</SimpleGrid>
|
|
||||||
</Stack>
|
|
||||||
);
|
|
||||||
|
|
||||||
export const DynamicClientBoard = dynamic(() => import("./_client").then((mod) => mod.ClientBoard), {
|
export const DynamicClientBoard = dynamic(() => import("./_client").then((mod) => mod.ClientBoard), {
|
||||||
ssr: false,
|
ssr: false,
|
||||||
loading: BoardLoadingShell,
|
|
||||||
});
|
});
|
||||||
@@ -1,36 +1,45 @@
|
|||||||
"use client";
|
"use client";
|
||||||
|
|
||||||
import { useCallback, useEffect, useState } from "react";
|
import { useCallback, useEffect } from "react";
|
||||||
import dynamic from "next/dynamic";
|
|
||||||
import { useRouter } from "next/navigation";
|
import { useRouter } from "next/navigation";
|
||||||
import { Box, Center, Loader, Menu, ScrollArea } from "@mantine/core";
|
import { OnboardingTour } from "@gfazioli/mantine-onboarding-tour";
|
||||||
|
import { Box, Group, Menu, ScrollArea } from "@mantine/core";
|
||||||
import { useHotkeys } from "@mantine/hooks";
|
import { useHotkeys } from "@mantine/hooks";
|
||||||
import { IconLayoutBoard, IconPencil, IconPencilOff, IconPlus, IconReplace, IconSettings } from "@tabler/icons-react";
|
import {
|
||||||
|
IconBox,
|
||||||
|
IconBoxAlignTop,
|
||||||
|
IconChevronDown,
|
||||||
|
IconLayoutBoard,
|
||||||
|
IconPencil,
|
||||||
|
IconPencilOff,
|
||||||
|
IconPlug,
|
||||||
|
IconPlus,
|
||||||
|
IconReplace,
|
||||||
|
IconResize,
|
||||||
|
IconSettings,
|
||||||
|
} from "@tabler/icons-react";
|
||||||
|
|
||||||
import { clientApi } from "@homarr/api/client";
|
import { clientApi } from "@homarr/api/client";
|
||||||
|
import { useSession } from "@homarr/auth/client";
|
||||||
import { useRequiredBoard } from "@homarr/boards/context";
|
import { useRequiredBoard } from "@homarr/boards/context";
|
||||||
import { useEditMode } from "@homarr/boards/edit-mode";
|
import { useEditMode } from "@homarr/boards/edit-mode";
|
||||||
import { revalidatePathActionAsync } from "@homarr/common/client";
|
import { revalidatePathActionAsync } from "@homarr/common/client";
|
||||||
import { env } from "@homarr/common/env";
|
import { env } from "@homarr/common/env";
|
||||||
import { hotkeys } from "@homarr/definitions";
|
import { hotkeys } from "@homarr/definitions";
|
||||||
import { useConfirmModal } from "@homarr/modals";
|
import { useConfirmModal, useModalAction } from "@homarr/modals";
|
||||||
|
import { AppSelectModal } from "@homarr/modals-collection";
|
||||||
import { showErrorNotification, showSuccessNotification } from "@homarr/notifications";
|
import { showErrorNotification, showSuccessNotification } from "@homarr/notifications";
|
||||||
import { useI18n, useScopedI18n } from "@homarr/translation/client";
|
import { useI18n, useScopedI18n } from "@homarr/translation/client";
|
||||||
import { Link } from "@homarr/ui";
|
import { Link } from "@homarr/ui";
|
||||||
|
|
||||||
|
import { useItemActions } from "~/components/board/items/item-actions";
|
||||||
|
import { ItemSelectModal } from "~/components/board/items/item-select-modal";
|
||||||
import { useBoardPermissions } from "~/components/board/permissions/client";
|
import { useBoardPermissions } from "~/components/board/permissions/client";
|
||||||
|
import { useCategoryActions } from "~/components/board/sections/category/category-actions";
|
||||||
|
import { CategoryEditModal } from "~/components/board/sections/category/category-edit-modal";
|
||||||
|
import { useDynamicSectionActions } from "~/components/board/sections/dynamic/dynamic-actions";
|
||||||
|
import { IntegrationSelectModal } from "~/components/integration/integration-select-modal";
|
||||||
import { HeaderButton } from "~/components/layout/header/button";
|
import { HeaderButton } from "~/components/layout/header/button";
|
||||||
import { TourTarget } from "~/components/layout/header/tour-target";
|
|
||||||
|
|
||||||
const loadBoardAddMenu = () => import("./_board-add-menu");
|
|
||||||
const preloadBoardAddMenu = () => void loadBoardAddMenu().catch(() => undefined);
|
|
||||||
const BoardAddMenu = dynamic(() => loadBoardAddMenu().then(({ BoardAddMenu: AddMenu }) => AddMenu), {
|
|
||||||
loading: () => (
|
|
||||||
<HeaderButton loading>
|
|
||||||
<IconPlus stroke={1.5} />
|
|
||||||
</HeaderButton>
|
|
||||||
),
|
|
||||||
});
|
|
||||||
|
|
||||||
export const BoardContentHeaderActions = ({ demoReadOnly }: { demoReadOnly: boolean }) => {
|
export const BoardContentHeaderActions = ({ demoReadOnly }: { demoReadOnly: boolean }) => {
|
||||||
const [isEditMode] = useEditMode();
|
const [isEditMode] = useEditMode();
|
||||||
@@ -43,16 +52,16 @@ export const BoardContentHeaderActions = ({ demoReadOnly }: { demoReadOnly: bool
|
|||||||
|
|
||||||
return (
|
return (
|
||||||
<>
|
<>
|
||||||
{isEditMode && <BoardAddMenu />}
|
{isEditMode && <AddMenu />}
|
||||||
|
|
||||||
<EditModeMenu demoReadOnly={demoReadOnly} />
|
<EditModeMenu demoReadOnly={demoReadOnly} />
|
||||||
|
|
||||||
{!demoReadOnly && (
|
{!demoReadOnly && (
|
||||||
<TourTarget id="board-settings">
|
<OnboardingTour.Target id="board-settings">
|
||||||
<HeaderButton href={`/boards/${board.name}/settings`}>
|
<HeaderButton href={`/boards/${board.name}/settings`}>
|
||||||
<IconSettings stroke={1.5} />
|
<IconSettings stroke={1.5} />
|
||||||
</HeaderButton>
|
</HeaderButton>
|
||||||
</TourTarget>
|
</OnboardingTour.Target>
|
||||||
)}
|
)}
|
||||||
|
|
||||||
<SelectBoardsMenu />
|
<SelectBoardsMenu />
|
||||||
@@ -60,6 +69,94 @@ export const BoardContentHeaderActions = ({ demoReadOnly }: { demoReadOnly: bool
|
|||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
|
||||||
|
const AddMenu = () => {
|
||||||
|
const { data: session } = useSession();
|
||||||
|
const { openModal: openCategoryEditModal } = useModalAction(CategoryEditModal);
|
||||||
|
const { openModal: openItemSelectModal } = useModalAction(ItemSelectModal);
|
||||||
|
const { openModal: openAppSelectModal } = useModalAction(AppSelectModal);
|
||||||
|
const { openModal: openIntegrationSelectModal } = useModalAction(IntegrationSelectModal);
|
||||||
|
const { addCategoryToEnd } = useCategoryActions();
|
||||||
|
const { addDynamicSection } = useDynamicSectionActions();
|
||||||
|
const { createItem } = useItemActions();
|
||||||
|
const t = useI18n();
|
||||||
|
|
||||||
|
const handleAddCategory = useCallback(
|
||||||
|
() =>
|
||||||
|
openCategoryEditModal(
|
||||||
|
{
|
||||||
|
category: {
|
||||||
|
id: "new",
|
||||||
|
name: "",
|
||||||
|
},
|
||||||
|
onSuccess({ name }) {
|
||||||
|
addCategoryToEnd({ name });
|
||||||
|
},
|
||||||
|
submitLabel: t("section.category.create.submit"),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
title: (t) => t("section.category.create.title"),
|
||||||
|
},
|
||||||
|
),
|
||||||
|
[addCategoryToEnd, openCategoryEditModal, t],
|
||||||
|
);
|
||||||
|
|
||||||
|
const handleSelectItem = useCallback(() => {
|
||||||
|
openItemSelectModal();
|
||||||
|
}, [openItemSelectModal]);
|
||||||
|
|
||||||
|
const handleSelectApp = useCallback(() => {
|
||||||
|
openAppSelectModal({
|
||||||
|
onSelect: (app) => {
|
||||||
|
createItem({
|
||||||
|
kind: "app",
|
||||||
|
options: { appId: app.id },
|
||||||
|
});
|
||||||
|
},
|
||||||
|
withCreate: session?.user.permissions.includes("app-create") ?? false,
|
||||||
|
});
|
||||||
|
}, [openAppSelectModal, createItem]);
|
||||||
|
|
||||||
|
const handleAddIntegration = useCallback(() => {
|
||||||
|
openIntegrationSelectModal({});
|
||||||
|
}, [openIntegrationSelectModal]);
|
||||||
|
|
||||||
|
return (
|
||||||
|
<Menu position="bottom-end">
|
||||||
|
<Menu.Target>
|
||||||
|
<HeaderButton w="auto" px={4}>
|
||||||
|
<Group gap={4} wrap="nowrap">
|
||||||
|
<IconPlus stroke={1.5} />
|
||||||
|
<IconChevronDown color="gray" size={16} />
|
||||||
|
</Group>
|
||||||
|
</HeaderButton>
|
||||||
|
</Menu.Target>
|
||||||
|
<Menu.Dropdown style={{ transform: "translate(-3px, 0)" }}>
|
||||||
|
<Menu.Item leftSection={<IconResize size={20} />} onClick={handleSelectItem}>
|
||||||
|
{t("item.action.create")}
|
||||||
|
</Menu.Item>
|
||||||
|
|
||||||
|
<Menu.Item leftSection={<IconBox size={20} />} onClick={handleSelectApp}>
|
||||||
|
{t("app.action.add")}
|
||||||
|
</Menu.Item>
|
||||||
|
|
||||||
|
<Menu.Item leftSection={<IconPlug size={20} />} onClick={handleAddIntegration}>
|
||||||
|
{t("integration.action.create")}
|
||||||
|
</Menu.Item>
|
||||||
|
|
||||||
|
<Menu.Divider />
|
||||||
|
|
||||||
|
<Menu.Item leftSection={<IconBoxAlignTop size={20} />} onClick={handleAddCategory}>
|
||||||
|
{t("section.category.action.create")}
|
||||||
|
</Menu.Item>
|
||||||
|
|
||||||
|
<Menu.Item leftSection={<IconResize size={20} />} onClick={addDynamicSection}>
|
||||||
|
{t("section.dynamic.action.create")}
|
||||||
|
</Menu.Item>
|
||||||
|
</Menu.Dropdown>
|
||||||
|
</Menu>
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
const EditModeMenu = ({ demoReadOnly }: { demoReadOnly: boolean }) => {
|
const EditModeMenu = ({ demoReadOnly }: { demoReadOnly: boolean }) => {
|
||||||
const [isEditMode, { open, close }] = useEditMode();
|
const [isEditMode, { open, close }] = useEditMode();
|
||||||
const board = useRequiredBoard();
|
const board = useRequiredBoard();
|
||||||
@@ -100,29 +197,21 @@ const EditModeMenu = ({ demoReadOnly }: { demoReadOnly: boolean }) => {
|
|||||||
usePreventLeaveWithDirty(isEditMode);
|
usePreventLeaveWithDirty(isEditMode);
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<TourTarget id="board-edit-mode">
|
<OnboardingTour.Target id="board-edit-mode">
|
||||||
<HeaderButton
|
<HeaderButton onClick={toggle} loading={isPending}>
|
||||||
onClick={toggle}
|
|
||||||
loading={isPending}
|
|
||||||
onFocus={preloadBoardAddMenu}
|
|
||||||
onPointerEnter={preloadBoardAddMenu}
|
|
||||||
>
|
|
||||||
{isEditMode ? <IconPencilOff stroke={1.5} /> : <IconPencil stroke={1.5} />}
|
{isEditMode ? <IconPencilOff stroke={1.5} /> : <IconPencil stroke={1.5} />}
|
||||||
</HeaderButton>
|
</HeaderButton>
|
||||||
</TourTarget>
|
</OnboardingTour.Target>
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
|
||||||
const SelectBoardsMenu = () => {
|
const SelectBoardsMenu = () => {
|
||||||
const [isOpen, setIsOpen] = useState(false);
|
const { data: boards = [] } = clientApi.board.getAllBoards.useQuery();
|
||||||
const utils = clientApi.useUtils();
|
|
||||||
const { data: boards = [], isPending } = clientApi.board.getAllBoards.useQuery(undefined, { enabled: isOpen });
|
|
||||||
const preloadBoards = () => void utils.board.getAllBoards.prefetch();
|
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<TourTarget id="board-switcher">
|
<OnboardingTour.Target id="board-switcher">
|
||||||
<Box onFocus={preloadBoards} onPointerEnter={preloadBoards}>
|
<Box>
|
||||||
<Menu position="bottom-end" opened={isOpen} onChange={setIsOpen}>
|
<Menu position="bottom-end">
|
||||||
<Menu.Target>
|
<Menu.Target>
|
||||||
<HeaderButton w="auto" px={4}>
|
<HeaderButton w="auto" px={4}>
|
||||||
<IconReplace stroke={1.5} />
|
<IconReplace stroke={1.5} />
|
||||||
@@ -130,11 +219,6 @@ const SelectBoardsMenu = () => {
|
|||||||
</Menu.Target>
|
</Menu.Target>
|
||||||
<Menu.Dropdown style={{ transform: "translate(-7px, 0)" }}>
|
<Menu.Dropdown style={{ transform: "translate(-7px, 0)" }}>
|
||||||
<ScrollArea.Autosize mah={300}>
|
<ScrollArea.Autosize mah={300}>
|
||||||
{isPending && (
|
|
||||||
<Center p="xs">
|
|
||||||
<Loader size="xs" />
|
|
||||||
</Center>
|
|
||||||
)}
|
|
||||||
{boards.map((board) => (
|
{boards.map((board) => (
|
||||||
<Menu.Item
|
<Menu.Item
|
||||||
key={board.id}
|
key={board.id}
|
||||||
@@ -149,7 +233,7 @@ const SelectBoardsMenu = () => {
|
|||||||
</Menu.Dropdown>
|
</Menu.Dropdown>
|
||||||
</Menu>
|
</Menu>
|
||||||
</Box>
|
</Box>
|
||||||
</TourTarget>
|
</OnboardingTour.Target>
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -162,13 +246,15 @@ const usePreventLeaveWithDirty = (isDirty: boolean) => {
|
|||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
if (!isDirty) return;
|
if (!isDirty) return;
|
||||||
|
|
||||||
const handleClick = (event: MouseEvent) => {
|
const handleClick = (event: Event) => {
|
||||||
if (event.button !== 0 || event.metaKey || event.ctrlKey || event.shiftKey || event.altKey) return;
|
const target = (event.target as HTMLElement).closest("a");
|
||||||
const target = event.target instanceof Element ? event.target.closest<HTMLAnchorElement>(anchorSelector) : null;
|
|
||||||
if (!target) return;
|
if (!target) {
|
||||||
|
console.warn("No anchor element found for click event", event);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
event.preventDefault();
|
event.preventDefault();
|
||||||
event.stopPropagation();
|
|
||||||
|
|
||||||
openConfirmModal({
|
openConfirmModal({
|
||||||
title: t("board.action.edit.confirmLeave.title"),
|
title: t("board.action.edit.confirmLeave.title"),
|
||||||
@@ -194,14 +280,19 @@ const usePreventLeaveWithDirty = (isDirty: boolean) => {
|
|||||||
event.returnValue = true;
|
event.returnValue = true;
|
||||||
};
|
};
|
||||||
|
|
||||||
document.addEventListener("click", handleClick, true);
|
const anchors = document.querySelectorAll(anchorSelector);
|
||||||
|
anchors.forEach((link) => {
|
||||||
|
link.addEventListener("click", handleClick);
|
||||||
|
});
|
||||||
window.addEventListener("popstate", handlePopState);
|
window.addEventListener("popstate", handlePopState);
|
||||||
window.addEventListener("beforeunload", handleBeforeUnload);
|
window.addEventListener("beforeunload", handleBeforeUnload);
|
||||||
|
|
||||||
return () => {
|
return () => {
|
||||||
document.removeEventListener("click", handleClick, true);
|
anchors.forEach((link) => {
|
||||||
|
link.removeEventListener("click", handleClick);
|
||||||
|
});
|
||||||
window.removeEventListener("popstate", handlePopState);
|
window.removeEventListener("popstate", handlePopState);
|
||||||
window.removeEventListener("beforeunload", handleBeforeUnload);
|
window.removeEventListener("beforeunload", handleBeforeUnload);
|
||||||
};
|
};
|
||||||
}, [isDirty, openConfirmModal, router, t]);
|
}, [isDirty]);
|
||||||
};
|
};
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
import { getBoardByNameAsync } from "@homarr/api/board-server";
|
import { api } from "@homarr/api/server";
|
||||||
|
|
||||||
import { BoardOtherHeaderActions } from "../_header-actions";
|
import { BoardOtherHeaderActions } from "../_header-actions";
|
||||||
import { createBoardLayout } from "../_layout-creator";
|
import { createBoardLayout } from "../_layout-creator";
|
||||||
@@ -6,6 +6,6 @@ import { createBoardLayout } from "../_layout-creator";
|
|||||||
export default createBoardLayout<{ locale: string; name: string }>({
|
export default createBoardLayout<{ locale: string; name: string }>({
|
||||||
headerActions: <BoardOtherHeaderActions />,
|
headerActions: <BoardOtherHeaderActions />,
|
||||||
async getInitialBoardAsync({ name }) {
|
async getInitialBoardAsync({ name }) {
|
||||||
return await getBoardByNameAsync(name);
|
return await api.board.getBoardByName({ name });
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
@@ -19,106 +19,130 @@ import {
|
|||||||
import { useDisclosure } from "@mantine/hooks";
|
import { useDisclosure } from "@mantine/hooks";
|
||||||
import { IconX } from "@tabler/icons-react";
|
import { IconX } from "@tabler/icons-react";
|
||||||
|
|
||||||
import type { UseFormReturnType } from "@homarr/form";
|
import { useZodForm } from "@homarr/form";
|
||||||
import { useI18n } from "@homarr/translation/client";
|
import { useI18n } from "@homarr/translation/client";
|
||||||
|
import { boardSavePartialSettingsSchema } from "@homarr/validation/board";
|
||||||
|
|
||||||
import { SectionCard } from "~/components/manage/section-card";
|
import type { Board } from "../../_types";
|
||||||
import { generateColors } from "../../(content)/_theme";
|
import { generateColors } from "../../(content)/_theme";
|
||||||
import type { FormValues } from "./_settings-form";
|
import { useSavePartialSettingsMutation } from "./_shared";
|
||||||
|
|
||||||
interface Props {
|
interface Props {
|
||||||
form: UseFormReturnType<FormValues>;
|
board: Board;
|
||||||
}
|
}
|
||||||
|
|
||||||
const hexRegex = /^#[0-9a-fA-F]{6}$/;
|
const hexRegex = /^#[0-9a-fA-F]{6}$/;
|
||||||
|
|
||||||
const progressPercentageLabel = (value: number) => `${value}%`;
|
const progressPercentageLabel = (value: number) => `${value}%`;
|
||||||
|
|
||||||
export const ColorSettingsContent = ({ form }: Props) => {
|
export const ColorSettingsContent = ({ board }: Props) => {
|
||||||
|
const form = useZodForm(boardSavePartialSettingsSchema, {
|
||||||
|
initialValues: {
|
||||||
|
primaryColor: board.primaryColor,
|
||||||
|
secondaryColor: board.secondaryColor,
|
||||||
|
opacity: board.opacity,
|
||||||
|
iconColor: board.iconColor ?? "",
|
||||||
|
itemRadius: board.itemRadius,
|
||||||
|
},
|
||||||
|
});
|
||||||
const [showPreview, { toggle }] = useDisclosure(false);
|
const [showPreview, { toggle }] = useDisclosure(false);
|
||||||
const t = useI18n();
|
const t = useI18n();
|
||||||
const theme = useMantineTheme();
|
const theme = useMantineTheme();
|
||||||
|
const { mutate: savePartialSettings, isPending } = useSavePartialSettingsMutation(board);
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<SectionCard title={t("board.setting.section.appearance.title")}>
|
<form
|
||||||
<Grid>
|
onSubmit={form.onSubmit((values) => {
|
||||||
<Grid.Col span={{ sm: 12, md: 6 }}>
|
savePartialSettings({
|
||||||
<Stack gap="xs">
|
id: board.id,
|
||||||
<ColorInput
|
...values,
|
||||||
label={t("board.field.primaryColor.label")}
|
});
|
||||||
format="hex"
|
})}
|
||||||
swatches={Object.values(theme.colors).map((color) => color[6])}
|
>
|
||||||
{...form.getInputProps("primaryColor")}
|
<Stack>
|
||||||
/>
|
<Grid>
|
||||||
</Stack>
|
<Grid.Col span={{ sm: 12, md: 6 }}>
|
||||||
</Grid.Col>
|
<Stack gap="xs">
|
||||||
<Grid.Col span={{ sm: 12, md: 6 }}>
|
<ColorInput
|
||||||
<ColorInput
|
label={t("board.field.primaryColor.label")}
|
||||||
label={t("board.field.secondaryColor.label")}
|
format="hex"
|
||||||
format="hex"
|
swatches={Object.values(theme.colors).map((color) => color[6])}
|
||||||
swatches={Object.values(theme.colors).map((color) => color[6])}
|
{...form.getInputProps("primaryColor")}
|
||||||
{...form.getInputProps("secondaryColor")}
|
/>
|
||||||
/>
|
|
||||||
</Grid.Col>
|
|
||||||
<Grid.Col span={12}>
|
|
||||||
<Anchor onClick={toggle}>{showPreview ? t("common.preview.hide") : t("common.preview.show")}</Anchor>
|
|
||||||
</Grid.Col>
|
|
||||||
<Grid.Col span={12}>
|
|
||||||
<Collapse expanded={showPreview}>
|
|
||||||
<Stack>
|
|
||||||
<ColorsPreview previewColor={form.values.primaryColor} />
|
|
||||||
<ColorsPreview previewColor={form.values.secondaryColor} />
|
|
||||||
</Stack>
|
</Stack>
|
||||||
</Collapse>
|
</Grid.Col>
|
||||||
</Grid.Col>
|
<Grid.Col span={{ sm: 12, md: 6 }}>
|
||||||
<Grid.Col span={{ sm: 12, md: 6 }}>
|
|
||||||
<InputWrapper label={t("board.field.opacity.label")}>
|
|
||||||
<Slider
|
|
||||||
my={6}
|
|
||||||
min={0}
|
|
||||||
max={100}
|
|
||||||
step={5}
|
|
||||||
label={progressPercentageLabel}
|
|
||||||
{...form.getInputProps("opacity")}
|
|
||||||
/>
|
|
||||||
</InputWrapper>
|
|
||||||
</Grid.Col>
|
|
||||||
<Grid.Col span={{ sm: 12, md: 6 }}>
|
|
||||||
<Group align="end">
|
|
||||||
<ColorInput
|
<ColorInput
|
||||||
label={t("board.field.iconColor.label")}
|
label={t("board.field.secondaryColor.label")}
|
||||||
format="hex"
|
format="hex"
|
||||||
swatches={Object.values(theme.colors).map((color) => color[6])}
|
swatches={Object.values(theme.colors).map((color) => color[6])}
|
||||||
flex={1}
|
{...form.getInputProps("secondaryColor")}
|
||||||
{...form.getInputProps("iconColor")}
|
|
||||||
/>
|
/>
|
||||||
<Button
|
</Grid.Col>
|
||||||
type="button"
|
<Grid.Col span={12}>
|
||||||
variant="subtle"
|
<Anchor onClick={toggle}>{showPreview ? t("common.preview.hide") : t("common.preview.show")}</Anchor>
|
||||||
leftSection={<IconX />}
|
</Grid.Col>
|
||||||
onClick={() => form.setFieldValue("iconColor", "")}
|
<Grid.Col span={12}>
|
||||||
disabled={!form.values.iconColor}
|
<Collapse expanded={showPreview}>
|
||||||
>
|
<Stack>
|
||||||
{t("board.field.clearColor.label")}
|
<ColorsPreview previewColor={form.values.primaryColor} />
|
||||||
</Button>
|
<ColorsPreview previewColor={form.values.secondaryColor} />
|
||||||
</Group>
|
</Stack>
|
||||||
</Grid.Col>
|
</Collapse>
|
||||||
<Grid.Col span={{ sm: 12, md: 6 }}>
|
</Grid.Col>
|
||||||
<Select
|
<Grid.Col span={{ sm: 12, md: 6 }}>
|
||||||
label={t("board.field.itemRadius.label")}
|
<InputWrapper label={t("board.field.opacity.label")}>
|
||||||
description={t("board.field.itemRadius.description")}
|
<Slider
|
||||||
data={[
|
my={6}
|
||||||
{ label: t("board.field.itemRadius.option.xs"), value: "xs" },
|
min={0}
|
||||||
{ label: t("board.field.itemRadius.option.sm"), value: "sm" },
|
max={100}
|
||||||
{ label: t("board.field.itemRadius.option.md"), value: "md" },
|
step={5}
|
||||||
{ label: t("board.field.itemRadius.option.lg"), value: "lg" },
|
label={progressPercentageLabel}
|
||||||
{ label: t("board.field.itemRadius.option.xl"), value: "xl" },
|
{...form.getInputProps("opacity")}
|
||||||
]}
|
/>
|
||||||
{...form.getInputProps("itemRadius")}
|
</InputWrapper>
|
||||||
/>
|
</Grid.Col>
|
||||||
</Grid.Col>
|
<Grid.Col span={{ sm: 12, md: 6 }}>
|
||||||
</Grid>
|
<Group align="end">
|
||||||
</SectionCard>
|
<ColorInput
|
||||||
|
label={t("board.field.iconColor.label")}
|
||||||
|
format="hex"
|
||||||
|
swatches={Object.values(theme.colors).map((color) => color[6])}
|
||||||
|
flex={1}
|
||||||
|
{...form.getInputProps("iconColor")}
|
||||||
|
/>
|
||||||
|
<Button
|
||||||
|
variant="subtle"
|
||||||
|
leftSection={<IconX />}
|
||||||
|
onClick={() => form.setFieldValue("iconColor", "")}
|
||||||
|
disabled={!form.values.iconColor}
|
||||||
|
>
|
||||||
|
{t("board.field.clearColor.label")}
|
||||||
|
</Button>
|
||||||
|
</Group>
|
||||||
|
</Grid.Col>
|
||||||
|
<Grid.Col span={{ sm: 12, md: 6 }}>
|
||||||
|
<Select
|
||||||
|
label={t("board.field.itemRadius.label")}
|
||||||
|
description={t("board.field.itemRadius.description")}
|
||||||
|
data={[
|
||||||
|
{ label: t("board.field.itemRadius.option.xs"), value: "xs" },
|
||||||
|
{ label: t("board.field.itemRadius.option.sm"), value: "sm" },
|
||||||
|
{ label: t("board.field.itemRadius.option.md"), value: "md" },
|
||||||
|
{ label: t("board.field.itemRadius.option.lg"), value: "lg" },
|
||||||
|
{ label: t("board.field.itemRadius.option.xl"), value: "xl" },
|
||||||
|
]}
|
||||||
|
{...form.getInputProps("itemRadius")}
|
||||||
|
/>
|
||||||
|
</Grid.Col>
|
||||||
|
</Grid>
|
||||||
|
<Group justify="end">
|
||||||
|
<Button type="submit" loading={isPending}>
|
||||||
|
{t("common.action.saveChanges")}
|
||||||
|
</Button>
|
||||||
|
</Group>
|
||||||
|
</Stack>
|
||||||
|
</form>
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|||||||
@@ -1,32 +1,41 @@
|
|||||||
"use client";
|
"use client";
|
||||||
|
|
||||||
import { startTransition } from "react";
|
import { startTransition } from "react";
|
||||||
import { ActionIcon, Autocomplete, Center, Grid, Group, Popover, Stack, Text } from "@mantine/core";
|
import { ActionIcon, Autocomplete, Button, Center, Grid, Group, Popover, Stack, Text } from "@mantine/core";
|
||||||
import { useDebouncedValue } from "@mantine/hooks";
|
import { useDebouncedValue } from "@mantine/hooks";
|
||||||
import { IconPhotoOff, IconUpload } from "@tabler/icons-react";
|
import { IconPhotoOff, IconUpload } from "@tabler/icons-react";
|
||||||
|
|
||||||
import { clientApi } from "@homarr/api/client";
|
import { clientApi } from "@homarr/api/client";
|
||||||
import { useSession } from "@homarr/auth/client";
|
import { useSession } from "@homarr/auth/client";
|
||||||
import { backgroundImageAttachments, backgroundImageRepeats, backgroundImageSizes } from "@homarr/definitions";
|
import { backgroundImageAttachments, backgroundImageRepeats, backgroundImageSizes } from "@homarr/definitions";
|
||||||
import type { UseFormReturnType } from "@homarr/form";
|
import { useZodForm } from "@homarr/form";
|
||||||
import { UploadMedia } from "@homarr/forms-collection";
|
import { UploadMedia } from "@homarr/forms-collection";
|
||||||
import type { TranslationObject } from "@homarr/translation";
|
import type { TranslationObject } from "@homarr/translation";
|
||||||
import { useI18n } from "@homarr/translation/client";
|
import { useI18n } from "@homarr/translation/client";
|
||||||
import type { SelectItemWithDescriptionBadge } from "@homarr/ui";
|
import type { SelectItemWithDescriptionBadge } from "@homarr/ui";
|
||||||
import { SelectWithDescriptionBadge } from "@homarr/ui";
|
import { SelectWithDescriptionBadge } from "@homarr/ui";
|
||||||
|
import { boardSavePartialSettingsSchema } from "@homarr/validation/board";
|
||||||
|
|
||||||
import { SectionCard } from "~/components/manage/section-card";
|
import type { Board } from "../../_types";
|
||||||
import type { FormValues } from "./_settings-form";
|
import { useSavePartialSettingsMutation } from "./_shared";
|
||||||
|
|
||||||
interface Props {
|
interface Props {
|
||||||
form: UseFormReturnType<FormValues>;
|
board: Board;
|
||||||
}
|
}
|
||||||
|
export const BackgroundSettingsContent = ({ board }: Props) => {
|
||||||
export const BackgroundSettingsContent = ({ form }: Props) => {
|
|
||||||
const t = useI18n();
|
const t = useI18n();
|
||||||
const { data: session } = useSession();
|
const { data: session } = useSession();
|
||||||
|
const { mutate: savePartialSettings, isPending } = useSavePartialSettingsMutation(board);
|
||||||
|
const form = useZodForm(boardSavePartialSettingsSchema, {
|
||||||
|
initialValues: {
|
||||||
|
backgroundImageUrl: board.backgroundImageUrl ?? "",
|
||||||
|
backgroundImageAttachment: board.backgroundImageAttachment,
|
||||||
|
backgroundImageRepeat: board.backgroundImageRepeat,
|
||||||
|
backgroundImageSize: board.backgroundImageSize,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
const [debouncedSearch] = useDebouncedValue(form.values.backgroundImageUrl ?? "", 200);
|
const [debouncedSearch] = useDebouncedValue(form.values.backgroundImageUrl, 200);
|
||||||
const medias = clientApi.media.getPaginated.useQuery({
|
const medias = clientApi.media.getPaginated.useQuery({
|
||||||
page: 1,
|
page: 1,
|
||||||
pageSize: 10,
|
pageSize: 10,
|
||||||
@@ -44,106 +53,121 @@ export const BackgroundSettingsContent = ({ form }: Props) => {
|
|||||||
const backgroundImageRepeatData = useBackgroundOptionData("backgroundImageRepeat", backgroundImageRepeats);
|
const backgroundImageRepeatData = useBackgroundOptionData("backgroundImageRepeat", backgroundImageRepeats);
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<SectionCard title={t("board.setting.section.background.title")}>
|
<form
|
||||||
<Grid>
|
onSubmit={form.onSubmit((values) => {
|
||||||
<Grid.Col span={12}>
|
savePartialSettings({
|
||||||
<Group wrap="nowrap" gap="xs" w="100%" align="start">
|
id: board.id,
|
||||||
<Autocomplete
|
...values,
|
||||||
flex={1}
|
});
|
||||||
leftSection={
|
})}
|
||||||
form.values.backgroundImageUrl &&
|
>
|
||||||
form.values.backgroundImageUrl.trim().length >= 2 && (
|
<Stack>
|
||||||
<Popover width={300} withArrow>
|
<Grid>
|
||||||
<Popover.Target>
|
<Grid.Col span={12}>
|
||||||
<Center h="100%">
|
<Group wrap="nowrap" gap="xs" w="100%" align="start">
|
||||||
<ImagePreview src={form.values.backgroundImageUrl} w={20} h={20} />
|
<Autocomplete
|
||||||
</Center>
|
flex={1}
|
||||||
</Popover.Target>
|
leftSection={
|
||||||
<Popover.Dropdown>
|
form.values.backgroundImageUrl &&
|
||||||
<ImagePreview src={form.values.backgroundImageUrl} w="100%" />
|
form.values.backgroundImageUrl.trim().length >= 2 && (
|
||||||
</Popover.Dropdown>
|
<Popover width={300} withArrow>
|
||||||
</Popover>
|
<Popover.Target>
|
||||||
)
|
<Center h="100%">
|
||||||
}
|
<ImagePreview src={form.values.backgroundImageUrl} w={20} h={20} />
|
||||||
// We filter it on the server
|
</Center>
|
||||||
filter={({ options }) => options}
|
</Popover.Target>
|
||||||
label={t("board.field.backgroundImageUrl.label")}
|
<Popover.Dropdown>
|
||||||
placeholder={`${t("board.field.backgroundImageUrl.placeholder")}...`}
|
<ImagePreview src={form.values.backgroundImageUrl} w="100%" />
|
||||||
renderOption={({ option }) => {
|
</Popover.Dropdown>
|
||||||
const current = imageMap.get(option.value);
|
</Popover>
|
||||||
if (!current) return null;
|
)
|
||||||
|
}
|
||||||
|
// We filter it on the server
|
||||||
|
filter={({ options }) => options}
|
||||||
|
label={t("board.field.backgroundImageUrl.label")}
|
||||||
|
placeholder={`${t("board.field.backgroundImageUrl.placeholder")}...`}
|
||||||
|
renderOption={({ option }) => {
|
||||||
|
const current = imageMap.get(option.value);
|
||||||
|
if (!current) return null;
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<Group gap="sm">
|
<Group gap="sm">
|
||||||
<ImagePreview src={option.value} w={20} h={20} />
|
<ImagePreview src={option.value} w={20} h={20} />
|
||||||
<Stack gap={0}>
|
<Stack gap={0}>
|
||||||
<Text size="sm">{current.name}</Text>
|
<Text size="sm">{current.name}</Text>
|
||||||
<Text size="xs" c="dimmed">
|
<Text size="xs" c="dimmed">
|
||||||
{option.value}
|
{option.value}
|
||||||
</Text>
|
</Text>
|
||||||
</Stack>
|
</Stack>
|
||||||
</Group>
|
</Group>
|
||||||
);
|
);
|
||||||
}}
|
|
||||||
data={[
|
|
||||||
{
|
|
||||||
group: t("board.field.backgroundImageUrl.group.your"),
|
|
||||||
items: images
|
|
||||||
.filter((media) => media.creatorId === session?.user.id)
|
|
||||||
.map((media) => `/api/user-medias/${media.id}`),
|
|
||||||
},
|
|
||||||
{
|
|
||||||
group: t("board.field.backgroundImageUrl.group.other"),
|
|
||||||
items: images
|
|
||||||
.filter((media) => media.creatorId !== session?.user.id)
|
|
||||||
.map((media) => `/api/user-medias/${media.id}`),
|
|
||||||
},
|
|
||||||
]}
|
|
||||||
{...form.getInputProps("backgroundImageUrl")}
|
|
||||||
/>
|
|
||||||
{session?.user.permissions.includes("media-upload") && (
|
|
||||||
<UploadMedia
|
|
||||||
onSuccess={(uploadedMedias) => {
|
|
||||||
const first = uploadedMedias.at(0);
|
|
||||||
if (!first) return;
|
|
||||||
|
|
||||||
startTransition(() => {
|
|
||||||
form.setFieldValue("backgroundImageUrl", first.url);
|
|
||||||
});
|
|
||||||
}}
|
}}
|
||||||
>
|
data={[
|
||||||
{({ onClick, loading }) => (
|
{
|
||||||
<ActionIcon onClick={onClick} loading={loading} mt={24} size={36} variant="default">
|
group: t("board.field.backgroundImageUrl.group.your"),
|
||||||
<IconUpload size={16} stroke={1.5} />
|
items: images
|
||||||
</ActionIcon>
|
.filter((media) => media.creatorId === session?.user.id)
|
||||||
)}
|
.map((media) => `/api/user-medias/${media.id}`),
|
||||||
</UploadMedia>
|
},
|
||||||
)}
|
{
|
||||||
</Group>
|
group: t("board.field.backgroundImageUrl.group.other"),
|
||||||
</Grid.Col>
|
items: images
|
||||||
<Grid.Col span={12}>
|
.filter((media) => media.creatorId !== session?.user.id)
|
||||||
<SelectWithDescriptionBadge
|
.map((media) => `/api/user-medias/${media.id}`),
|
||||||
label={t("board.field.backgroundImageAttachment.label")}
|
},
|
||||||
data={backgroundImageAttachmentData}
|
]}
|
||||||
{...form.getInputProps("backgroundImageAttachment")}
|
{...form.getInputProps("backgroundImageUrl")}
|
||||||
/>
|
/>
|
||||||
</Grid.Col>
|
{session?.user.permissions.includes("media-upload") && (
|
||||||
<Grid.Col span={12}>
|
<UploadMedia
|
||||||
<SelectWithDescriptionBadge
|
onSuccess={(medias) => {
|
||||||
label={t("board.field.backgroundImageSize.label")}
|
const first = medias.at(0);
|
||||||
data={backgroundImageSizeData}
|
if (!first) return;
|
||||||
{...form.getInputProps("backgroundImageSize")}
|
|
||||||
/>
|
startTransition(() => {
|
||||||
</Grid.Col>
|
form.setFieldValue("backgroundImageUrl", first.url);
|
||||||
<Grid.Col span={12}>
|
});
|
||||||
<SelectWithDescriptionBadge
|
}}
|
||||||
label={t("board.field.backgroundImageRepeat.label")}
|
>
|
||||||
data={backgroundImageRepeatData}
|
{({ onClick, loading }) => (
|
||||||
{...form.getInputProps("backgroundImageRepeat")}
|
<ActionIcon onClick={onClick} loading={loading} mt={24} size={36} variant="default">
|
||||||
/>
|
<IconUpload size={16} stroke={1.5} />
|
||||||
</Grid.Col>
|
</ActionIcon>
|
||||||
</Grid>
|
)}
|
||||||
</SectionCard>
|
</UploadMedia>
|
||||||
|
)}
|
||||||
|
</Group>
|
||||||
|
</Grid.Col>
|
||||||
|
<Grid.Col span={12}>
|
||||||
|
<SelectWithDescriptionBadge
|
||||||
|
label={t("board.field.backgroundImageAttachment.label")}
|
||||||
|
data={backgroundImageAttachmentData}
|
||||||
|
{...form.getInputProps("backgroundImageAttachment")}
|
||||||
|
/>
|
||||||
|
</Grid.Col>
|
||||||
|
<Grid.Col span={12}>
|
||||||
|
<SelectWithDescriptionBadge
|
||||||
|
label={t("board.field.backgroundImageSize.label")}
|
||||||
|
data={backgroundImageSizeData}
|
||||||
|
{...form.getInputProps("backgroundImageSize")}
|
||||||
|
/>
|
||||||
|
</Grid.Col>
|
||||||
|
<Grid.Col span={12}>
|
||||||
|
<SelectWithDescriptionBadge
|
||||||
|
label={t("board.field.backgroundImageRepeat.label")}
|
||||||
|
data={backgroundImageRepeatData}
|
||||||
|
{...form.getInputProps("backgroundImageRepeat")}
|
||||||
|
/>
|
||||||
|
</Grid.Col>
|
||||||
|
</Grid>
|
||||||
|
|
||||||
|
<Group justify="end">
|
||||||
|
<Button type="submit" loading={isPending}>
|
||||||
|
{t("common.action.saveChanges")}
|
||||||
|
</Button>
|
||||||
|
</Group>
|
||||||
|
</Stack>
|
||||||
|
</form>
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|||||||
@@ -1,27 +1,48 @@
|
|||||||
"use client";
|
"use client";
|
||||||
|
|
||||||
import { Switch } from "@mantine/core";
|
import { Button, Group, Stack, Switch } from "@mantine/core";
|
||||||
|
|
||||||
import type { UseFormReturnType } from "@homarr/form";
|
import { useForm } from "@homarr/form";
|
||||||
import { useI18n } from "@homarr/translation/client";
|
import { useI18n } from "@homarr/translation/client";
|
||||||
|
|
||||||
import { SectionCard } from "~/components/manage/section-card";
|
import type { Board } from "../../_types";
|
||||||
import type { FormValues } from "./_settings-form";
|
import { useSavePartialSettingsMutation } from "./_shared";
|
||||||
|
|
||||||
interface Props {
|
interface Props {
|
||||||
form: UseFormReturnType<FormValues>;
|
board: Board;
|
||||||
}
|
}
|
||||||
|
|
||||||
export const BehaviorSettingsContent = ({ form }: Props) => {
|
export const BehaviorSettingsContent = ({ board }: Props) => {
|
||||||
const t = useI18n();
|
const t = useI18n();
|
||||||
|
const { mutate: savePartialSettings, isPending } = useSavePartialSettingsMutation(board);
|
||||||
|
const form = useForm({
|
||||||
|
initialValues: {
|
||||||
|
disableStatus: board.disableStatus,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<SectionCard title={t("board.setting.section.behavior.title")}>
|
<form
|
||||||
<Switch
|
onSubmit={form.onSubmit((values) => {
|
||||||
label={t("board.field.disableStatus.label")}
|
savePartialSettings({
|
||||||
description={t("board.field.disableStatus.description")}
|
id: board.id,
|
||||||
{...form.getInputProps("disableStatus", { type: "checkbox" })}
|
...values,
|
||||||
/>
|
});
|
||||||
</SectionCard>
|
})}
|
||||||
|
>
|
||||||
|
<Stack>
|
||||||
|
<Switch
|
||||||
|
label={t("board.field.disableStatus.label")}
|
||||||
|
description={t("board.field.disableStatus.description")}
|
||||||
|
{...form.getInputProps("disableStatus", { type: "checkbox" })}
|
||||||
|
/>
|
||||||
|
|
||||||
|
<Group justify="end">
|
||||||
|
<Button type="submit" loading={isPending}>
|
||||||
|
{t("common.action.saveChanges")}
|
||||||
|
</Button>
|
||||||
|
</Group>
|
||||||
|
</Stack>
|
||||||
|
</form>
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
"use client";
|
"use client";
|
||||||
|
|
||||||
import { Alert, Input } from "@mantine/core";
|
import { Alert, Button, Group, Input, Stack } from "@mantine/core";
|
||||||
import { highlight, languages } from "prismjs";
|
import { highlight, languages } from "prismjs";
|
||||||
import Editor from "react-simple-code-editor";
|
import Editor from "react-simple-code-editor";
|
||||||
|
|
||||||
@@ -8,39 +8,59 @@ import "~/styles/prismjs.scss";
|
|||||||
|
|
||||||
import { IconInfoCircle } from "@tabler/icons-react";
|
import { IconInfoCircle } from "@tabler/icons-react";
|
||||||
|
|
||||||
import type { UseFormReturnType } from "@homarr/form";
|
import { useForm } from "@homarr/form";
|
||||||
import { useI18n, useScopedI18n } from "@homarr/translation/client";
|
import { useI18n, useScopedI18n } from "@homarr/translation/client";
|
||||||
|
|
||||||
import { SectionCard } from "~/components/manage/section-card";
|
import type { Board } from "../../_types";
|
||||||
import type { FormValues } from "./_settings-form";
|
import { useSavePartialSettingsMutation } from "./_shared";
|
||||||
import classes from "./customcss.module.css";
|
import classes from "./customcss.module.css";
|
||||||
|
|
||||||
interface Props {
|
interface Props {
|
||||||
form: UseFormReturnType<FormValues>;
|
board: Board;
|
||||||
}
|
}
|
||||||
|
|
||||||
export const CustomCssSettingsContent = ({ form }: Props) => {
|
export const CustomCssSettingsContent = ({ board }: Props) => {
|
||||||
const t = useI18n();
|
const t = useI18n();
|
||||||
const customCssT = useScopedI18n("board.field.customCss");
|
const customCssT = useScopedI18n("board.field.customCss");
|
||||||
|
const { mutate: savePartialSettings, isPending } = useSavePartialSettingsMutation(board);
|
||||||
|
const form = useForm({
|
||||||
|
initialValues: {
|
||||||
|
customCss: board.customCss ?? "",
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<SectionCard title={t("board.setting.section.customCss.title")}>
|
<form
|
||||||
<CustomCssInput {...form.getInputProps("customCss")} />
|
onSubmit={form.onSubmit((values) => {
|
||||||
|
savePartialSettings({
|
||||||
|
id: board.id,
|
||||||
|
...values,
|
||||||
|
});
|
||||||
|
})}
|
||||||
|
>
|
||||||
|
<Stack>
|
||||||
|
<CustomCssInput {...form.getInputProps("customCss")} />
|
||||||
|
|
||||||
<Alert variant="light" color="cyan" title={customCssT("customClassesAlert.title")} icon={<IconInfoCircle />}>
|
<Alert variant="light" color="cyan" title={customCssT("customClassesAlert.title")} icon={<IconInfoCircle />}>
|
||||||
{customCssT("customClassesAlert.description")}
|
{customCssT("customClassesAlert.description")}
|
||||||
</Alert>
|
</Alert>
|
||||||
</SectionCard>
|
|
||||||
|
<Group justify="end">
|
||||||
|
<Button type="submit" loading={isPending}>
|
||||||
|
{t("common.action.saveChanges")}
|
||||||
|
</Button>
|
||||||
|
</Group>
|
||||||
|
</Stack>
|
||||||
|
</form>
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
|
||||||
interface CustomCssInputProps {
|
interface CustomCssInputProps {
|
||||||
value?: string;
|
value?: string;
|
||||||
onChange: (value: string) => void;
|
onChange: (value: string) => void;
|
||||||
error?: React.ReactNode;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
const CustomCssInput = ({ value, onChange, error }: CustomCssInputProps) => {
|
const CustomCssInput = ({ value, onChange }: CustomCssInputProps) => {
|
||||||
const customCssT = useScopedI18n("board.field.customCss");
|
const customCssT = useScopedI18n("board.field.customCss");
|
||||||
|
|
||||||
return (
|
return (
|
||||||
@@ -50,7 +70,6 @@ const CustomCssInput = ({ value, onChange, error }: CustomCssInputProps) => {
|
|||||||
htmlFor: "custom-css",
|
htmlFor: "custom-css",
|
||||||
}}
|
}}
|
||||||
description={customCssT("description")}
|
description={customCssT("description")}
|
||||||
error={error}
|
|
||||||
inputWrapperOrder={["label", "description", "input", "error"]}
|
inputWrapperOrder={["label", "description", "input", "error"]}
|
||||||
>
|
>
|
||||||
<div className={classes.codeEditorRoot}>
|
<div className={classes.codeEditorRoot}>
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
import { useCallback } from "react";
|
import { useCallback } from "react";
|
||||||
import { useRouter } from "next/navigation";
|
import { useRouter } from "next/navigation";
|
||||||
import { Button } from "@mantine/core";
|
import { Button, Divider, Group, Stack, Text } from "@mantine/core";
|
||||||
|
|
||||||
import { clientApi } from "@homarr/api/client";
|
import { clientApi } from "@homarr/api/client";
|
||||||
import { useRequiredBoard } from "@homarr/boards/context";
|
import { useRequiredBoard } from "@homarr/boards/context";
|
||||||
@@ -10,7 +10,7 @@ import { useConfirmModal, useModalAction } from "@homarr/modals";
|
|||||||
import { useScopedI18n } from "@homarr/translation/client";
|
import { useScopedI18n } from "@homarr/translation/client";
|
||||||
|
|
||||||
import { BoardRenameModal } from "~/components/board/modals/board-rename-modal";
|
import { BoardRenameModal } from "~/components/board/modals/board-rename-modal";
|
||||||
import { DangerZoneItem, DangerZoneRoot } from "~/components/manage/danger-zone";
|
import classes from "./danger.module.css";
|
||||||
|
|
||||||
export const DangerZoneSettingsContent = ({ hideVisibility }: { hideVisibility: boolean }) => {
|
export const DangerZoneSettingsContent = ({ hideVisibility }: { hideVisibility: boolean }) => {
|
||||||
const board = useRequiredBoard();
|
const board = useRequiredBoard();
|
||||||
@@ -82,36 +82,60 @@ export const DangerZoneSettingsContent = ({ hideVisibility }: { hideVisibility:
|
|||||||
}, [board.id, deleteBoard, router, t, openConfirmModal]);
|
}, [board.id, deleteBoard, router, t, openConfirmModal]);
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<DangerZoneRoot>
|
<Stack gap="sm">
|
||||||
<DangerZoneItem
|
<Divider />
|
||||||
|
<DangerZoneRow
|
||||||
label={t("section.dangerZone.action.rename.label")}
|
label={t("section.dangerZone.action.rename.label")}
|
||||||
description={t("section.dangerZone.action.rename.description")}
|
description={t("section.dangerZone.action.rename.description")}
|
||||||
action={
|
buttonText={t("section.dangerZone.action.rename.button")}
|
||||||
<Button variant="subtle" color="red" onClick={onRenameClick}>
|
onClick={onRenameClick}
|
||||||
{t("section.dangerZone.action.rename.button")}
|
|
||||||
</Button>
|
|
||||||
}
|
|
||||||
/>
|
/>
|
||||||
{!hideVisibility && (
|
{hideVisibility ? null : (
|
||||||
<DangerZoneItem
|
<>
|
||||||
label={t("section.dangerZone.action.visibility.label")}
|
<Divider />
|
||||||
description={t(`section.dangerZone.action.visibility.description.${visibility}`)}
|
<DangerZoneRow
|
||||||
action={
|
label={t("section.dangerZone.action.visibility.label")}
|
||||||
<Button variant="subtle" color="red" loading={isChangeVisibilityPending} onClick={onVisibilityClick}>
|
description={t(`section.dangerZone.action.visibility.description.${visibility}`)}
|
||||||
{t(`section.dangerZone.action.visibility.button.${visibility}`)}
|
buttonText={t(`section.dangerZone.action.visibility.button.${visibility}`)}
|
||||||
</Button>
|
onClick={onVisibilityClick}
|
||||||
}
|
isPending={isChangeVisibilityPending}
|
||||||
/>
|
/>
|
||||||
|
</>
|
||||||
)}
|
)}
|
||||||
<DangerZoneItem
|
<Divider />
|
||||||
|
<DangerZoneRow
|
||||||
label={t("section.dangerZone.action.delete.label")}
|
label={t("section.dangerZone.action.delete.label")}
|
||||||
description={t("section.dangerZone.action.delete.description")}
|
description={t("section.dangerZone.action.delete.description")}
|
||||||
action={
|
buttonText={t("section.dangerZone.action.delete.button")}
|
||||||
<Button variant="subtle" color="red" loading={isDeletePending} onClick={onDeleteClick}>
|
onClick={onDeleteClick}
|
||||||
{t("section.dangerZone.action.delete.button")}
|
isPending={isDeletePending}
|
||||||
</Button>
|
|
||||||
}
|
|
||||||
/>
|
/>
|
||||||
</DangerZoneRoot>
|
</Stack>
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
interface DangerZoneRowProps {
|
||||||
|
label: string;
|
||||||
|
description: string;
|
||||||
|
buttonText: string;
|
||||||
|
isPending?: boolean;
|
||||||
|
onClick: () => void;
|
||||||
|
}
|
||||||
|
|
||||||
|
const DangerZoneRow = ({ label, description, buttonText, onClick, isPending }: DangerZoneRowProps) => {
|
||||||
|
return (
|
||||||
|
<Group justify="space-between" px="md" className={classes.dangerZoneGroup}>
|
||||||
|
<Stack gap={0}>
|
||||||
|
<Text fw="bold" size="sm">
|
||||||
|
{label}
|
||||||
|
</Text>
|
||||||
|
<Text size="sm">{description}</Text>
|
||||||
|
</Stack>
|
||||||
|
<Group justify="end" w={{ base: "100%", xs: "auto" }}>
|
||||||
|
<Button variant="subtle" color="red" loading={isPending} onClick={onClick}>
|
||||||
|
{buttonText}
|
||||||
|
</Button>
|
||||||
|
</Group>
|
||||||
|
</Group>
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
@@ -1,66 +1,128 @@
|
|||||||
"use client";
|
"use client";
|
||||||
|
|
||||||
import { useEffect } from "react";
|
import { useEffect, useRef } from "react";
|
||||||
import { Grid, Loader, TextInput } from "@mantine/core";
|
import { Button, Grid, Group, Loader, Stack, TextInput } from "@mantine/core";
|
||||||
import { useDebouncedValue, useDocumentTitle } from "@mantine/hooks";
|
import { useDebouncedValue, useDocumentTitle } from "@mantine/hooks";
|
||||||
|
|
||||||
import { useUpdateBoard } from "@homarr/boards/updater";
|
import { useUpdateBoard } from "@homarr/boards/updater";
|
||||||
import type { UseFormReturnType } from "@homarr/form";
|
import { useZodForm } from "@homarr/form";
|
||||||
import { IconPicker } from "@homarr/forms-collection";
|
import { IconPicker } from "@homarr/forms-collection";
|
||||||
import { useI18n } from "@homarr/translation/client";
|
import { useI18n } from "@homarr/translation/client";
|
||||||
|
import { boardSavePartialSettingsSchema } from "@homarr/validation/board";
|
||||||
|
|
||||||
import { SectionCard } from "~/components/manage/section-card";
|
import { homarrLogoPath } from "~/components/layout/logo/homarr-logo";
|
||||||
import { createMetaTitle } from "~/metadata";
|
import { createMetaTitle } from "~/metadata";
|
||||||
import type { Board } from "../../_types";
|
import type { Board } from "../../_types";
|
||||||
import type { FormValues } from "./_settings-form";
|
import { useSavePartialSettingsMutation } from "./_shared";
|
||||||
|
|
||||||
interface Props {
|
interface Props {
|
||||||
board: Board;
|
board: Board;
|
||||||
form: UseFormReturnType<FormValues>;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export const GeneralSettingsContent = ({ board, form }: Props) => {
|
export const GeneralSettingsContent = ({ board }: Props) => {
|
||||||
const t = useI18n();
|
const t = useI18n();
|
||||||
|
const ref = useRef({
|
||||||
|
pageTitle: board.pageTitle,
|
||||||
|
logoImageUrl: board.logoImageUrl,
|
||||||
|
});
|
||||||
|
const { updateBoard } = useUpdateBoard();
|
||||||
|
|
||||||
|
const { mutate: savePartialSettings, isPending } = useSavePartialSettingsMutation(board);
|
||||||
|
const form = useZodForm(
|
||||||
|
boardSavePartialSettingsSchema
|
||||||
|
.pick({
|
||||||
|
pageTitle: true,
|
||||||
|
logoImageUrl: true,
|
||||||
|
metaTitle: true,
|
||||||
|
faviconImageUrl: true,
|
||||||
|
})
|
||||||
|
.required(),
|
||||||
|
{
|
||||||
|
initialValues: {
|
||||||
|
pageTitle: board.pageTitle ?? "",
|
||||||
|
logoImageUrl: board.logoImageUrl ?? "",
|
||||||
|
metaTitle: board.metaTitle ?? "",
|
||||||
|
faviconImageUrl: board.faviconImageUrl ?? "",
|
||||||
|
},
|
||||||
|
onValuesChange({ pageTitle }) {
|
||||||
|
updateBoard((previous) => ({
|
||||||
|
...previous,
|
||||||
|
pageTitle,
|
||||||
|
}));
|
||||||
|
},
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
useLogoPreview(form.values.logoImageUrl);
|
useLogoPreview(form.values.logoImageUrl);
|
||||||
const metaTitleStatus = useMetaTitlePreview(form.values.metaTitle);
|
const metaTitleStatus = useMetaTitlePreview(form.values.metaTitle);
|
||||||
|
|
||||||
|
// Cleanup for not applied changes of the page title and logo image URL
|
||||||
|
useEffect(() => {
|
||||||
|
return () => {
|
||||||
|
updateBoard((previous) => ({
|
||||||
|
...previous,
|
||||||
|
pageTitle: ref.current.pageTitle,
|
||||||
|
logoImageUrl: ref.current.logoImageUrl,
|
||||||
|
}));
|
||||||
|
};
|
||||||
|
}, [updateBoard]);
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<SectionCard title={t("board.setting.section.general.title")}>
|
<form
|
||||||
<Grid>
|
onSubmit={form.onSubmit((values) => {
|
||||||
<Grid.Col span={{ xs: 12, md: 6 }}>
|
// Save the current values to the ref so that it does not reset if the form is submitted
|
||||||
<TextInput
|
ref.current = {
|
||||||
label={t("board.field.pageTitle.label")}
|
pageTitle: values.pageTitle,
|
||||||
placeholder="Homarr"
|
logoImageUrl: values.logoImageUrl,
|
||||||
{...form.getInputProps("pageTitle")}
|
};
|
||||||
/>
|
updateFavicon(values.faviconImageUrl ?? homarrLogoPath);
|
||||||
</Grid.Col>
|
savePartialSettings({
|
||||||
<Grid.Col span={{ xs: 12, md: 6 }}>
|
id: board.id,
|
||||||
<TextInput
|
...values,
|
||||||
label={t("board.field.metaTitle.label")}
|
});
|
||||||
placeholder={createMetaTitle(t("board.content.metaTitle", { boardName: board.name }))}
|
})}
|
||||||
rightSection={metaTitleStatus.isPending && <Loader size="xs" />}
|
>
|
||||||
{...form.getInputProps("metaTitle")}
|
<Stack>
|
||||||
/>
|
<Grid>
|
||||||
</Grid.Col>
|
<Grid.Col span={{ xs: 12, md: 6 }}>
|
||||||
<Grid.Col span={{ xs: 12, md: 6 }}>
|
<TextInput
|
||||||
<IconPicker
|
label={t("board.field.pageTitle.label")}
|
||||||
{...form.getInputProps("logoImageUrl")}
|
placeholder="Homarr"
|
||||||
label={t("board.field.logoImageUrl.label")}
|
{...form.getInputProps("pageTitle")}
|
||||||
placeholder="/logo/logo.png"
|
/>
|
||||||
withAsterisk={false}
|
</Grid.Col>
|
||||||
/>
|
<Grid.Col span={{ xs: 12, md: 6 }}>
|
||||||
</Grid.Col>
|
<TextInput
|
||||||
<Grid.Col span={{ xs: 12, md: 6 }}>
|
label={t("board.field.metaTitle.label")}
|
||||||
<IconPicker
|
placeholder={createMetaTitle(t("board.content.metaTitle", { boardName: board.name }))}
|
||||||
{...form.getInputProps("faviconImageUrl")}
|
rightSection={metaTitleStatus.isPending && <Loader size="xs" />}
|
||||||
label={t("board.field.faviconImageUrl.label")}
|
{...form.getInputProps("metaTitle")}
|
||||||
placeholder="/logo/logo.png"
|
/>
|
||||||
withAsterisk={false}
|
</Grid.Col>
|
||||||
/>
|
<Grid.Col span={{ xs: 12, md: 6 }}>
|
||||||
</Grid.Col>
|
<IconPicker
|
||||||
</Grid>
|
{...form.getInputProps("logoImageUrl")}
|
||||||
</SectionCard>
|
label={t("board.field.logoImageUrl.label")}
|
||||||
|
placeholder="/logo/logo.png"
|
||||||
|
withAsterisk={false}
|
||||||
|
/>
|
||||||
|
</Grid.Col>
|
||||||
|
<Grid.Col span={{ xs: 12, md: 6 }}>
|
||||||
|
<IconPicker
|
||||||
|
{...form.getInputProps("faviconImageUrl")}
|
||||||
|
label={t("board.field.faviconImageUrl.label")}
|
||||||
|
placeholder="/logo/logo.png"
|
||||||
|
withAsterisk={false}
|
||||||
|
/>
|
||||||
|
</Grid.Col>
|
||||||
|
</Grid>
|
||||||
|
<Group justify="end">
|
||||||
|
<Button type="submit" loading={isPending}>
|
||||||
|
{t("common.action.saveChanges")}
|
||||||
|
</Button>
|
||||||
|
</Group>
|
||||||
|
</Stack>
|
||||||
|
</form>
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -84,3 +146,14 @@ const useMetaTitlePreview = (title: string | null) => {
|
|||||||
isPending: (title ?? "") !== metaTitleDebounced,
|
isPending: (title ?? "") !== metaTitleDebounced,
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
|
// Previously we used the useFavicon hook from Mantine
|
||||||
|
// However if the user tried to click on a link to a different page
|
||||||
|
// it caused an error "Cannot read properties of null (reading 'removeChild')"
|
||||||
|
// Probably because the head element was null (https://github.com/mantinedev/mantine/blob/b90d9b81031f45f5d15e75f25138ed6477f65bce/packages/%40mantine/hooks/src/use-favicon/use-favicon.ts#L21)
|
||||||
|
// See https://github.com/homarr-labs/homarr/issues/4905
|
||||||
|
const updateFavicon = (url: string) => {
|
||||||
|
const link: HTMLLinkElement | null = document.querySelector('link[rel="icon"]');
|
||||||
|
if (!link) return;
|
||||||
|
link.href = url;
|
||||||
|
};
|
||||||
@@ -2,79 +2,114 @@
|
|||||||
|
|
||||||
import { Button, Fieldset, Grid, Group, Input, NumberInput, Slider, Stack, Text, TextInput } from "@mantine/core";
|
import { Button, Fieldset, Grid, Group, Input, NumberInput, Slider, Stack, Text, TextInput } from "@mantine/core";
|
||||||
|
|
||||||
|
import { clientApi } from "@homarr/api/client";
|
||||||
import { createId } from "@homarr/common";
|
import { createId } from "@homarr/common";
|
||||||
import type { UseFormReturnType } from "@homarr/form";
|
import { useZodForm } from "@homarr/form";
|
||||||
import { useI18n } from "@homarr/translation/client";
|
import { useI18n } from "@homarr/translation/client";
|
||||||
|
import { boardSaveLayoutsSchema } from "@homarr/validation/board";
|
||||||
|
|
||||||
import { SectionCard } from "~/components/manage/section-card";
|
import type { Board } from "../../_types";
|
||||||
import type { FormValues } from "./_settings-form";
|
|
||||||
|
|
||||||
interface Props {
|
interface Props {
|
||||||
form: UseFormReturnType<FormValues>;
|
board: Board;
|
||||||
}
|
}
|
||||||
|
export const LayoutSettingsContent = ({ board }: Props) => {
|
||||||
export const LayoutSettingsContent = ({ form }: Props) => {
|
|
||||||
const t = useI18n();
|
const t = useI18n();
|
||||||
|
const utils = clientApi.useUtils();
|
||||||
|
const { mutate: saveLayouts, isPending } = clientApi.board.saveLayouts.useMutation({
|
||||||
|
onSettled() {
|
||||||
|
void utils.board.getBoardByName.invalidate({ name: board.name });
|
||||||
|
void utils.board.getHomeBoard.invalidate();
|
||||||
|
},
|
||||||
|
});
|
||||||
|
const form = useZodForm(boardSaveLayoutsSchema.omit({ id: true }).required(), {
|
||||||
|
initialValues: {
|
||||||
|
layouts: board.layouts,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<SectionCard title={t("board.setting.section.layout.title")}>
|
<form
|
||||||
<Stack gap="sm">
|
onSubmit={form.onSubmit((values) => {
|
||||||
<Group justify="space-between" align="center">
|
saveLayouts({
|
||||||
<Text fw={500}>{t("board.setting.section.layout.responsive.title")}</Text>
|
id: board.id,
|
||||||
<Button
|
...values,
|
||||||
type="button"
|
});
|
||||||
variant="subtle"
|
})}
|
||||||
onClick={() => {
|
>
|
||||||
form.setValues((previous) => ({
|
<Stack>
|
||||||
...previous,
|
<Stack gap="sm">
|
||||||
layouts: [...(previous.layouts ?? []), { id: createId(), name: "", columnCount: 10, breakpoint: 0 }],
|
<Group justify="space-between" align="center">
|
||||||
}));
|
<Text fw={500}>{t("board.setting.section.layout.responsive.title")}</Text>
|
||||||
}}
|
<Button
|
||||||
>
|
variant="subtle"
|
||||||
{t("board.setting.section.layout.responsive.action.add")}
|
onClick={() => {
|
||||||
|
form.setValues({
|
||||||
|
layouts: [
|
||||||
|
...form.values.layouts,
|
||||||
|
{
|
||||||
|
id: createId(),
|
||||||
|
name: "",
|
||||||
|
columnCount: 10,
|
||||||
|
breakpoint: 0,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
});
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
{t("board.setting.section.layout.responsive.action.add")}
|
||||||
|
</Button>
|
||||||
|
</Group>
|
||||||
|
|
||||||
|
{form.values.layouts.map((layout, index) => (
|
||||||
|
<Fieldset key={layout.id} legend={layout.name} bg="transparent">
|
||||||
|
<Grid>
|
||||||
|
<Grid.Col span={{ sm: 12, md: 6 }}>
|
||||||
|
<TextInput {...form.getInputProps(`layouts.${index}.name`)} label={t("layout.field.name.label")} />
|
||||||
|
</Grid.Col>
|
||||||
|
|
||||||
|
<Grid.Col span={{ sm: 12, md: 6 }}>
|
||||||
|
<Input.Wrapper label={t("layout.field.columnCount.label")}>
|
||||||
|
<Slider mt="xs" min={1} max={24} step={1} {...form.getInputProps(`layouts.${index}.columnCount`)} />
|
||||||
|
</Input.Wrapper>
|
||||||
|
</Grid.Col>
|
||||||
|
|
||||||
|
<Grid.Col span={{ sm: 12, md: 6 }}>
|
||||||
|
<NumberInput
|
||||||
|
{...form.getInputProps(`layouts.${index}.breakpoint`)}
|
||||||
|
label={t("layout.field.breakpoint.label")}
|
||||||
|
description={t("layout.field.breakpoint.description")}
|
||||||
|
/>
|
||||||
|
</Grid.Col>
|
||||||
|
</Grid>
|
||||||
|
{form.values.layouts.length >= 2 && (
|
||||||
|
<Group justify="end">
|
||||||
|
<Button
|
||||||
|
variant="subtle"
|
||||||
|
onClick={() => {
|
||||||
|
form.setValues((previous) =>
|
||||||
|
previous.layouts !== undefined && previous.layouts.length >= 2
|
||||||
|
? {
|
||||||
|
layouts: form.values.layouts.filter((filteredLayout) => filteredLayout.id !== layout.id),
|
||||||
|
}
|
||||||
|
: previous,
|
||||||
|
);
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
{t("common.action.remove")}
|
||||||
|
</Button>
|
||||||
|
</Group>
|
||||||
|
)}
|
||||||
|
</Fieldset>
|
||||||
|
))}
|
||||||
|
</Stack>
|
||||||
|
|
||||||
|
<Group justify="end">
|
||||||
|
<Button type="submit" loading={isPending}>
|
||||||
|
{t("common.action.saveChanges")}
|
||||||
</Button>
|
</Button>
|
||||||
</Group>
|
</Group>
|
||||||
|
|
||||||
{form.values.layouts.map((layout, index) => (
|
|
||||||
<Fieldset key={layout.id} legend={layout.name} bg="transparent">
|
|
||||||
<Grid>
|
|
||||||
<Grid.Col span={{ sm: 12, md: 6 }}>
|
|
||||||
<TextInput {...form.getInputProps(`layouts.${index}.name`)} label={t("layout.field.name.label")} />
|
|
||||||
</Grid.Col>
|
|
||||||
|
|
||||||
<Grid.Col span={{ sm: 12, md: 6 }}>
|
|
||||||
<Input.Wrapper label={t("layout.field.columnCount.label")}>
|
|
||||||
<Slider mt="xs" min={1} max={24} step={1} {...form.getInputProps(`layouts.${index}.columnCount`)} />
|
|
||||||
</Input.Wrapper>
|
|
||||||
</Grid.Col>
|
|
||||||
|
|
||||||
<Grid.Col span={{ sm: 12, md: 6 }}>
|
|
||||||
<NumberInput
|
|
||||||
{...form.getInputProps(`layouts.${index}.breakpoint`)}
|
|
||||||
label={t("layout.field.breakpoint.label")}
|
|
||||||
description={t("layout.field.breakpoint.description")}
|
|
||||||
/>
|
|
||||||
</Grid.Col>
|
|
||||||
</Grid>
|
|
||||||
{form.values.layouts.length >= 2 && (
|
|
||||||
<Group justify="end">
|
|
||||||
<Button
|
|
||||||
type="button"
|
|
||||||
variant="subtle"
|
|
||||||
onClick={() => {
|
|
||||||
form.setValues((previous) => ({
|
|
||||||
...previous,
|
|
||||||
layouts: form.values.layouts.filter((filteredLayout) => filteredLayout.id !== layout.id),
|
|
||||||
}));
|
|
||||||
}}
|
|
||||||
>
|
|
||||||
{t("common.action.remove")}
|
|
||||||
</Button>
|
|
||||||
</Group>
|
|
||||||
)}
|
|
||||||
</Fieldset>
|
|
||||||
))}
|
|
||||||
</Stack>
|
</Stack>
|
||||||
</SectionCard>
|
</form>
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
@@ -1,219 +0,0 @@
|
|||||||
"use client";
|
|
||||||
|
|
||||||
import { useEffect, useRef } from "react";
|
|
||||||
import { Button, Stack } from "@mantine/core";
|
|
||||||
import type { z } from "zod/v4";
|
|
||||||
|
|
||||||
import type { RouterOutputs } from "@homarr/api";
|
|
||||||
import { useUpdateBoard } from "@homarr/boards/updater";
|
|
||||||
import { revalidatePathActionAsync } from "@homarr/common/client";
|
|
||||||
import { env } from "@homarr/common/env";
|
|
||||||
import { useZodForm } from "@homarr/form";
|
|
||||||
import { showErrorNotification, showSuccessNotification } from "@homarr/notifications";
|
|
||||||
import { useI18n, useScopedI18n } from "@homarr/translation/client";
|
|
||||||
import { boardSaveLayoutsSchema, boardSavePartialSettingsSchema } from "@homarr/validation/board";
|
|
||||||
|
|
||||||
import { homarrLogoPath } from "~/components/layout/logo/homarr-logo";
|
|
||||||
import { SectionCard } from "~/components/manage/section-card";
|
|
||||||
import { UnsavedChangesBar } from "~/components/manage/unsaved-changes-bar";
|
|
||||||
|
|
||||||
import type { Board } from "../../_types";
|
|
||||||
import { ColorSettingsContent } from "./_appereance";
|
|
||||||
import { BackgroundSettingsContent } from "./_background";
|
|
||||||
import { BehaviorSettingsContent } from "./_behavior";
|
|
||||||
import { BoardAccessSettings } from "./_board-access";
|
|
||||||
import { CustomCssSettingsContent } from "./_customCss";
|
|
||||||
import { DangerZoneSettingsContent } from "./_danger";
|
|
||||||
import { GeneralSettingsContent } from "./_general";
|
|
||||||
import { LayoutSettingsContent } from "./_layout";
|
|
||||||
import { useSaveLayoutsMutation, useSavePartialSettingsMutation } from "./_shared";
|
|
||||||
|
|
||||||
const boardSettingsFormSchema = boardSavePartialSettingsSchema
|
|
||||||
.extend({
|
|
||||||
layouts: boardSaveLayoutsSchema.shape.layouts,
|
|
||||||
})
|
|
||||||
.required();
|
|
||||||
|
|
||||||
export type FormValues = z.infer<typeof boardSettingsFormSchema>;
|
|
||||||
|
|
||||||
const PARTIAL_FORM_KEYS = [
|
|
||||||
"pageTitle",
|
|
||||||
"metaTitle",
|
|
||||||
"logoImageUrl",
|
|
||||||
"faviconImageUrl",
|
|
||||||
"backgroundImageUrl",
|
|
||||||
"backgroundImageAttachment",
|
|
||||||
"backgroundImageRepeat",
|
|
||||||
"backgroundImageSize",
|
|
||||||
"primaryColor",
|
|
||||||
"secondaryColor",
|
|
||||||
"opacity",
|
|
||||||
"iconColor",
|
|
||||||
"itemRadius",
|
|
||||||
"customCss",
|
|
||||||
"disableStatus",
|
|
||||||
] as const;
|
|
||||||
|
|
||||||
const buildInitialValues = (board: Board): FormValues => ({
|
|
||||||
pageTitle: board.pageTitle ?? "",
|
|
||||||
metaTitle: board.metaTitle ?? "",
|
|
||||||
logoImageUrl: board.logoImageUrl ?? "",
|
|
||||||
faviconImageUrl: board.faviconImageUrl ?? "",
|
|
||||||
backgroundImageUrl: board.backgroundImageUrl ?? "",
|
|
||||||
backgroundImageAttachment: board.backgroundImageAttachment,
|
|
||||||
backgroundImageRepeat: board.backgroundImageRepeat,
|
|
||||||
backgroundImageSize: board.backgroundImageSize,
|
|
||||||
primaryColor: board.primaryColor,
|
|
||||||
secondaryColor: board.secondaryColor,
|
|
||||||
opacity: board.opacity,
|
|
||||||
iconColor: board.iconColor ?? "",
|
|
||||||
itemRadius: board.itemRadius,
|
|
||||||
customCss: board.customCss ?? "",
|
|
||||||
disableStatus: board.disableStatus,
|
|
||||||
layouts: board.layouts,
|
|
||||||
});
|
|
||||||
|
|
||||||
interface BoardSettingsFormProps {
|
|
||||||
board: Board;
|
|
||||||
permissions: RouterOutputs["board"]["getBoardPermissions"];
|
|
||||||
hasFullAccess: boolean;
|
|
||||||
hideVisibility: boolean;
|
|
||||||
}
|
|
||||||
|
|
||||||
export const BoardSettingsForm = ({ board, permissions, hasFullAccess, hideVisibility }: BoardSettingsFormProps) => {
|
|
||||||
const t = useI18n();
|
|
||||||
const tSection = useScopedI18n("board.setting.section");
|
|
||||||
const { updateBoard } = useUpdateBoard();
|
|
||||||
const savePartialSettings = useSavePartialSettingsMutation(board);
|
|
||||||
const saveLayouts = useSaveLayoutsMutation(board);
|
|
||||||
|
|
||||||
const form = useZodForm(boardSettingsFormSchema, {
|
|
||||||
initialValues: buildInitialValues(board),
|
|
||||||
onValuesChange({ pageTitle }) {
|
|
||||||
updateBoard((previous) => ({
|
|
||||||
...previous,
|
|
||||||
pageTitle,
|
|
||||||
}));
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
const initialValuesRef = useRef(buildInitialValues(board));
|
|
||||||
const lastSavedRef = useRef({ pageTitle: board.pageTitle, logoImageUrl: board.logoImageUrl });
|
|
||||||
|
|
||||||
const isDirtyRef = useRef(false);
|
|
||||||
isDirtyRef.current = form.isDirty();
|
|
||||||
|
|
||||||
useEffect(() => {
|
|
||||||
return () => {
|
|
||||||
updateBoard((previous) => ({
|
|
||||||
...previous,
|
|
||||||
pageTitle: lastSavedRef.current.pageTitle,
|
|
||||||
logoImageUrl: lastSavedRef.current.logoImageUrl,
|
|
||||||
}));
|
|
||||||
};
|
|
||||||
}, [updateBoard]);
|
|
||||||
|
|
||||||
useEffect(() => {
|
|
||||||
const handler = (event: BeforeUnloadEvent) => {
|
|
||||||
if (env.NODE_ENV === "development") return;
|
|
||||||
if (isDirtyRef.current) event.preventDefault();
|
|
||||||
};
|
|
||||||
window.addEventListener("beforeunload", handler);
|
|
||||||
return () => window.removeEventListener("beforeunload", handler);
|
|
||||||
}, []);
|
|
||||||
|
|
||||||
const handleSubmitAsync = async (values: FormValues) => {
|
|
||||||
const defaults = initialValuesRef.current;
|
|
||||||
const changed = <TKey extends keyof FormValues>(...fields: TKey[]) =>
|
|
||||||
fields.some((field) => values[field] !== defaults[field]);
|
|
||||||
|
|
||||||
const { layouts, ...partialSettings } = values;
|
|
||||||
|
|
||||||
const saveActions: { when: boolean; action: () => Promise<unknown> }[] = [
|
|
||||||
{
|
|
||||||
when: changed(...PARTIAL_FORM_KEYS),
|
|
||||||
action: () =>
|
|
||||||
savePartialSettings.mutateAsync({ id: board.id, ...partialSettings }).then(() => {
|
|
||||||
updateFavicon(values.faviconImageUrl ?? homarrLogoPath);
|
|
||||||
}),
|
|
||||||
},
|
|
||||||
{
|
|
||||||
when: changed("layouts"),
|
|
||||||
action: () => saveLayouts.mutateAsync({ id: board.id, layouts }),
|
|
||||||
},
|
|
||||||
];
|
|
||||||
|
|
||||||
const promises = saveActions.filter((saveAction) => saveAction.when).map((saveAction) => saveAction.action());
|
|
||||||
if (promises.length === 0) return;
|
|
||||||
|
|
||||||
try {
|
|
||||||
await Promise.all(promises);
|
|
||||||
lastSavedRef.current = { pageTitle: values.pageTitle, logoImageUrl: values.logoImageUrl };
|
|
||||||
initialValuesRef.current = values;
|
|
||||||
form.setInitialValues(values);
|
|
||||||
form.resetDirty();
|
|
||||||
await revalidatePathActionAsync(`/boards/${board.name}/settings`);
|
|
||||||
showSuccessNotification({
|
|
||||||
title: t("common.notification.update.success"),
|
|
||||||
message: t("common.notification.update.success"),
|
|
||||||
});
|
|
||||||
} catch {
|
|
||||||
showErrorNotification({
|
|
||||||
title: t("common.notification.update.error"),
|
|
||||||
message: t("common.notification.update.error"),
|
|
||||||
});
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
const handleDiscard = () => {
|
|
||||||
form.setValues(initialValuesRef.current);
|
|
||||||
form.resetDirty();
|
|
||||||
updateBoard((previous) => ({
|
|
||||||
...previous,
|
|
||||||
pageTitle: lastSavedRef.current.pageTitle,
|
|
||||||
logoImageUrl: lastSavedRef.current.logoImageUrl,
|
|
||||||
}));
|
|
||||||
};
|
|
||||||
|
|
||||||
const isPending = savePartialSettings.isPending || saveLayouts.isPending;
|
|
||||||
|
|
||||||
return (
|
|
||||||
<form onSubmit={form.onSubmit((values) => void handleSubmitAsync(values))}>
|
|
||||||
<Stack gap="xl">
|
|
||||||
<GeneralSettingsContent board={board} form={form} />
|
|
||||||
<LayoutSettingsContent form={form} />
|
|
||||||
<BackgroundSettingsContent form={form} />
|
|
||||||
<ColorSettingsContent form={form} />
|
|
||||||
<CustomCssSettingsContent form={form} />
|
|
||||||
<BehaviorSettingsContent form={form} />
|
|
||||||
|
|
||||||
{hasFullAccess && (
|
|
||||||
<SectionCard title={tSection("access.title")}>
|
|
||||||
<BoardAccessSettings board={board} initialPermissions={permissions} />
|
|
||||||
</SectionCard>
|
|
||||||
)}
|
|
||||||
|
|
||||||
{hasFullAccess && <DangerZoneSettingsContent hideVisibility={hideVisibility} />}
|
|
||||||
|
|
||||||
{form.isDirty() && (
|
|
||||||
<UnsavedChangesBar>
|
|
||||||
<Button type="button" disabled={isPending} variant="default" onClick={handleDiscard}>
|
|
||||||
{t("common.action.discard")}
|
|
||||||
</Button>
|
|
||||||
<Button loading={isPending} type="submit" disabled={!form.isValid()}>
|
|
||||||
{t("common.action.saveChanges")}
|
|
||||||
</Button>
|
|
||||||
</UnsavedChangesBar>
|
|
||||||
)}
|
|
||||||
</Stack>
|
|
||||||
</form>
|
|
||||||
);
|
|
||||||
};
|
|
||||||
|
|
||||||
// Previously part of the general settings section; applied on the unified save
|
|
||||||
// https://github.com/homarr-labs/homarr/issues/4905
|
|
||||||
const updateFavicon = (url: string) => {
|
|
||||||
const link = document.querySelector<HTMLLinkElement>('link[rel="icon"]');
|
|
||||||
if (!link) return;
|
|
||||||
link.href = url;
|
|
||||||
};
|
|
||||||
@@ -11,13 +11,3 @@ export const useSavePartialSettingsMutation = (board: Board) => {
|
|||||||
},
|
},
|
||||||
});
|
});
|
||||||
};
|
};
|
||||||
|
|
||||||
export const useSaveLayoutsMutation = (board: Board) => {
|
|
||||||
const utils = clientApi.useUtils();
|
|
||||||
return clientApi.board.saveLayouts.useMutation({
|
|
||||||
onSettled() {
|
|
||||||
void utils.board.getBoardByName.invalidate({ name: board.name });
|
|
||||||
void utils.board.getHomeBoard.invalidate();
|
|
||||||
},
|
|
||||||
});
|
|
||||||
};
|
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
@media (min-width: 36em) {
|
||||||
|
.dangerZoneGroup {
|
||||||
|
--group-wrap: nowrap !important;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,20 +1,44 @@
|
|||||||
|
import type { PropsWithChildren } from "react";
|
||||||
import { notFound } from "next/navigation";
|
import { notFound } from "next/navigation";
|
||||||
import { Container, Stack, Title } from "@mantine/core";
|
import { AccordionControl, AccordionItem, AccordionPanel, Container, Stack, Text, Title } from "@mantine/core";
|
||||||
|
import {
|
||||||
|
IconAlertTriangle,
|
||||||
|
IconBrush,
|
||||||
|
IconClick,
|
||||||
|
IconFileTypeCss,
|
||||||
|
IconLayout,
|
||||||
|
IconPhoto,
|
||||||
|
IconSettings,
|
||||||
|
IconUser,
|
||||||
|
} from "@tabler/icons-react";
|
||||||
import { TRPCError } from "@trpc/server";
|
import { TRPCError } from "@trpc/server";
|
||||||
|
|
||||||
import { api } from "@homarr/api/server";
|
import { api } from "@homarr/api/server";
|
||||||
import { capitalize } from "@homarr/common";
|
import { capitalize } from "@homarr/common";
|
||||||
import { db } from "@homarr/db";
|
import { db } from "@homarr/db";
|
||||||
import { getServerSettingByKeyAsync } from "@homarr/db/queries";
|
import { getServerSettingByKeyAsync } from "@homarr/db/queries";
|
||||||
|
import type { TranslationObject } from "@homarr/translation";
|
||||||
import { getScopedI18n } from "@homarr/translation/server";
|
import { getScopedI18n } from "@homarr/translation/server";
|
||||||
|
import type { TablerIcon } from "@homarr/ui";
|
||||||
|
|
||||||
import { getBoardPermissionsAsync } from "~/components/board/permissions/server";
|
import { getBoardPermissionsAsync } from "~/components/board/permissions/server";
|
||||||
import { BoardSettingsForm } from "./_settings-form";
|
import { ActiveTabAccordion } from "../../../../../components/active-tab-accordion";
|
||||||
|
import { ColorSettingsContent } from "./_appereance";
|
||||||
|
import { BackgroundSettingsContent } from "./_background";
|
||||||
|
import { BehaviorSettingsContent } from "./_behavior";
|
||||||
|
import { BoardAccessSettings } from "./_board-access";
|
||||||
|
import { CustomCssSettingsContent } from "./_customCss";
|
||||||
|
import { DangerZoneSettingsContent } from "./_danger";
|
||||||
|
import { GeneralSettingsContent } from "./_general";
|
||||||
|
import { LayoutSettingsContent } from "./_layout";
|
||||||
|
|
||||||
interface Props {
|
interface Props {
|
||||||
params: Promise<{
|
params: Promise<{
|
||||||
name: string;
|
name: string;
|
||||||
}>;
|
}>;
|
||||||
|
searchParams: Promise<{
|
||||||
|
tab?: keyof TranslationObject["board"]["setting"]["section"];
|
||||||
|
}>;
|
||||||
}
|
}
|
||||||
|
|
||||||
const getBoardAndPermissionsAsync = async (params: Awaited<Props["params"]>) => {
|
const getBoardAndPermissionsAsync = async (params: Awaited<Props["params"]>) => {
|
||||||
@@ -33,7 +57,11 @@ const getBoardAndPermissionsAsync = async (params: Awaited<Props["params"]>) =>
|
|||||||
} catch (error) {
|
} catch (error) {
|
||||||
// Ignore not found errors and redirect to 404
|
// Ignore not found errors and redirect to 404
|
||||||
// error is already logged in _layout-creator.tsx
|
// error is already logged in _layout-creator.tsx
|
||||||
if (error instanceof TRPCError && (error.code === "NOT_FOUND" || error.code === "BAD_REQUEST")) {
|
if (error instanceof TRPCError && error.code === "NOT_FOUND") {
|
||||||
|
notFound();
|
||||||
|
}
|
||||||
|
|
||||||
|
if (error instanceof TRPCError && error.code === "BAD_REQUEST") {
|
||||||
notFound();
|
notFound();
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -42,6 +70,7 @@ const getBoardAndPermissionsAsync = async (params: Awaited<Props["params"]>) =>
|
|||||||
};
|
};
|
||||||
|
|
||||||
export default async function BoardSettingsPage(props: Props) {
|
export default async function BoardSettingsPage(props: Props) {
|
||||||
|
const searchParams = await props.searchParams;
|
||||||
const params = await props.params;
|
const params = await props.params;
|
||||||
const { board, permissions } = await getBoardAndPermissionsAsync(params);
|
const { board, permissions } = await getBoardAndPermissionsAsync(params);
|
||||||
const boardSettings = await getServerSettingByKeyAsync(db, "board");
|
const boardSettings = await getServerSettingByKeyAsync(db, "board");
|
||||||
@@ -56,13 +85,76 @@ export default async function BoardSettingsPage(props: Props) {
|
|||||||
<Container>
|
<Container>
|
||||||
<Stack>
|
<Stack>
|
||||||
<Title>{t("title", { boardName: capitalize(board.name) })}</Title>
|
<Title>{t("title", { boardName: capitalize(board.name) })}</Title>
|
||||||
<BoardSettingsForm
|
<ActiveTabAccordion variant="separated" defaultValue={searchParams.tab ?? "general"}>
|
||||||
board={board}
|
<AccordionItemFor value="general" icon={IconSettings}>
|
||||||
permissions={permissions}
|
<GeneralSettingsContent board={board} />
|
||||||
hasFullAccess={hasFullAccess}
|
</AccordionItemFor>
|
||||||
hideVisibility={boardSettings.homeBoardId === board.id || boardSettings.mobileHomeBoardId === board.id}
|
<AccordionItemFor value="layout" icon={IconLayout}>
|
||||||
/>
|
<LayoutSettingsContent board={board} />
|
||||||
|
</AccordionItemFor>
|
||||||
|
<AccordionItemFor value="background" icon={IconPhoto}>
|
||||||
|
<BackgroundSettingsContent board={board} />
|
||||||
|
</AccordionItemFor>
|
||||||
|
<AccordionItemFor value="appearance" icon={IconBrush}>
|
||||||
|
<ColorSettingsContent board={board} />
|
||||||
|
</AccordionItemFor>
|
||||||
|
<AccordionItemFor value="customCss" icon={IconFileTypeCss}>
|
||||||
|
<CustomCssSettingsContent board={board} />
|
||||||
|
</AccordionItemFor>
|
||||||
|
<AccordionItemFor value="behavior" icon={IconClick}>
|
||||||
|
<BehaviorSettingsContent board={board} />
|
||||||
|
</AccordionItemFor>
|
||||||
|
{hasFullAccess && (
|
||||||
|
<>
|
||||||
|
<AccordionItemFor value="access" icon={IconUser}>
|
||||||
|
<BoardAccessSettings board={board} initialPermissions={permissions} />
|
||||||
|
</AccordionItemFor>
|
||||||
|
<AccordionItemFor value="dangerZone" icon={IconAlertTriangle} danger noPadding>
|
||||||
|
<DangerZoneSettingsContent
|
||||||
|
hideVisibility={
|
||||||
|
boardSettings.homeBoardId === board.id || boardSettings.mobileHomeBoardId === board.id
|
||||||
|
}
|
||||||
|
/>
|
||||||
|
</AccordionItemFor>
|
||||||
|
</>
|
||||||
|
)}
|
||||||
|
</ActiveTabAccordion>
|
||||||
</Stack>
|
</Stack>
|
||||||
</Container>
|
</Container>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
type AccordionItemForProps = PropsWithChildren<{
|
||||||
|
value: keyof TranslationObject["board"]["setting"]["section"];
|
||||||
|
icon: TablerIcon;
|
||||||
|
danger?: boolean;
|
||||||
|
noPadding?: boolean;
|
||||||
|
}>;
|
||||||
|
|
||||||
|
const AccordionItemFor = async ({ value, children, icon: Icon, danger, noPadding }: AccordionItemForProps) => {
|
||||||
|
const t = await getScopedI18n("board.setting.section");
|
||||||
|
return (
|
||||||
|
<AccordionItem
|
||||||
|
value={value}
|
||||||
|
styles={
|
||||||
|
danger
|
||||||
|
? {
|
||||||
|
item: {
|
||||||
|
"--__item-border-color": "rgba(248,81,73,0.4)",
|
||||||
|
borderWidth: 4,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
: undefined
|
||||||
|
}
|
||||||
|
>
|
||||||
|
<AccordionControl icon={<Icon />}>
|
||||||
|
<Text fw="bold" size="lg">
|
||||||
|
{t(`${value}.title`)}
|
||||||
|
</Text>
|
||||||
|
</AccordionControl>
|
||||||
|
<AccordionPanel styles={noPadding ? { content: { paddingRight: 0, paddingLeft: 0 } } : undefined}>
|
||||||
|
{children}
|
||||||
|
</AccordionPanel>
|
||||||
|
</AccordionItem>
|
||||||
|
);
|
||||||
|
};
|
||||||
@@ -1,23 +1,17 @@
|
|||||||
import { createHash } from "node:crypto";
|
|
||||||
|
|
||||||
import type { JSX, PropsWithChildren } from "react";
|
import type { JSX, PropsWithChildren } from "react";
|
||||||
import { notFound, redirect } from "next/navigation";
|
import { notFound, redirect } from "next/navigation";
|
||||||
import { cookies } from "next/headers";
|
import { AppShellMain } from "@mantine/core";
|
||||||
import { TRPCError } from "@trpc/server";
|
import { TRPCError } from "@trpc/server";
|
||||||
|
|
||||||
import { getRscUserSettingsAsync } from "@homarr/api/user-server";
|
|
||||||
import { auth } from "@homarr/auth/next";
|
import { auth } from "@homarr/auth/next";
|
||||||
import { BoardProvider } from "@homarr/boards/context";
|
import { BoardProvider } from "@homarr/boards/context";
|
||||||
import { EditModeProvider } from "@homarr/boards/edit-mode";
|
import { EditModeProvider } from "@homarr/boards/edit-mode";
|
||||||
import { dbEnv } from "@homarr/core/infrastructure/db/env";
|
|
||||||
import { createLogger } from "@homarr/core/infrastructure/logs";
|
import { createLogger } from "@homarr/core/infrastructure/logs";
|
||||||
import { v2BetaAnnouncementCookieKey } from "@homarr/definitions";
|
|
||||||
|
|
||||||
import { MainHeaderContent } from "~/components/layout/header";
|
import { MainHeader } from "~/components/layout/header";
|
||||||
import { BoardLogoWithTitle } from "~/components/layout/logo/board-logo";
|
import { BoardLogoWithTitle } from "~/components/layout/logo/board-logo";
|
||||||
import { V2BetaDashboardShell } from "~/components/layout/v2-beta-announcement/v2-beta-dashboard-shell";
|
import { ClientShell } from "~/components/layout/shell";
|
||||||
import { BoardTourGate } from "~/components/onboarding/board-tour-gate";
|
import { BoardTourProvider } from "~/components/onboarding/board-tour";
|
||||||
import { env } from "~/env";
|
|
||||||
import { getCurrentColorSchemeAsync } from "~/theme/color-scheme";
|
import { getCurrentColorSchemeAsync } from "~/theme/color-scheme";
|
||||||
import type { Board } from "./_types";
|
import type { Board } from "./_types";
|
||||||
import type { Params } from "./(content)/_creator";
|
import type { Params } from "./(content)/_creator";
|
||||||
@@ -27,6 +21,11 @@ import { BoardMantineProvider } from "./(content)/_theme";
|
|||||||
|
|
||||||
const logger = createLogger({ module: "createBoardLayout" });
|
const logger = createLogger({ module: "createBoardLayout" });
|
||||||
|
|
||||||
|
const BoardTourWrapper = ({ hasSession, children }: PropsWithChildren<{ hasSession: boolean }>) => {
|
||||||
|
if (!hasSession) return <>{children}</>;
|
||||||
|
return <BoardTourProvider>{children}</BoardTourProvider>;
|
||||||
|
};
|
||||||
|
|
||||||
interface CreateBoardLayoutProps<TParams extends Params> {
|
interface CreateBoardLayoutProps<TParams extends Params> {
|
||||||
headerActions: JSX.Element;
|
headerActions: JSX.Element;
|
||||||
getInitialBoardAsync: (params: TParams) => Promise<Board>;
|
getInitialBoardAsync: (params: TParams) => Promise<Board>;
|
||||||
@@ -44,34 +43,8 @@ export const createBoardLayout = <TParams extends Params>({
|
|||||||
}: PropsWithChildren<{
|
}: PropsWithChildren<{
|
||||||
params: Promise<TParams>;
|
params: Promise<TParams>;
|
||||||
}>) => {
|
}>) => {
|
||||||
const resolvedParams = await params;
|
const session = await auth();
|
||||||
const sessionPromise = auth();
|
const initialBoard = await getInitialBoard(await params).catch((error) => {
|
||||||
const cookiesPromise = cookies();
|
|
||||||
const initialBoardPromise = getInitialBoard(resolvedParams).then(
|
|
||||||
(board) => ({ status: "fulfilled", board }) as const,
|
|
||||||
(error: unknown) => ({ status: "rejected", error }) as const,
|
|
||||||
);
|
|
||||||
const colorSchemePromise = getCurrentColorSchemeAsync();
|
|
||||||
const shouldRunBoardTourPromise = sessionPromise.then(async (session) => {
|
|
||||||
if (!withTour || !session || env.DEMO_MODE) return false;
|
|
||||||
|
|
||||||
try {
|
|
||||||
const user = await getRscUserSettingsAsync(session.user.id);
|
|
||||||
return user !== undefined && !user.completedBoardTour;
|
|
||||||
} catch (error) {
|
|
||||||
logger.error(new Error("Failed to load the board tour status", { cause: error }));
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
});
|
|
||||||
const [session, initialBoardResult, colorScheme, shouldRunBoardTour, cookieStore] = await Promise.all([
|
|
||||||
sessionPromise,
|
|
||||||
initialBoardPromise,
|
|
||||||
colorSchemePromise,
|
|
||||||
shouldRunBoardTourPromise,
|
|
||||||
cookiesPromise,
|
|
||||||
]);
|
|
||||||
if (initialBoardResult.status === "rejected") {
|
|
||||||
const { error } = initialBoardResult;
|
|
||||||
if (error instanceof TRPCError && error.code === "NOT_FOUND") {
|
if (error instanceof TRPCError && error.code === "NOT_FOUND") {
|
||||||
if (!session) {
|
if (!session) {
|
||||||
logger.debug("No home board found for anonymous user, redirecting to login");
|
logger.debug("No home board found for anonymous user, redirecting to login");
|
||||||
@@ -87,13 +60,8 @@ export const createBoardLayout = <TParams extends Params>({
|
|||||||
}
|
}
|
||||||
|
|
||||||
throw error;
|
throw error;
|
||||||
}
|
});
|
||||||
const initialBoard = initialBoardResult.board;
|
const colorScheme = await getCurrentColorSchemeAsync();
|
||||||
const viewerIdentity = session?.user.id ?? "anonymous";
|
|
||||||
const viewerHash = createHash("sha256").update(viewerIdentity).digest("hex").slice(0, 16);
|
|
||||||
const dismissalCookieName = `${v2BetaAnnouncementCookieKey}.${viewerHash}`;
|
|
||||||
const isAnnouncementDismissed = cookieStore.get(dismissalCookieName)?.value === "dismissed";
|
|
||||||
const canExportBackup = dbEnv.DRIVER === "better-sqlite3" && Boolean(session?.user.permissions.includes("admin"));
|
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<BoardProvider initialBoard={initialBoard}>
|
<BoardProvider initialBoard={initialBoard}>
|
||||||
@@ -101,22 +69,16 @@ export const createBoardLayout = <TParams extends Params>({
|
|||||||
<EditModeProvider>
|
<EditModeProvider>
|
||||||
<BoardMantineProvider defaultColorScheme={colorScheme}>
|
<BoardMantineProvider defaultColorScheme={colorScheme}>
|
||||||
<CustomCss />
|
<CustomCss />
|
||||||
<BoardTourGate enabled={shouldRunBoardTour}>
|
<BoardTourWrapper hasSession={withTour && !!session}>
|
||||||
<V2BetaDashboardShell
|
<ClientShell hasNavigation={false}>
|
||||||
canExportBackup={canExportBackup}
|
<MainHeader
|
||||||
dismissalCookieName={dismissalCookieName}
|
logo={<BoardLogoWithTitle size="md" hideTitleOnMobile />}
|
||||||
initiallyDismissed={isAnnouncementDismissed}
|
actions={headerActions}
|
||||||
header={
|
hasNavigation={false}
|
||||||
<MainHeaderContent
|
/>
|
||||||
logo={<BoardLogoWithTitle size="md" hideTitleOnMobile />}
|
<AppShellMain>{children}</AppShellMain>
|
||||||
actions={headerActions}
|
</ClientShell>
|
||||||
hasNavigation={false}
|
</BoardTourWrapper>
|
||||||
/>
|
|
||||||
}
|
|
||||||
>
|
|
||||||
{children}
|
|
||||||
</V2BetaDashboardShell>
|
|
||||||
</BoardTourGate>
|
|
||||||
</BoardMantineProvider>
|
</BoardMantineProvider>
|
||||||
</EditModeProvider>
|
</EditModeProvider>
|
||||||
</BoardReadyProvider>
|
</BoardReadyProvider>
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
import type { JSX } from "react";
|
import type { JSX } from "react";
|
||||||
import { Box, Center, Stack, Text, Title } from "@mantine/core";
|
import { Box, Center, Stack, Text, Title } from "@mantine/core";
|
||||||
|
|
||||||
|
import { api } from "@homarr/api/server";
|
||||||
import type { MaybePromise } from "@homarr/common/types";
|
import type { MaybePromise } from "@homarr/common/types";
|
||||||
import { db } from "@homarr/db";
|
|
||||||
import type { OnboardingStep } from "@homarr/definitions";
|
import type { OnboardingStep } from "@homarr/definitions";
|
||||||
import { getScopedI18n } from "@homarr/translation/server";
|
import { getScopedI18n } from "@homarr/translation/server";
|
||||||
|
|
||||||
@@ -29,16 +29,9 @@ const stepComponents: Record<OnboardingStep, null | (() => MaybePromise<JSX.Elem
|
|||||||
finish: InitFinish,
|
finish: InitFinish,
|
||||||
};
|
};
|
||||||
|
|
||||||
const getCurrentOnboardingStepAsync = async () => {
|
|
||||||
const value = await db.query.onboarding.findFirst();
|
|
||||||
if (!value) return { current: "start" as const, previous: null };
|
|
||||||
|
|
||||||
return { current: value.step, previous: value.previousStep };
|
|
||||||
};
|
|
||||||
|
|
||||||
export default async function InitPage() {
|
export default async function InitPage() {
|
||||||
const t = await getScopedI18n("init.step");
|
const t = await getScopedI18n("init.step");
|
||||||
const currentStep = await getCurrentOnboardingStepAsync();
|
const currentStep = await api.onboard.currentStep();
|
||||||
|
|
||||||
const CurrentComponent = stepComponents[currentStep.current];
|
const CurrentComponent = stepComponents[currentStep.current];
|
||||||
|
|
||||||
|
|||||||
@@ -13,11 +13,11 @@ import { notFound } from "next/navigation";
|
|||||||
import type { DayOfWeek } from "@mantine/dates";
|
import type { DayOfWeek } from "@mantine/dates";
|
||||||
import { NextIntlClientProvider } from "next-intl";
|
import { NextIntlClientProvider } from "next-intl";
|
||||||
|
|
||||||
import { getRscServerSettingsAsync } from "@homarr/api/server-settings-server";
|
import { api } from "@homarr/api/server";
|
||||||
import { getRscUserSettingsAsync } from "@homarr/api/user-server";
|
|
||||||
import { env } from "@homarr/auth/env";
|
import { env } from "@homarr/auth/env";
|
||||||
import { auth } from "@homarr/auth/next";
|
import { auth } from "@homarr/auth/next";
|
||||||
import { createLogger } from "@homarr/core/infrastructure/logs";
|
import { db } from "@homarr/db";
|
||||||
|
import { getServerSettingsAsync } from "@homarr/db/queries";
|
||||||
import { ModalProvider } from "@homarr/modals";
|
import { ModalProvider } from "@homarr/modals";
|
||||||
import { Notifications } from "@homarr/notifications";
|
import { Notifications } from "@homarr/notifications";
|
||||||
import { SettingsProvider } from "@homarr/settings";
|
import { SettingsProvider } from "@homarr/settings";
|
||||||
@@ -43,8 +43,6 @@ const fontSans = Inter({
|
|||||||
variable: "--font-sans",
|
variable: "--font-sans",
|
||||||
});
|
});
|
||||||
|
|
||||||
const logger = createLogger({ module: "rootLayout" });
|
|
||||||
|
|
||||||
// eslint-disable-next-line no-restricted-syntax
|
// eslint-disable-next-line no-restricted-syntax
|
||||||
export const generateMetadata = async (): Promise<Metadata> => ({
|
export const generateMetadata = async (): Promise<Metadata> => ({
|
||||||
title: "Homarr",
|
title: "Homarr",
|
||||||
@@ -80,27 +78,15 @@ export default async function Layout(props: {
|
|||||||
children: React.ReactNode;
|
children: React.ReactNode;
|
||||||
params: Promise<{ locale: SupportedLanguage }>;
|
params: Promise<{ locale: SupportedLanguage }>;
|
||||||
}) {
|
}) {
|
||||||
const { locale } = await props.params;
|
if (!isLocaleSupported((await props.params).locale)) {
|
||||||
if (!isLocaleSupported(locale)) {
|
|
||||||
notFound();
|
notFound();
|
||||||
}
|
}
|
||||||
|
|
||||||
const sessionPromise = auth();
|
const session = await auth();
|
||||||
const userPromise = sessionPromise.then((session) =>
|
const user = session ? await api.user.getById({ userId: session.user.id }).catch(() => null) : null;
|
||||||
session
|
const serverSettings = await getServerSettingsAsync(db);
|
||||||
? getRscUserSettingsAsync(session.user.id).catch((error: unknown) => {
|
const colorScheme = await getCurrentColorSchemeAsync();
|
||||||
logger.error(new Error("Failed to load the authenticated user in the root layout", { cause: error }));
|
const direction = isLocaleRTL((await props.params).locale) ? "rtl" : "ltr";
|
||||||
return null;
|
|
||||||
})
|
|
||||||
: null,
|
|
||||||
);
|
|
||||||
const [session, user, serverSettings, colorScheme] = await Promise.all([
|
|
||||||
sessionPromise,
|
|
||||||
userPromise,
|
|
||||||
getRscServerSettingsAsync(),
|
|
||||||
getCurrentColorSchemeAsync(),
|
|
||||||
]);
|
|
||||||
const direction = isLocaleRTL(locale) ? "rtl" : "ltr";
|
|
||||||
|
|
||||||
const StackedProvider = composeWrappers([
|
const StackedProvider = composeWrappers([
|
||||||
(innerProps) => {
|
(innerProps) => {
|
||||||
@@ -139,6 +125,8 @@ export default async function Layout(props: {
|
|||||||
(innerProps) => <SpotlightProvider {...innerProps} />,
|
(innerProps) => <SpotlightProvider {...innerProps} />,
|
||||||
]);
|
]);
|
||||||
|
|
||||||
|
const { locale } = await props.params;
|
||||||
|
|
||||||
return (
|
return (
|
||||||
// Instead of ColorSchemScript we use data-mantine-color-scheme to prevent flickering
|
// Instead of ColorSchemScript we use data-mantine-color-scheme to prevent flickering
|
||||||
<html
|
<html
|
||||||
|
|||||||
@@ -697,11 +697,7 @@ export function CustomWidgetForm({ mode, initialValues, definitionId }: CustomWi
|
|||||||
<Stack gap="sm">
|
<Stack gap="sm">
|
||||||
<TextInput label={t("field.name")} required {...form.getInputProps("name")} />
|
<TextInput label={t("field.name")} required {...form.getInputProps("name")} />
|
||||||
<Textarea label={t("field.description")} {...form.getInputProps("description")} />
|
<Textarea label={t("field.description")} {...form.getInputProps("description")} />
|
||||||
<IconPicker
|
<IconPicker withAsterisk={false} {...form.getInputProps("iconUrl")} />
|
||||||
withAsterisk={false}
|
|
||||||
suggestedSearch={mode === "create" ? form.values.name : undefined}
|
|
||||||
{...form.getInputProps("iconUrl")}
|
|
||||||
/>
|
|
||||||
</Stack>
|
</Stack>
|
||||||
</Fieldset>
|
</Fieldset>
|
||||||
|
|
||||||
|
|||||||
@@ -27,10 +27,8 @@ import {
|
|||||||
IconUsersGroup,
|
IconUsersGroup,
|
||||||
} from "@tabler/icons-react";
|
} from "@tabler/icons-react";
|
||||||
|
|
||||||
import { getRscUserSettingsAsync } from "@homarr/api/user-server";
|
|
||||||
import { auth } from "@homarr/auth/next";
|
import { auth } from "@homarr/auth/next";
|
||||||
import { isProviderEnabled } from "@homarr/auth/server";
|
import { isProviderEnabled } from "@homarr/auth/server";
|
||||||
import { createLogger } from "@homarr/core/infrastructure/logs";
|
|
||||||
import { createDocumentationLink } from "@homarr/definitions";
|
import { createDocumentationLink } from "@homarr/definitions";
|
||||||
import { dbEnv } from "@homarr/core/infrastructure/db/env";
|
import { dbEnv } from "@homarr/core/infrastructure/db/env";
|
||||||
import { env } from "@homarr/docker/env";
|
import { env } from "@homarr/docker/env";
|
||||||
@@ -41,29 +39,11 @@ import { homarrLogoPath } from "~/components/layout/logo/homarr-logo";
|
|||||||
import type { NavigationLink } from "~/components/layout/navigation";
|
import type { NavigationLink } from "~/components/layout/navigation";
|
||||||
import { MainNavigation } from "~/components/layout/navigation";
|
import { MainNavigation } from "~/components/layout/navigation";
|
||||||
import { ClientShell } from "~/components/layout/shell";
|
import { ClientShell } from "~/components/layout/shell";
|
||||||
import { ManageTourGate } from "~/components/onboarding/manage-tour-gate";
|
import { ManageTourProvider } from "~/components/onboarding/manage-tour";
|
||||||
import { env as nextEnv } from "~/env";
|
|
||||||
|
|
||||||
const logger = createLogger({ module: "manageLayout" });
|
|
||||||
|
|
||||||
export default async function ManageLayout({ children }: PropsWithChildren) {
|
export default async function ManageLayout({ children }: PropsWithChildren) {
|
||||||
const sessionPromise = auth();
|
const t = await getScopedI18n("management.navbar");
|
||||||
const shouldRunManageTourPromise = sessionPromise.then(async (session) => {
|
const session = await auth();
|
||||||
if (!session || nextEnv.DEMO_MODE) return false;
|
|
||||||
|
|
||||||
try {
|
|
||||||
const user = await getRscUserSettingsAsync(session.user.id);
|
|
||||||
return user !== undefined && !user.completedManageTour;
|
|
||||||
} catch (error) {
|
|
||||||
logger.error(new Error("Failed to load the management tour status", { cause: error }));
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
});
|
|
||||||
const [t, session, shouldRunManageTour] = await Promise.all([
|
|
||||||
getScopedI18n("management.navbar"),
|
|
||||||
sessionPromise,
|
|
||||||
shouldRunManageTourPromise,
|
|
||||||
]);
|
|
||||||
const navigationLinks: NavigationLink[] = [
|
const navigationLinks: NavigationLink[] = [
|
||||||
{
|
{
|
||||||
label: t("items.home"),
|
label: t("items.home"),
|
||||||
@@ -245,9 +225,7 @@ export default async function ManageLayout({ children }: PropsWithChildren) {
|
|||||||
</ClientShell>
|
</ClientShell>
|
||||||
);
|
);
|
||||||
|
|
||||||
return (
|
if (!session) return shell;
|
||||||
<ManageTourGate enabled={shouldRunManageTour} isAdmin={isAdmin}>
|
|
||||||
{shell}
|
return <ManageTourProvider isAdmin={isAdmin}>{shell}</ManageTourProvider>;
|
||||||
</ManageTourGate>
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
@@ -57,10 +57,7 @@ export const SearchEngineForm = (props: SearchEngineFormProps) => {
|
|||||||
/>
|
/>
|
||||||
</Grid.Col>
|
</Grid.Col>
|
||||||
</Grid>
|
</Grid>
|
||||||
<IconPicker
|
<IconPicker {...form.getInputProps("iconUrl")} />
|
||||||
{...form.getInputProps("iconUrl")}
|
|
||||||
suggestedSearch={initialValues === undefined ? form.values.name : undefined}
|
|
||||||
/>
|
|
||||||
|
|
||||||
<Fieldset legend={t("search.engine.page.edit.configControl")}>
|
<Fieldset legend={t("search.engine.page.edit.configControl")}>
|
||||||
<SegmentedControl
|
<SegmentedControl
|
||||||
|
|||||||
@@ -1,22 +1,53 @@
|
|||||||
"use client";
|
"use client";
|
||||||
|
|
||||||
import type { UseFormReturnType } from "@homarr/form";
|
import React from "react";
|
||||||
|
import { Card, LoadingOverlay, Stack, Title } from "@mantine/core";
|
||||||
|
|
||||||
|
import { clientApi } from "@homarr/api/client";
|
||||||
|
import { revalidatePathActionAsync } from "@homarr/common/client";
|
||||||
|
import { useForm } from "@homarr/form";
|
||||||
|
import type { defaultServerSettings } from "@homarr/server-settings";
|
||||||
import { useScopedI18n } from "@homarr/translation/client";
|
import { useScopedI18n } from "@homarr/translation/client";
|
||||||
|
|
||||||
import { SectionCard } from "~/components/manage/section-card";
|
import { SwitchSetting } from "~/app/[locale]/manage/settings/_components/setting-switch";
|
||||||
import type { FormValues } from "./settings-form";
|
|
||||||
import { SwitchSetting } from "./setting-switch";
|
|
||||||
|
|
||||||
interface AnalyticsSettingsProps {
|
interface AnalyticsSettingsProps {
|
||||||
form: UseFormReturnType<FormValues>;
|
initialData: typeof defaultServerSettings.analytics;
|
||||||
}
|
}
|
||||||
|
|
||||||
export const AnalyticsSettings = ({ form }: AnalyticsSettingsProps) => {
|
export const AnalyticsSettings = ({ initialData }: AnalyticsSettingsProps) => {
|
||||||
const t = useScopedI18n("management.page.settings.section.analytics");
|
const t = useScopedI18n("management.page.settings.section.analytics");
|
||||||
|
const { instanceId: _, ...formDefaults } = initialData;
|
||||||
|
const form = useForm({
|
||||||
|
initialValues: formDefaults,
|
||||||
|
onValuesChange: (updatedValues, _prev) => {
|
||||||
|
if (!form.isValid()) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
void mutateAsync({
|
||||||
|
settingsKey: "analytics",
|
||||||
|
value: updatedValues,
|
||||||
|
});
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const { mutateAsync, isPending } = clientApi.serverSettings.saveSettings.useMutation({
|
||||||
|
onSettled: async () => {
|
||||||
|
await revalidatePathActionAsync("/manage/settings");
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<SectionCard title={t("title")}>
|
<>
|
||||||
<SwitchSetting form={form} formKey="enableGeneral" title={t("general.title")} text={t("general.text")} />
|
<Title order={2}>{t("title")}</Title>
|
||||||
</SectionCard>
|
|
||||||
|
<Card pos="relative">
|
||||||
|
<LoadingOverlay visible={isPending} />
|
||||||
|
<Stack>
|
||||||
|
<SwitchSetting form={form} formKey="enableGeneral" title={t("general.title")} text={t("general.text")} />
|
||||||
|
</Stack>
|
||||||
|
</Card>
|
||||||
|
</>
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
+20
-21
@@ -5,32 +5,31 @@ import { IconDeviceDesktop, IconMoon, IconSun } from "@tabler/icons-react";
|
|||||||
|
|
||||||
import type { ColorScheme } from "@homarr/definitions";
|
import type { ColorScheme } from "@homarr/definitions";
|
||||||
import { colorSchemes } from "@homarr/definitions";
|
import { colorSchemes } from "@homarr/definitions";
|
||||||
import type { UseFormReturnType } from "@homarr/form";
|
import type { ServerSettings } from "@homarr/server-settings";
|
||||||
import { useScopedI18n } from "@homarr/translation/client";
|
import { useScopedI18n } from "@homarr/translation/client";
|
||||||
import { SelectWithCustomItems } from "@homarr/ui";
|
import { SelectWithCustomItems } from "@homarr/ui";
|
||||||
|
|
||||||
import { SectionCard } from "~/components/manage/section-card";
|
import { CommonSettingsForm } from "./common-form";
|
||||||
import type { FormValues } from "./settings-form";
|
|
||||||
|
|
||||||
interface AppearanceSettingsFormProps {
|
export const AppearanceSettingsForm = ({ defaultValues }: { defaultValues: ServerSettings["appearance"] }) => {
|
||||||
form: UseFormReturnType<FormValues>;
|
const tApperance = useScopedI18n("management.page.settings.section.appearance");
|
||||||
}
|
|
||||||
|
|
||||||
export const AppearanceSettingsForm = ({ form }: AppearanceSettingsFormProps) => {
|
|
||||||
const tAppearance = useScopedI18n("management.page.settings.section.appearance");
|
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<SectionCard title={tAppearance("title")}>
|
<CommonSettingsForm settingKey="appearance" defaultValues={defaultValues}>
|
||||||
<SelectWithCustomItems
|
{(form) => (
|
||||||
label={tAppearance("defaultColorScheme.label")}
|
<>
|
||||||
data={colorSchemes.map((scheme) => ({
|
<SelectWithCustomItems
|
||||||
value: scheme,
|
label={tApperance("defaultColorScheme.label")}
|
||||||
label: tAppearance(`defaultColorScheme.options.${scheme}`),
|
data={colorSchemes.map((scheme) => ({
|
||||||
}))}
|
value: scheme,
|
||||||
{...form.getInputProps("defaultColorScheme")}
|
label: tApperance(`defaultColorScheme.options.${scheme}`),
|
||||||
SelectOption={AppearanceCustomOption}
|
}))}
|
||||||
/>
|
{...form.getInputProps("defaultColorScheme")}
|
||||||
</SectionCard>
|
SelectOption={ApperanceCustomOption}
|
||||||
|
/>
|
||||||
|
</>
|
||||||
|
)}
|
||||||
|
</CommonSettingsForm>
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -40,7 +39,7 @@ const appearanceIcons = {
|
|||||||
dark: IconMoon,
|
dark: IconMoon,
|
||||||
};
|
};
|
||||||
|
|
||||||
const AppearanceCustomOption = ({ value, label }: { value: ColorScheme; label: string }) => {
|
const ApperanceCustomOption = ({ value, label }: { value: ColorScheme; label: string }) => {
|
||||||
const Icon = appearanceIcons[value];
|
const Icon = appearanceIcons[value];
|
||||||
|
|
||||||
return (
|
return (
|
||||||
|
|||||||
@@ -3,50 +3,49 @@
|
|||||||
import { Switch, Text } from "@mantine/core";
|
import { Switch, Text } from "@mantine/core";
|
||||||
|
|
||||||
import { clientApi } from "@homarr/api/client";
|
import { clientApi } from "@homarr/api/client";
|
||||||
import type { UseFormReturnType } from "@homarr/form";
|
import type { ServerSettings } from "@homarr/server-settings";
|
||||||
import { useScopedI18n } from "@homarr/translation/client";
|
import { useScopedI18n } from "@homarr/translation/client";
|
||||||
|
|
||||||
import { BoardSelect } from "~/components/board/board-select";
|
import { BoardSelect } from "~/components/board/board-select";
|
||||||
import { SectionCard } from "~/components/manage/section-card";
|
import { CommonSettingsForm } from "./common-form";
|
||||||
import type { FormValues } from "./settings-form";
|
|
||||||
|
|
||||||
interface BoardSettingsFormProps {
|
export const BoardSettingsForm = ({ defaultValues }: { defaultValues: ServerSettings["board"] }) => {
|
||||||
form: UseFormReturnType<FormValues>;
|
|
||||||
}
|
|
||||||
|
|
||||||
export const BoardSettingsForm = ({ form }: BoardSettingsFormProps) => {
|
|
||||||
const tBoard = useScopedI18n("management.page.settings.section.board");
|
const tBoard = useScopedI18n("management.page.settings.section.board");
|
||||||
const [selectableBoards] = clientApi.board.getPublicBoards.useSuspenseQuery();
|
const [selectableBoards] = clientApi.board.getPublicBoards.useSuspenseQuery();
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<SectionCard title={tBoard("title")}>
|
<CommonSettingsForm settingKey="board" defaultValues={defaultValues}>
|
||||||
<BoardSelect
|
{(form) => (
|
||||||
label={tBoard("homeBoard.label")}
|
<>
|
||||||
description={tBoard("homeBoard.description")}
|
<BoardSelect
|
||||||
clearable
|
label={tBoard("homeBoard.label")}
|
||||||
boards={selectableBoards}
|
description={tBoard("homeBoard.description")}
|
||||||
{...form.getInputProps("homeBoardId")}
|
clearable
|
||||||
/>
|
boards={selectableBoards}
|
||||||
|
{...form.getInputProps("homeBoardId")}
|
||||||
|
/>
|
||||||
|
|
||||||
<BoardSelect
|
<BoardSelect
|
||||||
label={tBoard("homeBoard.mobileLabel")}
|
label={tBoard("homeBoard.mobileLabel")}
|
||||||
description={tBoard("homeBoard.description")}
|
description={tBoard("homeBoard.description")}
|
||||||
clearable
|
clearable
|
||||||
boards={selectableBoards}
|
boards={selectableBoards}
|
||||||
{...form.getInputProps("mobileHomeBoardId")}
|
{...form.getInputProps("mobileHomeBoardId")}
|
||||||
/>
|
/>
|
||||||
|
|
||||||
<Text fw={500}>{tBoard("status.title")}</Text>
|
<Text fw={500}>{tBoard("status.title")}</Text>
|
||||||
<Switch
|
<Switch
|
||||||
{...form.getInputProps("enableStatusByDefault", { type: "checkbox" })}
|
{...form.getInputProps("enableStatusByDefault", { type: "checkbox" })}
|
||||||
label={tBoard("status.enableStatusByDefault.label")}
|
label={tBoard("status.enableStatusByDefault.label")}
|
||||||
description={tBoard("status.enableStatusByDefault.description")}
|
description={tBoard("status.enableStatusByDefault.description")}
|
||||||
/>
|
/>
|
||||||
<Switch
|
<Switch
|
||||||
{...form.getInputProps("forceDisableStatus", { type: "checkbox" })}
|
{...form.getInputProps("forceDisableStatus", { type: "checkbox" })}
|
||||||
label={tBoard("status.forceDisableStatus.label")}
|
label={tBoard("status.forceDisableStatus.label")}
|
||||||
description={tBoard("status.forceDisableStatus.description")}
|
description={tBoard("status.forceDisableStatus.description")}
|
||||||
/>
|
/>
|
||||||
</SectionCard>
|
</>
|
||||||
|
)}
|
||||||
|
</CommonSettingsForm>
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
@@ -0,0 +1,57 @@
|
|||||||
|
"use client";
|
||||||
|
|
||||||
|
import { Button, Group, Stack } from "@mantine/core";
|
||||||
|
|
||||||
|
import { clientApi } from "@homarr/api/client";
|
||||||
|
import { useForm } from "@homarr/form";
|
||||||
|
import { showErrorNotification, showSuccessNotification } from "@homarr/notifications";
|
||||||
|
import type { ServerSettings } from "@homarr/server-settings";
|
||||||
|
import { useI18n, useScopedI18n } from "@homarr/translation/client";
|
||||||
|
|
||||||
|
export const CommonSettingsForm = <TKey extends keyof ServerSettings>({
|
||||||
|
settingKey,
|
||||||
|
defaultValues,
|
||||||
|
children,
|
||||||
|
}: {
|
||||||
|
settingKey: TKey;
|
||||||
|
defaultValues: ServerSettings[TKey];
|
||||||
|
children: (form: ReturnType<typeof useForm<ServerSettings[TKey]>>) => React.ReactNode;
|
||||||
|
}) => {
|
||||||
|
const t = useI18n();
|
||||||
|
const tSettings = useScopedI18n("management.page.settings");
|
||||||
|
const { mutateAsync, isPending } = clientApi.serverSettings.saveSettings.useMutation({
|
||||||
|
onSuccess() {
|
||||||
|
showSuccessNotification({
|
||||||
|
message: tSettings("notification.success.message"),
|
||||||
|
});
|
||||||
|
},
|
||||||
|
onError() {
|
||||||
|
showErrorNotification({
|
||||||
|
message: tSettings("notification.error.message"),
|
||||||
|
});
|
||||||
|
},
|
||||||
|
});
|
||||||
|
const form = useForm({
|
||||||
|
initialValues: defaultValues,
|
||||||
|
});
|
||||||
|
|
||||||
|
const handleSubmitAsync = async (values: ServerSettings[TKey]) => {
|
||||||
|
await mutateAsync({
|
||||||
|
settingsKey: settingKey,
|
||||||
|
value: values,
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
return (
|
||||||
|
<form onSubmit={form.onSubmit((values) => void handleSubmitAsync(values))}>
|
||||||
|
<Stack gap="sm">
|
||||||
|
{children(form)}
|
||||||
|
<Group justify="end">
|
||||||
|
<Button type="submit" loading={isPending}>
|
||||||
|
{t("common.action.save")}
|
||||||
|
</Button>
|
||||||
|
</Group>
|
||||||
|
</Stack>
|
||||||
|
</form>
|
||||||
|
);
|
||||||
|
};
|
||||||
+54
-21
@@ -1,35 +1,68 @@
|
|||||||
"use client";
|
"use client";
|
||||||
|
|
||||||
import { Text } from "@mantine/core";
|
import React from "react";
|
||||||
|
import { Card, LoadingOverlay, Stack, Text, Title } from "@mantine/core";
|
||||||
|
|
||||||
import type { UseFormReturnType } from "@homarr/form";
|
import { clientApi } from "@homarr/api/client";
|
||||||
|
import { revalidatePathActionAsync } from "@homarr/common/client";
|
||||||
|
import { useForm } from "@homarr/form";
|
||||||
|
import type { defaultServerSettings } from "@homarr/server-settings";
|
||||||
import { useScopedI18n } from "@homarr/translation/client";
|
import { useScopedI18n } from "@homarr/translation/client";
|
||||||
|
|
||||||
import { SectionCard } from "~/components/manage/section-card";
|
import { SwitchSetting } from "~/app/[locale]/manage/settings/_components/setting-switch";
|
||||||
import type { FormValues } from "./settings-form";
|
|
||||||
import { SwitchSetting } from "./setting-switch";
|
|
||||||
|
|
||||||
interface CrawlingAndIndexingSettingsProps {
|
interface CrawlingAndIndexingSettingsProps {
|
||||||
form: UseFormReturnType<FormValues>;
|
initialData: typeof defaultServerSettings.crawlingAndIndexing;
|
||||||
}
|
}
|
||||||
|
|
||||||
export const CrawlingAndIndexingSettings = ({ form }: CrawlingAndIndexingSettingsProps) => {
|
export const CrawlingAndIndexingSettings = ({ initialData }: CrawlingAndIndexingSettingsProps) => {
|
||||||
const t = useScopedI18n("management.page.settings.section.crawlingAndIndexing");
|
const t = useScopedI18n("management.page.settings.section.crawlingAndIndexing");
|
||||||
|
const form = useForm({
|
||||||
|
initialValues: initialData,
|
||||||
|
onValuesChange: (updatedValues, _) => {
|
||||||
|
if (!form.isValid()) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
void mutateAsync({
|
||||||
|
settingsKey: "crawlingAndIndexing",
|
||||||
|
value: updatedValues,
|
||||||
|
});
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const { mutateAsync, isPending } = clientApi.serverSettings.saveSettings.useMutation({
|
||||||
|
onSettled: async () => {
|
||||||
|
await revalidatePathActionAsync("/manage/settings");
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<SectionCard title={t("title")}>
|
<>
|
||||||
<Text c="dimmed" size="sm">
|
<Title order={2}>{t("title")}</Title>
|
||||||
{t("warning")}
|
|
||||||
</Text>
|
<Card pos="relative">
|
||||||
<SwitchSetting form={form} formKey="noIndex" title={t("noIndex.title")} text={t("noIndex.text")} />
|
<Text c={"dimmed"} mb={"lg"}>
|
||||||
<SwitchSetting form={form} formKey="noFollow" title={t("noFollow.title")} text={t("noFollow.text")} />
|
{t("warning")}
|
||||||
<SwitchSetting form={form} formKey="noTranslate" title={t("noTranslate.title")} text={t("noTranslate.text")} />
|
</Text>
|
||||||
<SwitchSetting
|
<LoadingOverlay visible={isPending} />
|
||||||
form={form}
|
<Stack>
|
||||||
formKey="noSiteLinksSearchBox"
|
<SwitchSetting form={form} formKey="noIndex" title={t("noIndex.title")} text={t("noIndex.text")} />
|
||||||
title={t("noSiteLinksSearchBox.title")}
|
<SwitchSetting form={form} formKey="noFollow" title={t("noFollow.title")} text={t("noFollow.text")} />
|
||||||
text={t("noSiteLinksSearchBox.text")}
|
<SwitchSetting
|
||||||
/>
|
form={form}
|
||||||
</SectionCard>
|
formKey="noTranslate"
|
||||||
|
title={t("noTranslate.title")}
|
||||||
|
text={t("noTranslate.text")}
|
||||||
|
/>
|
||||||
|
<SwitchSetting
|
||||||
|
form={form}
|
||||||
|
formKey="noSiteLinksSearchBox"
|
||||||
|
title={t("noSiteLinksSearchBox.title")}
|
||||||
|
text={t("noSiteLinksSearchBox.text")}
|
||||||
|
/>
|
||||||
|
</Stack>
|
||||||
|
</Card>
|
||||||
|
</>
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
+14
-16
@@ -1,28 +1,26 @@
|
|||||||
"use client";
|
"use client";
|
||||||
|
|
||||||
import type { UseFormReturnType } from "@homarr/form";
|
import type { ServerSettings } from "@homarr/server-settings";
|
||||||
import type { SupportedLanguage } from "@homarr/translation";
|
import type { SupportedLanguage } from "@homarr/translation";
|
||||||
import { useScopedI18n } from "@homarr/translation/client";
|
import { useScopedI18n } from "@homarr/translation/client";
|
||||||
|
|
||||||
import { LanguageCombobox } from "~/components/language/language-combobox";
|
import { LanguageCombobox } from "~/components/language/language-combobox";
|
||||||
import { SectionCard } from "~/components/manage/section-card";
|
import { CommonSettingsForm } from "./common-form";
|
||||||
import type { FormValues } from "./settings-form";
|
|
||||||
|
|
||||||
interface CultureSettingsFormProps {
|
export const CultureSettingsForm = ({ defaultValues }: { defaultValues: ServerSettings["culture"] }) => {
|
||||||
form: UseFormReturnType<FormValues>;
|
|
||||||
}
|
|
||||||
|
|
||||||
export const CultureSettingsForm = ({ form }: CultureSettingsFormProps) => {
|
|
||||||
const tCulture = useScopedI18n("management.page.settings.section.culture");
|
const tCulture = useScopedI18n("management.page.settings.section.culture");
|
||||||
const localeInputProps = form.getInputProps("defaultLocale");
|
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<SectionCard title={tCulture("title")}>
|
<CommonSettingsForm settingKey="culture" defaultValues={defaultValues}>
|
||||||
<LanguageCombobox
|
{(form) => (
|
||||||
label={tCulture("defaultLocale.label")}
|
<>
|
||||||
{...localeInputProps}
|
<LanguageCombobox
|
||||||
value={localeInputProps.value as SupportedLanguage}
|
label={tCulture("defaultLocale.label")}
|
||||||
/>
|
value={form.getInputProps("defaultLocale").value as SupportedLanguage}
|
||||||
</SectionCard>
|
{...form.getInputProps("defaultLocale")}
|
||||||
|
/>
|
||||||
|
</>
|
||||||
|
)}
|
||||||
|
</CommonSettingsForm>
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
@@ -3,28 +3,27 @@
|
|||||||
import { Select } from "@mantine/core";
|
import { Select } from "@mantine/core";
|
||||||
|
|
||||||
import { clientApi } from "@homarr/api/client";
|
import { clientApi } from "@homarr/api/client";
|
||||||
import type { UseFormReturnType } from "@homarr/form";
|
import type { ServerSettings } from "@homarr/server-settings";
|
||||||
import { useScopedI18n } from "@homarr/translation/client";
|
import { useScopedI18n } from "@homarr/translation/client";
|
||||||
|
|
||||||
import { SectionCard } from "~/components/manage/section-card";
|
import { CommonSettingsForm } from "./common-form";
|
||||||
import type { FormValues } from "./settings-form";
|
|
||||||
|
|
||||||
interface SearchSettingsFormProps {
|
export const SearchSettingsForm = ({ defaultValues }: { defaultValues: ServerSettings["search"] }) => {
|
||||||
form: UseFormReturnType<FormValues>;
|
|
||||||
}
|
|
||||||
|
|
||||||
export const SearchSettingsForm = ({ form }: SearchSettingsFormProps) => {
|
|
||||||
const tSearch = useScopedI18n("management.page.settings.section.search");
|
const tSearch = useScopedI18n("management.page.settings.section.search");
|
||||||
const [selectableSearchEngines] = clientApi.searchEngine.getSelectable.useSuspenseQuery({ withIntegrations: false });
|
const [selectableSearchEngines] = clientApi.searchEngine.getSelectable.useSuspenseQuery({ withIntegrations: false });
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<SectionCard title={tSearch("title")}>
|
<CommonSettingsForm settingKey="search" defaultValues={defaultValues}>
|
||||||
<Select
|
{(form) => (
|
||||||
label={tSearch("defaultSearchEngine.label")}
|
<>
|
||||||
description={tSearch("defaultSearchEngine.description")}
|
<Select
|
||||||
data={selectableSearchEngines}
|
label={tSearch("defaultSearchEngine.label")}
|
||||||
{...form.getInputProps("defaultSearchEngineId")}
|
description={tSearch("defaultSearchEngine.description")}
|
||||||
/>
|
data={selectableSearchEngines}
|
||||||
</SectionCard>
|
{...form.getInputProps("defaultSearchEngineId")}
|
||||||
|
/>
|
||||||
|
</>
|
||||||
|
)}
|
||||||
|
</CommonSettingsForm>
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
@@ -3,13 +3,10 @@ import React from "react";
|
|||||||
import type { MantineSpacing } from "@mantine/core";
|
import type { MantineSpacing } from "@mantine/core";
|
||||||
import { Group, Stack, Switch, Text, UnstyledButton } from "@mantine/core";
|
import { Group, Stack, Switch, Text, UnstyledButton } from "@mantine/core";
|
||||||
|
|
||||||
|
import type { Modify } from "@homarr/common/types";
|
||||||
import type { UseFormReturnType } from "@homarr/form";
|
import type { UseFormReturnType } from "@homarr/form";
|
||||||
|
|
||||||
type BooleanKeys<TFormValue> = {
|
export const SwitchSetting = <TFormValue extends Record<string, boolean>>({
|
||||||
[TKey in keyof TFormValue]: TFormValue[TKey] extends boolean ? TKey : never;
|
|
||||||
}[keyof TFormValue];
|
|
||||||
|
|
||||||
export const SwitchSetting = <TFormValue extends Record<string, unknown>>({
|
|
||||||
form,
|
form,
|
||||||
ms,
|
ms,
|
||||||
title,
|
title,
|
||||||
@@ -17,8 +14,13 @@ export const SwitchSetting = <TFormValue extends Record<string, unknown>>({
|
|||||||
formKey,
|
formKey,
|
||||||
disabled,
|
disabled,
|
||||||
}: {
|
}: {
|
||||||
form: UseFormReturnType<TFormValue, TFormValue>;
|
form: Modify<
|
||||||
formKey: string & BooleanKeys<TFormValue>;
|
UseFormReturnType<TFormValue, TFormValue>,
|
||||||
|
{
|
||||||
|
setFieldValue: (key: keyof TFormValue, value: (previous: boolean) => boolean) => void;
|
||||||
|
}
|
||||||
|
>;
|
||||||
|
formKey: keyof TFormValue;
|
||||||
ms?: MantineSpacing;
|
ms?: MantineSpacing;
|
||||||
title: string;
|
title: string;
|
||||||
text: ReactNode;
|
text: ReactNode;
|
||||||
@@ -29,7 +31,7 @@ export const SwitchSetting = <TFormValue extends Record<string, unknown>>({
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
form.setFieldValue(formKey, (previous) => !previous as never);
|
form.setFieldValue(formKey, (previous) => !previous);
|
||||||
}, [form, formKey, disabled]);
|
}, [form, formKey, disabled]);
|
||||||
|
|
||||||
return (
|
return (
|
||||||
@@ -42,7 +44,7 @@ export const SwitchSetting = <TFormValue extends Record<string, unknown>>({
|
|||||||
</Text>
|
</Text>
|
||||||
</Stack>
|
</Stack>
|
||||||
</UnstyledButton>
|
</UnstyledButton>
|
||||||
<Switch disabled={disabled} onClick={handleClick} checked={Boolean(form.values[formKey])} />
|
<Switch disabled={disabled} onClick={handleClick} checked={form.values[formKey] && !disabled} />
|
||||||
</Group>
|
</Group>
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
@@ -1,193 +0,0 @@
|
|||||||
"use client";
|
|
||||||
|
|
||||||
import { useEffect, useRef, useState } from "react";
|
|
||||||
import { Button, Stack } from "@mantine/core";
|
|
||||||
import { z } from "zod/v4";
|
|
||||||
|
|
||||||
import { clientApi } from "@homarr/api/client";
|
|
||||||
import { revalidatePathActionAsync } from "@homarr/common/client";
|
|
||||||
import { env } from "@homarr/common/env";
|
|
||||||
import { colorSchemes } from "@homarr/definitions";
|
|
||||||
import { useZodForm } from "@homarr/form";
|
|
||||||
import { showErrorNotification, showSuccessNotification } from "@homarr/notifications";
|
|
||||||
import type { ServerSettings, defaultServerSettingsKeys } from "@homarr/server-settings";
|
|
||||||
import { useI18n, useScopedI18n } from "@homarr/translation/client";
|
|
||||||
|
|
||||||
import { UnsavedChangesBar } from "~/components/manage/unsaved-changes-bar";
|
|
||||||
import { AnalyticsSettings } from "./analytics.settings";
|
|
||||||
import { AppearanceSettingsForm } from "./appearance-settings-form";
|
|
||||||
import { BoardSettingsForm } from "./board-settings-form";
|
|
||||||
import { CrawlingAndIndexingSettings } from "./crawling-and-indexing.settings";
|
|
||||||
import { CultureSettingsForm } from "./culture-settings-form";
|
|
||||||
import { SearchSettingsForm } from "./search-settings-form";
|
|
||||||
import { UserSettingsForm } from "./user-settings-form";
|
|
||||||
|
|
||||||
const settingsFormSchema = z.object({
|
|
||||||
enableGeneral: z.boolean(),
|
|
||||||
noIndex: z.boolean(),
|
|
||||||
noFollow: z.boolean(),
|
|
||||||
noTranslate: z.boolean(),
|
|
||||||
noSiteLinksSearchBox: z.boolean(),
|
|
||||||
homeBoardId: z.string().nullable(),
|
|
||||||
mobileHomeBoardId: z.string().nullable(),
|
|
||||||
enableStatusByDefault: z.boolean(),
|
|
||||||
forceDisableStatus: z.boolean(),
|
|
||||||
enableGravatar: z.boolean(),
|
|
||||||
defaultSearchEngineId: z.string().nullable(),
|
|
||||||
defaultColorScheme: z.enum(colorSchemes),
|
|
||||||
defaultLocale: z.string(),
|
|
||||||
});
|
|
||||||
|
|
||||||
export type FormValues = z.infer<typeof settingsFormSchema>;
|
|
||||||
|
|
||||||
const buildInitialValues = (initialData: ServerSettings): FormValues => ({
|
|
||||||
enableGeneral: initialData.analytics.enableGeneral,
|
|
||||||
noIndex: initialData.crawlingAndIndexing.noIndex,
|
|
||||||
noFollow: initialData.crawlingAndIndexing.noFollow,
|
|
||||||
noTranslate: initialData.crawlingAndIndexing.noTranslate,
|
|
||||||
noSiteLinksSearchBox: initialData.crawlingAndIndexing.noSiteLinksSearchBox,
|
|
||||||
homeBoardId: initialData.board.homeBoardId,
|
|
||||||
mobileHomeBoardId: initialData.board.mobileHomeBoardId,
|
|
||||||
enableStatusByDefault: initialData.board.enableStatusByDefault,
|
|
||||||
forceDisableStatus: initialData.board.forceDisableStatus,
|
|
||||||
enableGravatar: initialData.user.enableGravatar,
|
|
||||||
defaultSearchEngineId: initialData.search.defaultSearchEngineId,
|
|
||||||
defaultColorScheme: initialData.appearance.defaultColorScheme,
|
|
||||||
defaultLocale: initialData.culture.defaultLocale,
|
|
||||||
});
|
|
||||||
|
|
||||||
interface SettingsFormProps {
|
|
||||||
initialData: ServerSettings;
|
|
||||||
}
|
|
||||||
|
|
||||||
export const SettingsForm = ({ initialData }: SettingsFormProps) => {
|
|
||||||
const t = useI18n();
|
|
||||||
const tSettings = useScopedI18n("management.page.settings");
|
|
||||||
|
|
||||||
const initialValues = buildInitialValues(initialData);
|
|
||||||
const initialValuesRef = useRef(initialValues);
|
|
||||||
|
|
||||||
const form = useZodForm(settingsFormSchema, {
|
|
||||||
initialValues,
|
|
||||||
});
|
|
||||||
|
|
||||||
const isDirtyRef = useRef(false);
|
|
||||||
isDirtyRef.current = form.isDirty();
|
|
||||||
|
|
||||||
const [isSubmitting, setIsSubmitting] = useState(false);
|
|
||||||
|
|
||||||
const saveSettingsMutation = clientApi.serverSettings.saveSettings.useMutation({
|
|
||||||
onError(error) {
|
|
||||||
showErrorNotification({ title: t("common.notification.update.error"), message: error.message });
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
useEffect(() => {
|
|
||||||
const handler = (event: BeforeUnloadEvent) => {
|
|
||||||
if (env.NODE_ENV === "development") return;
|
|
||||||
if (isDirtyRef.current) event.preventDefault();
|
|
||||||
};
|
|
||||||
window.addEventListener("beforeunload", handler);
|
|
||||||
return () => window.removeEventListener("beforeunload", handler);
|
|
||||||
}, []);
|
|
||||||
|
|
||||||
const handleSubmitAsync = async (values: FormValues) => {
|
|
||||||
const defaults = initialValuesRef.current;
|
|
||||||
const changed = <TKey extends keyof FormValues>(...fields: TKey[]) =>
|
|
||||||
fields.some((field) => values[field] !== defaults[field]);
|
|
||||||
|
|
||||||
const groups: {
|
|
||||||
settingsKey: (typeof defaultServerSettingsKeys)[number];
|
|
||||||
when: boolean;
|
|
||||||
value: Record<string, unknown>;
|
|
||||||
}[] = [
|
|
||||||
{ settingsKey: "analytics", when: changed("enableGeneral"), value: { enableGeneral: values.enableGeneral } },
|
|
||||||
{
|
|
||||||
settingsKey: "crawlingAndIndexing",
|
|
||||||
when: changed("noIndex", "noFollow", "noTranslate", "noSiteLinksSearchBox"),
|
|
||||||
value: {
|
|
||||||
noIndex: values.noIndex,
|
|
||||||
noFollow: values.noFollow,
|
|
||||||
noTranslate: values.noTranslate,
|
|
||||||
noSiteLinksSearchBox: values.noSiteLinksSearchBox,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
settingsKey: "board",
|
|
||||||
when: changed("homeBoardId", "mobileHomeBoardId", "enableStatusByDefault", "forceDisableStatus"),
|
|
||||||
value: {
|
|
||||||
homeBoardId: values.homeBoardId,
|
|
||||||
mobileHomeBoardId: values.mobileHomeBoardId,
|
|
||||||
enableStatusByDefault: values.enableStatusByDefault,
|
|
||||||
forceDisableStatus: values.forceDisableStatus,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{ settingsKey: "user", when: changed("enableGravatar"), value: { enableGravatar: values.enableGravatar } },
|
|
||||||
{
|
|
||||||
settingsKey: "search",
|
|
||||||
when: changed("defaultSearchEngineId"),
|
|
||||||
value: { defaultSearchEngineId: values.defaultSearchEngineId },
|
|
||||||
},
|
|
||||||
{
|
|
||||||
settingsKey: "appearance",
|
|
||||||
when: changed("defaultColorScheme"),
|
|
||||||
value: { defaultColorScheme: values.defaultColorScheme },
|
|
||||||
},
|
|
||||||
{ settingsKey: "culture", when: changed("defaultLocale"), value: { defaultLocale: values.defaultLocale } },
|
|
||||||
];
|
|
||||||
|
|
||||||
const promises = groups
|
|
||||||
.filter((group) => group.when)
|
|
||||||
.map((group) => saveSettingsMutation.mutateAsync({ settingsKey: group.settingsKey, value: group.value }));
|
|
||||||
if (promises.length === 0) return;
|
|
||||||
|
|
||||||
setIsSubmitting(true);
|
|
||||||
try {
|
|
||||||
const results = await Promise.allSettled(promises);
|
|
||||||
if (!results.every((result) => result.status === "fulfilled")) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
initialValuesRef.current = values;
|
|
||||||
form.setInitialValues(values);
|
|
||||||
form.resetDirty();
|
|
||||||
await revalidatePathActionAsync("/manage/settings");
|
|
||||||
showSuccessNotification({
|
|
||||||
title: t("common.notification.update.success"),
|
|
||||||
message: tSettings("notification.success.message"),
|
|
||||||
});
|
|
||||||
} finally {
|
|
||||||
setIsSubmitting(false);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
const handleDiscard = () => {
|
|
||||||
form.setValues(initialValuesRef.current);
|
|
||||||
form.resetDirty();
|
|
||||||
};
|
|
||||||
|
|
||||||
return (
|
|
||||||
<form onSubmit={form.onSubmit((values) => void handleSubmitAsync(values))}>
|
|
||||||
<Stack gap="xl">
|
|
||||||
<AnalyticsSettings form={form} />
|
|
||||||
<CrawlingAndIndexingSettings form={form} />
|
|
||||||
<BoardSettingsForm form={form} />
|
|
||||||
<UserSettingsForm form={form} />
|
|
||||||
<SearchSettingsForm form={form} />
|
|
||||||
<AppearanceSettingsForm form={form} />
|
|
||||||
<CultureSettingsForm form={form} />
|
|
||||||
|
|
||||||
{form.isDirty() && (
|
|
||||||
<UnsavedChangesBar>
|
|
||||||
<Button type="button" disabled={isSubmitting} variant="default" onClick={handleDiscard}>
|
|
||||||
{t("common.action.discard")}
|
|
||||||
</Button>
|
|
||||||
<Button loading={isSubmitting} type="submit" disabled={!form.isValid()}>
|
|
||||||
{t("common.action.saveChanges")}
|
|
||||||
</Button>
|
|
||||||
</UnsavedChangesBar>
|
|
||||||
)}
|
|
||||||
</Stack>
|
|
||||||
</form>
|
|
||||||
);
|
|
||||||
};
|
|
||||||
@@ -2,26 +2,25 @@
|
|||||||
|
|
||||||
import { Switch } from "@mantine/core";
|
import { Switch } from "@mantine/core";
|
||||||
|
|
||||||
import type { UseFormReturnType } from "@homarr/form";
|
import type { ServerSettings } from "@homarr/server-settings";
|
||||||
import { useScopedI18n } from "@homarr/translation/client";
|
import { useScopedI18n } from "@homarr/translation/client";
|
||||||
|
|
||||||
import { SectionCard } from "~/components/manage/section-card";
|
import { CommonSettingsForm } from "./common-form";
|
||||||
import type { FormValues } from "./settings-form";
|
|
||||||
|
|
||||||
interface UserSettingsFormProps {
|
export const UserSettingsForm = ({ defaultValues }: { defaultValues: ServerSettings["user"] }) => {
|
||||||
form: UseFormReturnType<FormValues>;
|
|
||||||
}
|
|
||||||
|
|
||||||
export const UserSettingsForm = ({ form }: UserSettingsFormProps) => {
|
|
||||||
const tUser = useScopedI18n("management.page.settings.section.user");
|
const tUser = useScopedI18n("management.page.settings.section.user");
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<SectionCard title={tUser("title")}>
|
<CommonSettingsForm settingKey="user" defaultValues={defaultValues}>
|
||||||
<Switch
|
{(form) => (
|
||||||
{...form.getInputProps("enableGravatar", { type: "checkbox" })}
|
<>
|
||||||
label={tUser("enableGravatar.label")}
|
<Switch
|
||||||
description={tUser("enableGravatar.description")}
|
{...form.getInputProps("enableGravatar", { type: "checkbox" })}
|
||||||
/>
|
label={tUser("enableGravatar.label")}
|
||||||
</SectionCard>
|
description={tUser("enableGravatar.description")}
|
||||||
|
/>
|
||||||
|
</>
|
||||||
|
)}
|
||||||
|
</CommonSettingsForm>
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
import { Center, Loader } from "@mantine/core";
|
|
||||||
|
|
||||||
export default function SettingsLoading() {
|
|
||||||
return (
|
|
||||||
<Center h="40vh">
|
|
||||||
<Loader />
|
|
||||||
</Center>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
@@ -5,8 +5,14 @@ import { api } from "@homarr/api/server";
|
|||||||
import { auth } from "@homarr/auth/next";
|
import { auth } from "@homarr/auth/next";
|
||||||
import { getScopedI18n } from "@homarr/translation/server";
|
import { getScopedI18n } from "@homarr/translation/server";
|
||||||
|
|
||||||
|
import { CrawlingAndIndexingSettings } from "~/app/[locale]/manage/settings/_components/crawling-and-indexing.settings";
|
||||||
import { DynamicBreadcrumb } from "~/components/navigation/dynamic-breadcrumb";
|
import { DynamicBreadcrumb } from "~/components/navigation/dynamic-breadcrumb";
|
||||||
import { SettingsForm } from "./_components/settings-form";
|
import { AnalyticsSettings } from "./_components/analytics.settings";
|
||||||
|
import { AppearanceSettingsForm } from "./_components/appearance-settings-form";
|
||||||
|
import { BoardSettingsForm } from "./_components/board-settings-form";
|
||||||
|
import { CultureSettingsForm } from "./_components/culture-settings-form";
|
||||||
|
import { SearchSettingsForm } from "./_components/search-settings-form";
|
||||||
|
import { UserSettingsForm } from "./_components/user-settings-form";
|
||||||
|
|
||||||
export async function generateMetadata() {
|
export async function generateMetadata() {
|
||||||
const t = await getScopedI18n("management");
|
const t = await getScopedI18n("management");
|
||||||
@@ -26,13 +32,33 @@ export default async function SettingsPage() {
|
|||||||
|
|
||||||
const serverSettings = await api.serverSettings.getAll();
|
const serverSettings = await api.serverSettings.getAll();
|
||||||
const tSettings = await getScopedI18n("management.page.settings");
|
const tSettings = await getScopedI18n("management.page.settings");
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<>
|
<>
|
||||||
<DynamicBreadcrumb />
|
<DynamicBreadcrumb />
|
||||||
<Stack>
|
<Stack>
|
||||||
<Title order={1}>{tSettings("title")}</Title>
|
<Title order={1}>{tSettings("title")}</Title>
|
||||||
<SettingsForm initialData={serverSettings} />
|
<AnalyticsSettings initialData={serverSettings.analytics} />
|
||||||
|
<CrawlingAndIndexingSettings initialData={serverSettings.crawlingAndIndexing} />
|
||||||
|
<Stack>
|
||||||
|
<Title order={2}>{tSettings("section.board.title")}</Title>
|
||||||
|
<BoardSettingsForm defaultValues={serverSettings.board} />
|
||||||
|
</Stack>
|
||||||
|
<Stack>
|
||||||
|
<Title order={2}>{tSettings("section.user.title")}</Title>
|
||||||
|
<UserSettingsForm defaultValues={serverSettings.user} />
|
||||||
|
</Stack>
|
||||||
|
<Stack>
|
||||||
|
<Title order={2}>{tSettings("section.search.title")}</Title>
|
||||||
|
<SearchSettingsForm defaultValues={serverSettings.search} />
|
||||||
|
</Stack>
|
||||||
|
<Stack>
|
||||||
|
<Title order={2}>{tSettings("section.appearance.title")}</Title>
|
||||||
|
<AppearanceSettingsForm defaultValues={serverSettings.appearance} />
|
||||||
|
</Stack>
|
||||||
|
<Stack>
|
||||||
|
<Title order={2}>{tSettings("section.culture.title")}</Title>
|
||||||
|
<CultureSettingsForm defaultValues={serverSettings.culture} />
|
||||||
|
</Stack>
|
||||||
</Stack>
|
</Stack>
|
||||||
</>
|
</>
|
||||||
);
|
);
|
||||||
|
|||||||
+65
-4
@@ -1,14 +1,49 @@
|
|||||||
"use client";
|
"use client";
|
||||||
|
|
||||||
import { Card, Group, Stack, Text, Title } from "@mantine/core";
|
import { useState } from "react";
|
||||||
import { IconDatabaseExport } from "@tabler/icons-react";
|
import { Alert, Button, Card, Group, Stack, Text, Title } from "@mantine/core";
|
||||||
|
import { IconAlertTriangle, IconDatabaseExport, IconDownload } from "@tabler/icons-react";
|
||||||
|
|
||||||
import { useScopedI18n } from "@homarr/translation/client";
|
import { useScopedI18n } from "@homarr/translation/client";
|
||||||
|
|
||||||
import { BackupExportButton } from "~/components/backup";
|
import { DangerousActionConfirmation } from "~/components/backup/dangerous-action-confirmation";
|
||||||
|
|
||||||
export const BackupExportCard = () => {
|
export const BackupExportCard = () => {
|
||||||
const t = useScopedI18n("management.page.tool.backup.export");
|
const t = useScopedI18n("management.page.tool.backup.export");
|
||||||
|
const [loading, setLoading] = useState(false);
|
||||||
|
const [error, setError] = useState<string | null>(null);
|
||||||
|
const [showConfirm, setShowConfirm] = useState(false);
|
||||||
|
|
||||||
|
const handleExport = async () => {
|
||||||
|
setLoading(true);
|
||||||
|
setError(null);
|
||||||
|
try {
|
||||||
|
const response = await fetch("/api/backup/export");
|
||||||
|
if (!response.ok) {
|
||||||
|
const errorMessage = await response.json().then(
|
||||||
|
(data) => data.error,
|
||||||
|
() => `Server returned ${response.status}`,
|
||||||
|
);
|
||||||
|
throw new Error(errorMessage ?? t("error"));
|
||||||
|
}
|
||||||
|
|
||||||
|
const blob = await response.blob();
|
||||||
|
const url = URL.createObjectURL(blob);
|
||||||
|
const filename =
|
||||||
|
response.headers.get("Content-Disposition")?.match(/filename="(.+)"/)?.[1] ?? "homarr-backup.zip";
|
||||||
|
|
||||||
|
const a = document.createElement("a");
|
||||||
|
a.href = url;
|
||||||
|
a.download = filename;
|
||||||
|
a.click();
|
||||||
|
URL.revokeObjectURL(url);
|
||||||
|
setShowConfirm(false);
|
||||||
|
} catch (err) {
|
||||||
|
setError(err instanceof Error ? err.message : t("error"));
|
||||||
|
} finally {
|
||||||
|
setLoading(false);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<Card withBorder>
|
<Card withBorder>
|
||||||
@@ -20,7 +55,33 @@ export const BackupExportCard = () => {
|
|||||||
<Text size="sm" c="dimmed">
|
<Text size="sm" c="dimmed">
|
||||||
{t("description")}
|
{t("description")}
|
||||||
</Text>
|
</Text>
|
||||||
<BackupExportButton />
|
{error && (
|
||||||
|
<Alert color="red" icon={<IconAlertTriangle size={16} />}>
|
||||||
|
{error}
|
||||||
|
</Alert>
|
||||||
|
)}
|
||||||
|
|
||||||
|
{showConfirm ? (
|
||||||
|
<DangerousActionConfirmation
|
||||||
|
title={t("confirm.title")}
|
||||||
|
warningTitle={t("confirm.warningTitle")}
|
||||||
|
warningBody={t("confirm.warningBody")}
|
||||||
|
typePrompt={t("confirm.typePrompt", { phrase: "I understand" })}
|
||||||
|
submitLabel={t("confirm.submit")}
|
||||||
|
submitIcon={<IconDownload size={16} />}
|
||||||
|
cancelLabel={t("confirm.cancel")}
|
||||||
|
onConfirm={handleExport}
|
||||||
|
onCancel={() => setShowConfirm(false)}
|
||||||
|
disabled={loading}
|
||||||
|
color="orange"
|
||||||
|
/>
|
||||||
|
) : (
|
||||||
|
<Group>
|
||||||
|
<Button leftSection={<IconDownload size={16} />} loading={loading} onClick={() => setShowConfirm(true)}>
|
||||||
|
{t("button")}
|
||||||
|
</Button>
|
||||||
|
</Group>
|
||||||
|
)}
|
||||||
</Stack>
|
</Stack>
|
||||||
</Card>
|
</Card>
|
||||||
);
|
);
|
||||||
|
|||||||
-3
@@ -1,6 +1,5 @@
|
|||||||
"use client";
|
"use client";
|
||||||
|
|
||||||
import { useRouter } from "next/navigation";
|
|
||||||
import { Badge, Button, Group, Stack, Text } from "@mantine/core";
|
import { Badge, Button, Group, Stack, Text } from "@mantine/core";
|
||||||
import { IconRefresh } from "@tabler/icons-react";
|
import { IconRefresh } from "@tabler/icons-react";
|
||||||
|
|
||||||
@@ -10,7 +9,6 @@ import { useScopedI18n } from "@homarr/translation/client";
|
|||||||
|
|
||||||
export const ResetTours = () => {
|
export const ResetTours = () => {
|
||||||
const t = useScopedI18n("management.page.user.setting.general.item.onboardingTours");
|
const t = useScopedI18n("management.page.user.setting.general.item.onboardingTours");
|
||||||
const router = useRouter();
|
|
||||||
const utils = clientApi.useUtils();
|
const utils = clientApi.useUtils();
|
||||||
const { data: tourStatus } = clientApi.user.getTourStatus.useQuery();
|
const { data: tourStatus } = clientApi.user.getTourStatus.useQuery();
|
||||||
const { mutate: resetTours, isPending } = clientApi.user.resetTours.useMutation({
|
const { mutate: resetTours, isPending } = clientApi.user.resetTours.useMutation({
|
||||||
@@ -20,7 +18,6 @@ export const ResetTours = () => {
|
|||||||
message: t("resetSuccess.message"),
|
message: t("resetSuccess.message"),
|
||||||
});
|
});
|
||||||
void utils.user.getTourStatus.invalidate();
|
void utils.user.getTourStatus.invalidate();
|
||||||
router.refresh();
|
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
@@ -1,38 +1,41 @@
|
|||||||
"use client";
|
"use client";
|
||||||
|
|
||||||
import { use, useCallback, useState } from "react";
|
import { useCallback, useMemo, useState } from "react";
|
||||||
import { ActionIcon, Affix, Card } from "@mantine/core";
|
import { ActionIcon, Affix, Card } from "@mantine/core";
|
||||||
import { IconDimensions, IconPencil, IconToggleLeft, IconToggleRight } from "@tabler/icons-react";
|
import { IconDimensions, IconPencil, IconToggleLeft, IconToggleRight } from "@tabler/icons-react";
|
||||||
import { QueryErrorResetBoundary } from "@tanstack/react-query";
|
import { QueryErrorResetBoundary } from "@tanstack/react-query";
|
||||||
import { ErrorBoundary } from "react-error-boundary";
|
import { ErrorBoundary } from "react-error-boundary";
|
||||||
|
|
||||||
import { clientApi } from "@homarr/api/client";
|
import type { IntegrationKind, WidgetKind } from "@homarr/definitions";
|
||||||
import type { WidgetKind } from "@homarr/definitions";
|
|
||||||
import { useModalAction } from "@homarr/modals";
|
import { useModalAction } from "@homarr/modals";
|
||||||
import { showErrorNotification, showSuccessNotification } from "@homarr/notifications";
|
import { showSuccessNotification } from "@homarr/notifications";
|
||||||
import { useSettings } from "@homarr/settings";
|
import { useSettings } from "@homarr/settings";
|
||||||
import { useI18n } from "@homarr/translation/client";
|
import { useI18n } from "@homarr/translation/client";
|
||||||
import type { BoardItemAdvancedOptions } from "@homarr/validation/shared";
|
import type { BoardItemAdvancedOptions } from "@homarr/validation/shared";
|
||||||
|
import { loadWidgetDynamic, reduceWidgetOptionsWithDefaultValues, widgetImports } from "@homarr/widgets";
|
||||||
import { WidgetError } from "@homarr/widgets/errors";
|
import { WidgetError } from "@homarr/widgets/errors";
|
||||||
import { loadWidgetResources, reduceWidgetOptionsWithDefinition } from "@homarr/widgets/manifest";
|
import { WidgetEditModal } from "@homarr/widgets/modals";
|
||||||
|
|
||||||
import { LazyWidgetEditModal, preloadWidgetEditModal } from "~/components/board/items/lazy-widget-edit-modal";
|
|
||||||
import type { Dimensions } from "./_dimension-modal";
|
import type { Dimensions } from "./_dimension-modal";
|
||||||
import { PreviewDimensionsModal } from "./_dimension-modal";
|
import { PreviewDimensionsModal } from "./_dimension-modal";
|
||||||
|
|
||||||
interface WidgetPreviewPageContentProps {
|
interface WidgetPreviewPageContentProps {
|
||||||
kind: WidgetKind;
|
kind: WidgetKind;
|
||||||
|
integrationData: {
|
||||||
|
id: string;
|
||||||
|
name: string;
|
||||||
|
url: string;
|
||||||
|
kind: IntegrationKind;
|
||||||
|
}[];
|
||||||
}
|
}
|
||||||
|
|
||||||
export const WidgetPreviewPageContent = ({ kind }: WidgetPreviewPageContentProps) => {
|
export const WidgetPreviewPageContent = ({ kind, integrationData }: WidgetPreviewPageContentProps) => {
|
||||||
const settings = useSettings();
|
const settings = useSettings();
|
||||||
const t = useI18n();
|
const t = useI18n();
|
||||||
const utils = clientApi.useUtils();
|
const { openModal: openWidgetEditModal } = useModalAction(WidgetEditModal);
|
||||||
const { openModal: openWidgetEditModal } = useModalAction(LazyWidgetEditModal);
|
|
||||||
const { openModal: openPreviewDimensionsModal } = useModalAction(PreviewDimensionsModal);
|
const { openModal: openPreviewDimensionsModal } = useModalAction(PreviewDimensionsModal);
|
||||||
const { definition: currentDefinition, Component } = use(loadWidgetResources(kind));
|
const currentDefinition = useMemo(() => widgetImports[kind].definition, [kind]);
|
||||||
const [editMode, setEditMode] = useState(false);
|
const [editMode, setEditMode] = useState(false);
|
||||||
const [isEditorLoading, setIsEditorLoading] = useState(false);
|
|
||||||
const [dimensions, setDimensions] = useState<Dimensions>({
|
const [dimensions, setDimensions] = useState<Dimensions>({
|
||||||
width: 128,
|
width: 128,
|
||||||
height: 128,
|
height: 128,
|
||||||
@@ -42,7 +45,7 @@ export const WidgetPreviewPageContent = ({ kind }: WidgetPreviewPageContentProps
|
|||||||
integrationIds: string[];
|
integrationIds: string[];
|
||||||
advancedOptions: BoardItemAdvancedOptions;
|
advancedOptions: BoardItemAdvancedOptions;
|
||||||
}>({
|
}>({
|
||||||
options: reduceWidgetOptionsWithDefinition(currentDefinition, settings, {}),
|
options: reduceWidgetOptionsWithDefaultValues(kind, settings, {}),
|
||||||
integrationIds: [],
|
integrationIds: [],
|
||||||
advancedOptions: {
|
advancedOptions: {
|
||||||
title: null,
|
title: null,
|
||||||
@@ -51,41 +54,31 @@ export const WidgetPreviewPageContent = ({ kind }: WidgetPreviewPageContentProps
|
|||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
const handleOpenEditWidgetModal = useCallback(async () => {
|
const handleOpenEditWidgetModal = useCallback(() => {
|
||||||
const hasIntegrationSupport = "supportedIntegrations" in currentDefinition;
|
openWidgetEditModal(
|
||||||
setIsEditorLoading(true);
|
{
|
||||||
preloadWidgetEditModal();
|
kind,
|
||||||
try {
|
value: state,
|
||||||
const integrationData = hasIntegrationSupport ? await utils.integration.all.ensureData() : [];
|
onSuccessfulEdit: (value) => {
|
||||||
openWidgetEditModal(
|
setState(value);
|
||||||
{
|
|
||||||
kind,
|
|
||||||
definition: currentDefinition,
|
|
||||||
value: state,
|
|
||||||
onSuccessfulEdit: (value) => {
|
|
||||||
setState(value);
|
|
||||||
},
|
|
||||||
integrationData: integrationData.filter((integration) =>
|
|
||||||
(currentDefinition.supportedIntegrations ?? []).includes(integration.kind),
|
|
||||||
),
|
|
||||||
integrationSupport: hasIntegrationSupport,
|
|
||||||
settings,
|
|
||||||
},
|
},
|
||||||
{
|
integrationData: integrationData.filter(
|
||||||
title(translate) {
|
(integration) =>
|
||||||
return `${translate("item.edit.title")} - ${translate(`widget.${kind}.name`)}`;
|
"supportedIntegrations" in currentDefinition &&
|
||||||
},
|
(currentDefinition.supportedIntegrations as string[]).some((kind) => kind === integration.kind),
|
||||||
|
),
|
||||||
|
integrationSupport: "supportedIntegrations" in currentDefinition,
|
||||||
|
settings,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
title(t) {
|
||||||
|
return `${t("item.edit.title")} - ${t(`widget.${kind}.name`)}`;
|
||||||
},
|
},
|
||||||
);
|
},
|
||||||
} catch (error) {
|
);
|
||||||
showErrorNotification({
|
}, [currentDefinition, integrationData, kind, openWidgetEditModal, settings, state]);
|
||||||
title: t("common.error"),
|
|
||||||
message: error instanceof Error ? error.message : String(error),
|
const Comp = loadWidgetDynamic(kind);
|
||||||
});
|
|
||||||
} finally {
|
|
||||||
setIsEditorLoading(false);
|
|
||||||
}
|
|
||||||
}, [currentDefinition, kind, openWidgetEditModal, settings, state, t, utils]);
|
|
||||||
|
|
||||||
const toggleEditMode = useCallback(() => {
|
const toggleEditMode = useCallback(() => {
|
||||||
setEditMode((editMode) => !editMode);
|
setEditMode((editMode) => !editMode);
|
||||||
@@ -101,11 +94,8 @@ export const WidgetPreviewPageContent = ({ kind }: WidgetPreviewPageContentProps
|
|||||||
});
|
});
|
||||||
}, [dimensions, openPreviewDimensionsModal]);
|
}, [dimensions, openPreviewDimensionsModal]);
|
||||||
|
|
||||||
const updateOptions = useCallback(
|
const updateOptions = ({ newOptions }: { newOptions: Record<string, unknown> }) =>
|
||||||
({ newOptions }: { newOptions: Record<string, unknown> }) =>
|
setState({ ...state, options: { ...state.options, newOptions } });
|
||||||
setState((current) => ({ ...current, options: { ...current.options, ...newOptions } })),
|
|
||||||
[],
|
|
||||||
);
|
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<>
|
<>
|
||||||
@@ -115,10 +105,10 @@ export const WidgetPreviewPageContent = ({ kind }: WidgetPreviewPageContentProps
|
|||||||
<ErrorBoundary
|
<ErrorBoundary
|
||||||
onReset={reset}
|
onReset={reset}
|
||||||
fallbackRender={({ resetErrorBoundary, error }) => (
|
fallbackRender={({ resetErrorBoundary, error }) => (
|
||||||
<WidgetError definition={currentDefinition} error={error} resetErrorBoundary={resetErrorBoundary} />
|
<WidgetError kind={kind} error={error} resetErrorBoundary={resetErrorBoundary} />
|
||||||
)}
|
)}
|
||||||
>
|
>
|
||||||
<Component
|
<Comp
|
||||||
options={state.options as never}
|
options={state.options as never}
|
||||||
integrationIds={state.integrationIds}
|
integrationIds={state.integrationIds}
|
||||||
width={dimensions.width}
|
width={dimensions.width}
|
||||||
@@ -137,10 +127,7 @@ export const WidgetPreviewPageContent = ({ kind }: WidgetPreviewPageContentProps
|
|||||||
size={48}
|
size={48}
|
||||||
variant="default"
|
variant="default"
|
||||||
radius="xl"
|
radius="xl"
|
||||||
onClick={() => void handleOpenEditWidgetModal()}
|
onClick={handleOpenEditWidgetModal}
|
||||||
onFocus={preloadWidgetEditModal}
|
|
||||||
onPointerEnter={preloadWidgetEditModal}
|
|
||||||
loading={isEditorLoading}
|
|
||||||
aria-label={t("common.action.edit")}
|
aria-label={t("common.action.edit")}
|
||||||
>
|
>
|
||||||
<IconPencil size={24} />
|
<IconPencil size={24} />
|
||||||
|
|||||||
@@ -1,18 +1,23 @@
|
|||||||
import type { PropsWithChildren } from "react";
|
import type { PropsWithChildren } from "react";
|
||||||
|
|
||||||
import { widgetKinds } from "@homarr/definitions";
|
import { widgetImports } from "@homarr/widgets";
|
||||||
import { widgetCatalogIcons } from "@homarr/widgets/catalog";
|
|
||||||
|
|
||||||
import { MainNavigation } from "~/components/layout/navigation";
|
import { MainNavigation } from "~/components/layout/navigation";
|
||||||
import { ClientShell } from "~/components/layout/shell";
|
import { ClientShell } from "~/components/layout/shell";
|
||||||
|
|
||||||
const links = widgetKinds.map((kind) => ({
|
const getLinks = () => {
|
||||||
href: `/widgets/${kind}`,
|
return Object.entries(widgetImports).map(([key, value]) => {
|
||||||
icon: widgetCatalogIcons[kind],
|
return {
|
||||||
label: kind,
|
href: `/widgets/${key}`,
|
||||||
}));
|
icon: value.definition.icon,
|
||||||
|
label: value.definition.kind,
|
||||||
|
};
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
export default function WidgetPreviewLayout({ children }: PropsWithChildren) {
|
export default function WidgetPreviewLayout({ children }: PropsWithChildren) {
|
||||||
|
const links = getLinks();
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<ClientShell hasHeader={false}>
|
<ClientShell hasHeader={false}>
|
||||||
<MainNavigation links={links} />
|
<MainNavigation links={links} />
|
||||||
|
|||||||
@@ -1,9 +1,10 @@
|
|||||||
import { Suspense } from "react";
|
|
||||||
import { notFound } from "next/navigation";
|
import { notFound } from "next/navigation";
|
||||||
import { Center, Loader } from "@mantine/core";
|
import { Center } from "@mantine/core";
|
||||||
|
|
||||||
|
import { env } from "@homarr/common/env";
|
||||||
|
import { db } from "@homarr/db";
|
||||||
import type { WidgetKind } from "@homarr/definitions";
|
import type { WidgetKind } from "@homarr/definitions";
|
||||||
import { widgetKinds } from "@homarr/widgets/manifest";
|
import { widgetImports } from "@homarr/widgets";
|
||||||
|
|
||||||
import { WidgetPreviewPageContent } from "./_content";
|
import { WidgetPreviewPageContent } from "./_content";
|
||||||
|
|
||||||
@@ -12,16 +13,24 @@ interface Props {
|
|||||||
}
|
}
|
||||||
|
|
||||||
export default async function WidgetPreview(props: Props) {
|
export default async function WidgetPreview(props: Props) {
|
||||||
const { kind } = await props.params;
|
if (!((await props.params).kind in widgetImports || env.NODE_ENV !== "development")) {
|
||||||
if (!widgetKinds.includes(kind as WidgetKind)) {
|
|
||||||
notFound();
|
notFound();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const integrationData = await db.query.integrations.findMany({
|
||||||
|
columns: {
|
||||||
|
id: true,
|
||||||
|
name: true,
|
||||||
|
url: true,
|
||||||
|
kind: true,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const sort = (await props.params).kind as WidgetKind;
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<Center h="100vh">
|
<Center h="100vh">
|
||||||
<Suspense fallback={<Loader size="sm" />}>
|
<WidgetPreviewPageContent kind={sort} integrationData={integrationData} />
|
||||||
<WidgetPreviewPageContent key={kind} kind={kind as WidgetKind} />
|
|
||||||
</Suspense>
|
|
||||||
</Center>
|
</Center>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
@@ -14,7 +14,6 @@ import { db } from "@homarr/db";
|
|||||||
|
|
||||||
import { getPackageVersion } from "~/versions/package-reader";
|
import { getPackageVersion } from "~/versions/package-reader";
|
||||||
import { extractMcpTools } from "../_extract-tools";
|
import { extractMcpTools } from "../_extract-tools";
|
||||||
import { serializeMcpToolResult } from "../_serialize-result";
|
|
||||||
|
|
||||||
const logger = createLogger({ module: "mcpRoute" });
|
const logger = createLogger({ module: "mcpRoute" });
|
||||||
|
|
||||||
@@ -204,7 +203,7 @@ const mcpHandler = createMcpHandler(
|
|||||||
const input = args && Object.keys(args).length > 0 ? args : undefined;
|
const input = args && Object.keys(args).length > 0 ? args : undefined;
|
||||||
const result = await procedure(input);
|
const result = await procedure(input);
|
||||||
return {
|
return {
|
||||||
content: [{ type: "text" as const, text: serializeMcpToolResult(result) }],
|
content: [{ type: "text" as const, text: JSON.stringify(result) }],
|
||||||
};
|
};
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
const message = sanitizeErrorMessage(error);
|
const message = sanitizeErrorMessage(error);
|
||||||
|
|||||||
@@ -1,23 +0,0 @@
|
|||||||
import { describe, expect, it } from "vitest";
|
|
||||||
|
|
||||||
import { serializeMcpToolResult } from "./_serialize-result";
|
|
||||||
|
|
||||||
describe("serializeMcpToolResult", () => {
|
|
||||||
it("serializes objects as JSON strings", () => {
|
|
||||||
expect(serializeMcpToolResult({ boardId: "1" })).toBe('{"boardId":"1"}');
|
|
||||||
});
|
|
||||||
|
|
||||||
it("serializes primitive values", () => {
|
|
||||||
expect(serializeMcpToolResult("hello")).toBe('"hello"');
|
|
||||||
expect(serializeMcpToolResult(42)).toBe("42");
|
|
||||||
expect(serializeMcpToolResult(true)).toBe("true");
|
|
||||||
});
|
|
||||||
|
|
||||||
it("serializes null as the string null", () => {
|
|
||||||
expect(serializeMcpToolResult(null)).toBe("null");
|
|
||||||
});
|
|
||||||
|
|
||||||
it("serializes void results as the string null so MCP content text is always a string", () => {
|
|
||||||
expect(serializeMcpToolResult(undefined)).toBe("null");
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
export function serializeMcpToolResult(result: unknown): string {
|
|
||||||
return JSON.stringify(result) ?? "null";
|
|
||||||
}
|
|
||||||
@@ -1,79 +0,0 @@
|
|||||||
"use client";
|
|
||||||
|
|
||||||
import { useState } from "react";
|
|
||||||
import { Alert, Button, Group, Stack } from "@mantine/core";
|
|
||||||
import { IconAlertTriangle, IconDownload } from "@tabler/icons-react";
|
|
||||||
|
|
||||||
import { useScopedI18n } from "@homarr/translation/client";
|
|
||||||
|
|
||||||
import { DangerousActionConfirmation } from "./dangerous-action-confirmation";
|
|
||||||
|
|
||||||
export const BackupExportButton = () => {
|
|
||||||
const t = useScopedI18n("management.page.tool.backup.export");
|
|
||||||
const [loading, setLoading] = useState(false);
|
|
||||||
const [error, setError] = useState<string | null>(null);
|
|
||||||
const [showConfirm, setShowConfirm] = useState(false);
|
|
||||||
|
|
||||||
const handleExport = async () => {
|
|
||||||
setLoading(true);
|
|
||||||
setError(null);
|
|
||||||
try {
|
|
||||||
const response = await fetch("/api/backup/export");
|
|
||||||
if (!response.ok) {
|
|
||||||
const errorMessage = await response.json().then(
|
|
||||||
(data) => data.error,
|
|
||||||
() => `Server returned ${response.status}`,
|
|
||||||
);
|
|
||||||
throw new Error(errorMessage ?? t("error"));
|
|
||||||
}
|
|
||||||
|
|
||||||
const blob = await response.blob();
|
|
||||||
const url = URL.createObjectURL(blob);
|
|
||||||
const filename =
|
|
||||||
response.headers.get("Content-Disposition")?.match(/filename="(.+)"/)?.[1] ?? "homarr-backup.zip";
|
|
||||||
|
|
||||||
const anchor = document.createElement("a");
|
|
||||||
anchor.href = url;
|
|
||||||
anchor.download = filename;
|
|
||||||
anchor.click();
|
|
||||||
URL.revokeObjectURL(url);
|
|
||||||
setShowConfirm(false);
|
|
||||||
} catch (cause) {
|
|
||||||
setError(cause instanceof Error ? cause.message : t("error"));
|
|
||||||
} finally {
|
|
||||||
setLoading(false);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
return (
|
|
||||||
<Stack gap="sm">
|
|
||||||
{error && (
|
|
||||||
<Alert color="red" icon={<IconAlertTriangle size={16} />}>
|
|
||||||
{error}
|
|
||||||
</Alert>
|
|
||||||
)}
|
|
||||||
|
|
||||||
{showConfirm ? (
|
|
||||||
<DangerousActionConfirmation
|
|
||||||
title={t("confirm.title")}
|
|
||||||
warningTitle={t("confirm.warningTitle")}
|
|
||||||
warningBody={t("confirm.warningBody")}
|
|
||||||
typePrompt={t("confirm.typePrompt", { phrase: "I understand" })}
|
|
||||||
submitLabel={t("confirm.submit")}
|
|
||||||
submitIcon={<IconDownload size={16} />}
|
|
||||||
cancelLabel={t("confirm.cancel")}
|
|
||||||
onConfirm={handleExport}
|
|
||||||
onCancel={() => setShowConfirm(false)}
|
|
||||||
disabled={loading}
|
|
||||||
color="orange"
|
|
||||||
/>
|
|
||||||
) : (
|
|
||||||
<Group>
|
|
||||||
<Button leftSection={<IconDownload size={16} />} loading={loading} onClick={() => setShowConfirm(true)}>
|
|
||||||
{t("button")}
|
|
||||||
</Button>
|
|
||||||
</Group>
|
|
||||||
)}
|
|
||||||
</Stack>
|
|
||||||
);
|
|
||||||
};
|
|
||||||
@@ -1,4 +1,3 @@
|
|||||||
export { BackupExportButton } from "./backup-export-button";
|
|
||||||
export { DatabaseRestoreFlow } from "./database-restore-flow";
|
export { DatabaseRestoreFlow } from "./database-restore-flow";
|
||||||
export { DangerousActionConfirmation } from "./dangerous-action-confirmation";
|
export { DangerousActionConfirmation } from "./dangerous-action-confirmation";
|
||||||
export type { BackupAnalysis, RestoreStep } from "./types";
|
export type { BackupAnalysis, RestoreStep } from "./types";
|
||||||
@@ -1,21 +1,17 @@
|
|||||||
import type { ComponentType, MutableRefObject } from "react";
|
import type { MutableRefObject } from "react";
|
||||||
import { Suspense, use, useRef } from "react";
|
import { useRef } from "react";
|
||||||
import type { CardProps } from "@mantine/core";
|
import { Badge, Card } from "@mantine/core";
|
||||||
import { Badge, Card, Center, Loader } from "@mantine/core";
|
|
||||||
import { useElementSize } from "@mantine/hooks";
|
import { useElementSize } from "@mantine/hooks";
|
||||||
import { QueryErrorResetBoundary, useQueryClient } from "@tanstack/react-query";
|
import { QueryErrorResetBoundary, useQueryClient } from "@tanstack/react-query";
|
||||||
import combineClasses from "clsx";
|
import combineClasses from "clsx";
|
||||||
import { NoIntegrationSelectedError } from "@homarr/widgets/errors/classes";
|
import { NoIntegrationSelectedError } from "@homarr/widgets/errors/classes";
|
||||||
import type { FallbackProps } from "react-error-boundary";
|
|
||||||
import { ErrorBoundary } from "react-error-boundary";
|
import { ErrorBoundary } from "react-error-boundary";
|
||||||
|
|
||||||
import { useRequiredBoard } from "@homarr/boards/context";
|
import { useRequiredBoard } from "@homarr/boards/context";
|
||||||
import { useEditMode } from "@homarr/boards/edit-mode";
|
import { useEditMode } from "@homarr/boards/edit-mode";
|
||||||
import { useSettings } from "@homarr/settings";
|
import { useSettings } from "@homarr/settings";
|
||||||
|
import { loadWidgetDynamic, reduceWidgetOptionsWithDefaultValues, widgetImports } from "@homarr/widgets";
|
||||||
import { WidgetError } from "@homarr/widgets/errors";
|
import { WidgetError } from "@homarr/widgets/errors";
|
||||||
import { getWidgetQueryKeys } from "@homarr/widgets/definition";
|
|
||||||
import type { WidgetComponentProps, WidgetDefinition } from "@homarr/widgets/definition";
|
|
||||||
import { loadWidgetResources, reduceWidgetOptionsWithDefinition } from "@homarr/widgets/manifest";
|
|
||||||
|
|
||||||
import type { SectionItem } from "~/app/[locale]/boards/_types";
|
import type { SectionItem } from "~/app/[locale]/boards/_types";
|
||||||
import classes from "../sections/item.module.css";
|
import classes from "../sections/item.module.css";
|
||||||
@@ -23,7 +19,7 @@ import { useItemActions } from "./item-actions";
|
|||||||
import itemContentClasses from "./item-content.module.css";
|
import itemContentClasses from "./item-content.module.css";
|
||||||
import { BoardItemMenu } from "./item-menu";
|
import { BoardItemMenu } from "./item-menu";
|
||||||
import { WidgetContextMenu } from "./widget-context-menu";
|
import { WidgetContextMenu } from "./widget-context-menu";
|
||||||
import { removeWidgetDataQueries } from "./widget-query-recovery";
|
import { removePersistedWidgetQueries } from "./widget-query-recovery";
|
||||||
|
|
||||||
interface BoardItemContentProps {
|
interface BoardItemContentProps {
|
||||||
item: SectionItem;
|
item: SectionItem;
|
||||||
@@ -35,53 +31,6 @@ const getOverflowFromKind = (kind: SectionItem["kind"]) => {
|
|||||||
return undefined;
|
return undefined;
|
||||||
};
|
};
|
||||||
|
|
||||||
type BoardItemCardProps = CardProps & {
|
|
||||||
item: SectionItem;
|
|
||||||
innerRef: (element: HTMLDivElement | null) => void;
|
|
||||||
};
|
|
||||||
|
|
||||||
const BoardItemCard = ({ item, innerRef, children, ...cardProps }: BoardItemCardProps) => {
|
|
||||||
const board = useRequiredBoard();
|
|
||||||
|
|
||||||
return (
|
|
||||||
<Card
|
|
||||||
{...cardProps}
|
|
||||||
ref={innerRef}
|
|
||||||
className={combineClasses(
|
|
||||||
classes.itemCard,
|
|
||||||
`${item.kind}-wrapper`,
|
|
||||||
"grid-stack-item-content",
|
|
||||||
item.advancedOptions.customCssClasses.join(" "),
|
|
||||||
)}
|
|
||||||
radius={board.itemRadius}
|
|
||||||
styles={{
|
|
||||||
root: {
|
|
||||||
"--opacity": board.opacity / 100,
|
|
||||||
containerType: "size",
|
|
||||||
overflow: getOverflowFromKind(item.kind),
|
|
||||||
"--border-color": item.advancedOptions.borderColor !== "" ? item.advancedOptions.borderColor : undefined,
|
|
||||||
},
|
|
||||||
}}
|
|
||||||
p={0}
|
|
||||||
>
|
|
||||||
{children}
|
|
||||||
</Card>
|
|
||||||
);
|
|
||||||
};
|
|
||||||
|
|
||||||
const WidgetDefinitionLoadError = ({
|
|
||||||
error,
|
|
||||||
resetErrorBoundary,
|
|
||||||
item,
|
|
||||||
innerRef,
|
|
||||||
}: FallbackProps & Pick<BoardItemCardProps, "item" | "innerRef">) => (
|
|
||||||
<BoardItemCard item={item} innerRef={innerRef}>
|
|
||||||
<Center h="100%">
|
|
||||||
<WidgetError error={error} resetErrorBoundary={resetErrorBoundary} />
|
|
||||||
</Center>
|
|
||||||
</BoardItemCard>
|
|
||||||
);
|
|
||||||
|
|
||||||
export const BoardItemContent = ({ item }: BoardItemContentProps) => {
|
export const BoardItemContent = ({ item }: BoardItemContentProps) => {
|
||||||
const { ref, width, height } = useElementSize<HTMLDivElement>();
|
const { ref, width, height } = useElementSize<HTMLDivElement>();
|
||||||
const board = useRequiredBoard();
|
const board = useRequiredBoard();
|
||||||
@@ -89,28 +38,29 @@ export const BoardItemContent = ({ item }: BoardItemContentProps) => {
|
|||||||
|
|
||||||
return (
|
return (
|
||||||
<>
|
<>
|
||||||
<ErrorBoundary
|
<WidgetContextMenu item={item} widgetStateRef={widgetStateRef}>
|
||||||
resetKeys={[item.kind]}
|
<Card
|
||||||
fallbackRender={(fallbackProps) => <WidgetDefinitionLoadError {...fallbackProps} item={item} innerRef={ref} />}
|
ref={ref}
|
||||||
>
|
className={combineClasses(
|
||||||
<Suspense
|
classes.itemCard,
|
||||||
fallback={
|
`${item.kind}-wrapper`,
|
||||||
<BoardItemCard item={item} innerRef={ref}>
|
"grid-stack-item-content",
|
||||||
<Center h="100%">
|
item.advancedOptions.customCssClasses.join(" "),
|
||||||
<Loader size="sm" />
|
)}
|
||||||
</Center>
|
radius={board.itemRadius}
|
||||||
</BoardItemCard>
|
styles={{
|
||||||
}
|
root: {
|
||||||
|
"--opacity": board.opacity / 100,
|
||||||
|
containerType: "size",
|
||||||
|
overflow: getOverflowFromKind(item.kind),
|
||||||
|
"--border-color": item.advancedOptions.borderColor !== "" ? item.advancedOptions.borderColor : undefined,
|
||||||
|
},
|
||||||
|
}}
|
||||||
|
p={0}
|
||||||
>
|
>
|
||||||
<LoadedBoardItemContent
|
<InnerContent item={item} width={width} height={height} widgetStateRef={widgetStateRef} />
|
||||||
item={item}
|
</Card>
|
||||||
width={width}
|
</WidgetContextMenu>
|
||||||
height={height}
|
|
||||||
widgetStateRef={widgetStateRef}
|
|
||||||
innerRef={ref}
|
|
||||||
/>
|
|
||||||
</Suspense>
|
|
||||||
</ErrorBoundary>
|
|
||||||
{item.advancedOptions.title?.trim() && (
|
{item.advancedOptions.title?.trim() && (
|
||||||
<Badge
|
<Badge
|
||||||
pos="absolute"
|
pos="absolute"
|
||||||
@@ -136,72 +86,40 @@ export const BoardItemContent = ({ item }: BoardItemContentProps) => {
|
|||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
|
||||||
interface LoadedBoardItemContentProps extends Omit<InnerContentProps, "definition" | "Component"> {
|
|
||||||
innerRef: (element: HTMLDivElement | null) => void;
|
|
||||||
}
|
|
||||||
|
|
||||||
const LoadedBoardItemContent = ({ item, innerRef, ...innerContentProps }: LoadedBoardItemContentProps) => {
|
|
||||||
const { definition, Component } = use(loadWidgetResources(item.kind));
|
|
||||||
|
|
||||||
return (
|
|
||||||
<WidgetContextMenu item={item} definition={definition} widgetStateRef={innerContentProps.widgetStateRef}>
|
|
||||||
<BoardItemCard item={item} innerRef={innerRef}>
|
|
||||||
<ErrorBoundary
|
|
||||||
resetKeys={[item.kind]}
|
|
||||||
fallbackRender={({ resetErrorBoundary, error }) => (
|
|
||||||
<>
|
|
||||||
<BoardItemMenu offset={4} item={item} definition={definition} resetErrorBoundary={resetErrorBoundary} />
|
|
||||||
<WidgetError definition={definition} error={error} resetErrorBoundary={resetErrorBoundary} />
|
|
||||||
</>
|
|
||||||
)}
|
|
||||||
>
|
|
||||||
<InnerContent item={item} definition={definition} Component={Component} {...innerContentProps} />
|
|
||||||
</ErrorBoundary>
|
|
||||||
</BoardItemCard>
|
|
||||||
</WidgetContextMenu>
|
|
||||||
);
|
|
||||||
};
|
|
||||||
|
|
||||||
interface InnerContentProps {
|
interface InnerContentProps {
|
||||||
item: SectionItem;
|
item: SectionItem;
|
||||||
width: number;
|
width: number;
|
||||||
height: number;
|
height: number;
|
||||||
widgetStateRef: MutableRefObject<Record<string, unknown> | null>;
|
widgetStateRef: MutableRefObject<Record<string, unknown> | null>;
|
||||||
definition: WidgetDefinition;
|
|
||||||
Component: ComponentType<WidgetComponentProps<SectionItem["kind"]>>;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
const InnerContent = ({ item, definition, Component, ...dimensions }: InnerContentProps) => {
|
const InnerContent = ({ item, ...dimensions }: InnerContentProps) => {
|
||||||
const settings = useSettings();
|
const settings = useSettings();
|
||||||
const board = useRequiredBoard();
|
const board = useRequiredBoard();
|
||||||
const [isEditMode] = useEditMode();
|
const [isEditMode] = useEditMode();
|
||||||
const options = reduceWidgetOptionsWithDefinition(definition, settings, item.options);
|
const Comp = loadWidgetDynamic(item.kind);
|
||||||
|
const { definition } = widgetImports[item.kind];
|
||||||
|
const options = reduceWidgetOptionsWithDefaultValues(item.kind, settings, item.options);
|
||||||
const newItem = { ...item, options };
|
const newItem = { ...item, options };
|
||||||
const { updateItemOptions } = useItemActions();
|
const { updateItemOptions } = useItemActions();
|
||||||
const updateOptions = ({ newOptions }: { newOptions: Record<string, unknown> }) =>
|
const updateOptions = ({ newOptions }: { newOptions: Record<string, unknown> }) =>
|
||||||
updateItemOptions({ itemId: item.id, newOptions });
|
updateItemOptions({ itemId: item.id, newOptions });
|
||||||
const widgetSupportsIntegrations =
|
const widgetSupportsIntegrations =
|
||||||
"supportedIntegrations" in definition && (definition.supportedIntegrations?.length ?? 0) >= 1;
|
"supportedIntegrations" in definition && definition.supportedIntegrations.length >= 1;
|
||||||
const queryClient = useQueryClient();
|
const queryClient = useQueryClient();
|
||||||
const widgetQueryKeys = getWidgetQueryKeys(definition, item.kind);
|
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<QueryErrorResetBoundary>
|
<QueryErrorResetBoundary>
|
||||||
{({ reset }) => (
|
{({ reset }) => (
|
||||||
<ErrorBoundary
|
<ErrorBoundary
|
||||||
onReset={() => {
|
onReset={() => {
|
||||||
removeWidgetDataQueries(queryClient, widgetQueryKeys);
|
removePersistedWidgetQueries(queryClient);
|
||||||
reset();
|
reset();
|
||||||
}}
|
}}
|
||||||
fallbackRender={({ resetErrorBoundary, error }) => (
|
fallbackRender={({ resetErrorBoundary, error }) => (
|
||||||
<>
|
<>
|
||||||
<BoardItemMenu
|
<BoardItemMenu offset={4} item={newItem} resetErrorBoundary={resetErrorBoundary} />
|
||||||
offset={4}
|
<WidgetError kind={item.kind} error={error} resetErrorBoundary={resetErrorBoundary} />
|
||||||
item={newItem}
|
|
||||||
definition={definition}
|
|
||||||
resetErrorBoundary={resetErrorBoundary}
|
|
||||||
/>
|
|
||||||
<WidgetError definition={definition} error={error} resetErrorBoundary={resetErrorBoundary} />
|
|
||||||
</>
|
</>
|
||||||
)}
|
)}
|
||||||
>
|
>
|
||||||
@@ -213,25 +131,23 @@ const InnerContent = ({ item, definition, Component, ...dimensions }: InnerConte
|
|||||||
(!("integrationsRequired" in definition) || definition.integrationsRequired !== false)
|
(!("integrationsRequired" in definition) || definition.integrationsRequired !== false)
|
||||||
}
|
}
|
||||||
/>
|
/>
|
||||||
<BoardItemMenu offset={4} item={newItem} definition={definition} />
|
<BoardItemMenu offset={4} item={newItem} />
|
||||||
<div data-homarr-widget-ready={item.kind} style={{ display: "contents" }}>
|
<Comp
|
||||||
<Component
|
options={options as never}
|
||||||
options={options as never}
|
integrationIds={item.integrationIds}
|
||||||
integrationIds={item.integrationIds}
|
isEditMode={isEditMode}
|
||||||
isEditMode={isEditMode}
|
boardId={board.id}
|
||||||
boardId={board.id}
|
itemId={item.id}
|
||||||
itemId={item.id}
|
setOptions={(partialNewOptions) =>
|
||||||
setOptions={(partialNewOptions) =>
|
updateOptions({
|
||||||
updateOptions({
|
newOptions: {
|
||||||
newOptions: {
|
...options,
|
||||||
...options,
|
...partialNewOptions.newOptions,
|
||||||
...partialNewOptions.newOptions,
|
},
|
||||||
},
|
})
|
||||||
})
|
}
|
||||||
}
|
{...dimensions}
|
||||||
{...dimensions}
|
/>
|
||||||
/>
|
|
||||||
</div>
|
|
||||||
</ErrorBoundary>
|
</ErrorBoundary>
|
||||||
)}
|
)}
|
||||||
</QueryErrorResetBoundary>
|
</QueryErrorResetBoundary>
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
import { useEffect, useRef, useState } from "react";
|
import { useEffect, useMemo, useRef } from "react";
|
||||||
import { ActionIcon, Menu } from "@mantine/core";
|
import { ActionIcon, Menu } from "@mantine/core";
|
||||||
import { IconCopy, IconDotsVertical, IconLayoutKanban, IconPencil, IconTrash } from "@tabler/icons-react";
|
import { IconCopy, IconDotsVertical, IconLayoutKanban, IconPencil, IconTrash } from "@tabler/icons-react";
|
||||||
|
|
||||||
@@ -8,44 +8,39 @@ import { useEditMode } from "@homarr/boards/edit-mode";
|
|||||||
import { useConfirmModal, useModalAction } from "@homarr/modals";
|
import { useConfirmModal, useModalAction } from "@homarr/modals";
|
||||||
import { useSettings } from "@homarr/settings";
|
import { useSettings } from "@homarr/settings";
|
||||||
import { useI18n, useScopedI18n } from "@homarr/translation/client";
|
import { useI18n, useScopedI18n } from "@homarr/translation/client";
|
||||||
import type { WidgetDefinition } from "@homarr/widgets/definition";
|
import { widgetImports } from "@homarr/widgets";
|
||||||
|
import { WidgetEditModal } from "@homarr/widgets/modals";
|
||||||
|
|
||||||
import type { SectionItem } from "~/app/[locale]/boards/_types";
|
import type { SectionItem } from "~/app/[locale]/boards/_types";
|
||||||
import { useSectionContext } from "../sections/section-context";
|
import { useSectionContext } from "../sections/section-context";
|
||||||
import { useItemActions } from "./item-actions";
|
import { useItemActions } from "./item-actions";
|
||||||
import { LazyItemMoveModal, preloadItemMoveModal } from "./lazy-item-move-modal";
|
import { ItemMoveModal } from "./item-move-modal";
|
||||||
import { LazyWidgetEditModal, preloadWidgetEditModal } from "./lazy-widget-edit-modal";
|
|
||||||
|
|
||||||
interface BoardItemMenuProps {
|
interface BoardItemMenuProps {
|
||||||
offset: number;
|
offset: number;
|
||||||
item: SectionItem;
|
item: SectionItem;
|
||||||
definition: WidgetDefinition;
|
|
||||||
resetErrorBoundary?: () => void;
|
resetErrorBoundary?: () => void;
|
||||||
}
|
}
|
||||||
|
|
||||||
export const BoardItemMenu = (props: BoardItemMenuProps) => {
|
export const BoardItemMenu = (props: BoardItemMenuProps) => {
|
||||||
const { data: session } = useSession();
|
const { data: session } = useSession();
|
||||||
const [isEditMode] = useEditMode();
|
if (!session) return null;
|
||||||
if (!session || !isEditMode) return null;
|
|
||||||
|
|
||||||
return <BoardItemMenuInner {...props} />;
|
return <BoardItemMenuInner {...props} />;
|
||||||
};
|
};
|
||||||
|
|
||||||
const BoardItemMenuInner = ({ offset, item, definition, resetErrorBoundary }: BoardItemMenuProps) => {
|
const BoardItemMenuInner = ({ offset, item, resetErrorBoundary }: BoardItemMenuProps) => {
|
||||||
const refResetErrorBoundaryOnNextRender = useRef(false);
|
const refResetErrorBoundaryOnNextRender = useRef(false);
|
||||||
const tItem = useScopedI18n("item");
|
const tItem = useScopedI18n("item");
|
||||||
const t = useI18n();
|
const t = useI18n();
|
||||||
const { openModal } = useModalAction(LazyWidgetEditModal);
|
const { openModal } = useModalAction(WidgetEditModal);
|
||||||
const { openModal: openMoveModal } = useModalAction(LazyItemMoveModal);
|
const { openModal: openMoveModal } = useModalAction(ItemMoveModal);
|
||||||
const { openConfirmModal } = useConfirmModal();
|
const { openConfirmModal } = useConfirmModal();
|
||||||
const [isMenuOpen, setIsMenuOpen] = useState(false);
|
const [isEditMode] = useEditMode();
|
||||||
const hasSupportedIntegrations =
|
|
||||||
"supportedIntegrations" in definition && (definition.supportedIntegrations?.length ?? 0) > 0;
|
|
||||||
const { updateItemOptions, updateItemAdvancedOptions, updateItemIntegrations, duplicateItem, removeItem } =
|
const { updateItemOptions, updateItemAdvancedOptions, updateItemIntegrations, duplicateItem, removeItem } =
|
||||||
useItemActions();
|
useItemActions();
|
||||||
const { data: integrationData, isPending } = clientApi.integration.all.useQuery(undefined, {
|
const { data: integrationData, isPending } = clientApi.integration.all.useQuery();
|
||||||
enabled: isMenuOpen && hasSupportedIntegrations,
|
const currentDefinition = useMemo(() => widgetImports[item.kind].definition, [item.kind]);
|
||||||
});
|
|
||||||
const { gridstack } = useSectionContext().refs;
|
const { gridstack } = useSectionContext().refs;
|
||||||
const settings = useSettings();
|
const settings = useSettings();
|
||||||
|
|
||||||
@@ -57,11 +52,12 @@ const BoardItemMenuInner = ({ offset, item, definition, resetErrorBoundary }: Bo
|
|||||||
}
|
}
|
||||||
}, [item, resetErrorBoundary]);
|
}, [item, resetErrorBoundary]);
|
||||||
|
|
||||||
|
if (!isEditMode || isPending) return null;
|
||||||
|
|
||||||
const openEditModal = () => {
|
const openEditModal = () => {
|
||||||
openModal(
|
openModal(
|
||||||
{
|
{
|
||||||
kind: item.kind,
|
kind: item.kind,
|
||||||
definition,
|
|
||||||
value: {
|
value: {
|
||||||
advancedOptions: item.advancedOptions,
|
advancedOptions: item.advancedOptions,
|
||||||
options: item.options,
|
options: item.options,
|
||||||
@@ -84,10 +80,10 @@ const BoardItemMenuInner = ({ offset, item, definition, resetErrorBoundary }: Bo
|
|||||||
},
|
},
|
||||||
integrationData: (integrationData ?? []).filter(
|
integrationData: (integrationData ?? []).filter(
|
||||||
(integration) =>
|
(integration) =>
|
||||||
"supportedIntegrations" in definition &&
|
"supportedIntegrations" in currentDefinition &&
|
||||||
(definition.supportedIntegrations as string[]).some((kind) => kind === integration.kind),
|
(currentDefinition.supportedIntegrations as string[]).some((kind) => kind === integration.kind),
|
||||||
),
|
),
|
||||||
integrationSupport: "supportedIntegrations" in definition,
|
integrationSupport: "supportedIntegrations" in currentDefinition,
|
||||||
settings,
|
settings,
|
||||||
itemId: item.id,
|
itemId: item.id,
|
||||||
appId: item.kind === "app" ? (item.options.appId as string | undefined) : undefined,
|
appId: item.kind === "app" ? (item.options.appId as string | undefined) : undefined,
|
||||||
@@ -111,7 +107,7 @@ const BoardItemMenuInner = ({ offset, item, definition, resetErrorBoundary }: Bo
|
|||||||
};
|
};
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<Menu withinPortal position="right-start" arrowPosition="center" opened={isMenuOpen} onChange={setIsMenuOpen}>
|
<Menu withinPortal position="right-start" arrowPosition="center">
|
||||||
<Menu.Target>
|
<Menu.Target>
|
||||||
<ActionIcon
|
<ActionIcon
|
||||||
variant="default"
|
variant="default"
|
||||||
@@ -127,19 +123,11 @@ const BoardItemMenuInner = ({ offset, item, definition, resetErrorBoundary }: Bo
|
|||||||
</Menu.Target>
|
</Menu.Target>
|
||||||
<Menu.Dropdown miw={128}>
|
<Menu.Dropdown miw={128}>
|
||||||
<Menu.Label>{tItem("menu.label.settings")}</Menu.Label>
|
<Menu.Label>{tItem("menu.label.settings")}</Menu.Label>
|
||||||
<Menu.Item
|
<Menu.Item leftSection={<IconPencil size={16} />} onClick={openEditModal}>
|
||||||
leftSection={<IconPencil size={16} />}
|
|
||||||
onClick={openEditModal}
|
|
||||||
onFocus={preloadWidgetEditModal}
|
|
||||||
onPointerEnter={preloadWidgetEditModal}
|
|
||||||
disabled={hasSupportedIntegrations && isPending}
|
|
||||||
>
|
|
||||||
{tItem("action.edit")}
|
{tItem("action.edit")}
|
||||||
</Menu.Item>
|
</Menu.Item>
|
||||||
<Menu.Item
|
<Menu.Item
|
||||||
leftSection={<IconLayoutKanban size={16} />}
|
leftSection={<IconLayoutKanban size={16} />}
|
||||||
onFocus={preloadItemMoveModal}
|
|
||||||
onPointerEnter={preloadItemMoveModal}
|
|
||||||
onClick={() => {
|
onClick={() => {
|
||||||
if (!gridstack.current) return;
|
if (!gridstack.current) return;
|
||||||
openMoveModal({ item, columnCount: gridstack.current.getColumn(), gridStack: gridstack.current });
|
openMoveModal({ item, columnCount: gridstack.current.getColumn(), gridStack: gridstack.current });
|
||||||
|
|||||||
@@ -9,13 +9,13 @@ import { useI18n } from "@homarr/translation/client";
|
|||||||
|
|
||||||
import type { Item, SectionItem } from "~/app/[locale]/boards/_types";
|
import type { Item, SectionItem } from "~/app/[locale]/boards/_types";
|
||||||
|
|
||||||
export interface ItemMoveModalProps {
|
interface InnerProps {
|
||||||
gridStack: GridStack;
|
gridStack: GridStack;
|
||||||
item: Pick<SectionItem, "id" | "width" | "height" | "xOffset" | "yOffset">;
|
item: Pick<SectionItem, "id" | "width" | "height" | "xOffset" | "yOffset">;
|
||||||
columnCount: number;
|
columnCount: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
export const ItemMoveModal = createModal<ItemMoveModalProps>(({ actions, innerProps }) => {
|
export const ItemMoveModal = createModal<InnerProps>(({ actions, innerProps }) => {
|
||||||
const t = useI18n();
|
const t = useI18n();
|
||||||
const maxWidthRef = useRef(innerProps.columnCount - innerProps.item.xOffset);
|
const maxWidthRef = useRef(innerProps.columnCount - innerProps.item.xOffset);
|
||||||
const form = useZodForm(
|
const form = useZodForm(
|
||||||
|
|||||||
@@ -1,48 +0,0 @@
|
|||||||
import { describe, expect, it, vi } from "vitest";
|
|
||||||
|
|
||||||
import { resolveMatchingIntegrationsAsync, tryLockSelection, unlockSelection } from "./item-select-data";
|
|
||||||
|
|
||||||
describe("widget selection lock", () => {
|
|
||||||
it("rejects repeated selection synchronously until the active selection finishes", () => {
|
|
||||||
const lock = { current: false };
|
|
||||||
|
|
||||||
expect(tryLockSelection(lock)).toBe(true);
|
|
||||||
expect(tryLockSelection(lock)).toBe(false);
|
|
||||||
|
|
||||||
unlockSelection(lock);
|
|
||||||
expect(tryLockSelection(lock)).toBe(true);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe("resolveMatchingIntegrationsAsync", () => {
|
|
||||||
it("waits for the shared integration query before a cold integration-backed selection", async () => {
|
|
||||||
const ensureDataAsync = vi.fn(async () => [
|
|
||||||
{ id: "matching", kind: "sonarr" as const },
|
|
||||||
{ id: "other", kind: "radarr" as const },
|
|
||||||
]);
|
|
||||||
|
|
||||||
await expect(
|
|
||||||
resolveMatchingIntegrationsAsync({
|
|
||||||
hasIntegrationSupport: true,
|
|
||||||
supportedIntegrations: ["sonarr"],
|
|
||||||
currentData: undefined,
|
|
||||||
ensureDataAsync,
|
|
||||||
}),
|
|
||||||
).resolves.toEqual([{ id: "matching", kind: "sonarr" }]);
|
|
||||||
expect(ensureDataAsync).toHaveBeenCalledOnce();
|
|
||||||
});
|
|
||||||
|
|
||||||
it("does not wait for integrations when the widget has no integration support", async () => {
|
|
||||||
const ensureDataAsync = vi.fn(async () => [{ id: "unused", kind: "sonarr" as const }]);
|
|
||||||
|
|
||||||
await expect(
|
|
||||||
resolveMatchingIntegrationsAsync({
|
|
||||||
hasIntegrationSupport: false,
|
|
||||||
supportedIntegrations: [],
|
|
||||||
currentData: undefined,
|
|
||||||
ensureDataAsync,
|
|
||||||
}),
|
|
||||||
).resolves.toEqual([]);
|
|
||||||
expect(ensureDataAsync).not.toHaveBeenCalled();
|
|
||||||
});
|
|
||||||
});
|
|
||||||
Loaded 100 of 357 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user