This Docker Image is unmaintained at the moment as my current employer does not use SAP Hybris. As the access to current releases and documentation is restricted to people working for SAP Hybris parterns its not possible for me to keep this project up to date. Therefore feel free to contact me if you like to maintain this project.

hybris-base-image

A base image for Hybris Commerce Suite, based on ubuntu:latest.

Can be used Out-Of-The-Box for projects based on Hybris Commerce Suite >5.5.

Please read this documentation directly in GitHub. Otherwise the links might not work.

The image on DockerHub is built automatically from the Dockerfile in the GitHub source repository.

Installed packages

• gosu
• lsof
• unzip
• ca-certificates
• curl
• oracle java 8 (1.8.0_171 via PPA Repository)

User

User	Group	uid	gid
hybris	hybris	1000	1000

Ports

Port	Purpose
9001	default HTTP port
9002	default HTTPS port
8983	default SOLR port
8000	default DEBUG port

The image exposes 9001 and 9002 for access to the hybris Tomcat server via HTTP and HTTPS.

Also the default Solr server port 8983 is exposed.

Please be aware that in non dev environments the Solr server(s) should run in own container(s).

If you like to debug via your IDE on the running server you can use the exposed 8000 port.

Volumes

The hybris home directory /home/hybris is marked as volume. You can override it by setting the HYBRIS_HOME variable.

How to add your code

Using a Dockerfile you can copy the output archives, generated using ant production, into the hybris home directory of the image. The entrypoint-script will unzip them when the container starts.

If you want you can copy unzipped content too, but this will bloat the images you push to your own repository.

FROM stefanlehmann/hybris-base-image:latest
MAINTAINER You <[email protected]>

# copy the build packages over
COPY hybrisServer*.zip $HYBRIS_HOME

Configuration support

For support of different database configurations per container the following environment variables can be set when starting a container. They will be used to add the properties in second column to local.properties file.

Environment variable	local.properties
HYBRIS_DB_URL	db.url=$HYBRIS_DB_URL
HYBRIS_DB_DRIVER	db.driver=$HYBRIS_DB_DRIVER
HYBRIS_DB_USER	db.username=$HYBRIS_DB_USER
HYBRIS_DB_PASSWORD	db.password=$HYBRIS_DB_PASSWORD
HYBRIS_DATAHUB_URL	datahubadapter.datahuboutbound.url=$HYBRIS_DATAHUB_URL

Of course you can also build with defaults like db.url=jdbc:mysql://database-container/database?useConfigs=maxPerformance&characterEncoding=utf8 in your local.properties and use the linking functionality of docker to inject the correct container name which should be mapped to database-container.

Clustering

For easy clustering the entrypoint-script adds the property cluster.broadcast.method.jgroups.tcp.bind_addr with currently used container-IP-adress to local.properties. Please be aware that this only happens on first start of the container, so when you restart the container and maybe get another ip this can lead to not working clustering.

How to use

As this image is just a base for running SAP Hybris you need to either copy your own production artefacts in and commit the result as your own image or mount a directory containing them. For the latter no own images are needed.

Using hybris artefacts copied into image

docker run -d --name HYBRIS_CONTAINER_NAME -p HOST_HTTP_PORT:9001 -p HOST_HTTPS_PORT:9002 REGISTRY/IMAGE:VERSION

Using hybris artefacts in directory on Docker host

docker run -d --name HYBRIS_CONTAINER_NAME -p HOST_HTTP_PORT:9001 -p HOST_HTTPS_PORT:9002 -v /PATH/TO/hybris:/home/hybris stefanlehmann/hybris-base-image:latest

Running with debug listener enabled

docker run -d --name HYBRIS_CONTAINER_NAME -p HOST_HTTP_PORT:9001 -p HOST_HTTPS_PORT:9002 REGISTRY/IMAGE:VERSION run debug

The important part is the run debug at the end if the line.

Running update system when starting a container

For automation of running the system update before starting the server you can use the environment variable HYBRIS_UPDATE_SYSTEM=yes. You can find the default configuration for this in updateRunningSystem.config.

If you like to use your own configuration you can export it in HAC

After you got your config you can include it into your own application image via

FROM stefanlehmann/hybris-base-image:latest
MAINTAINER You <[email protected]>

# copy the build packages over
COPY hybrisServer*.zip $HYBRIS_HOME

# copy the update system config to image
COPY updateRunningSystem.config $HYBRIS_HOME/updateRunningSystem.config

Hint

As the image is not intended for recompiling the hybris platform inside a container please get sure to build with following parameter in your local.properties to avoid hardcoded paths in your config artifact:

## https://wiki.hybris.com/display/release5/ant+production+improvements#antproductionimprovements-withoutAntHowtorunhybrisserveronproductionenvironmentwithoutneedtocallanyanttarget
## for docker we need to use the PLATFORM_HOME environment variable instead of absolute paths in server*.xml files and wrapper*.conf files
production.legacy.mode=false

Complete example on how to use this image

Build of complete image (B2C Acc)

# download hybris 6.5
curl -v -u "USER:PASSWORD" https://nexus.YOURCOMPANY.com/nexus/repository/thirdparty/de/hybris/platform/hybris-commerce-suite/6.5.0.0/hybris-commerce-suite-6.5.0.0.zip -o hybris-commerce-suite-6.5.0.0.zip

# unzip hybris
unzip hybris-commerce-suite-6.5.0.0.zip || ( e=$? && if [ $e -ne 1 ]; then exit $e; fi )

# add custom config for creation of production artifacts
cd installer
chmod +x install.sh
echo "production.legacy.mode=false
installed.tenants=
website.apparel-de.http=http://YOUR-DOCKER-HOST:9001/yacceleratorstorefront
website.apparel-de.https=https://YOUR-DOCKER-HOST:9002/yacceleratorstorefront
website.apparel-uk.http=http://YOUR-DOCKER-HOST:9001/yacceleratorstorefront
website.apparel-uk.https=https://YOUR-DOCKER-HOST:9002/yacceleratorstorefront
website.electronics.http=http://YOUR-DOCKER-HOST:9001/yacceleratorstorefront
website.electronics.https=https://YOUR-DOCKER-HOST:9002/yacceleratorstorefront" > customconfig/custom.properties

# run installer with b2c recipe
./install.sh -r b2c_acc_plus

# create production artifacts
cd ../hybris/bin/platform
. ./setantenv.sh
ant clean all production

# create Dockerfile
cd ../../..
mkdir docker
mv hybris/temp/hybris/hybrisServer/hybrisServer*.zip docker/
cd docker
echo "FROM stefanlehmann/hybris-base-image:latest
ENV PLATFORM_HOME=\$HYBRIS_HOME/bin/platform
ENV PATH=\$PLATFORM_HOME:\$PATH
COPY hybrisServer*.zip $HYBRIS_HOME" >> Dockerfile
cat Dockerfile

Alternative way of building complete image using Dockerfile (with intermediate buildcontainer) only

FROM stefanlehmann/hybris-base-image:latest as buildcontainer
ENV HYBRIS_VERSION 6.5.0.0
WORKDIR /tmp

# download hybris
RUN curl --location --silent -u "USER:PASSWORD" \
"https://nexus.YOURCOMPANY.com/nexus/repository/thirdparty/de/hybris/platform/hybris-commerce-suite/$HYBRIS_VERSION/hybris-commerce-suite-$HYBRIS_VERSION.zip" \
-o "hybris-commerce-suite-$HYBRIS_VERSION.zip"

# if you get the zip from build context you can of course copy it into the buildcontainer directly
# COPY hybris-commerce-suite-"${HYBRIS_VERSION}".zip .

# add custom settings from build context (optional)
# COPY custom.properties installer/customconfig/custom.properties

# build production zips
RUN unzip -qq hybris-commerce-suite-"${HYBRIS_VERSION}".zip \
&& cd installer \
&& chmod +x install.sh \
&& ./install.sh -r b2c_acc \
&& cd ../hybris/bin/platform \
&& . ./setantenv.sh \
&& ant clean all production

# build real image
FROM stefanlehmann/hybris-base-image:latest
COPY --from=buildcontainer /tmp/hybris/temp/hybris/hybrisServer/*.zip /home/hybris/

Build the image (still in docker dir created before)

docker build .

Tag and upload image (optional if you build image on your docker host)

docker tag IMAGEID IMAGENAME
docker push IMAGENAME

Start Image

docker run -d -p 9001:9001 -p 9002:9002 IMAGEID/IMAGENAME

Initialize

Open https://YOUR-DOCKER-HOST:9002/ and use HAC for Initialization

or set HYBRIS_INITIALIZE_SYSTEM environment variable to yes

Accelerator Frontend

Open https://YOUR-DOCKER-HOST:9002/yacceleratorstorefront?site=apparel-de