Skip To Content

Configure ArcGIS Notebook Server after installation (Linux containers)

When your ArcGIS Notebook Server installation is complete, run the post installation utility to set up the necessary Docker components. Perform these steps for each machine on which you've installed ArcGIS Notebook Server.

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 than 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, and 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 choose it. Click OK to confirm.
  5. Click OK to close the group dialog box.

Run the post installation utility

ArcGIS Notebook Server includes a utility to be run after the software is installed. This utility installs the Docker container images for notebooks that you 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 as an administrator.
  2. Change directories to the ArcGIS Notebook Server tools folder. By default, this path is C:\Program Files\ArcGIS\NotebookServer\tools\postInstallUtility.
  3. Optionally, 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. Determine whether Docker is active on your machine by running the following command: PostInstallUtility.bat -d
  5. If Docker Desktop is not installed, install it now.

    ArcGIS Notebook Server uses Linux containers in Docker Desktop. When you install Docker Desktop, ensure that you specify Linux containers, and do not click the Switch to Windows containers option.

  6. When using Docker Desktop, modify each of the following settings:
    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 Settings. In the Settings menu, click Resources > File sharing and add the drive directory that will be used for your ArcGIS Notebook Server configuration store.

      Docker for Windows only supports local directories on Windows that are to be shared with Linux containers.

  7. Install your Notebooks image by specifying its file path. The image should be zipped in the .tar.gz format. If you have an Advanced license and Docker Desktop, run the command twice to install both the Standard and Advanced container images you downloaded from My Esri.

    Ensure that your machine has at least 75 GB of available disk space.

    Run the following command: PostInstallUtility.bat -l <path of .tar.gz Docker image>

    Ensure you install both container images. Even if you have the Advanced license, your users may still need to use the Standard runtime.

Proceed to create an ArcGIS Notebook Server site.