freezmo/.env.example
Martin Dvorak bb1f4e2018 Phase 1: backup, encrypted sync and monthly-usage handling
Safety net and errors, mobile-first, desktop unchanged in behaviour.

Backup and persistence
- Settings -> Data & backup: 'Export all data' writes one zod-validated
  JSON (decks, folders, homework, progress, safe settings; the API key
  is not part of the shape and never appears in the file).
- 'Import backup' validates, shows a preview with added/replaced
  counts and offers merge or replace; invalid files get a friendly
  error. Storage persistence (navigator.storage.persist) is shown and
  requestable, with the result reported.
- A dismissible nudge appears after 5 new decks or 14 days without a
  backup and stays snoozed for 14 days.

Opt-in encrypted sync (off by default)
- New lib/sync.ts: PBKDF2-SHA256 (310k) -> AES-GCM-256, derived key
  kept as a non-extractable CryptoKey in IndexedDB (lib/sync-key.ts);
  the passphrase and key never leave the browser.
- New POST/GET/DELETE /api/sync following the route pattern (locale,
  cross-origin guard, body cap, rate limit RATE_LIMIT_SYNC, auth
  before body parsing, zod validation). One atomic JSON file per
  random 128-bit sync ID under SYNC_DIR; server-stamped updatedAt is
  the conflict clock; SYNC_MAX_BYTES and SYNC_TOTAL_BYTES enforced
  (413 / 507). The server only ever sees an opaque envelope.
- Settings -> Sync: enable with a passphrase, copy the sync ID, sync
  now, last-synced time, explicit keep-this-device / use-synced-copy
  conflict choice, join from another device (ID + passphrase, wrong
  passphrase rejected), unlock after the key is gone, delete the
  synced copy (works even on a locked device). Every data store marks
  sync dirty on write; pulled payloads are applied without marking
  dirty again.

Monthly usage vs short-term throttling
- lib/ollama.ts classifies the real 429 body (monthly/quota/upgrade
  vs burst) into new 'usage_limit' and 'throttled' kinds, mapped in
  every route and in the health probe.
- The client renders the same localized message in the deck flow,
  homework, grading and the Settings banner: the required
  upgrade/new-key copy with 'Open Settings' (jumps to and focuses the
  key field) and 'Open Ollama'. Input and wizard drafts are kept so
  Retry works right after swapping the key. No model fallback.

Verified: new phase-1 suite 38/38 (backup content + no key, import
preview/merge/replace, junk file, persistence row, nudge + snooze,
sync enable/upload/opaque blob/push/join/wrong passphrase/delete,
server validation 400/401, usage-limit copy and key focus, and the
real route mapping against a stub Ollama for both 429 variants) plus
regression 74/74, mobile 52/52, wizard 80/80, declutter 116/116,
animation 8/8, native 35/35, i18n 25/25. Key parity 638/638. Lint +
build clean. SW freezmo-v25.
2026-10-10 13:43:42 +00:00

63 lines
3.1 KiB
Bash

# ---------------------------------------------------------------------------
# Freezmo - Ollama configuration
# Copy this file to `.env.local` and adjust if needed.
# ---------------------------------------------------------------------------
# WHO PROVIDES THE API KEY -----------------------------------------------------
# user-key (default) Every browser supplies its own key. The key is typed
# into the settings dialog, kept in that browser's local
# storage and sent with each request in the
# `x-ollama-key` header. The server never stores it.
# Point OLLAMA_BASE_URL at https://ollama.com.
# server One key for everyone, read from OLLAMA_API_KEY below
# (single-user installs). Nothing is sent from the client.
# local No key at all: a local daemon signed in with
# `ollama signin` proxies the cloud models.
OLLAMA_AUTH=user-key
# Ollama endpoint. https://ollama.com for cloud, http://localhost:11434 for a
# local daemon. In user-key mode this is the endpoint the browser's key is sent
# to; in server/local mode it is used directly.
OLLAMA_BASE_URL=https://ollama.com
# Only used when OLLAMA_AUTH=server. Never commit a real key.
OLLAMA_API_KEY=
# Model used for the vision/transcription step (reads photos of notes).
# Must be multimodal — gpt-oss and other text-only models cannot be used here.
# Free-tier friendly: gemma4:31b-cloud, kimi-k3:cloud (paid), mistral-large-3 (paid).
VISION_MODEL=gemma4:31b-cloud
# Model used to generate activities, grade short answers and restore the
# language if a transcription came back translated. gpt-oss:120b is free-tier
# friendly, very good at strict JSON and the strongest multilingual model in the
# free plan. NOTE: it is text-only, so it can't be used as VISION_MODEL.
# Free alternatives: nemotron-3-super:cloud, gpt-oss:20b-cloud.
# Paid/credit: glm-5.3-flash:cloud, kimi-k3:cloud.
TEXT_MODEL=gpt-oss:120b-cloud
# RATE LIMITS (per client IP, sliding window, in-memory) ----------------------
# Generation decks are expensive, so they are limited tightly by default.
# RATE_LIMIT_WINDOW_MS=300000
# RATE_LIMIT_GENERATE=12
# RATE_LIMIT_GRADE=40
# RATE_LIMIT_HOMEWORK=12
# RATE_LIMIT_HEALTH=90
# Encrypted sync (no model calls, but shouldn't be hammered).
# RATE_LIMIT_SYNC=60
# ENCRYPTED SYNC STORAGE -------------------------------------------------------
# Opt-in sync uploads an opaque AES-GCM blob; the server can't read it and
# never sees the passphrase or the API key. One small JSON file per sync ID.
# SYNC_DIR=.freezmo/sync
# Per-blob cap in bytes (larger uploads are refused with HTTP 413).
# SYNC_MAX_BYTES=12582912
# Total cap for the directory in bytes (new blobs refused with HTTP 507).
# SYNC_TOTAL_BYTES=1073741824
# Optional tuning ------------------------------------------------------------
# OLLAMA_TIMEOUT_MS=300000
# OLLAMA_HEALTH_TIMEOUT_MS=8000
# Send `think: false` to thinking models for faster JSON output.
# OLLAMA_THINK=false
# FREEZMO_DEFAULT_ACTIVITY_COUNT=10