Surround SCM. Installation Guide Version

Transcription

1 Surround SCM Installation Guide Version

2 Copyrights 2015 Seapine Software, Inc. All rights reserved. Defect Scribe, QA Wizard Pro, Resource Thief, Seapine CM, SoloBug, SoloSubmit, Surround SCM, and TestTrack are trademarks or registered trademarks of Seapine Software, Inc. in the United States and other countries. Borland and StarTeam are trademarks or registered trademarks of Borland, Inc. in the United States and other countries. Delphi and JBuilder are trademarks or registered trademarks of Embarcadero Technologies, Inc. in the United States and other countries. Acrobat Reader is a registered trademark of Adobe, Inc. in the United States and other countries. Sun, JVM, Java, JavaScript, and all Java-based marks are trademarks or registered trademarks of Sun Microsystems, 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, Macintosh, Objective-C, and Safari are registered trademarks of Apple Computer, Inc. Microsoft, Windows, Windows NT, 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. Linux is a trademark of Linus Torvalds. Red Hat, Red Hat Enterprise Linux, and Fedora are registered trademarks of Red Hat, Inc. in the United States and other countries. SUSE is a registered trademark of Novell Inc. in the United States and other countries. Debian is a registered trademark of Software in the Public Interest, Inc. Ubuntu is a registered trademark of Canonical Ltd. IBM, ClearCase, and all other IBM brand and product names are service marks, trademarks or registered trademarks of IBM Corporation or its subsidiaries in the United States and other countries. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. PVCS, Serena PVCS Professional Suite, and Serena PVCS Version Manager are registered trademarks of Serena Software, Inc. 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 Seapine Software, Inc. Your license agreement with Seapine Software, Inc., 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 Seapine Software, Inc. 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. Seapine Software, Inc Cintas Boulevard Mason, OH (513) 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 10 Installation types 10 Running the Installer 13 Setting Surround SCM integration options 13 Setting Surround SCM configuration options 14 Setting Surround SCM Web Server configuration options 15 Setting WebDAV CGI configuration options 15 Setting Seapine License Server options 15 Setting Surround SCM CMIS Server configuration options 17 Setting RDBMS configuration options 17 Starting Surround SCM 19 Configuring the Seapine License Server 21 Starting the Seapine License Server 21 Starting the Seapine License Server Admin Utility 21 Configuring a Seapine License Server connection 21 Adding licenses to the Seapine License Server 22 Adding users to the Seapine License Server 22 Configuring web servers for the Seapine License Server Web Admin Utility 23 Configuring Apache for the Seapine License Server Web Admin Utility 23 Configuring Microsoft IIS 7 and 8 for the Seapine License Server Web Admin Utility 23 Configuring Microsoft IIS 6 for the Seapine License Server Web Admin Utility 25 Configuring New Surround SCM Installations 27 Starting the Surround SCM Server 27 Configuring a Surround SCM Server connection 27 Configuring Surround SCM Web 29 Starting the Surround SCM Web Server 29 Configuring the Surround SCM Proxy Server 31 Starting the Surround SCM Proxy Server 31 Configuring the Surround SCM CMIS Server 33 Starting the Surround SCM CMIS Server 33 i

4 Starting the Surround SCM CMIS Admin Utility 34 Configuring WebDAV for Surround SCM 35 Configuring web servers for WebDAV 36 Configuring Apache for WebDAV 36 Configuring Microsoft IIS 7 and 8 for WebDAV 37 Configuring Microsoft IIS 6 for WebDAV 39 Configuring anonymous user access for WebDAV 39 Configuring WebDAV text file end-of-line format 40 WebDAV configuration example 40 Setting Up RDBMS Databases 43 Setting up PostgreSQL databases 43 Setting up Oracle databases 44 Setting up SQL Server databases 45 Troubleshooting RDBMS connections 46 Troubleshooting 51 Appendix A: Third-Party Software Licenses 53 Index 57 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 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, Seapine License Server, and client applications. The following components are also included in the complete installer: Surround SCM Web Server, PostgreSQL (default RDBMS), proxy server, CMIS server, and WebDAV CGI. Note: If you are upgrading Surround SCM, see Upgrading Surround SCM, page Before installing, review the following information: Surround SCM Server system requirements Surround SCM Client system requirements Seapine License Server system requirements 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 Seapine 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 Configure the CMIS Server Configure WebDAV 1

6

7 Upgrading Surround SCM Perform the following tasks to upgrade Surround SCM. If you need help, contact Seapine 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 Server system requirements RDBMS support 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. 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 TestTrack, upgrade the product with the most recent release date last to guarantee you install the latest version of the Seapine 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 Surround SCM Analyze Utility help for information. 2. Stop the Seapine License Server and Surround SCM Server. 3. Back up your Seapine License Server database and Surround SCM Server and mainline databases. 4. Run the Surround SCM installer. 5. Start the Seapine 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 Surround SCM 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 Surround SCM Dreamweaver Integration. Administrators Keep the following in mind before installing and configuring Surround SCM server applications. If you use TestTrack, the Seapine License Server and Seapine License Server Admin Utility may already be installed on your network. Check with the TestTrack administrator. Review the Surround SCM Client System Requirements and Surround SCM 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 Surround SCM 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. The following Surround SCM data is stored in databases: 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 TestTrack integration connection information. Server options, the mail queue, and the server log are also stored in this database. Each mainline branch has a database, which is a set of tables that store all file information. 5

10 About 64-bit Surround SCM components By default, the server and mainline databases are stored in the same 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 databases 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 during the installation, 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 43. 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. 6

11 About 64-bit Surround SCM components To add or edit TestTrack items from the 64-bit Surround SCM Client, you must install TestTrack or later. See Setting Surround SCM configuration options, page 14. 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 Seapine License Server Seapine License Server Admin Utility Seapine 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 CMIS Admin Utility Surround SCM CMIS Server Surround SCM Proxy Server Surround SCM Registry Utility Surround SCM Server Surround SCM Web Server Visual Studio integration package WebDAV CGI library WebStorm plug-in Installed as: 32-bit or 64-bit executable depending on selected installation option 32-bit executable only 32-bit executable only 32-bit executable only 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 executable only 32-bit executable only 32-bit executable on 32-bit systems 32-bit and 64-bit executables on 64-bit systems Mac OS X Component Dreamweaver extension IntelliJ IDEA plug-in SCCI libraries Seapine License Server Seapine License Server Admin Utility Seapine License Server Web Admin Utility Shell extension for Mac Finder integration 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 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 Fat binary that includes 32-bit and 64-bit executables Fat binary that includes 32-bit and 64-bit executables 8

13 About 64-bit Surround SCM components Component Surround SCM Client Surround SCM CMIS Admin Utility Surround SCM CMIS Server Surround SCM Proxy Server Surround SCM Registry Utility Surround SCM Server Surround SCM Web Server WebDAV CGI library WebStorm plug-in Xcode plug-in Installed as: Fat binary that includes 32-bit and 64-bit executables 32-bit executable only 32-bit executable only 32-bit executable only 32-bit executable only Fat binary that includes 32-bit and 64-bit executables Fat binary that includes 32-bit and 64-bit executables 32-bit executable only Fat binary that includes 32-bit and 64-bit executables Fat binary that includes 32-bit and 64-bit executables Linux Component IntelliJ IDEA plug-in KDevelop plug-in SCCI integration libraries Seapine License Server Seapine License Server Admin Utility Seapine 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 9

14 Installers Component Surround SCM Client Surround SCM CMIS Admin Utility Surround SCM CMIS Server Surround SCM Proxy Server Surround SCM Registry Utility Surround SCM Server Surround SCM Web Server WebDAV CGI library WebStorm plug-in Installed as: 32-bit or 64-bit executable depending on selected installation option 32-bit executable only 32-bit executable only 32-bit executable only 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 executable only 32-bit executable on 32-bit systems 32-bit and 64-bit executables on 64-bit systems Installers The following Surround SCM installers are available. Note: All installers include 32-bit and 64-bit Surround SCM components. Operating system Installation type Name Windows Complete sscmwininstall.exe Client-only sscmwininstallclient.exe Mac Complete sscmmacosxinstall.dmg.gz Client-only sscmmacosxclientinstall.dmg.gz Linux Complete sscmlinuxjavainstall.tar.gz Client-only Command line sscmlinuxjavaclientinstall.tar.gz sscmlinuxinstall.tar.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. 10

15 Installation types Component Installs: Notes Surround SCM Client Surround SCM API Surround SCM Server Surround SCM Web Server Surround SCM Proxy Server Surround SCM CMIS Server Surround SCM WebDAV CGI Seapine 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 Surround SCMCMIS Server and CMIS Admin Utility WebDAV CGI, including sscmdav.cgi script and sscmdav.xml config file Web-based Seapine 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 29. 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 31. Allows Surround SCM integration with Content Management Interoperability Services (CMIS) clients. See Configuring the Surround SCM CMIS Server, page 33. When the WebDAV CGI is installed and configured, users can access source files using a web browser, a Windows network place, the Mac OS X Finder, a Linux filesystem path, and WebDAV-specific applications. You can work with files in applications that support WebDAV functionality such as Microsoft Office, Adobe Photoshop, or Adobe Dreamweaver. See Configuring web servers for WebDAV, page 36. A web server must be installed on the computer before installation. See Configuring web servers for the Seapine License Server Web Admin Utility, page

16 Installation types Component Installs: Notes Seapine License Server Admin Utility Seapine License Server Seapine License Server Admin Utility Seapine License Server application The Seapine License Server and admin utility are generally installed on a networked computer. The Seapine License Server and admin utility are generally installed on a networked computer. 12

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. Mac Double-click the installation file to extract the installer and then double-click sscmmacosxinstall.dmg to mount the image. Double-click the Surround SCM disk image on the desktop or in the Finder and then double-click Install Surround SCM. Linux graphical installer Untar and gunzip the installation file and then log in as root and double-click the installer file in the Window Manager. Linux command line installer Enter./install.pl to run the install script. 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 Surround SCM Web Server WebDAV CGI CMIS Server RDBMS Setting Surround SCM integration options Surround SCM can be integrated with third-party IDEs, build tools, and applications. These integrations allow users to access source files stored in Surround SCM from other applications without using a Surround SCM client. See Surround SCM 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 Seapine 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 Surround SCM Integrations knowledgebase for setup, usage, and troubleshooting information. 13

18 Setting Surround SCM configuration options 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 TestTrack items from the 64-bit Surround SCM Client, you must install TestTrack or later. You must select a Surround SCM application directory. Mac and 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)\seapine\surround SCM 64-bit applications (all files) C:\Program Files\Seapine\Surround SCM Mac Application /Applications/Surround SCM SCMStartup.log and SCMProxyStartup.log files Unix commands /var/log /usr/bin Linux Application /var/lib/surroundscm SCMStartup.log and SCMProxyStartup.log files Unix commands /var/log /usr/bin 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. 14

19 Setting Surround SCM Web Server configuration options 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 WebDAV CGI configuration options If you are installing the WebDAV CGI, you must set a location for the CGI scripts and a server IP address and port number. Operating system Default CGI directory Default port number Windows C:\InetPub\scripts 4900 Mac /Library/WebServer/CGI-Executables 4900 Linux /var/www/cgi-bin 4900 Setting Seapine License Server options You must select a Seapine License Server application directory. Mac and 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)\seapine\license Server 64-bit applications (all files) C:\Program Files\Seapine\License Server 15

20 Setting Seapine License Server options Operating system Files Default directory Mac Application /Applications/Seapine License Server LSStartup.log file Unix commands /var/log /usr/bin Linux Application /var/lib/splicsvr LSStartup.log file Unix commands /var/log /usr/bin Web server admin utility CGI and HTML file directories If you are installing the Seapine 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 Seapine License Server 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 Mac /Library/WebServer/CGI-Executables /Library/WebServer/Documents Linux /var/www/cgi-bin /var/www/html Server execution mode (Windows only) You can choose to run the Seapine 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 Seapine License Server application. Note: The Seapine License Server supports single sign-on, which allows LDAP users to automatically log in to Seapine products using the same credentials used to log in to their computer. See the Seapine License Server help for information. Server port The Seapine License Server communicates with Surround SCM clients on this port. Use the default port number (5100) or enter another number. 16

21 Setting Surround SCM CMIS Server configuration options Setting Surround SCM CMIS Server configuration options The Surround SCM CMIS Server is installed in the CMIS directory in the Surround SCM application directory by default. If you are only installing the CMIS Server, and installing it for the first time, you can specify the installation location and server port number during installation. Default directories Installer Files Default directory Windows All files C:\Program Files (x86)\seapine\surround SCM\CMIS Mac Application /Applications/Surround SCM/CMIS Unix commands /usr/bin Linux Application /var/lib/surround SCM/CMIS Unix commands /usr/bin Server port The Surround SCM CMIS Server communicates with CMIS clients on this port. Use the default port number (8080) or enter another number. 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 during the Surround SCM installation. 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. 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 Mac All files /usr/local/pgsql Linux All files /usr/local/pgsql 17

22 Setting RDBMS configuration options 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. 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

23 Starting Surround SCM The Seapine 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 Seapine License Server, page 21 and Starting the Surround SCM Server, page 27. 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 Seapine License Server is not running or is not found, you are prompted to log in using the local SCM admin password. This allows you to log in and verify the Seapine License Server settings. See Configuring a Seapine License Server connection, page 21. Surround SCM Client Windows Choose Programs > Seapine Software > 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\Seapine\Surround SCM to open the default installation directory on Windows. 2. Enter sscm followed by the command and options at the prompt. See the Surround SCM 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 29. 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. 19

24 Starting Surround SCM You are logged in and ready to start using Surround SCM. See the Surround SCM Web help for more information. 20

25 Configuring the Seapine License Server The Seapine License Server must be running and configured before users can access Surround SCM. 1. Make sure the Seapine License Server is running. 2. Start the Seapine License Server Admin Utility and configure a license server connection. Note: To use the Seapine License Server Web Admin Utility, you must install and configure the license server web components on a supported web server. See Configuring web servers for the Seapine License Server Web Admin Utility, page Add licenses and users to the license server. Starting the Seapine License Server The Seapine License Server must be running before the Surround SCM Server is started. 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 Programs > Seapine Software > Seapine License Server > Seapine License Server from the Start menu. Mac Click Seapine License Server in the System Preferences. If you want to set the server to start automatically, click the lock button and select Start Seapine License Server when this computer starts up. Linux Enter /usr/bin/spls start Starting the Seapine License Server Admin Utility Use Seapine License Server Admin Utility to manage global users and customers and assign licenses. Windows Choose Programs > Seapine Software > Seapine License Server > Seapine License Server Admin on the Start menu. Mac Double-click the Seapine License Server Admin Utility icon in the Applications/Seapine License Server folder. Linux Enter /usr/bin/lsadmin 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 Seapine License Server connection The Surround SCM Server connects to the Seapine License Server to authenticate license and user information. If you installed the Surround SCM Server and the Seapine 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. If the license server is installed on a different computer or port, or is not found, you can log in using the local SCM password to verify the connection information. 1. Start the Seapine License Server and the Seapine License Server Admin Utility. 21

26 Adding licenses to the Seapine License Server 2. Click Setup on the Seapine 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 Seapine 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 Surround SCM floating license. We strongly recommend setting a password for this user to prevent unauthorized user access. Adding licenses to the Seapine License Server Surround SCM licenses are required to access Surround SCM and are managed in the Seapine License Server. When you purchase a license, you need to add it to the license server before you can assign it to users. Note: If you need to purchase Surround SCM or other Seapine product licenses, contact Seapine Sales. 1. Start the Seapine License Server Admin Utility. 2. Click Licenses. The Seapine 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. 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 Seapine License Server, page 22. Adding users to the Seapine 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 by Surround SCM and TestTrack. Tip: You can also add users directly in Surround SCM. See the Surround SCM help for information. 1. Start the Seapine 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. 22

27 Configuring web servers for the Seapine License Server Web Admin Utility 4. Enter the user's contact information, username and password, security permissions, and licenses. See the Seapine License Server help for information. 5. Click Add to add the user to the Global Users list. 6. Close the Seapine 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 help configure security groups. See the Surround SCM help for information. Configuring web servers for the Seapine License Server Web Admin Utility Use the Seapine License Server Web Admin Utility to manage Seapine product licenses and global users and customers. The web admin utility can be accessed from any computer. It uses a set of HTML files and CGI scripts, which are hosted and configured on a web server. See Seapine License Server Supported Web Servers for a list of supported web servers. The Seapine License Server web components can be installed during Surround SCM installation. After installation, you need to configure the web server before administrators can use the web admin utility. Use the following information to configure Apache and Microsoft Internet Information Services (IIS) web servers. Apache IIS 7 and 8 IIS 6 Configuring Apache for the Seapine License Server Web Admin Utility You must create a CGI directory alias on the Apache web server before administrators can log in to the Seapine License Server Web Server Admin Utility. 1. Open the httpd.conf file. 2. Search the file for ScriptAlias/cgi-bin. If the directory does not exist, add the following to the file: ScriptAlias/cgi-bin/ C:\Program Files/Apache Group/cgi-bin/ Configuring Microsoft IIS 7 and 8 for the Seapine License Server Web Admin Utility After you install the Seapine License Server Web Admin Utility files, you need to configure the web server before administrators can log in to the admin utility. Refer to the IIS documentation for information about enabling CGI execution and authentication. 23

28 Configuring Microsoft IIS 7 and 8 for the Seapine License Server Web Admin Utility Enabling support for CGI executables Windows Vista, 7, and 8 1. 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. 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. 6. Select CGI. 7. Click OK. 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. Creating a CGI directory alias 1. Open IIS Manager. 2. In the Connections pane, expand the Web Sites node. 3. Right-click the default web site or the site used for the Seapine License Server Web Admin Utility and choose Add Virtual Directory. 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. 24

29 Configuring Microsoft IIS 6 for the Seapine License Server Web Admin Utility 6. Click OK. Enabling the.exe CGI extension 1. Click the scripts virtual directory in the Connections pane. 2. Double-click Handler Mappings. 3. Click Add Module Mapping in the Actions pane. 4. Enter 'lscgi.exe' as the Request path. 5. Select CgiModule as the Module. 6. Enter 'lscgi' as the Name. 7. Click OK. 8. Select the server computer in the Connections pane. 9. Double-click ISAPI and CGI Restrictions. 10. Click Add in the Actions pane. 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. Configuring Microsoft IIS 6 for the Seapine License Server Web Admin Utility After you install the Seapine License Server Web Admin Utility files, you need to configure the web server before administrators can log in to the admin utility. Refer to the IIS documentation for information about enabling CGI execution and authentication. Creating a CGI directory alias 1. Open IIS Manager. 2. Right-click the default web site or the site used for the Seapine License Server Web Server Admin Utility and choose New > Virtual Directory. 3. 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. Enabling the.exe CGI extension 1. In IIS Manager, expand Web Sites and click Web Service Extensions. 2. Click Add a new Web service extension in the Web Service Extensions pane. 3. Enter 'LSAdmin' as the Extension name. 25

30 Configuring Microsoft IIS 6 for the Seapine License Server Web Admin Utility 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. 26

31 Configuring New Surround SCM Installations Before users can access Surround SCM, the administrator needs to make sure the Surround SCM Server is running and perform some configuration tasks to set up Surround SCM. 1. Make sure the Surround SCM Server is running. 2. Start the Surround SCM Client and configure a server connection. Note: During installation, an administrative user with full admin security rights is created. To log in as this user, enter Administrator as the username and leave the password field empty. You can also delete this user and add a new admin user. If you do not want to delete this user, you should add a password to prevent unauthorized users from logging into the admin account. 3. After connecting to the server, use the Surround SCM Client to create a mainline branch, add files, configure server options, and set up security groups. Starting the Surround SCM Server The administrator must start the Surround SCM Server before users can access Surround SCM. Windows If the Surround SCM Server is installed as a service, it starts automatically. If the server is installed as an application, you must start it manually. Choose Programs > Seapine Software > Surround SCM > Surround SCM Server from the Start menu. Mac Click Surround SCM in the System Preferences. If you want to set the server to start automatically, click the lock button and select Start Surround SCM Server when this computer starts up. Linux Enter /usr/bin/surroundscm start Configuring a Surround SCM Server connection The administrator must configure a connection to the Surround SCM Server where files and Surround SCM data are stored. After the connection is added, log in as the administrative user to set up Surround SCM for users and perform other configuration tasks. Note: If you are a user and starting Surround SCM for the first time, you must add a server connection and log in using the connection information provided by your administrator. See the Surround SCM help for information about adding a server connection and logging in. 1. Make sure the Seapine License Server is running. 2. Start the Surround SCM Server. If the server does not start, see Troubleshooting, page Start the Surround SCM Client. 4. Click Setup on the Seapine Surround SCM Login dialog box and then click Add to configure a new server connection. 5. Enter a Server Name, Server Address, and Server Port. 27

32 Configuring a Surround SCM Server connection Enter a unique name, such as a product or department name, to help identify the server. Surround SCM clients connect to the server on the specified port via TCP/IP. Valid values are Click OK. 7. Log in as the administrative user and click Connect. The default username is Administrator and there is no password. By default, the Administrator user has full admin security rights and uses a Surround SCM floating license. We strongly recommend that you set a password for this user. Note: If you are prompted to create a mainline branch, refer to the Surround SCM help for information. 28