Polecenie logowania Intlayer CLI

Opis

Polecenie login w Intlayer CLI umożliwia uwierzytelnienie w Intlayer CMS. Polecenie to automatycznie otwiera domyślną przeglądarkę, aby dokończyć proces uwierzytelniania i otrzymać niezbędne dane dostępowe (Client ID i Client Secret) do korzystania z usług Intlayer.

Użycie

npx intlayer login [options]

or

intlayer login [options]

Opcje

--cms-url <url>

Określa URL Intlayer CMS, z którym należy się połączyć w celu uwierzytelnienia.

• Typ: string
• Domyślnie: Wartość skonfigurowana w intlayer.config.* lub https://intlayer.org
• Przykład:

npx intlayer login --cms-url https://intlayer.org

Opcje konfiguracyjne

Możesz również użyć ogólnych opcji konfiguracyjnych:

• --env-file <path>: Ścieżka do pliku środowiskowego
• -e, --env <env>: Środowisko wykonawcze
• --base-dir <dir>: Katalog główny projektu
• --verbose: Włącz szczegółowe wyjście (domyślnie: true)
• --prefix <prefix>: Prefiks dla logów

Jak to działa

1. Uruchomienie lokalnego serwera: Polecenie uruchamia lokalny serwer HTTP na losowym porcie, aby odebrać dane dostępowe od CMS
2. Otwieranie przeglądarki: Polecenie automatycznie otworzy domyślną przeglądarkę do adresu logowania CMS
3. Uwierzytelnianie: Ukończ proces uwierzytelniania w przeglądarce, używając konta Intlayer
4. Odbiór poświadczeń: Serwer lokalny otrzymuje Client ID i Client Secret od CMS
5. Instrukcje: Polecenie wyświetla instrukcje konfiguracji poświadczeń w Twoim projekcie

Wyjście

Po pomyślnym logowaniu polecenie wyświetli:

1. Otrzymane poświadczenia (Client ID i Client Secret)
2. Instrukcje dla pliku .env:

INTLAYER_CLIENT_ID=your_client_id
INTLAYER_CLIENT_SECRET=your_client_secret

3. Instrukcje dla pliku konfiguracyjnego Intlayer:

{
  editor: {
    cmsURL: 'https://intlayer.org',
    clientId: process.env.INTLAYER_CLIENT_ID,
    clientSecret: process.env.INTLAYER_CLIENT_SECRET,
  },
}
    clientId: process.env.INTLAYER_CLIENT_ID,
    clientSecret: process.env.INTLAYER_CLIENT_SECRET,
  },
}

Bezpieczeństwo klucza dostępu

intlayer login wydaje klucz dostępu: parę clientId / clientSecret, którą każde polecenie wymagające uwierzytelnienia (push, pull, fill, configuration push, live, …) wykorzystuje do autentykacji.

import type { IntlayerConfig } from "intlayer";

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

export default config;

clientSecret to poświadczenie po stronie serwera. Przyznaje pełny dostęp do API na poziomie projektu, czytanie i pisanie słowników, projektu i organizacji. Przechowuj go w .env (ignorowany przez git) lub w magazynie wpisów tajnych CI, nigdy nie umieszczaj go w pliku konfiguracyjnym.

Intlayer wymusza to zamiast tylko tego dokumentować:

• clientSecret jest usuwany z konfiguracji, którą bundler встраивает, więc nie może dotrzeć do bundle'a przeglądarki niezależnie od używanej integracji frameworka. Jest odczytywany tylko po stronie serwera, w czasie wykonania, ze środowiska.
• clientId jest inny: to publiczny klucz projektu, bezpieczny do wysyłki i używany przez @intlayer/analytics do uzyskania krótkotrwałego tokenu tylko do pozyskiwania danych.

Zakomentowanie clientId wystarczy, aby wyłączyć każde zachowanie wymagające uwierzytelnienia (pobieranie słowników zdalnych, dostęp do CMS, analizę) nawet gdy zmienne środowiskowe są jeszcze zdefiniowane.

W przypadku potoków CI preferuj flagę --ci, która wstrzykuje poświadczenia na czas pojedynczego uruchomienia zamiast ich utrwalania.

Ręczna konfiguracja

Jeśli przeglądarka nie otworzy się automatycznie, możesz ręcznie odwiedzić URL wyświetlony w terminalu.

Przykłady

Logowanie z niestandardowym URL CMS

npx intlayer login --cms-url https://custom-cms.example.com

Logowanie z określonym plikiem środowiskowym

npx intlayer login --env-file .env.production

Logowanie w trybie verbose

npx intlayer login --verbose

Rozwiązywanie problemów

Przeglądarka się nie otwiera

Jeśli przeglądarka nie otworzy się automatycznie, skopiuj URL wyświetlony w terminalu i otwórz go ręcznie w przeglądarce.

Problemy z połączeniem

Jeśli wystąpią problemy z połączeniem, sprawdź:

1. Czy adres URL CMS jest poprawny
2. Czy połączenie internetowe działa poprawnie
3. Czy żadne zapory sieciowe (firewalle) nie blokują połączenia
4. Że Twoje połączenie z internetem działa poprawnie
5. Że żadne zapory sieciowe nie blokują połączenia

Nie otrzymano poświadczeń

Jeśli poświadczenia nie zostały otrzymane:

1. Upewnij się, że zakończyłeś proces uwierzytelniania w przeglądarce
2. Sprawdź, czy lokalny port nie jest zablokowany
3. Spróbuj ponownie uruchomić polecenie

Następne kroki

Po zakończeniu logowania:

1. Dodaj poświadczenia do pliku .env
2. Skonfiguruj plik intlayer.config.*, używając tych poświadczeń
3. Użyj poleceń CLI do zarządzania słownikami:
   npx intlayer push

   npx intlayer pull

   npx intlayer fill

Zobacz także