Compare commits

..

1 Commits

Author SHA1 Message Date
dependabot[bot]
7d78a99bc2 Chore(deps): Bump actions/checkout from 5 to 6
Bumps [actions/checkout](https://github.com/actions/checkout) from 5 to 6.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/v5...v6)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: '6'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-11-23 03:45:46 +00:00
9 changed files with 40 additions and 123 deletions

View File

@@ -38,4 +38,3 @@ What type of change does your PR introduce to Homepage?
- [ ] If applicable, I have reviewed the [feature / enhancement](https://gethomepage.dev/more/development/#new-feature-guidelines) and / or [service widget guidelines](https://gethomepage.dev/more/development/#service-widget-guidelines). - [ ] If applicable, I have reviewed the [feature / enhancement](https://gethomepage.dev/more/development/#new-feature-guidelines) and / or [service widget guidelines](https://gethomepage.dev/more/development/#service-widget-guidelines).
- [ ] I have checked that all code style checks pass using [pre-commit hooks](https://gethomepage.dev/more/development/#code-formatting-with-pre-commit-hooks) and [linting checks](https://gethomepage.dev/more/development/#code-linting). - [ ] I have checked that all code style checks pass using [pre-commit hooks](https://gethomepage.dev/more/development/#code-formatting-with-pre-commit-hooks) and [linting checks](https://gethomepage.dev/more/development/#code-linting).
- [ ] If applicable, I have tested my code for new features & regressions on both mobile & desktop devices, using the latest version of major browsers. - [ ] If applicable, I have tested my code for new features & regressions on both mobile & desktop devices, using the latest version of major browsers.
- [ ] In the description above I have disclosed the use of AI tools in the coding of this PR.

View File

@@ -14,6 +14,4 @@ widget:
type: frigate type: frigate
url: http://frigate.host.or.ip:port url: http://frigate.host.or.ip:port
enableRecentEvents: true # Optional, defaults to false enableRecentEvents: true # Optional, defaults to false
username: username # optional
password: password # optional
``` ```

View File

@@ -12,17 +12,11 @@ Learn more about [Gluetun](https://github.com/qdm12/gluetun).
Allowed fields: `["public_ip", "region", "country", "port_forwarded"]`. Allowed fields: `["public_ip", "region", "country", "port_forwarded"]`.
Default fields: `["public_ip", "region", "country"]`. Default fields: `["public_ip", "region", "country"]`.
To setup authentication, follow [the official Gluetun documentation](https://github.com/qdm12/gluetun-wiki/blob/main/setup/advanced/control-server.md#authentication). Note that to use the api key method, you must add the route `GET /v1/publicip/ip` to the `routes` array in your Gluetun config.toml. Similarly, if you want to include the `port_forwarded` field, you must add the route `GET /v1/openvpn/portforwarded` (or `/v1/portforward`) to your Gluetun config.toml. To setup authentication, follow [the official Gluetun documentation](https://github.com/qdm12/gluetun-wiki/blob/main/setup/advanced/control-server.md#authentication). Note that to use the api key method, you must add the route `GET /v1/publicip/ip` to the `routes` array in your Gluetun config.toml. Similarly, if you want to include the `port_forwarded` field, you must add the route `GET /v1/openvpn/portforwarded` to your Gluetun config.toml.
| Gluetun Version | Homepage Widget Version |
| --------------- | ----------------------- |
| < 3.40.1 | 1 (default) |
| >= 3.40.1 | 2 |
```yaml ```yaml
widget: widget:
type: gluetun type: gluetun
url: http://gluetun.host.or.ip:port url: http://gluetun.host.or.ip:port
key: gluetunkey # Not required if /v1/publicip/ip endpoint is configured with `auth = none` key: gluetunkey # Not required if /v1/publicip/ip endpoint is configured with `auth = none`
version: 2 # optional, default is 1
``` ```

View File

@@ -563,7 +563,6 @@ export function cleanServiceGroups(groups) {
"speedtest", "speedtest",
"wgeasy", "wgeasy",
"grafana", "grafana",
"gluetun",
].includes(type) ].includes(type)
) { ) {
if (version) widget.version = parseInt(version, 10); if (version) widget.version = parseInt(version, 10);

View File

@@ -1,95 +0,0 @@
import getServiceWidget from "utils/config/service-helpers";
import createLogger from "utils/logger";
import { asJson, formatApiCall, sanitizeErrorURL } from "utils/proxy/api-helpers";
import { addCookieToJar } from "utils/proxy/cookie-jar";
import { httpProxy } from "utils/proxy/http";
import widgets from "widgets/widgets";
const proxyName = "frigateProxyHandler";
const logger = createLogger(proxyName);
export default async function frigateProxyHandler(req, res, map) {
const { group, service, endpoint, index } = req.query;
if (group && service) {
const widget = await getServiceWidget(group, service, index);
if (!widgets?.[widget.type]?.api) {
return res.status(403).json({ error: "Service does not support API calls" });
}
if (widget) {
const url = formatApiCall(widgets[widget.type].api, { endpoint, ...widget });
const params = {
method: "GET",
headers: {
"Content-Type": "application/json",
},
};
let [status, , data] = await httpProxy(url, params);
if (status === 401 && widget.username && widget.password) {
const loginUrl = `${widget.url}/api/login`;
logger.debug("Attempting login to Frigate at %s", loginUrl);
const [loginStatus, , , loginResponseHeaders] = await httpProxy(loginUrl, {
method: "POST",
body: JSON.stringify({ user: widget.username, password: widget.password }),
headers: {
"Content-Type": "application/json",
},
});
if (loginStatus !== 200) {
logger.error("HTTP Error %d calling %s", loginStatus, sanitizeErrorURL(loginUrl));
return res.status(status).json({
error: {
message: `HTTP Error ${status} while trying to login to Frigate`,
url: sanitizeErrorURL(url),
},
});
}
addCookieToJar(url, loginResponseHeaders);
// Retry original request with cookie set
[status, , data] = await httpProxy(url, params);
}
if (status >= 400) {
logger.error("HTTP Error %d calling %s", status, sanitizeErrorURL(url));
return res.status(status).json({
error: {
message: `HTTP Error ${status} from Frigate`,
url: sanitizeErrorURL(url),
},
});
}
data = asJson(data);
if (endpoint == "stats") {
res.status(status).send({
num_cameras: data?.cameras !== undefined ? Object.keys(data?.cameras).length : 0,
uptime: data?.service?.uptime,
version: data?.service.version,
});
} else if (endpoint == "events") {
return res.status(status).send(
data.slice(0, 5).map((event) => ({
id: event.id,
camera: event.camera,
label: event.label,
start_time: new Date(event.start_time * 1000),
thumbnail: event.thumbnail,
score: event.data.score,
type: event.data.type,
})),
);
}
}
}
logger.debug("Invalid or missing proxy service type '%s' in group '%s'", service, group);
return res.status(400).json({ error: "Invalid proxy service type" });
}

View File

@@ -1,12 +1,37 @@
import frigateProxyHandler from "./proxy"; import { asJson } from "utils/proxy/api-helpers";
import genericProxyHandler from "utils/proxy/handlers/generic";
const widget = { const widget = {
api: "{url}/api/{endpoint}", api: "{url}/api/{endpoint}",
proxyHandler: frigateProxyHandler, proxyHandler: genericProxyHandler,
mappings: { mappings: {
stats: { endpoint: "stats" }, stats: {
events: { endpoint: "events" }, endpoint: "stats",
map: (data) => {
const jsonData = asJson(data);
return {
num_cameras: jsonData?.cameras !== undefined ? Object.keys(jsonData?.cameras).length : 0,
uptime: jsonData?.service?.uptime,
version: jsonData?.service.version,
};
},
},
events: {
endpoint: "events",
map: (data) =>
asJson(data)
.slice(0, 5)
.map((event) => ({
id: event.id,
camera: event.camera,
label: event.label,
start_time: new Date(event.start_time * 1000),
thumbnail: event.thumbnail,
score: event.data.score,
type: event.data.type,
})),
},
}, },
}; };

View File

@@ -12,8 +12,10 @@ export default function Component({ service }) {
const { data: gluetunData, error: gluetunError } = useWidgetAPI(widget, "ip"); const { data: gluetunData, error: gluetunError } = useWidgetAPI(widget, "ip");
const includePF = widget.fields.includes("port_forwarded"); const includePF = widget.fields.includes("port_forwarded");
const pfEndpoint = widget.version > 1 ? "port_forwarded_v2" : "port_forwarded"; const { data: portForwardedData, error: portForwardedError } = useWidgetAPI(
const { data: portForwardedData, error: portForwardedError } = useWidgetAPI(widget, includePF ? pfEndpoint : ""); widget,
includePF ? "port_forwarded" : "",
);
if (gluetunError || (includePF && portForwardedError)) { if (gluetunError || (includePF && portForwardedError)) {
return <Container service={service} error={gluetunError || portForwardedError} />; return <Container service={service} error={gluetunError || portForwardedError} />;

View File

@@ -13,10 +13,6 @@ const widget = {
endpoint: "openvpn/portforwarded", endpoint: "openvpn/portforwarded",
validate: ["port"], validate: ["port"],
}, },
port_forwarded_v2: {
endpoint: "portforward",
validate: ["port"],
},
}, },
}; };

View File

@@ -38,13 +38,12 @@ export default function Component({ service }) {
if (Array.isArray(statusData.volume.volumeUseList.volumeUse)) { if (Array.isArray(statusData.volume.volumeUseList.volumeUse)) {
if (widget.volume) { if (widget.volume) {
const volumeSelected = statusData.volume.volumeList.volume.find((vl) => vl.volumeLabel._cdata === widget.volume); const volumeSelected = statusData.volume.volumeList.volume.findIndex(
if (volumeSelected) { (vl) => vl.volumeLabel._cdata === widget.volume,
const volumeUsed = statusData.volume.volumeUseList.volumeUse.find( );
(vu) => vu.volumeValue._cdata === volumeSelected.volumeValue._cdata, if (volumeSelected !== -1) {
); volumeTotalSize = statusData.volume.volumeUseList.volumeUse[volumeSelected].total_size._cdata;
volumeTotalSize = volumeUsed.total_size._cdata; volumeFreeSize = statusData.volume.volumeUseList.volumeUse[volumeSelected].free_size._cdata;
volumeFreeSize = volumeUsed.free_size._cdata;
} else { } else {
validVolume = false; validVolume = false;
} }