Install As System Service

This document explains how to configure QuickBuild programs (server, build agent, and user agent) to run as system service.

On Windows Platform

1. If necessary, edit file <QuickBuild server (or agent) install dir>/conf/wrapper.conf to specify service account via below properties:

   wrapper.ntservice.account=
   wrapper.ntservice.password=
   

   The service will run under local system account if these properties are not specified.

2. If necessary, edit above file to specify desired display name and description of the service via property wrapper.displayname and wrapper.description.

   Make sure to modify these properties to use different service name and description if you want to install multiple QuickBuild servers or agents in the same machine.

3. Open a command prompt window and switch to folder <QuickBuild server (or agent) install dir>/bin. On Windows system with UAC enabled, you will need to open the command prompt window as Administrator.
4. Run command server.bat install (or agent.bat install) from command prompt window, and a Windows service with the name QuickBuild Server will be installed.
5. If you want to uninstall the service later, just run command server.bat remove (or agent.bat remove) in the command prompt window (make sure the command prompt window is opened with administrative right on Windows system with UAC enabled).

On Unix family Platforms (including MacOS X and Linux)

1. Open a command shell and switch to folder <QuickBuild server (or agent) install dir>/bin.
2. Edit file server.sh (or agent.sh) to uncomment below line to specify the OS user to run the service as. Make sure the user has full permission against QuickBuild installation directory including all sub directories and files.

   #RUN_AS_USER=

   The service will be run under root account if this line is commented out.

3. If necessary, edit above file to specify desired display name and description of the service via property APP_NAME and APP_LONG_NAME.

   Make sure to modify these properties to use different service name and description if you want to install multiple QuickBuild servers or agents in the same machine.

4. Run command server.sh install (or agent.sh install) to install the service.
5. If you want to uninstall the service later, just run command server.sh remove (or agent.sh remove) in the command shell.