Skip to content

Rallly is an open-source scheduling and collaboration tool designed to make organizing events and meetings easier.

✨ Store branding settings in the database with env var fallback (#2916)

Luke Vellaf1a6754b14b4
diff --git a/apps/web/src/features/branding/data.ts b/apps/web/src/features/branding/data.ts
index 6ef92d4f0..d5aca6e5c 100644
--- a/apps/web/src/features/branding/data.ts
+++ b/apps/web/src/features/branding/data.ts
@@ -2,55 +2,39 @@ import "server-only";
import { cache } from "react";
import { env } from "@/env";
+import { getInstanceSettings } from "@/features/instance-settings/data";
import { loadInstanceLicense } from "@/features/licensing/data";
import { isSelfHosted } from "@/lib/constants";
import { isMaintenanceModeEnabled } from "@/lib/maintenance";
-import { getForegroundColor } from "@/lib/utils/color";
-import type { BrandingConfig } from "./client";
-import {
- DEFAULT_APP_NAME,
- DEFAULT_LOGO_ICON_URL,
- DEFAULT_LOGO_URL,
- DEFAULT_LOGO_URL_DARK,
- DEFAULT_PRIMARY_COLOR,
-} from "./constants";
-import { getPrimaryColorVars } from "./utils";
+import { resolveBrandingConfig } from "./utils";
-function getDefaultBrandingConfig(): BrandingConfig {
- return {
- primaryColor: getPrimaryColorVars(DEFAULT_PRIMARY_COLOR),
- logo: {
- light: DEFAULT_LOGO_URL,
- dark: DEFAULT_LOGO_URL_DARK,
- },
- logoIcon: DEFAULT_LOGO_ICON_URL,
- hideAttribution: false,
- appName: DEFAULT_APP_NAME,
- };
+function getDefaultBrandingConfig() {
+ return resolveBrandingConfig({});
}
-export function getCustomBrandingConfig() {
- const baseColor = env.PRIMARY_COLOR ?? DEFAULT_PRIMARY_COLOR;
- const vars = getPrimaryColorVars(baseColor);
- const dark = env.PRIMARY_COLOR_DARK ?? vars.dark;
-
+function getEnvBrandingValues() {
return {
- primaryColor: {
- light: vars.light,
- lightForeground: vars.lightForeground,
- dark,
- darkForeground: dark ? getForegroundColor(dark) : vars.darkForeground,
- },
- logo: {
- light: env.LOGO_URL ?? DEFAULT_LOGO_URL,
- dark: env.LOGO_URL_DARK ?? env.LOGO_URL ?? DEFAULT_LOGO_URL_DARK,
- },
- logoIcon: env.LOGO_ICON_URL ?? DEFAULT_LOGO_ICON_URL,
+ appName: env.APP_NAME,
+ primaryColor: env.PRIMARY_COLOR,
+ primaryColorDark: env.PRIMARY_COLOR_DARK,
+ logo: env.LOGO_URL,
+ logoDark: env.LOGO_URL_DARK,
+ logoIcon: env.LOGO_ICON_URL,
hideAttribution: env.HIDE_ATTRIBUTION === "true",
- appName: env.APP_NAME ?? DEFAULT_APP_NAME,
};
}
+export async function getCustomBrandingConfig() {
+ // Cloud keeps the env-only path; maintenance mode keeps skipping the
+ // database so the maintenance page can render while it's unreachable
+ const db =
+ isSelfHosted && !isMaintenanceModeEnabled()
+ ? await getInstanceSettings()
+ : null;
+
+ return resolveBrandingConfig({ db, env: getEnvBrandingValues() });
+}
+
/**
* Returns the branding config for the current instance.
* Automatically checks if the white label addon is enabled and returns
diff --git a/apps/web/src/features/branding/utils.test.ts b/apps/web/src/features/branding/utils.test.ts
new file mode 100644
index 000000000..f70417dae
--- /dev/null
+++ b/apps/web/src/features/branding/utils.test.ts
@@ -0,0 +1,170 @@
+import { describe, expect, it } from "vitest";
+import { getForegroundColor } from "@/lib/utils/color";
+import {
+ DEFAULT_APP_NAME,
+ DEFAULT_LOGO_ICON_URL,
+ DEFAULT_LOGO_URL,
+ DEFAULT_LOGO_URL_DARK,
+ DEFAULT_PRIMARY_COLOR,
+} from "./constants";
+import { getPrimaryColorVars, resolveBrandingConfig } from "./utils";
+
+describe("resolveBrandingConfig", () => {
+ it("returns the default config when no sources are provided", () => {
+ const config = resolveBrandingConfig({});
+
+ expect(config).toEqual({
+ primaryColor: getPrimaryColorVars(DEFAULT_PRIMARY_COLOR),
+ logo: {
+ light: DEFAULT_LOGO_URL,
+ dark: DEFAULT_LOGO_URL_DARK,
+ },
+ logoIcon: DEFAULT_LOGO_ICON_URL,
+ hideAttribution: false,
+ appName: DEFAULT_APP_NAME,
+ });
+ });
+
+ it("uses env values when the db values are unset", () => {
+ const config = resolveBrandingConfig({
+ db: {
+ appName: null,
+ primaryColor: null,
+ primaryColorDark: null,
+ logo: null,
+ logoDark: null,
+ logoIcon: null,
+ hideAttribution: null,
+ },
+ env: {
+ appName: "Env App",
+ logo: "https://example.com/logo.svg",
+ logoIcon: "https://example.com/icon.png",
+ hideAttribution: true,
+ },
+ });
+
+ expect(config.appName).toBe("Env App");
+ expect(config.logo.light).toBe("https://example.com/logo.svg");
+ expect(config.logoIcon).toBe("https://example.com/icon.png");
+ expect(config.hideAttribution).toBe(true);
+ });
+
+ it("prefers db values over env values per field", () => {
+ const config = resolveBrandingConfig({
+ db: {
+ appName: "DB App",
+ primaryColor: null,
+ primaryColorDark: null,
+ logo: "https://db.example.com/logo.svg",
+ logoDark: null,
+ logoIcon: null,
+ hideAttribution: false,
+ },
+ env: {
+ appName: "Env App",
+ logo: "https://env.example.com/logo.svg",
+ logoIcon: "https://env.example.com/icon.png",
+ hideAttribution: true,
+ },
+ });
+
+ // db wins where set
+ expect(config.appName).toBe("DB App");
+ expect(config.logo.light).toBe("https://db.example.com/logo.svg");
+ expect(config.hideAttribution).toBe(false);
+ // env fills fields the db leaves unset
+ expect(config.logoIcon).toBe("https://env.example.com/icon.png");
+ });
+
+ it("falls back to the merged light logo for the dark logo", () => {
+ const config = resolveBrandingConfig({
+ env: {
+ logo: "https://example.com/logo.svg",
+ },
+ });
+
+ expect(config.logo.dark).toBe("https://example.com/logo.svg");
+ });
+
+ it("prefers an explicit dark logo over the light logo fallback", () => {
+ const config = resolveBrandingConfig({
+ db: {
+ appName: null,
+ primaryColor: null,
+ primaryColorDark: null,
+ logo: "https://example.com/logo.svg",
+ logoDark: "https://example.com/logo-dark.svg",
+ logoIcon: null,
+ hideAttribution: null,
+ },
+ });
+
+ expect(config.logo.dark).toBe("https://example.com/logo-dark.svg");
+ });
+
+ it("uses the default dark logo when no logo is set anywhere", () => {
+ const config = resolveBrandingConfig({});
+
+ expect(config.logo.dark).toBe(DEFAULT_LOGO_URL_DARK);
+ });
+
+ it("resolves storage keys to storage URLs", () => {
+ const config = resolveBrandingConfig({
+ db: {
+ appName: null,
+ primaryColor: null,
+ primaryColorDark: null,
+ logo: "branding/logo.png",
+ logoDark: null,
+ logoIcon: "branding/icon.png",
+ hideAttribution: null,
+ },
+ });
+
+ expect(config.logo.light).toContain("/api/storage/branding/logo.png");
+ expect(config.logo.dark).toContain("/api/storage/branding/logo.png");
+ expect(config.logoIcon).toContain("/api/storage/branding/icon.png");
+ });
+
+ it("computes the dark primary color from the merged light color when unset", () => {
+ const config = resolveBrandingConfig({
+ db: {
+ appName: null,
+ primaryColor: "#336699",
+ primaryColorDark: null,
+ logo: null,
+ logoDark: null,
+ logoIcon: null,
+ hideAttribution: null,
+ },
+ });
+
+ expect(config.primaryColor).toEqual(getPrimaryColorVars("#336699"));
+ });
+
+ it("uses an explicit dark primary color and computes its foreground", () => {
+ const config = resolveBrandingConfig({
+ db: {
+ appName: null,
+ primaryColor: "#336699",
+ primaryColorDark: "#99ccff",
+ logo: null,
+ logoDark: null,
+ logoIcon: null,
+ hideAttribution: null,
+ },
+ env: {
+ primaryColorDark: "#000000",
+ },
+ });
+
+ expect(config.primaryColor.dark).toBe("#99ccff");
+ expect(config.primaryColor.darkForeground).toBe(
+ getForegroundColor("#99ccff"),
+ );
+ expect(config.primaryColor.light).toEqual(
+ getPrimaryColorVars("#336699").light,
+ );
+ });
+});
diff --git a/apps/web/src/features/branding/utils.ts b/apps/web/src/features/branding/utils.ts
index 907cb90d6..ee1a051d0 100644
--- a/apps/web/src/features/branding/utils.ts
+++ b/apps/web/src/features/branding/utils.ts
@@ -1,5 +1,15 @@
+import { resolveStorageUrl } from "@/lib/storage/resolve-storage-url";
import { adjustColorForContrast, getForegroundColor } from "@/lib/utils/color";
-import { DARK_MODE_BACKGROUND, LIGHT_MODE_BACKGROUND } from "./constants";
+import type { BrandingConfig } from "./client";
+import {
+ DARK_MODE_BACKGROUND,
+ DEFAULT_APP_NAME,
+ DEFAULT_LOGO_ICON_URL,
+ DEFAULT_LOGO_URL,
+ DEFAULT_LOGO_URL_DARK,
+ DEFAULT_PRIMARY_COLOR,
+ LIGHT_MODE_BACKGROUND,
+} from "./constants";
export function getPrimaryColorVars(primaryColor: string) {
const light = adjustColorForContrast(primaryColor, LIGHT_MODE_BACKGROUND);
@@ -11,3 +21,54 @@ export function getPrimaryColorVars(primaryColor: string) {
darkForeground: getForegroundColor(dark),
};
}
+
+interface BrandingValues {
+ appName?: string | null;
+ primaryColor?: string | null;
+ primaryColorDark?: string | null;
+ logo?: string | null;
+ logoDark?: string | null;
+ logoIcon?: string | null;
+ hideAttribution?: boolean | null;
+}
+
+/**
+ * Merges branding values per field (db → env → default), then applies the
+ * derived rules: dark logo falls back to the light logo, the dark primary
+ * color is computed from the light one, and foreground colors are computed
+ * from their backgrounds. Logo values may be storage keys or absolute URLs.
+ */
+export function resolveBrandingConfig({
+ db,
+ env,
+}: {
+ db?: BrandingValues | null;
+ env?: BrandingValues;
+}): BrandingConfig {
+ const primaryColor =
+ db?.primaryColor ?? env?.primaryColor ?? DEFAULT_PRIMARY_COLOR;
+ const vars = getPrimaryColorVars(primaryColor);
+ const primaryColorDark =
+ db?.primaryColorDark ?? env?.primaryColorDark ?? vars.dark;
+
+ const logo = db?.logo ?? env?.logo ?? null;
+ const logoDark = db?.logoDark ?? env?.logoDark ?? logo;
+
+ return {
+ primaryColor: {
+ light: vars.light,
+ lightForeground: vars.lightForeground,
+ dark: primaryColorDark,
+ darkForeground: getForegroundColor(primaryColorDark),
+ },
+ logo: {
+ light: resolveStorageUrl(logo ?? DEFAULT_LOGO_URL),
+ dark: resolveStorageUrl(logoDark ?? DEFAULT_LOGO_URL_DARK),
+ },
+ logoIcon: resolveStorageUrl(
+ db?.logoIcon ?? env?.logoIcon ?? DEFAULT_LOGO_ICON_URL,
+ ),
+ hideAttribution: db?.hideAttribution ?? env?.hideAttribution ?? false,
+ appName: db?.appName ?? env?.appName ?? DEFAULT_APP_NAME,
+ };
+}
diff --git a/apps/web/src/features/instance-settings/data.ts b/apps/web/src/features/instance-settings/data.ts
index b54dd3d32..bceac2822 100644
--- a/apps/web/src/features/instance-settings/data.ts
+++ b/apps/web/src/features/instance-settings/data.ts
@@ -14,6 +14,13 @@ export const getInstanceSettings = unstable_cache(
select: {
instanceId: true,
disableUserRegistration: true,
+ appName: true,
+ primaryColor: true,
+ primaryColorDark: true,
+ logo: true,
+ logoDark: true,
+ logoIcon: true,
+ hideAttribution: true,
},
});
@@ -21,6 +28,13 @@ export const getInstanceSettings = unstable_cache(
instanceId: instanceSettings?.instanceId ?? null,
disableUserRegistration:
instanceSettings?.disableUserRegistration ?? false,
+ appName: instanceSettings?.appName ?? null,
+ primaryColor: instanceSettings?.primaryColor ?? null,
+ primaryColorDark: instanceSettings?.primaryColorDark ?? null,
+ logo: instanceSettings?.logo ?? null,
+ logoDark: instanceSettings?.logoDark ?? null,
+ logoIcon: instanceSettings?.logoIcon ?? null,
+ hideAttribution: instanceSettings?.hideAttribution ?? null,
};
},
[],
diff --git a/packages/database/prisma/migrations/20260814000000_add_branding_instance_settings/migration.sql b/packages/database/prisma/migrations/20260814000000_add_branding_instance_settings/migration.sql
new file mode 100644
index 000000000..83a0cdd9f
--- /dev/null
+++ b/packages/database/prisma/migrations/20260814000000_add_branding_instance_settings/migration.sql
@@ -0,0 +1,9 @@
+-- AlterTable
+ALTER TABLE "instance_settings"
+ ADD COLUMN "app_name" TEXT,
+ ADD COLUMN "primary_color" TEXT,
+ ADD COLUMN "primary_color_dark" TEXT,
+ ADD COLUMN "logo" TEXT,
+ ADD COLUMN "logo_dark" TEXT,
+ ADD COLUMN "logo_icon" TEXT,
+ ADD COLUMN "hide_attribution" BOOLEAN;
diff --git a/packages/database/prisma/models/instance-settings.prisma b/packages/database/prisma/models/instance-settings.prisma
index 189a06e5e..e1eae10ac 100644
--- a/packages/database/prisma/models/instance-settings.prisma
+++ b/packages/database/prisma/models/instance-settings.prisma
@@ -6,6 +6,16 @@ model InstanceSettings {
// Anonymous identifier used when the instance checks for updates
instanceId String @unique @default(dbgenerated("gen_random_uuid()")) @map("instance_id") @db.Uuid
+ // Branding (unset values fall through to env vars, then defaults)
+ appName String? @map("app_name")
+ primaryColor String? @map("primary_color")
+ primaryColorDark String? @map("primary_color_dark")
+ // Logo values are storage keys or absolute URLs
+ logo String?
+ logoDark String? @map("logo_dark")
+ logoIcon String? @map("logo_icon")
+ hideAttribution Boolean? @map("hide_attribution")
+
createdAt DateTime @default(now()) @map("created_at")
updatedAt DateTime @default(now()) @updatedAt @map("updated_at")