Getting Started

Here you will learn how to install and configure an Axon Ivy Engine and ultimately how to bring your processes to life by deploying your Axon Ivy projects. As you will see, a minimal setup of an Axon Ivy Engine is straightforward. Next to the Axon Ivy Engine, you only need a browser of your choice (e.g. Firefox) and a database management system (e.g. PostgreSQL) for storing the data of the Axon Ivy Engine.

digraph overview { layout=neato; node [shape=box, height="0.8", width="2", color="#007095", style=filled, fixedsize="true", margin=0, fontname="Roboto,Helvetica Neue,Arial,sans-serif", fontcolor="white", fontsize=15 ]; /* nodes */ browser [ label="Browser", pos="0,0!", height="0.8", width="1.5"]; engine [label="Axon Ivy\nEngine", pos="3,0!", height="0.8", width="1.5", color="#C7D426", fontcolor="black"]; systemdb [ label="System\nDatabase", pos="6,0!", height="0.8", width="1.5"] /* edges */ browser -> engine; engine -> systemdb; /* edge labels */ browser_engine [ label="HTTP(S)\n \n ", pos="1.5,0!", width="1.7", height="0.8", shape=none, fillcolor=none, fontcolor="black", fontsize="11" ]; engine_systemdb [ label="JDBC\n \n ", pos="4.5,0!", width="1.7", height="0.8", shape=none, fillcolor=none, fontcolor="black", fontsize="11" ]; }

At this point, you need to choose a platform. The Axon Ivy Engine runs on all modern runtime environments:

  • Debian

    We provide a Debian package for Debian-based Linux systems like Ubuntu or Linux Mint. Besides the install capabilities, this package offers great support for later upgrades of the Axon Ivy Engine.

  • Docker

    The Axon Ivy Engine is provided as a docker image. You can run the Axon Ivy Engine in a simple docker-compose setup or in container orchestration platforms like Kubernetes or Openshift. This package provides optimal installation, configuration and upgrade support.

  • Linux

    If you are on a non-Debian-based Linux system, choose this option. Compared to the Debian package, you will miss the install and upgrade capabilities. Compared to Debian and Docker, more effort is required to install and subsequently upgrade the Axon Ivy Engine.

  • Windows

    Windows is the operating system of choice in many places. Compared to Debian and Docker, more effort is required to install and subsequently upgrade the Axon Ivy Engine.

Non-Demo Setup

Out of the box, the Axon Ivy Engine runs in Demo mode without a license. In this mode, it uses an in-memory, non-persistent database.

To run an Axon Ivy Engine in non-Demo mode (i.e. for integration, test/acceptance and production environments), you have to order a license for the Axon Ivy Engine and install the Axon Ivy Engine on a system that fulfills the system requirements.

Please be aware of the integration possibilities. For example:

  • For security reasons, we highly recommend to use a reverse proxy.

  • You can synchronize your users from an external user management system to minimize the administration effort.

  • For high availability, performance and scalability, you can cluster the Axon Ivy Engine.