Intlayer सेल्फ-होस्टिंग

Intlayer आपके अपने बुनियादी ढांचे पर चल सकता है, किसी Intlayer Cloud खाते की आवश्यकता नहीं है। तीन सेटअप उपलब्ध हैं, जो सभी एक ही इंस्टॉलर (install.sh, Windows पर install.ps1, या 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 मोड docker/selfhost/.env.template से उत्पन्न एक ही फ़ाइल (कंटेनर के लिए intlayer.env, Compose के लिए .env) पढ़ते हैं।

आवश्यक

परिनियोजन द्वारा तय

ये इमेज (ऑल-इन-वन) या compose फ़ाइल द्वारा सेट किए जाते हैं, और इन्हें केवल गैर-मानक टोपोलॉजी के लिए ओवरराइड करने की आवश्यकता होती है। DOMAIN, APP_URL, BACKEND_URL और S3_PUBLIC_URL इसके अपवाद हैं: env फ़ाइल में सेट होने पर, ये दोनों मोड में प्राथमिकता लेते हैं (कस्टम डोमेन देखें)।

Compose app सेवा अतिरिक्त रूप से INTLAYER_BACKEND_INTERNAL_URL=http://backend:3100 प्राप्त करती है: ब्राउज़र localhost:3100 पर API तक पहुँचता है, लेकिन सर्वर-साइड रेंडरिंग 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. उन 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 प्रत्यय साझा करना होगा, क्योंकि सेशन कुकी उसी तक सीमित है।

वैकल्पिक (अनुपस्थित होने पर सुविधाएं सुचारू रूप से कार्य करती हैं)

ग्लोबल मेलर

पासवर्ड रीसेट और मैजिक लिंक जैसे गैर-संगठन ईमेल सहित सभी लेन-देन संबंधी ईमेल दो वैश्विक ट्रांसपोर्ट में से एक से होकर गुजरते हैं:

• Resend: RESEND_API_KEY का उपयोग करके।
• SMTP: MAIL_SMTP_* चरों का उपयोग करके। जैसे ही MAIL_SMTP_HOST सेट होता है, SMTP का उपयोग किया जाता है और RESEND_API_KEY को अनदेखा कर दिया जाता है।

MAIL_PROVIDER केवल तभी आवश्यक होता है जब दोनों कॉन्फ़िगर होने पर किसी एक ट्रांसपोर्ट को बाध्य करना हो (उदाहरण के लिए SMTP होस्ट मौजूद होने पर Resend रखने के लिए MAIL_PROVIDER=resend)।

प्राथमिकता क्रम: किसी संगठन का अपना मेलर (संगठन डैशबोर्ड से कॉन्फ़िगर किया गया) ग्लोबल मेलर को ओवरराइड करता है, और ग्लोबल मेलर डिफ़ॉल्ट 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) पर एक्सेस क्रेडेंशियल बनाएं।

@intlayer/api SDK

प्रोग्रामेटिक रूप से @intlayer/api SDK का उपयोग करते समय, 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();

सीमाएँ

• कस्टम डोमेन का अर्थ है पुनर्निर्माण। सभी ब्राउज़र-सामना करने वाले VITE_* URL निर्माण के समय डैशबोर्ड में इनलाइन होते हैं, और प्रकाशित इमेज (और डेस्कटॉप ऐप) localhost / Intlayer Cloud मानों के साथ आते हैं। डिफ़ॉल्ट रूप से डैशबोर्ड को http://localhost:3000 पर, API को :3100 पर और MinIO को :9000 पर एक्सेस किया जाना चाहिए; होस्ट पोर्ट को रीमैप करने का भी यही प्रभाव होता है। जब आप डोमेन देते हैं तो इंस्टॉलर रिपॉजिटरी से पुनर्निर्माण के लिए सब कुछ तैयार कर देता है (कस्टम डोमेन देखें), लेकिन बिल्ड में स्वयं कई मिनट लगते हैं। डेस्कटॉप ऐप को सेल्फ-होस्टेड बैकएंड पर इंगित करना समर्थित नहीं है।
• ईमेल के लिए एक कार्यशील मेलर की आवश्यकता होती है। प्रथम-रन सेटअप ईमेल सत्यापन लागू करता है, इसलिए या तो RESEND_API_KEY या SMTP रिले (MAIL_SMTP_*) कॉन्फ़िगर किया जाना चाहिए। पहले एडमिन के साइन इन करने के बाद, प्रत्येक संगठन डैशबोर्ड से अपना स्वयं का SMTP या Resend मेलर भी कॉन्फ़िगर कर सकता है।
• डेस्कटॉप ऐप को अपने एम्बेडेड सर्वर को शुरू करने के लिए मशीन पर Node.js की आवश्यकता होती है।
• कोई डॉक्यूमेंटेशन असिस्टेंट नहीं। intlayer.org का AI डॉक असिस्टेंट (/api/ai/ask, /api/search/doc) लगभग 130 MB के पूर्व-गणना किए गए डॉक्यूमेंटेशन एम्बेडिंग पर निर्भर करता है जो सेल्फ-होस्ट इमेज में शामिल नहीं होते; इसलिए सेल्फ-होस्टेड मोड में ये दो रूट पंजीकृत नहीं होते। डैशबोर्ड की अपनी AI सुविधाएँ (अनुवाद, ऑडिट, ऑटोकम्प्लीट, चैट) अप्रभावित रहती हैं और उन्हें केवल 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