Let an installation look different via ENVIRONMENT_NAME and ENVIRONMENT_COLOR
Setting ENVIRONMENT_NAME (and optionally ENVIRONMENT_COLOR, a name or hex value) gives the sidebar that colour, adds a name badge next to the title and on the sign-in page, and prefixes the browser tab title, so a dev copy can't be taken for production. Unset, nothing changes. The colour is validated to a plain #rrggbb before it reaches the page's styles. A public GET /api/environment lets the sign-in page use it too. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
44cc9d1cf2
commit
7e196be56d
11 files changed
+253
-3
No files matched your search
@@ -38,6 +38,7 @@ import { api, type CurrentUser, type MaintenanceWindow } from "../api/client";
|
||||
import { formatRemaining } from "../utils/duration";
|
||||
import { getTheme, setTheme, type Theme } from "../utils/theme";
|
||||
import CommandPalette from "../components/CommandPalette";
|
||||
import { isLightColor, useEnvironment } from "../utils/environment";
|
||||
|
||||
type Role = "operator" | "admin";
|
||||
|
||||
@@ -163,6 +164,7 @@ export default function AppShell({ user, children }: { user: CurrentUser; childr
|
||||
const [sidebarOpen, setSidebarOpen] = useState(false);
|
||||
const [theme, setThemeState] = useState<Theme>(() => getTheme());
|
||||
const [maintenance, setMaintenance] = useState<MaintenanceWindow[]>([]);
|
||||
const environment = useEnvironment();
|
||||
|
||||
// Everyone sees what's currently silenced, so nobody is left wondering why an alert never came.
|
||||
useEffect(() => {
|
||||
@@ -220,7 +222,7 @@ export default function AppShell({ user, children }: { user: CurrentUser; childr
|
||||
|
||||
return (
|
||||
<div className="page">
|
||||
<aside className="navbar navbar-vertical navbar-expand-lg" data-bs-theme="dark">
|
||||
<aside className="navbar navbar-vertical navbar-expand-lg" data-bs-theme={environment && isLightColor(environment.color) ? "light" : "dark"}>
|
||||
<div className="container-fluid">
|
||||
<button
|
||||
type="button"
|
||||
@@ -232,6 +234,7 @@ export default function AppShell({ user, children }: { user: CurrentUser; childr
|
||||
</button>
|
||||
<h1 className="navbar-brand navbar-brand-autodark">
|
||||
<NavLink to="/">Homelab Manager</NavLink>
|
||||
{environment?.name && <span className="badge ms-2 env-badge">{environment.name}</span>}
|
||||
</h1>
|
||||
<div className={`navbar-collapse collapse ${sidebarOpen ? "show" : ""}`}>
|
||||
<div className="px-3 pt-3 pt-lg-0">
|
||||
|
||||
@@ -4,6 +4,10 @@ import { BrowserRouter } from "react-router-dom";
|
||||
import App from "./App";
|
||||
import "@tabler/core/dist/css/tabler.min.css";
|
||||
import "./styles.css";
|
||||
import { loadEnvironment } from "./utils/environment";
|
||||
|
||||
// Dev and production can be told apart (ENVIRONMENT_NAME / ENVIRONMENT_COLOR on the server); do it before anything is drawn.
|
||||
void loadEnvironment();
|
||||
|
||||
// Production only — in dev the worker would just add another layer between Vite and the browser.
|
||||
if ("serviceWorker" in navigator && import.meta.env.PROD) {
|
||||
|
||||
@@ -1,8 +1,14 @@
|
||||
import { useEnvironment } from "../utils/environment";
|
||||
|
||||
export default function Login() {
|
||||
const environment = useEnvironment();
|
||||
return (
|
||||
<div className="login-screen">
|
||||
<div className="login-card">
|
||||
<h1>Homelab Manager</h1>
|
||||
<div className={`login-card ${environment ? "login-card-env" : ""}`}>
|
||||
<h1>
|
||||
Homelab Manager
|
||||
{environment?.name && <span className="badge ms-2 env-badge">{environment.name}</span>}
|
||||
</h1>
|
||||
<p>Sign in with your homelab identity provider to continue.</p>
|
||||
<a className="btn btn-primary w-100" href="/auth/login">
|
||||
Sign in with Authentik
|
||||
|
||||
@@ -34,6 +34,24 @@
|
||||
margin-bottom: 1.5rem;
|
||||
}
|
||||
|
||||
/* An installation told to look different (ENVIRONMENT_NAME / ENVIRONMENT_COLOR on the server), so a dev copy can't be taken for production. */
|
||||
html[data-env] .navbar-vertical {
|
||||
background-color: var(--hlm-env-color) !important;
|
||||
}
|
||||
|
||||
.env-badge {
|
||||
background-color: #fff;
|
||||
color: var(--hlm-env-color, #000);
|
||||
font-weight: 700;
|
||||
letter-spacing: 0.06em;
|
||||
text-transform: uppercase;
|
||||
vertical-align: middle;
|
||||
}
|
||||
|
||||
.login-card-env {
|
||||
border-top: 4px solid var(--hlm-env-color);
|
||||
}
|
||||
|
||||
/* Sidebar submenus: a little tighter than Tabler's dropdown rows, so several open groups still fit on one screen. */
|
||||
.navbar-vertical .dropdown-menu .dropdown-item {
|
||||
padding-top: 0.3rem;
|
||||
|
||||
@@ -0,0 +1,64 @@
|
||||
import { useEffect, useState } from "react";
|
||||
|
||||
/** How this installation looks different from the others (a dev copy next to production), set by ENVIRONMENT_NAME / ENVIRONMENT_COLOR on the server. */
|
||||
export interface EnvironmentLook {
|
||||
/** Shown as a badge and in the browser tab; may be empty. */
|
||||
name: string;
|
||||
/** A #rrggbb colour. */
|
||||
color: string;
|
||||
}
|
||||
|
||||
const BASE_TITLE = "Homelab Manager";
|
||||
|
||||
let pending: Promise<EnvironmentLook | null> | null = null;
|
||||
|
||||
/** Asked once per page load; a failure just means a normal look. */
|
||||
export function loadEnvironment(): Promise<EnvironmentLook | null> {
|
||||
if (!pending) {
|
||||
pending = fetch("/api/environment", { credentials: "same-origin" })
|
||||
.then((res) => (res.ok ? res.json() : null))
|
||||
.then((body: { environment?: EnvironmentLook | null } | null) => {
|
||||
const look = body?.environment;
|
||||
// The value goes into styles, so only a plain #rrggbb colour is accepted here too.
|
||||
if (look && typeof look.color === "string" && /^#[0-9a-f]{6}$/i.test(look.color)) {
|
||||
return { name: typeof look.name === "string" ? look.name : "", color: look.color };
|
||||
}
|
||||
return null;
|
||||
})
|
||||
.catch(() => null)
|
||||
.then((look) => {
|
||||
applyEnvironment(look);
|
||||
return look;
|
||||
});
|
||||
}
|
||||
return pending;
|
||||
}
|
||||
|
||||
function applyEnvironment(look: EnvironmentLook | null): void {
|
||||
const root = document.documentElement;
|
||||
if (!look) return;
|
||||
root.style.setProperty("--hlm-env-color", look.color);
|
||||
root.setAttribute("data-env", look.name || "custom");
|
||||
document.title = look.name ? `[${look.name}] ${BASE_TITLE}` : BASE_TITLE;
|
||||
document.querySelector('meta[name="theme-color"]')?.setAttribute("content", look.color);
|
||||
}
|
||||
|
||||
/** Whether white text on this colour would be hard to read. */
|
||||
export function isLightColor(hex: string): boolean {
|
||||
const n = parseInt(hex.slice(1), 16);
|
||||
const [r, g, b] = [(n >> 16) & 255, (n >> 8) & 255, n & 255];
|
||||
return (0.299 * r + 0.587 * g + 0.114 * b) / 255 > 0.6;
|
||||
}
|
||||
|
||||
/** undefined while it is being asked, null for a normal installation. */
|
||||
export function useEnvironment(): EnvironmentLook | null | undefined {
|
||||
const [look, setLook] = useState<EnvironmentLook | null | undefined>(undefined);
|
||||
useEffect(() => {
|
||||
let alive = true;
|
||||
loadEnvironment().then((l) => alive && setLook(l));
|
||||
return () => {
|
||||
alive = false;
|
||||
};
|
||||
}, []);
|
||||
return look;
|
||||
}
|
||||
Reference in new issue
Block a user