freezmo/lib/config.ts
Martin Dvorak 3ea2cea100 Freezmo: self-hosted notes-to-activities study app
Next.js 15 app that turns photos, PDFs, DOCX/PPTX and text into a swipeable
feed of AI-generated activities (flashcards, multiple choice, true/false,
fill-in-the-blank, matching, ordering, short answer) using the user's own
Ollama models.

Highlights:
- All AI calls run in server route handlers; the browser never talks to Ollama.
- Bring-your-own-key mode (default): the key lives only in the browser and is
  sent per-request; server, local-daemon and shared-key modes also supported.
- Client-side document extraction (pdf.js, mammoth, jszip) with scanned-PDF
  page rendering for the vision model; notes stay in their original language.
- ChatGPT-style shell: collapsible sidebar / mobile drawer, neutral token-based
  light + dark themes, folder organisation, PWA (manifest, SW, offline page).
- Strict JSON validation with zod + auto-repair, rate limiting, and request
  guards (cross-origin, body-size, API-key sanitising).
- setup.sh bootstraps deps, .env.local and a production build.

Gitignore excludes .env*, the generated pdf.js worker and local scratch files.
2026-10-06 20:56:55 +00:00

180 lines
6.2 KiB
TypeScript

/**
* Server-side configuration, read from the environment on every request so
* that editing `.env.local` only requires a dev-server restart.
*
* Never import this into a client component: it would leak the API key.
*/
import { sanitiseApiKey } from "./http-guard";
export type AuthMode = "user-key" | "server" | "local";
export type ServerConfig = {
baseUrl: string;
apiKey: string;
authMode: AuthMode;
visionModel: string;
textModel: string;
/** True when talking straight to https://ollama.com (needs an API key). */
directCloud: boolean;
timeoutMs: number;
healthTimeoutMs: number;
/** `false` sends `think: false`; `null` omits the field entirely. */
think: boolean | null;
defaultActivityCount: number;
rateLimits: {
windowMs: number;
generate: number;
grade: number;
health: number;
};
};
/** What a single request should use to talk to Ollama. */
export type OllamaAuth = {
baseUrl: string;
apiKey: string;
directCloud: boolean;
authMode: AuthMode;
};
function positiveInt(value: string | undefined, fallback: number): number {
const parsed = Number.parseInt(value ?? "", 10);
return Number.isFinite(parsed) && parsed > 0 ? parsed : fallback;
}
function trimTrailingSlash(url: string): string {
return url.replace(/\/+$/, "");
}
export function getServerConfig(): ServerConfig {
const baseUrl = trimTrailingSlash(
process.env.OLLAMA_BASE_URL?.trim() || "http://localhost:11434",
);
const apiKey = process.env.OLLAMA_API_KEY?.trim() || "";
const rawAuthMode = process.env.OLLAMA_AUTH?.trim().toLowerCase();
const authMode: AuthMode =
rawAuthMode === "local" || rawAuthMode === "server" || rawAuthMode === "user-key"
? rawAuthMode
: rawAuthMode === "none"
? "local"
: "user-key";
let directCloud = false;
try {
const host = new URL(baseUrl).hostname.toLowerCase();
directCloud = host === "ollama.com" || host.endsWith(".ollama.com");
} catch {
directCloud = false;
}
const thinkRaw = process.env.OLLAMA_THINK?.trim().toLowerCase();
const think =
thinkRaw === "false" ? false : thinkRaw === "true" ? true : null;
const count = Number.parseInt(
process.env.FREEZMO_DEFAULT_ACTIVITY_COUNT ?? "",
10,
);
return {
baseUrl,
apiKey,
authMode,
visionModel: process.env.VISION_MODEL?.trim() || "gemma4:31b-cloud",
textModel: process.env.TEXT_MODEL?.trim() || "gpt-oss:120b-cloud",
directCloud,
timeoutMs: Number.parseInt(process.env.OLLAMA_TIMEOUT_MS ?? "", 10) || 300_000,
healthTimeoutMs:
Number.parseInt(process.env.OLLAMA_HEALTH_TIMEOUT_MS ?? "", 10) || 8_000,
think,
defaultActivityCount: Number.isFinite(count) ? Math.min(Math.max(count, 6), 20) : 10,
rateLimits: {
windowMs: positiveInt(process.env.RATE_LIMIT_WINDOW_MS, 300_000),
generate: positiveInt(process.env.RATE_LIMIT_GENERATE, 12),
grade: positiveInt(process.env.RATE_LIMIT_GRADE, 40),
health: positiveInt(process.env.RATE_LIMIT_HEALTH, 90),
},
};
}
/**
* Human-readable explanation for every auth configuration problem, so the UI
* never has to show a bare "unauthorised".
*/
export const AUTH_ERROR_MESSAGES: Record<"missing_key" | "server_key_missing" | "local_with_cloud_url", string> = {
missing_key:
"Add your Ollama API key first — open the settings dialog (⚙️) and paste a key from ollama.com/settings/keys.",
server_key_missing:
"This server is configured to use its own Ollama API key (OLLAMA_AUTH=server), but OLLAMA_API_KEY is empty in .env.local.",
local_with_cloud_url:
"This server is set to OLLAMA_AUTH=local but points at https://ollama.com. A signed-in local daemon can't be used against the cloud URL — either set OLLAMA_AUTH=user-key, or point OLLAMA_BASE_URL at http://localhost:11434.",
};
export function authErrorKind(error: "missing_key" | "server_key_missing" | "local_with_cloud_url"): string {
if (error === "missing_key") return "needs_key";
return "config";
}
/** Header a browser uses to hand over its own key for a single request. */
export const API_KEY_HEADER = "x-ollama-key";
/**
* Works out which credentials a request may use.
*
* - `user-key` (default): the key must come from the browser. Nothing is
* stored server-side, ever — it is used for this request and dropped.
* - `server`: the key comes from `.env.local` (single-user installs).
* - `local`: neither; a local daemon signed in with `ollama signin`.
*/
export function resolveAuth(
config: ServerConfig,
request: Request,
): { auth: OllamaAuth } | { error: "missing_key" | "server_key_missing" | "local_with_cloud_url" } {
const headerKey = sanitiseApiKey(request.headers.get(API_KEY_HEADER));
if (config.authMode === "local") {
// A daemon without sign-in can't talk to the cloud API: catch the
// misconfiguration here instead of returning a confusing 401 later.
if (config.directCloud) return { error: "local_with_cloud_url" };
return {
auth: { baseUrl: config.baseUrl, apiKey: "", directCloud: config.directCloud, authMode: "local" },
};
}
if (config.authMode === "server") {
if (!config.apiKey) return { error: "server_key_missing" };
return {
auth: { baseUrl: config.baseUrl, apiKey: config.apiKey, directCloud: config.directCloud, authMode: "server" },
};
}
if (!headerKey) return { error: "missing_key" };
return {
auth: { baseUrl: config.baseUrl, apiKey: headerKey, directCloud: config.directCloud, authMode: "user-key" },
};
}
/**
* Cloud models are addressed as `<model>:cloud` (or `<model>-cloud`) by a
* local daemon, but the direct cloud API uses the plain library name
* (`gemma4:31b-cloud` -> `gemma4:31b`, `glm-5.3-flash:cloud` -> `glm-5.3-flash`).
* Normalise so the same .env works in both modes.
*/
export function resolveModelName(model: string, directCloud: boolean): string {
if (!directCloud) return model;
if (model.endsWith(":cloud")) return model.slice(0, -":cloud".length);
if (model.endsWith("-cloud")) return model.slice(0, -"-cloud".length);
return model;
}
/** Strip local/daemon routing suffixes so model names can be compared. */
export function canonicalModelName(model: string): string {
return model
.replace(/:cloud$/, "")
.replace(/-cloud$/, "")
.toLowerCase();
}