Vault Server 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.
- Upgrading Vault Professional
- Operating System-Specific Guidelines:
- What the Installer does:
- Pre-Installation Checklist:
- Welcome to the Vault Pro Server Installer
- Software License Agreement
- Read Me
- Setup Details
- IIS Process Model
- Ready to Install
- Troubleshooting Vault Pro Installation Issues
Upgrading Vault Professional
If you are upgrading an existing Vault Pro/Fortress server, first backup your Vault Pro/Fortress databases (
sgmaster) before beginning the installation. You can do the backup via SQL Server's backup tools, or from the Vault Pro/Fortress Admin Tool, on the Backup page. Then run the Vault Pro upgrade over your current installation. The Vault Professional installer will upgrade the Vault Pro/Fortress database in MS SQL Server.
If you're upgrading from Vault Standard to Vault Professional, you should backup — but not delete — those databases before installing Vault Professional.
Before installing the Vault Server, verify that your system meets the following requirements:
You will need a Windows Operating System.
The Vault Server requires at least the .NET Framework 4.0 and is supported in both the 32-bit and 64-bit versions of these Windows operating systems:
- Windows XP Professional (SP2)
- Windows Server 2003
- Windows Vista (Business and Ultimate)
- Windows Server 2008
- Windows Server 2008 R2
- Windows 7 (Professional and Ultimate)
- Windows 8 (Release Preview and Release)
In general you would install the 64-bit version of the Vault Server on a 64-bit OS. However if your OS is 64-bit but IIS is configured to run in 32-bit mode, install the 32-bit Vault Server. The 32-bit Vault server is required for VSS Handoff, which imports the latest version of a VSS databse.
The Vault Server Database requires a Microsoft SQL Server.
- QL Server 2005 (SP2) or SQL Server Express 2005 (SP2)
- SQL Server 2008 or SQL Server Express 2008
- SQL Server 2008 R2 or SQL Server Express 2008 R2
- SQL Server 2012
The Vault Server also requires a version of Microsoft IIS.
- IIS 5.1 or higher with .Net 4.0 Full Framework for Server and Development (not the Client Profile, which is for the desktop). http://www.microsoft.com/net/download
Your server computer should have at least:
- 2.4 GHz CPU or better
- 2-4 GB RAM depending on configuration
- 70 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, 2008 R2 and 2012 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 Pro 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 Professional installer will:
- create the VaultService directory on the local hard drive.
- create the sgvault, sgdragnet, sgnotify, sgvaultindex and sgmaster databases in SQL Server.
- if required, create a SQL Server login and database user for the new databases.
- create the Server's web.config file for IIS.
- give the Microsoft .Net Process account access to certain directories on the Vault Pro Server Machine.
- create the VaultService, VaultShadowFolder, VaultPro, VaultIndexService, VaultNotifyService and SgDav (Vault WebDAV) virtual directories in IIS, and their corresponding folders under the IIS web root.
Is Microsoft Sharepoint installed on the Vault Server machine?
Sharepoint and Vault Professional cannot successfully co-exist on the same server machine without special configuration.
You must be logged in as a domain or machine Administrator. Be sure SQL Server is running.
Know your Options
During the installation you will be asked to choose certain options:
You will choose to install Vault to the 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 Machine\ASPNET, Network Service or IIS APPPOOL\VaultAppPool account or you can create a custom account. In most cases you will select the machine account.
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, sgdragnet, sgnotify, sgvaultindex and sgmaster databases, the SQL Server login for the
NT Authority\Network Service account, and create a role for the user
NT Authority\Network Service within the new databases.
Using SQL Server Authentication:
If you choose to use SQL Server Authentication in the SQL Server Setup portion of the installation, then you will enter the name and password of the SA user (or equivalent account) and the installer will log into SQL Server with those credentials.
Note that you are not creating a SQL account in this screen. You are providing a username with SQL Server administrative privileges (the SA account, for example) so that the Vault installer can make the necessary changes to the database. The Server installation will create (or update) the sgvault, sgmaster, sgnotify, sgvaultindex and sgdragnet databases.
The Vault installer will also create a SQL login named 'sgvaultuser', and grant it access to the new databases. The SA account is used only during the installation process. After installation, Vault Pro server will use only the sgvaultuser account to access the databases.
IF SQL Server is on another machine:
The easiest way to install the Vault Pro 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 want 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 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."
Please read the notes concerning the version of Vault being installed.
Click Next to continue.
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, generally
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
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
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 as a user to the Vault databases, 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:
MachineName\ASPNETaccount (IIS 5.0) or
NT AUTHORITY\NETWORK SERVICEaccount (IIS 6.0) or
IIS APPPOOL\VAULTAPPPOOL (IIS 7/7.5).
The IIS ProcessModel account is created during the installation of the Microsoft .Net Framework.
- The System Account,
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. Note: The System account is rarely used.
- Custom Account
The Custom option allows you to specify a local or domain Windows user for the IIS Process User. 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 -
You must use an existing Windows account.
Ready to Install
The Vault Pro installation program will now update your system. The Vault Pro Server Configuration Status dialog shows the status of the configuration, step by step.
Updating System - Web Site
The first step is installing the Vault Pro virtual directory. By default, Vault Pro is installed to the IIS default website. However, the Vault Pro 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.
Create a password for the Admin user.
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 SQL Server is on the same machine as the Vault web service, 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.
If you select Windows Authentication, the account of the logged in Windows user who is running the Vault 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/sgmaster/sgdragnet/sgnotify/sgvaultindex databases.
Note that the SA account is only used once during installation to create the appropriate user 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', 'sgdragnet'. 'sgnotify', sgvaultindex' and 'sgmaster' databases. 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.
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.
If you are upgrading from Fortress or Vault Standard and/or Dragnet to Vault Pro, a similar prompt will appear. You should choose to keep and upgrade the existing databases.
The server installation is complete when the status message says "Completing the SourceGear Vault Pro Server Setup Wizard." If you wish to install the Vault Pro Client, check the "Install the Vault Pro 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 during the installation. 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, review Vault installation Help and search the SourceGear Support Forum at support.sourcegear.com.
If you are unable to resolve the problem, contact Technical Support, email@example.com. Please provide copies of any error messages, plus the following information, as relevant.
- Vault Pro installation log
If you had an unsuccessful installation, we would like to see the Vault Pro installation log. It is named vaultpro_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.
- Web.config file
Web.config is located in the
inetpub\wwwroot\VaultServicedirectory (or under the location you chose during a custom installation). This file is helpful in troubleshooting installation and database access issues.
- Vault Pro Server log
If you are experiencing problems with Vault Pro operations, the log file will help us determine the problem. In the Vault Pro Server Admin Web Client under Server Settings, set the Log Level to Debug, perform the actions which are failing, then send a copy of the
sgvault.logfile to Technical Support. The default location of the
sgvault.logfile is in the
Be sure the set the logging back to Quiet mode, as debug logging can take a lot of disk space.