2025-10-01 15:39:43 +03:00
|
|
|
{
|
2026-01-28 02:10:29 +03:00
|
|
|
"label": "Proxy",
|
2026-01-24 17:54:56 +03:00
|
|
|
"description": "Settings for integrating Frigate behind a reverse proxy that passes authenticated user headers.",
|
2026-01-23 18:55:56 +03:00
|
|
|
"header_map": {
|
2026-01-29 18:43:43 +03:00
|
|
|
"label": "Header mapping",
|
2026-01-24 17:54:56 +03:00
|
|
|
"description": "Map incoming proxy headers to Frigate user and role fields for proxy-based auth.",
|
2026-01-23 18:55:56 +03:00
|
|
|
"user": {
|
2026-01-29 18:43:43 +03:00
|
|
|
"label": "User header",
|
2026-01-24 17:54:56 +03:00
|
|
|
"description": "Header containing the authenticated username provided by the upstream proxy."
|
2025-10-01 15:39:43 +03:00
|
|
|
},
|
2026-01-23 18:55:56 +03:00
|
|
|
"role": {
|
2026-01-29 18:43:43 +03:00
|
|
|
"label": "Role header",
|
2026-01-24 17:54:56 +03:00
|
|
|
"description": "Header containing the authenticated user's role or groups from the upstream proxy."
|
2025-10-01 15:39:43 +03:00
|
|
|
},
|
2026-01-23 18:55:56 +03:00
|
|
|
"role_map": {
|
2026-01-29 18:43:43 +03:00
|
|
|
"label": "Role mapping",
|
2026-01-24 17:54:56 +03:00
|
|
|
"description": "Map upstream group values to Frigate roles (for example map admin groups to the admin role)."
|
2025-10-01 15:39:43 +03:00
|
|
|
}
|
2026-01-23 18:55:56 +03:00
|
|
|
},
|
|
|
|
|
"logout_url": {
|
2026-01-29 18:43:43 +03:00
|
|
|
"label": "Logout URL",
|
2026-01-24 17:54:56 +03:00
|
|
|
"description": "URL to redirect users to when logging out via the proxy."
|
2026-01-23 18:55:56 +03:00
|
|
|
},
|
|
|
|
|
"auth_secret": {
|
2026-01-29 18:43:43 +03:00
|
|
|
"label": "Proxy secret",
|
2026-01-24 17:54:56 +03:00
|
|
|
"description": "Optional secret checked against the X-Proxy-Secret header to verify trusted proxies."
|
2026-01-23 18:55:56 +03:00
|
|
|
},
|
|
|
|
|
"default_role": {
|
2026-01-29 18:43:43 +03:00
|
|
|
"label": "Default role",
|
2026-01-24 17:54:56 +03:00
|
|
|
"description": "Default role assigned to proxy-authenticated users when no role mapping applies (admin or viewer)."
|
2026-01-23 18:55:56 +03:00
|
|
|
},
|
|
|
|
|
"separator": {
|
2026-01-29 18:43:43 +03:00
|
|
|
"label": "Separator character",
|
|
|
|
|
"description": "Character used to split multiple values provided in proxy headers."
|
2025-10-01 15:39:43 +03:00
|
|
|
}
|
2026-01-24 17:54:56 +03:00
|
|
|
}
|