|
||
|
|
|
Compass Version 1.3
Windows Installation GuideCompass comes with two installers for Windows. The Compass Server installer and the Compass Client installer. The Compass Server installer installs the base Compass Server as well as a windows task trey application called the Compass Manager. The Compass Manager provides a windows user interface to start/stop and manage a running instance of the Compass server as well as which windows computers are connected to the server and functioning as Compass build clients. To Install the Compass Server and Compass Manager application download the Compass_Server_Setup.exe installer and run it on the computer you want to be the server, following the instructions in the installer. The Compass Client Installer install the Compass Build client and a windows task trey application that makes it conveinent to start and stop the Compass Build Client and connect it to the Compass Manager. In some cases, there is only one physical machine that is both the Compass Manager and a single Compass Client Driver. In this case, both installers must be used. The Compass Client must be installed on all computers that will be used as Compass build clients. After downloading Compass_Client_Setup.exe, simply run it on each computer that Compass will be used on and follow the instructions for each step in the installation. Both Compass installers will ask to install Python 2.6 and PyWin32. If these have already been installed then this step can be skipped. If you are unsure if you have these installed it's best to attempt to do the installation and it will fail if either have already been installed. Once the installation has completed. Both Compass Manager and Compass Client Driver will have been installed. To start the Compass server, go to the start menu and run Compass Manager. This will start the Compass Manager and put an icon in your windows task trey that looks like this: Right click on the Compass Manager icon and select settings; this will bring up the following dialog: ![]() Check the box for 'Run server on startup' if you want the Compass Server to start when the Compass Manager application is launched. Also, if you have more than one python installation, make sure the correct version is selected here. Finally, the Compass master config file is specified here. For most installations the defaults in this file can be left unmodified. If you do require changes to this file or for more information about it please refer to the Compass Config section in this documentation. Click 'OK' on the settings window to save any changes and then right click on the Compass Manager icon in the task trey and the click 'Start Compass Server' The Compass server will now be started and running on localhost. Open a web browser and navigate to 'http://localhost' and you should see a page like this: ![]() To complete the Compass Server installation enter an administrator username and password and click the 'Install Server' Button. Once you click this button you will be taken to the Server Administration page. The rest of the Compass Server setup is all platform independent. You can continue to the quick setup in the next chapter of the documentation or read the full Compass Documentation for advanced topics. Before any builds can execute, there is still the platform dependent problem of setting up Compass Build Clients, which is covered here: Set Up a Windows Build ClientNow that the Compass Server running is all set up, with a build plan, ready to start building; it needs a build client to execute the build plan. The simplest Compass configuration is to have a single build client on the same machine as the Compass Manager and Compass Server. To set this up simply start the Compass Client Driver from the start menu. This will put a second icon in your task trey that looks like this: Right clicking on this icon gives you a menu to control the Compass build client on this machine. On this menu, the first thing we need to do is change the settings. Click the settings option and bring up the following dialog: ![]() We need to first give our build client a name, this must be unique (a default name is auto-generated but most users prefer to put their name or the name of their machine). Next make sure that the python location is correct; also make sure that the full path to the client config file is specified. Additional settings for how the client behaves can be added to this config file; for more details on setting up specific Compass Client config options in this file see the config file documentation page. The last setting we must enter is the address of the Compass Manager. If this Client Driver is on the same computer as the the Compass Manager then enter 127.0.0.1 or else enter the IP address of the Compass Manager computer. Due to windows socket limitations this must be an IP address not a domain name. Once we have all the settings correct, click OK. Now right click on the Client Driver icon again and this time select 'Connect to Manager'. Once you have connected you can start the build client by clicking on 'Start Build Client' either in the Compass Manager or in the Client Driver menus. Finally, to test that the client is correctly started and connected, open a web browser and log in to the Compass web page. Click on the Build Monitor icon on the top menu and you should see a build client called windows-1: And now compass is completely set up and ready to go. Builds will start at their next scheduled time or with the next repository change. Many more advanced features of Compass are covered in other documentation pages on the Anx Labs partner site. For questions and comments please contact: This e-mail address is being protected from spambots. You need JavaScript enabled to view it
|








