Installing the SDK for Jahia

October 8, 2024

Introduction

This document intends to help users and developers to do a first and fast install of Jahia, mainly for a first discovery.

What's in this documentation?

This document presents the simplest installation process for Jahia SDK.

Subscription customers using the Enterprise Distribution should refer to Installing, configuring and monitoring Jahia for a complete understanding of installation options.

What this guide is not

This guide is not a complete installation guide, explaining all available options (DB, OS, Application Servers, external libs, production environments, etc.) or advanced configurations, some of which are only available to our subscription customers.

Community and Enterprise Distributions

Content and Main differences

The Community Distribution is the 100% free and open source distribution of Jahia, under GPLv3 license. The Enterprise Distribution is available through a business-friendly license (JSEL) and is designed to meet the needs of the most demanding mission-critical projects.

The Enterprise Distribution differentiates from the Community Distribution by the Digital Industrialization tools it embarks:

  • The Private App Store software
  • Roles and advanced workflows
  • User directories and SSO (LDAP, AD etc.)
  • Distant publishing
  • Clustering
  • Complex environments support (Oracle)
  • The possibility ton install specific packages like Portal Factory providing features like the Esigate or CMIS integration.

The Community Distribution shares the exact same code base as the Enterprise Distribution (we do not want to provide unstable versions to our community) but users of the Community Distribution cannot access monthly hotfixes and are not supported by Jahia expert from Jahia Solutions Group or any of its partners.

The Enterprise Distribution is available through annual subscriptions that encompass the additional Digital Industrialization tools, unlimited bug fixes, Online Technical Assistance and specific SLAs for both development and production environments.

Prices for subscriptions can be found on the pricing page on the Jahia website.

Installing the SDK

The following procedure applies to both the Community Distribution and the Enterprise Distribution of the SDK.

What is the SDK package?

The SDK package is the fastest way to discover and start coding on Jahia for developers. The SDK contains:

  • A pre-installed Jahia instance
  • The Digitall demo web site already deployed
  • Maven binaries
  • Pre-downloaded sources of templates and modules

The SDK archive

You can download the SDK Enterprise Package here (you need to be authenticated). These packages work for Windows, Linux and Mac OS X. Unzip the archive on your PC or Mac. On PC, please unzip it on C:/ or similar, not on your desktop.

Maven repository

Before building Jahia modules, you need to gather all the libraries dependencies needed to build a Jahia module.

The default configuration will create a repository folder under the directory .m2 in your home folder (HOME/.m2/repository). If you want to create a distributable repository, please edit the file settings_DX_SDK.xml to uncomment the following line:

<localRepository>${local.repo}</localRepository>

it will create a repository m2repo at the root level of the SDK. Once done, you should merge this repository with the maven repository on the targeted computer (by default HOME/.m2/repository).

From the SDK archive, execute the script ./fillRepository.sh or fillRepository.bat on Windows.

This operation can take time, depending of your bandwidth.

Procedure

  1. Launch your instance using the ./start.sh command on Mac or Linux or start.bat on Windows
  2. Open a browser, go to http://localhost:8080/, you should see our Digitall demo. Click on "Login".
  3. ROOT credentials are:
    • user: root
    • password: root
  4. Click on the root name (top - right) and switch edit mode or select the new user dashboard interface.
  5. To access the Jahia Studio, in the Edit Mode or in the new dashboard interface, click on the "Mode" dropdown menu and select "Studio"

NB: to stop you Jahia instance, use the ./stop.sh command on Mac or Linux or stop.bat on Windows

Going further

If you're completely new with Jahia, you should read the following documents

Discover Jahia

Technical overview