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 :

  • Le service d’éditeur universel officiel d’Adobe est hébergé à l’échelle mondiale et votre instance AEM locale doit être exposée à Internet.
  • Lors du développement avec un SDK AEM local, le service d’éditeur universel d’Adobe n’est pas accessible à partir d’Internet.
  • Si votre instance AEM présente des restrictions d’adresse IP et que le service d’éditeur universel d’Adobe ne se trouve pas dans une plage d’adresses IP définie, vous pouvez l’héberger vous-même.

Cas d’utilisation use-cases

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

  • Développez localement sur AEM pour l’utiliser avec l’éditeur universel.
  • Exécutez votre propre service d’éditeur universel dans le cadre de votre propre infrastructure, indépendamment du service d’éditeur universel d’Adobe.

Les deux cas d’utilisation sont pris en charge. Ce document explique comment exécuter AEM dans 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.

Configurer 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.

NOTE
Si vous exécutez Chrome version 130 ou ultérieure, vous devez activer l’envoi d’en-têtes CORS pour accès au réseau privé à l’aide de l’option UES_CORS_PRIVATE_NETWORK.

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

Valeur
Facultatif
Valeur par défaut
Description
UES_PORT
Oui
8080
Port sur lequel le serveur s’exécute
UES_PRIVATE_KEY
Oui
Aucune
Chemin d’accès à la clé privée du serveur HTTPS
UES_CERT
Oui
Aucune
Chemin d’accès au fichier de certification pour le serveur HTTPS
UES_TLS_REJECT_UNAUTHORIZED
Oui
true
Rejeter les connexions TLS non autorisées
UES_DISABLE_IMS_VALIDATION
Oui
false
Désactiver la validation IMS
UES_ENDPOINT_MAPPING
Oui
Vide
Mappage des points d’entrée pour les réécritures internes
Exemple : UES_ENDPOINT_MAPPING='[{"https://your-public-facing-author-domain.net": "http://10.0.0.1:4502"}]'
Résultat : le service d’éditeur universel se connectera à http://10.0.0.1:4502 au lieu du https://your-public-facing-author-domain.net de connexion fourni.
UES_LOG_LEVEL
Oui
info
Niveau de journal du serveur. Les valeurs possibles sont silly, trace, debug, verbose, info, log, warn, error et fatal
UES_SPLUNK_HEC_URL
Oui
Aucune
URL HEC vers le point d’entrée Splunk
UES_SPLUNK_TOKEN
Oui
Aucune
Jeton Splunk
UES_SPLUNK_INDEX
Oui
Aucune
Index vers lequel écrire les journaux
UES_SPLUNK_SOURCE
Oui
universal-editor-service
Nom de la source dans les journaux Splunk
UES_CORS_PRIVATE_NETWORK
Oui
false
Activez l’envoi d’en-têtes CORS pour autoriser réseau privé. Requis pour les utilisateurs de Chrome version 130+
NOTE
Avant la version 2024.08.13 de l’éditeur universel, les variables suivantes étaient requises dans le fichier .env. Ces valeurs seront prises en charge jusqu’au 1er octobre 2024 à des fins de rétrocompatibilité.
EXPRESS_PORT=8000
EXPRESS_PRIVATE_KEY=./key.pem
EXPRESS_CERT=./certificate.pem
NODE_TLS_REJECT_UNAUTHORIZED=0

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.

NOTE
Toute tentative d’accès direct à https://localhost:8000 entraîne une erreur 404. Il s’agit d’un comportement attendu.
Pour tester l’accès à votre service d’éditeur universel local, utilisez https://localhost:8000/corslib/LATEST. Voir la section suivante pour plus d’informations.
TIP
Pour plus d’informations sur la manière dont les pages sont instrumentées pour utiliser le service d’éditeur universel global, consultez le document Prise en main de l’éditeur universel dans AEM

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.

  1. Ouvrez votre navigateur pour https://localhost:8000/ping.
  2. Demandez à votre navigateur d’accepter votre certificat auto-signé.
  3. Une fois le certificat auto-signé approuvé, vous pouvez modifier la page à l’aide de votre service d’éditeur universel local.
recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab