Seapine Labs
Personal tools

Proxy Server

From Seapine Labs

Jump to: navigation, search

The Surround SCM Proxy Server, which was introduced in version 2008, is a file caching proxy that improves performance of file retrievals at remote locations. 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.


[edit] About the proxy server

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.

Keep the following in mind:

  • The proxy server must be installed at the local site and then added to Surround SCM before users can connect to it.
  • Each Surround SCM Server can support multiple proxy servers. Each proxy server can only use one master Surround SCM Server.
  • Performance improvements are noticeable only after files are cached. The first time files are retrieved, they are returned by the Surround SCM Server.
  • You can specify the default users for each proxy server. If the proxy server is not available, Surround SCM clients retrieve files directly from the master server.

[edit] Recommended installation and configuration steps

To ensure security of the master Surround SCM Server data, you must configure it 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 the Surround SCM Server and proxy servers. You must set the configuration options on both computers.

We strongly recommend adding a proxy server to the master Surround SCM Server before installing the proxy server. However, if the proxy server is already installed and you add a proxy server to Surround SCM, you can use the registry utility to configure the proxy server settings.

[edit] Setting up a proxy server

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 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.

[edit] 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.

[edit] Configuring the proxy server

After you configure a proxy server definition on the master Surround SCM Server, you can run the Surround SCM 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 in the 'Surround application directory' specified during the installation (e.g., Windows - C:\Progam Files\Seapine\Surround SCM or
Mac OS X/Linux - \var\lib\Seapine\Surround SCM).

The Surround SCM Registry Utility is located in the application directory (e.g., Windows - Surround SCM Registry Utility.exe or Mac OS X/Linux - scmregistryutil). Run the registry utility and use it to set the proxy server options.

[edit] 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.

[edit] 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. The proxy server will automatically connect to the configured master Surround SCM Server.

If you are running the proxy server as an application, double-click the proxy server icon in the Surround SCM application directory. The proxy server will connect to the configured master Surround SCM Server.

[edit] Linux/Solaris

Enter surroundscmproxy start. The proxy server will connect to the configured master Surround SCM Server.

[edit] Mac OS X

Start the proxy server from System Preferences. The proxy server will connect to the configured master Surround SCM Server.

[edit] Troubleshooting help

If the proxy server does not start, check the SCMProxyStartup.log file for error messages. By default the startup log is located in the Surround SCM application directory on Windows or \var\log on Linux and Mac OS X.

Following are some common reasons why the proxy server may not start:

  • The proxy server does not have read/write permissions for the proxy cache directory and its files.
  • The master Surround SCM Server rejects the connection because the Proxy Name and Password are incorrect.

Issue Management Software | Source Code Control Software | Test Case Management | Requirements Management Software