How to get started… Link to online references and a guide to setup your own local environment

hybris Blank content will come from two key sources:

1. hybris Wiki, an online resource provided by hybris themselves. hybris Wiki comes with a great wealth of information (remember, hybris is a massive, mature, ecommerce solution), as such, when first entering the wiki, it can be quite overwhelming. In this blog series I will often reference their wiki, so please ensure you have an account already setup ūüôā

2. Hands-on, I’m not sure about you, but I am a hands-on person. Back in my SharePoint days, I built and ran MANY SharePoint instances locally on my computer, and same will be true here. ¬†And here is my first astonishment with hybris, it has a super small footprint in regards to standalone environment!!! OK OK, granted my setup is for my personal use and by¬†no means a production environment where thousands of customers are hitting it simultaneously but when you compare to standing up a SharePoint environment (even WSS/SharePoint Foundation) it is amazingly easy and painless to setup your own environment to play in.

To help with your learning process, I suggest you setup one for yourself as well, and that will be my first official information blog:

NOTE: The following instructions are supported with hybris v5.4 and 5.5. If you are running hybris v5.6 and greater, please see Deploying hybris Sample Sites in version 5.6 and greater

How to Setup Local Environment

Let me walk you through how to setup your own local environment. Many reference below come from hybris Wiki page Quick Installation. Remember, to access hybris Wiki links, you will be required to have an account. This type of installation (what hybris describes as a Demonstration/Development environment) utilizes JVM (JAVA Virtual Machine) concept, keeping everything self contained (very clean and efficient, again, big difference from SharePoint).hybris hardware recommendations include:

Minimum Requirements

  • CPU:¬†Dual Core, e.g. i5
  • Hard Disk Type:¬†7200 rpm IDE
  • Hard Disk Size: 10 GB
  • Ram (Memory): 8 GB

Recommended Requirements

  • CPU:¬†Quad Core, e.g. i7
  • Hard Disk Type:¬†SSD
  • Hard Disk Size:¬†20 GB
  • Ram (Memory):¬†16 GB

I am using a laptop running Windows 8.1 Update 3 with i7 and 8GB of memory (ok in full disclosure, it is a MacBook Air in bootcamp, sorry just could not handle Mac OS, but love their hardware, go figure).¬†As referenced in Third-Party Compatibility – Release 5.4 (oh by the way, my hands-on expeiences will be based on version 5.4), a variety of operating systems are supported for hosting your local hybris environment,¬† but looks like Mac OS X is not supported….

Since we are running JVM, we need to ensure JAVA Engine is installed, I am running Oracle JAVA Runtime Engine 8.0 (per system requirements, you need at least version 7.0).

NOTE: rest of this guide is based on Windows 8/8.1 operating system, reference hybris Quick Installation guide for other Linux commands if running hybris on Linux platform.

Now that my computer is ready, next step is to download the hybris Commerce Suite, heads up, it is a hefty file of 2 GBs. After successful download, extract the zip to your harddrive in location of your choosing. ¬†Before we can run your environment, you need to “build” it first and it is NOT as scary as it sounds ūüôā

  1. Open search box in charms bar and type Command, you should see Command Prompt listed.
  2. Right click and select Run as administrator
  3. Go to the directory you extracted the zip file and navigation to hybris -> bin -> platform and copy the full folder path from your window address bar.
  4. Back in the Command Prompt window, type cd then hit space. Now right click and select Paste in the menu, the path is now added to the screen. Hit enter.
  5. Now type setantenv.bat and hit enter, this will begin the process to build your environment, do not close the window.
    NOTE: you will likely receive an error as shown below, this is just a warning related to initial configuration of JVM and you can disregard it:
  6. This step is complete when you see:
    Setting ant home to: C:hybrisbinplatformapache-ant-1.8.2
    Apache Ant version 1.8.2 compiled on Dec 05 2012
  7. Next enter ant clean all in same window and hit enter. You will receive another prompt in the window, just hit enter again to setup a Develop environment.
  8. Now the final steps of building your server will execute. You will know when done when you see something like this:
    Total time: 6 minutes 43 seconds

Great, you have built your environment! Thankfully the steps above is one time only (unless you want to refresh your environment). Now we need to start our environment so we can play with it. These steps below you need to run anytime you shut down your computer, so keep them handy ūüôā

  1. In the same command window type hybrisserver.bat and hit enter. This will launch your local environment in the JVM (JAVA Virtual Machine). This can take a while, so maybe go get a coffee than it will be ready.
  2. To know when it is ready you will see these lines on the screen (of course with different date and numbers ūüėČ )
    Dec 9, 2012 12:05:20 PM org.apache.catalina.startup.Catalina start
    INFO: Server startup in 112513 ms
  3.  To kill your environment, hit Ctrl + C

Ok we have one final one time setup step and that is initializing your environment. In your browser, enter localhost:9001 and you should see a page as shown below. Leave all the settings as is and click the button Initialize.


This step will take time to run, so take a break, and grab a coffee (on my computer it took 43¬†minutes to complete). if you already have a coffee in hand, I suggest¬†jump over to the hybris wiki and checkout the hybris Architecture Overview¬†This will help give you a great view into the formation of the hybris Commerce Suite and the associated components. Also introduce essential hybris terms that I will also be using in my blogs such as “cockpits”.

When the initialization is complete you will see:


To see if your environment is successfully running, let’s try to reach one of the provided¬†web sites in the hybris Commerce Accelerator, the Electronic Store. In your¬†browser, enter¬†http://localhost:9001/yacceleratorstorefront/?site=electronics&clear=true¬†you should see a page similar to shown below:


In a future post, I will discuss further about the out of box web sites provided with the hybris Accelerator and how to access each one in an easier method.

Hope you have a successful deployment!

**UPDATED – March 2, 2015**

Subsequent details regarding licensing can be read here –¬†URGENT NOTICE: Licensing limitation in your Local Environment


3 thoughts on “How to get started… Link to online references and a guide to setup your own local environment

  1. Pingback: Brief Introduction to Electronics and Apparel Sites provided by hybris Commerce AcceleratorqYuSuppotwo | hybris Blank

  2. Pingback: URGENT NOTICE: Licensing limitation in your Local Environment | hybris Blank

  3. Pingback: Deploying hybris Sample Sites in version 5.6 and greater | hybris Blank

Leave a Reply

Fill in your details below or click an icon to log in: Logo

You are commenting using your account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s