wiki:Software/Install/IcaWindows
Last modified 7 years ago Last modified on 12/18/11 03:16:47

Installing the Raptor ICA on Windows

All Raptor components are made available on linux as Windows Installer (.msi) files, allowing easy installs and upgrades. These MSIs are made available at the following location: https://iam.cf.ac.uk/downloads/raptor.

1. MSI Installation Instructions

The MSI repository can be found at https://iam.cf.ac.uk/downloads/raptor. Each MSI file has a corresponding GPG signature, signed with the private key of Rhys Smith.

For the Raptor ICA, you are looking for raptor-ica-vx.x.x.msi (where x.x.x is the latest version!).

1.1 Run the MSI

Download the file for this Raptor component, and double click (as Administrator) to run the MSI.

MSI Screenshot - Start

Simply click through the MSI installer, choosing where to install Raptor, until you are asked for configuration details.

1.2. Configuration through the MSI

The Raptor Windows Installers perform a certain amount of configuration automatically for you, based on your answers to questions during the install process.

1.2.1 Configuring Metadata

You will be asked to provide the following information:

  • EntityID - This uniquely identifies your instance of a Raptor ICA, and should follow the suggested format of https://YOURSERVERNAME/raptor-ica.
    • e.g. https://idp.example.com/raptor-ica
  • Organisation Name - This identifies the organisation that owns the service that you are monitoring.
    • e.g. Example University
  • Service Name - This identifies the name of the service itself that you are monitoring.
    • e.g. Shibboleth IdP
  • Contact Email - An email address for someone responsible for this Raptor component's upkeep.
    • e.g. someone@example.com

MSI Screenshot - Configuring Metadata

1.3. Finally

When the installation options have been chosen and the configuration has been modified appropriately, hit Install and away it goes.

MSI Screenshot - Finally

2. Installation Details

The MSI will:

  1. Install the Raptor ICA into the default (but overridable) location of C:\Program Files\Raptor\ICA
  2. Set up its SSL keystone (in Raptor\ICA\keys)
  3. Installing a Windows Service on the machine (raptorica which is set to start automatically on server boot. The service will be running a web service (using embedded jetty) listening on port :8110.

The installed program will have installed the following file structure:

  • C:\Program Files\Raptor
    • C:\Program Files\Raptor\ICA
      • C:\Program Files\Raptor\ICA\raptor-ica.jar - The main Raptor ICA classfile
      • C:\Program Files\Raptor\ICA\conf\ - Contains all configuration files for the Raptor ICA
      • C:\Program Files\Raptor\ICA\lib\ - Contains all libraries used by the Raptor ICA
      • C:\Program Files\Raptor\ICA\keys\ - Contains the Raptor ICA's keystore and truststore
      • C:\Program Files\Raptor\ICA\logs\ - Contains the Raptor ICA's log files

See this wiki page for a complete listing of files along with a description of what they do.

Attachments