Engine Service
In productive environments, we recommend to run the Axon Ivy Engine as a service.
Windows Service
The binary bin/AxonIvyEngineService.exe
is the Axon Ivy Engine
implementation as Windows Service. It can also be used as command line tool to
register, unregister, start and stop Axon Ivy Engine as Windows Service. The
command line tool must be run as administrator.
Register Axon Ivy Engine as Windows Service
AxonIvyEngineService.exe -register [windowsServiceName] [username] [password]
Unregister Axon Ivy Engine as Windows Service
AxonIvyEngineService.exe -unregister [windowsServiceName]
Start the Windows Service
AxonIvyEngineService.exe -start [windowsServiceName]
Stop the Windows Service
AxonIvyEngineService.exe -stop [windowsServiceName]
- Parameters:
windowsServiceName
is optional and set by default to Axon Ivy Engine.username
is optional and defines under which user the windows service should run.password
is mandatory ifusername
is set and defines the password for the given user.
Note
You can also use the Control Center to register, unregister, start and stop the Axon Ivy Engine Windows Service.
Linux Service
The install service program InstallService.sh
helps you to install the
Axon Ivy Engine as a systemd Linux daemon. To install the service:
Run following command as root:
[engineDir]/bin/InstallService.sh
Accept the directory of your engine installation.
Set the user and group under which the Engine service should run. Must not be root. Typically, a special user with limited access right is used.
Start the Engine service with
systemctl start AxonIvyEngine.service
to check if it works.Check the current status of the service with
systemctl status AxonIvyEngine.service
If you want to start the Engine service on system start, execute following command:
systemctl enable AxonIvyEngine.service
Hint
For more information about systemd services consult man systemd
and
man systemctl
.