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
The minimum RAM requirement for an ArcGIS Notebook Server node is 8 GB.
For a production environment, minimum 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'll need to 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.
Operating system requirements
The following 64-bit operating systems satisfy the minimum operating system requirements. Support is not provided for 32-bit operating systems; the setup will only proceed if the operating system is 64 bit.
Machines with an underscore (_) in the name are not supported. The setup will not proceed if an underscore is detected in the machine name.
Several widely used Internet host name specifications have designated the underscore character as not standard. Although Windows allows you to use 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 systems are supported unless otherwise stated. The operating system version and updates must also be supported by the operating system provider.
| Supported operating systems |
|---|
Windows Server 2016 Standard and higher |
Windows Server 2019 |
| Supported operating systems |
|---|
Windows 10 Pro and Enterprise |
Note:
Windows 10 is supported for basic testing and application development use only. It is not recommended for deployment in a production environment.
SSL certificates
ArcGIS Notebook Server is preconfigured with a self-signed certificate, which 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 could 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 comes with a preconfigured self-signed certificate. Because you'll be federating an ArcGIS Notebook Server site with your portal, you should 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 10.7 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 runtime (version 17.0 or later) to be installed. Follow the steps in Prepare 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 2016, Windows Server 2019, and Windows 10. Refer to Microsoft documentation on how to install the Hyper-V role for Windows Server 2016 or Windows Server 2019 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. Before you install ArcGIS Notebook Server, ensure Docker is installed on your machine and supports the running of Linux containers.
- If you plan to install the ArcGIS Web Adaptor for your ArcGIS Notebook Server on an IIS web server, enable the WebSocket protocol. This is required for notebooks to work with the Web Adaptor.
Domain name service and fully qualified domain name recommendations
It's recommended that you configure your organization's domain name service (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
The ArcGIS Notebook Server Configuration Wizard requires one of the following web browsers to be installed:
- Google Chrome
- Mozilla Firefox
- Microsoft Edge
Microsoft Internet Explorer is not recommended when using ArcGIS Notebook Server.