استضافة Intlayer ذاتيًا (Self-Hosting)

يمكن تشغيل 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 start intlayer

# 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: يصل المتصفح إلى واجهة برمجة التطبيقات على localhost:3100، ولكن العرض من جانب الخادم يتم داخل شبكة Compose ولذلك يجب استخدام اسم الخدمة.

النطاق المخصص

تقرأ الواجهة الخلفية عناوين URL العامة الخاصة بها وقت التشغيل، لكن لوحة التحكم تحتويها مضمّنة أثناء البناء: الصورتان المنشورتان intlayer/cms-frontend و intlayer/cms-all تعملان فقط على http://localhost:3000. لذلك يتطلب تقديم Intlayer على نطاقك الخاص أمرين، يُعدّهما برنامج التثبيت كليهما عندما تجيب على سؤال النطاق:

1. أربعة متغيرات في ملف env، تقرؤها الواجهة الخلفية (ملفات تعريف الارتباط، روابط البريد الإلكتروني، استدعاءات 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. صورة للوحة التحكم مبنية بهذه العناوين. يبنيها 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
   

ثم ضع وكيلًا عكسيًا (reverse proxy) مع TLS أمام الحاوية: cms.example.org → المنفذ 3000، back.example.org → 3100، s3.example.org → 9000. يجب أن تشترك المضيفات الثلاثة في اللاحقة DOMAIN، لأن ملف تعريف ارتباط الجلسة مقيّد بها.

اختياري (تتراجع الميزات بسلاسة عند غيابها)

خادم البريد العام

تمر جميع رسائل البريد الإلكتروني الخاصة بالمعاملات، بما في ذلك رسائل البريد الإلكتروني غير التابعة للمؤسسة مثل عمليات إعادة تعيين كلمة المرور والروابط السحرية، عبر أحد وسيطي النقل العالميين:

• 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، والواجهة الخلفية على :3100، و MinIO على :9000؛ وإعادة تعيين منافذ المضيف لها التأثير نفسه. يُعدّ برنامج التثبيت كل شيء لإعادة البناء من المستودع عندما تزوده بنطاق (انظر النطاق المخصص)، لكن البناء نفسه يستغرق عدة دقائق. توجيه تطبيق سطح المكتب إلى واجهة خلفية مستضافة ذاتيًا غير مدعوم.
• يتطلب إرسال البريد الإلكتروني خادم بريد فعال. يفرض إعداد التشغيل الأول التحقق من البريد الإلكتروني، لذلك يجب تكوين RESEND_API_KEY أو مرحّل SMTP (MAIL_SMTP_*). بعد تسجيل دخول المسؤول الأول، يمكن لكل مؤسسة أيضًا تكوين خادم بريد SMTP أو Resend الخاص بها من لوحة التحكم.
• يحتاج تطبيق سطح المكتب إلى Node.js على الجهاز لبدء خادمه المدمج.
• لا يوجد مساعد للتوثيق. يعتمد مساعد التوثيق بالذكاء الاصطناعي في intlayer.org (/api/ai/ask، /api/search/doc) على نحو 130 ميغابايت من التضمينات (embeddings) المحسوبة مسبقًا للتوثيق والتي لا تتضمنها صور الاستضافة الذاتية؛ لذا لا يتم تسجيل هذين المسارين في وضع الاستضافة الذاتية. لا تتأثر ميزات الذكاء الاصطناعي الخاصة بلوحة التحكم (الترجمة، التدقيق، الإكمال التلقائي، الدردشة) ولا تحتاج إلا إلى 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