frigate/web/src/components/setup/SetupComplete.tsx
Josh Hawkins bb1e556ba9 Add onboarding wizard for new installations (#24102)
* add onboarding wizard for new users

* resolve hwaccel per camera and clarify recording retention

The hwaccel step listed every preset Frigate ships, so an Intel box was offered Raspberry Pi and Rockchip decoding, and the codec specific presets (`preset-intel-qsv-h264` vs `-h265`) were offered as global values that break as soon as two cameras use different codecs. `/hardware/hwaccel` now returns the decoding families the probed hardware can actually use, each carrying a preset per codec, and the wizard resolves the family against the detect stream codec the camera wizard already probed: one global `ffmpeg.hwaccel_args` when every camera agrees, per-camera `cameras.<name>.ffmpeg.hwaccel_args` when they don't. The global stays on `auto` in that case so cameras added later still resolve at startup. A gen13+ Intel machine keeps its QuickSync recommendation with mixed h264 and h265 cameras instead of dropping to vaapi.

The recording step's "Days to retain recordings" only wrote alert and detection retention, and the storage estimate under it assumed continuous recording. It now asks what to record in plain language, writes `record.continuous.days` to match, shows the estimate only for continuous, and drops the spinner arrows on the number input.

* clean up

* add light/dark mode icon switcher

* use yml as default config file extension when not found

* i18n tweaks

* gate the setup wizard on cameras instead of a config key

* render setup wizard steps by key

* share the setup wizard e2e helpers and mock users

* add an account step to the setup wizard

* add setup wizard account step e2e coverage

* cover the account step's restart behavior

* button consistency

* fix test

* docs

* fixes
2026-08-27 20:30:36 -05:00

210 lines
5.7 KiB
TypeScript

import Logo from "@/components/Logo";
import ActivityIndicator from "@/components/indicators/activity-indicator";
import { Button } from "@/components/ui/button";
import { useCallback, useEffect, useRef, useState } from "react";
import { useTranslation } from "react-i18next";
import { toast } from "sonner";
import axios from "axios";
import { FaCircleCheck } from "react-icons/fa6";
import { dismissSetup } from "@/utils/setupWizard";
type ConfiguredItem = {
key: string;
label: string;
value: string | null;
};
type SetupCompleteProps = {
cameraNames: string[];
configuredSteps: {
camera: boolean;
hwaccel: boolean;
detector: boolean;
recording: boolean;
};
restartRequired: boolean;
onBack: () => void;
};
export default function SetupComplete({
cameraNames,
configuredSteps,
restartRequired,
onBack,
}: SetupCompleteProps) {
const { t } = useTranslation(["views/setup"]);
const [restarting, setRestarting] = useState(false);
const [finishing, setFinishing] = useState(false);
const pollRef = useRef<ReturnType<typeof setInterval> | null>(null);
const cameraItems: ConfiguredItem[] =
configuredSteps.camera && cameraNames.length > 0
? cameraNames.map((name) => ({
key: `camera-${name}`,
label: t("setupWizard.complete.camera"),
value: name,
}))
: [
{
key: "camera",
label: t("setupWizard.complete.camera"),
value: null,
},
];
const items: ConfiguredItem[] = [
...cameraItems,
{
key: "hwaccel",
label: t("setupWizard.complete.hwaccel"),
value: configuredSteps.hwaccel
? t("setupWizard.complete.configured")
: null,
},
{
key: "detector",
label: t("setupWizard.complete.detector"),
value: configuredSteps.detector
? t("setupWizard.complete.configured")
: null,
},
{
key: "recording",
label: t("setupWizard.complete.recording"),
value: configuredSteps.recording
? t("setupWizard.complete.configured")
: null,
},
];
useEffect(() => {
return () => {
if (pollRef.current) {
clearInterval(pollRef.current);
}
};
}, []);
const handleFinish = useCallback(async () => {
setFinishing(true);
dismissSetup();
try {
// camera adds were applied live, so nothing is waiting on a restart
if (!restartRequired) {
window.location.href = window.baseUrl || "/";
return;
}
setRestarting(true);
await axios.post("restart");
let retries = 0;
const maxRetries = 60; // 2 minutes max
pollRef.current = setInterval(async () => {
retries++;
if (retries > maxRetries) {
if (pollRef.current) {
clearInterval(pollRef.current);
}
window.location.href = window.baseUrl || "/";
return;
}
try {
const resp = await axios.get("version", { timeout: 2000 });
if (resp.status === 200) {
if (pollRef.current) {
clearInterval(pollRef.current);
}
window.location.href = window.baseUrl || "/";
}
} catch {
// not back yet
}
}, 2000);
} catch {
setRestarting(false);
setFinishing(false);
toast.error(t("setupWizard.errors.saveFailed"));
}
}, [restartRequired, t]);
if (restarting) {
return (
<div className="flex flex-col items-center gap-6 py-12">
<Logo className="h-12 w-12" />
<ActivityIndicator />
<div className="text-center">
<p className="font-semibold">
{t("setupWizard.complete.restarting")}
</p>
<p className="mt-1 text-sm text-muted-foreground">
{t("setupWizard.complete.restartingDescription")}
</p>
</div>
</div>
);
}
return (
<div className="flex flex-col gap-4 py-4">
<div>
<h2 className="text-xl font-semibold">
{t("setupWizard.complete.title")}
</h2>
<p className="mt-1 text-sm text-muted-foreground">
{t("setupWizard.complete.description")}
</p>
</div>
<div className="flex flex-col gap-2">
{items.map((item) => (
<div
key={item.key}
className="flex items-center justify-between rounded-md border p-3"
>
<span className="text-sm font-medium">{item.label}</span>
<div className="flex items-center gap-2">
{item.value && <FaCircleCheck className="size-4 text-success" />}
<span
className={`text-sm ${item.value ? "" : "text-muted-foreground"}`}
>
{item.value ?? t("setupWizard.complete.notConfigured")}
</span>
</div>
</div>
))}
</div>
<p className="text-sm text-muted-foreground">
{t("setupWizard.complete.nextSteps")}
</p>
{restartRequired && (
<p className="rounded-md bg-muted p-3 text-sm text-muted-foreground">
{t("setupWizard.complete.restartNotice")}
</p>
)}
<div className="flex flex-col gap-3 pt-6 sm:flex-row sm:justify-end sm:gap-4">
<Button type="button" onClick={onBack}>
{t("setupWizard.actions.back")}
</Button>
<div className="flex flex-1 justify-end">
<Button
type="button"
variant="select"
onClick={handleFinish}
disabled={finishing}
>
{restartRequired
? t("setupWizard.complete.applyAndRestart")
: t("setupWizard.complete.goToLiveView")}
</Button>
</div>
</div>
</div>
);
}