Self-Hosting Intlayer

Intlayer dapat dijalankan di infrastruktur Anda sendiri tanpa memerlukan akun Intlayer Cloud. Tiga konfigurasi disediakan, semuanya dapat diatur menggunakan penginstal yang sama (install.sh, install.ps1 di Windows, atau npx intlayer init infra):

Table of Contents

Image dan Paket yang Diterbitkan

Ketiga image dibuat dari docker/selfhost/Dockerfile yang sama dan diterbitkan pada setiap rilis. Stack Compose juga menarik image resmi mongo:8, redis:8-alpine, dan quay.io/minio/minio.

Pengaturan

Penginstal akan menanyakan pengaturan yang diinginkan, memeriksa prasyarat (menawarkan untuk menginstal Docker), menulis file lingkungan dengan secret yang telah dibuat sebelumnya, dan menarik image. Penginstal tidak memulai apa pun dengan sendirinya: mode Docker memerlukan pengirim email terlebih dahulu, sehingga proses diakhiri dengan mencetak perintah yang harus dijalankan. Menjalankan ulang aman dilakukan: file lingkungan yang ada tidak akan pernah ditimpa, yang juga menjadikannya jalur pembaruan.

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

Pengaturan Penginstal

Tanpa --mode (atau INTLAYER_MODE), penginstal akan menampilkan menu: desktop, docker (all-in-one), atau compose. Penginstal juga membaca beberapa variabel lingkungan; teruskan ke shell alih-alih ke curl karena ini disalurkan (piped):

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

Variabel port hanya mengubah sisi host dari pemetaan. Image yang diterbitkan memiliki http://localhost:3000, http://localhost:3100, dan http://localhost:9000 yang dikompilasi ke dalam bundle dasbor, jadi pertahankan default kecuali Anda membuat image sendiri, lihat Batasan.

Pengaturan Pertama Kali

Membuka dasbor pada instance baru (database kosong) akan otomatis dialihkan ke /init:

1. Buat akun pertama. Karena koleksi pengguna kosong, akun ini secara otomatis dipromosikan menjadi Super Admin.
2. Email verifikasi dikirim melalui Resend atau relay SMTP Anda. Verifikasi email wajib dilakukan, itulah mengapa pengirim email harus dikonfigurasi sebelum memulai.
3. Klik tautan di email dan masuk.

Setelah admin ada, /init akan dialihkan ke halaman masuk biasa.

Variabel Lingkungan

Kedua mode Docker membaca file yang sama (berupa intlayer.env untuk kontainer atau .env untuk Compose) yang dihasilkan dari docker/selfhost/.env.template.

Wajib

Ditetapkan oleh Penerapan

Variabel ini diatur oleh image (all-in-one) atau oleh file compose, dan hanya perlu ditimpa untuk topologi non-standar. DOMAIN, APP_URL, BACKEND_URL, dan S3_PUBLIC_URL adalah pengecualian: jika diatur di file env, variabel ini diutamakan di kedua mode (lihat Domain kustom).

Layanan Compose app juga menerima INTLAYER_BACKEND_INTERNAL_URL=http://backend:3100: browser menjangkau API di localhost:3100, tetapi rendering sisi server berjalan di dalam jaringan Compose sehingga harus menggunakan nama layanan.

Domain kustom

Backend membaca URL publiknya saat runtime, tetapi dasbor memilikinya terkompilasi di dalamnya: image intlayer/cms-frontend dan intlayer/cms-all yang diterbitkan hanya berfungsi di http://localhost:3000. Karena itu, menyajikan Intlayer di domain Anda sendiri memerlukan dua hal, yang keduanya disiapkan oleh penginstal saat Anda menjawab pertanyaan domain:

1. Empat variabel di file env, dibaca oleh backend (cookie, tautan email, callback OAuth, URL aset) dan digunakan sebagai argumen build oleh docker-compose.build.yml:

   intlayer.env

   Salin konten

   Salin kode

   Salin kode ke clipboard

   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. Image dasbor yang dibuat dengan URL tersebut. Docker membuatnya langsung dari repositori, tanpa perlu kloning:

   sh

   Salin konten

   Salin kode

   Salin kode ke clipboard

   # 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
   

Kemudian pasang reverse proxy dengan TLS di depan kontainer: cms.example.org → port 3000, back.example.org → 3100, s3.example.org → 9000. Ketiga host harus berbagi sufiks DOMAIN, karena cookie sesi dibatasi pada domain tersebut.

Opsional (fitur akan dinonaktifkan dengan lancar jika tidak disetel)

Mailer Global

Semua email transaksional, termasuk email di luar organisasi seperti reset kata sandi dan magic link, melewati salah satu dari dua transport global:

• Resend: Menggunakan RESEND_API_KEY.
• SMTP: Menggunakan variabel MAIL_SMTP_*. Menyetel MAIL_SMTP_HOST akan langsung memilih transport SMTP dan mengabaikan RESEND_API_KEY.

MAIL_PROVIDER hanya diperlukan untuk memaksa salah satu transport jika keduanya dikonfigurasi (misalnya MAIL_PROVIDER=resend untuk tetap menggunakan Resend saat host SMTP ada).

Urutan prioritas: Mailer milik organisasi sendiri (dikonfigurasi dari dasbor Organisasi) menggantikan mailer global, dan mailer global menggantikan kunci Resend default.

Menghubungkan Proyek Intlayer Anda

Setelah stack berjalan, konfigurasikan proyek Anda untuk mengarah ke backend dan dasbor self-hosted Anda, bukan ke intlayer.org.

Konfigurasi Proyek

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>

Buat kredensial akses di dasbor self-hosted Anda di Proyek → Kunci Akses (http://localhost:3000/projects).

SDK @intlayer/api

Saat menggunakan SDK @intlayer/api secara terprogram, teruskan backendURL secara eksplisit:

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();

Batasan

• Domain kustom berarti build ulang. Semua URL VITE_* yang ditujukan untuk browser dipanggang ke dalam dasbor pada waktu build, dan image yang diterbitkan (serta aplikasi desktop) memiliki nilai localhost / Intlayer Cloud. Secara bawaan, dasbor harus diakses di http://localhost:3000, API di :3100, dan MinIO di :9000; memetakan ulang port host memiliki efek yang sama. Penginstal menyiapkan semuanya untuk build ulang dari repositori saat Anda memberikan domain (lihat Domain kustom), tetapi build itu sendiri memakan waktu beberapa menit. Mengarahkan aplikasi desktop ke backend self-hosted tidak didukung.
• Pengiriman email memerlukan mailer yang berfungsi. Pengaturan pertama kali mewajibkan verifikasi email, jadi RESEND_API_KEY atau relay SMTP (MAIL_SMTP_*) harus dikonfigurasi. Setelah admin pertama masuk, organisasi juga dapat mengonfigurasi mailer SMTP atau Resend mereka sendiri dari dasbor.
• Aplikasi desktop memerlukan Node.js di mesin untuk memulai server yang disematkan.
• Tidak ada asisten dokumentasi. Asisten dokumentasi AI intlayer.org (/api/ai/ask, /api/search/doc) bergantung pada sekitar 130 MB embedding dokumentasi yang telah dihitung sebelumnya, yang tidak disertakan dalam image self-host; kedua rute tersebut tidak didaftarkan dalam mode self-hosted. Fitur AI milik dasbor itu sendiri (terjemahan, audit, pelengkapan otomatis, chat) tidak terpengaruh dan hanya memerlukan OPENAI_API_KEY.

Tautan Berguna

• Dokumentasi Intlayer CMS
• Referensi Konfigurasi
• CMS SDK: @intlayer/api
• Rilis Aplikasi Desktop
• Docker Hub: intlayer/cms-all, intlayer/cms-frontend, intlayer/cms-backend, mirror GHCR: ghcr.io/aymericzip/intlayer/
• docker/selfhost/: Dockerfile, docker-compose.yml, .env.template