Install the SOS Collab Servers Only (use existing MS SQL or MSDE)-- Custom Installation

Install the SOS Collab Servers -- Custom Installation

Install the SOS Collab Servers
Re-install/Upgrade the SOS Collab Servers

This is a 16MB package that will install only the SOS Collab Servers and will use your existing database engine. Please verify that your MS SQL Server or MSDE is running before you begin the SOS Collab Servers installation process.

The SOS Collab Server installer will download as a self-extracting archive or run from CD. Installation should take about 5 minutes.

Install the SOS Collab Servers

Run the SOS Collab Servers Setup executable. The following dialogs will be presented:

License Agreement

To continue with the SOS Collab installation program you must accept the license agreement for SourceOffSite Collaborative Edition. Read the agreement and click Yes to proceed.

Microsoft Visual SourceSafe License Reminder

If you are using SOS Collab to access a SourceSafe database, you must be a legally licensed user of Microsoft Visual SourceSafe. A Microsoft Visual SourceSafe License Reminder dialog will be presented. Click Yes if you are either a legally licensed SourceSafe user or if you will not be using SOS Collab to access a SourceSafe database.

Choose Destination Location

By default, the SOS Collab Servers will be installed in C:\Program Files\SourceOffSite Collab Servers. To choose a different folder, click Browse. Select the desired folder and click OK.

Setup type

Typical
For first time installations, we recommend the Typical Installation, which installs the default configuration. These default settings can be changed later with the SOS Server Manager.

Custom
Advanced SOS Collab users may wish to use the Custom Installation to configure the SOS Collab system during installation.

Instructions for Custom Setup on a machine with an existing MSDE or MS SQL Server:

Select Components

The Setup program will install Data Components (Database Schema), the Primary Server and the Web Server. It is recommended that all components be installed on the same machine. Verify that all components are checked, then click Next.

Select Program Folder

The Setup program will add program icons to the SourceOffSite Collaborative Edition folder. You can choose the default SourceOffSite Collaborative Edition folder, type a new folder name, or select an existing folder. After selecting, click Next.

Compatible Data Engine Found

If this screen appears, Setup has detected the MS SQL Server or MSDE installation on your machine. Enter the password for the existing MSDE or MS SQL Server Administrator account. Check with your MSDE or MS SQL Server database Administrator if you do not know the password.

SourceOffSite Collab Servers Administrator Information

Password -- Create a password that will be used by the SOS Collab System Admin.
Admin E-mail -- Enter the email account of the person who will be the SOS Collab System Admin. The System Admin can choose to receive system notifications just like any other user.

Primary Server Service Setting

If the VSS database is on the same machine as the SOS Collab Primary Server, select the log on as the Local System account.

Select Use a Domain User Account if the VSS database is on another machine on same LAN as the SOS Collab Primary Server. The SOS Collab installer will authenticate the user account on the domain.

Primary Server Port Configuration

Configure the ports through which the Servers will communicate with the Clients. SOS Collab operates using a TCP/IP-based networking protocol. This protocol can be operated on any ports the user specifies, from 0 to 65536. If a network firewall or proxy server is used, the firewall or proxy server may need to be configured to allow communication on the specified ports.

The Servers may be configured to listen on secure and/or unsecure ports. The secure ports listen for connections with SSL; the unsecure ports listen for connections in the clear.

The command port is used for requests and responses between the Primary Server and the Windows Client. The Broadcast port is used to send unsolicited messages from the Primary Server to one or more Windows Clients.

Enable Unsecure Connection

Default Command port - 16436

Default Broadcast port - 16437

Enable Secure Connection

Default Command port - 16434

Default Broadcast port - 16435

Primary Server SMTP Configuration

SMTP Server
The SOS Collab system sends email notifications to users about bug events and discussion messages. Enter the name of the SMTP Server that will be used by SOS Collab.

From Address
Enter the address that will appear on the email notifications from the SOS Collab system. An email address must be configured here with the proper format, i.e. name@company.com. However, this does not have to be an actual working email address.

Primary Server Log Files

Configure the path to the Server log directory. The default is:

C:\Program Files\SourceOffSite Collab Servers\Logs

The SOS Collab Primary Server logs connection and error information that could prove useful in resolving any problems with the SOS Collab software.

Log file path -- The path to the directory where the SOS Collab Primary Server logs will be kept.
Logging Level -- Amount of information logged in SOS Collab Primary Server log

Quiet -- Logs system error messages only
Chatty -- Logs error messages, connection information, notification emails, and VSS commands that are invoked
Debug/Support -- Logs errors, connections, and all system operations

(Please Note: Because of logging volume, the Debug/Support setting is recommended only when troubleshooting technical issues.)
Overwrite log file on server startup -- By default, the log file will continuously log information. To shorten the log file, there is an option to overwrite the file upon Primary Server startup.

SSL Configuration

Configure the Secure Sockets Layer Destination Folders.

The default directory for Certificate Files is:

C:\Program Files\SourceOffSite Collab Servers\SSL\Certs

The default directory for the Certificate Cache is:

C:\Program Files\SourceOffSite Collab Servers\SSL\Cache

SOS Collab acts as a Certificate Authority to issue certificates to SOS Collab Clients for secure connections. Certificates are exchanged between clients and servers during an SSL handshake. Verifying the server's certificate gives the client a level of trust about the server's identity. SOS Collab stores the certificate information in a database and caches client certificates.

Choose Attachment Location

By default, SOS Collab stores attachments in C:\Program Files\SourceOffSite Collab Servers\Data\Attach. To choose a different folder, click Browse.

(Please Note: This directory can increase in size with regular use; therefore, choose a location with a large amount of disk space.)

Primary Server Miscellaneous Settings

Temporary Directory -- The default is C:\Program Files\SourceOffSite Collab Servers\Temp. SOS Collab stores temporary Source Code Control (VSS) files in this directory.
Enable Visual SourceSafe Caching -- VSS Caching can enhance performance under certain condition. For more information see Server Manager->Performance Cache.
Enable Pin Support -- This setting enables pin support in SOS Collab Source Code Control. For more information on Pin Support see SOS Collab Server Manager>Pin Support. In order for SOS Collab Clients to be able to pin/unpin files, the Enable Pin Support option must be selected in the Source Code Control tab of the Server Manager.

Web Server Port and Script Settings

Enable HTTP/HTTPS

Default HTTP Port is 80

Default HTTPS port is 443

At least one of these ports must be enabled to allow the Web Client and web-enabled functions of the Windows Client to connect to the SOS Collab Web Server.

(Please Note: If the machine is running IIS on port 80, select a different port for SOS Collab Web Server.)

Web Server Settings

For enhanced security, you can use SSL to connect to the Primary Server. This setting, however, will reduce system performance and may not be necessary if both the Primary and Web server operate in a secure area of the LAN.

Script Directory

The default is:
C:\Program Files\SourceOffSite Collab Servers\Data\Scripts.

Scripts used by the SOS Collab Web Server are stored in this directory.

Web Advanced Server Configuration

Advanced Settings

These settings determine how the Web Server will handle idle connections and expire authentication cookies.

Connection Check -- Default is 300 seconds (5 minutes).

Connection Timeout -- Default is 3600 seconds (1 hour).

Cookies Expiration -- Default is 86400 seconds (24 hours).

Enable Reverse DNS Lookup

The default is unselected. SOS Collab can resolve an IP address into a fully qualified domain name. This is useful Web Server access logging purposes, however, it will reduce SOS Collab performance.

Web Server Log Files

Web Server Logging

The SOS Collab Web Server logs connection and error information that could prove useful in resolving any problems with the SOS Collab software.

Log File

Configure the path to the Server log directory. The default is: C:\Program Files\SourceOffSite Collab Servers\Logs

Logging Level -- Amount of information logged in SOS Collab Web Server log.
Quiet -- Logs system error messages only.
Chatty -- Logs system error messages and connection information.
Debug/Support -- Logs errors, connections, and all system operations.

(Please Note: Because of logging volume, the Debug/Support setting is recommended only when troubleshooting technical issues.)

Overwrite log file on startup -- Default is unselected.

Enable Web Access Logging

If enabled, SOS Collab logs connections to the Web Server. Default is checked.

Access Log File

Default directory is: C:\Program Files\SourceOffSite Collab Servers\Logs

Review Install Information

The Review Install screen shows the information you have provided during the Server Setup along with the SOS Collab system default settings.

You can change information you have added during the Server Setup by selecting the Back button. System default settings can be changed after installation by using the SOS Collab Server Manger.

Setup Status

Setup installs certain components and creates SSL certificates.

Install Schema

Important!

If you wish to keep your existing SOS Collab data and database schema, select NO

If you wish to delete all your data and reinstall the database schema, select YES

When SOS Collab installs the database schema, it will overwrite any existing SOS Collab database information.

First time installations: Since no data exists the first time you install SOS Collab, select Yes.

Installation Complete

Once the Server installation is complete, click Finish.

Verify Files Are in Selected Folder

After the installation is completed, assuming that default installation location was accepted, the SOS Collab Servers should be found in: C:\Program Files\SourceGear\SourceOffSite Collab Servers.

The notable files installed in that folder are:

sosce_server.exe -- Primary Server program
sosce_web.exe -- Web Server program
sosce_config.xml -- Server configuration file
sosce_svrmgr.exe -- Server Manager (GUI tool) for configuring and managing the Servers
sosce_svcmgr.exe - Service Manager for the Server Services and Administration

(Please note: The SOS Collab Servers directory does not contain any project data. All information is stored in the SQL database, which is in your SQL installation folder.)

If you wish to change any of the installed settings, use the SOS Collab Server Manager.

Reinstall the SOS Collab Servers

If the Setup program detects an existing SOS Collab installation this dialog will be presented:

Select Upgrade/Repair if you wish to upgrade or reinstall the SOS Collab Servers.

If you wish to uninstall SOS Collab, select Remove.