ArcGIS Notebook Server is an ArcGIS Server role, licensed and configured for the purpose of hosting ArcGIS Notebooks. The server role uses Docker containers to host and run notebooks and provides an isolated and secure environment for the notebooks without interfering with operations of the host operating system.
Learn more about Docker and its role in ArcGIS Notebook Server
The system and hardware requirements to run ArcGIS Notebook Server are listed below.
Hardware requirements
An ArcGIS Notebook Server node requires, at minimum, 16 GB of RAM.
For a production environment, hardware requirements are not listed because the user and business needs of the software may vary. These requirements must be considered in determining hardware needs to meet performance and scalability expectations.
ArcGIS Notebook Server requires a minimum of 50 GB of available disk space.
Firewall settings
ArcGIS Notebook Server communicates on port 11443. You must open this port on your firewall before installing the software.
To communicate with the ArcGIS Enterprise portal with which it's federated, ArcGIS Notebook Server needs access to port 7443 on the portal machine.
Note:
This component is only one part of an ArcGIS Enterprise deployment. See ArcGIS Enterprise system requirements for a diagram and links to information about the ports needed to communicate with other components in an Enterprise portal.
Operating system requirements
The following 64-bit operating systems satisfy the operating system requirements. Support is not provided for 32-bit operating systems; the setup will only proceed if the operating system is 64 bit.
| Supported operating systems | Latest update or service pack tested |
|---|---|
Windows Server 2022 Standard and Datacenter | |
Windows Server 2019 Standard and Datacenter | February 2021 update |
Note:
If you are upgrading ArcGIS Notebook Server on a machine currently running Windows Server 2016, you must also upgrade your operating system to Windows Server 2019 or Windows Server 2022. See Upgrade ArcGIS Notebook Server for steps.
Windows 10 Pro and Windows 10 Enterprise are supported for basic testing of single-machine sites and application development use only. Windows 10 is not recommended for deployment in a production environment and does not support multiple-machine sites.
Machines with an underscore (_) in the name are not supported. The setup will not proceed if an underscore is detected in the machine name.
The operating system of your ArcGIS Notebook Server machines can be different from those of the other machines in your ArcGIS Enterprise deployment. The most common scenario for this is to deploy ArcGIS Notebook Server on Linux machines while the rest of the ArcGIS Enterprise deployment is on Microsoft Windows machines.
Several internet host name specifications have designated the underscore character as nonstandard. Although Microsoft Windows allows the underscore in a machine name, it can still cause problems when you interact with other servers and platforms. For this reason, ArcGIS Notebook Server will not install on servers that have an underscore in the host name.
ArcGIS Notebook Server is not supported on domain controllers. Installing ArcGIS Notebook Server on a domain controller may adversely affect functionality.
Prior and future updates or service packs on these operating system versions are supported unless otherwise stated. The operating system version and updates must also be supported by the operating system provider.
Cloud implementations
You can deploy ArcGIS Notebook Server in the cloud. Cloud platforms allow you to add capabilities to your ArcGIS Notebook Server deployment, including resizing computer capacity and automatically distributing application network traffic across multiple instances for better performance.
Esri images
The ArcGIS Enterprise Microsoft Azure image provided by Esri includes an installation of ArcGIS Notebook Server. You can use ArcGIS Enterprise Cloud Builder for Microsoft Azure, but you must manually install Docker and configure it after installation, as Cloud Builder will not perform these steps. Currently, only single-machine ArcGIS Notebook Server sites are supported on Microsoft Azure.
Note:
Esri Technical Support is available for Esri software on cloud platforms. However, support may not be provided for Microsoft Azure machine images that have been modified beyond standard Esri or operating system updates. It's recommended that you do not modify software released by Esri.
If you require a different configuration, see the next section.
Other images
To deploy ArcGIS Notebook Server on a different operating system, different machine type, or different cloud platform from what is provided by Esri, you must install and configure the software on an instance offered by your cloud provider. The instance must meet the hardware, software, firewall, SSL certificate, and domain name requirements described on this page. Keep in mind the following if you install and configure your own cloud instance for ArcGIS Notebook Server:
- Deploying ArcGIS Notebook Server on Windows machines in Amazon Web Services is not supported. It's recommended that you deploy the software on Ubuntu machines if you use Amazon Web Services.
- You can deploy ArcGIS Notebook Server on Azure virtual machines running either a supported Windows or Linux platform.
- If you deploy your own Microsoft Azure Windows instance, the Microsoft Server 2016 Datacenter with Containers image is recommended.
- Only single-machine ArcGIS Notebook Server sites are supported on Microsoft Azure.
SSL certificates
ArcGIS Notebook Server is preconfigured with a self-signed certificate that allows the server to be initially tested and to help you quickly verify that your installation was successful.
You must request a certificate from a trusted certificate authority (CA) and configure ArcGIS Notebook Server to use it. This can be a domain certificate issued by your organization or a CA-signed certificate. The certificate must have a Subject Alternative Name (SAN) configured, or ArcGIS Notebook Server will not work properly.
Note:
Certificates created using IIS do not have the option to include a SAN. Use the script in Create a domain certificate, which includes a SAN, with the certificate created.
Portal for ArcGIS also includes a preconfigured self-signed certificate. Because you'll federate an ArcGIS Notebook Server site with your portal, request a certificate from a trusted CA and configure the portal to use it.
Software prerequisites
Before installing ArcGIS Notebook Server, you must have at least a base deployment of ArcGIS Enterprise ready. During the setup process, you will federate your new ArcGIS Notebook Server site with your ArcGIS Enterprise portal. ArcGIS Notebook Server can be installed on a machine that has other ArcGIS Enterprise software (of the same version) installed.
- ArcGIS Notebook Server requires Docker Desktop for Windows (version 3.0.0 or later) to be installed. Follow the steps in Install Docker for ArcGIS Notebook Server to install the appropriate edition of Docker.
- ArcGIS Notebook Server requires the Hyper-V role to already be installed on Windows Server and Windows 10. Refer to the Microsoft documentation on how to install the Hyper-V role for Windows Server and for Windows 10.
Note:
Certain virtualization environments do not allow Hyper-V to be enabled and operated in Windows. As a result, ArcGIS Notebook Server cannot be installed and operated in such environments. ArcGIS Notebook Server supports virtualized environments hosted on VMware vSphere 6.7 or later that have hardware-assisted virtualization (nested virtualization) enabled for the guest OS. Before you install ArcGIS Notebook Server, ensure that Docker is installed on your machine and supports Linux containers.
- Starting at 10.8, instances of ArcGIS Web Adaptor running on IIS web servers enable the WebSocket protocol by default. No action is needed. Previously, enabling WebSocket was an essential part of ArcGIS Notebook Server installation, as the protocol is required for notebooks to work with the web adaptor.
Domain name system and fully qualified domain name recommendations
It's recommended that you configure your organization's domain name system (DNS) to include fully qualified domain name (FQDN) entries for the ArcGIS Notebook Server site. Portal for ArcGIS will request the FQDN of the site when you federate.
Supported web browsers
To use the ArcGIS Notebook Server Configuration Wizard, as well as the notebook editor, the following web browsers are supported:
- Google Chrome
- Mozilla Firefox
- Microsoft Edge