Samodzielne hostowanie Intlayer

Intlayer może działać w całości na Twojej własnej infrastrukturze — konto Intlayer Cloud nie jest wymagane. Jedno polecenie uruchamia gotowy do produkcji stos:

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

Instalator pobiera plik docker-compose.yml oraz .env, automatycznie generuje wymagane sekrety i uruchamia wszystkie kontenery za pomocą docker compose up -d.

Spis treści

Architektura

                ┌─────────────────────────────┐ przeglądarka ──────▶ │  aplikacja  (TanStack Start)  :3000│ ──┐                └─────────────────────────────┘   │ VITE_BACKEND_URL                ┌─────────────────────────────┐   │                │  backend (Fastify/Bun)  :3100│ ◀─┘                └──────────────┬──────────────┘          ┌──────────┬─────────┼──────────┬───────────┐          ▼          ▼         ▼          ▼           ▼     mongo:27017  redis:6379  minio:9000  mailpit:1025  Chromium     (RS z 1 węzłem)             (API S3)     (SMTP)        (w obrazie)                             minio:9001   mailpit:8025                             (konsola)    (interfejs webowy)

Chromium (używany do generowania zrzutów ekranu przez Puppeteer) jest dołączony do obrazu backendu — nie jest potrzebny oddzielny kontener.

Wymagania wstępne

• Docker ≥ 24 i Docker Compose ≥ v2. Jeśli którykolwiek z nich jest brakujący, instalator wyświetli link do instalacji i zakończy działanie.
• Porty 3000, 3100, 8025, 9000 i 9001 dostępne na hoście.
• Host Linux lub macOS (lub WSL2 na Windows).

Szybki start

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

Co robi instalator:

1. Sprawdza, czy docker i docker compose są obecne.
2. Pobiera docker-compose.yml i .env.example do ./intlayer/.
3. Jeśli plik .env nie istnieje, kopiuje przykład i generuje losowe sekrety dla BETTER_AUTH_SECRET, S3_ACCESS_KEY_ID i S3_SECRET_ACCESS_KEY za pomocą openssl rand.
4. Uruchamia docker compose pull + docker compose up -d.
5. Wyświetla adresy URL: pulpit nawigacyjny :3000, API :3100, interfejs e-mail :8025, konsola MinIO :9001.

Po uruchomieniu stosu, otwórz http://localhost:3000 i utwórz swoje pierwsze konto.

Usługi

Wewnętrzne porty (mongo, redis) nie są domyślnie udostępniane na hoście.

Port MinIO 9000 musi być osiągalny przez przeglądarkę, ponieważ przesłane zasoby (awatary, zrzuty ekranu) są ładowane bezpośrednio z S3_PUBLIC_URL=http://localhost:9000/intlayer.

Zmienne środowiskowe

Instalator generuje gotowy do użycia plik .env. Poniższa tabela opisuje każdą zmienną.

Wymagane (generowane automatycznie lub monitowane)

Opcjonalne (funkcje działają z ograniczoną funkcjonalnością, gdy ich brakuje)

Łączenie Twojego projektu Intlayer

Po uruchomieniu stosu, skieruj swój projekt na samodzielnie hostowany backend i pulpit nawigacyjny zamiast na intlayer.org.

Konfiguracja projektu

import type { IntlayerConfig } from "intlayer";

const config: IntlayerConfig = {
  editor: {
    clientId: process.env.INTLAYER_CLIENT_ID,
    clientSecret: process.env.INTLAYER_CLIENT_SECRET,

    /**
     * URL samodzielnie hostowanego pulpitu nawigacyjnego CMS.
     * Domyślnie: https://app.intlayer.org
     */
    cmsURL: process.env.INTLAYER_CMS_URL, // np. http://localhost:3000

    /**
     * URL samodzielnie hostowanego API backendu.
     * Domyślnie: https://back.intlayer.org
     */
    backendURL: process.env.INTLAYER_BACKEND_URL, // np. http://localhost:3100
  },
};

export default config;

Ustaw zmienne środowiskowe w pliku .env Twojego projektu:

INTLAYER_CMS_URL=http://localhost:3000INTLAYER_BACKEND_URL=http://localhost:3100INTLAYER_CLIENT_ID=<your-client-id>INTLAYER_CLIENT_SECRET=<your-client-secret>

Utwórz dane uwierzytelniające dostęp w swoim samodzielnie hostowanym pulpicie nawigacyjnym w sekcji Projects → Access keys pod adresem http://localhost:3000/projects.

SDK @intlayer/api

Używając SDK @intlayer/api programowo, przekaż backendURL jawnie:

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

Aktualizacja

Ponowne uruchomienie instalatora na istniejącym wdrożeniu wykonuje aktualizację krokową:

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

Spowoduje to pobranie najnowszych obrazów i ponowne uruchomienie kontenerów za pomocą docker compose pull && docker compose up -d. Istniejące woluminy (mongo-data, redis-data, minio-data) zostaną zachowane — brak utraty danych.

Aby ręcznie zaktualizować z poziomu katalogu ./intlayer/:

docker compose pulldocker compose up -d

Kopia zapasowa i przywracanie

Wszystkie trwałe dane znajdują się w trzech nazwach woluminów Docker.

Kopia zapasowa

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

Przywracanie

docker run --rm \  -v intlayer_mongo-data:/data \  -v "$(pwd)":/backup \  busybox tar xzf /backup/mongo-data.tar.gz -C /# Powtórz dla redis-data i minio-data

Używanie reverse proxy (Nginx / Caddy)

W przypadku wdrożeń produkcyjnych, umieść reverse proxy przed kontenerami aplikacji i backendu, zamiast udostępniać je bezpośrednio.

Przykład Nginx

server {    listen 80;    server_name cms.example.com;    location / {        proxy_pass http://localhost:3000;        proxy_set_header Host $host;        proxy_set_header X-Real-IP $remote_addr;    }}server {    listen 80;    server_name api.example.com;    location / {        proxy_pass http://localhost:3100;        proxy_set_header Host $host;        proxy_set_header X-Real-IP $remote_addr;    }}

Zaktualizuj poniższe zmienne .env, aby odpowiadały Twoim publicznym domenom:

BACKEND_URL=https://api.example.comAPP_URL=https://cms.example.comDOMAIN=example.comVITE_BACKEND_URL=https://api.example.comVITE_DOMAIN=example.com

Zmienne VITE_* są wbudowywane w obraz pulpitu nawigacyjnego podczas kompilacji. Jeśli zmienisz je po zbudowaniu obrazu, musisz ponownie zbudować obraz app (docker compose build app) lub użyć wstrzykiwania konfiguracji w czasie uruchomienia.

Rozwiązywanie problemów

Backend w pętli awarii przy pierwszym uruchomieniu

MongoDB i Redis muszą być sprawne przed uruchomieniem backendu. Plik compose używa depends_on z condition: service_healthy. Jeśli widzisz powtarzające się restarty backendu, sprawdź, czy testy kondycji mongo i redis przechodzą pomyślnie:

docker compose psdocker compose logs mongodocker compose logs redis

Pulpit nawigacyjny nie może dotrzeć do API

Sprawdź, czy VITE_BACKEND_URL odpowiada adresowi URL, pod którym backend jest osiągalny z przeglądarki (nie z sieci Docker). Jeśli zmieniłeś port backendu lub dodałeś reverse proxy, ponownie zbuduj obraz pulpitu nawigacyjnego:

docker compose build appdocker compose up -d app

E-mail nie jest wysyłany

Domyślnie wszystkie wychodzące wiadomości e-mail są przechwytywane przez Mailpit. Otwórz http://localhost:8025, aby zobaczyć wysłane wiadomości. Aby wysyłać prawdziwe wiadomości e-mail, ustaw MAIL_PROVIDER=resend i RESEND_API_KEY=<your-key> w .env, a następnie zrestartuj backend:

docker compose restart backend

Brak zasobnika MinIO

Jeśli jednorazowa usługa minio-init nie uruchomiła się (lub uruchomiła się, zanim MinIO było gotowe), utwórz zasobnik ręcznie:

docker compose run --rm minio-init

Przydatne linki

• Dokumentacja Intlayer CMS
• Referencje konfiguracji
• SDK CMS — @intlayer/api