Install As System Service

Version 2 by Robin Shen
on Feb 19, 2013 07:53.

<< Changes from 1 to 2

compared with

Current by Robin Shen
on Feb 19, 2013 07:59.

Key

These lines were removed. This word was removed.

These lines were added. This word was added.

View page history

There are 6 changes. View first change.

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

		h3. On Windows Platform
		# Optionally edit file _<QuickBuild server (or agent) install dir>/conf/wrapper.conf_ to specify the account to run service via below properties:
		# If necessary, edit file _<QuickBuild server (or agent) install dir>/conf/wrapper.conf_ to specify service account via below properties:
		{code}
		wrapper.ntservice.account=
		wrapper.ntservice.password=
		{code}
		This step can be skipped if you'd like to run the service using local system account.
		# Optionally edit above file to specify desired display name and description of the service via property _wrapper.displayname_ and _wrapper.description_ if necessary.
		The service will run under local system account if these properties are not specified.
		# If necessary, edit above file to specify desired display name and description of the service via property _wrapper.displayname_ and _wrapper.description_.
		{note}
		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.
		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.
		{note}
		# 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\|http://www.howtogeek.com/howto/windows-vista/run-a-command-as-administrator-from-the-windows-vista-run-box/].
		# 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.
		# 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\|http://www.howtogeek.com/howto/windows-vista/run-a-command-as-administrator-from-the-windows-vista-run-box/] on Windows system with UAC enabled).

		h3. On Unix family Platforms (including MacOS X and Linux)
		# Open a command shell and switch to folder _<QuickBuild server (or agent) install dir>/bin_.
		# 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.
		# 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.
		{code}#RUN_AS_USER={code}
		# Optionally edit above file to specify desired display name and description of the service via property _APP_NAME_ and _APP_LONG_NAME_ if necessary.
		The service will be run under root account if this line is commented out.
		# If necessary, edit above file to specify desired display name and description of the service via property _APP_NAME_ and _APP_LONG_NAME_.
		{note}
		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.
		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.
		{note}
		# Run command _server.sh install_ (or _agent.sh install_) to install the service.
		# If you want to uninstall the service later, just run command _server.sh remove_ (or _agent.sh remove_) in the command shell.