This topic explains the Web Deployment Tool download locations, installation options, installation steps, and how to customize the Web Deployment Agent Service URL.
You can install Web Deploy by using the user interface (UI), or by running the Windows Installer in a command-line window. In all cases, you should perform the installation only if you are logged on as an administrator.
Installing from the user interface
The following table describes the 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.
|
|
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).
|
Choosing installation options
Before you install, decide whether you want to use the remote service to perform live operations between two servers, or if you prefer the offline mode. The remote service is not started by default and is set to Manual startup. It 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" or archive 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.
.gif) Important |
| If you install Web Deploy by using the Windows UI, the Web Deploy remote service will listen on http://+: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 previous table, 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.
-
Click Install.
-
Click Finish.
-
To verify that the Web Deployment Agent Service is started, click Start, Control Panel, Administrative Tools, and then Services. Find Web Deployment Agent Service. If it is not started, right-click it and select Start.
|
Important |
| The deployment tool will be installed to the %programfiles%\IIS\Microsoft Web Deploy 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 http://+: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=http://+: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 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. |
Post installation steps
If you installed the Web Management Service (WMSvc), you can start the service by running the following command at an administrative command prompt.
net start wmsvc
For information about configuring the Web Management Service, see Configuring the Web Deployment Handler.
By default, the remote service (MsDepSvc) will listen on http://+: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.
By default, the Web Deployment Agent Service (MsDepSvc) and the Web Management Service (WMSvc) startup types are set to Manual. You can set the startup type to Automatic by using the Services interface under Computer Management. You can also use the command-line tool, Sc.exe, to 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.