Install As System Service

Added by Robin Shen, last edited by Robin Shen on Dec 24, 2009  (view change)
QuickBuild2 Documentation

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.sh (or server.bat) with agent.sh (or agent.bat).

On Windows Platform

  1. Run command bin\service-install.bat, 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.

  2. 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).

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:

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.

Labels:

Enter labels to add to this page:
Wait Image 
Looking for a label? Just start typing.