Configure ArcGIS Web Adaptor

After you install ArcGIS Web Adaptor, you must configure it to work with a server site and your ArcGIS Enterprise portal. You'll do this from the configuration web page or from the command line utility that was installed with the Web Adaptor.

When you open the configuration page, the current status of ArcGIS Web Adaptor is displayed. This indicates whether ArcGIS Web Adaptor has been previously configured. To view the platform type and version number of the Web Adaptor, click About on the configuration page.

Note:

As of ArcGIS Enterprise 11.5, administrative access to the ArcGIS Server site through the Web Adaptor is enabled by default and cannot be disabled. For Internet-facing ArcGIS Enterprise deployments, consider using a production-grade web application firewall (WAF)-enabled load balancer as a front end instead of the Web Adaptor. For more information, see the ArcGIS Enterprise Hardening Guide.

If you've already configured a Web Adaptor with your ArcGIS Enterprise portal and want to update your portal to use a different Web Adaptor, you must first unregister the current Web Adaptor. You can only do this through the Portal Directory; the unregister functionality is not available from the configuration page or the portal website. For full instructions, see Unregister ArcGIS Web Adaptor with Portal for ArcGIS.

Caution:

Although you can modify a portal's Web Adaptor by registering a new one, doing so may also impact user content in the portal (for example, map notes or other items).

Note:

The use of the default HTTPS port 443 is appropriate for the 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.

Configure ArcGIS Web Adaptor with a server site

The following sections describe how to configure ArcGIS Web Adaptor with a server site from the configuration page and the command line utility.

Configure from the configuration web page

To configure ArcGIS Web Adaptor with a server site from the configuration web page that was installed with the software, follow the steps below.

Note:

There are additional considerations for ArcGIS Mission Server, ArcGIS Notebook Server, and ArcGIS Video Server that should be reviewed at this point.

Open the configuration page in a web browser.

The URL is in the format https://webadaptorhost.example.com/webadaptorname/webadaptor.

Note:

If the web server where you installed ArcGIS Web Adaptor is configured to use a forward proxy, disable it while registering the Web Adaptor. Otherwise, you will be unable to access the Web Adaptor configuration page.
Select the type of server you want to configure with the Web Adaptor. Click Next.
Enter the machine name for one of the servers you are registering in your site.

This machine name will be used to discover all of the machines participating in your server site and register them with the Web Adaptor. The machine name should be in the form server.example.com.
Provide a username and password for an account that has administrative privileges to the server site. Typically, you'll use the primary site administrator account username and password you defined when you created the site. If you disabled the primary site administrator account, you'll need to specify an account with administrative access to the site.
Click Configure to apply your settings to the Web Adaptor.

When the configuration is successful, machines recognized by the Web Adaptor are listed at the bottom of the configuration page (highlighted in green). You can return to this page at any time to see the list of recognized machines and adjust the Web Adaptor settings.

Configure from the command line

You can configure ArcGIS Web Adaptor with a server site using the command line utility (ConfigureWebAdaptor.exe) in C:\Program Files\Common Files\ArcGIS\WebAdaptor\IIS\<current version>\Tools.

The available parameters are as follows:

ConfigureWebAdaptor.exe /m <Mode> /w <WebAdaptorURL> /g <MachineName|URL> /u <Username> /p <Password>

You can configure ArcGIS Web Adaptor with a server site using the command line utility (ConfigureWebAdaptor.bat) in <ArcGIS Web Adaptor (Java Platform) installation directory>\WebAdaptor\<current version>\java\tools.

The available parameters are as follows:

ConfigureWebAdaptor.bat -m <Mode> -w <WebAdaptorURL> -g <MachineName|URL> -u <Username> -p <Password>

You can configure ArcGIS Web Adaptor with a server site using the command line utility (configurewebadaptor.sh) in <ArcGIS Web Adaptor installation directory>/webadaptor/<current version>/java/tools. This is particularly advantageous if the machine hosting the Web Adaptor does not have a graphical user interface (GUI).

The available parameters are as follows:

configurewebadaptor.sh -m <Mode> -w <WebAdaptorURL> -g <MachineName|URL> -u <Username> -p <Password>

<Mode>—The component with which the Web Adaptor will be configured. By default, this parameter is set to server, meaning that the Web Adaptor can be configured for use with server site. Below are the parameters you can use to configure other components.
- Portal for ArcGIS—portal
- ArcGIS Mission Server—mission
- Notebook Server—notebook
- Video Server—video
- ArcGIS Monitor—monitor
- ArcGIS Data Pipelines—datapipelines
<WebAdaptorURL>—The URL of the Web Adaptor that you want to configure from the command line. This is the same URL that would be used if you were accessing the Web Adaptor configuration page in a web browser. If the Web Adaptor was installed on a port other than the default of 80, specify the port in the URL.
<MachineName|URL>—The machine name for one of the machines in your server site, for example server.example.com. You can also use the server machine URL instead of the machine name. If you are configuring the Web Adaptor with ArcGIS Server, the machine name or URL will be used to discover all of the machines participating in your site.
<Username>—The username of an account that has administrative privileges to the server site. For ArcGIS Server, this account may be the Primary Site Administrator account entered when the site was first created or an account that has been assigned administrative privileges. For ArcGIS Mission Server, Notebook Server, and Video Server, enter the username for the Primary Site Administrator account used when the site was created.
<Password>—The password of the account that has administrative privileges to the server site.

See the following example: ConfigureWebAdaptor.exe /m server /w https://webadaptorhost.example.com/webadaptorname/webadaptor /g server.example.com /u siteadmin /p secret

See the following example: ConfigureWebAdaptor.bat -m server -w https://webadaptorhost.example.com/webadaptorname/webadaptor -g server.example.com -u siteadmin -p secret

See the following example: $ ./configurewebadaptor.sh -m server -w https://webadaptorhost.example.com/webadaptorname/webadaptor -g server.example.com -u siteadmin -p secret

Note:

To run the command line utility, the Java Runtime Environment (JRE) must be present on the machine hosting the Web Adaptor. If the JRE is not present on your machine, an error occurs when running the utility. See the Java SE Downloads site for instructions on how to download and install the JRE on your machine.

Configure ArcGIS Web Adaptor with a portal

The following sections describe how to configure ArcGIS Web Adaptor with your ArcGIS Enterprise portal from the configuration page and the command line utility.

Configure from the configuration web page

To configure ArcGIS Web Adaptor with your portal from the configuration web page that was installed with the software, complete the following steps:

Caution:

To add a DNS alias or reverse proxy after an ArcGIS Server site has been federated with your portal, see Update the organization URL.

If you haven't done so already, enable HTTPS on your web server.
Open the configuration page in a web browser using an HTTPS URL such as https://webadaptorhost.example.com/webadaptorname/webadaptor. If a DNS alias will be used with the portal, the Web Adaptor should be configured over the DNS alias instead, using a URL such as https://<dnsalias.example.com>/<webadaptorname>/webadaptor.

Note:

If you have a forward proxy running on the web server where you've installed ArcGIS Web Adaptor, disable it while registering the Web Adaptor. Otherwise, you will be unable to access the Web Adaptor configuration page.
Choose Portal for ArcGIS and click Next.
Enter the name of the machine hosting Portal for ArcGIS. Include the fully qualified domain name, for example, portal.example.com.
Supply a username and password for an account that has administrative privileges to Portal for ArcGIS. Typically, you'll use the initial administrator account username and password you defined when you set up your portal. If you demoted or deleted the initial administrator account, you must specify an account with administrative access to the portal website.
Click Configure.

ArcGIS Web Adaptor is configured for use with the machine hosting Portal for ArcGIS. Now, you'll access your portal through the ArcGIS Web Adaptor URL instead of port 7443. The URL is in the following format: https://webadaptorhost.example.com/webadaptorname/home.

If you configured your portal to use HTTPS for all communication, you should update the installed portal website and help shortcut URLs to use https instead of http; otherwise, you'll see failures in your browser when attempting to access the original shortcut URLs.

If you'll be configuring Portal for ArcGIS with your organization's reverse proxy server, you must provide some information to your portal about the proxy server. For full instructions, see Integrate your portal with a reverse proxy or load balancer.

Configure from the command line

You can configure ArcGIS Web Adaptor with your portal using the command line utility (ConfigureWebAdaptor.exe) in C:\Program Files\Common Files\ArcGIS\WebAdaptor\IIS\<current version>\Tools.

The available parameters are as follows:

ConfigureWebAdaptor.exe /m <Mode> /w <WebAdaptorURL> /g <MachineName|URL> /u <Username> /p <Password> -r <ReindexPortal>

You can configure ArcGIS Web Adaptor with your portal using the command line utility (ConfigureWebAdaptor.bat) in <ArcGIS Web Adaptor (Java Platform) installation directory>\WebAdaptor\<current version>\java\tools.

The available parameters are as follows:

ConfigureWebAdaptor.bat -m <Mode> -w <WebAdaptorURL> -g <MachineName|URL> -u <Username> -p <Password> -r <ReindexPortal>

You can configure ArcGIS Web Adaptor with your portal using the command line utility (configurewebadaptor.sh) in <ArcGIS Web Adaptor installation directory>/webadaptor/<current version>/java/tools. This is particularly advantageous if the machine hosting the Web Adaptor does not have a graphical user interface (GUI).

The available parameters are as follows:

configurewebadaptor.sh -m <Mode> -w <WebAdaptorURL> -g <MachineName|URL> -u <Username> -p <Password> -r <ReindexPortal>

<Mode>—The component with which the Web Adaptor will be configured. By default, this parameter is set to server, meaning that the Web Adaptor will be configured for use with the GIS Server, Image Server, or GeoAnalytics Server. Since you're configuring the Web Adaptor for use with Portal for ArcGIS, specify this parameter as portal.
<WebAdaptorURL>—The URL of the Web Adaptor that you want to configure from the command line. This is the same URL that would be used if you were accessing the Web Adaptor configuration page in a web browser. You're required to specify the HTTPS URL of the Web Adaptor, for example, https://webadaptorhost.example.com/webadaptorname/webadaptor. If a DNS Alias will be used with the portal, the Web Adaptor should be configured over the DNS Alias instead, using a URL such as https://<dnsalias.example.com>/<webadaptorname>/webadaptor.
<MachineName|URL>—The machine name for one of the machines hosting Portal for ArcGIS. Include the fully qualified domain name of the machine, for example, portal.example.com. You can also use the URL of the machine hosting Portal for ArcGIS in place of the machine name.
<Username>—The username of an account that has administrative privileges to Portal for ArcGIS. This account may be the initial administrator account entered when you first set up your portal, or an account that has been assigned administrative privileges.
<Password>—The password of the account that has administrative privileges to Portal for ArcGIS.
<ReindexPortal>—Indicates whether to reindex the default content in the portal when registering the Web Adaptor. This option is useful if you intend to configure your deployment with a reverse proxy or load balancer. Web Adaptor registration takes less time without indexing. Once the webContextURL is configured, the built-in content will reference the webContextURL.

Example: ConfigureWebAdaptor.exe /m portal /w https://webadaptorhost.example.com/webadaptorname/webadaptor /g portal.example.com /u initialadmin /p secret -r true

Example: ConfigureWebAdaptor.bat -m portal -w https://webadaptorhost.example.com/webadaptorname/webadaptor -g portal.example.com -u initialadmin -p secret -r true

Example: ConfigureWebAdaptor.sh -m portal -w https://webadaptorhost.example.com/webadaptorname/webadaptor -g portal.example.com -u initialadmin -p secret -r true

After running the command, ArcGIS Web Adaptor is configured for use with the machine hosting Portal for ArcGIS. Now, you'll access your portal through ArcGIS Web Adaptor URL instead of port 7443. The URL is in the following format: https://webadaptorhost.example.com/webadaptorname/home.

If you'll be configuring Portal for ArcGIS with your organization's proxy server, you must provide some information to your portal about the proxy server. For full instructions, see Integrate your portal with a reverse proxy or load balancer.

Configure multiple ArcGIS Web Adaptors

Multiple ArcGIS Web Adaptors are required when configuring a highly available portal that uses web-tier authentication. To configure multiple Web Adaptors with Portal for ArcGIS, a single endpoint must be used to access the portal. This URL must be defined in the WebContextURL property. Multiple Web Adaptors can then be configured with the portal following the steps below.

Configure the first ArcGIS Web Adaptor with your portal.
Add Portal for ArcGIS to your reverse proxy server. Set the WebContextURL property as follows:
1. Open a web browser and sign in to the Portal Administrator Directory as an Administrator of your organization.
  
  The URL is formatted https://portal.example.com:7443/arcgis/portaladmin.
2. Click System > Properties > Update Properties.
  
  The Portal for ArcGIS service restarts automatically. Wait for the restart to complete before continuing.
3. On the Update System Properties dialog box, insert the following JSON, substituting your reverse proxy server or DNS alias URL as seen by users outside your organization's firewall:
```
{
   "WebContextURL": "https://reverseproxy.example.com/myorg"
}
```
4. Click Update Properties.
Configure additional Web Adaptors.

All Web Adaptors configured with the portal are listed on the configuration summary page. Users access the portal through the reverse proxy server or DNS alias URL.

Note:

Portal for ArcGIS only supports a single organization URL.

After configuring ArcGIS Web Adaptor

Now that ArcGIS Web Adaptor has been configured for use, consider the items below.

Adding or removing server machines

If you add or remove server machines from your site, it takes the Web Adaptor 1 minute to recognize the changes to your site. If you want the Web Adaptor to immediately recognize the added or removed machines, you can reconfigure it by following the instructions above.

Installing multiple Web Adaptors

You can provide different web entry points into your server site by installing multiple Web Adaptors. Doing so makes your site more highly available to clients, provides support for legacy applications, and allows publishing by specific users in a highly secure environment. For more information, see Deployment scenarios.

Multiple Web Adaptors can be installed on the same machine at the same time, or they can be installed on separate machines. To install multiple Web Adaptors on the same website (port), use different names for them. 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).