Lokale Dispatcher-gereedschappen instellen set-up-local-dispatcher-tools

Dispatcher van Adobe Experience Manager (AEM) is een Apache HTTP Web server module die een veiligheid en prestatieslaag tussen CDN en AEM Publish rij verstrekt. Dispatcher is een integraal onderdeel van de algehele architectuur van de Experience Manager en moet deel uitmaken van de plaatselijke ontwikkelingsstructuur.

De SDK van AEM as a Cloud Service bevat de aanbevolen versie van Dispatcher Tools waarmee u het valideren en het lokaal simuleren van Dispatcher kunt configureren. Dispatcher Tools bestaat uit:

~ wordt gebruikt als steno voor de gebruikerslijst. In Windows is dit het equivalent van %HOMEPATH% .

Vereisten

Download de Dispatcher Tools (als onderdeel van de AEM SDK)

De SDK van AEM as a Cloud Service, of AEM SDK, bevat de Dispatcher Tools die worden gebruikt om Apache HTTP Web-server met de Dispatcher-module lokaal uit te voeren voor ontwikkeling, en de compatibele QuickStart Jar.

Als AEM as a Cloud Service SDK reeds aan opstelling lokale AEM runtimeis gedownload, te hoeven het niet opnieuw worden gedownload.

De Dispatcher-gereedschappen extraheren uit het ZIP-bestand van de AEM SDK

De versie van Dispatcher Tools verschilt van die van de AEM SDK. Zorg ervoor dat de versie van Dispatcher Tools wordt geleverd via de AEM SDK-versie die overeenkomt met de AEM as a Cloud Service-versie.

$ chmod a+x aem-sdk-dispatcher-tools-x.x.x-unix.sh
$ ./aem-sdk-dispatcher-tools-x.x.x-unix.sh

$ chmod a+x aem-sdk-dispatcher-tools-x.x.x-unix.sh
$ ./aem-sdk-dispatcher-tools-x.x.x-unix.sh

Alle hieronder uitgegeven bevelen veronderstellen dat de huidige het werk folder de het uitbreiden inhoud van de Hulpmiddelen van Dispatcher bevat.

Deze video gebruikt macOS voor illustratieve doeleinden. De gelijkwaardige bevelen Windows/Linux kunnen worden gebruikt om gelijkaardige resultaten te bereiken.

De Dispatcher-configuratiebestanden begrijpen

De Dispatcher Tools biedt een set Apache HTTP Web server- en Dispatcher-configuratiebestanden die gedrag voor alle omgevingen, inclusief lokale ontwikkeling, definiëren.

Deze bestanden zijn bedoeld om naar een Experience Manager Maven-project naar de map dispatcher/src te worden gekopieerd, als ze niet bestaan in het Experience Manager Maven-project.

Een volledige beschrijving van de configuratiebestanden is beschikbaar in de onverpakte Dispatcher Tools als dispatcher-sdk-x.x.x/docs/Config.html .

Configuraties valideren

Optioneel kunnen de Dispatcher- en Apache Web-serverconfiguraties (via httpd -t) worden gevalideerd met behulp van het validate -script (niet te verwarren met het validator -uitvoerbare bestand). Het validate manuscript verstrekt een geschikte manier om de drie fasenvan validator in werking te stellen.

$ ./bin/validate.sh ./src

$ bin\validate src

$ ./bin/validate.sh ./src

Dispatcher lokaal uitvoeren

AEM Dispatcher lokaal wordt uitgevoerd met Docker op basis van de configuratiebestanden van de Dispatcher- en Apache-webserver. src

$ ./bin/docker_run_hot_reload.sh <src-folder> <aem-publish-host>:<aem-publish-port> <dispatcher-port>

$ bin\docker_run <src-folder> <aem-publish-host>:<aem-publish-port> <dispatcher-port>

$ ./bin/docker_run_hot_reload.sh <src-folder> <aem-publish-host>:<aem-publish-port> <dispatcher-port>

<aem-publish-host> kan aan host.docker.internal worden geplaatst, verstrekt een speciale DNS naamDocker in de container die aan IP van de gastheermachine oplost. Als host.docker.internal niet oplost, te zien gelieve de het oplossen van problemen hieronder sectie.

U kunt bijvoorbeeld de Dispatcher Docker-container starten met de standaardconfiguratiebestanden van de Dispatcher Tools:

Start de Dispatcher Docker-container die het pad naar de SDR-configuratiemap van Dispatcher bevat:

$ ./bin/docker_run_hot_reload.sh ./src host.docker.internal:4503 8080

$ bin\docker_run src host.docker.internal:4503 8080

$ ./bin/docker_run_hot_reload.sh ./src host.docker.internal:4503 8080

De Publish Service van de AEM as a Cloud Service SDK, die lokaal wordt uitgevoerd op poort 4503, is beschikbaar via Dispatcher op http://localhost:8080 .

Om Dispatcher Tools tegen de configuratie van Dispatcher van een project van de Experience Manager in werking te stellen, richt aan de omslag van uw project dispatcher/src.

$ ./bin/docker_run_hot_reload.sh ~/code/my-project/dispatcher/src host.docker.internal:4503 8080

$ bin\docker_run <User Directory>/code/my-project/dispatcher/src host.docker.internal:4503 8080

$ ./bin/docker_run_hot_reload.sh ~/code/my-project/dispatcher/src host.docker.internal:4503 8080

Dispatcher Tools-logboeken

Dispatcher-logboeken zijn handig tijdens lokale ontwikkeling om te begrijpen of en waarom HTTP-aanvragen worden geblokkeerd. U kunt het logniveau instellen door de uitvoering van docker_run vooraf te bepalen met omgevingsparameters.

Logboeken van Dispatcher Tools worden uitgestraald naar de standaard-out wanneer docker_run wordt uitgevoerd.

Handige parameters voor foutopsporing in Dispatcher zijn:

Een of meerdere parameters, kan worden doorgegeven aan docker_run

$ DISP_LOG_LEVEL=Debug REWRITE_LOG_LEVEL=Debug ./bin/docker_run_hot_reload.sh ~/code/my-project/dispatcher/src host.docker.internal:4503 8080

$ DISP_LOG_LEVEL=Debug REWRITE_LOG_LEVEL=Debug bin\docker_run <User Directory>/code/my-project/dispatcher/src host.docker.internal:4503 8080

$ DISP_LOG_LEVEL=Debug REWRITE_LOG_LEVEL=Debug ./bin/docker_run_hot_reload.sh ~/code/my-project/dispatcher/src host.docker.internal:4503 8080

Toegang tot logbestanden

Apache-webserver en AEM Dispatcher-logbestanden zijn rechtstreeks toegankelijk in de Docker-container:

Wanneer moet u Dispatcher Tools bijwerken? dispatcher-tools-version

De versies van de Hulpmiddelen van Dispatcher stijgen minder vaak dan de Experience Manager, en daarom vereisen de Hulpmiddelen van Dispatcher minder updates in de lokale ontwikkelomgeving.

De aanbevolen versie van Dispatcher Tools is de versie die wordt meegeleverd bij de AEM as a Cloud Service SDK die overeenkomt met de as a Cloud Service versie van de Experience Manager. De versie van AEM as a Cloud Service kan via Cloud Managerworden gevonden.

Merk op dat de versie van de Hulpmiddelen van Dispatcher niet de versie van de Experience Manager aanpast.

De basislijnset van Apache- en Dispatcher-configuraties bijwerken

De basisset van Apache- en Dispatcher-configuratie wordt regelmatig verbeterd en vrijgegeven met de AEM as a Cloud Service SDK-versie. Het is beste praktijken om de verhogingen van de basislijnconfiguratie in uw AEM project op te nemen en lokale bevestigingen de pijpleidingsmislukkingen van Cloud Manager te vermijden. Werk deze bij met het script update_maven.sh in de map .../dispatcher-sdk-x.x.x/bin .

Deze video gebruikt macOS voor illustratieve doeleinden. De gelijkwaardige bevelen Windows/Linux kunnen worden gebruikt om gelijkaardige resultaten te bereiken.

Laten we veronderstellen u een AEM project in het verleden gebruikend creeerde AEM Archetype van het Project, waren de basislijn Apache en de configuraties van Dispatcher huidig. Met behulp van deze basislijnconfiguraties zijn uw projectspecifieke configuraties gemaakt door de bestanden als *.vhost , *.conf , *.farm en *.any uit de mappen dispatcher/src/conf.d en dispatcher/src/conf.dispatcher.d opnieuw te gebruiken en te kopiëren. Je lokale Dispatcher-validatie en Cloud Manager-pijpleidingen werkten prima.

Ondertussen werden de basislijnconfiguraties Apache en Dispatcher verbeterd om verschillende redenen, zoals nieuwe functies, beveiligingsoplossingen en optimalisatie. Ze worden vrijgegeven via een nieuwere versie van Dispatcher Tools als onderdeel van de AEM as a Cloud Service-release.

Wanneer u nu uw projectspecifieke Dispatcher-configuraties valideert op basis van de nieuwste versie van Dispatcher Tools, mislukt deze versie. Om dit te verhelpen, moeten de basislijnconfiguraties door onder stappen worden bijgewerkt te gebruiken:

$ ./bin/validate.sh ${YOUR-AEM-PROJECT}/dispatcher/src

...
checking 'conf.dispatcher.d/renders/default_renders.any' immutability (if present)
checking existing 'conf.dispatcher.d/renders/default_renders.any' for changes
checking 'conf.dispatcher.d/virtualhosts/default_virtualhosts.any' immutability (if present)
checking existing 'conf.dispatcher.d/virtualhosts/default_virtualhosts.any' for changes
no immutable file has been changed - check is SUCCESSFUL
Phase 3 finished

Problemen oplossen

docker_run resulteert in het bericht 'Wachten tot host.docker.internal beschikbaar is' troubleshooting-host-docker-internal

host.docker.internal is een hostnaam die aan Docker wordt verstrekt die aan de gastheer oplost. Per docs.docker.com ( macOS, Vensters):

Vanaf Docker 18.03 moet de aanbeveling met de speciale DNS naam host.docker.internal verbinden, die aan het interne IP adres oplost dat door de gastheer wordt gebruikt

Wanneer bin/docker_run src host.docker.internal:4503 8080 in het bericht het Wachten tot host.docker.internal beschikbaar is resulteert, dan:

Voorbeeldfout

$ docker_run src host.docker.internal:4503 8080

Running script /docker_entrypoint.d/10-check-environment.sh
Running script /docker_entrypoint.d/20-create-docroots.sh
Running script /docker_entrypoint.d/30-wait-for-backend.sh
Waiting until host.docker.internal is available

Aanvullende bronnen