Installation Guide. Version

Transcription

1 Installation Guide Version

2 Copyrights 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 USA documentation@seapine.com

3 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 29 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

4 Setting up SQL Server databases 39 Troubleshooting RDBMS connections 40 Troubleshooting 43 Appendix A: Third-Party Software Licenses 45 Index 51 ii

5 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 client system requirements. 2. Download the 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 Before installing, review the following information: Server system requirements Client system requirements Helix ALM License Server system requirements Database information 2. Download the complete 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: Configure the Surround SCM Web Server Configure the Surround SCM Proxy Server 1

6

7 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. Client system requirements License server system requirements Supported web browsers Server system requirements RDBMS support 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 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

8

9 Before You Install Before installing Surround SCM, determine the options to select during the installation. Keep the following in mind: You must be logged in as a user with full administrative privileges. 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. 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. If you use Adobe Dreamweaver CC , 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. 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. 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. Determine which RDBMS database type to store Surround SCM data in. See About Surround SCM databases, page 5. If you are installing the Surround SCM Proxy Server, we recommend adding a proxy server configuration to the master Surround SCM Server before the proxy server is installed. See the Surround SCM help for information about using proxy servers. If you use Surround SCM Linux and will use PostgreSQL for the database, make sure your Linux server's locale LC_CTYPE setting is either UTF8, C, or POSIX. See PostgreSQL Installation Fails on Linux. About Surround SCM databases Surround SCM data is stored in RDBMS-based databases. Microsoft SQL Server, Oracle, and PostgreSQL are supported. See RDBMS Support for information about supported platforms and versions. The following data is stored in databases: Surround SCM Server Each Surround SCM Server has a server database, which is a set of tables that store user, security group, workflow, custom field, filter, report, shadow folder, trigger, and Helix ALM integration connection information. Server options, the mail queue, and the server log are also stored in this database. Mainline branches Each mainline branch has a database, which is a set of tables that store all file information. Helix ALM License Server Each license server has a separate database, which stores all license server data. See the License Server help for information. 5

10 About 64-bit Surround SCM components By default, the Surround SCM Server data and mainline branches are stored in the same RDBMS database. After installation, you can change the configuration if you want to use a different RDBMS type or move databases between servers. You can also move mainline branches to a separate database from the server database or store mainlines in multiple databases and point a single Surround SCM Server to them. Mainlines can only be associated with one Surround SCM Server. You can leverage your existing database administration process and use standard database tools for tasks such as analysis, manipulation, and backups. All Surround SCM data is stored in the database except the server database connection information. Note: All file data is stored in the RDBMS database as binary large objects (BLOBs). The RDBMS may allow you to control where BLOB data is stored and indexed. If you want more granular control over BLOBs, consult your DBA and RDBMS documentation. Choosing an RDBMS database type Determine which RDBMS you will use to store Surround SCM data before installing to help streamline the installation process. Keep the following in mind: Server database tables are installed in a single RDBMS database. PostgreSQL is the default database type. Surround SCM can install PostgreSQL and create the database tables when installing the Surround SCM Server for the first time, or you can manually install it. You can also host Surround SCM databases in Oracle or SQL Server (Windows only). Your DBA must manually install Oracle or SQL Server before installation. See Setting Up RDBMS Databases, page 37. If you choose to use PostgreSQL, decide if you want to install the PostgreSQL files and databases on the Surround SCM Server computer or a different computer. You can point the Surround SCM Server to access RDBMS servers on other computers. The database configuration you use depends on your installation and environment. At any time, you can convert the RDBMS type or location for the server or mainline database or distribute mainline databases across multiple RDBMS database instances. If you do not know how you want to configure the databases, use the default PostgreSQL installation and make configuration changes later. Review the operating system and database firewall settings on the RDBMS server to make sure the Surround SCM databases are secure. Some RDBMS servers must be configured to allow remote computers to access databases. About 64-bit Surround SCM components 32-bit and 64-bit versions of the Surround SCM Client and Server are available. The 64-bit server lets the server computer access more RAM, which increases the number of branches that can be cached when the server starts. The 64-bit client lets users use Surround SCM on 64-bit Linux systems without needing to install additional libraries. Keep the following in mind: The 32-bit clients can communicate with the 64-bit server and vice versa. All installers include the 32-bit and 64-bit components. If you run an installer on a 64-bit system, you can select to install the 32-bit or 64-bit components. See Components installed on 64-bit systems, page 7. To add or edit Helix ALM items from the 64-bit Surround SCM Client, you must install Helix ALM (or TestTrack ). See Setting Surround SCM configuration options, page 14. 6

11 About 64-bit Surround SCM components Database conversion is not required when upgrading from the 32-bit server to the 64-bit server or downgrading from 64-bit to 32-bit servers. The only exception is if you upgrade from Surround SCM 5.x or earlier, which requires upgrading to Surround SCM 2008 or later to use the 64-bit server. See the Surround SCM Upgrade Guide for information. Components installed on 64-bit systems If you are installing Surround SCM on a 64-bit operating system, you can choose to install 32-bit or 64-bit components. The following information describes the available versions and what is installed based on the computer configuration. Windows Component Dreamweaver extension IntelliJ IDEA plug-in Microsoft Office plug-in SCCI integration libraries Shell extension for Windows Explorer integration Helix ALM License Server Helix ALM License Server Admin Utility Helix ALM License Server Web Admin Utility Surround SCM Analyze Utility Surround SCM API libraries Surround SCM CLI Installed as: 32-bit executable on 32-bit systems 32-bit and 64-bit executables on 64-bit systems 32-bit executable on 32-bit systems 32-bit and 64-bit executables on 64-bit systems 32-bit executable if 32-bit Microsoft Office is installed on system 64-bit executable if 64-bit Microsoft Office is installed on system 32-bit executable on 32-bit systems 32-bit and 64-bit executables on 64-bit systems 32-bit executable on 32-bit systems 32-bit and 64-bit executables on 64-bit systems 32-bit or 64-bit executable depending on selected installation option 32-bit or 64-bit executable depending on selected installation option 32-bit or 64-bit executable depending on selected installation option 32-bit or 64-bit executable depending on selected installation option 32-bit and 64-bit executables on all operating systems 32-bit or 64-bit executable depending on selected installation option 7

12 About 64-bit Surround SCM components Component Surround SCM Client Surround SCM Proxy Server Surround SCM Registry Utility Surround SCM Server Surround SCM Web Server Visual Studio integration package WebStorm plug-in Installed as: 32-bit or 64-bit executable depending on selected installation option 32-bit executable only 32-bit or 64-bit executable depending on selected installation option 32-bit or 64-bit executable depending on selected installation option 32-bit or 64-bit executable depending on selected installation option 32-bit executable only 32-bit executable on 32-bit systems 32-bit and 64-bit executables on 64-bit systems Linux Component IntelliJ IDEA plug-in KDevelop plug-in SCCI integration libraries Helix ALM License Server Helix ALM License Server Admin Utility Helix ALM License Server Web Admin Utility Surround SCM Analyze Utility Surround SCM API libraries Surround SCM CLI Installed as: 32-bit executable on 32-bit systems 32-bit and 64-bit executables on 64-bit systems 32-bit if 32-bit KDevelop is installed on system 64-bit if 64-bit KDevelop is installed on system 32-bit executable on 32-bit systems 32-bit and 64-bit executables on 64-bit systems 32-bit or 64-bit executable depending on selected installation option 32-bit or 64-bit executable depending on selected installation option 32-bit or 64-bit executable depending on selected installation option 32-bit or 64-bit executable depending on selected installation option 32-bit and 64-bit on all operating systems 32-bit or 64-bit executable depending on selected installation option 8

13 Installers Component Surround SCM Client Surround SCM Proxy Server Surround SCM Registry Utility Surround SCM Server Surround SCM Web Server WebStorm plug-in Installed as: 32-bit or 64-bit executable depending on selected installation option 32-bit executable only 32-bit or 64-bit executable depending on selected installation option 32-bit or 64-bit executable depending on selected installation option 32-bit or 64-bit executable depending on selected installation option 32-bit executable on 32-bit systems 32-bit and 64-bit executables on 64-bit systems Mac Component Dreamweaver extension IntelliJ IDEA plug-in SCCI libraries Shell extension for Mac Finder integration Surround SCM API libraries Surround SCM CLI Surround SCM Client WebStorm plug-in Installed as: 32-bit executable on 32-bit systems 32-bit and 64-bit executables on 64-bit systems Fat binary that includes 32-bit and 64-bit executables Fat binary that includes 32-bit and 64-bit executables Fat binary that includes 32-bit and 64-bit executables Fat binary that includes 32-bit and 64-bit executables Fat binary that includes 32-bit and 64-bit executables Fat binary that includes 32-bit and 64-bit executables Fat binary that includes 32-bit and 64-bit executables Installers The following Surround SCM installers are available. Note: All installers include 32-bit and 64-bit Surround SCM components. 9

14 Installation types Operating system Installation type Name Windows Client and server sscmwininstall.exe Client only sscmwininstallclient.exe Linux Client and server (Java installer) sscmlinuxjavainstall.tar.gz Client only (Java installer) Client and server (Perl command line installer) sscmlinuxjavaclientinstall.tar.gz sscmlinuxinstall.tar.gz Mac Client only sscmmacosxclientinstall.dmg.gz Installation types You can choose to install the following Surround SCM components. If you are installing on a 64-bit operating system, see About 64-bit Surround SCM components, page 6 for information about available 32-bit and 64-bit components. Component Installs: Notes Surround SCM Client Surround SCM API Surround SCM Server Surround SCM Web Server Surround SCM Proxy Server Helix ALM License Server Web Admin Utility GUI client, command line interface (CLI) client, and SCCI DLL API Surround SCM Server application and Surround SCM Analyze Utility. Optionally installs PostgreSQL to host data. Surround SCM Web service and application Surround SCM Proxy Server application Web-based Helix ALM License Server Admin Utility Most users only need to install the client. Allows third-party client applications to communicate with the Surround SCM Server. The server application and analyze utility are generally installed on a networked computer. Allows users to view and download source files from Surround SCM Web. See Configuring Surround SCM Web, page 33. We recommend configuring a proxy server definition on the master Surround SCM Server before installing the proxy server. See Configuring the Surround SCM Proxy Server, page 35. A web server must be installed on the computer before installation. See Configuring web servers for the Helix ALM License Server Web Admin Utility, page

15 Installation types Component Installs: Notes Helix ALM License Server Admin Utility Helix ALM License Server Helix ALM License Server Admin Utility Helix ALM License Server application The Helix ALM License Server and admin utility are generally installed on a networked computer. The Helix ALM License Server and admin utility are generally installed on a networked computer. 11

16

17 Running the Installer After downloading the installer, run it on the computer to install the Surround SCM components on. Note: To install 64-bit Surround SCM applications, you must run the installer on a 64-bit system. Windows Double-click the installation file. Tip: The network administrator can run a silent, client-only install to multiple computers without user intervention. See Running a silent installation on Windows, page 18 for information. Linux Note: Specific system libraries are required to run Helix ALM applications on different Linux distributions. You must install these libraries before using the applications to make sure they work correctly. See Checking for Missing System Libraries on Linux for information. Java installer 1. Double-click the installer archive or enter tar -zxvf <InstallerFilename>.tar.gz in Terminal to extract the installer. 2. Run the extracted.bin file as root to start the installer. Perl command line installer 1. In Terminal, enter tar -zxvf <InstallerFilename>.tar.gz to extract the installer. 2. Enter cd sscm-<version> to change to the Surround SCM application directory. For example, if you are installing Surround SCM , enter cd sscm Enter./install.pl as root to run the install script. Mac 1. Double-click the installation file to extract the installer and then double-click sscmmacosxclientinstall.dmg to mount the image. 2. Double-click the Surround SCM disk image on the desktop or in Finder and then double-click Install Surround SCM. During installation You must select settings for the components you choose to install. Depending on installation type, you may be prompted to select options for the following components: Third-party integrations Surround SCM applications 13

18 Setting Surround SCM integration options Surround SCM Web Server RDBMS Setting Surround SCM integration options Surround SCM can be integrated with third-party IDEs, build tools, and applications. These integrations allow access source files stored in Surround SCM from other applications without using a Surround SCM client. See Third-Party Integrations for a list of supported integrations. Surround SCM conforms to the Microsoft Source Code Control Interface (SCCI) standard and can be integrated with many Windows IDEs and applications, which may include integrations Perforce does not officially support. To use Surround SCM as the default source control provider for applications that support SCCI, select the Make Surround SCM my default SCCI provider option. Other integration options and plug-ins are also available during installation. Some Unix application integration plug-ins must be manually installed. See the Integrations knowledgebase for setup, usage, and troubleshooting information. Setting Surround SCM configuration options Note: If installing Surround SCM on a 64-bit system, you can choose to install 32-bit or 64-bit versions of the selected applications. See About 64-bit Surround SCM components, page 6. To add or edit Helix ALM items from the 64-bit Surround SCM Client, you must install Helix ALM (or TestTrack ). You must select a Surround SCM application directory. Linux installations also require selecting a directory for the SCMStartup.log and SCMProxyStartup.log files. You can use the default directory or select a different directory. Additional configuration options include setting the server port number and choosing a server execution mode (Windows only). Default directories Installer Files Default directory Windows 32-bit applications (all files) C:\Program Files (x86)\perforce\surround SCM 64-bit applications (all files) C:\Program Files\Perforce\Surround SCM Linux Application /var/lib/surroundscm SCMStartup.log and SCMProxyStartup.log files Unix commands /var/log /usr/bin Mac Application /Applications/Surround SCM Unix commands /usr/local/bin 14

19 Setting Surround SCM Web Server configuration options Server execution mode (Windows only) You can choose to run the Surround SCM Server as a service if you want the server to automatically start when the computer starts. If you run the server as an application, you must manually start the Surround SCM Server application. Server port The server communicates with Surround SCM clients on this port. Use the default port number (4900) or enter another number. Setting Surround SCM Web Server configuration options The Surround SCM Web Server is installed in the sscmweb directory in the Surround SCM application directory. You must specify the Surround SCM Server address and port, and HTTP and HTTPS ports for the web server. Server address and port The Surround SCM Web Server uses this information to communicate with the Surround SCM Server. Use the default server (localhost) and port (4900) if installing the web server on the Surround SCM Server computer, or enter the address and port number for the Surround SCM Server you want users to access from Surround SCM Web. HTTP and HTTPS ports Surround SCM Web clients communicate with the web server on these ports. Use the default port numbers (8090 for HTTP and 8443 for HTTPS) or enter different numbers. Setting Helix ALM License Server options You must select a Helix ALM License Server application directory. Linux installations also require selecting a directory for the LSStartup.log file. You can use the default directory or select a different directory. Additional configuration options include setting the server port number, choosing a server execution mode (Windows only), and setting the web server admin utility CGI and HTML file locations. Default installation directories Operating system Files Default directory Windows 32-bit applications (all files) C:\Program Files (x86)\perforce\license Server 64-bit applications (all files) C:\Program Files\Perforce\License Server Linux Application /var/lib/splicsvr LSStartup.log file Unix commands /var/log /usr/bin 15

20 Setting RDBMS configuration options Web server admin utility CGI and HTML file directories If you are installing the Helix ALM License Server Web Admin Utility, you must set a location for the CGI scripts and HTML files. Microsoft IIS and Apache web servers are supported. See Supported Web Servers for supported versions. Web server Operating system Default CGI directory Default HTML files directory IIS Windows C:\inetpub\scripts C:\inetpub\wwwroot Apache Windows cgi-bin directory in the Apache application directory htdocs directory in the Apache application directory Linux /var/www/cgi-bin /var/www/html Server execution mode (Windows only) You can choose to run the Helix ALM License Server as a service if you want the server to automatically start when the computer starts. If you run the server as an application, you must manually start the Helix ALM License Server application. Note: The Helix ALM License Server supports single sign-on, which allows LDAP users to automatically log in to Helix ALM products using the same credentials used to log in to their computer. See the license server help for information. Server port Surround SCM clients and the Helix ALM License Server Web Admin Utility CGI communicate with the license server on this port. Use the default port number (5100) or enter another number. Linux installation notes Specific system libraries are required to run Helix ALM applications on different Linux distributions. You must install these libraries before using the applications to make sure they work correctly. See Checking for Missing System Libraries on Linux for information. If CGIs are installed on Linux distributions with SELinux security policies, you must enable network requests from CGI executables before you can use Helix ALM web clients. See CGIs on Linux Cannot Connect to the Helix ALM License Server and Helix ALM Server for information. Setting RDBMS configuration options Surround SCM data must be stored in an RDBMS database. If you do not have an existing RDBMS installation, you can install PostgreSQL when installing the Surround SCM Server for the first time. PostgreSQL is the default RDBMS type, but you can use Oracle or SQL Server instead. If you are using an existing RDBMS installation, create an empty database before installing Surround SCM so you have the RDBMS connection information available. 16

21 Setting RDBMS configuration options Note: Make sure the RDBMS version is supported on the operating system you are using. See RDBMS Support for a list of supported versions. See the RDBMS vendor documentation for information about supported operating systems. Installing PostgreSQL with Surround SCM Following are the default PostgreSQL directories. Operating system Files Default directory Windows Application and documentation files C:\Program Files\PostgreSQL\<version> Databases, tables, and configuration files C:\Program Files\PostgreSQL\<version>\data Linux All files /usr/local/pgsql Configuring PostgreSQL options You must use the following default host name and port number for PostgreSQL: Host name localhost Port number 5432 Note: You can change the port number at a later time if other applications use port See Changing the PostgreSQL Port Number. Accessing PostgreSQL databases The PostgreSQL service starts automatically the first time you start the Surround SCM Server. The service is also configured to start automatically when the server computer is restarted. During PostgreSQL installation, a new user is automatically created to start and stop the PostgreSQL service and manage the PostgreSQL data directory. Following are the default PostgreSQL database and service login credentials. Credential Service username Service password Database username Database password Default value postgres P0stgreSQL seapine s34p1n3 Note: We strongly recommend changing the database username and password during installation, but you can use PostgreSQL commands to change the credentials at a later time. Refer to the PostgreSQL documentation for information. 17

22 Running a silent installation on Windows Using Oracle, SQL Server, or existing PostgreSQL installations If you choose to use an existing RDBMS, you must manually install the database server and enter connection information for an empty UTF-8 encoded database before starting the Surround SCM Server. See Setting Up RDBMS Databases, page 37. Running a silent installation on Windows Network administrators can run Windows client-only installers from the command prompt to install the Surround SCM desktop client on multiple computers without user intervention. To run the installer in silent mode using the default installation options, enter the following at the command prompt: <InstallerFilename.exe> -i SILENT For example: sscmwininstallclient.exe -i SILENT Tip: You can also use the -i SILENT option to uninstall components installed during the most recent installation. The uninstaller is located in the Uninstall_Surround SCM folder in the Surround SCM application directory. Customizing installations You can customize silent installations to change the installation location, only install specific components, and change other options. You need to use a properties file, which the installer uses to determine the installation options. The properties file can be in the same directory as the installer or on a network drive. Creating a properties file You can manually or automatically create a properties file. To manually create a properties file, download the sscmwininstallclient.properties.txt file and modify it to customize your installation. Note: Remove the.txt extension from the downloaded file before using it. File extensions are hidden by default in Windows Explorer. If you do not remove the.txt extension, you must specify the full path to the file to use it during installation. To automatically create a properties file, use the -r option to capture the settings used during installation in a response file that can be used for future installations. To use the -r option, you must specify the filename or a full path to the properties file, or you can use. to create a file with the default filename in the current directory. For example: sscmwininstallclient.exe r myinstall.properties Using the properties file during silent installation To use the properties file during silent installation, use the -f option. For example: sscmwininstallclient.exe -i SILENT -f C:\sscmwininstallclient.properties Note: The -f and -r options cannot be used together. You can specify the full or relative path to the properties file. 18

23 Running a silent installation on Windows If the properties file is in the same directory as the installer, you do not need to specify any parameters. The installer searches the relative directory for files named installer.properties or <InstallerFilename>.properties (e.g., sscmwininstallclient.properties) and uses the settings in the properties file. If the directory contains both files, installer.properties is used. If a file is not found and you are performing a new installation, the default installation options are used. If a file is not found and you are upgrading, values written to the system registry during previous installations are used. Note: If INSTALLER_UI=SILENT is set in the properties file, you do not need to specify SILENT on the command line. 19

24

25 Starting Surround SCM The Helix ALM License Server and Surround SCM Server must be running before you start Surround SCM. Contact your administrator for help if the servers are not running. See Starting the Helix ALM License Server, page 23 and Starting the Surround SCM Server, page 31. If this is your first time using Surround SCM and you have not set up any users, you can log in as the default administrative user. The username is Administrator and there is no password. Note: If you try to log in to Surround SCM and the license server is not running orfound, you are prompted to log in using the local SCM admin password. This allows you to log in and verify the license server settings. See Configuring a Helix ALM License Server connection, page 24. Surround SCM Client Windows Choose Programs > Perforce > Surround SCM > Surround SCM Client on the Start menu. Mac Double-click the Surround SCM Client icon in the Applications/Surround SCM folder. Linux Enter /usr/bin/scmgui start The first time you start Surround SCM, you are prompted to add a server connection. See the Surround SCM help for information about adding server connections. Command line interface (CLI) You can use the Surround SCM CLI to access all features and functionality from a Unix command shell or Windows DOS prompt. 1. In a command prompt, use the cd command to change to the directory where Surround SCM is installed. For example, enter cd C:\Program Files\Perforce\Surround SCM to open the default installation directory on Windows. 2. Enter sscm followed by the command and options at the prompt. See the CLI help for information about the available commands and options. Surround SCM Web The administrator needs to make sure the Surround SCM Web Server is running before users can access Surround SCM Web. See Starting the Surround SCM Web Server, page 33. To use Surround SCM Web, you need the Surround SCM URL and your Surround SCM username and password. 1. Start a web browser and enter the Surround SCM URL. The URL includes the name or IP address of the computer that hosts Surround SCM, the port number (default is 8090), and the path to the login page. For example, 2. Enter your Username and Password. 3. Click Log In. You are logged in and ready to start using Surround SCM. See the Surround SCM Web help for more information. 21

26

27 Configuring the Helix ALM License Server The Helix ALM License Server must be running and configured before users can access Surround SCM. 1. Make sure the Helix ALM License Server is running. 2. Start the Helix ALM License Server Admin Utility and configure a license server connection. Note: To use the Helix ALM License Server Web Admin Utility, you must install and configure the license server web components. See Configuring web servers for the Helix ALM License Server Web Admin Utility, page Add licenses and users to the license server. Starting the Helix ALM License Server An administrative user must make sure the Helix ALM License Server is running before the Surround SCM Server is started. Tip: If Surround SCM cannot connect to the license server, an administrative user needs to troubleshoot. See Surround SCM Cannot Connect to the License Server for information. Windows If the license server is installed as a service, it starts automatically. If the license server is installed as an application, you must start it manually. Choose All Programs > Perforce > Helix ALM License Server > Helix ALM License Server from the Start menu. Note: If the server is installed as a service but not running or you need to restart it, see the Windows documentation for information about starting a service. Linux Enter /usr/bin/spls start. If you need to restart the server, enter /usr/bin/spls stop and then restart the server. Starting Helix ALM License Server Admin Utility Use the Helix ALM License Server Admin Utility to manage Helix ALM product licenses and global users and customers. Windows Choose All Programs > Perforce > Helix ALM License Server > Helix ALM License Server Admin on the Start menu. Linux Enter /usr/bin/lsadmin. 23

28 Configuring a Helix ALM License Server connection Web In a web browser, enter the server admin utility URL. The URL uses the static or IP address of the web server hosting the admin utility and the path to the admin utility files. For example, Configuring a Helix ALM License Server connection The Surround SCM Server connects to the Helix ALM License Server to authenticate license and user information. If you installed the Surround SCM Server and the Helix ALM License Server on the same computer and chose to use the default port numbers (5100 for license server and 4900 for the Surround SCM Server), the Surround SCM Server automatically connects to the license server when it starts. Tip: If the license server is installed on a different computer or port, or is not found, you can log in using the local admin password to verify the connection information. See Troubleshooting, page 43 for information. 1. Start the Helix ALM License Server and the Helix ALM License Server Admin Utility. 2. Click Setup on the Helix ALM License Server Login dialog box. 3. Click Add on the Setup Server Connections dialog box. 4. Enter a Server Name, Server Address, and Port. The default port is Click OK to add the server connection. 6. Click Close in the Setup Server Connections dialog box to return to the Helix ALM License Server Login dialog box. 7. Log in as the default administrative user and click Connect. The username is Administrator and there is no password. By default, the Administrator user has full admin security permissions and uses a floating license. We strongly recommend setting a password for this user to prevent unauthorized user access. Adding licenses to the Helix ALM License Server Users must have a license to access Surround SCM. Helix ALM product licenses are managed in the Helix ALM License Server. When you purchase a license, you need to add it to the license server before assigning it to users. Note: If you need to purchase Surround SCM or other product licenses, contact Perforce Sales. 1. Start the Helix ALM License Server Admin Utility. 2. Click Licenses. The Helix ALM Licenses dialog box opens. 3. Click Add. The Add License dialog box opens. 4. Enter the serial number or click Browse to select a license file. 24

29 Adding users to the Helix ALM License Server License files have a.lic extension. If you manually enter a license, the Serial Number field is case sensitive. Licenses can be entered with or without dashes. 5. Click OK to add the license. You can assign the license to users to provide access to Surround SCM. See Adding users to the Helix ALM License Server, page 25. Adding users to the Helix ALM License Server Add users to the license server to provide access to Surround SCM. Users added to the license server are global users and can be shared across Helix ALM products. Tip: You can also add users directly in Surround SCM. See the Surround SCM help for information. 1. Start the Helix ALM License Server Admin Utility. 2. Click Global Users. The Global Users dialog box opens. 3. Click Add and then select Add User. The Add User dialog box opens. 4. Enter the user's contact information, username and password, security permissions, and licenses. See the Helix ALM License Server help for information. 5. Click Add to add the user to the Global Users list. 6. Close the Helix ALM License Server Admin Utility. You are prompted to change the communications and Administrator passwords. We strongly recommend changing these passwords to prevent unauthorized user access. After global users are added to the license server, you can retrieve them in Surround SCM and then add them to security groups. See the Surround SCM help for information. Configuring web servers for the Helix ALM License Server Web Admin Utility The Helix ALM License Server Web Admin Utility requires a set of HTML files and CGI scripts, which are hosted and configured on a web server. See Helix ALM License Server Supported Web Servers for a list of supported web servers. The utility components can be installed during Surround SCM installation. After installation, you need to configure the web server before administrative users can use the utility. See the following information to configure your web server. Apache IIS 7 and later IIS 6 Tip: If you use IIS, you can also configure single sign-on for the license server web admin utility to let users log in using their network credentials. See the license server admin help for information. 25

30 Configuring Apache for the Helix ALM License Server Web Admin Utility Security notes Login credentials sent from the Helix ALM License Server Web Admin Utility to the CGI are not encrypted, even if encryption is enabled on the server. We strongly recommend configuring HTTPS to encrypt communication from the browser to the CGI on the web server. See your web server documentation for information about configuring and using HTTPS. Clickjacking can occur when hackers use transparent frames or iframes to embed content in web pages to trick users into clicking buttons or hyperlinks on a different web page in another domain or application. To protect your data and prevent clickjacking in the license server web admin utility, configure the web server that hosts it to include X-Frame-Options and Content-Security-Policy HTTP response headers. See Preventing Clickjacking Attempts on Helix ALM Web Clients for information. Configuring Apache for the Helix ALM License Server Web Admin Utility After you install the Helix ALM License Server Web Admin Utility files, you need to create a CGI directory alias on the Apache web server before administrative users can log in. 1. Open the httpd.conf file in the Apache application directory. Note: The Apache directory structure varies on Linux distributions. If an httpd.conf file does not exist in the application directory, you may need to create it in a different directory. See Linux notes, page Search the file for ScriptAlias /cgi-bin on a line that does not start with a pound symbol (#). If the directory does not exist, add the following line to the file to point to the location where CGIs are installed: ScriptAlias /cgi-bin/ "<Apache application directory path>/cgi-bin/" Windows example The Apache application directory location varies on Apache and Windows versions. Replace <Apache application directory path> with the exact directories in the cgi-bin path. Following are examples of default paths. Apache accepts forward or back slashes in Windows paths. Windows version 32-bit Apache path 64-bit Apache path 64-bit C:\Program Files (x86)\apache C:\Program Files\Apache 32-bit C:\Program Files\Apache -- Example: ScriptAlias /cgi-bin/ "C:\Program Files\Apache Group\Apache\cgi-bin\" Linux example ScriptAlias /cgi-bin/ "/var/www/cgi-bin/" 26

31 Configuring Microsoft IIS 7 and later for the Helix ALM License Server Web Admin Utility Linux notes Additional installation and configuration steps may be required on some Linux distributions. Keep the following in mind: Apache configuration files may be installed in multiple directories. For example, on Debian and Ubuntu, the Apache application directory has an apache2.conf file that locates configuration files in subdirectories. To add the required CGI directory alias on these distributions, create an httpd.conf file in the /etc/apache2/mods-enabled directory and add the ScriptAlias line to it. Save the file and restart Apache. Review the apache2.conf file in the Apache application directory for information about modifying configuration files on other distributions. Specific system libraries are required to run Helix ALM applications on different Linux distributions. You must install these libraries before using the applications to make sure they work correctly. See Checking for Missing System Libraries on Linux for information. Configuring Microsoft IIS 7 and later for the Helix ALM License Server Web Admin Utility After you install the Helix ALM License Server Web Admin Utility files, you need to configure the web server before administrative users can log in. See License Server Supported Web Servers for information about supported Microsoft Internet Information Server (IIS) versions. Refer to the IIS documentation for information about enabling CGI execution and authentication. Note: If you use IIS 6, see Configuring Microsoft IIS 6 for the Helix ALM License Server Web Admin Utility, page 29. Enabling support for CGI executables Windows Vista, 7, 8, 8.1, and Choose Start > Control Panel > Programs and Features. 2. Click Turn Windows features on or off in the Tasks pane. 3. Expand the Internet Information Services, World Wide Web Services, and Application Development Features nodes. 4. Select CGI. 5. Click OK to save the changes. Windows Server Choose Start > Control Panel > Programs and Features. 2. Click Turn Windows features on or off in the Tasks pane. 3. Click Roles in the left pane. 4. Click Add Role Services in the right pane. 5. Expand the Web Server and Application Development Features nodes. 27

32 Configuring Microsoft IIS 7 and later for the Helix ALM License Server Web Admin Utility 6. Select CGI. 7. Click OK to save the changes. Windows Server Choose Start > Control Panel > Programs and Features. 2. Click Turn Windows features on or off in the Tasks pane. 3. Select Role-based or feature-based installation on the Installation Type page and click Next. 4. Select the server you want to use and click Next. 5. Expand the Web Server (IIS), Web Server, and Application Development Features nodes. 6. Select CGI and click Next. 7. Click Next to skip the Features information. You do not need to change any of these values. 8. Click Install to save the changes. Creating a CGI directory alias 1. Open IIS Manager. 2. In the Connections pane, expand the server computer and Sites nodes. 3. Right-click Default Web Site and choose Add Virtual Directory. The Add Virtual Directory dialog box opens. 4. Enter 'scripts' as the Alias. 5. Enter the path to the lscgi.exe as the Physical Path. This is the path entered during the admin utility installation. The default path is C:\inetpub\scripts. 6. Click OK to save the changes. Enabling the.exe CGI extension 1. Select the scripts virtual directory in the Connections pane. 2. Double-click Handler Mappings. 3. Click Add Module Mapping in the Actions pane. The Add Module Mapping dialog box opens. 4. Enter 'lscgi.exe' as the Request path. 5. Select CgiModule as the Module. 6. Enter 'lscgi' as the Name. 7. Click OK to save the changes. 8. Select the server computer in the Connections pane. 9. Double-click ISAPI and CGI Restrictions. 10. Click Add in the Actions pane. The Add ISAPI or CGI Restriction dialog box opens. 28

33 Configuring Microsoft IIS 6 for the Helix ALM License Server Web Admin Utility 11. Enter the path to the lscgi.exe program as the ISAPI or CGI path. This is the path entered for the lscgi.exe program during the admin utility installation. The default path is C:\inetpub\scripts\lscgi.exe. 12. Enter 'lscgi' as the Description. 13. Select Allow extension path to execute. 14. Click OK to save the changes. Configuring Microsoft IIS 6 for the Helix ALM License Server Web Admin Utility After you install the Helix ALM License Server Web Admin Utility files, you need to configure the web server before administrative users can log in. See License Server Supported Web Servers for information about supported Microsoft Internet Information Server (IIS) versions. Refer to the IIS documentation for information about enabling CGI execution and authentication. Note: If you use IIS 7 or later, see Configuring Microsoft IIS 7 and later for the Helix ALM License Server Web Admin Utility, page 27. Creating a CGI directory alias 1. Open IIS Manager. 2. Expand the server computer and Web Sites nodes. 3. Right-click Default Web Site and choose New > Virtual Directory. The Virtual Directory Creation Wizard opens. 4. Follow the on-screen instructions. Enter the following information when prompted: Enter scripts as the Alias. Set the Directory to the path that was entered during the admin utility installation for the lscgi.exe program. The default path is C:\inetpub\scripts. Select the following Access Permissions: Read, Run scripts, Execute. 5. Click Finish to save the changes. Enabling the.exe CGI extension 1. In IIS Manager, expand the server computer and select Web Service Extensions. 2. Click Add a new Web service extension in the Web Service Extensions pane. 3. Enter 'LSAdmin' as the Extension name. 4. Click Add. 5. Enter the path to the lscgi.exe program and click OK. The default location is C:\inetpub\scripts\lscgi.exe. 6. Select Set extension status to Allowed. 7. Click OK. 8. Click OK to save the changes. 29