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

Découvrez comment vous pouvez 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 est ce qui lie l’éditeur universel et le système principal. Pour pouvoir développer localement pour Universal Editor, vous devez exécuter une copie locale du service Universal Editor. En effet :

Cas d’utilisation use-cases

Votre propre copie du service Universal Editor 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 Universal Editor.

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 l’exemple de développement local.

Configuration d’AEM à exécuter sur HTTPS aem-https

Dans un cadre externe sécurisé avec HTTPS, un cadre HTTP non sécurisé ne peut pas être chargé. Le service Universal Editor s’exécute sur HTTPS. Par conséquent, AEM ou toute autre page distante doit s’exécuter également 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 auto-signé.

Consultez ce document sur la configuration de l’AEM s’exécutant sur HTTPS, y compris un certificat auto-signé que vous pouvez utiliser.

Installation du service Universal Editor 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 pour s’assurer que les appels provenant de votre environnement d’AEM local ne sont pas acheminés sur Internet, mais à partir d’un point de terminaison défini que vous contrôlez.

NodeJS version 20 est nécessaire pour exécuter une copie locale du service Universal Editor.

Le service d’éditeur universel est disponible via Distribution logicielle. Pour plus d’informations sur la façon d’y accéder, consultez la documentation sur la distribution de logiciels.

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

Création d’un certificat pour exécuter le service Universal Editor avec HTTPS ue-https

Le service d’éditeur universel requiert également un certificat à 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 fichier key.pem et un fichier certificate.pem. Enregistrez ces fichiers dans le même chemin que votre fichier universal-editor-service.cjs.

Configuration de la 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 localement le service d’éditeur universel.

Sur le même chemin 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

Il s’agit des valeurs minimales requises pour le développement local dans notre exemple. Le tableau suivant présente en détail ces valeurs et les valeurs supplémentaires disponibles.

Exécution du service Universal Editor running-ue

Pour démarrer le service Universal Editor, exécutez la commande suivante :

$ node ./universal-editor-service.cjs

Il doit générer les résultats suivants sur 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

Universal Editor 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 par le biais de balises META dans la page chargée dans Universal Editor.

Pour qu’une page soit modifiée à l’aide de votre service Universal Editor 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 aller à 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 instrumentée pour utiliser le service local,vous pouvez maintenant démarrer l'éditeur.