This documentation relates to QuickBuild 5.0.x
Select here if you are using a different version

Install As System Service

You are viewing an old version (v. 2) of this page.
The latest version is v. 3, last edited on Feb 19, 2013 (view differences | )
<< View previous version | view page history | view next version >>

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

On Windows Platform

  1. Optionally edit file <QuickBuild server (or agent) install dir>/conf/wrapper.conf to specify the account to run service via below properties:
    wrapper.ntservice.account=
    wrapper.ntservice.password=
    

    This step can be skipped if you'd like to run the service using local system account.

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

    This step is necessary if you want to install multiple QuickBuild servers or agents in the same machine to avoid using the same service name.

  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. If RUN_AS_USER is commented out, the service will be run as root user.
    #RUN_AS_USER=
  3. Optionally edit above file to specify desired display name and description of the service via property APP_NAME and APP_LONG_NAME if necessary.

    This step is necessary if you want to install multiple QuickBuild servers or agents in the same machine to avoid using the same service name.

  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.
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.