Setting Up Your Environment
Note: If you are upgrading an existing installation of
IncrediBuild to a newer version, go straight to the Updating IncrediBuild section.
Overview
Installing IncrediBuild is a 2-phase procedure.
First, install IncrediBuild Coordinator, the
central component that manages the distributed processing workload
and resource assignment. Once the Coordinator has been installed,
IncrediBuild Agents can be installed on
computers connected to the local network.
The IncrediBuild setup program is used to install both the
Coordinator and Agent components.
Begin the IncrediBuild installation by setting up the
Coordinator.
Being quite lightweight, the Coordinator does not require
installation on a particularly strong machine. However, it is
advisable to install this on a stable machine that is normally not
shut down during working hours.
Installation Prerequisites
Operating System: Windows NT, Windows 2000, Windows XP,
Windows 2003, Windows Vista.
Network: Standard TCP/IP network.
Software: No special software is required by the
installation.
User Privileges: User running the setup should have
Administrator privileges.
Coordinator Setup Procedure
1. Click "Next" to go through the introduction page.
2. Read the terms of the end-user license agreement and click "I
accept" and 'Next' to continue.
3. Choose the "IncrediBuild Coordinator" option, and click
"Next".
4. Enter the destination folder for the IncrediBuild installation
by entering the folder path or using the "Browse…" button. Click
"Next" to proceed.
5. The Port is a network setting used by the Coordinator to
communicate with Agents in the IncrediBuild environment. Leave this
option unchanged unless you are aware of another application using
this port on the Coordinator machine. Click "Next" to proceed.
6. In the "Coordinator Role" page, click next to proceed if
installing your initial IncrediBuild Coordinator, or choose "Backup
Coordinator" if a primary Coordinator has already been
installed.
7. The summary window should be displayed. Click "Next" to begin
installing IncrediBuild Coordinator. This should last a few seconds
and end by displaying a "Setup completed" screen.
8. Click "Finish" to complete the installation.
You are now ready to install IncrediBuild Agents.
Agents should be installed on machines that are used to do one or
both of the following:
1. Initiate builds and other distributed jobs.
2. Participate as resources in distributed jobs.
Installation Prerequisites
Operating System: Windows NT, Windows 2000, Windows XP,
Windows 2003, Windows Vista.
Network: Standard TCP/IP network.
Software: For Agents that initiate Visual Studio builds,
Microsoft Visual Studio should be installed before running the
Setup application. For Helper Agents (Agents that only participate
in builds initiated by other Agents), no additional software is
required.
User Privileges: User running the setup should have Power
User privileges or higher.
Agent Setup Procedure
1. Click "Next" to go through the introduction page.
2. Read the terms of the end-user license agreement and click "I
accept" and 'Next' to continue.
3. Choose the "IncrediBuild Agent" option, and click "Next".
Agent Page 1 - Installation Settings
4. Enter the destination folder for the IncrediBuild installation
(enter the folder path or use the "Browse…" button).
5. The File Cache size setting determines the size, in Megabytes,
of space the IncrediBuild Agent will allocate to cache project
information from remote Agents. Leaving this option at the default
value is recommended for most installations (You can always change
this value at a later time through the Agent Settings dialog).
Click "Next" to proceed.
Agent Page 2 - Coordinator Settings
6. Enter the network name (or the IP Address) of the computer used
for the IncrediBuild Coordinator installation by typing it or by
using the "Browse…" button (if you do not know this name, ask your
system administrator). If you are installing the Agent on the
computer used for IncrediBuild Coordinator installation, you can
leave this field blank.
7. Enter the TCP/IP Port used by the IncrediBuild Coordinator. This
will normally be the default value.
8. Click the "Test" button. You should get a "Successfully
connected to Coordinator" message. If you do not receive this
message, consult your system administrator to find out why the
IncrediBuild Coordinator is not accessible, and repeat sections 6
and 7 after correcting the cause. Note that if, for some valid
reason, the Coordinator is temporarily inaccessible, press the
message-box "Ignore" button to skip the test and proceed with the
installation.
Possible causes for connection test failure are:
a. The Coordinator Name and Port
settings were set incorrectly.
b. The Coordinator is not installed
properly.
c. Network security settings are
preventing your computer from accessing the Coordinator.
9. Click "Next" to continue.
Agent Page 3 -Network Settings
This page controls which TCP/IP ports the IncrediBuild Agent will
use. It is recommended to leave the default values unchanged. If,
for some reason, you wish to apply different settings, you can set
your preferred values manually or select "Select ports
automatically" to instruct the Agent to always select the next
available TCP/IP port upon startup.
Agent Page 4 -Integration Settings
This page will only be displayed for Agent installations on
machines with Microsoft Visual C++ installed. If you do not see
this page, skip to step 14.
10. Uncheck any of the "Enable Microsoft Visual Studio 6.0 IDE
integration" and "Enable Microsoft Visual Studio 7.0 IDE
integration" options if you do not wish IncrediBuild to add its
commands to any of these environments' IDEs. Even without IDE
integration, you will still be able to run builds from the command
line and tray-icon menu.
12. Uncheck "Add IncrediBuild folder to system path" if you do not
intend to use IncrediBuild from the command line or from batch
scripts. Leaving this option selected will add IncrediBuild's
installation folder to the PATH environment variable, for simple
access to IncrediBuild's command line interface.
13. Press 'Next' to continue.
14. The summary window should be displayed.
Click "Next" to begin installing IncrediBuild Agent. This should
last a few seconds and end with a "Setup completed" screen.
15. Click "Finish" to complete the installation.
Your IncrediBuild Agent is now set up and ready to build.
The entire IncrediBuild environment can be upgraded to a newer
version from a central location. In order to do this, go through
the following process:
1. Run the Setup application from the Coordinator machine.
2. This will bring up a page with two options:
a. "Update Version" will
automatically upgrade IncrediBuild on this machine. Choose this to
continue with this section.
b. "Reinstall Components" will run
the setup as normal, allowing you to override an existing
IncrediBuild installation.
3. Press Next. A summary page will display the components about to
be updated.
4. Press Next. IncrediBuild will update the IncrediBuild
installation on this machine.
5. Once IncrediBuild has completed the update, press 'Finish' to
update remote Agents with the new version, or uncheck the "Remotely
update Agents" checkbox before pressing 'Finish' to skip updating
remote Agents with the new version.
Notes:
1. In order for Agents to be able to receive remote version
updates, the following conditions must be met on the machine
running the Agent:
a. The currently logged on user must
have local Administrator privileges.
b. The IncrediBuild Agent tray-icon
display must be running. If you cannot see the IncrediBuild
tray-icon display, run "IncrediBuild Agent" from the "Xoreax
IncrediBuild" Start menu group.
2. If an Agent has an IncrediBuild version different from the
Coordinator's, the Agent will only be able to run builds in
standalone mode. The tray-icon will change to a special
"Incompatible version" icon to indicate this status. To update such
an Agent's version directly, simply select "Update Version..." from
the Agent's tray-icon menu.
3. At any time, you can update the IncrediBuild version on a group
of Agents using the Coordinator application. To do this, select the
Agents you wish to upgrade and select "Update version" right-click
menu option.
Copyright (C) 2001-2008 Xoreax Software Ltd. All rights
reserved.