fmarchon / jahia-development-environment

Jahia Vagrant Development Environment

This is not supported by Jahia. Use at your own risk.

Install

• Vagrant 1.7.4 - http://www.vagrantup.com/downloads.html
• Virtual Box 5.0.16 - https://www.virtualbox.org/
• Homebrew - http://brew.sh/
• Ansible 2.1.0.0, brew install ansible

Installed Applications on VM

• Digital Factory Enterprise Edition 7.1.2.0
• Marketing Factory 1.0
• Forms Factory 1.1
• Nginx
• Java 8
• Apache Maven 3
• MySQL 5
• OpenLDAP
• Shibboleth IDP
• Mongo
• Redis

These files will be downloaded on your local environment in the {{development-environment}}/opt folder. This folder can be removed, but any future vagrant up will redownload these files to set up your VM.

Setting up

• cd {{development-environment}}
• git clone [e-mail]:Jahia/jahia-development-environment.git
• Rename vagrant_config.sample.yml to vagrant_config.yml. Make any adjustments to the configuration in the vagrant config.
• vagrant up

Host configuration

• sudo vi /etc/hosts
• Add 192.168.33.99 jahia.local ldap.jahia.local idp.jahia.local

Start Jahia

• Jahia is set up as a service.
• Is set up as a single-node cluster
• Generated files are save under the /vagrant/opt/generated-resources ** service tomcat stop|start|restart|status

Regis

• /var/log/regis/redis.log

Regis will be used for Distributed Session. The Distributed Session module has been already installed in Jahia.

Navigate

Tomcat

• http://jahia.local:8080/
• User: root
• Password: root

Nginx

• http://jahia.local
• User: root
• Password: root
• /var/log/nginx/access.log
• /var/log/nginx/error.log

Nginx is set up for load balancing and sticky session. Currently, Nginx is load balanced to one Jahia DX node. Update the /etc/nginx/conf.d/jahia.conf to add another Jahia DX node.

OpenLDAP

• http://ldap.jahia.local
• User: cn=Manager,dc=digitall,dc=com
• Password: root
• Users
• smomin/root

Shibboleth IDP

• IDP Metadata: https://idp.jahia.local/idp/shibboleth, checks to see if IDP returns metadata.
• IDP Status: https://idp.jahia.local/idp/status, checks to see if IDP is configured properly.
• Logs: /opt/shibboleth-idp/logs, folder where logs are created.
• SAML Authentication Valve, [e-mail]:Jahia/saml-authentication-valve.git, must be enabled for the site

Edit Mode

• Site Settings > SAML2 Settings
• Identity Provider Url: https://idp.jahia.com/idp/shibboleth
• Relying Party Indentifier: https://sp.jahia.org/shibboleth-sp
• Incoming Target Url: /cms/login.SAML.incoming
• IDP Metadata Location: /opt/shibboleth-idp/metadata/idp-metadata.xml
• Signing Cert Location: /opt/shibboleth-idp/credentials/idp-signing.crt
• Encryption Cert Location: /opt/shibboleth-idp/credentials/idp-encryption.crt

The IDP is a java webapp deployed in the Jahia tomcat webapps folder. If any issues hitting the above shibboleth end points, vagrant ssh into the environment and execute sudo service tomcat restart or vagrant reload to restart the virtual machine.

Mongo

• Configurations
• Host: 127.0.0.1
• Port: 17017
• DB: jahiadb
• Collection: users
• Users
• [e-mail]/password
• [e-mail]/password
• [e-mail]/password
• /var/log/mongodb/mongod.log

Shared Folders

• Create a link or folder /opt/code on your local computer. This path on your local will mirror that path on the virtual environment. This way any maven commands executed on remote or local with have the correct path to the source code so that Jahia Studio will be able to scan the folders. Developer can work in the virtual environment by SSH into the box. If you plan to work in the manner, you can execute mvn clean install jahia:deploy -P jahia-server, which will package up the moduleset and deploy it to Digital Factory.

If the steps above execute without any errors, you should now be able to navigate to http://jahia.local.

Deploy a module on the Virtual Machine

Create a symbolic link

• Open vagrant_config.yml and uncomment the line with the parameter synced_local_folder and synced_vagrant_folder
• Modify this line to map your local folder containing your module(s) to the virtual folder where you wish to find your module(s).
• vagrant reload

Deploy a module

• On the virtual machine, navigate to your module's sources (ex: /opt/projectName)
• mvn clean install jahia:deploy

Maven

Once Homebrew is installed, you can use it to install easily Maven on your computer using this command : brew install maven It will install Maven, and automatically perform the export command (you can check it using `mvn -version)

Enhanced terminal with Git support

• Download and install iTerm2 : http://iterm2.com/
• Open iTerm2 and change the default shell to Zsh : chsh -s /bin/zsh
• Install oh-my-zsh : curl -L https://github.com/robbyrussell/oh-my-zsh/raw/master/tools/install.sh | sh
• Close your iTerm2 window and open a new one. Navigate to a directory with a git repository, you should be able to see on which branch you currently are

Miscellaneous

This process will install Jahia Enterprise version, with a trial licence of 30 days.

By default, all will be installed (JDK, Maven, Jahia, ...) in the /opt folder of the virtual box.