Skip To Content

Configure ArcGIS Notebook Server after installation

When your ArcGIS Notebook Server installation is complete, run the postinstallation utility to set up the necessary Docker components.

Add your OS account to the Docker group

If the Run As account for ArcGIS Notebook Server is a local system user, or is different from the user account used to install Docker, add the user to the docker-users group:

  1. From the Start menu on your Windows machine, open the Computer Management application.
  2. On the left sidebar, expand the Local Users and Groups item, then open the Groups folder.
  3. Choose the docker-users group from the list of groups and double-click it.
  4. Click the Add... button. Locate your Run As account and select it. Click OK to confirm.
  5. Click OK to close the group's dialog box.

Run the post-installation utility

ArcGIS Notebook Server includes a post-installation utility to be run after the software is installed. This utility installs the Docker container images for notebooks that you have downloaded from My Esri.

Complete the following steps to run the utility before creating your ArcGIS Notebook Server site.

  1. Open the command prompt window using the ArcGIS Notebook Server Run As account.
  2. Change directories to the ArcGIS Notebook Server Tools folder. By default, this path is C:\Program Files\ArcGIS\NotebookServer\tools\postInstallUtility.
  3. You can refer to the utility's help by running the following command: > PostInstallUtility.bat -h
  4. ArcGIS Notebook Server requires Docker Engine Community Edition to be installed on your machine. Check whether Docker is active on your machine by running the following command: > PostInstallUtility.bat -d
  5. If Docker is not installed, install it now.

    ArcGIS Notebook Server uses Linux containers on Docker, not Windows containers. When you install Docker, ensure that you specify that it uses Linux containers, and never click the Switch to Windows containers option.

    Note:

    If you have obtained an Advanced license, you should install both the Standard and Advanced container images downloaded from My Esri.

  6. Modify each of the following settings in Docker:
    1. Right-click the Docker button in the system tray and click Settings. Under General, check Expose daemon on tcp://localhost:2375 without TLS.

      You'll be using the Docker Remote API, which requires the use of port 2375.

    2. Right-click the Docker button in the system tray and click Shared Drives. Check the drive that will be used for your ArcGIS Notebook Server configuration store.
      The Docker container needs access to your local drive.
      Note:

      Whenever the credentials for your Run As account change, you will need to repeat this step.

  7. Install your Docker image by specifying its file path. The image should be zipped in the .tar.gz format. Run the following command: > PostInstallUtility.bat -l <path of .tar.gz Docker image>

    Note:
    This step could take a few minutes to run.

Proceed to create your ArcGIS Notebook Server site.