Skip To Content

Install ArcGIS Notebook Server

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 opens after the setup installation completes (this is the recommended method).

Before you begin the installation, make sure you have completed the following steps from previous topics. If you are setting up a multiple-machine site, these steps apply to each machine.

  1. Verify that your machine meets the system requirements for ArcGIS Notebook Server.
  2. Modify the firewall of the ArcGIS Notebook Server machine to allow communication on port 11443 from the machines in your ArcGIS Enterprise deployment.
  3. 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.
  4. Install Docker or Mirantis Container Runtime on your machine.

When you've completed the steps above, follow the steps below, in order, to set up ArcGIS Notebook Server using the installation wizard.

  1. Run the ArcGIS Notebook Server installation wizard you downloaded from My Esri.
  2. During installation, 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 installation location on Linux is ${HOME}/arcgis/notebookserver.

  3. 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.

  4. 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.
    • If you have an authorization file, such as a .prvc file, and have internet access on your machine, select the option I have received an authorization file from Esri and am now ready to finish the authorization process. Then browse to your file and upload it before proceeding.
    • If you have an authorization code from Esri Customer Service, select the option I have installed my software and need to authorize it.
    • If your ArcGIS Notebook Server machine is in an environment disconnected from the internet, select the authorization file option and upload your .prvc file. The wizard will generate an output file to send to Esri; you will then receive an .ecp file to complete the authorization process.
  5. Modify your OS privileges to allow systemd to bootstrap and manage processes on ArcGIS Notebook Server.
    1. In a terminal, switch to the root user.
    2. Copy the <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.
    3. Still as the root user, run the following command:

      # systemctl enable agsnotebook.service

    4. Restart the systemd service and review its status to verify that it's properly configured:

      # systemctl stop agsnotebook.service
      # systemctl start agsnotebook.service
      # systemctl status agsnotebook.service

    5. End the root user session.
    6. Reboot the operating system and verify that ArcGIS Notebook Server starts properly.

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, see Configure ArcGIS Notebook Server after installation.