Inspired by AEM-Devbox

AEM Author, Publisher and Dispatcher in one VM With a logging server*. managed via Vagrant and provisioned via Ansible. "AEM-UP" comes from Vagrant up command

*This VM runs a tailon server to show you logs in browser! no SSH necessary!

TL;DR:

• Stack:
• Requirements
• Setup
• Configuration
  • Port forwarding
  • Runmodes
  • Dispatcher Configuration
    • Editing dispatcher configs
    • applying dispatcher changes
  • Increase VM memory and CPU cores
  • JVM/AEM parameters
  • Ansible extra arguments (Mac/Linux only)
• Default Ports
• SSH into VM
• Logs
• VM script (Mac/Linux* only)

Table of contents generated with markdown-toc

• Vagrant
• Ansible
• CentOs 7 vagrant image.

• vagrant 2.1.5 or higher Install Vagrant
• Ansible 2.7 or higher Install Ansible
• AEM JAR and license.
• Latest Dispatcher module*.

*Download from PackageShare. choose Linux x86 64bit for example: dispatcher-apache2.4-linux-x86-64-4.2.3.tar.gz

1. Add AEM JAR, license and dispatcher module:

   copy your cq-quickstart-<version>.jar, license.properties and dispatcher-apache2.4-<version>.so to user-provided folder.

   Pay close attention to step 2

Folder structure should look something like this:

  .
  ├── LICENSE.md
  ├── README.md
  ├── Vagrantfile
  ├── binaries
  │   └── tailon
  │       ├── LICENSE
  │       ├── README.md
  │       └── tailon
  ├── dispatcher
  │   ├── 00-dispatcher.conf
  │   ├── dispatcher.any
  │   └── dispatcher.conf
  ├── playbook.yml
  ├── services
  │   ├── aem-author.service
  │   ├── aem-publish.service
  │   └── tailon.service
  ├── user-provided
  │   ├── cq-quickstart-6.4.0.jar
  │   ├── dispatcher-apache2.4-4.2.3.so
  │   └── license.properties
  └── vm

2. Tell Ansible where your file names

   open playbook.yml and edit the variables aem_jar_name and dispatcher_module_name** (documentation in the file)

3. Run VM

   On Mac? use ./vm up. see the VM script below.

   Not on Mac? run vagrant up

   This VM binds no non-standard ports (46##), see Default Ports below. This can be changed: read Configuration section below.

   HELP: If you have experience converting bash scripts to windows, I could use the help to convert vm script.

4. buy me coffee? JK, just star the repo :)

   NOTE: you will need to setup replication agents and configs as needed. This setup only installs AEM.

ie. Changing localhost ports

You can do this in the Vagrantfile. There is a port forwarding. You may se entries like:

# Ports Forwarding  
config.vm.network "forwarded_port", guest: 4602, host: 4602
config.vm.network "forwarded_port", guest: 4603, host: 4603
config.vm.network "forwarded_port", guest: 80, host: 4604
config.vm.network "forwarded_port", guest: 8080, host: 4605

leave guest ports untouched, and change host ports to your heart's content!

in playbook.yml you can change values for aem_publish_runmodes and aem_author_runmodes

Dispatcher will be installed with default configs.

• Edit dispatcher.any at path: dispatcher/dispatcher.any
• Edit dispatcher conf at path: dospatcher/00-dispatcher.conf

...after the VM has been created.

Once done with your changes, you can apply them with the provision command:

ANSIBLE_ARGS='--tags "aem_dispatcher"' vagrant provision

this wont work on windows, you'd have to run vagrant provision to re-provision the whole VM. Unless you know how to pass env variables :)

in vagrantfile change vb.memory and vb.cpu

You can set Java and AEM params in Environment directive in services/aem-author.service and services/aem-publish.service

You can pass extra arguments to Ansible as part of the vagrant provision command by setting the params to the environment variable ANSIBLE_ARGS.

HELP: need to know how to do this on windows.

for example:

ANSIBLE_ARGS='--tags "aem_dispatcher"' vagrant provision

passes --tags "aem_dispatcher" to ansible, to run tasks with tag aem_dispatcher

Use vagrant ssh while on the root of this project directory. This allows you to SSH with the key vagrant generated when it setup the VM.

Go to localhost:4605 to see logs reported by tailon

Please note tailon has a bug with regards to showing the full path of the log in the web UI. I opened a PR to fix it. It should still allow you se all the logs with no issues.

You can also SSH into VM as mentioned above to see logs.

*Must support bash

run ./vm help or look into the vm file, I added a LOT of documentation :).