1.0 Introduction

This page provides a guide to installing the Hackystat Visual Studio Team Foundation Server (VSTFS) sensor from a "Binary Distribution". It is assumed that the user has already setup a VSTFS server to collect data from and a Hackystat sensorbase (General Install Guide) to send the data to.

2.0 Requirements and Prerequisites

Requirements

• System capable of running VSTFS

or

• 500MHz Processor with 64MB RAM
• ASP.NET 2.0+ compatible webserver

Prerequisites

3.0 Structure of the Binary Distribution

Currently a VSTFS binary build consists of a single directory within the svn repository. This directory contains the ASP.NET web files, compiled code and media items required to run the sensor.

PrecompiledWeb/
               App_Data/
               bin/
               Code/
               Logs/
               Services/
               Style/
                     images/
                     css/
               Services.xml
               Services.xsl
               Setting.ini
               Web.config
               *.*

This directory will always contain the latest compiled code. Since ASP.Net does not strictly require a web application to be compiled prior to use a user may also use the non-compiled source code when setting up a new sensor.

4.0 Installing a Binary Distribution

4.1 Installing the prerequisites

Most of the prerequisites come with executable installers. Please refer to the Sensorshell website for instructions on how to install the sensorshell and configure its properties.

Missing a dependency? Try using Dependency Walker to determine whick files or APIs you are missing.

4.2 Installing the sensor

• Login as a user with administrative privelages
• Navigate to Start->Programs->Administrative tools->Internet Information Services
• or Control Panel->Administrative tools->Internet Information Services
• Create a separate virtual directory to place the compiled ASP.NET web files.
• The alias of the directory can be anything you want. It will be the subdirectory under your server later.
• It will ask you to select where the web files are. For now create a new directory and point to that. You will put the files there later.
• Suggested Directory: C:/inetpub/wwwroot/<Your folder name>

• Drop the web project files into the newly created virtual directory.

• Modify the ASP.NET server to use ASP.NET 2.0.
• Right click virtual directory and select the ASP.Net tab.

• Fix the server permissions(http://support.microsoft.com/?kbid=267904)
• Try: C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727>aspnet_regiis -i
• It is highly suggested that you change the port of your server from the default 80 to something like 7777.
• Right click Default Web Site->Properties
• Download the latest copy of the precompiled web files from source.
• Find the Precompiled web folder from the svn checkout and place the files from this folder in your newly created virtual directory.
• Configure the setting.ini file. (Important)
• The settings file stores the most basic of settings. This includes the location and credentials required to access the VSTFS server. If a user does not want others to maintain settings in this file the user can setup the settings.ini file with only read permissions and allow the remaining settings to be loaded from the server.
• If the setting.ini file is deleted and directory permissions are correct a new one with default settings is created.
• If using the IEventService API make sure the SQL server can be accessed.

• Configure the web.config file. (Important)
• Turn off debugging
• Specify custom error pages
• Enable webserver authentication (Suggested)
• Configure SQL server security. (Important)
• If the sensor is not running using local windows user authentication make sure that you setup the SQL for non-windows authentication login
• Give the local ASP.NET account permissions to write to the Logs directory, setting.ini, setting.ini.backup and webconfig.ini as applicable.
1. You will need to disable simple file sharing. Open windows explorer (run->explorer.exe). Navigate to the folder where your files are. Click Tools->Folder options->View->disable simple file sharing
2. Right click file you wish to change permissions select properties->security
3. Add a new user. Select advanced->find now->select ASPNET
4. Give ASPNET full control
5. Go back to IIS
6. For each file or folder right click and select properties and then allow writing to files.

• Reset your webserver
• This step may not even be necessary.
• If all goes well you should see the configuration screen with the sensorshell label as "online".

• Subscribe to the events you want to send to the Hackystat sensorbase.
• Thats it your done!

5.0 Uninstallation

1. Run the sensor web interface and un-subscribe to all events.
2. Remove the virtual directory.
3. Remove the sensorshell directory if not located within the virtual directory.
4. The application should be gone entirely.