Web Deployment Tool Installation
Applies To: Windows 7, Windows Server 2003, Windows Server 2003 R2, Windows Server 2008, Windows Server 2008 R2, Windows Vista, Windows XP
This topic explains the Web Deployment Tool download locations, installation options, installation steps, and how to customize the Web Deployment Agent Service URL.
Download options and locations
You can install Web Deploy by using the Web Platform Installer, by running the Web Deploy Windows® Installer, or from the command line by using Msiexec.exe. The Web Platform Installer requires fewer steps, while the other methods allow you to customize your installation. In all cases, you should perform the installation only if you are logged on as an administrator.
Using the Web Platform Installer
The Web Platform Installer automatically detects the bitness of your operating system, installs the latest version of the Web Deployment Tool, and installs any missing dependencies that Web Deploy requires. To use the Web Platform Installer, visit this link at www.microsoft.com/web and follow the installation steps.
Using the Web Deploy Installer or Msiexec.exe
If you do not want to use the Web Platform Installer, you can install Web Deploy by using the Web Deploy installer user interface (UI), or by running the Windows Installer in a command-line window.
For both methods, you must download the Web Deploy Windows Installer (.msi) file that corresponds to your operating system platform from one of the following locations.
Web Deployment Tool Download Locations
| Platform | Location |
|---|---|
x86 (32–bit) |
|
x64 (64–bit) |
Installing from the user interface
The following table describes the installation options that are available for Web Deploy 2.1 on Windows Server 2008.
Web Deploy Installation Options
| Install option | Description |
|---|---|
Web Deployment Framework |
The managed code framework that includes public APIs and the underlying deployment tool engine. This is the top-level node and cannot be removed. |
IIS Manager UI Module |
Adds features to IIS Manager for packaging or deploying Web sites or applications. This option requires IIS 7 or the IIS Remote Manager to be installed. |
IIS 7 Deployment Handler |
Integrates with the Web Management service (WMSVC) and enables non-administrators or administrators to perform remote operations. Requires that IIS 7 and WMSVC be installed. For information about how to configure the handler, see Configuring the Web Deployment Handler. |
Configure for Non-Administrator Deployments |
Enables you to allow non-administrator IIS Manager users to deploy files and databases to the site or sites for which they have permissions. |
Management Service Delegation UI |
Adds a user interface to IIS Manager that lets you control how remote users can deploy applications, content, and databases to the Web server. |
Remote Agent Service |
An administrator-only service based on HTTP and HTTPS that enables server administrators to connect and perform remote operations. In the Services UI, this service is listed as Web Deployment Agent Service (MsDepSvc). |
Note
On Windows Server 2003 and client versions of Windows (such as Windows 7), only the Web Deployment Framework and Remote Agent Service installation options are available. In Web Deploy 1.1, the Configure for Non-Administrator Deployments installation option is not available.
Deciding whether to install the Web Deployment Agent Service
Before you install, decide whether you want to use the Web Deployment Agent Service (also called the "remote service") to perform live operations between two servers, or if you prefer the offline mode. The Web Deployment Agent service is started by default and is set to Automatic startup. The service is only required during an operation and it can be stopped when not in use.
Offline mode is simply installation of the tool without the remote service. It requires you to create a local copy of a site or server, then manually copy the "snapshot" package to the destination.
If the source of your operations will be a remote server, you only need to install the remote service on the remote server. In this case, you will use Msdeploy.exe from the local destination computer to request data from the remote source computer. The remote service is not required on both machines in such a scenario. For maximum flexibility in synchronization operations, you can install the remote agent service on both the source and destination computers, and verify that the service is started on both computers.
Important
If you install Web Deploy by using the Windows UI, the Web Deploy remote service will listen on https://+:80/MsDeployAgentService/. On Windows XP, you will have to change either the default port for the agent service, or change the port for the default Web site. On later versions of Windows, the Web Deploy remote service will not conflict with IIS on port 80, and IIS and the Web Deploy remote service can run at the same time. Web Deploy and IIS both use the HTTP.SYS URL registrations to make reservations in the URL namespace. To install Web Deploy with a different remote service URL, see the Installing from the command line section in this topic.
How to perform a complete install
The following steps show you how to perform a complete install of all Web Deployment Tool features. The default remote service URL will be used.
To use the UI
Visit the x86 or x64 link in the Download Locations table earlier in this topic, and then click Download.
In the File Download dialog box, click Run.
In the Security Warning dialog box, click Run.
On the Welcome to the Web Deployment Tool Setup Wizard page, click Next.
On the End-User License Agreement page, select the I accept the terms in the license agreement box, and then click Next.
On the Choose Setup Type page, click Complete.
Note
If you choose Typical, only the Web Deployment Framework and the IIS Manager UI Module will be installed. If you choose Custom, you will be able to choose from among the options listed in the Web Deploy Installation Options table earlier in this topic.
Click Install.
Click Finish.
Important
The deployment tool will be installed to the %programfiles%\IIS\Microsoft Web Deploy V2 directory. This install location cannot be changed. Setup does not add this folder to the system Path environment variable. It is assumed that you have used the command prompt to move to this folder or that you have added a reference to this folder to the Path environment variable before you run Web Deploy commands.
Installing from the command line
To install Web Deploy from the command line, open an elevated command Prompt window. Click Start, point to All Programs, click Accessories, right-click Command Prompt, and then click Run as administrator. Replace <msi_x86_filename> or <msi_x64_filename> with the name of the Windows Installer file that you downloaded, and type the command that corresponds to your version of Windows.
| Platform | Command |
|---|---|
x86 |
msiexec /i <msi_x86_filename> |
x64 |
msiexec /i <msi_x64_filename> |
By default, the remote service will be URL https://+:80/MsDeployAgentService. This default URL should only be used on test computers, not on production servers.
To specify a custom remote service URL, replace <msi_filename>, port and URL in the following command line example with those of your own:
msiexec /I <msi_filename> /passive ADDLOCAL=ALL LISTENURL=https://+:8080/MsDeployAgentService2/
Manually start the service by running the following command at an administrative command prompt.
net start msdepsvc
Finally, ensure that the port that you have chosen is open in the firewall.
Important
The deployment tool will be installed to the %programfiles%\IIS\Microsoft Web Deploy V2 directory. This install location cannot be changed. Setup does not add this folder to the system Path environment variable. It is assumed that you have used the command prompt to move to this folder or that you have added a reference to this folder to the Path environment variable before you run Web Deploy commands.
Prerequisites for the dbFullSQL provider
The dbFullSql provider enables first-time publishing of databases from a local SQL Server database to another SQL Server database and requires SQL Server Management Objects (SMO), Microsoft Core XML Services (MSXML) 6.0, and the Microsoft SQL Server 2008 Native Client (SQL Native Client). If you will be using the dbFullSQL provider, be sure to install these prerequisites. For more information and install links, see Web Deploy dbFullSql Provider.
Important
If you install the Web Deployment Tool by using the Web Platform Installer, these prerequisites will be installed for you.
Post installation steps
By default, the remote service (MsDepSvc) will listen on https://+:80/MsDeployAgentService/, or at the URL that you specified if you performed a custom installation. If you want to use a different URL after installation, reinstall Web Deploy. Reinstallation is relatively quick (typically less than 30 seconds), and your system configuration will not be affected as long as your other installation choices do not change.
For information about configuring the Web Management Service, see Configuring the Web Deployment Handler.
Installing Version 1.1 of Web Deploy
If you want to install version 1.1 of the Web Deployment Tool, download the Web Deploy Windows Installer (.msi) file that corresponds to your operating system platform from one of the following locations.
| Platform | Location |
|---|---|
x86 (32–bit) |
|
x64 (64–bit) |
Version 1.1 of the deployment tool will be installed in the %programfiles%\IIS\Microsoft Web Deploy directory.
By default, the Web Deployment Agent Service (MsDepSvc) startup type is set to Manual in version 1.1. To manually start the Web Deployment Agent Service, run the following command at an administrative command prompt:
net start msdepsvc
To set the startup type to Automatic, you can use the Services interface under Computer Management. You can also set the startup type to Automatic by typing sc config msdepsvc start=auto at a command prompt. For more information about Sc.exe, see How to create a Windows service by using Sc.exe.