Exécuter 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 développer localement avec l’éditeur universel, exécutez une copie locale du service d’é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 infrastructure, suivez les mêmes étapes que dans 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 en HTTPS et, par conséquent, AEM ou toute autre page distante doit également s’exécuter en HTTPS.

Pour ce faire, configurez AEM pour qu’il s’exécute en HTTPS. À des fins de développement, vous pouvez utiliser un certificat auto-signé.

Consultez ce document expliquant comment configurer AEM pour qu’il s’exécute en HTTPS, y compris avec un certificat auto-signé que vous pouvez utiliser.

Installation du service d’éditeur universel install-ue-service

Le service d’éditeur universel n’est pas une copie complète de l’éditeur universel, mais seulement un sous-ensemble de ses fonctionnalités afin de garantir que les appels provenant de votre environnement AEM local ne transitent pas par Internet, mais par un point de terminaison défini que vous contrôlez.

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

Le service d’éditeur universel est disponible via la plateforme Software Distribution (Distribution de logiciels). Veuillez consulter la documentation Software Distribution pour obtenir des détails sur la manière d’y accéder.

Enregistrez le fichier universal-editor-service.cjs depuis Software Distribution dans votre environnement de développement local.

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

Le service d’éditeur universel nécessite également un certificat pour s’exécuter en 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 fichier 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 d’é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 d’éditeur universel running-ue

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

$ node ./universal-editor-service.cjs

Le terminal doit afficher le résultat suivant :

Universal Editor Service listening on port 8000 as HTTPS Server

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

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 méta 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 méta suivante doit être définie :

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

Une fois définie, chaque appel de mise à jour de contenu doit être dirigé vers 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 exécuté localement et votre page de contenu instrumentée pour utiliser le service local, vous pouvez maintenant démarrer l’éditeur.