Surround SCM Installation Guide V2017.1
Total Page:16
File Type:pdf, Size:1020Kb
Surround SCM Installation Guide Version 2017.1 Copyrights © 1996-2017 Perforce Software, Inc. and its subsidiaries. All rights reserved. Defect Scribe, Helix ALM, Helix ALM Suite, Helix Issue Management, Helix Requirements Management, Helix Test Case Management, QA Wizard Pro, Resource Thief, SoloBug, SoloSubmit, Surround SCM, and TestTrack are trademarks or registered trademarks of Perforce Software, Inc. and its subsidiaries in the United States and other countries. Acrobat Reader is a registered trademark of Adobe, Inc. in the United States and other countries. UNIX is a registered trademark in the United States and other countries, licensed exclusively through X/Open Company Limited. Apple, Mac, Mac OS, macOS, Macintosh, Objective-C, and Safari are registered trademarks of Apple Computer, Inc. Chrome is a registered trademark of Google Inc. Debian is a registered trademark of Software in the Public Interest, Inc. Firefox is a registered trademark of the Mozilla Foundation. Linux is a trademark of Linus Torvalds. Microsoft, Windows, Windows Server, Windows Vista, MS Windows, Active Directory, Internet Explorer, Outlook, SQL Server, Visual SourceSafe, and Visual Studio are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. openSUSE and SUSE are registered trademarks of Novell Inc. in the United States and other countries. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Red Hat, Red Hat Enterprise Linux, and Fedora are registered trademarks of Red Hat, Inc. in the United States and other countries. Ubuntu is a registered trademark of Canonical Ltd. All other product names mentioned herein are the trademarks of their respective owners. All other trademarks are the property of their respective owners. No part of this publication may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any language in any form by any means without the written permission of Perforce Software, Inc. and its subsidiaries. Your license agreement with Perforce Software, Inc. or any of its subsidiaries, which is included with the product, specifies the permitted and prohibited uses of the product. Any unauthorized duplication or use of this software, in whole or in part, in print, or in any other storage and retrieval system is forbidden. Information in this document is subject to change without notice and does not represent a commitment on the part of Perforce Software, Inc. or any of its subsidiaries. Unless otherwise noted, all companies, products, street addresses, and persons contained herein are purely fictitious. Mention of third-party companies and products is for informational purposes only and does not constitute an endorsement. Perforce Software, Inc. and its subsidiaries 400 N 1st Avenue Suite 200 Minneapolis, Minnesota 55401 USA +1 510.864.7400 [email protected] Contents Installing Surround SCM 1 Upgrading Surround SCM 3 Before You Install 5 About Surround SCM databases 5 About 64-bit Surround SCM components 6 Installers 9 Installation types 10 Running the Installer 13 Setting Surround SCM integration options 14 Setting Surround SCM configuration options 14 Setting Surround SCM Web Server configuration options 15 Setting Helix ALM License Server options 15 Setting RDBMS configuration options 16 Running a silent installation on Windows 18 Starting Surround SCM 21 Configuring the Helix ALM License Server 23 Starting the Helix ALM License Server 23 Starting Helix ALM License Server Admin Utility 23 Configuring a Helix ALM License Server connection 24 Adding licenses to the Helix ALM License Server 24 Adding users to the Helix ALM License Server 25 Configuring web servers for the Helix ALM License Server Web Admin Utility 25 Configuring Apache for the Helix ALM License Server Web Admin Utility 26 Configuring Microsoft IIS 7 and later for the Helix ALM License Server Web Admin Utility 27 Configuring Microsoft IIS 6 for the Helix ALM License Server Web Admin Utility 28 Configuring New Surround SCM Installations 31 Starting the Surround SCM Server 31 Configuring a Surround SCM Server connection 31 Configuring Surround SCM Web 33 Starting the Surround SCM Web Server 33 Configuring the Surround SCM Proxy Server 35 Starting the Surround SCM Proxy Server 35 Setting Up RDBMS Databases 37 Setting up PostgreSQL databases 37 Setting up Oracle databases 38 i Setting up SQL Server databases 39 Troubleshooting RDBMS connections 40 Troubleshooting 43 Appendix A: Third-Party Software Licenses 45 Index 51 ii Installing Surround SCM The tasks to install and start using Surround SCM depend on your role. Users Use the client-only installer to install the Surround SCM Client, command line interface (CLI), API, and integration components. Note: If you only use Surround SCM Web, you do not need to install anything. Contact your Surround SCM administrator if you need the Surround SCM Web URL or login credentials. 1. Before installing, review the Surround SCM Client system requirements. 2. Download the Surround SCM client-only installer for your operating system. 3. Run the installer and select installation options. 4. After installation is complete, start Surround SCM, add a server connection, and log in. See the Surround SCM help for information about using Surround SCM. Administrators If you are an administrator responsible for configuring Surround SCM for the team, perform a complete installation, which includes the Surround SCM Server, Helix ALM License Server, and client applications. The following components are also included in the complete installer: Surround SCM Web Server, PostgreSQL (default RDBMS), and proxy server. Note: If you are upgrading Surround SCM, see Upgrading Surround SCM, page 3. 1. Before installing, review the following information: n Surround SCM Server system requirements n Surround SCM Client system requirements n Helix ALM License Server system requirements n Database information 2. Download the complete Surround SCM installer for your operating system. 3. Run the installer and select installation options. 4. After installation is complete, start and configure the license server, and then start and configure the Surround SCM Server. Depending on how your organization uses Surround SCM, you may also need to perform the following tasks: n Configure the Surround SCM Web Server n Configure the Surround SCM Proxy Server 1 Upgrading Surround SCM Perform the following tasks to upgrade Surround SCM. If you need help, contact Perforce Support. Preparing for the upgrade 1. Review the release notes for information about new features, enhancements, bug fixes, and important upgrade information. 2. Check the system requirements to make sure computers you are installing Surround SCM components on have the required space, memory, and other resources to run efficiently. n Client system requirements n Server system requirements n License server system requirements n RDBMS support n Supported web browsers 3. If you are upgrading from Surround SCM 2008 or earlier, review important upgrade information. 4. Download the installer for the current Surround SCM version. Tip: You may also want to upgrade to a more recent version of the RDBMS you host Surround SCM databases in. Upgrading an RDBMS is a manual process that is not part of the Surround SCM installation. See Surround SCM RDBMS Support for a list of supported versions. Performing the upgrade The time it takes up upgrade depends on the Surround SCM components you are installing and your data. Note: If you are upgrading both Surround SCM and Helix ALM, upgrade the product with the most recent release date last to guarantee you install the latest version of the Helix ALM License Server. 1. Run the Surround SCM Analyze Utility to analyze and repair any data integrity issues in the Surround SCM Server database. See the Analyze Utility help for information. 2. Stop the Helix ALM License Server and Surround SCM Server. 3. Back up your license server database and Surround SCM Server and mainline databases. 4. Run the Surround SCM installer. 5. Start the license server and Surround SCM Server applications. The Surround SCM Server database and RDBMS mainline branches stored in the server database are automatically upgraded and any new required tables are created in the database. You cannot use upgraded databases with older Surround SCM versions, which is why it is important to have a backup copy. 6. Upgrade mainline branches stored in other RDBMS databases if needed. See the Surround SCM help for information. Tip: If users cannot log in after upgrading, make sure a license is assigned to the user and that maintenance for the license is not expired. See Users Cannot Log In After Upgrading. 3 Before You Install Before installing Surround SCM, determine the options to select during the installation. Keep the following in mind: n You must be logged in as a user with full administrative privileges. n If you are installing on a 64-bit operating system, determine if you need to install 32-bit or 64-bit components. See About 64-bit Surround SCM components, page 6. Users Keep the following in mind before installing the Surround SCM Client and other components. n Review the client system requirements to make sure the computer you are installing on has the required space, memory, and other resources to run efficiently. n If you use Adobe Dreamweaver CC 13 - 2014.1, you must install Adobe Extension Manager CC before installing the Dreamweaver extension with Surround SCM. See Dreamweaver Integration. Administrators Keep the following in mind before installing and configuring Surround SCM server applications. n If you use Helix ALM, the Helix ALM License Server and license server admin utility may already be installed on your network. Check with the Helix ALM administrator. n Review the client system requirements and server system requirements to make sure computers you are installing on have the required space, memory, and other resources to run efficiently. n Determine which RDBMS database type to store Surround SCM data in. See About Surround SCM databases, page 5.