Compare commits

...
9 Commits
Author SHA1 Message Date
shamoon 51cc1684f9 2.6.0
Docs / Test Build Docs (push) Waiting to run
Docs / Build & Deploy Docs (push) Waiting to run
Docker CI / Docker Build & Push (push) Waiting to run
Lint / Linting Checks (push) Waiting to run
Release Drafter / Update Release Draft (push) Waiting to run
Release Drafter / Auto Label PR (push) Waiting to run
Tests / vitest (1) (push) Waiting to run
Tests / vitest (2) (push) Waiting to run
Tests / vitest (3) (push) Waiting to run
Tests / vitest (4) (push) Waiting to run
2026-10-16 22:26:12 -07:00
github-actions[bot]andCrowdin Bot 8a97e38393 New Crowdin translations by GitHub Action (#7241)
Co-authored-by: Crowdin Bot <support+bot@crowdin.com>
2026-10-16 22:25:18 -07:00
shamoon 9628256887 Refactor: auth architecture (#7256) 2026-10-16 22:09:09 -07:00
dependabot[bot] 89b0d20655 Chore(deps): Bump release-drafter/release-drafter/autolabeler from 7.8.0 to 7.10.0 (#7248)
Docker CI / Docker Build & Push (push) Canceled after 0s
Lint / Linting Checks (push) Canceled after 0s
Release Drafter / Update Release Draft (push) Canceled after 0s
Release Drafter / Auto Label PR (push) Canceled after 0s
Tests / vitest (1) (push) Canceled after 0s
Tests / vitest (2) (push) Canceled after 0s
Tests / vitest (3) (push) Canceled after 0s
Tests / vitest (4) (push) Canceled after 0s
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-10-15 18:39:43 +00:00
dependabot[bot] d20a5c5322 Chore(deps): Bump release-drafter/release-drafter from 7.8.0 to 7.10.0 (#7250)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-10-15 18:32:18 +00:00
dependabot[bot] 84721f2769 Chore(deps): Bump actions/setup-node from 7.0.0 to 7.1.0 (#7249)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-10-15 11:25:12 -07:00
Mustafa 11ca29104a Chore: send Gitea/Forgejo API key as Authorization header (#7245)
Docker CI / Docker Build & Push (push) Canceled after 0s
Lint / Linting Checks (push) Canceled after 0s
Release Drafter / Update Release Draft (push) Canceled after 0s
Release Drafter / Auto Label PR (push) Canceled after 0s
Tests / vitest (1) (push) Canceled after 0s
Tests / vitest (2) (push) Canceled after 0s
Tests / vitest (3) (push) Canceled after 0s
Tests / vitest (4) (push) Canceled after 0s
2026-10-14 16:29:58 -07:00
Anirudh SharmaandCodex 6bf81a78f3 Fix: preserve dollar sequences in environment and file secrets (#7242)
Docker CI / Docker Build & Push (push) Canceled after 0s
Lint / Linting Checks (push) Canceled after 0s
Release Drafter / Update Release Draft (push) Canceled after 0s
Release Drafter / Auto Label PR (push) Canceled after 0s
Tests / vitest (1) (push) Canceled after 0s
Tests / vitest (2) (push) Canceled after 0s
Tests / vitest (3) (push) Canceled after 0s
Tests / vitest (4) (push) Canceled after 0s
Co-authored-by: Codex <codex@openai.com>
2026-10-13 06:44:40 -07:00
shamoon 4a38eea1b0 Fix api page tests creating routes
Docker CI / Docker Build & Push (push) Canceled after 0s
Lint / Linting Checks (push) Canceled after 0s
Release Drafter / Update Release Draft (push) Canceled after 0s
Release Drafter / Auto Label PR (push) Canceled after 0s
Tests / vitest (1) (push) Canceled after 0s
Tests / vitest (2) (push) Canceled after 0s
Tests / vitest (3) (push) Canceled after 0s
Tests / vitest (4) (push) Canceled after 0s
2026-10-10 23:12:49 -07:00
66 changed files with 782 additions and 190 deletions
+1 -1
View File
@@ -68,7 +68,7 @@ jobs:
run_install: false
- name: Setup Node.js
uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v6
uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v6
with:
node-version: 24
cache: 'pnpm'
+1 -1
View File
@@ -32,7 +32,7 @@ jobs:
run_install: false
- name: Setup Node.js
uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v6
uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v6
with:
node-version: 24
cache: 'pnpm'
+3 -3
View File
@@ -26,14 +26,14 @@ jobs:
runs-on: ubuntu-latest
steps:
- if: github.event_name == 'workflow_dispatch' && github.event.inputs.version != ''
uses: release-drafter/release-drafter@c345907820e0396f6f44bcfd9ac4763325f8feb0 # v7
uses: release-drafter/release-drafter@978bb0b30c5ee8cdd332ced253758157150d43f0 # v7
with:
config-name: release-drafter.yml
version: ${{ github.event.inputs.version }}
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- if: github.event_name != 'workflow_dispatch' || github.event.inputs.version == ''
uses: release-drafter/release-drafter@c345907820e0396f6f44bcfd9ac4763325f8feb0 # v7
uses: release-drafter/release-drafter@978bb0b30c5ee8cdd332ced253758157150d43f0 # v7
with:
config-name: release-drafter.yml
env:
@@ -47,7 +47,7 @@ jobs:
pull-requests: write
runs-on: ubuntu-latest
steps:
- uses: release-drafter/release-drafter/autolabeler@c345907820e0396f6f44bcfd9ac4763325f8feb0
- uses: release-drafter/release-drafter/autolabeler@978bb0b30c5ee8cdd332ced253758157150d43f0
with:
config-name: release-drafter.yml
env:
+1 -1
View File
@@ -22,7 +22,7 @@ jobs:
with:
version: 9
- uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v6
- uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v6
with:
node-version: 24
cache: pnpm
+2 -2
View File
@@ -6,7 +6,7 @@
</p>
<p align="center">
A modern, <em>fully static, fast</em>, secure <em>fully proxied</em>, highly customizable application dashboard with integrations for over 100 services and translations into multiple languages. Easily configured via YAML files or through docker label discovery.
A modern, <em>fast</em>, secure <em>fully proxied</em>, highly customizable application dashboard with integrations for over 100 services and translations into multiple languages. Easily configured via YAML files or through docker label discovery.
</p>
<p align="center">
@@ -31,7 +31,7 @@
With features like quick search, bookmarks, weather support, a wide range of integrations and widgets, an elegant and modern design, and a focus on performance, Homepage is your ideal start to the day and a handy companion throughout it.
- **Fast** - The site is statically generated at build time for instant load times.
- **Fast** - Cached dashboard data and optimized assets keep page loads quick.
- **Secure** - All API requests to backend services are proxied, keeping your API keys hidden. Constantly reviewed for security by the community.
- **For Everyone** - Images built for AMD64, ARM64.
- **Full i18n** - Support for over 40 languages.
+2 -2
View File
@@ -3,7 +3,7 @@ title: Settings
description: Service Configuration
---
The `settings.yaml` file allows you to define application level options. For changes made to this file to take effect, you will need to regenerate the static HTML, this can be done by clicking the refresh icon in the bottom right of the page.
The `settings.yaml` file allows you to define application level options. After making changes, click the refresh icon in the bottom right of the page to clear the cached dashboard data and reload the page.
## Title
@@ -33,7 +33,7 @@ startUrl: https://custom.url
!!! warning "Heads Up!"
You will need to restart the container any time you add new images, this is a limitation of the Next.js static site server.
You will need to restart the container any time you add new local images so the server can discover them.
!!! warning "Heads Up!"
+2 -2
View File
@@ -1,6 +1,6 @@
---
title: Home
description: A modern, fully static, fast, secure, fully proxied, highly customizable application dashboard with integrations for over 100 services and translations into multiple languages.
description: A modern, fast, secure, fully proxied, highly customizable application dashboard with integrations for over 100 services and translations into multiple languages.
icon: material/home
hide:
- navigation
@@ -18,7 +18,7 @@ hide:
<img src="assets/homepage_demo_clip.webp" alt="homepage" style="max-width: 100%; margin: 0 auto; display: block;" />
<p style="margin: 0 0 30px;">A modern, <em>fully static, fast</em>, secure <em>fully proxied</em>, highly customizable application dashboard with integrations for over 100 services and translations into multiple languages. Easily configured via YAML files or through docker label discovery.</p>
<p style="margin: 0 0 30px;">A modern, <em>fast</em>, secure <em>fully proxied</em>, highly customizable application dashboard with integrations for over 100 services and translations into multiple languages. Easily configured via YAML files or through docker label discovery.</p>
</div>
+1 -1
View File
@@ -30,6 +30,6 @@ Finally, run the server:
HOMEPAGE_ALLOWED_HOSTS=gethomepage.dev:1234 pnpm start
```
When updating homepage versions you will need to re-build the static files i.e. repeat the process above.
When updating Homepage versions, rebuild the production bundle by repeating the steps above.
See [HOMEPAGE_ALLOWED_HOSTS](index.md#homepage_allowed_hosts) for more information on this environment variable.
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "homepage",
"version": "2.5.0",
"version": "2.6.0",
"private": true,
"scripts": {
"preinstall": "npx only-allow pnpm",
+1 -1
View File
@@ -791,7 +791,7 @@
"processing": "Processant",
"processed": "Processat",
"time": "Temps",
"failed": "Failed"
"failed": "Error"
},
"firefly": {
"networth": "Valor Net",
+1 -1
View File
@@ -791,7 +791,7 @@
"processing": "Behandler",
"processed": "Behandlet",
"time": "Tid",
"failed": "Failed"
"failed": "Fejlet"
},
"firefly": {
"networth": "Nettoformue",
+15 -15
View File
@@ -871,12 +871,12 @@
"finished": "Fertig"
},
"bookorbit": {
"books": "Books",
"authors": "Authors",
"series": "Series",
"books": "Bücher",
"authors": "Autoren",
"series": "Serien",
"storage": "Storage",
"reading": "Reading",
"finished": "Finished"
"finished": "Beendet"
},
"jdownloader": {
"downloadCount": "Warteschlange",
@@ -999,11 +999,11 @@
"message": "Nachricht",
"tags": "Schlagwörter",
"none": "Keine",
"min": "Min",
"low": "Low",
"default": "Default",
"high": "High",
"urgent": "Urgent"
"min": "Minimal",
"low": "Niedrig",
"default": "Standard",
"high": "Hoch",
"urgent": "Dringend"
},
"plantit": {
"events": "Ereignisse",
@@ -1117,8 +1117,8 @@
"beszel": {
"name": "Name",
"systems": "Systeme",
"up": "Up",
"down": "Down",
"up": "Online",
"down": "Offline",
"paused": "Pausiert",
"pending": "Wartend",
"status": "Status",
@@ -1268,10 +1268,10 @@
"steps": "Schritte"
},
"syncthing": {
"connected": "Connected",
"synced": "Synced",
"errors": "Errors",
"storage": "Storage"
"connected": "Verbunden",
"synced": "Synchronisiert",
"errors": "Fehler",
"storage": "Speicher"
},
"sportarr": {
"wanted": "Wanted",
+13 -13
View File
@@ -257,14 +257,14 @@
"seed": "Semillas"
},
"qui": {
"leech": "Leech",
"download": "Download",
"seed": "Seed",
"upload": "Upload",
"leech": "Sanguijuela",
"download": "Descargar",
"seed": "Semilla",
"upload": "Subir",
"total": "Total",
"errored": "Errored",
"errored": "Con error",
"ratio": "Ratio",
"freeSpace": "Free"
"freeSpace": "Libre"
},
"qnap": {
"cpuUsage": "Uso de la CPU",
@@ -791,7 +791,7 @@
"processing": "Procesando",
"processed": "Procesado",
"time": "Tiempo",
"failed": "Failed"
"failed": "Fallido"
},
"firefly": {
"networth": "Patrimonio neto",
@@ -871,12 +871,12 @@
"finished": "Finalizado"
},
"bookorbit": {
"books": "Books",
"authors": "Authors",
"books": "Libros",
"authors": "Autores",
"series": "Series",
"storage": "Storage",
"reading": "Reading",
"finished": "Finished"
"storage": "Almacenamiento",
"reading": "Lectura",
"finished": "Finalizado"
},
"jdownloader": {
"downloadCount": "En cola",
@@ -1279,6 +1279,6 @@
"leagues": "Ligas"
},
"feed": {
"noItems": "No items"
"noItems": "No hay elementos"
}
}
+16 -16
View File
@@ -257,14 +257,14 @@
"seed": "Сид"
},
"qui": {
"leech": "Leech",
"download": "Download",
"seed": "Seed",
"upload": "Upload",
"total": "Total",
"errored": "Errored",
"ratio": "Ratio",
"freeSpace": "Free"
"leech": "Лич",
"download": "Скачивание",
"seed": "Сид",
"upload": "Загрузка",
"total": "Всего",
"errored": "Ошибок",
"ratio": "Соотношение",
"freeSpace": "Свободно"
},
"qnap": {
"cpuUsage": "Использование ЦП",
@@ -791,7 +791,7 @@
"processing": "Обрабатывается",
"processed": "Обработано",
"time": "Время",
"failed": "Failed"
"failed": "Неудачно"
},
"firefly": {
"networth": "Общая средства",
@@ -871,12 +871,12 @@
"finished": "Завершено"
},
"bookorbit": {
"books": "Books",
"authors": "Authors",
"series": "Series",
"storage": "Storage",
"reading": "Reading",
"finished": "Finished"
"books": "Книги",
"authors": "Авторы",
"series": "Серии",
"storage": "Память",
"reading": "Чтение",
"finished": "Завершено"
},
"jdownloader": {
"downloadCount": "Очередь",
@@ -1279,6 +1279,6 @@
"leagues": "Лиги"
},
"feed": {
"noItems": "No items"
"noItems": "Ничего нет"
}
}
@@ -0,0 +1,57 @@
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import createMockRes from "test-utils/create-mock-res";
vi.mock("next-auth/jwt", () => ({ getToken: vi.fn(async () => null) }));
vi.mock("utils/logger", () => ({ default: () => ({ error: vi.fn(), warn: vi.fn(), debug: vi.fn(), info: vi.fn() }) }));
const allRoutes = Object.entries(import.meta.glob("/src/pages/api/**/*.js"));
const routes = allRoutes.filter(([file]) => !/\/(auth|mcp)\//.test(file) && !file.endsWith("/healthcheck.js"));
describe("API authentication without middleware", () => {
beforeEach(() => vi.stubEnv("HOMEPAGE_AUTH_ENABLED", "true"));
afterEach(() => vi.unstubAllEnvs());
it.each(routes)("rejects anonymous access to %s at its exported handler", async (_file, load) => {
const { default: handler } = await load();
const req = { query: {}, headers: { "x-prerender-revalidate": "public-image-key" }, cookies: {} };
const res = createMockRes();
await handler(req, res);
expect(res.statusCode).toBe(401);
expect(res.body).toEqual({ error: "Unauthorized" });
expect(res.headers["Cache-Control"]).toBe("private, no-store");
});
it("keeps sign-in CSS public while protecting custom JavaScript", async () => {
const { default: handler } = await import("pages/api/config/[path]");
const css = createMockRes();
await handler({ query: { path: "custom.css" } }, css);
expect(css.statusCode).toBe(200);
const js = createMockRes();
await handler({ query: { path: "custom.js" }, headers: {}, cookies: {} }, js);
expect(js.statusCode).toBe(401);
});
});
describe("API host validation without middleware", () => {
beforeEach(() => {
vi.stubEnv("HOMEPAGE_ALLOWED_HOSTS", "");
vi.stubEnv("PORT", "3000");
});
afterEach(() => vi.unstubAllEnvs());
it.each(allRoutes)("rejects disallowed hosts at %s, including public routes", async (_file, load) => {
vi.spyOn(console, "error").mockImplementation(() => {});
const { default: handler } = await load();
const req = {
query: { path: "custom.css", nextauth: ["session"] },
method: "POST",
headers: { host: "evil.example", "x-prerender-revalidate": "public-image-key" },
cookies: {},
};
const res = createMockRes();
await handler(req, res);
expect(res.statusCode).toBe(400);
expect(res.body).toEqual({ error: "Host validation failed. See logs for more details." });
});
});
@@ -34,7 +34,7 @@ function mockResponse() {
async function loadHandler() {
vi.resetModules();
return (await import("./index")).default;
return (await import("pages/api/mcp/index")).default;
}
describe("pages/api/mcp", () => {
+6 -13
View File
@@ -3,27 +3,20 @@ import { describe, expect, it, vi } from "vitest";
import createMockRes from "test-utils/create-mock-res";
import handler from "pages/api/revalidate";
import { invalidateDashboardData } from "utils/config/dashboard";
vi.mock("utils/config/dashboard", () => ({ invalidateDashboardData: vi.fn() }));
describe("pages/api/revalidate", () => {
it("revalidates and returns {revalidated:true}", async () => {
it("invalidates the dashboard snapshot without regenerating a static page", async () => {
const req = {};
const res = createMockRes();
res.revalidate = vi.fn().mockResolvedValueOnce(undefined);
await handler(req, res);
expect(res.revalidate).toHaveBeenCalledWith("/");
expect(invalidateDashboardData).toHaveBeenCalledOnce();
expect(res.revalidate).not.toHaveBeenCalled();
expect(res.body).toEqual({ revalidated: true });
});
it("returns 500 when revalidate throws", async () => {
const req = {};
const res = createMockRes();
res.revalidate = vi.fn().mockRejectedValueOnce(new Error("nope"));
await handler(req, res);
expect(res.statusCode).toBe(500);
expect(res.body).toBe("Error revalidating");
});
});
@@ -57,7 +57,7 @@ vi.mock("widgets/widgets", () => ({
},
}));
import handler from "./proxy";
import handler from "pages/api/services/proxy";
function createReq({ method = "GET", body, query = {} } = {}) {
return { method, body, query };
+4 -4
View File
@@ -19,22 +19,22 @@ describe("pages/api/theme", () => {
vi.clearAllMocks();
});
it("returns defaults when settings are missing", () => {
it("returns defaults when settings are missing", async () => {
getSettings.mockReturnValueOnce({});
const res = createMockRes();
handler({ res });
await handler({}, res);
expect(checkAndCopyConfig).toHaveBeenCalledWith("settings.yaml");
expect(res.statusCode).toBe(200);
expect(res.body).toEqual({ color: "slate", theme: "dark" });
});
it("returns configured color + theme when present", () => {
it("returns configured color + theme when present", async () => {
getSettings.mockReturnValueOnce({ color: "red", theme: "light" });
const res = createMockRes();
handler({ res });
await handler({}, res);
expect(res.body).toEqual({ color: "red", theme: "light" });
});
+9 -7
View File
@@ -3,6 +3,7 @@
import { act, fireEvent, render, screen, waitFor } from "@testing-library/react";
import { beforeEach, describe, expect, it, vi } from "vitest";
import { invalidateDashboardData } from "utils/config/dashboard";
import { ColorContext } from "utils/contexts/color";
import { SettingsContext } from "utils/contexts/settings";
import { TabContext } from "utils/contexts/tab";
@@ -170,8 +171,9 @@ vi.mock("components/toggles/revalidate", () => ({
default: () => null,
}));
describe("pages/index getStaticProps", () => {
describe("pages/index getServerSideProps", () => {
beforeEach(() => {
invalidateDashboardData();
vi.clearAllMocks();
state.throwIn = null;
state.validateData = [];
@@ -190,8 +192,8 @@ describe("pages/index getStaticProps", () => {
it("returns initial settings and api fallbacks for swr", async () => {
getSettings.mockReturnValueOnce({ providers: { x: 1 }, language: "en", title: "Homepage" });
const { getStaticProps } = await import("pages/index.jsx");
const result = await getStaticProps();
const { getServerSideProps } = await import("pages/index.jsx");
const result = await getServerSideProps({});
expect(result.props.initialSettings).toEqual({ language: "en", title: "Homepage" });
expect(result.props.fallback["/api/services"]).toEqual([{ name: "svc" }]);
@@ -204,8 +206,8 @@ describe("pages/index getStaticProps", () => {
it("normalizes legacy language codes before requesting translations", async () => {
getSettings.mockReturnValueOnce({ providers: {}, language: "zh-CN" });
const { getStaticProps } = await import("pages/index.jsx");
await getStaticProps();
const { getServerSideProps } = await import("pages/index.jsx");
await getServerSideProps({});
expect(serverSideTranslations).toHaveBeenCalledWith("zh-Hans");
});
@@ -214,8 +216,8 @@ describe("pages/index getStaticProps", () => {
getSettings.mockReturnValueOnce({ providers: {}, language: "de" });
state.throwIn = "services";
const { getStaticProps } = await import("pages/index.jsx");
const result = await getStaticProps();
const { getServerSideProps } = await import("pages/index.jsx");
const result = await getServerSideProps({});
expect(result.props.initialSettings).toEqual({});
expect(result.props.fallback["/api/services"]).toEqual([]);
@@ -0,0 +1,19 @@
import { readdirSync } from "fs";
import { expect, it } from "vitest";
// Next compiles everything under src/pages into routes, so a colocated test ships
// to users and drags its dev dependencies into the runtime image.
function filesIn(dir, found = []) {
readdirSync(dir, { withFileTypes: true }).forEach((entry) => {
const path = `${dir}/${entry.name}`;
if (entry.isDirectory()) filesIn(path, found);
else found.push(path);
});
return found;
}
it("keeps test files out of src/pages", () => {
const tests = filesIn("src/pages").filter((path) => /\.(test|spec)\.[jt]sx?$/.test(path));
expect(tests).toEqual([]);
});
+3 -13
View File
@@ -1,6 +1,7 @@
import { getToken } from "next-auth/jwt";
import { NextResponse } from "next/server";
import { isAllowedHost, secureCookie } from "utils/auth";
import { isAuthEnabled } from "utils/env";
const authEnabled = isAuthEnabled();
@@ -17,18 +18,7 @@ function withPrivateCache(res) {
}
export async function middleware(req) {
// Check the Host header, if HOMEPAGE_ALLOWED_HOSTS is set
const host = req.headers.get("host");
const port = process.env.PORT || 3000;
let allowedHosts = [`localhost:${port}`, `127.0.0.1:${port}`, `[::1]:${port}`];
const allowAll = process.env.HOMEPAGE_ALLOWED_HOSTS === "*";
if (process.env.HOMEPAGE_ALLOWED_HOSTS) {
allowedHosts = allowedHosts.concat(process.env.HOMEPAGE_ALLOWED_HOSTS.split(","));
}
if (!allowAll && (!host || !allowedHosts.includes(host))) {
console.error(
`Host validation failed for: ${host}. Hint: Set the HOMEPAGE_ALLOWED_HOSTS environment variable to allow requests from this host / port.`,
);
if (!isAllowedHost(req.headers.get("host"))) {
return NextResponse.json({ error: "Host validation failed. See logs for more details." }, { status: 400 });
}
@@ -40,7 +30,7 @@ export async function middleware(req) {
return withPrivateCache(NextResponse.next());
}
const token = await getToken({ req, secret: authSecret });
const token = await getToken({ req, secret: authSecret, secureCookie: secureCookie() });
if (!token) {
const signInUrl = new URL("/auth/signin", req.url);
// Same-origin by construction, so this cannot be used as an open redirect
+25
View File
@@ -37,6 +37,7 @@ describe("middleware", () => {
beforeEach(() => {
vi.clearAllMocks();
process.env = { ...originalEnv };
delete process.env.HOMEPAGE_ALLOWED_HOSTS;
console.error = originalConsoleError;
});
@@ -135,6 +136,29 @@ describe("middleware", () => {
expect(res.type).toBe("next");
});
it.each([
["NEXTAUTH_URL", "https://homepage.example", true],
["NEXTAUTH_URL", "HTTPS://homepage.example", true],
["NEXTAUTH_URL", " https://homepage.example ", true],
["NEXTAUTH_URL", "HTTP://homepage.example", false],
["HOMEPAGE_EXTERNAL_URL", "HTTPS://homepage.example", true],
["HOMEPAGE_EXTERNAL_URL", " https://homepage.example ", true],
["HOMEPAGE_EXTERNAL_URL", "homepage.example", false],
])("reads the session cookie NextAuth sets when %s is %j", async (variable, url, secure) => {
process.env.HOMEPAGE_AUTH_ENABLED = "true";
process.env.HOMEPAGE_AUTH_SECRET = "secret";
delete process.env.NEXTAUTH_URL;
process.env[variable] = url;
getToken.mockResolvedValueOnce({ sub: "user" });
const middleware = await loadMiddleware();
const res = await middleware(createReq("localhost:3000", "http://localhost:3000/"));
expect(getToken).toHaveBeenCalledWith(expect.objectContaining({ secureCookie: secure }));
expect(res.type).toBe("next");
});
it("redirects to signin when auth is enabled and no token is present", async () => {
process.env.HOMEPAGE_AUTH_ENABLED = "true";
process.env.HOMEPAGE_AUTH_SECRET = "secret";
@@ -147,6 +171,7 @@ describe("middleware", () => {
expect(getToken).toHaveBeenCalledWith({
req: expect.objectContaining({ url: "http://localhost:3000/some" }),
secret: "secret",
secureCookie: false,
});
expect(NextResponse.redirect).toHaveBeenCalled();
expect(res.type).toBe("redirect");
+4 -1
View File
@@ -3,6 +3,7 @@ import { createHash, timingSafeEqual } from "node:crypto";
import NextAuth from "next-auth";
import CredentialsProvider from "next-auth/providers/credentials";
import { withAllowedHost } from "utils/auth";
import { applyNextAuthEnv, isAuthEnabled } from "utils/env";
import createLogger from "utils/logger";
@@ -163,7 +164,7 @@ export const authOptions = {
const nextAuthHandler = NextAuth(authOptions);
export default async function handler(req, res) {
async function handler(req, res) {
// Just pass empty session if auth not enabled
if (!authEnabled) {
return res.status(200).json({});
@@ -171,3 +172,5 @@ export default async function handler(req, res) {
return nextAuthHandler(req, res);
}
export default withAllowedHost(handler);
+4 -1
View File
@@ -1,5 +1,8 @@
import { withAuth } from "utils/auth";
import { bookmarksResponse } from "utils/config/api-response";
export default async function handler(req, res) {
async function handler(req, res) {
res.send(await bookmarksResponse());
}
export default withAuth(handler);
+4 -1
View File
@@ -1,6 +1,7 @@
import fs from "fs";
import path from "path";
import { withAuth } from "utils/auth";
import { CONF_DIR } from "utils/config/config";
import createLogger from "utils/logger";
@@ -10,7 +11,7 @@ const logger = createLogger("configFileService");
* @param {import("next").NextApiRequest} req
* @param {import("next").NextApiResponse} res
*/
export default async function handler(req, res) {
async function handler(req, res) {
const { path: relativePath } = req.query;
// only two supported files, for now
@@ -32,3 +33,5 @@ export default async function handler(req, res) {
return res.status(500).end("Internal Server Error");
}
}
export default withAuth(handler, { public: (req) => req.query?.path === "custom.css" });
+4 -1
View File
@@ -1,9 +1,10 @@
import { withAuth } from "utils/auth";
import { getDockerStats } from "utils/docker/stats";
import createLogger from "utils/logger";
const logger = createLogger("dockerStats");
export default async function handler(req, res) {
async function handler(req, res) {
try {
const result = await getDockerStats(req.query.server);
@@ -19,3 +20,5 @@ export default async function handler(req, res) {
});
}
}
export default withAuth(handler);
+4 -1
View File
@@ -1,9 +1,10 @@
import { withAuth } from "utils/auth";
import { getDockerStatuses } from "utils/docker/status";
import createLogger from "utils/logger";
const logger = createLogger("dockerStatuses");
export default async function handler(req, res) {
async function handler(req, res) {
try {
const result = await getDockerStatuses(req.query.server);
@@ -19,3 +20,5 @@ export default async function handler(req, res) {
});
}
}
export default withAuth(handler);
+4 -1
View File
@@ -2,6 +2,7 @@ import { createHash } from "crypto";
import { readFileSync } from "fs";
import { join } from "path";
import { withAuth } from "utils/auth";
import checkAndCopyConfig, { CONF_DIR } from "utils/config/config";
const configs = [
@@ -20,7 +21,7 @@ function hash(buffer) {
return hashSum.digest("hex");
}
export default async function handler(req, res) {
async function handler(req, res) {
const hashes = configs.map((config) => {
checkAndCopyConfig(config);
const configYaml = join(CONF_DIR, config);
@@ -36,3 +37,5 @@ export default async function handler(req, res) {
hash: combinedHash,
});
}
export default withAuth(handler);
+5 -1
View File
@@ -1,3 +1,7 @@
export default function handler(req, res) {
import { withAllowedHost } from "utils/auth";
function handler(req, res) {
res.send("up");
}
export default withAllowedHost(handler);
@@ -4,9 +4,11 @@ import { getKubeConfig } from "../../../../utils/config/kubernetes";
import { parseCpu, parseMemory } from "../../../../utils/kubernetes/utils";
import createLogger from "../../../../utils/logger";
import { withAuth } from "utils/auth";
const logger = createLogger("kubernetesStatsService");
export default async function handler(req, res) {
async function handler(req, res) {
const APP_LABEL = "app.kubernetes.io/name";
const { service, podSelector } = req.query;
@@ -108,3 +110,5 @@ export default async function handler(req, res) {
});
}
}
export default withAuth(handler);
@@ -3,9 +3,11 @@ import { CoreV1Api } from "@kubernetes/client-node";
import { getKubeConfig } from "../../../../utils/config/kubernetes";
import createLogger from "../../../../utils/logger";
import { withAuth } from "utils/auth";
const logger = createLogger("kubernetesStatusService");
export default async function handler(req, res) {
async function handler(req, res) {
const APP_LABEL = "app.kubernetes.io/name";
const { service, podSelector } = req.query;
@@ -68,3 +70,5 @@ export default async function handler(req, res) {
});
}
}
export default withAuth(handler);
+5 -1
View File
@@ -1,6 +1,7 @@
import { getServerSession } from "next-auth/next";
import { authOptions } from "pages/api/auth/[...nextauth]";
import { withAllowedHost } from "utils/auth";
import { isAuthEnabled } from "utils/env";
import createLogger from "utils/logger";
import { handleMcpRequest, mcpEnabled, mcpTokenAuthorized, mcpTokenConfigError } from "utils/mcp/homepage-mcp";
@@ -10,7 +11,8 @@ async function hasHomepageSession(req, res) {
return Boolean(await getServerSession(req, res, authOptions));
}
export default async function handler(req, res) {
async function handler(req, res) {
res.setHeader("Cache-Control", "private, no-store");
if (!mcpEnabled()) {
return res.status(404).end("Not Found");
}
@@ -38,3 +40,5 @@ export default async function handler(req, res) {
return res.status(200).json(response);
}
export default withAllowedHost(handler);
+4 -1
View File
@@ -1,11 +1,12 @@
import { promise as ping } from "ping";
import { withAuth } from "utils/auth";
import { getServiceItem } from "utils/config/service-helpers";
import createLogger from "utils/logger";
const logger = createLogger("ping");
export default async function handler(req, res) {
async function handler(req, res) {
const { groupName, serviceName } = req.query;
const serviceItem = await getServiceItem(groupName, serviceName);
if (!serviceItem) {
@@ -40,3 +41,5 @@ export default async function handler(req, res) {
});
}
}
export default withAuth(handler);
+4 -1
View File
@@ -1,3 +1,4 @@
import { withAuth } from "utils/auth";
import { getProxmoxConfig } from "utils/config/proxmox";
import createLogger from "utils/logger";
import { httpProxy } from "utils/proxy/http";
@@ -7,7 +8,7 @@ const VALID_VM_TYPES = new Set(["qemu", "lxc"]);
const VALID_NODE = /^[A-Za-z0-9._-]+$/;
const VALID_VMID = /^\d+$/;
export default async function handler(req, res) {
async function handler(req, res) {
const { service, type: vmType } = req.query;
const [node, vmid] = service || [];
@@ -103,3 +104,5 @@ export default async function handler(req, res) {
});
}
}
export default withAuth(handler);
+4 -1
View File
@@ -1,9 +1,10 @@
import { withAuth } from "utils/auth";
import createLogger from "utils/logger";
import { cachedRequest } from "utils/proxy/http";
const logger = createLogger("releases");
export default async function handler(req, res) {
async function handler(req, res) {
const releasesURL = "https://api.github.com/repos/gethomepage/homepage/releases";
try {
return res.send(await cachedRequest(releasesURL, 5));
@@ -12,3 +13,5 @@ export default async function handler(req, res) {
return res.send([]);
}
}
export default withAuth(handler);
+7 -6
View File
@@ -1,8 +1,9 @@
export default async function handler(req, res) {
try {
await res.revalidate("/");
import { withAuth } from "utils/auth";
import { invalidateDashboardData } from "utils/config/dashboard";
async function handler(req, res) {
invalidateDashboardData();
return res.json({ revalidated: true });
} catch (err) {
return res.status(500).send("Error revalidating");
}
}
export default withAuth(handler);
+4 -1
View File
@@ -1,9 +1,10 @@
import { searchProviders } from "components/widgets/search/search";
import { withAuth } from "utils/auth";
import { getSettings } from "utils/config/config";
import { widgetsFromConfig } from "utils/config/widget-helpers";
import { cachedRequest } from "utils/proxy/http";
export default async function handler(req, res) {
async function handler(req, res) {
const { query, providerName } = req.query;
const provider = Object.values(searchProviders).find(({ name }) => name === providerName);
@@ -34,3 +35,5 @@ export default async function handler(req, res) {
return res.send(await cachedRequest(`${provider.suggestionUrl}${encodeURIComponent(query)}`, 5, "Mozilla/5.0"));
}
export default withAuth(handler);
+4 -1
View File
@@ -1,5 +1,8 @@
import { withAuth } from "utils/auth";
import { servicesResponse } from "utils/config/api-response";
export default async function handler(req, res) {
async function handler(req, res) {
res.send(await servicesResponse());
}
export default withAuth(handler);
+4 -1
View File
@@ -1,3 +1,4 @@
import { withAuth } from "utils/auth";
import getServiceWidget from "utils/config/service-helpers";
import createLogger from "utils/logger";
import { formatApiCall } from "utils/proxy/api-helpers";
@@ -41,7 +42,7 @@ function getSafeSegments(rawSegments, allowedSegments) {
return safeSegments;
}
export default async function handler(req, res) {
async function handler(req, res) {
try {
const { service, group, index } = req.query;
const serviceWidget = await getServiceWidget(group, service, index);
@@ -144,3 +145,5 @@ export default async function handler(req, res) {
return res.status(500).send({ error: "Unexpected error" });
}
}
export default withAuth(handler);
+4 -1
View File
@@ -1,12 +1,13 @@
import { performance } from "perf_hooks";
import { withAuth } from "utils/auth";
import { getServiceItem } from "utils/config/service-helpers";
import createLogger from "utils/logger";
import { httpProxy } from "utils/proxy/http";
const logger = createLogger("siteMonitor");
export default async function handler(req, res) {
async function handler(req, res) {
const { groupName, serviceName } = req.query;
const serviceItem = await getServiceItem(groupName, serviceName);
if (!serviceItem) {
@@ -50,3 +51,5 @@ export default async function handler(req, res) {
});
}
}
export default withAuth(handler);
+4 -1
View File
@@ -1,6 +1,7 @@
import { withAuth } from "utils/auth";
import checkAndCopyConfig, { getSettings } from "utils/config/config";
export default function handler({ res }) {
function handler(req, res) {
checkAndCopyConfig("settings.yaml");
const settings = getSettings();
@@ -12,3 +13,5 @@ export default function handler({ res }) {
theme,
});
}
export default withAuth(handler);
+4 -1
View File
@@ -1,10 +1,11 @@
import { withAuth } from "utils/auth";
import checkAndCopyConfig from "utils/config/config";
import createLogger from "utils/logger";
const configs = ["docker.yaml", "settings.yaml", "services.yaml", "bookmarks.yaml", "kubernetes.yaml", "proxmox.yaml"];
const logger = createLogger("configValidationHandler");
export default async function handler(req, res) {
async function handler(req, res) {
let errors = configs.map((config) => checkAndCopyConfig(config)).filter((status) => status !== true);
if (errors.length > 0) {
logger.error("Configuration validation errors", errors);
@@ -17,3 +18,5 @@ export default async function handler(req, res) {
}
res.send(errors);
}
export default withAuth(handler);
+4 -1
View File
@@ -1,3 +1,4 @@
import { withAuth } from "utils/auth";
import { getPrivateWidgetOptions } from "utils/config/widget-helpers";
import createLogger from "utils/logger";
import { sanitizeErrorURL } from "utils/proxy/api-helpers";
@@ -5,7 +6,7 @@ import { httpProxy } from "utils/proxy/http";
const logger = createLogger("customapi");
export default async function handler(req, res) {
async function handler(req, res) {
const { index } = req.query;
const options = await getPrivateWidgetOptions("customapi", index);
@@ -44,3 +45,5 @@ export default async function handler(req, res) {
return res.status(500).json({ error: { message: "Invalid JSON", url: sanitizeErrorURL(url) } });
}
}
export default withAuth(handler);
+4 -1
View File
@@ -1,3 +1,4 @@
import { withAuth } from "utils/auth";
import { getPrivateWidgetOptions } from "utils/config/widget-helpers";
import createLogger from "utils/logger";
import { parseVersionForUrl } from "utils/proxy/api-helpers";
@@ -42,7 +43,7 @@ async function retrieveFromGlancesAPI(privateWidgetOptions, endpoint) {
return JSON.parse(Buffer.from(data).toString());
}
export default async function handler(req, res) {
async function handler(req, res) {
const { index, cputemp: includeCpuTemp, uptime: includeUptime, disk: includeDisks, version } = req.query;
const privateWidgetOptions = await getPrivateWidgetOptions("glances", index);
@@ -76,3 +77,5 @@ export default async function handler(req, res) {
return res.status(400).json({ error: e.message });
}
}
export default withAuth(handler);
+4 -1
View File
@@ -1,5 +1,8 @@
import { withAuth } from "utils/auth";
import { widgetsResponse } from "utils/config/api-response";
export default async function handler(req, res) {
async function handler(req, res) {
res.send(await widgetsResponse());
}
export default withAuth(handler);
+5 -1
View File
@@ -4,9 +4,11 @@ import { getKubeConfig } from "../../../utils/config/kubernetes";
import { parseCpu, parseMemory } from "../../../utils/kubernetes/utils";
import createLogger from "../../../utils/logger";
import { withAuth } from "utils/auth";
const logger = createLogger("widget");
export default async function handler(req, res) {
async function handler(req, res) {
try {
const kc = getKubeConfig();
if (!kc) {
@@ -98,3 +100,5 @@ export default async function handler(req, res) {
});
}
}
export default withAuth(handler);
+5 -1
View File
@@ -2,6 +2,8 @@ import { getSettings } from "../../../utils/config/config";
import createLogger from "../../../utils/logger";
import { httpProxy } from "../../../utils/proxy/http";
import { withAuth } from "utils/auth";
const logger = createLogger("longhorn");
function parseLonghornData(data) {
@@ -47,7 +49,7 @@ function parseLonghornData(data) {
return nodes;
}
export default async function handler(req, res) {
async function handler(req, res) {
const settings = getSettings();
const longhornSettings = settings?.providers?.longhorn || {};
const { url, username, password } = longhornSettings;
@@ -85,3 +87,5 @@ export default async function handler(req, res) {
nodes,
});
}
export default withAuth(handler);
+4 -1
View File
@@ -1,9 +1,12 @@
import { withAuth } from "utils/auth";
import { cachedRequest } from "utils/proxy/http";
export default async function handler(req, res) {
async function handler(req, res) {
const { latitude, longitude, units, cache, timezone } = req.query;
const degrees = units === "metric" ? "celsius" : "fahrenheit";
const timezeone = timezone ?? "auto";
const apiUrl = `https://api.open-meteo.com/v1/forecast?latitude=${latitude}&longitude=${longitude}&daily=sunrise,sunset&current_weather=true&temperature_unit=${degrees}&timezone=${timezeone}`;
return res.send(await cachedRequest(apiUrl, cache));
}
export default withAuth(handler);
+4 -1
View File
@@ -1,8 +1,9 @@
import { withAuth } from "utils/auth";
import { getSettings } from "utils/config/config";
import { getPrivateWidgetOptions } from "utils/config/widget-helpers";
import { cachedRequest } from "utils/proxy/http";
export default async function handler(req, res) {
async function handler(req, res) {
const { latitude, longitude, units, provider, cache, lang, index } = req.query;
const privateWidgetOptions = await getPrivateWidgetOptions("openweathermap", index);
let { apiKey } = privateWidgetOptions;
@@ -28,3 +29,5 @@ export default async function handler(req, res) {
return res.send(await cachedRequest(apiUrl, cache));
}
export default withAuth(handler);
+4 -1
View File
@@ -1,5 +1,6 @@
import si from "systeminformation";
import { withAuth } from "utils/auth";
import createLogger from "utils/logger";
const logger = createLogger("resources");
@@ -19,7 +20,7 @@ function isMissingNetworkStat(networkData, interfaceName) {
);
}
export default async function handler(req, res) {
async function handler(req, res) {
const { type, target, interfaceName = "default" } = req.query;
if (type === "cpu") {
@@ -114,3 +115,5 @@ export default async function handler(req, res) {
error: "invalid type",
});
}
export default withAuth(handler);
+4 -1
View File
@@ -1,10 +1,11 @@
import { withAuth } from "utils/auth";
import { getSettings } from "utils/config/config";
import createLogger from "utils/logger";
import { cachedRequest } from "utils/proxy/http";
const logger = createLogger("stocks");
export default async function handler(req, res) {
async function handler(req, res) {
const { watchlist, provider, cache } = req.query;
logger.debug("Stocks API request: %o", { watchlist, provider, cache });
@@ -81,3 +82,5 @@ export default async function handler(req, res) {
/* c8 ignore next 2 -- provider validation above currently makes this unreachable */
return res.status(400).json({ error: "Invalid configuration" });
}
export default withAuth(handler);
+4 -1
View File
@@ -1,8 +1,9 @@
import { withAuth } from "utils/auth";
import { getSettings } from "utils/config/config";
import { getPrivateWidgetOptions } from "utils/config/widget-helpers";
import { cachedRequest } from "utils/proxy/http";
export default async function handler(req, res) {
async function handler(req, res) {
const { latitude, longitude, provider, cache, lang, index } = req.query;
const privateWidgetOptions = await getPrivateWidgetOptions("weatherapi", index);
let { apiKey } = privateWidgetOptions;
@@ -28,3 +29,5 @@ export default async function handler(req, res) {
return res.send(await cachedRequest(apiUrl, cache));
}
export default withAuth(handler);
+4 -1
View File
@@ -1,7 +1,8 @@
import { withPageAuth } from "utils/auth";
import { getSettings } from "utils/config/config";
import themes from "utils/styles/themes";
export async function getServerSideProps({ res }) {
async function getProps({ res }) {
const settings = getSettings();
const color = settings.color || "slate";
@@ -27,3 +28,5 @@ export async function getServerSideProps({ res }) {
}
export default function BrowserConfig() {}
export const getServerSideProps = withPageAuth(getProps);
+3 -45
View File
@@ -1,6 +1,5 @@
import classNames from "classnames";
import { useTranslation } from "next-i18next/pages";
import { serverSideTranslations } from "next-i18next/pages/serverSideTranslations";
import dynamic from "next/dynamic";
import Head from "next/head";
import { useRouter } from "next/router";
@@ -16,14 +15,13 @@ import ServicesGroup from "components/services/group";
import Tab, { slugifyAndEncode } from "components/tab";
import Revalidate from "components/toggles/revalidate";
import Widget from "components/widgets/widget";
import { bookmarksResponse, servicesResponse, widgetsResponse } from "utils/config/api-response";
import { getSettings } from "utils/config/config";
import { withPageAuth } from "utils/auth";
import { getDashboardData } from "utils/config/dashboard";
import { ColorContext } from "utils/contexts/color";
import { SettingsContext } from "utils/contexts/settings";
import { TabContext } from "utils/contexts/tab";
import { ThemeContext } from "utils/contexts/theme";
import useWindowFocus from "utils/hooks/window-focus";
import createLogger from "utils/logger";
import themes from "utils/styles/themes";
const ThemeToggle = dynamic(() => import("components/toggles/theme"), {
@@ -55,47 +53,7 @@ const normalizeLanguage = (language) => {
return alias || language;
};
export async function getStaticProps() {
let logger;
try {
logger = createLogger("index");
const { providers, ...settings } = getSettings();
const services = await servicesResponse();
const bookmarks = await bookmarksResponse();
const widgets = await widgetsResponse();
const language = normalizeLanguage(settings.language);
return {
props: {
initialSettings: settings,
fallback: {
"/api/services": services,
"/api/bookmarks": bookmarks,
"/api/widgets": widgets,
"/api/hash": false,
},
...(await serverSideTranslations(language)),
},
};
} catch (e) {
if (logger && e) {
logger.error(e);
}
return {
props: {
initialSettings: {},
fallback: {
"/api/services": [],
"/api/bookmarks": [],
"/api/widgets": [],
"/api/hash": false,
},
...(await serverSideTranslations("en")),
},
};
}
}
export const getServerSideProps = withPageAuth(async () => ({ props: await getDashboardData() }));
function Index({ initialSettings, fallback }) {
const windowFocused = useWindowFocus();
+4 -1
View File
@@ -1,7 +1,8 @@
import { withPageAuth } from "utils/auth";
import checkAndCopyConfig, { getSettings } from "utils/config/config";
import themes from "utils/styles/themes";
export async function getServerSideProps({ res }) {
async function getProps({ res }) {
checkAndCopyConfig("settings.yaml");
const settings = getSettings();
@@ -44,3 +45,5 @@ export async function getServerSideProps({ res }) {
export default function Webmanifest() {
return null;
}
export const getServerSideProps = withPageAuth(getProps);
+75
View File
@@ -0,0 +1,75 @@
import { getToken } from "next-auth/jwt";
import { isAuthEnabled } from "utils/env";
export function isAllowedHost(host) {
if (process.env.HOMEPAGE_ALLOWED_HOSTS === "*") return true;
const port = process.env.PORT || 3000;
const allowedHosts = [`localhost:${port}`, `127.0.0.1:${port}`, `[::1]:${port}`].concat(
process.env.HOMEPAGE_ALLOWED_HOSTS ? process.env.HOMEPAGE_ALLOWED_HOSTS.split(",") : [],
);
if (host && allowedHosts.includes(host)) return true;
console.error(
`Host validation failed for: ${host}. Hint: Set the HOMEPAGE_ALLOWED_HOSTS environment variable to allow requests from this host / port.`,
);
return false;
}
export function withAllowedHost(handler) {
return async function hostCheckedHandler(req, res) {
if (!isAllowedHost(req.headers?.host)) {
return res.status(400).json({ error: "Host validation failed. See logs for more details." });
}
return handler(req, res);
};
}
// Match NextAuth, which picks the cookie name from the parsed URL protocol
export function secureCookie() {
try {
return new URL(process.env.NEXTAUTH_URL || process.env.HOMEPAGE_EXTERNAL_URL).protocol === "https:";
} catch {
return false;
}
}
async function authorized(req, res) {
if (!isAuthEnabled()) return true;
res.setHeader("Cache-Control", "private, no-store");
return Boolean(
await getToken({
req,
secret: process.env.NEXTAUTH_SECRET || process.env.HOMEPAGE_AUTH_SECRET,
secureCookie: secureCookie(),
}),
);
}
export function withAuth(handler, { public: isPublic } = {}) {
return withAllowedHost(async function authenticatedHandler(req, res) {
if (!isPublic?.(req) && !(await authorized(req, res))) {
return res.status(401).json({ error: "Unauthorized" });
}
return handler(req, res);
});
}
export function withPageAuth(getProps) {
return async function authenticatedPage(context) {
if (!isAllowedHost(context.req?.headers?.host)) {
return { notFound: true };
}
if (!(await authorized(context.req, context.res))) {
// resolvedUrl is a path supplied by Next.js, never an external destination.
const callbackUrl = context.resolvedUrl || "/";
return {
redirect: {
destination: `/auth/signin?callbackUrl=${encodeURIComponent(callbackUrl)}`,
permanent: false,
},
};
}
return getProps(context);
};
}
+180
View File
@@ -0,0 +1,180 @@
import { encode } from "next-auth/jwt";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import createMockRes from "test-utils/create-mock-res";
import { isAllowedHost, secureCookie, withAllowedHost, withAuth, withPageAuth } from "utils/auth";
describe("handler authentication", () => {
const secret = "test-session-secret-at-least-32-characters";
beforeEach(() => {
vi.stubEnv("HOMEPAGE_AUTH_ENABLED", "true");
vi.stubEnv("HOMEPAGE_AUTH_SECRET", secret);
vi.stubEnv("HOMEPAGE_EXTERNAL_URL", "http://localhost:3000");
vi.stubEnv("NEXTAUTH_SECRET", "");
vi.stubEnv("NEXTAUTH_URL", "");
});
afterEach(() => vi.unstubAllEnvs());
const request = (cookies = {}) => ({ headers: { "x-prerender-revalidate": "public-image-key" }, cookies });
it("rejects anonymous requests before the API handler runs, independently of middleware", async () => {
const handler = vi.fn();
const res = createMockRes();
await withAuth(handler)(request(), res);
expect(res.statusCode).toBe(401);
expect(res.body).toEqual({ error: "Unauthorized" });
expect(res.headers["Cache-Control"]).toBe("private, no-store");
expect(handler).not.toHaveBeenCalled();
});
describe.each(["HOMEPAGE_EXTERNAL_URL", "NEXTAUTH_URL"])("session cookies with %s", (variable) => {
it.each([
["http://homepage.example", false],
["https://homepage.example", true],
["HTTP://homepage.example", false],
["HTTPS://homepage.example", true],
[" https://homepage.example ", true],
[" http://homepage.example ", false],
])("accepts a real session for %s", async (url, secure) => {
vi.stubEnv(variable, url);
const cookie = secure ? "__Secure-next-auth.session-token" : "next-auth.session-token";
const token = await encode({ token: { sub: "homepage" }, secret });
const req = request({ [cookie]: token });
const res = createMockRes();
const handler = vi.fn(() => res.send("private data"));
await withAuth(handler)(req, res);
expect(handler).toHaveBeenCalledWith(req, res);
expect(res.body).toBe("private data");
expect(res.headers["Cache-Control"]).toBe("private, no-store");
const getProps = vi.fn(() => ({ props: { title: "private page" } }));
expect(await withPageAuth(getProps)({ req, res })).toEqual({ props: { title: "private page" } });
expect(getProps).toHaveBeenCalledOnce();
});
});
it.each(["expired", "wrong secret", "missing secret", "malformed"])("rejects %s sessions", async (kind) => {
const token =
kind === "malformed"
? "broken-token"
: await encode({
token: { sub: "homepage" },
secret: kind === "wrong secret" ? "different-secret" : secret,
maxAge: kind === "expired" ? -60 : 3600,
});
if (kind === "missing secret") vi.stubEnv("HOMEPAGE_AUTH_SECRET", "");
const handler = vi.fn();
const res = createMockRes();
await withAuth(handler)(request({ "next-auth.session-token": token }), res);
expect(res.statusCode).toBe(401);
expect(handler).not.toHaveBeenCalled();
});
it("allows auth-disabled installations and explicit public resources", async () => {
const handler = vi.fn();
await withAuth(handler, { public: () => true })(request(), createMockRes());
vi.stubEnv("HOMEPAGE_AUTH_ENABLED", "false");
await withAuth(handler)(request(), createMockRes());
expect(handler).toHaveBeenCalledTimes(2);
});
it("redirects a page before reading or returning its private props", async () => {
const getProps = vi.fn();
const res = createMockRes();
const result = await withPageAuth(getProps)({ req: request(), res, resolvedUrl: "/?tab=private" });
expect(result.redirect).toEqual({ destination: "/auth/signin?callbackUrl=%2F%3Ftab%3Dprivate", permanent: false });
expect(res.headers["Cache-Control"]).toBe("private, no-store");
expect(getProps).not.toHaveBeenCalled();
});
});
describe("handler host validation", () => {
beforeEach(() => {
vi.stubEnv("HOMEPAGE_ALLOWED_HOSTS", "");
vi.stubEnv("PORT", "3000");
vi.spyOn(console, "error").mockImplementation(() => {});
});
afterEach(() => {
vi.unstubAllEnvs();
vi.restoreAllMocks();
});
it.each([
["localhost:3000", true],
["127.0.0.1:3000", true],
["[::1]:3000", true],
["evil.example", false],
[undefined, false],
])("checks %s against the default hosts", (host, allowed) => {
expect(isAllowedHost(host)).toBe(allowed);
});
it("accepts configured hosts and the wildcard", () => {
vi.stubEnv("HOMEPAGE_ALLOWED_HOSTS", "homepage.example,other:3000");
expect(isAllowedHost("homepage.example")).toBe(true);
expect(isAllowedHost("evil.example")).toBe(false);
vi.stubEnv("HOMEPAGE_ALLOWED_HOSTS", "*");
expect(isAllowedHost("evil.example")).toBe(true);
});
it("rejects disallowed hosts before public or authenticated handlers run", async () => {
const handler = vi.fn();
const req = { headers: { host: "evil.example", "x-prerender-revalidate": "public-image-key" }, cookies: {} };
for (const wrapped of [withAllowedHost(handler), withAuth(handler, { public: () => true })]) {
const res = createMockRes();
await wrapped(req, res);
expect(res.statusCode).toBe(400);
}
expect(handler).not.toHaveBeenCalled();
});
it("hides pages from disallowed hosts before reading their props", async () => {
const getProps = vi.fn();
const result = await withPageAuth(getProps)({
req: { headers: { host: "evil.example" }, cookies: {} },
res: createMockRes(),
resolvedUrl: "/",
});
expect(result).toEqual({ notFound: true });
expect(getProps).not.toHaveBeenCalled();
});
});
describe("secureCookie", () => {
beforeEach(() => {
vi.stubEnv("NEXTAUTH_URL", "");
vi.stubEnv("HOMEPAGE_EXTERNAL_URL", "");
});
afterEach(() => vi.unstubAllEnvs());
it.each([
["https://homepage.example", true],
["HTTPS://homepage.example", true],
[" https://homepage.example ", true],
["http://homepage.example", false],
["homepage.example", false],
["not a url", false],
["", false],
])("treats %j as secure: %s", (url, secure) => {
vi.stubEnv("HOMEPAGE_EXTERNAL_URL", url);
expect(secureCookie()).toBe(secure);
});
it("prefers NEXTAUTH_URL, as NextAuth does", () => {
vi.stubEnv("NEXTAUTH_URL", "https://homepage.example");
vi.stubEnv("HOMEPAGE_EXTERNAL_URL", "http://homepage.example");
expect(secureCookie()).toBe(true);
});
it("rejects instead of erroring when the URL is invalid", async () => {
vi.stubEnv("HOMEPAGE_AUTH_ENABLED", "true");
vi.stubEnv("HOMEPAGE_AUTH_SECRET", "test-session-secret-at-least-32-characters");
vi.stubEnv("HOMEPAGE_EXTERNAL_URL", "homepage.example");
const handler = vi.fn();
const res = createMockRes();
await withAuth(handler)({ headers: {}, cookies: {} }, res);
expect(res.statusCode).toBe(401);
expect(handler).not.toHaveBeenCalled();
});
});
+2 -2
View File
@@ -69,11 +69,11 @@ export function substituteEnvironmentVars(str) {
const cachedVars = getCachedEnvironmentVars();
cachedVars.forEach(([key, value]) => {
if (key.startsWith(homepageVarPrefix)) {
result = result.replaceAll(`{{${key}}}`, value);
result = result.replaceAll(`{{${key}}}`, () => value);
} else if (key.startsWith(homepageFilePrefix)) {
const filename = value;
const fileContents = readFileSync(filename, "utf8");
result = result.replaceAll(`{{${key}}}`, fileContents);
result = result.replaceAll(`{{${key}}}`, () => fileContents);
}
});
}
+34 -1
View File
@@ -1,4 +1,4 @@
import { mkdtempSync, writeFileSync } from "node:fs";
import { mkdtempSync, rmdirSync, unlinkSync, writeFileSync } from "node:fs";
import { tmpdir } from "node:os";
import path from "node:path";
@@ -37,6 +37,39 @@ describe("utils/config/config", () => {
expect(mod.substituteEnvironmentVars("token={{HOMEPAGE_FILE_SECRET}}")).toBe("token=secret");
});
it.each(["pa$$word", "pa$&word", "pa$`word", "pa$'word", "pa$1word"])(
"substituteEnvironmentVars preserves literal environment value %j in every occurrence",
async (secret) => {
process.env.HOMEPAGE_VAR_SECRET = secret;
const mod = await import("./config");
expect(
mod.substituteEnvironmentVars("before {{HOMEPAGE_VAR_SECRET}} between {{HOMEPAGE_VAR_SECRET}} after"),
).toBe(`before ${secret} between ${secret} after`);
},
);
it.each(["pa$$word", "pa$&word", "pa$`word", "pa$'word", "pa$1word"])(
"substituteEnvironmentVars preserves literal secret file contents %j in every occurrence",
async (secret) => {
const dir = mkdtempSync(path.join(tmpdir(), "homepage-config-test-"));
const secretPath = path.join(dir, "secret.txt");
writeFileSync(secretPath, secret, "utf8");
try {
process.env.HOMEPAGE_FILE_SECRET = secretPath;
const mod = await import("./config");
expect(
mod.substituteEnvironmentVars("before {{HOMEPAGE_FILE_SECRET}} between {{HOMEPAGE_FILE_SECRET}} after"),
).toBe(`before ${secret} between ${secret} after`);
} finally {
unlinkSync(secretPath);
rmdirSync(dir);
}
},
);
it("getSettings reads from HOMEPAGE_CONFIG_DIR and converts layout list to an object", async () => {
const dir = mkdtempSync(path.join(tmpdir(), "homepage-settings-test-"));
process.env.HOMEPAGE_CONFIG_DIR = dir;
+54
View File
@@ -0,0 +1,54 @@
import cache from "memory-cache";
import { serverSideTranslations } from "next-i18next/pages/serverSideTranslations";
import { bookmarksResponse, servicesResponse, widgetsResponse } from "utils/config/api-response";
import { getSettings } from "utils/config/config";
import createLogger from "utils/logger";
const cacheKey = "homepageDashboardData";
export function invalidateDashboardData() {
cache.del(cacheKey);
}
async function loadDashboardData() {
const { providers, ...settings } = getSettings();
const language = settings.language?.toLowerCase() === "zh-cn" ? "zh-Hans" : settings.language || "en";
const [services, bookmarks, widgets, translations] = await Promise.all([
servicesResponse(),
bookmarksResponse(),
widgetsResponse(),
serverSideTranslations(language),
]);
return {
initialSettings: settings,
fallback: {
"/api/services": services,
"/api/bookmarks": bookmarks,
"/api/widgets": widgets,
"/api/hash": false,
},
...translations,
};
}
export async function getDashboardData() {
let pending = cache.get(cacheKey);
if (!pending) {
pending = loadDashboardData().catch((error) => {
if (cache.get(cacheKey) === pending) invalidateDashboardData();
throw error;
});
cache.put(cacheKey, pending);
}
try {
return await pending;
} catch (error) {
createLogger("index").error(error);
return {
initialSettings: {},
fallback: { "/api/services": [], "/api/bookmarks": [], "/api/widgets": [], "/api/hash": false },
...(await serverSideTranslations("en")),
};
}
}
+75
View File
@@ -0,0 +1,75 @@
import { beforeEach, describe, expect, it, vi } from "vitest";
const { services, bookmarks, widgets, translations, settings, logger } = vi.hoisted(() => ({
services: vi.fn(),
bookmarks: vi.fn(),
widgets: vi.fn(),
translations: vi.fn(),
settings: vi.fn(),
logger: { error: vi.fn() },
}));
vi.mock("utils/config/api-response", () => ({
servicesResponse: services,
bookmarksResponse: bookmarks,
widgetsResponse: widgets,
}));
vi.mock("utils/config/config", () => ({ getSettings: settings }));
vi.mock("next-i18next/pages/serverSideTranslations", () => ({ serverSideTranslations: translations }));
vi.mock("utils/logger", () => ({ default: () => logger }));
import { getDashboardData, invalidateDashboardData } from "utils/config/dashboard";
describe("dashboard data snapshot", () => {
beforeEach(() => {
vi.resetAllMocks();
invalidateDashboardData();
services.mockResolvedValue([{ name: "private service" }]);
bookmarks.mockResolvedValue([]);
widgets.mockResolvedValue([]);
translations.mockResolvedValue({ _nextI18Next: { initialLocale: "en" } });
settings.mockReturnValue({ providers: { privateKey: "secret" }, title: "Dashboard" });
});
it("coalesces concurrent discovery and reuses the snapshot for later page loads", async () => {
const results = await Promise.all(Array.from({ length: 10 }, () => getDashboardData()));
const later = await getDashboardData();
for (const loader of [services, bookmarks, widgets, translations, settings]) expect(loader).toHaveBeenCalledOnce();
expect(results.every((result) => result === later)).toBe(true);
expect(later.initialSettings).toEqual({ title: "Dashboard" });
expect(later.fallback["/api/services"]).toEqual([{ name: "private service" }]);
});
it("refreshes configuration and discovery after invalidation", async () => {
await getDashboardData();
invalidateDashboardData();
settings.mockReturnValue({ title: "Updated", language: "zh-CN" });
const result = await getDashboardData();
expect(services).toHaveBeenCalledTimes(2);
expect(result.initialSettings.title).toBe("Updated");
expect(translations).toHaveBeenLastCalledWith("zh-Hans");
});
it("retries after a failed load instead of caching an empty dashboard", async () => {
services.mockRejectedValueOnce(new Error("discovery failed"));
expect((await getDashboardData()).fallback["/api/services"]).toEqual([]);
expect((await getDashboardData()).fallback["/api/services"]).toEqual([{ name: "private service" }]);
expect(services).toHaveBeenCalledTimes(2);
});
it("does not let a stale failed load evict a newer snapshot", async () => {
let reject;
services.mockImplementationOnce(
() =>
new Promise((_resolve, fail) => {
reject = fail;
}),
);
const stale = getDashboardData();
invalidateDashboardData();
const current = await getDashboardData();
reject(new Error("old discovery failed"));
await stale;
expect(await getDashboardData()).toBe(current);
expect(services).toHaveBeenCalledTimes(2);
});
});
+3 -2
View File
@@ -55,6 +55,7 @@ export default async function credentialedProxyHandler(req, res, map) {
"authentik",
"cloudflared",
"ghostfolio",
"gitea",
"headscale",
"hoarder",
"karakeep",
@@ -143,7 +144,7 @@ export default async function credentialedProxyHandler(req, res, map) {
headers["X-API-Key"] = `${widget.key}`;
}
const [status, contentType, data] = await httpProxy(url, {
const [status, contentType, data, responseHeaders] = await httpProxy(url, {
method: req.method,
withCredentials: true,
credentials: "include",
@@ -178,7 +179,7 @@ export default async function credentialedProxyHandler(req, res, map) {
.status(500)
.json({ error: { message: "Invalid data", url: sanitizeErrorURL(url), data: resultData } });
}
if (map) resultData = map(resultData);
if (map) resultData = map(resultData, responseHeaders);
}
if (contentType) res.setHeader("Content-Type", contentType);
@@ -45,6 +45,7 @@ vi.mock("widgets/widgets", () => ({
autobrr: { api: "{url}/{endpoint}" },
jellystat: { api: "{url}/{endpoint}" },
trilium: { api: "{url}/{endpoint}" },
gitea: { api: "{url}/api/v1/{endpoint}" },
gitlab: { api: "{url}/{endpoint}" },
azuredevops: { api: "{url}/{endpoint}" },
glances: { api: "{url}/{endpoint}" },
@@ -135,6 +136,33 @@ describe("utils/proxy/handlers/credentialed", () => {
expect(res.body).toEqual({ ok: true });
});
it("uses Bearer auth for gitea widgets and keeps the key out of the URL", async () => {
getServiceWidget.mockResolvedValue({ type: "gitea", url: "http://example", key: "token" });
httpProxy.mockResolvedValue([200, "application/json", []]);
const req = { method: "GET", query: { group: "g", service: "s", endpoint: "notifications?limit=1", index: 0 } };
const res = createMockRes();
await credentialedProxyHandler(req, res);
const [url, params] = httpProxy.mock.calls[0];
expect(params.headers.Authorization).toBe("Bearer token");
expect(url.toString()).toBe("http://example/api/v1/notifications?limit=1");
});
it("passes response headers to the mapping function", async () => {
getServiceWidget.mockResolvedValue({ type: "gitea", url: "http://example", key: "token" });
httpProxy.mockResolvedValue([200, "application/json", [], { "x-total-count": "7" }]);
const req = { method: "GET", query: { group: "g", service: "s", endpoint: "notifications?limit=1", index: 0 } };
const res = createMockRes();
await credentialedProxyHandler(req, res, (data, headers) => ({ count: Number(headers["x-total-count"]) }));
expect(res.statusCode).toBe(200);
expect(res.body).toEqual({ count: 7 });
});
it("uses NC-Token auth for nextcloud widgets when key is provided", async () => {
getServiceWidget.mockResolvedValue({ type: "nextcloud", url: "http://example", key: "nc-token" });
httpProxy.mockResolvedValue([200, "application/json", { ok: true }]);
+3 -3
View File
@@ -1,4 +1,4 @@
import genericProxyHandler from "utils/proxy/handlers/generic";
import credentialedProxyHandler from "utils/proxy/handlers/credentialed";
// Get total from header to avoid pagination limit
export function totalCount(data, headers) {
@@ -7,8 +7,8 @@ export function totalCount(data, headers) {
}
const widget = {
api: "{url}/api/v1/{endpoint}?access_token={key}",
proxyHandler: genericProxyHandler,
api: "{url}/api/v1/{endpoint}",
proxyHandler: credentialedProxyHandler,
mappings: {
notifications: {
+2
View File
@@ -8,6 +8,8 @@ afterEach(() => {
if (typeof document !== "undefined") cleanup();
});
process.env.HOMEPAGE_ALLOWED_HOSTS = "*";
// Avoid NextAuth client-side fetches during unit tests.
vi.mock("next-auth/react", () => ({
SessionProvider: ({ children }) => children ?? null,