| 3 | | Coming soon... A windows MSI installer package and associated instructions. |
| | 3 | 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. |
| | 4 | |
| | 5 | == 1. MSI Installation Instructions == |
| | 6 | |
| | 7 | 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. |
| | 8 | |
| | 9 | === 1.1 Run the MSI |
| | 10 | |
| | 11 | Download the file for this Raptor component, and double click (as Administrator) to run the MSI. |
| | 12 | |
| | 13 | [[Image(RaptorMSISS-ICA-Start.png)]] |
| | 14 | |
| | 15 | Simply click through the MSI installer, choosing where to install Raptor, until you are asked for configuration details. |
| | 16 | |
| | 17 | === 1.2. Configuration through the MSI === |
| | 18 | |
| | 19 | The Raptor Windows Installers perform a certain amount of configuration automatically for you, based on your answers to questions during the install process. |
| | 20 | |
| | 21 | ==== 1.2.1 Configuring Metadata ==== |
| | 22 | |
| | 23 | You will be asked to provide the following information: |
| | 24 | |
| | 25 | * EntityID - This uniquely identifies your instance of a Raptor ICA, and should follow the suggested format of !https://YOURSERVERNAME/raptor-ica. |
| | 26 | * ''e.g. !https://idp.example.com/raptor-ica'' |
| | 27 | * Organisation Name - This identifies the organisation that owns the service that you are monitoring. |
| | 28 | * ''e.g. Example University'' |
| | 29 | * Service Name - This identifies the name of the service itself that you are monitoring. |
| | 30 | * ''e.g. Shibboleth IdP'' |
| | 31 | * Contact Email - An email address for someone responsible for this Raptor component's upkeep. |
| | 32 | * ''e.g. !someone@example.om'' |
| | 33 | |
| | 34 | [[Image(RaptorMSISS-ICA-Metadata.png)]] |
| | 35 | |
| | 36 | === 1.3. Finally === |
| | 37 | |
| | 38 | When the installation options have been chosen and the configuration has been modified appropriately, hit Install and away it goes. |
| | 39 | |
| | 40 | [[Image(RaptorMSISS-ICA-Finally.png)]] |
| | 41 | |
| | 42 | |
| | 43 | == 2. Installation Details == |
| | 44 | |
| | 45 | The MSI will: |
| | 46 | 1. Install the Raptor ICA into the default (but overridable) location of {{{C:\Program Files\Raptor\ICA}}} |
| | 47 | 1. Set up its SSL keystone (in {{{Raptor\ICA\keys}}}) |
| | 48 | 1. 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. |
| | 49 | |
| | 50 | |
| | 51 | The installed program will have installed the following file structure: |
| | 52 | |
| | 53 | * {{{C:\Program Files\Raptor}}} |
| | 54 | * {{{C:\Program Files\Raptor\ICA}}} |
| | 55 | * {{{C:\Program Files\Raptor\ICA\raptor-ica.jar}}} - The main Raptor ICA classfile |
| | 56 | * {{{C:\Program Files\Raptor\ICA\conf\}}} - Contains all configuration files for the Raptor ICA |
| | 57 | * {{{C:\Program Files\Raptor\ICA\lib\}}} - Contains all libraries used by the Raptor ICA |
| | 58 | * {{{C:\Program Files\Raptor\ICA\keys\}}} - Contains the Raptor ICA's keystore and truststore |
| | 59 | * {{{C:\Program Files\Raptor\ICA\logs\}}} - Contains the Raptor ICA's log files |
| | 60 | |
| | 61 | See [Software/Configuration/Files this wiki page] for a complete listing of files along with a description of what they do. |
