feat: add config portability — full export/import, homepage import, docker label discovery
Add a dedicated Import/Export tool page with full configuration export/import (v2.0 bundle with encrypted secrets), Homepage services.yaml import with env variable resolution, and manual Docker label discovery (moved from cron job). Support importing Homarr JSON during onboarding alongside legacy zip import. New @homarr/board-portability package handles schema, serialization, compat checks, and import planning. Shared preview UI reused across admin and onboarding. Fix xterm.js crash by removing deprecated @xterm/addon-canvas (incompatible with xterm v6). Fix Homepage env variable i18n and React 19 currentTarget bug. See docs/config-portability.md for full changelog.
This commit is contained in:
100 files changed
+13394
-56
No files matched your search
@@ -6,11 +6,14 @@ import { clientApi } from "@homarr/api/client";
|
||||
import { revalidatePathActionAsync } from "@homarr/common/client";
|
||||
import { useI18n } from "@homarr/translation/client";
|
||||
|
||||
import { clearInitImportMode } from "./import/use-init-import-mode";
|
||||
|
||||
export const BackToStart = () => {
|
||||
const t = useI18n();
|
||||
const { mutateAsync, isPending } = clientApi.onboard.previousStep.useMutation();
|
||||
|
||||
const handleBackToStartAsync = async () => {
|
||||
clearInitImportMode();
|
||||
await mutateAsync();
|
||||
await revalidatePathActionAsync("/init");
|
||||
};
|
||||
|
||||
@@ -0,0 +1,68 @@
|
||||
"use client";
|
||||
|
||||
import { Group, rem, Text } from "@mantine/core";
|
||||
import type { FileWithPath } from "@mantine/dropzone";
|
||||
import { Dropzone, MIME_TYPES } from "@mantine/dropzone";
|
||||
import { IconJson, IconUpload, IconX } from "@tabler/icons-react";
|
||||
|
||||
import "@mantine/dropzone/styles.css";
|
||||
|
||||
import { useScopedI18n } from "@homarr/translation/client";
|
||||
|
||||
interface ConfigImportDropZoneProps {
|
||||
loading: boolean;
|
||||
updateFile: (file: FileWithPath) => void;
|
||||
}
|
||||
|
||||
export const ConfigImportDropZone = ({ loading, updateFile }: ConfigImportDropZoneProps) => {
|
||||
const tDropzone = useScopedI18n("init.step.import.configDropzone");
|
||||
return (
|
||||
<Dropzone
|
||||
onDrop={(files) => {
|
||||
const firstFile = files[0];
|
||||
if (!firstFile) return;
|
||||
|
||||
updateFile(firstFile);
|
||||
}}
|
||||
acceptColor="blue.6"
|
||||
rejectColor="red.6"
|
||||
accept={[MIME_TYPES.json]}
|
||||
loading={loading}
|
||||
multiple={false}
|
||||
maxSize={1024 * 1024 * 64}
|
||||
onReject={(rejections) => {
|
||||
console.error(
|
||||
"Rejected files",
|
||||
rejections.map(
|
||||
(rejection) =>
|
||||
`File: ${rejection.file.name} size=${rejection.file.size} fileType=${rejection.file.type}\n - ${rejection.errors.map((error) => error.message).join("\n - ")}`,
|
||||
),
|
||||
);
|
||||
}}
|
||||
>
|
||||
<Group justify="center" gap="xl" mih={220} style={{ pointerEvents: "none" }}>
|
||||
<Dropzone.Accept>
|
||||
<IconUpload style={{ width: rem(52), height: rem(52), color: "var(--mantine-color-blue-6)" }} stroke={1.5} />
|
||||
</Dropzone.Accept>
|
||||
<Dropzone.Reject>
|
||||
<IconX style={{ width: rem(52), height: rem(52), color: "var(--mantine-color-red-6)" }} stroke={1.5} />
|
||||
</Dropzone.Reject>
|
||||
<Dropzone.Idle>
|
||||
<IconJson
|
||||
style={{ width: rem(52), height: rem(52), color: "var(--mantine-color-dimmed)" }}
|
||||
stroke={1.5}
|
||||
/>
|
||||
</Dropzone.Idle>
|
||||
|
||||
<div>
|
||||
<Text size="xl" inline>
|
||||
{tDropzone("title")}
|
||||
</Text>
|
||||
<Text size="sm" c="dimmed" inline mt={7}>
|
||||
{tDropzone("description")}
|
||||
</Text>
|
||||
</div>
|
||||
</Group>
|
||||
</Dropzone>
|
||||
);
|
||||
};
|
||||
@@ -0,0 +1,98 @@
|
||||
"use client";
|
||||
|
||||
import { useEffect, useState } from "react";
|
||||
import { Button, Card, Stack } from "@mantine/core";
|
||||
import type { FileWithPath } from "@mantine/dropzone";
|
||||
|
||||
import { clientApi } from "@homarr/api/client";
|
||||
import { revalidatePathActionAsync } from "@homarr/common/client";
|
||||
import { showErrorNotification } from "@homarr/notifications";
|
||||
import { useI18n } from "@homarr/translation/client";
|
||||
|
||||
import { ConfigImportPreviewPanel } from "~/components/config-import/config-import-preview-panel";
|
||||
|
||||
import { ConfigImportDropZone } from "./config-import-dropzone";
|
||||
import { FileInfoCard } from "./file-info-card";
|
||||
|
||||
export const InitConfigImport = () => {
|
||||
const t = useI18n() as unknown as (key: string, values?: Record<string, unknown>) => string;
|
||||
const [file, setFile] = useState<FileWithPath | null>(null);
|
||||
const [fileContent, setFileContent] = useState("");
|
||||
|
||||
const {
|
||||
mutate: runPreview,
|
||||
data: preview,
|
||||
isPending: previewLoading,
|
||||
reset: resetPreview,
|
||||
} = clientApi.import.previewInitialConfigImport.useMutation();
|
||||
|
||||
const { mutateAsync, isPending } = clientApi.import.importInitialConfigImport.useMutation({
|
||||
async onSuccess() {
|
||||
await revalidatePathActionAsync("/init");
|
||||
},
|
||||
});
|
||||
|
||||
useEffect(() => {
|
||||
if (!fileContent) {
|
||||
resetPreview();
|
||||
return;
|
||||
}
|
||||
runPreview({ content: fileContent });
|
||||
}, [fileContent, runPreview, resetPreview]);
|
||||
|
||||
const importAllowed = preview?.compatibility.status === "compatible";
|
||||
|
||||
const handleImport = async () => {
|
||||
if (!file || !importAllowed) {
|
||||
return;
|
||||
}
|
||||
|
||||
await mutateAsync(
|
||||
{ content: fileContent },
|
||||
{
|
||||
onError() {
|
||||
showErrorNotification({
|
||||
title: t("management.page.importExport.importConfig.notification.error.title"),
|
||||
message: t("management.page.importExport.importConfig.notification.error.message"),
|
||||
});
|
||||
},
|
||||
},
|
||||
);
|
||||
};
|
||||
|
||||
if (!file) {
|
||||
return (
|
||||
<Card w={64 * 12 + 8} maw="90vw">
|
||||
<ConfigImportDropZone
|
||||
loading={previewLoading}
|
||||
updateFile={(selectedFile) => {
|
||||
void selectedFile.text().then((content) => {
|
||||
setFileContent(content);
|
||||
setFile(selectedFile);
|
||||
});
|
||||
}}
|
||||
/>
|
||||
</Card>
|
||||
);
|
||||
}
|
||||
|
||||
return (
|
||||
<Stack mb="sm" w={64 * 12 + 8} maw="90vw">
|
||||
<FileInfoCard
|
||||
file={file}
|
||||
onRemove={() => {
|
||||
setFile(null);
|
||||
setFileContent("");
|
||||
}}
|
||||
/>
|
||||
<ConfigImportPreviewPanel preview={preview} previewLoading={previewLoading} t={t} />
|
||||
<Button
|
||||
loading={isPending}
|
||||
disabled={!importAllowed || previewLoading}
|
||||
onClick={() => void handleImport()}
|
||||
>
|
||||
{t("init.step.import.configImport.action")}
|
||||
</Button>
|
||||
</Stack>
|
||||
);
|
||||
};
|
||||
@@ -10,8 +10,16 @@ import { InitialOldmarrImport } from "@homarr/old-import/components";
|
||||
|
||||
import { FileInfoCard } from "./file-info-card";
|
||||
import { ImportDropZone } from "./import-dropzone";
|
||||
import { InitConfigImport } from "./init-config-import";
|
||||
import { useInitImportMode } from "./use-init-import-mode";
|
||||
|
||||
export const InitImport = () => {
|
||||
const importMode = useInitImportMode();
|
||||
|
||||
if (importMode === "config") {
|
||||
return <InitConfigImport />;
|
||||
}
|
||||
|
||||
const [file, setFile] = useState<FileWithPath | null>(null);
|
||||
const { isPending, mutate } = clientApi.import.analyseInitialOldmarrImport.useMutation();
|
||||
const [analyseResult, setAnalyseResult] = useState<RouterOutputs["import"]["analyseInitialOldmarrImport"] | null>(
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
"use client";
|
||||
|
||||
import { useSyncExternalStore } from "react";
|
||||
|
||||
export type InitImportMode = "legacy" | "config";
|
||||
|
||||
const storageKey = "homarr-init-import-mode";
|
||||
|
||||
const readMode = (): InitImportMode => {
|
||||
const stored = sessionStorage.getItem(storageKey);
|
||||
return stored === "config" ? "config" : "legacy";
|
||||
};
|
||||
|
||||
const subscribe = (onStoreChange: () => void) => {
|
||||
window.addEventListener("storage", onStoreChange);
|
||||
return () => window.removeEventListener("storage", onStoreChange);
|
||||
};
|
||||
|
||||
export const setInitImportMode = (mode: InitImportMode) => {
|
||||
sessionStorage.setItem(storageKey, mode);
|
||||
window.dispatchEvent(new Event("storage"));
|
||||
};
|
||||
|
||||
export const clearInitImportMode = () => {
|
||||
sessionStorage.removeItem(storageKey);
|
||||
window.dispatchEvent(new Event("storage"));
|
||||
};
|
||||
|
||||
export const useInitImportMode = () =>
|
||||
useSyncExternalStore(subscribe, readMode, () => "legacy" as InitImportMode);
|
||||
@@ -1,5 +1,5 @@
|
||||
import { Card, Stack, Text } from "@mantine/core";
|
||||
import { IconFileImport, IconPlayerPlay } from "@tabler/icons-react";
|
||||
import { IconFileImport, IconJson, IconPlayerPlay } from "@tabler/icons-react";
|
||||
|
||||
import { getMantineColor } from "@homarr/common";
|
||||
import { getScopedI18n } from "@homarr/translation/server";
|
||||
@@ -22,10 +22,18 @@ export const InitStart = async () => {
|
||||
</InitStartButton>
|
||||
<InitStartButton
|
||||
preferredStep="import"
|
||||
importMode="legacy"
|
||||
icon={<IconFileImport color={getMantineColor("cyan", 6)} size={16} stroke={1.5} />}
|
||||
>
|
||||
{tStart("action.importOldmarr")}
|
||||
</InitStartButton>
|
||||
<InitStartButton
|
||||
preferredStep="import"
|
||||
importMode="config"
|
||||
icon={<IconJson color={getMantineColor("blue", 6)} size={16} stroke={1.5} />}
|
||||
>
|
||||
{tStart("action.importConfig")}
|
||||
</InitStartButton>
|
||||
</Stack>
|
||||
</Card>
|
||||
);
|
||||
|
||||
@@ -7,15 +7,28 @@ import { clientApi } from "@homarr/api/client";
|
||||
import { revalidatePathActionAsync } from "@homarr/common/client";
|
||||
import type { OnboardingStep } from "@homarr/definitions";
|
||||
|
||||
import { clearInitImportMode, setInitImportMode, type InitImportMode } from "../import/use-init-import-mode";
|
||||
|
||||
interface InitStartButtonProps {
|
||||
icon: ReactNode;
|
||||
preferredStep: OnboardingStep | undefined;
|
||||
importMode?: InitImportMode;
|
||||
}
|
||||
|
||||
export const InitStartButton = ({ preferredStep, icon, children }: PropsWithChildren<InitStartButtonProps>) => {
|
||||
export const InitStartButton = ({
|
||||
preferredStep,
|
||||
icon,
|
||||
children,
|
||||
importMode,
|
||||
}: PropsWithChildren<InitStartButtonProps>) => {
|
||||
const { mutateAsync } = clientApi.onboard.nextStep.useMutation();
|
||||
|
||||
const handleClickAsync = async () => {
|
||||
if (importMode) {
|
||||
setInitImportMode(importMode);
|
||||
} else {
|
||||
clearInitImportMode();
|
||||
}
|
||||
await mutateAsync({ preferredStep });
|
||||
await revalidatePathActionAsync("/init");
|
||||
};
|
||||
|
||||
+19
-3
@@ -2,14 +2,14 @@
|
||||
|
||||
import { useCallback } from "react";
|
||||
import { Menu } from "@mantine/core";
|
||||
import { IconCopy, IconDeviceMobile, IconHome, IconSettings, IconTrash } from "@tabler/icons-react";
|
||||
import { IconCopy, IconDeviceMobile, IconDownload, IconHome, IconSettings, IconTrash } from "@tabler/icons-react";
|
||||
|
||||
import type { RouterOutputs } from "@homarr/api";
|
||||
import { clientApi } from "@homarr/api/client";
|
||||
import { useSession } from "@homarr/auth/client";
|
||||
import { revalidatePathActionAsync } from "@homarr/common/client";
|
||||
import { useConfirmModal, useModalAction } from "@homarr/modals";
|
||||
import { DuplicateBoardModal } from "@homarr/modals-collection";
|
||||
import { DuplicateBoardModal, ExportBoardModal } from "@homarr/modals-collection";
|
||||
import { useScopedI18n } from "@homarr/translation/client";
|
||||
import { Link } from "@homarr/ui";
|
||||
|
||||
@@ -28,7 +28,10 @@ interface BoardCardMenuDropdownProps {
|
||||
}
|
||||
|
||||
export const BoardCardMenuDropdown = ({ board }: BoardCardMenuDropdownProps) => {
|
||||
const t = useScopedI18n("management.page.board.action");
|
||||
const t = useScopedI18n("management.page.board.action" as never) as unknown as (
|
||||
key: string,
|
||||
values?: Record<string, unknown>,
|
||||
) => string;
|
||||
const tCommon = useScopedI18n("common");
|
||||
|
||||
const { hasFullAccess, hasChangeAccess } = useBoardPermissions(board);
|
||||
@@ -36,6 +39,7 @@ export const BoardCardMenuDropdown = ({ board }: BoardCardMenuDropdownProps) =>
|
||||
|
||||
const { openConfirmModal } = useConfirmModal();
|
||||
const { openModal: openDuplicateModal } = useModalAction(DuplicateBoardModal);
|
||||
const { openModal: openExportModal } = useModalAction(ExportBoardModal);
|
||||
|
||||
const setHomeBoardMutation = clientApi.board.setHomeBoard.useMutation({
|
||||
onSettled: async () => {
|
||||
@@ -87,6 +91,15 @@ export const BoardCardMenuDropdown = ({ board }: BoardCardMenuDropdownProps) =>
|
||||
});
|
||||
}, [board.id, board.name, openDuplicateModal]);
|
||||
|
||||
const handleExportBoard = useCallback(() => {
|
||||
openExportModal({
|
||||
board: {
|
||||
id: board.id,
|
||||
name: board.name,
|
||||
},
|
||||
});
|
||||
}, [board.id, board.name, openExportModal]);
|
||||
|
||||
return (
|
||||
<Menu.Dropdown>
|
||||
<Menu.Item onClick={handleSetHomeBoard} leftSection={<IconHome {...iconProps} />}>
|
||||
@@ -95,6 +108,9 @@ export const BoardCardMenuDropdown = ({ board }: BoardCardMenuDropdownProps) =>
|
||||
<Menu.Item onClick={handleSetMobileHomeBoard} leftSection={<IconDeviceMobile {...iconProps} />}>
|
||||
{t("setMobileHomeBoard.label")}
|
||||
</Menu.Item>
|
||||
<Menu.Item onClick={handleExportBoard} leftSection={<IconDownload {...iconProps} />}>
|
||||
{t("export.label")}
|
||||
</Menu.Item>
|
||||
{session?.user.permissions.includes("board-create") && (
|
||||
<Menu.Item onClick={handleDuplicateBoard} leftSection={<IconCopy {...iconProps} />}>
|
||||
{t("duplicate.label")}
|
||||
|
||||
@@ -10,7 +10,7 @@ import { useI18n } from "@homarr/translation/client";
|
||||
import { ManageMobilePrimaryAction } from "~/components/manage/manage-mobile-primary-action";
|
||||
|
||||
export const CreateBoardButton = () => {
|
||||
const t = useI18n();
|
||||
const t = useI18n() as unknown as (key: string) => string;
|
||||
const { openModal: openAddModal } = useModalAction(AddBoardModal);
|
||||
const { openModal: openImportModal } = useModalAction(ImportBoardModal);
|
||||
|
||||
|
||||
@@ -10,6 +10,7 @@ import {
|
||||
IconBrandTablerFilled,
|
||||
IconCertificate,
|
||||
IconClipboardListFilled,
|
||||
IconDatabaseExport,
|
||||
IconDirectionsFilled,
|
||||
IconGitFork,
|
||||
IconHelpSquareRoundedFilled,
|
||||
@@ -146,6 +147,12 @@ export default async function ManageLayout({ children }: PropsWithChildren) {
|
||||
href: "/manage/tools/tasks",
|
||||
hidden: !session?.user.permissions.includes("admin"),
|
||||
},
|
||||
{
|
||||
label: (t as unknown as (key: string) => string)("items.tools.items.importExport"),
|
||||
icon: IconDatabaseExport,
|
||||
href: "/manage/tools/import-export",
|
||||
hidden: !session?.user.permissions.includes("admin"),
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
|
||||
@@ -0,0 +1,57 @@
|
||||
"use client";
|
||||
|
||||
import { NumberInput, Switch, TextInput } from "@mantine/core";
|
||||
|
||||
import type { ServerSettings } from "@homarr/server-settings";
|
||||
import { useScopedI18n } from "@homarr/translation/client";
|
||||
|
||||
import { CommonSettingsForm } from "./common-form";
|
||||
|
||||
export const DockerSettingsForm = ({ defaultValues }: { defaultValues: ServerSettings["docker"] }) => {
|
||||
const tDocker = useScopedI18n("management.page.settings.section.docker" as never) as unknown as (
|
||||
key: string,
|
||||
) => string;
|
||||
|
||||
return (
|
||||
<CommonSettingsForm settingKey="docker" defaultValues={defaultValues}>
|
||||
{(form) => (
|
||||
<>
|
||||
<TextInput
|
||||
{...form.getInputProps("targetBoardName")}
|
||||
label={tDocker("targetBoardName.label")}
|
||||
description={tDocker("targetBoardName.description")}
|
||||
/>
|
||||
<Switch
|
||||
{...form.getInputProps("readHomepageLabels", { type: "checkbox" })}
|
||||
label={tDocker("readHomepageLabels.label")}
|
||||
description={tDocker("readHomepageLabels.description")}
|
||||
/>
|
||||
<Switch
|
||||
{...form.getInputProps("createIntegrations", { type: "checkbox" })}
|
||||
label={tDocker("createIntegrations.label")}
|
||||
description={tDocker("createIntegrations.description")}
|
||||
/>
|
||||
<Switch
|
||||
{...form.getInputProps("pruneRemoved", { type: "checkbox" })}
|
||||
label={tDocker("pruneRemoved.label")}
|
||||
description={tDocker("pruneRemoved.description")}
|
||||
/>
|
||||
<NumberInput
|
||||
{...form.getInputProps("defaultItemWidth")}
|
||||
label={tDocker("defaultItemWidth.label")}
|
||||
description={tDocker("defaultItemWidth.description")}
|
||||
min={1}
|
||||
max={10}
|
||||
/>
|
||||
<NumberInput
|
||||
{...form.getInputProps("defaultItemHeight")}
|
||||
label={tDocker("defaultItemHeight.label")}
|
||||
description={tDocker("defaultItemHeight.description")}
|
||||
min={1}
|
||||
max={10}
|
||||
/>
|
||||
</>
|
||||
)}
|
||||
</CommonSettingsForm>
|
||||
);
|
||||
};
|
||||
@@ -5,12 +5,15 @@ import { api } from "@homarr/api/server";
|
||||
import { auth } from "@homarr/auth/next";
|
||||
import { getScopedI18n } from "@homarr/translation/server";
|
||||
|
||||
import { env } from "@homarr/docker/env";
|
||||
|
||||
import { CrawlingAndIndexingSettings } from "~/app/[locale]/manage/settings/_components/crawling-and-indexing.settings";
|
||||
import { DynamicBreadcrumb } from "~/components/navigation/dynamic-breadcrumb";
|
||||
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 { DockerSettingsForm } from "./_components/docker-settings-form";
|
||||
import { SearchSettingsForm } from "./_components/search-settings-form";
|
||||
import { UserSettingsForm } from "./_components/user-settings-form";
|
||||
|
||||
@@ -59,6 +62,12 @@ export default async function SettingsPage() {
|
||||
<Title order={2}>{tSettings("section.culture.title")}</Title>
|
||||
<CultureSettingsForm defaultValues={serverSettings.culture} />
|
||||
</Stack>
|
||||
{env.ENABLE_DOCKER && (
|
||||
<Stack>
|
||||
<Title order={2}>{(tSettings as unknown as (key: string) => string)("section.docker.title")}</Title>
|
||||
<DockerSettingsForm defaultValues={serverSettings.docker} />
|
||||
</Stack>
|
||||
)}
|
||||
</Stack>
|
||||
</>
|
||||
);
|
||||
|
||||
@@ -0,0 +1,124 @@
|
||||
"use client";
|
||||
|
||||
import { Avatar, Badge, Button, Card, Group, Stack, Table, Text, Title } from "@mantine/core";
|
||||
import { IconRefresh, IconSearch } from "@tabler/icons-react";
|
||||
|
||||
import { clientApi } from "@homarr/api/client";
|
||||
import { showErrorNotification, showSuccessNotification } from "@homarr/notifications";
|
||||
import { useScopedI18n } from "@homarr/translation/client";
|
||||
|
||||
export const DockerDiscoveryPanel = () => {
|
||||
const tDiscovery = useScopedI18n("docker.discovery" as never) as unknown as (
|
||||
key: string,
|
||||
values?: Record<string, unknown>,
|
||||
) => string;
|
||||
const { data: preview, refetch, isLoading: isLoadingPreview, isFetched } =
|
||||
clientApi.docker.getDiscoveredPreview.useQuery(undefined, {
|
||||
enabled: false,
|
||||
});
|
||||
const { mutate: syncDiscovery, isPending: isSyncing } = clientApi.docker.syncDiscovery.useMutation({
|
||||
onSuccess(result) {
|
||||
showSuccessNotification({
|
||||
title: tDiscovery("sync.notification.success.title"),
|
||||
message: tDiscovery("sync.notification.success.message", {
|
||||
created: result.created,
|
||||
updated: result.updated,
|
||||
}),
|
||||
});
|
||||
void refetch();
|
||||
},
|
||||
onError() {
|
||||
showErrorNotification({
|
||||
title: tDiscovery("sync.notification.error.title"),
|
||||
message: tDiscovery("sync.notification.error.message"),
|
||||
});
|
||||
},
|
||||
});
|
||||
|
||||
const services = preview ?? [];
|
||||
|
||||
return (
|
||||
<Card withBorder>
|
||||
<Stack>
|
||||
<Group justify="space-between">
|
||||
<Title order={3}>{tDiscovery("title")}</Title>
|
||||
<Group gap="xs">
|
||||
<Button
|
||||
variant="light"
|
||||
leftSection={<IconSearch size={16} />}
|
||||
loading={isLoadingPreview}
|
||||
onClick={() => refetch()}
|
||||
>
|
||||
{tDiscovery("preview.label")}
|
||||
</Button>
|
||||
<Button
|
||||
leftSection={<IconRefresh size={16} />}
|
||||
loading={isSyncing}
|
||||
onClick={() => syncDiscovery()}
|
||||
disabled={services.length === 0}
|
||||
>
|
||||
{tDiscovery("sync.label")}
|
||||
</Button>
|
||||
</Group>
|
||||
</Group>
|
||||
|
||||
{!isFetched ? (
|
||||
<Text c="dimmed" ta="center" py="xl">
|
||||
{tDiscovery("preview.idle")}
|
||||
</Text>
|
||||
) : services.length === 0 ? (
|
||||
<Text c="dimmed" ta="center" py="xl">
|
||||
{tDiscovery("preview.empty")}
|
||||
</Text>
|
||||
) : (
|
||||
<Table striped highlightOnHover>
|
||||
<Table.Thead>
|
||||
<Table.Tr>
|
||||
<Table.Th>{tDiscovery("field.name")}</Table.Th>
|
||||
<Table.Th>{tDiscovery("field.group")}</Table.Th>
|
||||
<Table.Th>{tDiscovery("field.href")}</Table.Th>
|
||||
<Table.Th>{tDiscovery("field.host")}</Table.Th>
|
||||
</Table.Tr>
|
||||
</Table.Thead>
|
||||
<Table.Tbody>
|
||||
{services.map((service) => (
|
||||
<Table.Tr key={`${service.host}/${service.containerId}`}>
|
||||
<Table.Td>
|
||||
<Group gap="xs">
|
||||
{service.icon && (
|
||||
<Avatar size="sm" radius="sm" src={service.icon}>
|
||||
{service.name.charAt(0)}
|
||||
</Avatar>
|
||||
)}
|
||||
<Text size="sm">{service.name}</Text>
|
||||
{service.integrationKind && (
|
||||
<Badge size="xs" variant="light">
|
||||
{service.integrationKind}
|
||||
</Badge>
|
||||
)}
|
||||
</Group>
|
||||
</Table.Td>
|
||||
<Table.Td>
|
||||
<Badge variant="outline" size="sm">
|
||||
{service.group}
|
||||
</Badge>
|
||||
</Table.Td>
|
||||
<Table.Td>
|
||||
<Text size="sm" lineClamp={1}>
|
||||
{service.href}
|
||||
</Text>
|
||||
</Table.Td>
|
||||
<Table.Td>
|
||||
<Text size="sm" c="dimmed">
|
||||
{service.host}
|
||||
</Text>
|
||||
</Table.Td>
|
||||
</Table.Tr>
|
||||
))}
|
||||
</Table.Tbody>
|
||||
</Table>
|
||||
)}
|
||||
</Stack>
|
||||
</Card>
|
||||
);
|
||||
};
|
||||
@@ -0,0 +1,138 @@
|
||||
"use client";
|
||||
|
||||
import { useState } from "react";
|
||||
import { Alert, Button, Card, Group, List, Loader, Popover, Stack, Text, Title } from "@mantine/core";
|
||||
import { IconAlertTriangle, IconDatabaseExport } from "@tabler/icons-react";
|
||||
|
||||
import { clientApi } from "@homarr/api/client";
|
||||
import { showErrorNotification, showSuccessNotification } from "@homarr/notifications";
|
||||
import { useI18n } from "@homarr/translation/client";
|
||||
|
||||
import { ConfigSummaryList } from "~/components/config-import/config-summary-list";
|
||||
|
||||
const exportWarningPointKeys = [
|
||||
"management.page.importExport.export.warning.message",
|
||||
"management.page.importExport.export.warning.storage",
|
||||
"management.page.importExport.export.warning.sharing",
|
||||
] as const;
|
||||
|
||||
export const ExportConfigCard = () => {
|
||||
const t = useI18n() as unknown as (key: string, values?: Record<string, unknown>) => string;
|
||||
const { mutateAsync, isPending } = clientApi.config.exportFull.useMutation();
|
||||
const [popoverOpened, setPopoverOpened] = useState(false);
|
||||
|
||||
const { data: preview, isLoading: previewLoading } = clientApi.config.previewExport.useQuery(undefined, {
|
||||
enabled: popoverOpened,
|
||||
});
|
||||
|
||||
const closePopover = () => setPopoverOpened(false);
|
||||
|
||||
const runExport = async () => {
|
||||
await mutateAsync(undefined, {
|
||||
onSuccess({ content, filename }) {
|
||||
const blob = new Blob([content], { type: "application/json" });
|
||||
const url = URL.createObjectURL(blob);
|
||||
const anchor = document.createElement("a");
|
||||
anchor.href = url;
|
||||
anchor.download = filename;
|
||||
anchor.click();
|
||||
URL.revokeObjectURL(url);
|
||||
showSuccessNotification({
|
||||
title: t("management.page.importExport.export.notification.success.title"),
|
||||
message: t("management.page.importExport.export.notification.success.message"),
|
||||
});
|
||||
},
|
||||
onError() {
|
||||
showErrorNotification({
|
||||
title: t("management.page.importExport.export.notification.error.title"),
|
||||
message: t("management.page.importExport.export.notification.error.message"),
|
||||
});
|
||||
},
|
||||
});
|
||||
};
|
||||
|
||||
const handleConfirmExport = () => {
|
||||
closePopover();
|
||||
void runExport();
|
||||
};
|
||||
|
||||
return (
|
||||
<Card withBorder>
|
||||
<Stack>
|
||||
<Stack gap="xs">
|
||||
<Title order={3}>{t("management.page.importExport.export.title")}</Title>
|
||||
<Text size="sm" c="dimmed">
|
||||
{t("management.page.importExport.export.description")}
|
||||
</Text>
|
||||
</Stack>
|
||||
|
||||
<Popover
|
||||
opened={popoverOpened}
|
||||
onChange={setPopoverOpened}
|
||||
width={420}
|
||||
position="bottom-end"
|
||||
withArrow
|
||||
shadow="md"
|
||||
>
|
||||
<Popover.Target>
|
||||
<Group justify="flex-end">
|
||||
<Button
|
||||
leftSection={<IconDatabaseExport size="1rem" />}
|
||||
loading={isPending}
|
||||
disabled={isPending}
|
||||
onClick={() => setPopoverOpened(true)}
|
||||
>
|
||||
{t("management.page.importExport.export.action")}
|
||||
</Button>
|
||||
</Group>
|
||||
</Popover.Target>
|
||||
<Popover.Dropdown>
|
||||
<Stack gap="md">
|
||||
<Alert
|
||||
variant="light"
|
||||
color="red"
|
||||
icon={<IconAlertTriangle size="1.25rem" stroke={1.5} />}
|
||||
title={t("management.page.importExport.export.warning.title")}
|
||||
>
|
||||
<List size="sm" spacing="xs">
|
||||
{exportWarningPointKeys.map((key) => (
|
||||
<List.Item key={key}>{t(key)}</List.Item>
|
||||
))}
|
||||
</List>
|
||||
</Alert>
|
||||
|
||||
<Stack gap="xs">
|
||||
<Text size="sm" fw={500}>
|
||||
{t("management.page.importExport.summary.title")}
|
||||
</Text>
|
||||
{previewLoading && (
|
||||
<Group gap="xs">
|
||||
<Loader size="xs" />
|
||||
<Text size="sm" c="dimmed">
|
||||
{t("management.page.importExport.preview.exportLoading")}
|
||||
</Text>
|
||||
</Group>
|
||||
)}
|
||||
{preview && <ConfigSummaryList counts={preview} t={t} />}
|
||||
</Stack>
|
||||
|
||||
<Group justify="flex-end" gap="sm">
|
||||
<Button variant="default" onClick={closePopover}>
|
||||
{t("common.action.cancel")}
|
||||
</Button>
|
||||
<Button
|
||||
color="red.9"
|
||||
onClick={handleConfirmExport}
|
||||
disabled={previewLoading}
|
||||
loading={isPending}
|
||||
>
|
||||
{t("common.action.continue")}
|
||||
</Button>
|
||||
</Group>
|
||||
</Stack>
|
||||
</Popover.Dropdown>
|
||||
</Popover>
|
||||
</Stack>
|
||||
</Card>
|
||||
);
|
||||
};
|
||||
@@ -0,0 +1,126 @@
|
||||
"use client";
|
||||
|
||||
import { useEffect, useState } from "react";
|
||||
import { Alert, Button, Card, FileInput, Group, List, Stack, Text, Title } from "@mantine/core";
|
||||
import { IconCheck, IconFileUpload } from "@tabler/icons-react";
|
||||
|
||||
import { clientApi } from "@homarr/api/client";
|
||||
import { revalidatePathActionAsync } from "@homarr/common/client";
|
||||
import { showErrorNotification, showSuccessNotification } from "@homarr/notifications";
|
||||
import { useI18n } from "@homarr/translation/client";
|
||||
|
||||
import { ConfigImportPreviewPanel } from "~/components/config-import/config-import-preview-panel";
|
||||
|
||||
export const ImportConfigCard = () => {
|
||||
const t = useI18n() as unknown as (key: string, values?: Record<string, unknown>) => string;
|
||||
const [file, setFile] = useState<File | null>(null);
|
||||
const [fileContent, setFileContent] = useState("");
|
||||
const [importResult, setImportResult] = useState<{
|
||||
boards: number;
|
||||
apps: number;
|
||||
integrations: number;
|
||||
groups: number;
|
||||
searchEngines: number;
|
||||
warnings: string[];
|
||||
} | null>(null);
|
||||
|
||||
const {
|
||||
mutate: runPreview,
|
||||
data: preview,
|
||||
isPending: previewLoading,
|
||||
reset: resetPreview,
|
||||
} = clientApi.config.previewImport.useMutation();
|
||||
|
||||
const { mutateAsync, isPending } = clientApi.config.importFull.useMutation({
|
||||
async onSuccess() {
|
||||
await revalidatePathActionAsync("/manage");
|
||||
},
|
||||
});
|
||||
|
||||
useEffect(() => {
|
||||
if (!fileContent) {
|
||||
resetPreview();
|
||||
return;
|
||||
}
|
||||
runPreview({ content: fileContent });
|
||||
}, [fileContent, runPreview, resetPreview]);
|
||||
|
||||
const importAllowed = preview?.compatibility.status === "compatible";
|
||||
|
||||
const handleImport = async () => {
|
||||
if (!file || !importAllowed) {
|
||||
return;
|
||||
}
|
||||
const content = await file.text();
|
||||
await mutateAsync(
|
||||
{ content },
|
||||
{
|
||||
onSuccess(result) {
|
||||
setImportResult(result);
|
||||
showSuccessNotification({
|
||||
title: t("management.page.importExport.importConfig.notification.success.title"),
|
||||
message: t("management.page.importExport.importConfig.notification.success.message"),
|
||||
});
|
||||
},
|
||||
onError() {
|
||||
showErrorNotification({
|
||||
title: t("management.page.importExport.importConfig.notification.error.title"),
|
||||
message: t("management.page.importExport.importConfig.notification.error.message"),
|
||||
});
|
||||
},
|
||||
},
|
||||
);
|
||||
};
|
||||
|
||||
return (
|
||||
<Card withBorder>
|
||||
<Stack>
|
||||
<Stack gap="xs">
|
||||
<Title order={3}>{t("management.page.importExport.importConfig.title")}</Title>
|
||||
<Text size="sm" c="dimmed">
|
||||
{t("management.page.importExport.importConfig.description")}
|
||||
</Text>
|
||||
</Stack>
|
||||
|
||||
<FileInput
|
||||
rightSection={<IconFileUpload />}
|
||||
accept="application/json"
|
||||
value={file}
|
||||
onChange={(newFile) => {
|
||||
setFile(newFile);
|
||||
setImportResult(null);
|
||||
setFileContent("");
|
||||
|
||||
if (!newFile) {
|
||||
return;
|
||||
}
|
||||
|
||||
void newFile.text().then((content) => {
|
||||
setFileContent(content);
|
||||
});
|
||||
}}
|
||||
label={t("management.page.importExport.importConfig.fileLabel")}
|
||||
/>
|
||||
|
||||
<ConfigImportPreviewPanel preview={preview} previewLoading={previewLoading} t={t} />
|
||||
|
||||
{importResult && (
|
||||
<Alert color="green" icon={<IconCheck />}>
|
||||
<List size="sm">
|
||||
<List.Item>{importResult.boards} boards imported</List.Item>
|
||||
<List.Item>{importResult.apps} apps created</List.Item>
|
||||
<List.Item>{importResult.integrations} integrations created</List.Item>
|
||||
<List.Item>{importResult.groups} groups created</List.Item>
|
||||
</List>
|
||||
</Alert>
|
||||
)}
|
||||
|
||||
<Group justify="end">
|
||||
<Button loading={isPending} disabled={!file || !importAllowed || previewLoading} onClick={() => void handleImport()}>
|
||||
{t("common.action.import")}
|
||||
</Button>
|
||||
</Group>
|
||||
</Stack>
|
||||
</Card>
|
||||
);
|
||||
};
|
||||
@@ -0,0 +1,181 @@
|
||||
"use client";
|
||||
|
||||
import { useState } from "react";
|
||||
import { Button, Card, Code, FileInput, Group, Stack, Switch, Text, TextInput, Title } from "@mantine/core";
|
||||
import { IconFileUpload } from "@tabler/icons-react";
|
||||
import { z } from "zod/v4";
|
||||
|
||||
import { clientApi } from "@homarr/api/client";
|
||||
import {
|
||||
extractHomepageEnvVariables,
|
||||
parseServicesYaml,
|
||||
replaceHomepageEnvVariables,
|
||||
} from "@homarr/board-portability/client";
|
||||
import { revalidatePathActionAsync } from "@homarr/common/client";
|
||||
import { useZodForm } from "@homarr/form";
|
||||
import { showErrorNotification, showSuccessNotification } from "@homarr/notifications";
|
||||
import { useI18n } from "@homarr/translation/client";
|
||||
import { boardNameSchema } from "@homarr/validation/board";
|
||||
|
||||
export const ImportHomepageCard = () => {
|
||||
const t = useI18n() as unknown as (key: string) => string;
|
||||
const [fileValid, setFileValid] = useState(true);
|
||||
const [rawContent, setRawContent] = useState("");
|
||||
const [envVars, setEnvVars] = useState<string[]>([]);
|
||||
const [envValues, setEnvValues] = useState<Record<string, string>>({});
|
||||
|
||||
const form = useZodForm(
|
||||
z.object({
|
||||
file: z.file(),
|
||||
boardName: boardNameSchema,
|
||||
createIntegrations: z.boolean(),
|
||||
}),
|
||||
{
|
||||
mode: "controlled",
|
||||
initialValues: {
|
||||
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
|
||||
file: null!,
|
||||
boardName: "",
|
||||
createIntegrations: true,
|
||||
},
|
||||
onValuesChange(values, previous) {
|
||||
void (async () => {
|
||||
if (values.file === previous.file) return;
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
if (!values.file) return;
|
||||
|
||||
const content = await values.file.text();
|
||||
setRawContent(content);
|
||||
|
||||
const vars = extractHomepageEnvVariables(content);
|
||||
setEnvVars(vars);
|
||||
setEnvValues(Object.fromEntries(vars.map((v: string) => [v, ""])));
|
||||
|
||||
const result = parseServicesYaml(content);
|
||||
if (!result.success) {
|
||||
setFileValid(false);
|
||||
return;
|
||||
}
|
||||
|
||||
setFileValid(true);
|
||||
const suggestedName =
|
||||
result.services[0]?.group.replaceAll(/[^A-Za-z0-9-_]/g, "-").replaceAll(/-+/g, "-") ?? "homepage";
|
||||
if (form.values.boardName.trim().length === 0) {
|
||||
form.setFieldValue("boardName", suggestedName.slice(0, 255));
|
||||
}
|
||||
})();
|
||||
},
|
||||
},
|
||||
);
|
||||
|
||||
const { mutateAsync, isPending } = clientApi.board.importHomepageServices.useMutation({
|
||||
async onSuccess() {
|
||||
await revalidatePathActionAsync("/manage/boards");
|
||||
},
|
||||
});
|
||||
|
||||
const allEnvVarsFilled = envVars.length === 0 || envVars.every((v) => (envValues[v] ?? "").trim().length > 0);
|
||||
|
||||
return (
|
||||
<Card withBorder>
|
||||
<form
|
||||
onSubmit={form.onSubmit((values) => {
|
||||
if (!fileValid || !allEnvVarsFilled) return;
|
||||
|
||||
void (async () => {
|
||||
const resolvedContent =
|
||||
envVars.length > 0 ? replaceHomepageEnvVariables(rawContent, envValues) : rawContent;
|
||||
|
||||
await mutateAsync(
|
||||
{
|
||||
content: resolvedContent,
|
||||
boardName: values.boardName,
|
||||
createIntegrations: values.createIntegrations,
|
||||
},
|
||||
{
|
||||
onSuccess() {
|
||||
showSuccessNotification({
|
||||
title: t("management.page.importExport.importHomepage.notification.success.title"),
|
||||
message: t("management.page.importExport.importHomepage.notification.success.message"),
|
||||
});
|
||||
form.reset();
|
||||
setRawContent("");
|
||||
setEnvVars([]);
|
||||
setEnvValues({});
|
||||
},
|
||||
onError() {
|
||||
showErrorNotification({
|
||||
title: t("management.page.importExport.importHomepage.notification.error.title"),
|
||||
message: t("management.page.importExport.importHomepage.notification.error.message"),
|
||||
});
|
||||
},
|
||||
},
|
||||
);
|
||||
})();
|
||||
})}
|
||||
>
|
||||
<Stack>
|
||||
<Stack gap="xs">
|
||||
<Title order={3}>{t("management.page.importExport.importHomepage.title")}</Title>
|
||||
<Text size="sm" c="dimmed">
|
||||
{t("management.page.importExport.importHomepage.description")}
|
||||
</Text>
|
||||
</Stack>
|
||||
|
||||
<FileInput
|
||||
rightSection={<IconFileUpload />}
|
||||
withAsterisk
|
||||
accept=".yaml,.yml"
|
||||
{...form.getInputProps("file")}
|
||||
error={
|
||||
(form.getInputProps("file").error as string | undefined) ??
|
||||
(!fileValid && form.isDirty("file") ? t("management.page.importExport.importHomepage.invalidFile") : undefined)
|
||||
}
|
||||
type="button"
|
||||
label={t("management.page.importExport.importHomepage.fileLabel")}
|
||||
/>
|
||||
|
||||
{envVars.length > 0 && (
|
||||
<Stack gap="xs">
|
||||
<Text size="sm" fw={500}>
|
||||
{t("management.page.importExport.importHomepage.envVariables.label")}
|
||||
</Text>
|
||||
<Text size="xs" c="dimmed">
|
||||
{t("management.page.importExport.importHomepage.envVariables.description")}
|
||||
</Text>
|
||||
{envVars.map((varName) => (
|
||||
<TextInput
|
||||
key={varName}
|
||||
label={<Code>{`{{${varName}}}`}</Code>}
|
||||
placeholder={varName.replace("HOMEPAGE_VAR_", "").toLowerCase().replaceAll("_", ".")}
|
||||
value={envValues[varName] ?? ""}
|
||||
onChange={(event) => {
|
||||
setEnvValues((prev) => ({ ...prev, [varName]: event.target.value }));
|
||||
}}
|
||||
withAsterisk
|
||||
/>
|
||||
))}
|
||||
</Stack>
|
||||
)}
|
||||
|
||||
<TextInput
|
||||
withAsterisk
|
||||
label={t("management.page.importExport.importHomepage.boardNameLabel")}
|
||||
{...form.getInputProps("boardName")}
|
||||
/>
|
||||
|
||||
<Switch
|
||||
label={t("management.page.importExport.importHomepage.createIntegrations")}
|
||||
{...form.getInputProps("createIntegrations", { type: "checkbox" })}
|
||||
/>
|
||||
|
||||
<Group justify="end">
|
||||
<Button type="submit" loading={isPending} disabled={!allEnvVarsFilled}>
|
||||
{t("common.action.import")}
|
||||
</Button>
|
||||
</Group>
|
||||
</Stack>
|
||||
</form>
|
||||
</Card>
|
||||
);
|
||||
};
|
||||
@@ -0,0 +1,34 @@
|
||||
import { notFound } from "next/navigation";
|
||||
import { Stack, Title } from "@mantine/core";
|
||||
|
||||
import { auth } from "@homarr/auth/next";
|
||||
import { env } from "@homarr/docker/env";
|
||||
import { getScopedI18n } from "@homarr/translation/server";
|
||||
|
||||
import { DynamicBreadcrumb } from "~/components/navigation/dynamic-breadcrumb";
|
||||
import { DockerDiscoveryPanel } from "./docker-discovery-panel";
|
||||
import { ExportConfigCard } from "./export-config-card";
|
||||
import { ImportConfigCard } from "./import-config-card";
|
||||
import { ImportHomepageCard } from "./import-homepage-card";
|
||||
|
||||
export default async function ImportExportPage() {
|
||||
const session = await auth();
|
||||
if (!session?.user.permissions.includes("admin")) {
|
||||
notFound();
|
||||
}
|
||||
|
||||
const t = await getScopedI18n("management.page.importExport" as never) as unknown as (key: string) => string;
|
||||
|
||||
return (
|
||||
<>
|
||||
<DynamicBreadcrumb />
|
||||
<Stack>
|
||||
<Title order={1}>{t("title")}</Title>
|
||||
<ExportConfigCard />
|
||||
<ImportConfigCard />
|
||||
<ImportHomepageCard />
|
||||
{env.ENABLE_DOCKER && <DockerDiscoveryPanel />}
|
||||
</Stack>
|
||||
</>
|
||||
);
|
||||
}
|
||||
@@ -2,7 +2,6 @@
|
||||
|
||||
import { useEffect, useRef } from "react";
|
||||
import { Box } from "@mantine/core";
|
||||
import { CanvasAddon } from "@xterm/addon-canvas";
|
||||
import { FitAddon } from "@xterm/addon-fit";
|
||||
import { Terminal } from "@xterm/xterm";
|
||||
|
||||
@@ -15,7 +14,7 @@ export const TerminalComponent = () => {
|
||||
const ref = useRef<HTMLDivElement>(null);
|
||||
const { activeLevels } = useLogContext();
|
||||
|
||||
const terminalRef = useRef<Terminal>(null);
|
||||
const terminalRef = useRef<Terminal | null>(null);
|
||||
clientApi.log.subscribe.useSubscription(
|
||||
{
|
||||
levels: activeLevels,
|
||||
@@ -26,7 +25,6 @@ export const TerminalComponent = () => {
|
||||
terminalRef.current?.refresh(0, terminalRef.current.rows - 1);
|
||||
},
|
||||
onError(err) {
|
||||
// This makes sense as logging might cause an infinite loop
|
||||
alert(err);
|
||||
},
|
||||
},
|
||||
@@ -37,28 +35,30 @@ export const TerminalComponent = () => {
|
||||
return () => undefined;
|
||||
}
|
||||
|
||||
const canvasAddon = new CanvasAddon();
|
||||
|
||||
terminalRef.current = new Terminal({
|
||||
const fitAddon = new FitAddon();
|
||||
const terminal = new Terminal({
|
||||
cursorBlink: false,
|
||||
disableStdin: true,
|
||||
convertEol: true,
|
||||
});
|
||||
terminalRef.current.open(ref.current);
|
||||
terminalRef.current.loadAddon(canvasAddon);
|
||||
terminal.open(ref.current);
|
||||
terminal.loadAddon(fitAddon);
|
||||
terminalRef.current = terminal;
|
||||
|
||||
// This is a hack to make sure the terminal is rendered before we try to fit it
|
||||
// You can blame @Meierschlumpf for this
|
||||
setTimeout(() => {
|
||||
const fitAddon = new FitAddon();
|
||||
terminalRef.current?.loadAddon(fitAddon);
|
||||
fitAddon.fit();
|
||||
});
|
||||
const fitTerminal = () => fitAddon.fit();
|
||||
const fitTimeout = setTimeout(fitTerminal);
|
||||
|
||||
const resizeObserver = new ResizeObserver(fitTerminal);
|
||||
resizeObserver.observe(ref.current);
|
||||
|
||||
return () => {
|
||||
terminalRef.current?.dispose();
|
||||
canvasAddon.dispose();
|
||||
clearTimeout(fitTimeout);
|
||||
resizeObserver.disconnect();
|
||||
fitAddon.dispose();
|
||||
terminal.dispose();
|
||||
terminalRef.current = null;
|
||||
};
|
||||
}, []);
|
||||
|
||||
return <Box ref={ref} id="terminal" className={classes.outerTerminal} h="100%"></Box>;
|
||||
};
|
||||
@@ -0,0 +1,160 @@
|
||||
"use client";
|
||||
|
||||
import { Alert, Group, List, Loader, Stack, Text } from "@mantine/core";
|
||||
import { IconAlertTriangle } from "@tabler/icons-react";
|
||||
|
||||
import type { ConfigImportPreview } from "@homarr/board-portability";
|
||||
|
||||
import { ConfigSummaryList } from "./config-summary-list";
|
||||
|
||||
const compatibilityAlertColor: Record<ConfigImportPreview["compatibility"]["status"], string> = {
|
||||
compatible: "blue",
|
||||
unsupportedVersion: "red",
|
||||
invalidStructure: "red",
|
||||
};
|
||||
|
||||
type ConfigImportPreviewPanelProps = {
|
||||
preview: ConfigImportPreview | undefined;
|
||||
previewLoading: boolean;
|
||||
t: (key: string, values?: Record<string, unknown>) => string;
|
||||
};
|
||||
|
||||
export const ConfigImportPreviewPanel = ({ preview, previewLoading, t }: ConfigImportPreviewPanelProps) => {
|
||||
if (!preview && !previewLoading) {
|
||||
return null;
|
||||
}
|
||||
|
||||
const importAllowed = preview?.compatibility.status === "compatible";
|
||||
|
||||
return (
|
||||
<Stack gap="sm">
|
||||
{previewLoading && (
|
||||
<Group gap="xs">
|
||||
<Loader size="xs" />
|
||||
<Text size="sm" c="dimmed">
|
||||
{t("management.page.importExport.preview.importLoading")}
|
||||
</Text>
|
||||
</Group>
|
||||
)}
|
||||
|
||||
{preview && (
|
||||
<>
|
||||
<Alert
|
||||
variant="light"
|
||||
color={compatibilityAlertColor[preview.compatibility.status]}
|
||||
icon={<IconAlertTriangle size="1rem" stroke={1.5} />}
|
||||
title={
|
||||
preview.compatibility.status === "compatible"
|
||||
? t("management.page.importExport.preview.migrationNote", {
|
||||
bundleVersion: preview.meta.bundleVersion || "?",
|
||||
})
|
||||
: t("management.page.importExport.preview.importIncompatible")
|
||||
}
|
||||
>
|
||||
{preview.compatibility.status === "compatible" && preview.meta.exportedAt && (
|
||||
<Text size="sm" mb="xs">
|
||||
{t("management.page.importExport.preview.importMeta", {
|
||||
exportedAt: preview.meta.exportedAt,
|
||||
homarrVersion: preview.meta.homarrVersion,
|
||||
bundleVersion: preview.meta.bundleVersion,
|
||||
})}
|
||||
</Text>
|
||||
)}
|
||||
{preview.compatibility.issues.length > 0 && (
|
||||
<List size="sm" spacing={4}>
|
||||
{preview.compatibility.issues.map((issue) => (
|
||||
<List.Item key={issue}>{issue}</List.Item>
|
||||
))}
|
||||
</List>
|
||||
)}
|
||||
</Alert>
|
||||
|
||||
{importAllowed && (
|
||||
<>
|
||||
<Stack gap="xs">
|
||||
<Text size="sm" fw={500}>
|
||||
{t("management.page.importExport.preview.importWillCreate")}
|
||||
</Text>
|
||||
<ConfigSummaryList counts={preview.toCreate} t={t} />
|
||||
</Stack>
|
||||
|
||||
{(preview.toReuse.apps > 0 || preview.toReuse.integrations > 0) && (
|
||||
<Stack gap="xs">
|
||||
<Text size="sm" fw={500}>
|
||||
{t("management.page.importExport.preview.importWillReuse")}
|
||||
</Text>
|
||||
<List size="sm">
|
||||
{preview.toReuse.apps > 0 && (
|
||||
<List.Item>
|
||||
{t("management.page.importExport.preview.reuseApps", { count: preview.toReuse.apps })}
|
||||
</List.Item>
|
||||
)}
|
||||
{preview.toReuse.integrations > 0 && (
|
||||
<List.Item>
|
||||
{t("management.page.importExport.preview.reuseIntegrations", {
|
||||
count: preview.toReuse.integrations,
|
||||
})}
|
||||
</List.Item>
|
||||
)}
|
||||
</List>
|
||||
</Stack>
|
||||
)}
|
||||
|
||||
{(preview.toSkip.boards > 0 || preview.toSkip.groups > 0 || preview.toSkip.searchEngines > 0) && (
|
||||
<Stack gap="xs">
|
||||
<Text size="sm" fw={500}>
|
||||
{t("management.page.importExport.preview.importWillSkip")}
|
||||
</Text>
|
||||
<List size="sm">
|
||||
{preview.toSkip.boards > 0 && (
|
||||
<List.Item>
|
||||
{t("management.page.importExport.preview.skipBoards", { count: preview.toSkip.boards })}
|
||||
</List.Item>
|
||||
)}
|
||||
{preview.toSkip.groups > 0 && (
|
||||
<List.Item>
|
||||
{t("management.page.importExport.preview.skipGroups", { count: preview.toSkip.groups })}
|
||||
</List.Item>
|
||||
)}
|
||||
{preview.toSkip.searchEngines > 0 && (
|
||||
<List.Item>
|
||||
{t("management.page.importExport.preview.skipSearchEngines", {
|
||||
count: preview.toSkip.searchEngines,
|
||||
})}
|
||||
</List.Item>
|
||||
)}
|
||||
</List>
|
||||
</Stack>
|
||||
)}
|
||||
|
||||
{preview.toUpdate.serverSettings > 0 && (
|
||||
<Stack gap="xs">
|
||||
<Text size="sm" fw={500}>
|
||||
{t("management.page.importExport.preview.importWillUpdate")}
|
||||
</Text>
|
||||
<List size="sm">
|
||||
<List.Item>
|
||||
{t("management.page.importExport.preview.updateServerSettings", {
|
||||
count: preview.toUpdate.serverSettings,
|
||||
})}
|
||||
</List.Item>
|
||||
</List>
|
||||
</Stack>
|
||||
)}
|
||||
|
||||
{preview.warnings.length > 0 && (
|
||||
<Alert color="yellow" variant="light" icon={<IconAlertTriangle size="1rem" />}>
|
||||
<List size="sm">
|
||||
{preview.warnings.map((warning) => (
|
||||
<List.Item key={warning}>{warning}</List.Item>
|
||||
))}
|
||||
</List>
|
||||
</Alert>
|
||||
)}
|
||||
</>
|
||||
)}
|
||||
</>
|
||||
)}
|
||||
</Stack>
|
||||
);
|
||||
};
|
||||
@@ -0,0 +1,48 @@
|
||||
"use client";
|
||||
|
||||
import { List, Text } from "@mantine/core";
|
||||
|
||||
import type { ConfigEntityCounts } from "@homarr/board-portability";
|
||||
|
||||
const countLabelKeys: Record<keyof ConfigEntityCounts, string> = {
|
||||
boards: "management.page.importExport.summary.boards",
|
||||
apps: "management.page.importExport.summary.apps",
|
||||
integrations: "management.page.importExport.summary.integrations",
|
||||
secrets: "management.page.importExport.summary.secrets",
|
||||
widgets: "management.page.importExport.summary.widgets",
|
||||
sections: "management.page.importExport.summary.sections",
|
||||
layouts: "management.page.importExport.summary.layouts",
|
||||
searchEngines: "management.page.importExport.summary.searchEngines",
|
||||
groups: "management.page.importExport.summary.groups",
|
||||
serverSettings: "management.page.importExport.summary.serverSettings",
|
||||
};
|
||||
|
||||
const countEntries = (counts: ConfigEntityCounts) =>
|
||||
(Object.keys(countLabelKeys) as (keyof ConfigEntityCounts)[]).filter((key) => counts[key] > 0);
|
||||
|
||||
type ConfigSummaryListProps = {
|
||||
counts: ConfigEntityCounts;
|
||||
t: (key: string, values?: Record<string, unknown>) => string;
|
||||
};
|
||||
|
||||
export const ConfigSummaryList = ({ counts, t }: ConfigSummaryListProps) => {
|
||||
const entries = countEntries(counts);
|
||||
|
||||
if (entries.length === 0) {
|
||||
return (
|
||||
<Text size="sm" c="dimmed">
|
||||
{t("management.page.importExport.summary.empty")}
|
||||
</Text>
|
||||
);
|
||||
}
|
||||
|
||||
return (
|
||||
<List size="sm" spacing={4}>
|
||||
{entries.map((key) => (
|
||||
<List.Item key={key}>
|
||||
{t(countLabelKeys[key], { count: counts[key] })}
|
||||
</List.Item>
|
||||
))}
|
||||
</List>
|
||||
);
|
||||
};
|
||||
Reference in new issue
Block a user