Starting an Environment

November 14, 2023

Overview

Multiple deployments are available to run an jExperience environment, the System Administrator guide contains step by step instructions to manually install and run jExperience.

This document will be focused on running jExperience with Docker as it is the easiest method to get started with jExperience.

Running jExperience with Docker

Using Docker jointly with Jahia provisioning API allows you to easily start a jExperience environment with its dependencies.

The following resources will be started:

  • One mariaDB instance
  • One Jahia instance, using mariaDB to persist data
  • One Elasticsearch single-node cluster
  • One jCustomer instance

Assuming you already have Docker installed and configured on your machine,  and after making sure you don't already have an environment currently running and using ports 9200, 8080, 9443, 8181, 8102, you can start the environment on your machine using the following commands:


cd ~
git clone https://github.com/Jahia/provisioning-tutorials.git
cd provisioning-tutorials/04-jexperience
docker-compose up --renew-anon

These resources will be automatically configured using default variables, most of which are detailed in the `.env` file. Additional environment variables (notably: JCUSTOMER_MAXMIND_GEOIP2_CITY_DATABASE_URL and JCUSTOMER_GEONAMES_ALL_COUNTRIES_ARCHIVE_URL) are available to further customize the environment. You can find more details about these variables on this Academy page.

The environment will be provisioned and ready to use once you stop seeing events in your terminal.

If you are not already familiar with the Jahia provisioning API, following the provisioning tutorials is a good opportunity to understand how you can modify the jExperience environment to best fit your needs.