Install As System Service

Version 10 by Steve Luo
on Jun 27, 2009 04:49.

<< Changes from 9 to 10
compared with
Current by Robin Shen
on Dec 24, 2009 09:02.

 
Key
These lines were removed. This word was removed.
These lines were added. This word was added.

View page history


There are 1 changes. View first change.

 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_).
  
 h3. On Windows Platform
 # Run command _bin\service-install.bat_, a Windows service with the name _QuickBuild Server_ will be installed.
 {info}
 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_.
 {info}
  # Edit this service properties to make it auto-start. You may also configure the service to run as a different user if necessary (normally when the SCM can not be accessed by the default system account).
  # 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).
  
 h3. On Mac OS X
 From Mac OS X v10.4 Tiger, Apple introduced a new system startup program called [launchd|http://developer.apple.com/MacOsX/launchd.html]. 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:
 {code}
 <?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>
 {code}
 To run QuickBuild server as a specified user, you may add below property to file _quickbuild.server.plist_:
 {code}
 <key>UserName</key>
 <string>my_user_name</string>
 {code}
 {warning}Please make sure the user name you specified here have the full access rights to QuickBuild installation directory.{warning}
  
 For more information on launchd, please read below reference:
 * [Creating launchd Daemons and Agents|http://developer.apple.com/documentation/MacOSX/Conceptual/BPSystemStartup/Articles/LaunchOnDemandDaemons.html]
 * [launchd manual|http://developer.apple.com/documentation/Darwin/Reference/ManPages/man8/launchd.8.html]
 * [launchd.plist|http://developer.apple.com/documentation/Darwin/Reference/ManPages/man5/launchd.plist.5.html]
  
 h3. 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.
 {warning}Please make sure the user starting QuickBuild server have the full access rights to QuickBuild installation directory.{warning}