Самостоятельный хостинг Intlayer

Intlayer может работать на вашей собственной инфраструктуре без необходимости создания учетной записи Intlayer Cloud. Доступны три конфигурации, устанавливаемые одним и тем же установщиком (install.sh, install.ps1 в Windows или npx intlayer init infra):

Table of Contents

Опубликованные образы и пакеты

Все три образа собираются из одного и того же docker/selfhost/Dockerfile и публикуются при каждом релизе. Стек Compose также загружает официальные образы mongo:8, redis:8-alpine и quay.io/minio/minio.

Настройка

Установщик запрашивает желаемую конфигурацию, проверяет предварительные требования (предлагая установить Docker), записывает файл переменных окружения с уже сгенерированными секретами и загружает образы. Он никогда ничего не запускает сам: режимам Docker сначала требуется почтовый сервис, поэтому в конце выводится команда для запуска. Повторный запуск безопасен: существующий файл окружения не перезаписывается, что делает его также способом обновления.

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

Параметры установщика

Без флага --mode (или INTLAYER_MODE) установщик отображает меню: desktop, docker (все в одном) или compose. Он также считывает несколько переменных окружения. Поскольку запуск происходит через пайплайн в оболочке, передавайте их оболочке, а не 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

Переменные портов изменяют только сторону хоста сопоставления. В опубликованных образах http://localhost:3000, http://localhost:3100 и http://localhost:9000 встроены в сборку панели управления, поэтому сохраняйте значения по умолчанию, если не собираете собственные образы, смотрите Ограничения.

Первоначальная настройка

На новом экземпляре (пустая база данных) открытие панели перенаправляет на страницу /init:

1. Создайте первую учетную запись. Поскольку коллекция пользователей пуста, эта учетная запись автоматически становится суперадминистратором.
2. Письмо с подтверждением отправляется через Resend или ваше SMTP-реле. Подтверждение электронной почты является обязательным, поэтому почтовый сервис должен быть настроен до начала работы.
3. Перейдите по ссылке в письме и войдите в систему.

Когда администратор уже существует, /init перенаправляет на стандартную страницу входа.

Переменные окружения

Оба режима Docker читают один и тот же файл (intlayer.env для контейнера, .env для Compose), сгенерированный из docker/selfhost/.env.template.

Обязательные

Фиксированные развертыванием

Эти переменные задаются образом («все в одном») или файлом compose, и переопределять их нужно только для нестандартной топологии. Исключение составляют DOMAIN, APP_URL, BACKEND_URL и S3_PUBLIC_URL: заданные в env-файле, они имеют приоритет в обоих режимах (см. Пользовательский домен).

Служба app в Compose дополнительно получает INTLAYER_BACKEND_INTERNAL_URL=http://backend:3100: браузер обращается к API через localhost:3100, но SSR выполняется внутри сети Compose и должен использовать имя службы.

Пользовательский домен

Бэкенд считывает свои публичные URL во время выполнения, но в панели управления они вкомпилированы: опубликованные образы intlayer/cms-frontend и intlayer/cms-all работают только на http://localhost:3000. Поэтому для работы Intlayer на собственном домене нужны две вещи, и обе подготавливает установщик, когда вы отвечаете на вопрос о домене:

1. Четыре переменные в env-файле, которые считывает бэкенд (cookie, ссылки в письмах, OAuth-колбэки, URL ресурсов) и которые docker-compose.build.yml использует как аргументы сборки:

   intlayer.env

   Копировать содержимое

   Копировать код

   Копировать код в буфер обмена

   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. Образ панели управления, собранный с этими URL. Docker собирает его прямо из репозитория, клонировать ничего не нужно:

   sh

   Копировать содержимое

   Копировать код

   Копировать код в буфер обмена

   # 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
   

Затем поставьте перед контейнером обратный прокси с TLS: cms.example.org → порт 3000, back.example.org → 3100, s3.example.org → 9000. Все три хоста должны иметь общий суффикс DOMAIN, так как область действия сессионного cookie ограничена им.

Необязательные (функции мягко деградируют при отсутствии)

Глобальный почтовый сервис

Каждое транзакционное письмо, включая внеорганизационные письма (сброс пароля, магические ссылки), проходит через один из двух глобальных транспортов:

• Resend, с использованием RESEND_API_KEY.
• SMTP, с использованием переменных MAIL_SMTP_*. Как только задана MAIL_SMTP_HOST, используется SMTP, а RESEND_API_KEY игнорируется.

MAIL_PROVIDER требуется только для принудительного выбора транспорта, когда настроены оба (например, MAIL_PROVIDER=resend, чтобы сохранить Resend при наличии SMTP-хоста).

Приоритет: собственный почтовый сервис организации (настроенный в панели управления Организация) имеет приоритет над глобальным почтовым сервисом, который, в свою очередь, имеет приоритет над ключом Resend по умолчанию.

Подключение вашего проекта Intlayer

После запуска стека настройте свой проект на использование собственного бэкенда и панели управления вместо intlayer.org.

Конфигурация проекта

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>

Создайте учетные данные доступа в панели управления собственного сервера в разделе Проекты → Ключи доступа по адресу http://localhost:3000/projects.

SDK @intlayer/api

При программном использовании SDK @intlayer/api передавайте backendURL явно:

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();

Ограничения

• Пользовательский домен требует пересборки. Все URL-адреса VITE_* для браузера встроены в панель управления во время сборки, а опубликованные образы (и десктопное приложение) поставляются со значениями localhost / Intlayer Cloud. По умолчанию панель управления должна быть доступна по адресу http://localhost:3000, API — по адресу :3100, а MinIO — по адресу :9000; переназначение портов хоста приводит к тому же. Когда вы указываете домен, установщик готовит все для пересборки из репозитория (см. Пользовательский домен), но сама сборка занимает несколько минут. Подключение десктопного приложения к собственному бэкенду не поддерживается.
• Для работы почты требуется рабочий почтовый сервис. При первой настройке требуется подтверждение электронной почты, поэтому необходимо настроить RESEND_API_KEY или SMTP-реле (MAIL_SMTP_*). После входа первого администратора каждая организация может настроить собственный SMTP или Resend из панели управления.
• Десктопному приложению требуется Node.js на компьютере для запуска встроенного сервера.
• Нет ассистента по документации. ИИ-ассистент по документации intlayer.org (/api/ai/ask, /api/search/doc) опирается на ~130 МБ предварительно вычисленных эмбеддингов документации, которые не входят в образы для самостоятельного размещения; в этом режиме эти два маршрута не регистрируются. Собственные функции ИИ панели управления (перевод, аудит, автодополнение, чат) не затронуты и требуют только OPENAI_API_KEY.

Полезные ссылки

• Документация Intlayer CMS
• Справочник по конфигурации
• CMS SDK: @intlayer/api
• Релизы десктопного приложения
• Docker Hub: intlayer/cms-all, intlayer/cms-frontend, intlayer/cms-backend, зеркало на GHCR: ghcr.io/aymericzip/intlayer/
• docker/selfhost/: Dockerfile, docker-compose.yml и .env.template