| | 2 | |
| | 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 | For Raptor Server, you are looking for raptor-all-vx-rx.msi (where vx-rx is the latest version!). |
| | 10 | |
| | 11 | === 1.1 Run the MSI |
| | 12 | |
| | 13 | Download the file for this Raptor component, and double click (as Administrator) to run the MSI. |
| | 14 | |
| | 15 | [[Image(RaptorMSISS-All-Start.png)]] |
| | 16 | |
| | 17 | Simply click through the MSI installer, choosing where to install Raptor, until you are asked for configuration details. |
| | 18 | |
| | 19 | === 1.2. Configuration through the MSI === |
| | 20 | |
| | 21 | The Raptor Windows Installers perform a certain amount of configuration automatically for you, based on your answers to questions during the install process. |
| | 22 | |
| | 23 | ==== 1.2.1 Configuring Metadata for the ICA ==== |
| | 24 | |
| | 25 | You will be asked to provide the following information: |
| | 26 | |
| | 27 | * EntityID - This uniquely identifies your instance of a Raptor ICA, and should follow the suggested format of !https://YOURSERVERNAME/raptor-ica. |
| | 28 | * ''e.g. !https://idp.example.com/raptor-ica'' |
| | 29 | * Organisation Name - This identifies the organisation that owns the service that you are monitoring. |
| | 30 | * ''e.g. Example University'' |
| | 31 | * Service Name - This identifies the name of the service itself that you are monitoring. |
| | 32 | * ''e.g. Shibboleth IdP'' |
| | 33 | * Contact Email - An email address for someone responsible for this Raptor component's upkeep. |
| | 34 | * ''e.g. !someone@example.com'' |
| | 35 | |
| | 36 | [[Image(RaptorMSISS-ICA-Metadata.png)]] |
| | 37 | |
| | 38 | ==== 1.2.2 Configuring Metadata for the MUA ==== |
| | 39 | |
| | 40 | You will be asked to provide the following information: |
| | 41 | |
| | 42 | * EntityID - This uniquely identifies your instance of a Raptor MUA, and should follow the suggested format of !https://YOURSERVERNAME/raptor-mua. |
| | 43 | * ''e.g. !https://raptor.example.com/raptor-mua'' |
| | 44 | * Organisation Name - This identifies the organisation that owns the service that you are monitoring. |
| | 45 | * ''e.g. Example University'' |
| | 46 | * Service Name - This identifies the name of the service itself that you are monitoring. |
| | 47 | * ''e.g. Raptor MUA'' |
| | 48 | * Contact Email - An email address for someone responsible for this Raptor component's upkeep. |
| | 49 | * ''e.g. !someone@example.com'' |
| | 50 | |
| | 51 | [[Image(RaptorMSISS-MUA-Metadata.png)]] |
| | 52 | |
| | 53 | ==== 1.2.3 Configuring Metadata for Web ==== |
| | 54 | |
| | 55 | You will be asked to provide the following information: |
| | 56 | |
| | 57 | * EntityID - This uniquely identifies your instance of Raptor Web, and should follow the suggested format of !https://YOURSERVERNAME/raptor-web. |
| | 58 | * ''e.g. !https://raptor.example.com/raptor-web'' |
| | 59 | * Organisation Name - This identifies the organisation that owns the service that you are monitoring. |
| | 60 | * ''e.g. Example University'' |
| | 61 | * Service Name - This identifies the name of the service itself that you are monitoring. |
| | 62 | * ''e.g. Raptor Web'' |
| | 63 | * Contact Email - An email address for someone responsible for this Raptor component's upkeep. |
| | 64 | * ''e.g. !someone@example.com'' |
| | 65 | |
| | 66 | [[Image(RaptorMSISS-Web-Metadata.png)]] |
| | 67 | |
| | 68 | === 1.3. Finally === |
| | 69 | |
| | 70 | When the installation options have been chosen and the configuration has been modified appropriately, hit Install and away it goes. |
| | 71 | |
| | 72 | [[Image(RaptorMSISS-Server-Finally.png)]] |
| | 73 | |
| | 74 | |
| | 75 | == 2. Installation Details == |
| | 76 | |
| | 77 | The MSI will: |
| | 78 | 1. Install the Raptor MUA and Web into the default (but overridable) locations of {{{C:\Program Files\Raptor\ICA}}}, {{{C:\Program Files\Raptor\MUA}}}, and {{{C:\Program Files\Raptor\Web}}} |
| | 79 | 1. Set up their SSL keystones (in {{{Raptor\ICA\keys}}}, {{{Raptor\MUA\keys}}} and {{{Raptor\Web\keys}}}) |
| | 80 | 1. Installing Windows Services on the machine ({{{raptormua}}} and {{{raptorweb}}} which are set to start automatically on server boot. The services will be running a web service (using embedded jetty) listening on port :8110 (for the ICA), :8111 (for the MUA) and :8112 (for Web). |
| | 81 | |
| | 82 | |
| | 83 | The installed program will have installed the following file structure: |
| | 84 | |
| | 85 | * {{{C:\Program Files\Raptor}}} |
| | 86 | * {{{C:\Program Files\Raptor\ICA}}} |
| | 87 | * {{{C:\Program Files\Raptor\ICA\raptor-ica.jar}}} - The main Raptor ICA classfile |
| | 88 | * {{{C:\Program Files\Raptor\ICA\conf\}}} - Contains all configuration files for the Raptor ICA |
| | 89 | * {{{C:\Program Files\Raptor\ICA\lib\}}} - Contains all libraries used by the Raptor ICA |
| | 90 | * {{{C:\Program Files\Raptor\ICA\keys\}}} - Contains the Raptor ICA's keystore and truststore |
| | 91 | * {{{C:\Program Files\Raptor\ICA\logs\}}} - Contains the Raptor ICA's log files |
| | 92 | * {{{C:\Program Files\Raptor\MUA}}} |
| | 93 | * {{{C:\Program Files\Raptor\MUA\raptor-mua.jar}}} - The main Raptor MUA classfile |
| | 94 | * {{{C:\Program Files\Raptor\MUA\batchimport\}}} - Where historical log files can be dropped (see [Software/Productionalisation/ImportingOldLogs this page]) |
| | 95 | * {{{C:\Program Files\Raptor\MUA\conf\}}} - Contains all configuration files for the Raptor MUA |
| | 96 | * {{{C:\Program Files\Raptor\MUA\data\}}} - Contains the HSQL database, if you haven't switched to using a "real" database |
| | 97 | * {{{C:\Program Files\Raptor\MUA\lib\}}} - Contains all libraries used by the Raptor MUA |
| | 98 | * {{{C:\Program Files\Raptor\MUA\keys\}}} - Contains the Raptor MUA's keystore and truststore |
| | 99 | * {{{C:\Program Files\Raptor\MUA\logs\}}} - Contains the Raptor MUA log files |
| | 100 | * {{{C:\Program Files\Raptor\Web}}} |
| | 101 | * {{{C:\Program Files\Raptor\Web\raptor-web.jar}}} - The main Raptor Web classfile |
| | 102 | * {{{C:\Program Files\Raptor\Web\conf\}}} - Contains all configuration files for the Raptor Web |
| | 103 | * {{{C:\Program Files\Raptor\Web\lib\}}} - Contains all libraries used by the Raptor Web |
| | 104 | * {{{C:\Program Files\Raptor\Web\keys\}}} - Contains Raptor Web's keystore and truststore |
| | 105 | * {{{C:\Program Files\Raptor\Web\logs\}}} - Contains Raptor Web log files |
| | 106 | |
| | 107 | See [Software/Configuration/Files this wiki page] for a complete listing of files along with a description of what they do. |
