Документація системи керування контентом Intlayer (CMS)

Intlayer CMS, це застосунок, який дозволяє винести вміст вашого проєкту Intlayer у зовнішню систему (CMS).

Для цього Intlayer вводить поняття «віддалених словників» (distant dictionaries).

Зміст

Розуміння віддалених словників

Intlayer розрізняє 'local' та 'remote' словники.

• 'local' словник, це словник, який оголошений у вашому проєкті Intlayer. Наприклад файл декларації кнопки або ваша панель навігації. Виносити контент назовні в такому випадку не має сенсу, оскільки цей контент зазвичай не змінюється часто.

• 'remote' словник, це словник, яким керують через Intlayer CMS. Це може бути корисно, щоб дозволити вашій команді керувати контентом безпосередньо на вашому вебсайті, а також для використання функцій A/B тестування та автоматичної SEO-оптимізації.

Візуальний редактор проти CMS

Редактор Intlayer Visual, це інструмент, який дозволяє керувати вашим вмістом у візуальному редакторі для локальних словників. Після внесення зміни вміст буде замінено в code-base. Це означає, що застосунок буде перебудовано, а сторінка перезавантажиться для відображення нового вмісту.

На відміну від цього, Intlayer CMS, це інструмент, який дозволяє керувати вмістом у візуальному редакторі для віддалених словників. Після внесення зміни вміст не вплине на ваш code-base. Вебсайт автоматично відобразить змінений вміст.

Інтеграція

Для детальнішої інформації про встановлення пакета див. відповідний розділ нижче:

Інтеграція з Next.js

Для інтеграції з Next.js зверніться до керівництва з налаштування.

Інтеграція з Create React App

Для інтеграції з Create React App зверніться до керівництва з налаштування.

Інтеграція з Vite + React

Для інтеграції з Vite + React зверніться до керівництва з налаштування.

Конфігурація

Запустіть наступну команду, щоб увійти в Intlayer CMS:

npx intlayer login

Це відкриє ваш браузер за замовчуванням, щоб завершити процес автентифікації й отримати необхідні облікові дані (Client ID та Client Secret) для використання сервісів Intlayer.

У файлі конфігурації Intlayer ви можете налаштувати параметри CMS:

import type { IntlayerConfig } from "intlayer";

const config: IntlayerConfig = {
  // ... інші налаштування конфігурації
  editor: {
    /**
     * Обов'язково
     *
     * URL застосунку.
     * Це URL, що використовується візуальним редактором.
     */
    applicationURL: process.env.INTLAYER_APPLICATION_URL,

    /**
     * Обов'язково
     *
     * Client ID та client secret потрібні для увімкнення редактора.
     * Вони дозволяють ідентифікувати користувача, який редагує контент.
     * Їх можна отримати, створивши нового клієнта в Intlayer Dashboard - Projects (https://app.intlayer.org/projects).
     * clientId: process.env.INTLAYER_CLIENT_ID,
     * clientSecret: process.env.INTLAYER_CLIENT_SECRET,
     */
    clientId: process.env.INTLAYER_CLIENT_ID,
    clientSecret: process.env.INTLAYER_CLIENT_SECRET,

    /**
     * Необов'язково
     *
     * Якщо ви розгортаєте Intlayer CMS самостійно, ви можете вказати URL CMS.
     *
     * URL Intlayer CMS.
     * За замовчуванням встановлено на https://intlayer.org
     */
    cmsURL: process.env.INTLAYER_CMS_URL,

    /**
     * Необов'язково
     *
     * У випадку, якщо ви самостійно розгортаєте Intlayer CMS, ви можете вказати URL бекенду.
     *
     * URL Intlayer CMS.
     * За замовчуванням встановлено на https://back.intlayer.org
     */
    backendURL: process.env.INTLAYER_BACKEND_URL,
  },
};

export default config;

Якщо у вас немає client ID та client secret, ви можете отримати їх, створивши нового клієнта в Intlayer Dashboard - Projects.

Щоб побачити всі доступні параметри, зверніться до документації з конфігурації.

Використання CMS

Надіслати вашу конфігурацію

Щоб налаштувати Intlayer CMS, ви можете використовувати команди intlayer CLI.

npx intlayer config push

Якщо ви використовуєте змінні оточення в файлі конфігурації intlayer.config.ts, ви можете вказати потрібне оточення за допомогою аргументу --env:

npx intlayer config push --env production

Ця команда завантажує вашу конфігурацію в Intlayer CMS.

Відправити словник

Щоб перетворити ваші локальні словники у віддалений словник, ви можете використовувати команди intlayer CLI.

npx intlayer dictionary push -d my-first-dictionary-key

Якщо ви використовуєте змінні середовища у вашому файлі конфігурації intlayer.config.ts, ви можете вказати потрібне середовище за допомогою аргументу --env:

npx intlayer dictionary push -d my-first-dictionary-key --env production

Ця команда завантажує ваші початкові словники контенту, роблячи їх доступними для асинхронного отримання та редагування через платформу Intlayer.

Редагування словника

Потім ви зможете переглядати та керувати своїм словником у Intlayer CMS.

Програмний доступ за допомогою @intlayer/api SDK

Крім CLI і візуального редактора, Intlayer поставляється з типізованим SDK у пакеті @intlayer/api. Це дозволяє вам розглядати CMS як headless content database: ви можете отримувати проекти, отримувати словники та безпосередньо змінювати їх з вашого власного додатку, скриптів або CI pipeline.

SDK обробляє автентифікацію за вас. Доки ваші clientId і clientSecret доступні (у вашій конфігурації Intlayer або середовищі), він автоматично отримує та оновлює OAuth2 access token та підписує кожен запит.

Установка

npm install @intlayer/api

Як це працює: authenticator + endpoints

SDK розділений на два окремі імпорти навмисне, щоб зберегти ваш bundle компактним:

1. createIntlayerCMS — створює легкий authenticator. Він містить лише облікові дані та керований токен доступу; він нічого не знає про будь-який конкретний домен.
2. dictionaryEndpoint, projectEndpoint, … — привʼязки endpoint для кожного домену, кожна імпортується з власного підпапки (@intlayer/api/dictionary, @intlayer/api/project, …). Ви передаєте authenticator потрібному вам endpoint.

Оскільки кожний endpoint імпортується окремо, ваш bundle містить лише домени, які ви насправді використовуєте — імпортування dictionaryEndpoint ніколи не потягне за собою project, AI або будь-який інший клієнт домену.

import { createIntlayerCMS } from "@intlayer/api";// Конфігурація є необов'язковою: якщо її опущено, облікові дані читаються з// `@intlayer/config/built`, що розв'язує змінні середовища INTLAYER_CLIENT_ID та// INTLAYER_CLIENT_SECRET.export const cmsAuthenticator = createIntlayerCMS();

WARNING

Облікові дані CMS (clientId / clientSecret) надають доступ до запису вашого контенту. Завжди створюйте authenticator лише на серверній стороні (server actions, route handlers, scripts, CI). Ніколи не імпортуйте його в код на стороні клієнта та не розкривайте ваші облікові дані браузеру.

Якщо ви воліте не покладатися на конфігурацію на етапі збирання, передайте облікові дані явно:

import { createIntlayerCMS } from "@intlayer/api";export const cmsAuthenticator = createIntlayerCMS({  editor: {    clientId: process.env.INTLAYER_CLIENT_ID,    clientSecret: process.env.INTLAYER_CLIENT_SECRET,    // Необов'язково, для самостійно розміщених backend:    // backendURL: process.env.INTLAYER_BACKEND_URL,  },});

Отримайте свої облікові дані, створивши новий ключ доступу в Intlayer Dashboard - Projects.

Завантажити проекти

import { createIntlayerCMS } from "@intlayer/api";import { projectEndpoint } from "@intlayer/api/project";const cmsAuthenticator = createIntlayerCMS();// Список проектів, доступних з вашими облікові данимиconst { data: projects } =  await projectEndpoint(cmsAuthenticator).getProjects();// Читання агрегованих інформацій про локалізацію вибраного проектуconst { data: insights } =  await projectEndpoint(cmsAuthenticator).getProjectInsights();

Отримання словників

import { createIntlayerCMS } from "@intlayer/api";import { dictionaryEndpoint } from "@intlayer/api/dictionary";const cmsAuthenticator = createIntlayerCMS();// Список усіх віддалених словників проектуconst { data: dictionaries } =  await dictionaryEndpoint(cmsAuthenticator).getDictionaries();// Або отримайте один словник за ключемconst { data: dictionary } = await dictionaryEndpoint(  cmsAuthenticator).getDictionary("my-first-dictionary-key");

Отправка та оновлення словників

Використовуйте CMS як базу даних для запису вмісту назад:

import { createIntlayerCMS } from "@intlayer/api";import { dictionaryEndpoint } from "@intlayer/api/dictionary";const cmsAuthenticator = createIntlayerCMS();// Створення нового словникаawait dictionaryEndpoint(cmsAuthenticator).addDictionary({  key: "my-first-dictionary-key",  content: { title: "Hello world" },});// Upsert пакету словників (створення або оновлення в одному викликі)await dictionaryEndpoint(cmsAuthenticator).pushDictionaries([  { key: "home", content: { title: "Home" } },  { key: "about", content: { title: "About" } },]);// Оновлення існуючого словникаawait dictionaryEndpoint(cmsAuthenticator).updateDictionary({  id: "<dictionary-id>",  key: "home",  content: { title: "Updated title" },});

Порада: повторно використовуйте прив'язану endpoint, щоб уникнути повторень:

typescript

Копіювати вміст

Копіювати код

Скопіюйте код у буфер обміну

const dictionary = dictionaryEndpoint(cmsAuthenticator);await dictionary.pushDictionaries([myDictionary]);const { data } = await dictionary.getDictionaries();

Вилучення одного методу

Кожен метод endpoint уже автентифікований та самостійний (він має власну обробку токена), тому ви можете вилучити один і передавати його навколо — наприклад, щоб інжектувати його як залежність:

import { createIntlayerCMS } from "@intlayer/api";import { dictionaryEndpoint } from "@intlayer/api/dictionary";const dictionary = dictionaryEndpoint(createIntlayerCMS());// Уже автентифіковано — автоматично оновлює токен при кожному викликуexport const pushDictionaries = dictionary.pushDictionaries;// Використанняawait pushDictionaries([{ key: "home", content: { title: "Home" } }]);

Live Sync

Live Sync дозволяє вашому застосунку відображати зміни контенту з CMS під час виконання. Немає потреби у перебудові або повторному розгортанні. Коли увімкнено, оновлення передаються на сервер Live Sync, який оновлює словники, які читає ваш застосунок.

Повний посібник з налаштування (увімкнення, запуск сервера Live Sync, локальний робочий процес розробки та обмеження) наведено в документації Live Sync.

Самостійне розгортання (Self-Hosting)

Intlayer може працювати повністю на вашій власній інфраструктурі. Одна команда розгортає повний стек (дашборд, API, база даних, сховище об'єктів та електронна пошта) за допомогою Docker Compose:

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

Повний посібник із налаштування, довідник зі змінних середовища, інструкції з оновлення та процедури резервного копіювання/відновлення наведені в Посібнику із самостійного розгортання.

Налагодження

Якщо у вас виникли проблеми з CMS, перевірте наступне:

• Застосунок запущено.

• Налаштування editor правильно встановлені у вашому конфігураційному файлі Intlayer.

  • Обов'язкові поля:
    • URL застосунку має відповідати тому, що ви вказали в конфігурації редактора (applicationURL).
    • URL CMS

• Переконайтеся, що конфігурацію проєкту було pushed до Intlayer CMS.

• Візуальний редактор використовує iframe для відображення вашого вебсайту. Переконайтеся, що Content Security Policy (CSP) вашого сайту дозволяє URL CMS у frame-ancestors ('https://app.intlayer.org' за замовчуванням). Перевірте консоль редактора на наявність помилок.