Exécution de votre propre service d’éditeur universel local-ue-service

Découvrez comment exécuter votre propre service d’éditeur universel pour le développement local ou dans le cadre de votre propre infrastructure.

Vue d’ensemble overview

Le service d’éditeur universel lie l’éditeur universel et le système principal. Pour pouvoir développer localement pour l’éditeur universel, vous devez exécuter une copie locale du service Éditeur universel. En effet :

Cas d’utilisation use-cases

Votre propre copie du service d’éditeur universel est utile si vous souhaitez :

Les deux cas d’utilisation sont pris en charge. Ce document explique comment exécuter AEM en HTTPS avec une copie locale du service d’éditeur universel.

Si vous souhaitez exécuter votre propre service d’éditeur universel dans le cadre de votre propre infrastructure, vous devez suivre les mêmes étapes que pour l’exemple de développement local.

Configuration d’AEM pour une exécution sur HTTPS aem-https

Dans une trame externe sécurisée par HTTPS, une trame HTTP non sécurisée ne peut pas être chargée. Le service d’éditeur universel s’exécute sur HTTPS. Par conséquent, AEM ou toute autre page distante doit également s’exécuter sur HTTPS.

Pour ce faire, vous devez configurer AEM pour qu’il s’exécute sur HTTPS. À des fins de développement, vous pouvez utiliser un certificat autosigné.

Voir ce document sur la configuration d’AEM s’exécutant sur HTTPS, y compris un certificat autosigné que vous pouvez utiliser.

Installation du service de l’éditeur universel install-ue-service

Le service Éditeur universel n’est pas une copie intégrale de l’éditeur universel, mais uniquement un sous-ensemble de ses fonctionnalités pour s’assurer que les appels de votre environnement AEM local ne sont pas acheminés via Internet, mais à partir d’un point d’entrée défini que vous contrôlez.

NodeJS version 20 est nécessaire pour exécuter une copie locale du service de l’éditeur universel.

Le service d’éditeur universel est disponible via la distribution logicielle. Veuillez consulter la Documentation sur la distribution logicielle pour plus d’informations sur la manière d’y accéder.

Enregistrez le fichier universal-editor-service.cjs de la distribution logicielle dans votre environnement de développement local.

Créez un certificat pour exécuter le service de l’éditeur universel avec HTTPS ue-https

Le service d’éditeur universel requiert également un certificat pour s’exécuter sur HTTPS dans votre environnement de développement.

Exécutez la commande suivante.

$ openssl req -newkey rsa:2048 -nodes -keyout key.pem -x509 -days 365 -out certificate.pem

La commande génère un key.pem et un fichier certificate.pem. Enregistrez ces fichiers dans le même chemin d’accès que votre fichier universal-editor-service.cjs.

Configuration du service de l’éditeur universel setting-up-service

Un certain nombre de variables d’environnement doivent être définies dans NodeJS pour exécuter le service d’éditeur universel localement.

Sur le même chemin d’accès que vos fichiers universal-editor-service.cjs, key.pem et certificate.pem, créez un fichier .env avec le contenu suivant.

UES_PORT=8000
UES_PRIVATE_KEY=./key.pem
UES_CERT=./certificate.pem
UES_TLS_REJECT_UNAUTHORIZED=false
UES_CORS_PRIVATE_NETWORK=true

Ce sont les valeurs minimales requises pour le développement local dans notre exemple.

Le tableau suivant détaille ces valeurs et les valeurs supplémentaires disponibles.

Exécution du service de l’éditeur universel running-ue

Pour démarrer le service d’éditeur universel, exécutez la commande suivante :

$ node ./universal-editor-service.cjs

Il doit générer les éléments suivants vers votre terminal :

Universal Editor Service listening on port 8000 as HTTPS Server

Assurez-vous que le service démarre le serveur HTTPS et non le serveur HTTP.

Utilisation du service d’éditeur universel local au lieu du service global using-local-ue

L’éditeur universel sait quel service d’éditeur universel utiliser pour modifier une page en fonction de la manière dont la page est instrumentée. Cette opération s’effectue à l’aide de balises meta dans la page chargée dans l’éditeur universel.

Pour qu’une page soit modifiée à l’aide de votre service d’éditeur universel local, la balise meta suivante doit être définie :

<meta name="urn:adobe:aue:config:service" content="https://localhost:8000">

Une fois défini, vous devriez voir chaque appel de mise à jour de contenu accéder à https://localhost:8000 au lieu du service d’éditeur universel par défaut.

Modification d’une page avec le service d’éditeur universel local editing

Avec le service d’éditeur universel s’exécutant localement et votre page de contenu exécutée pour utiliser le service local, vous pouvez maintenant démarrer l’éditeur.