3. Optionally, if you want to use the new Web SSO feature, complete the steps in Adding Web Single Sign-On Functionality.

Transcription

1 Webthority HOW TO Upgrade The steps required to upgrade depend on the version you are upgrading from: upgrading from 6.5 upgrading from 6.0. Upgrading from 6.5 To upgrade from 6.5 perform the following steps: 1. Ensure you have taken a backup of your existing installation, including any customized HTML login pages. We recommend this is stored on another machine. If you want to take advantage of the enhancements to the login pages, we recommend that you install the new version of the login pages with the upgrade and then manually re-apply to the new login pages any customization used with your previous login pages. Alternatively, if you want to continue using your existing login pages, select the option to keep the current pages when prompted during the upgrade procedure. 2. Run the Webthority installation program on each machine that hosts a Webthority component, refer to Running the Webthority 6.6 Installation Program. The logo s and CSS files used for the login pages have been moved to the Proxy machine. If you want to move any customized logo s or CSS files, the logo s and CSS files must be copied to <installation_folder>\webapps\<proxy_home>\web-inf\templates\public\quest 3. Optionally, if you want to use the new Web SSO feature, complete the steps in Adding Web Single Sign-On Functionality. Upgrading from 6.0 To upgrade from Webthority 6.0, perform the following steps: 1. Ensure you have taken a backup of your existing installation, including any customized HTML login pages. We recommend this is stored on another machine. If you want to take advantage of the enhancements to the login pages, we recommend that you install the new version of the login pages with the upgrade and then manually re-apply to the new login pages any customization used with your previous login pages. Alternatively, if you want to continue using your existing login pages, select the option to keep the current pages when prompted during the upgrade procedure.

2 2. Run the Webthority installation program on each machine that hosts a Webthority component, as described below. The logo s and CSS files used for the login pages have been moved to the Proxy machine. If you want to move any customized logo s or CSS files, the logo s and CSS files must be copied to <installation_folder>\webapps\<proxy_home>\web- INF\templates\public\quest 3. For each Proxy machine, modify server.xml to update the configuration, see Updating your Webthority Proxy server.xml. 4. Change the Encryption Passphrase, see Changing the Encryption Passphrase. 5. Optionally, if you want to use the new Web SSO feature, complete the steps in Adding Web Single Sign-On Functionality. Running the Webthority 6.6 Installation Program The Webthority service will be stopped and restarted during upgrade. 1. From the Quest Autorun, run the Webthority 6.6 installation program, e.g. webthority.exe for Windows platforms. The Webthority Setup Wizard is displayed. Click Next. 2. Accept the license terms, then click Next. 3. Select the location that hosts your existing Webthority installation. 4. Click Install to start the Webthority upgrade, including the supporting Tomcat web service and Java Runtime Environment (JRE). 5. You are prompted to confirm that you want to continue with upgrade. Click Yes. The automated upgrade will proceed. 6. A command window will be displayed. Press Return to complete the upgrade. Updating your Webthority Proxy server.xml file This section describes how to update the proxy server.xml file after you have upgraded to Webthority 6.6. This is necessary for the following reasons: the internal connections between Webthority 6.6 components now use SSL by default. the underlying Apache Tomcat software has been upgraded from version 4 to version 6. 2

3 On Each Proxy Machine 1. Backup the server.xml file located in the following directory: <installdirectory>/webthority/conf 2. Open the server.xml file in a text editor such as WordPad and locate the sections which define each of your proxy services. These can be identified by searching for a service tag containing the name of your proxy service, e.g. the name that appears in the Webthority Administration console. For example: 3. Where myproxy is the name of your proxy service. For each proxy service, make a note of the values highlighted below so that they can be restored later. 4. Delete the contents of the service tag for each proxy service so that they look like the following: 5. Next locate the replacement configuration for each proxy service at the bottom of the file. There are two configurations, one for SSL and another for non-ssl. Copy the new configuration as indicated below using the appropriate section for the proxy type, e.g. for an SSL proxy service, copy the SSL Proxy Service configuration. 3

4 6. For each proxy service paste the relevant copied configuration into the empty service tag. For example a non-ssl proxy service would now look like: 4

5 7. Update the two placeholders for the proxy name indicated below with the name of the proxy. For example replace <proxy_name> with myproxy. 8. The maxprocessors setting has been renamed in Tomcat 6 and is now called maxthreads. If the value noted in step 3 for maxprocessors is greater than 200, replace the maxthreads value with the noted value. 9. Using the port number noted in step 3, use the following conversion chart to identify the new port number to use. For example if the original port number was 8081 then update the port number to be Original Port New Port Save the server.xml file and exit. 11. Restart Webthority: Start Programs Quest Software Webthority Service Restart Webthority 12. Login to your Webthority Administration Console, which now uses port 8553 by default, e.g. from the same machine or from a separate machine, and resync each host in your Webthority environment by rightclicking on the host, then select Resync Host. 5

6 Changing the Encryption Passphrase This section describes how to change the Encryption Passphrase from the Webthority Administration Console. The Encryption Passphrase enables the Webthority components to communicate with each other. 1. Login to the Webthority Administration Console. Your Webthority Administration Console URL is by default. 2. Click System Info. 3. Select the Change Encryption Passphrase tab. 4. Enter your current passphrase and new passphrase. The current passphrase is the Webthority password that you used to login to the Administration Console. 5. Click Apply. 6

7 Adding Web Single Sign-On Functionality The new Web Single Sign-On functionality that has been added to Webthority 6.6 can be added to your current Webthority setup following upgrade to 6.6. The new Single Sign-On functionality comes in two stages which will require the installation and configuration of different components. 1. Form-based authentication to applications that require credentials different to those used to authenticate to Webthority. 2. Single Sign On to web applications that require SAML authentication. Form-based Authentication Form-based authentication to applications that require credentials different to those used to authenticate to Webthority require the following components: Data Store Service Landing Page (Optional: For user management of credentials) SAML Authentication SAML authentication to applications requires the following components: Data Store Service IDP Service 7

8 To add these components, run the Configure Webthority application located at Start Programs Quest Software Webthority. These components should be installed on the authentication host and any authentication host clones with the exception of the datastore component which should only be installed on the authentication host and not a clone. 1. Click Next. 2. Select Add new components. Click New. 3. Select the components you want to add. Click Next. 4. Click Next to bypass the Add Proxy Services section. 5. Click Next to bypass the Add Authentication Services section. 6. Click Install to add your new components. 7. Log onto your administration console and resync the host that contains these new components. For information on configuring these new components, please refer to the guide entitled Webthority How To Configure Web Single Sign-On Quest Software, Inc. ALL RIGHTS RESERVED. Quest, Quest Software and the Quest Software logo are trademarks and registered trademarks of Quest Software, Inc. in the United States of America and other countries. Other trademarks and registered trademarks are property of their respective owners. 8