Search:     Advanced search

Setting Up the Surround SCM Proxy Server

Article ID: 649  |  Last updated: 30 Sep, 2015

The Surround SCM Proxy Server is a file caching proxy that improves performance of file retrievals at remote client sites. As such, the proxy server is usually installed on a separate computer from the master server at the remote location where the clients using the proxy reside. This is not a requirement.

For security reasons, you must configure a master server to accept connections from known proxy servers before attempting to use the proxy server. The installation and configuration of the proxy server requires information about both computers, and you must set the configuration options on both server computers.

The proxy server is a client of the master Surround SCM Server and a server to Surround SCM client applications. This means it listens for transactions from Surround clients (GUI clients and the CLI), and it connects to the Surround SCM master server to get files that meet client requests. The proxy server needs the same connection information that the Surround clients use to connect to the master server. The master server also needs connection information to provide to the clients that use the proxy.

You need the following information to set up a proxy server.

  • Proxy name: This is the descriptive name for the proxy server. A master server can be configured to accept connections from multiple proxy servers.
  • Proxy connection password: This is the password required to authenticate the proxy server with the master server.
  • Proxy server address: This is the hostname/URL/IP address of the proxy server that clients use to access the proxy. Because the proxy is a client to the master and does not receive connections from the master server, this address does not need to be resolvable by the Surround SCM master server. This address could be a local IP or hostname found only on the subnet hosting the proxy server and the remote clients using the proxy.
  • Proxy server port: This is the port the proxy server uses to handle proxy requests from the Surround clients. Because the proxy is a client to the master, this port does not need to be open on the firewall to the master server. It only needs to be open on the firewall of the proxy computer (between the proxy and the Surround clients using the proxy). If the proxy server and master server are installed on the same computer, the proxy server port cannot be the same as the port used by the master server.
  • Master server address: This is the hostname/URL/IP address of the master server. This is the same address used to connect to the master server by all clients.
  • Master server port: This is the port the master server is listening on, which is configured when the master server is installed.

Configuring the master server

Before a proxy server is allowed to connect to a master server, you must configure the master server to accept proxy requests. In the Surround SCM client, choose Tools > Administration > Proxy Maintenance. Enter the following in the Proxy Maintenance dialog.

  • Proxy name 
  • Proxy connection password 
  • Proxy server address 
  • Port connection that the clients use to connect to the proxy

The configuration information regarding limits on proxy server disk usage or how long files are cached on the proxy is optional. You can set the options when configuring the master server or modify them later.

Configuring the proxy server

After you configure a proxy server definition on the master Surround SCM Server, you can run the Surround installer to install just the Proxy server on the proxy computer. During the installation enter the required name, password, and connection information when prompted.

If the proxy server is already installed and you configured a proxy server definition, you can use the Surround SCM Registry Utility to configure the proxy server. The proxy server is installed into the Surround application directory specified during the installation (e.g., Windows -- C:\Program Files\Seapine\Surround SCM or Linux -- var/lib/Seapine/Surround SCM). The Surround SCM Registry Utility is located in the application directory. Run the registry utility and use it to set the proxy server options.

Starting the proxy server

The method for starting the proxy server depends on the platform, and whether you installed it as a service or as an application.

  • Windows: If you installed the proxy server as a service, open the Control Panel and double-click Administrative Tools. Double-click Services. Select the Surround SCM Proxy Server from the Services list and start the service. If you are running the proxy server as an application, double-click the proxy server icon in the Surround SCM application directory.
  • Linux: Enter surroundscmproxy start.

The proxy server will automatically connect to the configured master Surround SCM Server.

Article ID: 649  |   Last updated: 30 Sep, 2015
proxy server

Prev   Next
Understanding Helix ALM and Surround SCM Passwords     No Files to Rebase in Surround SCM