Install ArcGIS Web Adaptor

ArcGIS Web Adaptor can be installed using the provided setup program that can be run through a utility named Setup.exe or installed silently using Windows Installer command line parameters.

ArcGIS Web Adaptor can be installed using the provided setup program that can be run through a utility named Setup.sh or installed silently using command line parameters.

Installation requirements

The version of ArcGIS Web Adaptor must match the version of your server site or portal.
ArcGIS Web Adaptor can be installed side by side with other versions. You are not required to uninstall ArcGIS Web Adaptor unless you are upgrading to a newer version.
Each ArcGIS Web Adaptor must have its own unique name; you cannot have two Web Adaptors with the same name on a single web server. If a naming conflict is detected during the installation, a warning message appears. You must uninstall the earlier version with the same name to resolve the conflict. Alternatively, you can change the name of one of the Web Adaptors to proceed with the installation.
ArcGIS Web Adaptor and Tomcat do not need to be installed on the same machine if you will configure the Web Adaptor with a server site or portal through your browser. However, if you will configure the Web Adaptor using the configurewebadaptor.exe tool, the Web Adaptor and Tomcat must be installed on the same machine.

Note:

Ensure that you start Tomcat, or any application server where an ArcGIS Web Adaptor instance is to be deployed, with administrative permissions. If it is not, the operation to register the ArcGIS Web Adaptor with ArcGIS Server will fail.

ArcGIS Web Adaptor and Tomcat do not need to be installed on the same machine if you will configure the Web Adaptor with a server site or portal through your browser. However, if you will configure the Web Adaptor using the configurewebadaptor.sh tool, the Web Adaptor and Tomcat must be installed on the same machine.

Note:

Ensure that you start Tomcat, or any application server where an ArcGIS Web Adaptor instance is to be deployed, with administrative permissions. If it is not, the operation to register the ArcGIS Web Adaptor with ArcGIS Server will fail.
When deploying ArcGIS Web Adaptor on an application server, the Web Adaptor configuration is written to the user’s home directory. Ensure that the user is assigned a home directory and has read and write access to it before proceeding.

Before installing ArcGIS Web Adaptor

Before you install ArcGIS Web Adaptor, do the following:

Verify that your system meets all system requirements. You can only configure one Web Adaptor with a server site or portal.
Enable IIS and the required components.

Caution:

To successfully install and configure ArcGIS Web Adaptor, you must enable IIS and the required components before installing the prerequisites specified in the next step.
Ensure that the following prerequisites are installed on the machine where ArcGIS Web Adaptor will be installed:
- Microsoft Web Deploy 4.0
- ASP.NET Core Runtime - Windows Hosting Bundle 10.x
Note:

You must install the ASP.NET Core Runtime - Windows Hosting Bundle, which includes the .NET Runtime and IIS support.

Caution:

If you installed the ASP.NET Core Runtime - Windows Hosting Bundle before enabling IIS and the required components, you must repair the bundle installation using the bundle installer.
Sign in to the machine on which you're installing ArcGIS Web Adaptor.

Note:

You must sign in as a user with administrative privileges.
Verify that you have a website running on port 80 and HTTPS is enabled on port 443. This is to accommodate the variety of encrypted and unencrypted calls made to ArcGIS Enterprise. For instructions on how to create a website, consult the IIS product documentation. For more information about setting up and using HTTPS, see Enable HTTPS on your web server.

Note:

The use of the default HTTPS port 443 is appropriate for the vast majority of users. In some rare cases, an ArcGIS Web Adaptor instance cannot use port 443 on its web server for organization-specific reasons. If this applies to your organization, see Use nondefault ports for the portal's ArcGIS Web Adaptor, which details additional steps to configure a workaround.
Close all applications.
Browse to the downloaded folder containing the ArcGIS Web Adaptor setup. You can also insert the ArcGIS Server or the Portal for ArcGIS media into the appropriate drive to automatically start the setup.

You are now ready to proceed with the ArcGIS Web Adaptor installation.

Caution:

Attempting to configure ArcGIS Web Adaptor so the URL includes additional levels is not supported and may cause problems with client applications.

Verify that your system meets all system requirements. You can only configure one Web Adaptor with a server site or portal.
Sign in to the machine on which you're installing ArcGIS Web Adaptor.

Note:

You must sign in as a user with administrative privileges.
Verify that you have a website running on port 80 and HTTPS is enabled on port 443. This is to accommodate the variety of encrypted and unencrypted calls made to ArcGIS Enterprise. For instructions on how to create a website, consult the product documentation specific for your Java application server.. For more information about setting up and using HTTPS, see Enable HTTPS on your web server.

Note:

The use of the default HTTPS port 443 is appropriate for the vast majority of users. In some rare cases, an ArcGIS Web Adaptor instance cannot use port 443 on its web server for organization-specific reasons. If this applies to your organization, see Use nondefault ports for the portal's ArcGIS Web Adaptor, which details additional steps to configure a workaround.
Close all applications.
Browse to the downloaded folder containing the ArcGIS Web Adaptor setup. You can also insert the ArcGIS Server or the Portal for ArcGIS media into the appropriate drive to automatically start the setup.

You are now ready to proceed with the ArcGIS Web Adaptor installation.

Verify that your system meets all system requirements. You can only configure one Web Adaptor with a server site or portal.
Sign in to the machine on which you're installing ArcGIS Web Adaptor.

Note:

You must sign in as a user with administrative privileges.
Verify that you have a website running on port 80 and HTTPS is enabled on port 443. This is to accommodate the variety of encrypted and unencrypted calls made to ArcGIS Enterprise. For instructions on how to create a website, consult the product documentation specific for your Java application server.. For more information about setting up and using HTTPS, see Enable HTTPS on your web server.

Note:

The use of the default HTTPS port 443 is appropriate for the vast majority of users. In some rare cases, an ArcGIS Web Adaptor instance cannot use port 443 on its web server for organization-specific reasons. If this applies to your organization, see Use nondefault ports for the portal's ArcGIS Web Adaptor, which details additional steps to configure a workaround.
Browse to the downloaded folder containing the ArcGIS Web Adaptor setup. You can also insert the ArcGIS Server or the Portal for ArcGIS media into the appropriate drive to automatically start the setup.

You are now ready to proceed with the ArcGIS Web Adaptor installation.

Install ArcGIS Web Adaptor using the setup program

To install ArcGIS Web Adaptor using the setup program, complete the following steps:

The ArcGIS Web Adaptor setup program should start automatically after the download is complete. If the setup does not start automatically, browse to the location of the downloaded setup files, and double-click Setup.exe.
Review the master agreement and accept it if you agree. Click Next to continue with the installation.
Choose a website running on port 80 for ArcGIS Web Adaptor. Available websites are listed as <website name (port)>. If you don't see the Select website dialog box, this means you only have one website. If only one website is found on your machine, ArcGIS Web Adaptor is automatically placed on that website without displaying the Select website dialog box.
Provide a name for the Web Adaptor. The default value is arcgis. This instance name cannot contain spaces.

Note:

A message appears if a virtual directory with the same name as the Web Adaptor already exists on the selected website. Click OK to close the message, and provide a different name for the Web Adaptor.
To complete the installation, follow the directions on the screen.

Note:

Each Web Adaptor installation creates an application pool with the default naming convention of ArcGISWebAdaptorAppPool<web adaptor name>.

Start the ArcGIS Web Adaptor installation program Setup.exe, and read the welcome screen and terms of use. Click Next when you're ready to proceed.
Review the master agreement and accept it if you agree. Click Next to continue with the installation.
Click Change to specify the installation folder or Next to accept the default location.
Click Install to begin the installation.
Click Finish to close the wizard.
Browse to the ArcGIS Web Adaptor installation folder. Deploy the arcgis.war file to your Java application server on a website running on port 80. For instructions on how to deploy a .war file, refer to the documentation for your Java application server.
Optionally, to deploy multiple Web Adaptors on the host machine, redeploy the arcgis.war file as necessary. Keep in mind that if you're deploying multiple Web Adaptors on the same website (port), they must have different names. For example, two Web Adaptors named arcgis cannot exist on the same website. If you want multiple Web Adaptors with the same name, you must install them on separate websites (ports).
Connect ArcGIS Web Adaptor with a server site or portal.

After installation, ArcGIS Web Adaptor will display in the language specified by your Java application server. To change the language, consult the product documentation for your Java application server.

Start the ArcGIS Web Adaptor installation program and evaluate the Introduction dialog box. Click Next when you're ready to proceed.
Review the master agreement and accept it if you agree. Click Next to continue with the installation.
Click Next to accept the default location, or click Choose to specify the installation folder.

Note:

It is recommended that you do not install ArcGIS Web Adaptor to a remote network drive. If the remote drive is not accessible at uninstallation time, the uninstallation could fail and leave files behind.
Click Install to begin the installation.
When completed, click Done to close the wizard.
Browse to the ArcGIS Web Adaptor installation folder. Deploy the arcgis.war file to your Java application server on a website running on port 80. For instructions on how to deploy a .war file, refer to the documentation for your Java application server.
Optionally, to deploy multiple Web Adaptors on the host machine, redeploy the arcgis.war file as necessary. Keep in mind that if you're deploying multiple Web Adaptors on the same website (port), they must have different names. For example, two Web Adaptors named arcgis cannot exist on the same website. If you want multiple Web Adaptors with the same name, you must install them on separate websites (ports).
Connect ArcGIS Web Adaptor with a server site or portal.

Repeat the same steps to install multiple ArcGIS Web Adaptor instances on the same machine at the same time or on separate machines.To install multiple Web Adaptors on the same website (port), they must have different names. For example, two Web Adaptors named arcgis cannot exist on the same website. If you want multiple Web Adaptors with the same name, you must install them on separate websites (ports).

Note:

The setup detects and prevents any conflicts with the Web Adaptor name. If you see a message indicating that the virtual directory already exists, specify a different name for the Web Adaptor or select a different website.

Note:

To apply a Web Adaptor service pack, the base instance cannot be removed.

Install ArcGIS Web Adaptor silently

The following command lines are parameters to be used when installing ArcGIS Web Adaptor silently. If these command line parameters are not invoked during a silent installation, the ArcGIS Web Adaptor web application is created under the default website with the default name of arcgis.

ACCEPTEULA=yes

This property is required to accept the End User License Agreement during a silent installation. Specify yes to agree to the EULA and install the software. Specifying no or omitting this property will result in a failed installation. The download contains a PDF version of the End User License Agreement (EULA). The EULA.pdf file is located in the \Documentation folder.
WEBSITE_ID=<numeric value of website>

The WEBSITE_ID parameter is used to specify the website where the ArcGIS Web Adaptor web application will be created. The value for WEBSITE_ID is a number specific to each website on your server and assigned by IIS. The IDs for the websites on your server can be found in IIS Manager. The default website has a website ID of 1. By default, the WEBSITE_ID parameter is set to the default website (even if multiple websites exist). The parameter WEBSITE_ID is case sensitive.
PORT=<port number>

Additionally, if you have a website with multiple ports, use the PORT parameter to install to the specified port of the WEBSITE_ID.

For example, the path is <path to ArcGIS Web Adaptor (IIS) setup download>\setup.exe /qb VDIRNAME=arcgis_external WEBSITE_ID=4059640 PORT=82.
VDIRNAME=<name of ArcGIS Web Adaptor>

This command line parameter is optional. By default, the VDIRNAME property is set to arcgis. If you do not invoke the VDIRNAME parameter in your command line, the Web Adaptor is created as arcgis. The VDIRNAME parameter is case sensitive. The Web Adaptor name cannot contain spaces.

For example, the path is <path to ArcGIS Web Adaptor (IIS) setup download>\setup.exe /qb ACCEPTEULA=yes VDIRNAME=arcgis_external WEBSITE_ID=4059640.
CONFIGUREIIS=TRUE

This optional parameter will allow the setup program to silently configure and install all missing Microsoft IIS components required by ArcGIS Web Adaptor.

The following are the Windows Installer command line parameters to be used when installing ArcGIS Web Adaptor silently:

ACCEPTEULA=yes

This property is required to accept the End User License Agreement during a silent installation. Specify yes to agree to the EULA and install the software. Specifying no or omitting this property will result in a failed installation. The download contains a PDF version of the End User License Agreement (EULA). The EULA.pdf file is located in the \Documentation folder.
INSTALLDIR=<installation location>

This property allows you to specify the installation location of ArcGIS Web Adaptor from the command line. If you do not set this property, the default installation location of C:\Program Files\ArcGIS\WebAdaptor12.0\java\ is used.

For example:

<path to ArcGIS Web Adaptor (Java Platform) setup download>\setup.exe ACCEPTEULA=yes INSTALLDIR="C:\NewInstallDir" /qb
Use the following command to install ArcGIS Web Adaptor silently without specifying the installation location:

<path to ArcGIS Web Adaptor (Java Platform) setup download>\setup.exe ACCEPTEULA=yes /qb

After ArcGIS Web Adaptor is installed, you can configure it with a server site or portal.

Note:

To install ArcGIS Web Adaptor silently, complete the following steps:

Before beginning the installation, read the master agreement located at <CD_ROOT or untar directory>/Documentation/EULA.pdf, and if you agree, accept the terms.

Run the setup silently at the prompt. Sample syntax:

<CD_ROOT or untar directory>/Setup -m silent -l yes

Usage: Setup [Options]

Option	Description
-m; --mode MODE	Optional. Defaults to GUI. MODE is either silent or gui.
-l; --license-agreement CHOICE	Required for silent mode. CHOICE is either Yes or No. Yes indicates that you have read and agreed to the Esri Master Agreement (E204, E300). See https://www.esri.com/legal/licensing-translations to read the agreement.
-d; --directory DIRECTORY	Optional. By default, ArcGIS Web Adaptor is installed to your $HOME directory. DIRECTORY specifies a different installation directory. The path /arcgis/webadaptor12.0/ is appended to the installation directory. The name of the installation directory should be lowercase. The samples and data installed require the data path to be lowercase. It is recommended that you do not install ArcGIS Web Adaptor to a remote network drive. If the remote drive is not accessible at uninstallation time, the uninstallation could fail and leave files behind.
-v; --verbose	Installer runs in verbose mode.
-h; --help	Displays command line help and exits.
-e; --examples	Displays usage examples of these options and exits.

Browse to the ArcGIS Web Adaptor installation folder and deploy the appropriate .war file to your Java application server on a website running on port 80. If you're using Apache Tomcat 10.1.x, you must deploy the arcgis_tomcat10.war file. For Tomcat 9.0.x and all other Java application servers, you must deploy the arcgis.war file. For instructions on how to deploy a .war file, refer to the documentation for your Java application server.
Optionally, to deploy multiple Web Adaptors on the host machine, redeploy the .war file as necessary. If you're deploying multiple Web Adaptors on the same website (port), they must use different names; for example, two Web Adaptors named arcgis cannot exist on the same website. If you want multiple Web Adaptors with the same name, you must install them on separate websites (ports).
After ArcGIS Web Adaptor is installed, you can configure it with a server site or portal.

You can install multiple Web Adaptors by running the setup using command line parameters. No additional command line parameters are necessary to install multiple Web Adaptors.