GETTING STARTED WITH SETTING UP BLOOMREACH XM CMS AS A HEADLESS CAAS INSTANCE

Watch this video to get an idea of how to setup XIN Mods on your *NIX-based machine.

GETTING STARTED

To get started using this software, simply clone the following repository. Its main branch is called stable, this is where the latest SNAPSHOT code lives.

If you'd rather checkout a specific version, please checkout its corresponding version tag, that way, you know for sure you're getting the actual release code.

					$ git clone https://github.com/XIN-Solutions/hippo-xinmods
					

Once the repository has been cloned simply run the start-local.sh and wait for the CMS to finish starting up. The first time make take a while as you're having to download all the Bloomreach XM related dependencies.

You can now navigate to http://localhost:8080/cms/ and login using admin for both username and password.

It should look something like this:

Start with Bloomreach XM and XIN Mods using Docker Compose

If you're not expecting to make any changes to the backend project and would prefer to use Docker to deploy a local instance, use this docker-compose.yml file instead:

					version: '3'
					services:
					
					  mysql:
					    image: xinsolutions/bloomreach-xinmods-mysql
					    stdin_open: true
					    tty: true
					    restart: always
					    environment:
					      MYSQL_ALLOW_EMPTY_PASSWORD: 'yes'
					
					    volumes:
					      - mysql-data:/var/lib/mysql
					
					
					  brxm:
					    image: xinsolutions/bloomreach-xinmods-cms
					
					    stdin_open: true
					    tty: true
					    restart: always
					
					    environment:
					      - MYSQL_HOST=mysql
					      - MYSQL_DATABASE=bloomreach
					      - MYSQL_PORT=3306
					      - MYSQL_USERNAME=root
					      - MYSQL_PASSWORD=
					      - BRXM_CMS_HOST=http://bloomreach.local
					
					    volumes:
					      - bloomreach-repo:/var/lib/hippostorage
					
					    links:
					      - 'mysql'
					
					volumes:
					  bloomreach-repo:
					  mysql-data:

Then run `docker-compose up` to start a new set of containers. Use `docker network inspect` on the newly created network to discover the IP of `brxm` instance, and add it to your host file with the `bloomreach.local` alias. After starting the containers you should be ready to go!

 

Next Steps

To get a full understand of the functionality offered by XIN Mods go back to the overview and select the different functionalities to get a better idea.

If you're used to Bloomreach's Experience Manager, the next step is to understand the additional APIs XIN Mods introduces. An easy way to experiment with them is to use the xinmods NPM package to integrate the backend into your Node frontend.

To understand how to use it in a NodeJS application, please reference the tutorial repository:

• xinmods npm package
• Tutorial Repository