Розгортання Intlayer на власному сервері

Intlayer може повністю працювати на вашій власній інфраструктурі — обліковий запис Intlayer Cloud не потрібен. Одна команда запускає готовий до виробництва стек:

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

Інсталятор завантажує docker-compose.yml та .env, автоматично генерує необхідні секрети та запускає всі контейнери за допомогою docker compose up -d.

Зміст

Архітектура

                ┌─────────────────────────────┐ browser ──────▶ │  app  (TanStack Start)  :3000│ ──┐                └─────────────────────────────┘   │ VITE_BACKEND_URL                ┌─────────────────────────────┐   │                │  backend (Fastify/Bun)  :3100│ ◀─┘                └──────────────┬──────────────┘          ┌──────────┬─────────┼──────────┬───────────┐          ▼          ▼         ▼          ▼           ▼     mongo:27017  redis:6379  minio:9000  mailpit:1025  Chromium     (1-node RS)             (S3 API)     (SMTP)        (in-image)                             minio:9001   mailpit:8025                             (console)    (web UI)

Chromium (використовується для генерації скріншотів Puppeteer) вбудований в образ бекенду — окремий контейнер не потрібен.

Передумови

• Docker ≥ 24 та Docker Compose ≥ v2. Якщо чогось бракує, інсталятор виводить посилання на встановлення та завершує роботу.
• Порти 3000, 3100, 8025, 9000 та 9001 доступні на хості.
• Хост Linux або macOS (або WSL2 на Windows).

Швидкий старт

Витягніть і запустіть опубліковану image, надавши ваші облікові дані та секрети MongoDB Atlas:

docker run -d --name intlayer \  -p 3000:3000 \  -p 3100:3100 \  -p 9000:9000 \  -p 9001:9001 \  -v intlayer-data:/data \  -e DB_ID="<atlas-user>" \  -e DB_MDP="<atlas-password>" \  -e DB_CLUSTER="<cluster>.xxxxx.mongodb.net" \  -e BETTER_AUTH_SECRET="$(openssl rand -hex 32)" \  -e S3_SECRET_ACCESS_KEY="$(openssl rand -hex 16)" \  -e RESEND_API_KEY="<your-resend-key>" \  aymericzip/intlayer-selfhost

Потім відкрийте http://localhost:3000.

Dashboard доступний на localhost. Див. Обмеження — користувацькі домени не підтримуються опублікованою image.

Швидкий старт

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

Що робить інсталятор:

1. Перевіряє наявність docker та docker compose.
2. Завантажує docker-compose.yml та .env.example до ./intlayer/.
3. Якщо файл .env не існує, копіює приклад та генерує випадкові секрети для BETTER_AUTH_SECRET, S3_ACCESS_KEY_ID та S3_SECRET_ACCESS_KEY за допомогою openssl rand.
4. Запускає docker compose pull + docker compose up -d.
5. Виводить URL-адреси: дашборд :3000, API :3100, інтерфейс електронної пошти :8025, консоль MinIO :9001.

Після запуску стека відкрийте http://localhost:3000 та створіть свій перший обліковий запис.

Сервіси

Внутрішні порти (mongo, redis) за замовчуванням не доступні з хосту.

Порт MinIO 9000 має бути доступним для браузера, оскільки завантажені ресурси (аватари, скріншоти) завантажуються безпосередньо з S3_PUBLIC_URL=http://localhost:9000/intlayer.

Змінні середовища

Обов'язково

Обов'язкові (автоматично генеруються або запитуються)

Необов'язкові (функції погіршуються, якщо відсутні)

Глобальний поштовик

За замовчуванням усі транзакційні електронні листи відправляються через Resend з використанням RESEND_API_KEY. Самостійно розгорнуті розгортання можуть натомість маршрутизувати кожну електронну пошту — включаючи не-організаційні листи, такі як скидання паролів і магічні посилання — через глобальний поштовик, налаштований за допомогою змінних середовища.

Встановіть MAIL_PROVIDER, щоб активувати це. Коли не встановлено, використовується поштовик за замовчуванням Resend.

Пріоритет: власний поштовик організації (налаштований з панелі керування Organization) має пріоритет над глобальним поштовиком, який у свою чергу має пріоритет над ключем 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 самостійно розгорнутого дашборду CMS.
     * За замовчуванням: https://app.intlayer.org
     */
    cmsURL: process.env.INTLAYER_CMS_URL, // наприклад, http://localhost:3000

    /**
     * URL самостійно розгорнутого бекенд API.
     * За замовчуванням: https://back.intlayer.org
     */
    backendURL: process.env.INTLAYER_BACKEND_URL, // наприклад, http://localhost:3100
  },
};

export default config;

Встановіть змінні середовища у файлі .env вашого проекту:

INTLAYER_CMS_URL=http://localhost:3000INTLAYER_BACKEND_URL=http://localhost:3100INTLAYER_CLIENT_ID=<ваш-client-id>INTLAYER_CLIENT_SECRET=<ваш-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();

Оновлення

Повторний запуск інсталятора на існуючому розгортанні виконує послідовне оновлення:

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

Це завантажує останні образи та перезапускає контейнери за допомогою docker compose pull && docker compose up -d. Існуючі томи (mongo-data, redis-data, minio-data) зберігаються — без втрати даних.

Щоб оновити вручну з каталогу ./intlayer/:

docker compose pulldocker compose up -d

Резервне копіювання та відновлення

Всі постійні дані зберігаються в трьох іменованих томах Docker.

Резервне копіювання

docker run --rm \  -v intlayer_mongo-data:/data \  -v "$(pwd)":/backup \  busybox tar czf /backup/mongo-data.tar.gz /datadocker run --rm \  -v intlayer_redis-data:/data \  -v "$(pwd)":/backup \  busybox tar czf /backup/redis-data.tar.gz /datadocker run --rm \  -v intlayer_minio-data:/data \  -v "$(pwd)":/backup \  busybox tar czf /backup/minio-data.tar.gz /data

Відновлення

docker run --rm \  -v intlayer_mongo-data:/data \  -v "$(pwd)":/backup \  busybox tar xzf /backup/mongo-data.tar.gz -C /# Повторіть для redis-data та minio-data

Обмеження

• MongoDB має бути зовнішньою (Atlas). Backend підключається лише через mongodb+srv:// (побудований на основі DB_ID / DB_MDP / DB_CLUSTER), тому звичайний mongodb://host:27017 — включаючи вбудований mongod контейнера — не може бути використаний. Надайте кластер MongoDB Atlas.
• Немає користувацького домену. Усі VITE_* URL-адреси, видимі браузером, вбудовуються в додаток під час збирання, а опублікований образ поставляється зі значеннями localhost. Доступ до панелі керування має здійснюватися через http://localhost:3000; обслуговування її на публічному домені потребувало б перебудови образу з цільовими URL-адресами вбудованими та не підтримується з коробки.
• Email вимагає працюючого mailer. Перша установка примушує перевірку електронної пошти, тому має бути налаштований або RESEND_API_KEY, або глобальний SMTP mailer (MAIL_PROVIDER=smtp + MAIL_SMTP_*). Після того як перший адміністратор увійде, кожна організація також може налаштувати власний SMTP або Resend mailer з панелі керування.

Усунення несправностей

Бекенд циклічно перезапускається під час першого запуску

MongoDB та Redis повинні бути справними, перш ніж бекенд почне працювати. Файл compose використовує depends_on з condition: service_healthy. Якщо ви бачите багаторазові перезапуски бекенду, перевірте, чи проходять перевірки стану mongo та redis:

docker compose psdocker compose logs mongodocker compose logs redis

Електронні листи не надсилаються

За замовчуванням усі вихідні електронні листи захоплюються Mailpit. Відкрийте http://localhost:8025, щоб побачити надіслані повідомлення. Щоб надсилати реальні електронні листи, встановіть MAIL_PROVIDER=resend та RESEND_API_KEY=<ваш-ключ> у .env, а потім перезапустіть бекенд:

docker compose restart backend

Відсутній кошик MinIO

Якщо одноразовий сервіс minio-init не запустився (або запустився до того, як MinIO був готовий), створіть кошик вручну:

docker compose run --rm minio-init

Корисні посилання

• Документація Intlayer CMS
• Довідка щодо конфігурації
• CMS SDK — @intlayer/api
• Docker Image (aymercizip/intlayer-selfhost)