Self-Hosting Intlayer

Intlayer dapat berjalan sepenuhnya di infrastruktur Anda sendiri — tidak memerlukan akun Intlayer Cloud. Satu perintah akan mem-boot stack yang siap produksi:

Satu perintah menginstal semuanya:

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

Installer mengunduh docker-compose.yml dan .env, membuat secret yang diperlukan secara otomatis, dan memulai semua kontainer dengan docker compose up -d.

Satu-satunya dependensi eksternal adalah MongoDB: backend terhubung ke cluster MongoDB Atlas, yang Anda sediakan. Semua yang lain berjalan di dalam container.

Daftar Isi

Arsitektur

                ┌─────────────────────────────┐
 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 (digunakan untuk pembuatan screenshot Puppeteer) dibundel di dalam image backend — tidak diperlukan kontainer terpisah.

Prasyarat

• Docker ≥ 24 dan Docker Compose ≥ v2. Jika salah satunya tidak ada, installer akan mencetak tautan instalasi dan keluar.
• Port 3000, 3100, 8025, 9000, dan 9001 tersedia di host.
• Host Linux atau macOS (atau WSL2 di Windows).

Semuanya — Bun, Redis, MinIO, Chromium — dikirimkan di dalam image.

Memulai dengan cepat

1. Jalankan installer

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

Installer memverifikasi bahwa Docker terinstall dan berjalan, menulis ./intlayer.env dengan BETTER_AUTH_SECRET dan S3_SECRET_ACCESS_KEY yang sudah digenerate, dan menarik image. Installer tidak memulai container — backend tidak dapat boot tanpa kredensial database Anda.

Menjalankan installer kembali aman: intlayer.env yang sudah ada tidak akan pernah ditimpa, jadi ini juga berfungsi sebagai jalur upgrade.

2. Isi kredensial Anda

Buka intlayer.env dan lengkapi nilai-nilai yang ditandai TODO:

DB_ID=<atlas-user>
DB_MDP=<atlas-password>
DB_CLUSTER=<cluster>.xxxxx.mongodb.net
RESEND_API_KEY=<your-resend-key>

File ini juga berisi blok yang dikomentari untuk fitur-fitur opsional — SMTP mailer, OPENAI_API_KEY, dan penyedia OAuth. Uncomment yang Anda butuhkan.

File dibaca oleh docker run --env-file, yang tidak menghapus tanda kutip dan menganggap semua yang setelah = sebagai nilai. Tulis nilai tanpa tanda kutip, dan simpan komentar di baris terpisah.

3. Mulai container

Ini adalah perintah yang dicetak oleh installer ketika selesai:

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 \
  ghcr.io/aymericzip/intlayer-selfhost:latest

Kemudian buka http://localhost:3000. Boot pertama menginisialisasi datastores, jadi tunggu sebentar.

Dashboard disajikan di localhost. Lihat Limitations — domain kustom tidak didukung oleh image yang dipublikasikan.

Pengaturan Installer

Installer membaca beberapa variabel environment. Karena di-pipe ke sh, teruskan ke shell daripada ke curl:

curl -fsSL https://intlayer.org/install.sh | INTLAYER_ENV_FILE=./config/intlayer.env sh

Keempat variabel port hanya mengubah sisi host dari mapping yang dicetak dalam perintah docker run. Image yang dipublikasikan memiliki http://localhost:3000, http://localhost:3100 dan http://localhost:9000 dikompilasi ke dalam bundle dashboard pada saat build, jadi remapping mereka membuat browser tetap menunjuk ke port lama. Pertahankan default kecuali Anda membangun image Anda sendiri — lihat Limitations.

Memulai Cepat

Apa yang dilakukan installer:

1. Memeriksa bahwa docker dan docker compose ada.
2. Mengunduh docker-compose.yml dan .env.example ke ./intlayer/.
3. Jika tidak ada .env yang ada, menyalin contoh dan menghasilkan secret acak untuk BETTER_AUTH_SECRET, S3_ACCESS_KEY_ID, dan S3_SECRET_ACCESS_KEY melalui openssl rand.
4. Menjalankan docker compose pull + docker compose up -d.
5. Mencetak URL: dashboard :3000, API :3100, UI email :8025, konsol MinIO :9001.

Setelah stack aktif, buka http://localhost:3000 dan buat akun pertama Anda.

Layanan

Port MinIO 9000 harus dapat dijangkau oleh browser karena aset yang diunggah (avatar, screenshot) dimuat langsung dari S3_PUBLIC_URL=http://localhost:9000/intlayer.

Variabel lingkungan

Diperlukan

Wajib (dibuat secara otomatis atau diminta)

Opsional (fitur akan menurun secara bertahap jika tidak ada)

Global mailer

Secara default, semua email transaksional dikirim melalui Resend menggunakan RESEND_API_KEY. Deployment yang self-hosted dapat mengarahkan setiap email — termasuk email non-organisasi seperti reset password dan magic links — melalui global mailer yang dikonfigurasi dengan environment variables.

Atur MAIL_PROVIDER untuk mengaktifkannya. Ketika tidak diatur, mailer Resend default digunakan.

Precedence: mailer milik organisasi sendiri (dikonfigurasi dari dashboard Organization) mengambil prioritas atas global mailer, yang pada gilirannya mengambil prioritas atas kunci Resend default.

Menghubungkan proyek Intlayer Anda

Setelah stack berjalan, arahkan proyek Anda ke backend dan dashboard yang di-self-host, 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 dashboard CMS yang di-self-host.
     * Default: https://app.intlayer.org
     */
    cmsURL: process.env.INTLAYER_CMS_URL, // e.g. http://localhost:3000

    /**
     * URL API backend yang di-self-host.
     * Default: https://back.intlayer.org
     */
    backendURL: process.env.INTLAYER_BACKEND_URL, // e.g. http://localhost:3100
  },
};

export default config;

Setel variabel lingkungan di .env proyek Anda:

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 dashboard self-host Anda di bawah Projects → Access keys di http://localhost:3000/projects.

@intlayer/api SDK

Saat menggunakan @intlayer/api SDK 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();

Peningkatan

Ini menarik image terbaru dan memulai ulang kontainer dengan docker compose pull && docker compose up -d. Volume yang sudah ada (mongo-data, redis-data, minio-data) dipertahankan — tidak ada kehilangan data.

docker compose pull
docker compose up -d

Cadangkan dan pulihkan

Semua data persisten berada dalam tiga volume Docker bernama.

Cadangkan

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

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

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

Pulihkan

docker run --rm \
  -v intlayer_mongo-data:/data \
  -v "$(pwd)":/backup \
  busybox tar xzf /backup/mongo-data.tar.gz -C /

# Ulangi untuk redis-data dan minio-data

Keterbatasan

• MongoDB harus external (Atlas). Backend terhubung hanya melalui mongodb+srv:// (dibangun dari DB_ID / DB_MDP / DB_CLUSTER), jadi plain mongodb://host:27017 — termasuk mongod bundled container sendiri — tidak dapat digunakan. Sediakan cluster MongoDB Atlas.
• Tidak ada custom domain. Semua URL VITE_* yang dihadapi browser di-inline ke dalam app pada saat build, dan image yang dipublikasikan dilengkapi dengan nilai localhost. Dashboard harus diakses di http://localhost:3000; melayaninya di domain publik memerlukan rebuilding image dengan target URLs yang tertanam dan tidak didukung out of the box.
• Email memerlukan mailer yang berfungsi. Setup first-run menerapkan verifikasi email, jadi baik RESEND_API_KEY atau global SMTP mailer (MAIL_PROVIDER=smtp + MAIL_SMTP_*) harus dikonfigurasi. Setelah admin pertama masuk, setiap organisasi juga dapat mengonfigurasi SMTP atau Resend mailer-nya sendiri dari dashboard.

Pemecahan Masalah

Backend crash-loops pada start pertama

MongoDB dan Redis harus sehat sebelum backend dimulai. File compose menggunakan depends_on dengan condition: service_healthy. Jika Anda melihat restart backend berulang, periksa apakah healthchecks mongo dan redis lulus:

docker compose ps
docker compose logs mongo
docker compose logs redis

Cari MongoDB connection error di bagian atas log.

Dashboard tidak dapat mencapai API

Verifikasi bahwa VITE_BACKEND_URL cocok dengan URL di mana backend dapat dijangkau dari browser (bukan jaringan Docker). Jika Anda mengubah port backend atau menambahkan reverse proxy, bangun ulang image dashboard:

Bucket MinIO hilang

Jika layanan one-shot minio-init tidak berjalan (atau berjalan sebelum MinIO siap), buat bucket secara manual:

docker compose run --rm minio-init

Tautan Berguna

• Dokumentasi Intlayer CMS
• Referensi Konfigurasi
• SDK CMS — @intlayer/api
• Docker Image (aymercizip/intlayer-selfhost)