Configuración

La configuración de FrameKit proviene del proyecto generado, su entorno y los puntos de entrada del paquete público. Mantén los secretos en el entorno de ejecución; .env.example es una plantilla, no un almacén de secretos de despliegue.

Precaución

Antes de exponer un proyecto de producción a una red no confiable, define explícitamente FRAMEKIT_AUTH_ENABLED=true. Este es el único interruptor de autenticación. La ausencia o false significa modo abierto; cualquier otro valor es inválido, sin fallback a NODE_ENV, credenciales ni SQLite.

Variables de entorno

La plantilla generada documenta estas variables:

Variable	Predeterminado	Se usa para
FRAMEKIT_AUTH_ENABLED	false	El único interruptor de autenticación. La ausencia o false activa el modo abierto; exactamente true activa usuarios, sesiones, tokens de API y rutas protegidas de Studio y acceso.
FRAMEKIT_ADMIN_USERNAME	admin	Solo se usa con la autenticación activada para nombrar al primer administrador de una base de datos vacía. Debe contener entre 3 y 64 letras ASCII, números, ., _ o -. Después de que exista un usuario, el valor de bootstrap se ignora.
FRAMEKIT_ADMIN_PASSWORD	Ninguno	Solo se usa con la autenticación activada durante el bootstrap del primer administrador. Debe contener entre 12 y 256 bytes UTF-8.
FRAMEKIT_DATABASE_PATH	.framekit-data/framekit.sqlite	La ruta de la base de datos SQLite de autenticación. Las rutas relativas se resuelven desde el directorio de trabajo de la aplicación. :memory: usa una base de datos no persistente. El modo abierto no inicializa SQLite.
PORT	3000	El puerto del servidor. Debe ser un entero de 1 a 65535.
FRAMEKIT_ALLOWED_IMAGE_HOSTS	Vacío	Una lista separada por comas de nombres de host exactos permitidos para imágenes remotas HTTPS. Las entradas se recortan y se convierten a minúsculas; los nombres de host tienen un máximo de 253 caracteres y no se aceptan literales de IP.
FRAMEKIT_MAX_CONCURRENT_RENDERS	2	El número máximo de renderizados de imágenes simultáneos. Debe ser un entero de 1 a 32.
FRAMEKIT_RENDER_TIMEOUT_MS	30000	El tiempo de espera del renderizado de imágenes en milisegundos. Debe ser un entero de 1 a 120000.

El servidor de desarrollo también acepta FRAMEKIT_HOST y HOST para el nombre de host de enlace. FRAMEKIT_HOST tiene prioridad, luego HOST y después localhost. PORT se comparte con la configuración del renderizado de imágenes y también tiene allí el valor predeterminado 3000.

Los hosts de imágenes remotas deben ser nombres de host HTTPS explícitos de la lista de permitidos. Por lo tanto, una lista vacía no autoriza ningún host de imágenes remotas.

Modos de autenticación

En el modo abierto, /editor y /brand funcionan sin iniciar sesión, /login redirige a /editor, /settings y la API de acceso responden como no encontrados, y POST /api/framekit/images/render no necesita credenciales. El renderizador sigue aplicando la validación de solicitudes, las restricciones de imágenes, los límites de navegación del navegador, la capacidad, los tiempos de espera y la limpieza. Las cargas de desarrollo siguen protegidas por una comprobación del mismo origen.

Con FRAMEKIT_AUTH_ENABLED=true se activan usuarios, sesiones, tokens de API, rutas protegidas de Studio y rutas de acceso. FRAMEKIT_ADMIN_PASSWORD y FRAMEKIT_ADMIN_USERNAME inicializan el primer administrador solo en este modo. El modo abierto no crea un administrador anónimo ni inicializa SQLite. Cambiar el interruptor de nuevo a false no elimina usuarios, sesiones ni tokens almacenados; solo deja de consultar esos registros hasta volver a activar la autenticación.

El valor es estricto: usa únicamente true, false o deja la variable sin definir.

Alias del proyecto

El tsconfig.json generado canónico define estos alias:

{
  "compilerOptions": {
    "paths": {
      "@/*": ["./src/*"],
      "@framekit/generated/*": ["./src/generated/framekit/*"]
    }
  }
}

Usa @/* para el código fuente del proyecto y @framekit/generated/* para los módulos generados. Importa FrameKit a través de sus puntos de entrada públicos del paquete, por ejemplo:

import { defineTemplate, field } from '@mauriciodmo/framekit'
import { withFrameKit } from '@mauriciodmo/framekit/next'

Valores predeterminados de Next.js

El next.config.ts generado usa withFrameKit() de @mauriciodmo/framekit/next. El wrapper establece la salida de Next.js en standalone, usa .framekit/next como distDir y añade una redirección temporal de / a /editor. Un proyecto puede pasar su otra configuración de Next.js al wrapper, pero estos valores de FrameKit forman parte de la configuración generada.

Para conocer la estructura del proyecto generado, consulta estructura del proyecto. Para conocer los valores de despliegue del contenedor canónico, consulta Docker y persistencia.