aem-dispatcher-docker

This is an reference repo to setup AEM dispatcher with example configurations.

Pre-requisite

0. Download Docker from https://www.docker.com/products/docker-desktop
1. Your AEM publisher should be running and should have valid content pages that are accessible from browser. ex: localhost:4503/content/wknd/us/en.html

Structure

/
|-- src
|    |-- conf.d  
|    |   |-- *      # Follow https://github.com/adobe/aem-project-archetype. Adobe recommended structure.
|    |-- conf.dispatcher.d   
|    |   |-- *      # Follow https://github.com/adobe/aem-project-archetype. Adobe recommended structure.
|-- dockerfile      # Change this file according to your requirement. 
|-- README.md       # Check https://hub.docker.com/r/aemcloud/dispatcher for the latest dispatcher version

Follow below steps

• (OPTIONAL step) Add the HOST_IP and PORT if you want to hard-code the IP and port in dispatcher configuration. You can skip this step as this is being passed in docker run commnad in the next step.

0. Go to /src/conf.d/variables/default.vars replace the IP and PORT values as shown below

   Define AEM_IP 192.168.1.18
   Define AEM_HOST 192.168.1.18
   Define AEM_PORT 4503

1. You can customize almost everything by changing something inside src folder. Make sure if you do a major folder change you need to do the same change in dockerfile as well regarding the location.

• Steps to bring up the dispatcher

0. docker build -t dispatcher-image .
1. docker run -p 8080:80 -e PUBLISH_DOMAIN=host.docker.internal -e PUBLISH_IP=host.docker.internal -e PUBLISH_PORT=4503 --name dispatcher-container dispatcher-image
2. Test by browsing localhost:8080. Try a valid URL like localhost:8080/content/wknd/us/en.html to verify that it's working or not.

Some docker commands

0. docker ps to check current status of all running container
1. docker container ls -a to check list of available container
2. docker container rm container_name_or_id_here to delete a docker container. Ex: docker container rm dispatcher-container
3. docker images to check list of available images
4. docker rmi image_name_or_id_here to delete a docker image. Ex: docker rmi dispatcher-image
5. docker container prune to delete all containers
6. docker image prune -a to delete all images
7. docker exec -it container_name_or_id /bin/bash to ssh inside the container. Ex: docker exec -it dispatcher-container /bin/bash

Some more points

0. host.docker.internal is the alias for localhost of your host machine from docker. In case this doesn't work you can try your local LAN IP to replace this.
1. MAC: ifconfig, Windows: ipconfig to find your local LAN IP. You can test the LAN IP directly in your browser by using 198.0.1.18:4502 instead of localhost:4502 where 198.0.1.18 should be your LAN IP you got from the previous point command.

• Update regarding Cache

0. Go to src/conf.dispatcher.d/enabled_farms/default.farm change /allowAuthorized "1" from /allowAuthorized "0" to cache all authorized requests. Try this step if your cache is not generating under /var/www/html
1. Check https://adobe-consulting-services.github.io/acs-aem-commons/features/http-cache/ if you do not want to use dispatcher for cache

Inspired by https://hub.docker.com/r/aemcloud/dispatcher