mirror of
https://github.com/blakeblackshear/frigate.git
synced 2026-05-01 19:17:41 +03:00
docs: remove 5000 port tips
This commit is contained in:
parent
39f9491971
commit
6cc4db1103
@ -32,12 +32,12 @@ function renderHelpText(text: string): React.ReactNode {
|
||||
export default function DockerComposeGenerator() {
|
||||
const {
|
||||
deviceId, device, hardwareEnabled,
|
||||
portEnabled, port5000Confirmed,
|
||||
portEnabled,
|
||||
nvidiaGpuCount, nvidiaGpuDeviceId,
|
||||
configPath, mediaPath, rtspPassword, timezone, shmSize,
|
||||
shmSizeError, gpuDeviceIdError, configPathError, mediaPathError,
|
||||
hasAnyHardware, generatedYaml,
|
||||
selectDevice, toggleHardware, togglePort, setPort5000Confirmed,
|
||||
selectDevice, toggleHardware, togglePort,
|
||||
handleShmSizeChange, handleConfigPathChange, handleMediaPathChange,
|
||||
handleNvidiaGpuCountChange, handleNvidiaGpuDeviceIdChange,
|
||||
setRtspPassword, setTimezone, isHardwareDisabled,
|
||||
@ -82,9 +82,7 @@ export default function DockerComposeGenerator() {
|
||||
|
||||
<PortConfigSection
|
||||
portEnabled={portEnabled}
|
||||
port5000Confirmed={port5000Confirmed}
|
||||
onTogglePort={togglePort}
|
||||
onConfirm5000={setPort5000Confirmed}
|
||||
/>
|
||||
|
||||
<OtherOptions
|
||||
|
||||
@ -1,103 +1,34 @@
|
||||
import React from "react";
|
||||
import Admonition from "@theme/Admonition";
|
||||
import { ports } from "../config";
|
||||
import { useCooldown } from "../hooks/useCooldown";
|
||||
import styles from "../styles.module.css";
|
||||
|
||||
interface Props {
|
||||
portEnabled: Record<string, boolean>;
|
||||
port5000Confirmed: boolean;
|
||||
onTogglePort: (portId: string) => void;
|
||||
onConfirm5000: (confirmed: boolean) => void;
|
||||
}
|
||||
|
||||
function Port5000Confirmation({
|
||||
portEnabled,
|
||||
confirmed,
|
||||
function PortItem({
|
||||
port,
|
||||
enabled,
|
||||
onToggle,
|
||||
onConfirm,
|
||||
}: {
|
||||
portEnabled: boolean;
|
||||
confirmed: boolean;
|
||||
port: typeof ports[number];
|
||||
enabled: boolean;
|
||||
onToggle: () => void;
|
||||
onConfirm: (confirmed: boolean) => void;
|
||||
}) {
|
||||
const { remaining, start, stop } = useCooldown(10);
|
||||
|
||||
React.useEffect(() => {
|
||||
if (portEnabled) {
|
||||
start();
|
||||
} else {
|
||||
stop();
|
||||
onConfirm(false);
|
||||
}
|
||||
return stop;
|
||||
}, [portEnabled]);
|
||||
|
||||
return (
|
||||
<div className={styles.portSection}>
|
||||
{portEnabled && (
|
||||
<Admonition type="danger">
|
||||
<p>
|
||||
Exposing port 5000 allows <strong>unauthenticated access</strong> to
|
||||
your Frigate instance. Anyone on your network (or the internet if you
|
||||
have a public IP) could access it without credentials.
|
||||
</p>
|
||||
<p>
|
||||
This may lead to <strong>unauthorized access</strong>,{" "}
|
||||
<strong>privacy leaks</strong>, or further attacks. Ensure you have
|
||||
proper firewall rules or VPN in place.
|
||||
</p>
|
||||
<label
|
||||
className={`${styles.checkboxLabel} ${remaining > 0 ? styles.checkboxDisabled : ""}`}
|
||||
>
|
||||
<input
|
||||
type="checkbox"
|
||||
checked={confirmed}
|
||||
onChange={(e) => onConfirm(e.target.checked)}
|
||||
disabled={remaining > 0}
|
||||
/>
|
||||
<span>
|
||||
I understand the risk and confirm enabling port 5000
|
||||
{remaining > 0 && ` (${remaining}s)`}
|
||||
</span>
|
||||
</label>
|
||||
</Admonition>
|
||||
)}
|
||||
<label className={styles.checkboxLabel}>
|
||||
<input
|
||||
type="checkbox"
|
||||
checked={portEnabled}
|
||||
onChange={onToggle}
|
||||
/>
|
||||
<span>Port 5000 (unauthenticated access)</span>
|
||||
<span className={styles.warningBadge}>⚠️ Expose carefully</span>
|
||||
</label>
|
||||
</div>
|
||||
const showWarning = port.warningContent && (
|
||||
port.warningWhen === "checked" ? enabled :
|
||||
port.warningWhen === "unchecked" ? !enabled : enabled
|
||||
);
|
||||
}
|
||||
|
||||
export default function PortConfigSection({
|
||||
portEnabled,
|
||||
port5000Confirmed,
|
||||
onTogglePort,
|
||||
onConfirm5000,
|
||||
}: Props) {
|
||||
return (
|
||||
<div className={styles.formSection}>
|
||||
<h4>Port Configuration</h4>
|
||||
|
||||
{/* All ports except 5000 */}
|
||||
<div className={styles.checkboxGrid}>
|
||||
{ports
|
||||
.filter((p) => p.id !== "5000")
|
||||
.map((port) => (
|
||||
<div key={port.id} className={styles.hardwareItem}>
|
||||
<div className={styles.hardwareItem}>
|
||||
<label className={`${styles.checkboxLabel} ${port.locked ? styles.checkboxDisabled : ""}`}>
|
||||
<input
|
||||
type="checkbox"
|
||||
checked={!!portEnabled[port.id]}
|
||||
onChange={() => onTogglePort(port.id)}
|
||||
checked={enabled}
|
||||
onChange={onToggle}
|
||||
disabled={port.locked}
|
||||
/>
|
||||
<span>
|
||||
@ -109,17 +40,32 @@ export default function PortConfigSection({
|
||||
{port.description && (
|
||||
<div className={styles.hardwareDescription}>{port.description}</div>
|
||||
)}
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
|
||||
{/* Port 5000 with special warning — placed last */}
|
||||
<Port5000Confirmation
|
||||
portEnabled={!!portEnabled["5000"]}
|
||||
confirmed={port5000Confirmed}
|
||||
onToggle={() => onTogglePort("5000")}
|
||||
onConfirm={onConfirm5000}
|
||||
/>
|
||||
{showWarning && (
|
||||
<Admonition type={port.warningType || "warning"}>
|
||||
{port.warningContent}
|
||||
</Admonition>
|
||||
)}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
export default function PortConfigSection({
|
||||
portEnabled,
|
||||
onTogglePort,
|
||||
}: Props) {
|
||||
return (
|
||||
<div className={styles.formSection}>
|
||||
<h4>Port Configuration</h4>
|
||||
<div className={styles.checkboxGrid}>
|
||||
{ports.map((port) => (
|
||||
<PortItem
|
||||
key={port.id}
|
||||
port={port}
|
||||
enabled={!!portEnabled[port.id]}
|
||||
onToggle={() => onTogglePort(port.id)}
|
||||
/>
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
@ -265,7 +265,8 @@ ports:
|
||||
protocol: "tcp"
|
||||
description: "Authenticated UI and API access (default HTTPS)"
|
||||
defaultEnabled: true
|
||||
locked: true
|
||||
warningContent: "This is the access port for Frigate. Closing it means you will no longer be able to access the instance."
|
||||
warningWhen: "unchecked"
|
||||
|
||||
- id: "8554"
|
||||
host: 8554
|
||||
|
||||
@ -145,14 +145,10 @@ export interface PortConfig {
|
||||
defaultEnabled: boolean;
|
||||
/** Whether this port is locked (always enabled, cannot be toggled off) */
|
||||
locked?: boolean;
|
||||
/** Whether this port requires a confirmation step before enabling */
|
||||
requiresConfirmation?: boolean;
|
||||
/** Admonition type for the warning */
|
||||
warningType?: "warning" | "danger";
|
||||
/** Warning content (markdown) */
|
||||
warningContent?: string;
|
||||
/** Confirmation checkbox label */
|
||||
confirmationLabel?: string;
|
||||
/** Cooldown in seconds before the confirmation checkbox becomes available */
|
||||
cooldownSeconds?: number;
|
||||
/** When to show the warning: when the port is checked or unchecked */
|
||||
warningWhen?: "checked" | "unchecked";
|
||||
}
|
||||
|
||||
@ -29,7 +29,6 @@ export function useConfigGenerator() {
|
||||
return initial;
|
||||
});
|
||||
|
||||
const [port5000Confirmed, setPort5000Confirmed] = useState(false);
|
||||
const [nvidiaGpuCount, setNvidiaGpuCount] = useState("all");
|
||||
const [nvidiaGpuDeviceId, setNvidiaGpuDeviceId] = useState("");
|
||||
const [configPath, setConfigPath] = useState("");
|
||||
@ -69,13 +68,7 @@ export function useConfigGenerator() {
|
||||
const togglePort = useCallback((portId: string) => {
|
||||
const port = portMap.get(portId);
|
||||
if (port?.locked) return;
|
||||
setPortEnabled((prev) => {
|
||||
const next = { ...prev, [portId]: !prev[portId] };
|
||||
if (portId === "5000" && !next[portId]) {
|
||||
setPort5000Confirmed(false);
|
||||
}
|
||||
return next;
|
||||
});
|
||||
setPortEnabled((prev) => ({ ...prev, [portId]: !prev[portId] }));
|
||||
}, []);
|
||||
|
||||
const isHardwareDisabled = useCallback(
|
||||
@ -149,7 +142,6 @@ export function useConfigGenerator() {
|
||||
const lines: string[] = [];
|
||||
for (const [id, enabled] of Object.entries(portEnabled)) {
|
||||
if (!enabled) continue;
|
||||
if (id === "5000" && !port5000Confirmed) continue;
|
||||
const p = portMap.get(id);
|
||||
if (!p) continue;
|
||||
const proto = p.protocol && p.protocol !== "tcp" ? `/${p.protocol}` : "";
|
||||
@ -157,7 +149,7 @@ export function useConfigGenerator() {
|
||||
lines.push(` - "${p.host}:${p.container}${proto}"${comment}`);
|
||||
}
|
||||
return lines;
|
||||
}, [portEnabled, port5000Confirmed]);
|
||||
}, [portEnabled]);
|
||||
|
||||
const selectedHardwareIds = useMemo(() => {
|
||||
return Object.entries(hardwareEnabled)
|
||||
@ -195,11 +187,11 @@ export function useConfigGenerator() {
|
||||
|
||||
return {
|
||||
deviceId, device, hardwareEnabled, portEnabled,
|
||||
port5000Confirmed, nvidiaGpuCount, nvidiaGpuDeviceId,
|
||||
nvidiaGpuCount, nvidiaGpuDeviceId,
|
||||
configPath, mediaPath, rtspPassword, timezone, shmSize,
|
||||
shmSizeError, gpuDeviceIdError, configPathError, mediaPathError,
|
||||
hasAnyHardware, generatedYaml,
|
||||
selectDevice, toggleHardware, togglePort, setPort5000Confirmed,
|
||||
selectDevice, toggleHardware, togglePort,
|
||||
handleShmSizeChange, handleConfigPathChange, handleMediaPathChange,
|
||||
handleNvidiaGpuCountChange, handleNvidiaGpuDeviceIdChange,
|
||||
setRtspPassword, setTimezone, isHardwareDisabled,
|
||||
|
||||
@ -1,42 +0,0 @@
|
||||
import { useState, useEffect, useCallback, useRef } from "react";
|
||||
|
||||
/**
|
||||
* Hook for a countdown timer (e.g. cooldown before confirming port 5000).
|
||||
*/
|
||||
export function useCooldown(initialSeconds: number) {
|
||||
const [remaining, setRemaining] = useState(0);
|
||||
const timerRef = useRef<ReturnType<typeof setInterval> | null>(null);
|
||||
|
||||
const start = useCallback(() => {
|
||||
// Clear any existing timer
|
||||
if (timerRef.current) clearInterval(timerRef.current);
|
||||
setRemaining(initialSeconds);
|
||||
timerRef.current = setInterval(() => {
|
||||
setRemaining((prev) => {
|
||||
if (prev <= 1) {
|
||||
if (timerRef.current) clearInterval(timerRef.current);
|
||||
timerRef.current = null;
|
||||
return 0;
|
||||
}
|
||||
return prev - 1;
|
||||
});
|
||||
}, 1000);
|
||||
}, [initialSeconds]);
|
||||
|
||||
const stop = useCallback(() => {
|
||||
if (timerRef.current) {
|
||||
clearInterval(timerRef.current);
|
||||
timerRef.current = null;
|
||||
}
|
||||
setRemaining(0);
|
||||
}, []);
|
||||
|
||||
// Cleanup on unmount
|
||||
useEffect(() => {
|
||||
return () => {
|
||||
if (timerRef.current) clearInterval(timerRef.current);
|
||||
};
|
||||
}, []);
|
||||
|
||||
return { remaining, start, stop };
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user