Esecuzione del servizio editor universale local-ue-service
Scopri come eseguire il servizio editor universale per lo sviluppo locale o come parte dell’infrastruttura.
Panoramica overview
Il servizio editor universale è ciò che lega l’editor universale e il sistema di back-end. Per poter sviluppare in locale l’editor universale, è necessario eseguire una copia locale del servizio editor universale. Questo perché:
- Il servizio editor universale ufficiale di Adobe è ospitato a livello globale e l’istanza AEM locale dovrebbe essere esposta a Internet.
- Durante lo sviluppo con AEM SDK locale, non è possibile accedere al servizio editor universale di Adobe da Internet.
- Se l’istanza di AEM presenta restrizioni IP e il servizio editor universale di Adobe non è incluso in un intervallo IP definito, è possibile ospitarlo personalmente.
Casi d’uso use-cases
Una copia personalizzata del servizio editor universale è utile per:
- Lo sviluppo locale su AEM per l’utilizzo con l’editor universale.
- L’esecuzione del servizio editor universale come parte dell’infrastruttura, indipendentemente dal servizio editor universale di Adobe.
Sono supportati entrambi i casi d’uso. Questo documento spiega come eseguire AEM in HTTPS insieme a una copia locale del servizio editor universale.
Per eseguire il servizio editor universale come parte dell’infrastruttura, è necessario seguire gli stessi passaggi dell’esempio di sviluppo locale.
Configurare AEM per l’esecuzione su HTTPS aem-https
All’interno del frame esterno protetto con HTTPS, non è possibile caricare un frame HTTP non sicuro. Il servizio editor universale viene eseguito su HTTPS, pertanto anche AEM o qualsiasi altra pagina remota deve essere eseguito su HTTPS.
A questo scopo, devi configurare AEM per l’esecuzione su HTTPS. A scopo di sviluppo, puoi utilizzare un certificato autofirmato.
Consulta questo documento su come configurare AEM in esecuzione su HTTPS, incluso un certificato autofirmato utilizzabile.
Installare il servizio editor universale install-ue-service
Il servizio editor universale non è un'intera copia dell’editor universale, ma solo un sottoinsieme delle relative funzioni per garantire che le chiamate dall’ambiente AEM locale non vengano instradate su Internet, ma da un endpoint definito controllato.
Per eseguire una copia locale del servizio editor universale è necessario NodeJS versione 20.
Il servizio editor universale è disponibile tramite distribuzione software. Per informazioni dettagliate su come accedervi, consulta la documentazione sulla distribuzione software.
Salva il file universal-editor-service.cjs
dalla distribuzione software nell’ambiente di sviluppo locale.
Creare un certificato per eseguire il servizio editor universale con HTTPS ue-https
Il servizio editor universale richiede inoltre un certificato per l’esecuzione su HTTPS nell’ambiente di sviluppo.
Esegui il comando seguente.
$ openssl req -newkey rsa:2048 -nodes -keyout key.pem -x509 -days 365 -out certificate.pem
Il comando genera un file key.pem
e un file certificate.pem
. Salva questi file nello stesso percorso del file universal-editor-service.cjs
.
Configurazione del servizio editor universale setting-up-service
È necessario impostare alcune variabili di ambiente in NodeJS per eseguire il servizio editor universale in locale.
Nello stesso percorso dei file universal-editor-service.cjs
, key.pem
e certificate.pem
, crea un file .env
con il contenuto seguente.
UES_PORT=8000
UES_PRIVATE_KEY=./key.pem
UES_CERT=./certificate.pem
UES_TLS_REJECT_UNAUTHORIZED=false
UES_CORS_PRIVATE_NETWORK=true
Nel nostro esempio, questi sono i valori minimi richiesti per lo sviluppo locale.
UES_CORS_PRIVATE_NETWORK
.La tabella seguente descrive questi e altri valori aggiuntivi disponibili.
UES_PORT
8080
UES_PRIVATE_KEY
UES_CERT
UES_TLS_REJECT_UNAUTHORIZED
true
UES_DISABLE_IMS_VALIDATION
false
UES_ENDPOINT_MAPPING
Esempio:
UES_ENDPOINT_MAPPING='[{"https://your-public-facing-author-domain.net": "http://10.0.0.1:4502"}]'
Risultato: il servizio editor universale si connetterà a
http://10.0.0.1:4502
invece della connessione https://your-public-facing-author-domain.net
specificataUES_LOG_LEVEL
info
silly
, trace
, debug
, verbose
, info
, log
, warn
, error
e fatal
UES_SPLUNK_HEC_URL
UES_SPLUNK_TOKEN
UES_SPLUNK_INDEX
UES_SPLUNK_SOURCE
universal-editor-service
UES_CORS_PRIVATE_NETWORK
false
.env
erano richieste le seguenti variabili. Questi valori saranno supportati fino al 1° ottobre 2024 per la compatibilità con le versioni precedenti.EXPRESS_PORT=8000
EXPRESS_PRIVATE_KEY=./key.pem
EXPRESS_CERT=./certificate.pem
NODE_TLS_REJECT_UNAUTHORIZED=0
Esecuzione del servizio editor universale running-ue
Per avviare il servizio editor universale, esegui questo comando:
$ node ./universal-editor-service.cjs
Dovrebbe trasmettere quanto segue al terminale:
Universal Editor Service listening on port 8000 as HTTPS Server
Verifica che il servizio avvii il server HTTPS e non il server HTTP.
Utilizzo del servizio editor universale locale anziché del servizio globale using-local-ue
L’editor universale conosce il servizio editor universale da utilizzare per modificare una pagina in base alla strumentazione. Questa operazione viene eseguita tramite i meta tag nella pagina caricata nell’editor universale.
Per modificare una pagina con il servizio editor universale locale, devi impostare il seguente meta tag:
<meta name="urn:adobe:aue:config:service" content="https://localhost:8000">
Una volta impostato, ogni chiamata di aggiornamento del contenuto dovrebbe passare a https://localhost:8000
anziché al servizio editor universale predefinito.
https://localhost:8000
genera un errore 404
. Questo è il comportamento previsto.https://localhost:8000/corslib/LATEST
. Per informazioni dettagliate, consulta la sezione successiva.Modifica di una pagina con il servizio editor universale locale editing
Con il servizio editor universale in esecuzione localmente e la pagina contenuto dotata di strumenti per l’utilizzo del servizio locale, ora puopi avviare l’editor.
- Apri il browser per
https://localhost:8000/ping
. - Indirizza il browser per accettare il certificato autofirmato.
- Una volta che il certificato autofirmato è attendibile, puoi modificare la pagina utilizzando il servizio editor universale locale.