Télécharger des ressources UI personnalisées en utilisant CLI

Après avoir développé votre interface de connexion personnalisée, vous pouvez la déployer sur Logto Cloud pour servir vos utilisateurs locataires. Comme nous l'avons déjà introduit dans la documentation "Bring your UI", vous pouvez y parvenir en téléchargeant les ressources UI zippées dans Logto Console.

Ici, nous proposons une autre option pour déployer vos ressources UI sur Cloud en utilisant la commande CLI, ce qui sera utile lorsque vous souhaitez intégrer le processus de déploiement dans un script NPM ou un pipeline CI/CD.

Instructions

remarque

En supposant que vous avez construit vos ressources UI de connexion personnalisées dans le répertoire /path/to/your/custom/ui/dist.

La commande de déploiement va automatiquement zipper vos ressources UI, les télécharger sur Logto Cloud, et définir l'UI personnalisée comme l'Expérience de connexion pour vos utilisateurs locataires.

Prérequis

Étant donné que cette commande interagit avec le Logto Management API, une application machine-to-machine est requise pour authentifier la requête. Référez-vous à cette documentation pour savoir ce qu'est le Logto Management API et comment créer une application machine-to-machine avec les permissions requises.

Options de commande

--help                                 Afficher l'aide
--version                              Imprimer la version CLI
--auth                                 Informations d'authentification de votre application Logto M2M. Par exemple : <app-id>:<app-secret>
--endpoint                             URI de point de terminaison Logto qui pointe vers votre instance Logto Cloud. Par exemple : https://<tenant-id>.logto.app/
--path, --experience-path              Le chemin du dossier local de vos ressources d'Expérience de connexion personnalisées.
--resource, --management-api-resource  Indicateur de ressource Logto Management API. Requis si vous utilisez un domaine personnalisé.
--verbose                              Afficher la sortie détaillée. [par défaut : false]

Exécuter la commande

En supposant que votre ID d'application est foo, le secret de l'application est bar, et votre ID de locataire est baz.

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

Si vous utilisez un domaine personnalisé pour votre point de terminaison Logto, une option supplémentaire --management-api-resource (ou --resource) doit être spécifiée.

Étant donné que le Logto Management API resource est toujours fixé à https://<tenant-id>.logto.app/api. Vous pouvez exécuter la commande comme suit :

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

Remarque :

1. Cette option peut être omise lors de l'utilisation du domaine Logto par défaut, car le CLI peut déduire automatiquement la ressource.
2. Utiliser soit un domaine personnalisé soit le domaine Logto par défaut comme point de terminaison donnera des résultats identiques.

Alternativement, si vous avez un zip existant et préférez l'utiliser directement, vous pouvez spécifier l'option --zip-path.

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

Variables d'environnement prises en charge

La commande de déploiement prend également en charge les variables d'environnement et les mappera automatiquement aux options correspondantes.

Toutes les variables d'environnement prises en charge sont listées ci-dessous, préfixées par LOGTO_.

Variable d'environnement	Option 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

Utiliser les variables d'environnement

1. Vous pouvez créer un fichier .env dans le répertoire racine du CLI, ou dans tout répertoire parent où se trouve le CLI.

.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

Ensuite, exécutez la commande sans spécifier les options.

npx @logto/tunnel deploy

2. Alternativement, spécifiez directement ces variables d'environnement lors de l'exécution de la commande.

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