Власний хостинг 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 (all-in-one) або 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.

Обов'язкові

Фіксовані розгортанням

Ці змінні задаються образом (all-in-one) або файлом compose, і перевизначати їх потрібно лише для нестандартної топології. Виняток становлять DOMAIN, APP_URL, BACKEND_URL та S3_PUBLIC_URL: задані в env-файлі, вони мають пріоритет в обох режимах (див. Власний домен).

Сервіс Compose app додатково отримує INTLAYER_BACKEND_INTERNAL_URL=http://backend:3100: браузер звертається до API через localhost:3100, але серверний рендеринг виконується всередині мережі 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