Configuration

The Axon Ivy Engine is configured by files. They are located in the /configuration directory of the engine. The ivy.yaml file contains the most important entries that define the environment and runtime behavior of the Axon Ivy Engine.

 1# yaml-language-server: $schema=https://json-schema.axonivy.com/ivy/13.2.7/ivy.json
 2# sample ivy.yaml with some often used entries defined
 3SystemDb:
 4  Url: jdbc:mariadb://myDbHost:3306/AxonIvySystemDatabase
 5  UserName: root
 6  Password: "1234"
 7Administrators:
 8  admin:
 9    Password: "${hash:1234}"
10    Email: info@localhost
11  devop:
12    Password: "${hash:4321}"
13    Email: dev@axonivy.com
14EMail:
15  Server:
16    Host: smtp.gmail.com
17    Port: 25
18BaseUrl: http://workflow.acme.com

Craft you own configuration

To craft your own configuration you would typically copy values from our reference files, located under [engineDir]/configuration/reference or see te File Reference and adjust them according to your needs. Alternative, you can also copy and modify whole templates, which are provided under [enginDir]/configuration/templates.

As an Editor for the files, we recommend VS-Code or the engine-cockpit Config File Editor. Note that, most settings can also be adjusted with a UI in our Engine Cockpit.

Version

The Axon Ivy configuration files, ivy.yaml and app.yaml, use a versioned schema. The schema version is specified in the header as the first entry. Many editors can recognize this schema and validate the file accordingly. If no schema is defined, the Axon Ivy Engine assumes the latest version. Therefore it is recommended that you always define the schema header in the configuration file.

Configure your engine