Install As System Service

This document explains how to configure QuickBuild server to run as system service. The process for build agent and user agent is the same except that you need to replace occurrance of server.(bat|sh) with agent.(bat|sh).

On Windows Platform

1. Open a command prompt window and switch to folder bin under QuickBuild' installation directory. On Windows Vista and Windows 7 system with UAC enabled, you will need to open the command prompt window as Administrator.
2. Run command server.bat install from the command prompt window, and a Windows service with the name QuickBuild Server will be installed.

   In case of build agent, the service will be named as QuickBuild Build Agent, and in case of user agent, the service will be named as QuickBuild User Agent.

3. You may need to configure the service to run as a different user if necessary (normally when the SCM can not be accessed by the default system account).
4. If you want to uninstall the installed service later, just run command /server.bat remove in the command prompt window (make sure the command prompt window is opened with administrative right on Windows Vista and Windows 7 system with UAC enabled).

On Mac OS X

From Mac OS X v10.4 Tiger, Apple introduced a new system startup program called launchd. QuickBuild server can be installed as a service by creating a configuration file quickbuild.server.plist in direcory /Library/LaunchDaemons, below is a skeleton for it:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
	<key>Label</key>
	<string>com.pmease.quickbuild</string>
	<key>ProgramArguments</key>
	<array>
		<string>/path/to/quickbuild_install_dir/bin/server.sh</string>
		<string>start</string>
	</array>
	<key>RunAtLoad</key>
	<true/>
</dict>
</plist>

To run QuickBuild server as a specified user, you may add below property to file quickbuild.server.plist:

<key>UserName</key>
<string>my_user_name</string>

Please make sure the user name you specified here have the full access rights to QuickBuild installation directory.

For more information on launchd, please read below reference:

• Creating launchd Daemons and Agents
• launchd manual
• launchd.plist

On Other Unix Platforms

The command server.sh start can be used to start the server as background process, and server.sh stop can be used to stop that process. This process also accepts TERM signal to shutdown itself gracefully. You can safely put the start up command into system start up script so that QuickBuild server starts automatically when system reboots.

Please make sure the user starting QuickBuild server have the full access rights to QuickBuild installation directory.