Fazer upload de ativos de UI personalizados usando CLI

Após desenvolver sua interface de login personalizada, você pode implantá-la no Logto Cloud para atender aos usuários do seu locatário. Como já introduzimos na documentação "Bring your UI", você pode fazer isso fazendo upload dos ativos de UI compactados no Logto Console.

Aqui, fornecemos outra opção para implantar seus ativos de UI na Cloud usando o comando CLI, o que será útil quando você quiser integrar o processo de implantação em um script NPM ou pipeline CI/CD.

Instruções

nota

Assumindo que você tenha seus ativos de UI de login personalizados construídos no diretório /path/to/your/custom/ui/dist.

O comando de implantação irá compactar automaticamente seus ativos de UI, fazer upload deles para o Logto Cloud e definir a UI personalizada como a experiência de login para os usuários do seu locatário.

Pré-requisitos

Como este comando interage com o Logto Management API, um aplicativo máquina para máquina é necessário para autenticar a solicitação. Consulte esta documentação para saber o que é o Logto Management API e como criar um aplicativo máquina para máquina com as permissões necessárias.

Opções de comando

--help                                 Mostrar ajuda
--version                              Imprimir versão do CLI
--auth                                 Credenciais de autenticação do seu aplicativo Logto M2M. Ex.: <app-id>:<app-secret>
--endpoint                             URI do endpoint Logto que aponta para sua instância Logto Cloud. Ex.: https://<tenant-id>.logto.app/
--path, --experience-path              O caminho da pasta local dos ativos da sua experiência de login personalizada.
--resource, --management-api-resource  Indicador de recurso do Logto Management API. Necessário se estiver usando domínio personalizado.
--verbose                              Mostrar saída detalhada. [padrão: false]

Executar o comando

Assumindo que seu ID de aplicativo é foo, o segredo do aplicativo é bar, e seu ID de locatário é baz.

npx @logto/tunnel deploy --auth foo:bar --endpoint https://baz.logto.app --experience-path /path/to/your/custom/ui/dist

Se você estiver usando um domínio personalizado para seu endpoint Logto, uma opção adicional --management-api-resource (ou --resource) deve ser especificada.

Dado que o recurso do Logto Management API é sempre fixo em https://<tenant-id>.logto.app/api. Você pode executar o comando da seguinte forma:

npx @logto/tunnel deploy --resource https://baz.logto.app/api --auth foo:bar --endpoint https://your.custom.domain --experience-path /path/to/your/custom/ui/dist

Nota:

1. Esta opção pode ser omitida ao usar o domínio padrão do Logto, pois o CLI pode inferir o recurso automaticamente.
2. Usar tanto o domínio personalizado quanto o domínio padrão do Logto como endpoint produzirá resultados idênticos.

Alternativamente, se você tiver um zip existente e preferir usá-lo diretamente, pode especificar a opção --zip-path.

npx @logto/tunnel deploy --auth foo:bar --endpoint https://baz.logto.app --zip-path /path/to/your/custom/ui/dist.zip

Variáveis de ambiente suportadas

O comando de implantação também suporta variáveis de ambiente e as mapeará automaticamente para as opções correspondentes.

Todas as variáveis de ambiente suportadas estão listadas abaixo, prefixadas com LOGTO_.

Variável de ambiente	Opção CLI
LOGTO_AUTH	--auth
LOGTO_ENDPOINT	--endpoint
LOGTO_EXPERIENCE_PATH	--experience-path
LOGTO_PATH	--path
LOGTO_MANAGEMENT_API_RESOURCE	--management-api-resource
LOGTO_RESOURCE	--resource
LOGTO_ZIP_PATH	--zip-path

Usar variáveis de ambiente

1. Você pode criar um arquivo .env no diretório raiz do CLI, ou em qualquer diretório pai onde o CLI esteja localizado.

.env

LOGTO_AUTH=foo:bar
LOGTO_ENDPOINT=https://your.custom.domain
LOGTO_EXPERIENCE_PATH=/path/to/your/custom/ui/dist
LOGTO_RESOURCE=https://baz.logto.app/api

Em seguida, execute o comando sem especificar as opções.

npx @logto/tunnel deploy

2. Alternativamente, especifique essas variáveis de ambiente diretamente ao executar o comando.

LOGTO_AUTH=foo:bar LOGTO_ENDPOINT=https://your.custom.domain LOGTO_EXPERIENCE_PATH=/path/to/your/custom/ui/dist LOGTO_RESOURCE=https://baz.logto.app/api npx @logto/tunnel deploy