Installation

Install Axon.ivy Engine

To install the Axon.ivy Engine extract the correct zip file for your platform to the directory where you want to install the Axon.ivy Engine. For Debian based operating systems there is a convenient installer package available. The following platforms are supported:

CPU

Architecture

Operation System

Installation File

Intel

x64

Debian (Ubuntu/Mint)

axonivy-engine-V_X.Y.Z.deb

Intel

x64

Windows

AxonIvyEngineX.Y.Z_Windows_x64.zip

Intel

x64

Linux and Windows*

AxonIvyEngineX.Y.Z_All_x64.zip

Intel

x64

Linux and Windows*

AxonIvyEngineX.Y.Z_Slim_All_x64.zip

* The All and Slim_All engines are delivered with launchers for Linux and Windows, but without a JRE. To use the slim Axon.ivy Engine set up the IVY_JAVA_HOME environment variable pointing to a supported x64 JRE, or the JAVA_HOME environment variable pointing to a supported x64 JDK. The slim Axon.ivy Engine comes without demo projects.

Note

Note, that the installation procedure implies sufficient administration and access rights on the system. For example, the access to drive C: on a Windows Server 2008 system is very restrictive that you might install the programs on drive D: instead.

Start the Axon.ivy Engine

You can start the Axon.ivy Engine by navigation to the bin folder and executing the AxonIvyEngine binary on Linux:

cd bin
./AxonIvyEngine

and the AxonIvyEngineC.exe on Windows:

cd bin
AxonIvyEngineC.exe

Alternative, you can use the Control Center to start the Axon.ivy Engine. By default the Axon.ivy Engine starts in Demo Mode.

Installing a Licence

You have to install a licence in order to run Axon.ivy Engine in Production Mode. To order a licence file you need to know the public URLs that end users will use to access your Axon.ivy Engine.

Example

Let’s assume your Axon.ivy Engine is installed on a machine with the DNS name axonivyprod and listens on port 8080. Users access the Axon.ivy Engine in two different ways:

  • Intranet users use http://axonivyprod:8080/ivy/* to access it.

  • Internet users use http://www.customer.com/ivy/* to access it through a reverse proxy.

In this case the licence must contain two public URLs: axonivyprod and www.customer.com.

If the users do not access over the standard http or https ports (80, 443, 8080, 8443) and the default context path /ivy then the public URLs must also contain the port and/or context path (e.g. www.customer.com/axon, axonivyprod:9090, www.customer.com:90/axon).

To install a licence file use the Engine Cockpit or follow the steps below:

  1. Copy the licence file *.lic to the directory [engineDir]/configuration.

  2. Remove all other licence files in the [engineDir]/configuration directory.

Note

For container based installations it is also possible to make the license file available via environment variables or docker-secrets.

Creating a system database

You have to create and configure a system database in order to run Axon.ivy Engine in Production Mode. See Configuration to find out how you can create and configure Axon.ivy Engine system database.

Detailed Installation Information