Running as a Windows Service

If you installed ManualWorks in the C:\Program Files folder, registering the service might fail. Do not install ManualWorks in the C:\Program Files folder.

Downloading the Files

To register ManualWorks as a Windows service, download the following files.

Windows service files

File

Download

Notes

service.bat

Download


tomcat9.exe

Download

For 64-bit Windows

Copy the downloaded files to the 3RABBITZ_HOME\bin folder.

3RABBITZ_HOME refers to the folder where ManualWorks is installed.

Registering the Service

Register ManualWorks as a service as follows.

  1. Open Command Prompt as an administrator.

    1. Type CMD in the Windows <Start> menu search box.

    2. Right-click Command Prompt in the results to open the context menu.

    3. Select Run as administrator.

  1. Go to the 3RABBITZ_HOME\bin folder.

  2. If needed, set JAVA_HOME with the following command. Replace the Java location with the actual path.

set "JAVA_HOME=C:\open-jdk\jdk-25.0.1"

  1. Run the following command.

service.bat install

When the command finishes, a service named 3Rabbitz appears in Windows Services.

The service is registered with the LocalSystem account, and the Java heap memory is set to a minimum of 256MB and a maximum of 2048MB. To register the service with a different account, set the account in the SERVICE_ACCOUNT environment variable before you run service.bat install. If your server is already running as a registered service, you do not need to register it again.

The startup type of the service is Manual. To start ManualWorks automatically when Windows starts, change the startup type to Automatic.

Setting Up Service Recovery

Set the service to restart automatically if ManualWorks stops unexpectedly.

  1. In Services, select 3Rabbitz, and select the 1Recovery tab.

  1. For 2First failure, select 3Restart the Service.

  2. Click <OK>.

Removing the Service

Remove ManualWorks from Windows Services as follows.

  1. Open Command Prompt as an administrator.

    1. Type CMD in the Windows <Start> menu search box.

    2. Right-click Command Prompt in the results to open the context menu.

    3. Select Run as administrator.

  2. Go to the 3RABBITZ_HOME\bin folder.

  3. Run the following command.

service.bat remove

Other Settings

When You Update the JRE

If you update the JRE, remove the service and register it again. This does not apply if ManualWorks runs on a JDK instead of a JRE.

We recommend not using the JRE.

Changing Java

To change Java after you register the service, see Changing Java for the Windows Service.

Java Heap Memory Settings

To change the Java heap memory settings after you register the service, see Changing the Java Heap Size for the Windows Service.