Autoalojamiento de Intlayer

Intlayer puede ejecutarse en su propia infraestructura, sin necesidad de una cuenta de Intlayer Cloud. Hay tres configuraciones disponibles, todas gestionadas por el mismo instalador (install.sh, install.ps1 en Windows o npx intlayer init infra):

Table of Contents

Imágenes y paquetes publicados

Las tres imágenes se compilan a partir del mismo docker/selfhost/Dockerfile y se publican con cada versión. El stack de Compose también descarga las imágenes oficiales mongo:8, redis:8-alpine y quay.io/minio/minio.

Configuración

El instalador pregunta qué configuración desea, verifica los requisitos previos (ofreciendo instalar Docker), escribe el archivo de entorno con los secretos ya generados y descarga las imágenes. Nunca inicia nada por sí solo: los modos Docker necesitan primero un servicio de correo, por lo que finaliza mostrando el comando a ejecutar. Volver a ejecutarlo es seguro: un archivo de entorno existente nunca se sobrescribe, por lo que también es la vía de actualización.

curl -fsSL https://intlayer.org/install.sh | sh -s -- --mode desktop

$env:INTLAYER_MODE = "desktop"; irm https://intlayer.org/install.ps1 | iex

npx intlayer init infra --mode desktop

                ┌─────────────────────────────┐
 browser ──────▶ │  app  (TanStack Start)  :3000│ ──┐
 (localhost)    └─────────────────────────────┘   │ VITE_BACKEND_URL (baked at build)
                ┌─────────────────────────────┐   │
                │  backend (Fastify/Bun)  :3100│ ◀─┘
                └──────────────┬──────────────┘
          ┌──────────┬─────────┼──────────────┐
          ▼          ▼         ▼               ▼
      mongo:27017  redis:6379  minio:9000   Chromium
      /data/mongo  /data/redis /data/minio  (in-image)
      (1-node RS)              minio:9001

curl -fsSL https://intlayer.org/install.sh | sh -s -- --mode docker

$env:INTLAYER_MODE = "docker"; irm https://intlayer.org/install.ps1 | iex

npx intlayer init infra --mode docker

# Option A: Resend
RESEND_API_KEY=<your-resend-key>

# Option B: SMTP (takes over from Resend as soon as MAIL_SMTP_HOST is set)
MAIL_SMTP_HOST=smtp.example.com
MAIL_SMTP_PORT=587
MAIL_SMTP_USER=<user>
MAIL_SMTP_PASSWORD=<password>
MAIL_FROM=Intlayer <no-reply@example.com>

docker run -d --name intlayer \
  --restart unless-stopped \
  -p 3000:3000 -p 3100:3100 -p 9000:9000 -p 9001:9001 \
  -v intlayer-data:/data \
  --env-file ./intlayer.env \
  intlayer/cms-all:latest

docker run -d --name intlayer `
  --restart unless-stopped `
  -p 3000:3000 -p 3100:3100 -p 9000:9000 -p 9001:9001 `
  -v intlayer-data:/data `
  --env-file ./intlayer.env `
  intlayer/cms-all:latest

# Backup (stop the container first so MongoDB's files are consistent)
docker stop intlayer
docker run --rm -v intlayer-data:/data -v "$(pwd)":/backup busybox tar czf /backup/intlayer-data.tar.gz /data
docker start intlayer

# Restore
docker run --rm -v intlayer-data:/data -v "$(pwd)":/backup busybox tar xzf /backup/intlayer-data.tar.gz -C /

                ┌───────────────────┐
 browser ──────▶ │  app        :3000 │ ── SSR ──▶ http://backend:3100
 (localhost)    └───────────────────┘
                ┌───────────────────┐
 browser ──────▶ │  backend    :3100 │
 (localhost)    └─────────┬─────────┘
          ┌───────────────┼───────────────┐
          ▼               ▼               ▼
     mongo:27017     redis:6379      minio:9000 ◀── browser (assets)
     (1-node RS)                     minio:9001

curl -fsSL https://intlayer.org/install.sh | sh -s -- --mode compose

mkdir intlayer && cd intlayer
curl -fsSLO https://raw.githubusercontent.com/aymericzip/intlayer/main/docker/selfhost/docker-compose.yml
curl -fsSL  https://raw.githubusercontent.com/aymericzip/intlayer/main/docker/selfhost/.env.template -o .env
# fill in BETTER_AUTH_SECRET and S3_SECRET_ACCESS_KEY (openssl rand -hex 32)

$env:INTLAYER_MODE = "compose"; irm https://intlayer.org/install.ps1 | iex

mkdir intlayer; cd intlayer
irm https://raw.githubusercontent.com/aymericzip/intlayer/main/docker/selfhost/docker-compose.yml -OutFile docker-compose.yml
irm https://raw.githubusercontent.com/aymericzip/intlayer/main/docker/selfhost/.env.template -OutFile .env
# fill in BETTER_AUTH_SECRET and S3_SECRET_ACCESS_KEY

npx intlayer init infra --mode compose

cd intlayer && docker compose up -d

services:
  backend:
    environment:
      MONGODB_URI: mongodb+srv://user:password@cluster0.xxxxx.mongodb.net/intlayer
      REDIS_URL: rediss://default:password@redis.example.com:6380
      S3_ENDPOINT: https://s3.eu-west-1.amazonaws.com
      S3_PUBLIC_URL: https://intlayer-assets.s3.eu-west-1.amazonaws.com

cd docker/selfhost
docker compose -f docker-compose.yml -f docker-compose.build.yml up -d --build

# Backup one volume (repeat for intlayer_redis-data and intlayer_minio-data)
docker compose stop
docker run --rm -v intlayer_mongo-data:/data -v "$(pwd)":/backup busybox tar czf /backup/mongo-data.tar.gz /data
docker compose start

# Upgrade, volumes are kept
docker compose pull && docker compose up -d

Configuración del instalador

Sin --mode (o INTLAYER_MODE), el instalador muestra un menú: desktop, docker (todo en uno) o compose. También lee algunas variables de entorno. Al pasarse por tubería a la shell, declárelas en la shell en lugar de pasarlas a curl:

curl -fsSL https://intlayer.org/install.sh | INTLAYER_COMPOSE_DIR=./cms sh -s -- --mode compose

$env:INTLAYER_MODE = "compose"; $env:INTLAYER_COMPOSE_DIR = ".\cms"; irm https://intlayer.org/install.ps1 | iex

Las variables de puerto solo cambian el lado del host del mapeo. Las imágenes publicadas tienen http://localhost:3000, http://localhost:3100 y http://localhost:9000 compiladas en el paquete del panel, por lo que mantenga los valores predeterminados a menos que construya sus propias imágenes, consulte Limitaciones.

Configuración inicial

En una instancia nueva (base de datos vacía), al abrir el panel se le redirige a la página /init:

1. Cree la primera cuenta. Al estar vacía la colección de usuarios, esta cuenta se asciende automáticamente a superadministrador.
2. Se envía un correo electrónico de verificación a través de Resend o de su relay SMTP. La verificación del correo es obligatoria, por lo que se debe configurar un servicio de correo antes de comenzar.
3. Haga clic en el enlace del correo y luego inicie sesión.

Una vez que existe un administrador, /init redirige a la página de inicio de sesión estándar.

Variables de entorno

Ambos modos Docker leen el mismo archivo (intlayer.env para el contenedor, .env para Compose), generado a partir de docker/selfhost/.env.template.

Requeridas

Fijadas por el despliegue

Estas las define la imagen (todo en uno) o el archivo compose, y solo es necesario sobrescribirlas para una topología no estándar. DOMAIN, APP_URL, BACKEND_URL y S3_PUBLIC_URL son la excepción: si se definen en el archivo env, tienen prioridad en ambos modos (consulte Dominio personalizado).

El servicio app de Compose recibe adicionalmente INTLAYER_BACKEND_INTERNAL_URL=http://backend:3100: el navegador accede a la API en localhost:3100, pero el renderizado del lado del servidor se ejecuta dentro de la red Compose y debe usar el nombre del servicio.

Dominio personalizado

El backend lee sus URLs públicas en tiempo de ejecución, pero el panel las tiene compiladas: las imágenes publicadas intlayer/cms-frontend e intlayer/cms-all solo funcionan en http://localhost:3000. Servir Intlayer en su propio dominio requiere, por tanto, dos cosas, ambas preparadas por el instalador cuando responde a la pregunta del dominio:

1. Cuatro variables en el archivo env, leídas por el backend (cookies, enlaces de correo, callbacks de OAuth, URLs de recursos) y usadas como build args por docker-compose.build.yml:

   intlayer.env

   Copiar contenido

   Copiar código

   Copiar el código al portapapeles

   DOMAIN=example.org                          # cookie domain, parent of the hosts below
   APP_URL=https://cms.example.org
   BACKEND_URL=https://back.example.org
   S3_PUBLIC_URL=https://s3.example.org/intlayer
   

2. Una imagen del panel compilada con esas URLs. Docker la compila directamente desde el repositorio, sin necesidad de una copia local:

   sh

   Copiar contenido

   Copiar código

   Copiar el código al portapapeles

   # Docker Compose: the override reads the build args from .env
   docker compose -f docker-compose.yml -f docker-compose.build.yml up -d --build
   
   # All-in-one
   docker build -f docker/selfhost/Dockerfile \
     --build-arg VITE_DOMAIN=example.org \
     --build-arg VITE_SITE_URL=https://cms.example.org \
     --build-arg VITE_IDE_URL=https://cms.example.org \
     --build-arg VITE_BACKEND_URL=https://back.example.org \
     -t intlayer/cms-all:custom \
     https://github.com/aymericzip/intlayer.git#main
   

Después, coloque un reverse proxy con TLS delante del contenedor: cms.example.org → puerto 3000, back.example.org → 3100, s3.example.org → 9000. Los tres hosts deben compartir el sufijo DOMAIN, ya que la cookie de sesión está limitada a él.

Opcionales (las funciones se degradan suavemente si están ausentes)

Servicio de correo global

Cada correo electrónico transaccional, incluidos los correos no pertenecientes a la organización (como restablecimientos de contraseña y enlaces mágicos), pasa a través de uno de dos transportes globales:

• Resend, usando RESEND_API_KEY.
• SMTP, usando las variables MAIL_SMTP_*. Tan pronto como se define MAIL_SMTP_HOST, se utiliza SMTP y se ignora RESEND_API_KEY.

MAIL_PROVIDER solo es necesario para forzar un transporte cuando ambos están configurados (por ejemplo, MAIL_PROVIDER=resend para mantener Resend aunque esté presente un host SMTP).

Prioridad: el servicio de correo propio de una organización (configurado en el panel de Organización) tiene prioridad sobre el servicio de correo global, que a su vez tiene prioridad sobre la clave predeterminada de Resend.

Conectar su proyecto Intlayer

Una vez que el stack esté funcionando, apunte su proyecto al backend y al panel autoalojados en lugar de intlayer.org.

Configuración del proyecto

import type { IntlayerConfig } from "intlayer";

const config: IntlayerConfig = {
  editor: {
    clientId: process.env.INTLAYER_CLIENT_ID,
    clientSecret: process.env.INTLAYER_CLIENT_SECRET,

    /**
     * URL of the self-hosted CMS dashboard.
     * Default: https://app.intlayer.org
     */
    cmsURL: process.env.INTLAYER_CMS_URL, // e.g. http://localhost:3000

    /**
     * URL of the self-hosted backend API.
     * Default: https://back.intlayer.org
     */
    backendURL: process.env.INTLAYER_BACKEND_URL, // e.g. http://localhost:3100
  },
};

export default config;

Set the environment variables in your project's .env:

INTLAYER_CMS_URL=http://localhost:3000
INTLAYER_BACKEND_URL=http://localhost:3100
INTLAYER_CLIENT_ID=<your-client-id>
INTLAYER_CLIENT_SECRET=<your-client-secret>

Cree credenciales de acceso en su panel autoalojado en Proyectos → Claves de acceso en http://localhost:3000/projects.

SDK @intlayer/api

Al usar el SDK @intlayer/api de forma programática, pase backendURL explícitamente:

import { createIntlayerCMS } from "@intlayer/api";
import { dictionaryEndpoint } from "@intlayer/api/dictionary";

const cms = createIntlayerCMS({
  editor: {
    clientId: process.env.INTLAYER_CLIENT_ID,
    clientSecret: process.env.INTLAYER_CLIENT_SECRET,
    backendURL: process.env.INTLAYER_BACKEND_URL, // http://localhost:3100
  },
});

const { data: dictionaries } = await dictionaryEndpoint(cms).getDictionaries();

Limitaciones

• Un dominio personalizado implica recompilar. Todas las URLs VITE_* visibles para el navegador se integran en el panel durante la compilación, y las imágenes publicadas (y la aplicación de escritorio) se entregan con valores de localhost / Intlayer Cloud. Por defecto, se debe acceder al panel en http://localhost:3000, a la API en :3100 y a MinIO en :9000; reasignar los puertos del host tiene el mismo efecto. El instalador prepara todo para una recompilación desde el repositorio cuando le indica un dominio (consulte Dominio personalizado), pero la compilación en sí tarda varios minutos. No se admite apuntar la aplicación de escritorio a un backend autoalojado.
• El correo electrónico requiere un servicio funcional. La configuración inicial exige la verificación por correo electrónico, por lo que se debe configurar RESEND_API_KEY o un relay SMTP (MAIL_SMTP_*). Después de que el primer administrador inicie sesión, cada organización puede configurar su propio servicio SMTP o Resend desde el panel.
• La aplicación de escritorio necesita Node.js en la máquina para iniciar su servidor integrado.
• Sin asistente de documentación. El asistente de documentación con IA de intlayer.org (/api/ai/ask, /api/search/doc) se basa en unos 130 MB de embeddings de documentación precalculados que las imágenes autoalojadas no incluyen; esas dos rutas no se registran en modo autoalojado. Las funcionalidades de IA propias del panel (traducción, auditoría, autocompletado, chat) no se ven afectadas y solo necesitan OPENAI_API_KEY.

Enlaces útiles

• Documentación de Intlayer CMS
• Referencia de configuración
• SDK de CMS: @intlayer/api
• Releases de la aplicación de escritorio
• Docker Hub: intlayer/cms-all, intlayer/cms-frontend, intlayer/cms-backend, alojado en GHCR bajo ghcr.io/aymericzip/intlayer/
• docker/selfhost/: Dockerfile, docker-compose.yml y .env.template