Skip to main content

Configure ArcGIS Notebook Server after installation

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

Add your OS user account (or the account used to install ArcGIS Notebook Server) to a Unix group named docker. See the Docker documentation for complete steps.

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 a terminal using the ArcGIS Notebook Server installation account.

  2. Change the working directory to the ArcGIS Notebook Server tools folder.

    By default, this path is ${HOME}/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 to be installed on your machine. Determine whether Docker is active on your machine by running the following command:

    ./PostInstallUtility.sh -d

    1. If Docker installation requirements are not met, install it now.

  5. Download the runtime images necessary for your setup from My Esri:

    • ArcGIS Notebook Server Python Container Image (Standard)

    • ArcGIS Notebook Server Python Container Image (Advanced)

      Note:

      The Advanced runtime is only necessary if you have an ArcGIS Notebook Server Advanced license.

  6. Install the runtime image or images by specifying their file paths.

    Note:

    The image should be zipped in the .tar.gz format.

    Note:

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

    Note:

    If you have an Advanced license, ensure you install both container images, as your users may still need to use the Standard runtime.

    Run the following command:

    ./PostInstallUtility.sh -l <path of .tar.gz Docker image>

Proceed to create an ArcGIS Notebook Server site.

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. When your ArcGIS Notebook Server installation is complete, run the post installation utility to install the Windows container image. Perform the following steps for each machine on which you have installed ArcGIS Notebook Server:

  1. Open the command prompt window as an administrator.

  2. Change the working directory to the ArcGIS Notebook Server tools folder.

    By default, the 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. Determine whether Docker is active on your machine by running the following command:

    PostInstallUtility.bat -d

    1. If Docker is not active, install Mirantis Container Runtime or Docker Engine from binaries.

  5. Download the ArcGIS Notebook Server Python Container Image (Windows) from My Esri.

  6. Install the runtime image by specifying its path:

    Note:

    The image should be zipped in the tar.gz format.

    Note:

    Ensure that your machine has at least 100 GB of free disk space.

    Run the following command:

    PostInstallUtility.bat -l <path of .tar.gz Docker image>

Proceed to create an ArcGIS Notebook Server site.