Vault: Installation

Before you install Vault, review this Installation Guide to learn how the Vault installer works and what is needed for a successful installation.

Because the Vault Server installation relies on IIS and MS SQL, the options you choose during installation must be compatible with your specific IIS and MS SQL configurations. In addition, certain system requirements must be in place before you install Vault. The installation guide will help you determine the right options for your system.

  1. Upgrading Vault
  2. Overview
  3. Operating System-Specific Guidelines:
  4. What the Installer does:
  5. Pre-Installation Checklist:
  6. Welcome to the Vault Server Installer
  7. Software License Agreement
  8. Read Me
  9. Setup Details
  10. IIS Process Model
  11. Ready to Install
  12. Troubleshooting Vault Installation Issues

Upgrading Vault

If you are upgrading an existing Vault server, first backup your Vault databases (sgvault and sgmaster) before beginning the installation. You can do the backup via SQL Server's backup tools, or from the Vault Admin Tool, on the Backup page. Then run the Vault upgrade over your current installation. The Vault installer will upgrade the Vault database in MS SQL Server.

Overview

Before installing the Vault Server, verify that your system meets the following requirements:

The Vault server is supported on both the 32-bit and 64-bit versions of these Windows operating systems:

  • Windows XP Professional
  • Windows Server 2003
  • Windows Vista (Business or Ultimate)
  • Windows Server 2008

You will also need Microsoft SQL Server.

  • MSDE 2000 (SP3a)
  • SQL Server 2000 (SP3a)
  • SQL Server 2005 or SQL Server Express 2005 (SP2)
  • SQL Server 2008 or SQL Server Express 2008

You also need Microsoft's Internet Information Server (IIS)

  • IIS 5.0 or higher with .NET Framework 3.5

Your server computer should have at least:

  • 2.4 GHz CPU or better
  • 2 GB RAM
  • 20 MB available hard disk space

Operating System-Specific Guidelines:

Windows XP: IIS must be installed before the .NET Framework to ensure the proper IIS mappings exist for ASP.NET file extensions. If there is a problem with the mappings, they can be repaired. See support.microsoft.com.

Windows  2003 Server, Windows 2008 Server: Verify that IIS is installed and that ASP.NET is allowed: support.sourcegear.com/viewtopic.php?t=185

Verify that Static Content is enabled in IIS: http://support.sourcegear.com/viewtopic.php?t=10069

Windows Vista:  Vault supports Vista Business and Vista Ultimate.

Once these requirements are satisfied, you may proceed with the installation.

What the Installer does:

During the installation, the Vault installer will:

  • create the VaultService directory on the local hard drive.
  • create the sgvault and sgmaster databases in SQL Server.
  • if required, create a SQL Server login and database user for the sgvault database.
  • create the Server's web.config file for IIS.
  • give the Microsoft .Net Process account access to certain directories on the Vault Server Machine.
  • create the VaultService, VaultShadowFolder and sgdav (Vault WebDAV) virtual directories in IIS, and their corresponding folders under the IIS web root.

Pre-Installation Checklist:

Is Microsoft Sharepoint installed on the Vault Server machine?

Sharepoint and Vault cannot successfully co-exist on the same server machine without special configuration.

Privileges

You must be logged in as a domain or machine Administrator. Be sure SQL Server or MSDE is running.

Know your Options

During the installation you will be asked to choose certain options:

You will choose to install Vault to the default IIS Default website or to a secondary website configured on the machine you are installing to.

You will decide which user/login will have access to the Vault virtual directory. Your choices are the ASPNET or Network Service account (Win2003) (default), the machine account, or you can create a custom account. In most cases you will pick the account that the .Net Process model is using.

To determine which account the .Net Process model is using:

  • In IIS 5.0, examine %windir%\Microsoft.NET\Framework\v.YYY\Config\machine.config. Search for the "processModel" element.
  • In IIS 6.0 or 7.0, open up the Internet Information Administrator. Examine the properties for the "application pool". Look for the account used to run the process model

Database Authentication

You will decide whether to use Windows Authentication or SQL Server authentication for access to the Vault database by the Vault process. Be sure your SQL Server is set up to accept the type of authentication you choose.

The options you select in the IIS Process model and SQL Server Setup screens determine what user has access to the Vault database. Examples:

Using Windows Authentication:

This describes using the NT Authority\Network Service account, but applies to any of the IIS Process model choices.

If you select Windows Authentication during the SQL Server Setup portion of the installation, the installer will use your credentials to log into SQL Server. The installer will create the sgvault database, the SQL Server login for the NT Authority\Network Service account, and create the user NT Authority\Network Service within the sgvault database.

Using SQL Server Authentication:

If you choose to use SQL Server Authentication in the SQL Server Setup portion of the installation, then the installer will use the user/password you supply in the SQL Server Setup page to log into SQL Server. That username you supply must have SQL Server administrative privileges (the SA account, for example). The Server installation will then create the sgvault database, plus create a SQL login named 'sgvaultuser', and grant it access to the sgvault database.

IF SQL Server/MSDE is on another machine:

The easiest way to install the Vault Server when SQL Server is located on a different machine is to use SQL Server authentication.

However, If your SQL Server is on a different machine, and you would like to use Windows Authentication, then the account you choose for the IIS Process Model should not be the ASP.Net account, as that only exists on the local machine. In this case, choose the DOMAIN\MACHINE account, or a custom account. The custom account needs to be a Windows account which has access to both the SQL Server and the IIS Server, usually a DOMAIN\USER account.

Welcome to the Vault Server Installer

Double click the Vault Install icon to launch the Vault Server Installation Wizard.

Click Next to continue.

Software License Agreement

Please read the license agreement. Select "I accept this agreement."

Read Me

Please read the notes concerning the version of Vault being installed.

Click Next to continue.

Setup Details

This screen gives you the option of choosing a Typical or Custom setup. The "Custom" option allows you to choose the Vault installation directory; Typical chooses the install location automatically.

Choose Typical unless you have a specific need to install Vault in a non-standard location.

If you choose "Custom", the next screen will include a Browse button which allows you to choose a Web root folder other than the standard c:\inetpub\wwwroot

When you are satisfied with your choices, click Next to continue.

IIS Process Model

This setting determines the Windows Account that will receive permissions to the Vault Service physical directory, selected in the previous step. By default this is C:\Inetpub\wwwroot\VaultService. You must choose the account under which IIS runs ASP.NET processes on your server machine.

If you want Vault to connect to SQL Server through Windows Authentication, the account selected for the IIS process model will be granted access to the database. For instance, if you select the NT Authority\Network Service login, NT Authority\Network Service will be granted a login to SQL Server and the NT Authority\Network Service user will be added to the sgvault database, with the roles of public and db_owner.

If you want to connect to SQL Server through SQL Server Authentication, the Vault Server installation will create an 'sgvaultuser' SQL Server login account, which will be used by Vault to connect to the database. See the SQL Server Setup section for details.

There are three choices for the IIS Process model:

  1. The MachineName\ASPNET account (IIS 5.0) or NT AUTHORITY\NETWORK SERVICE account (IIS 6.0/7.0)

    The IIS ProcessModel account is created during the installation of the Microsoft .Net Framework. Before using this account, verify that you have an ASPNET account on the server machine. (Windows 2003 uses NT AUTHORITY\NETWORK SERVICE).

  2. The System Account, Domain\Machinename$

    Use the System account when Microsoft .Net is set up to run as SYSTEM in the process model, rather than the ASP.Net Machine account.

  3. Custom Account

    Use a custom account when SQL Server is located on a different machine than the Vault Server, and you want to use Windows Authentication to connect to SQL Server. You should use an account which is accessible by both machines - specifically a domain account - DOMAIN\USER.

    You must use an existing Windows account.

Ready to Install

The Vault installation program will now update your system. The Vault Server Configuration Status dialog shows the status of the configuration, step by step.

Updating System - Web Site

The first step is installing the Vault virtual directory. By default, Vault is installed to the IIS default website. However, the Vault installation program will detect whether you have more than one website configured, and if you want the virtual directory installed to a different site, make your selection from the entries in the combo box.

Vault Administration

Create a password for the Admin user.

If using SQL Server authentication, this password will also be used for the SQL Server login, 'sgvaultuser'. This value is encrypted in the Vault Server's web.config file.

Be sure to remember this password. If you decide to move the Vault server or database, life is much easier if you use the same password for the Vault Admin when you reinstall.

Vault can accept a blank password, but this is not recommended for security concerns.

Click OK to continue.

SQL Server Setup

Specify the location of the SQL Server which will store the Vault database, and the authentication method the Vault Server should use to connect to the database. Vault can create a database on SQL Server if it has been set up on the local machine, or you can use a SQL Server on a different machine on the network. Please verify SQL Server is running before you complete this step.

The Vault Server can connect to SQL Server via Windows Authentication or SQL Server Authentication. If you choose SQL Server Authentication, please verify SQL Server is set up to allow SQL Server Authentication

When installing Vault Server with SQL Server Express, use .\sqlexpress instead of (local) or use machinename\sqlexpress, since SQL Express is installed as an instance.

Note for MSDE users: By default, MSDE uses Windows Authentication only.

If you select Windows Authentication, the account running the Fortress installer must be a full SQL administrator.  The installer will not prompt for alternative Windows Authentication credentials.

Vault installer will grant database access to the user specified in the IIS Process Model screen.

If you choose SQL Server authentication, then you should use the sa account or another account that can modify the database to create logins and users to establish the connection between the Vault Service and the sgvault database.

Note that the SA account is only used once during installation to create the appropriate users and logins for the Vault database.

If you chose SQL Server authentication, the Vault Installation creates a SQL Server login named 'sgvaultuser', and grants this account access to the 'sgvault' database. Sgvaultuser will have db roles of public and db_owner. Vault is set up so that only sgvaultuser can access the Vault database.

Click Next to continue.

Database Collation

Choose Collation for Database (on a new database only). Collation is how the database sorts text strings in the database based on the language used. The Vault installer chooses a collation that is appropriate based on the language settings of the machine. If you wish to choose a different collation than the default, click Collations and select the one you want.

Updating System Status - if reinstalling and database exists

The Vault installation program will check to see if a Vault database exists.

If you re-install Vault and there already is a database, you will be asked to use the existing database or drop the database and create a new one. If you choose to drop the database, a confirmation box will appear.

Installation Complete

The server installation is complete when the status message says "Completing the SourceGear Vault Server Setup Wizard." If you wish to install the Vault Client, check the "Install the Vault Client" checkbox before pressing OK. The client installer will begin.

Vault's Admin web site will launch.

Enter the username and password you chose in the Vault Administration dialog. Vault is now installed and ready for you to add license keys.

Troubleshooting Vault Installation Issues

If you are unable to connect to the Vault Server after installation, it is typically due to a permissions problem.

Verify that you used the correct account for the IIS Process Model screen. Verify that this account has the appropriate access.

Verify that Anonymous Access is enabled for the VaultService virtual directory.

Review Vault installation Help and the Vault Forum at support.sourcegear.com.

If you are unable to resolve the problem, contact Technical Support, support@sourcegear.com. Please provide copies of any error messages, plus the following information, as relevant.

  1. Vault installation log

    If you had an unsuccessful installation, we would like to see the Vault installation log. It is named vault_install.log and should be found in your temp folder as defined by the USER's TEMP Environment variable. If you type %temp%, in a browser address bar, it will open your temp folder.

  2. Web.config file

    Web.config is located in the inetpub\wwwroot\VaultService directory (or under the location you chose during a custom installation). This file is helpful in troubleshooting installation and database access issues.

  3. Vault log

    If you are experiencing problems with Vault operations, the log file will help us determine the problem. In the Vault Server Admin Tool under Server Settings, set the Log Level to Debug, perform the actions which are failing, then send a copy of the sgvault.log file to Technical Support. The default location of the sgvault.log file is in the %WINDIR%\Temp\sgvault folder.

    Be sure the set the logging back to Quiet mode, as debug logging can take a lot of disk space.