To install ArcGIS Notebook Server, you can run the ArcGIS Notebook Server installation wizard, or you can run the installation from a command prompt; for the latter option, see Silently install ArcGIS Notebook Server.
Each machine with an installation of ArcGIS Notebook Server requires an authorization file. There are several ways to register ArcGIS Notebook Server. You can visit My Esri to obtain an authorization file (by email, fax, phone, or mail) before proceeding with the installation. You can also register ArcGIS Notebook Server using the Software Authorization Wizard that launches after the setup installation completes (this is the recommended method).
Before you begin the installation, review to make sure you have completed the following steps from previous topics. If you are setting up a multiple-machine site, these apply to each machine:
- Verify that your machine meets the system requirements for ArcGIS Notebook Server.
- Modify the firewall of the ArcGIS Notebook Server machine to allow communication on port 11443 from the machines in your ArcGIS Enterprise deployment.
- Obtain your software download, authorization file (if using), and one or two Docker container images from My Esri. The number of images you receive depends on your license.
- Install Docker on your machine.
When you are ready, the following steps get ArcGIS Notebook Server set up using the installation wizard. Perform the steps in chronological order.
- Run the ArcGIS Notebook Server installation wizard you downloaded from My Esri.
- During installation, you will need to provide a location for the installation directory. The installation directory contains the ArcGIS Notebook Server files. Specify a location on the computer where you want to store these files.
The default install location on Linux is ${HOME}/arcgis/notebookserver.
- The Software Authorization Wizard opens at the end of the ArcGIS Notebook Server installation. Use this to authorize the installation with an ArcGIS Notebook Server license.
- Modify your OS privileges to allow systemd to bootstrap and manage processes on ArcGIS Notebook Server:
- Within a terminal, switch to the root user.
- Copy <ArcGIS Notebook Server install directory>/framework/etc/scripts/agsnotebook.service unit file to /etc/systemd/system. Change the file permissions of this relocated file from 700 to 600.
- Still as the root user, run the following command:
# systemctl enable agsnotebook.service - Restart the systemd service and check its status to verify it's properly configured:
# systemctl stop agsnotebook.service # systemctl start agsnotebook.service # systemctl status agsnotebook.service - End the root user session.
- Reboot the operating system and verify that ArcGIS Notebook Server starts properly.
Note:
This directory must be local to the machine. You cannot install ArcGIS Notebook Server on a shared network directory (NFS mounted folder). Folders with special characters in their names (such as $) are not supported.
If you are setting up a multiple-machine ArcGIS Notebook Server site, repeat the installation steps for each machine. When all ArcGIS Notebook Server software is installed and authorized, proceed to configure it with Docker.