Install a container engine for ArcGIS Notebook Server

The steps below describe how to download, install, and configure container allocation software required by ArcGIS Notebook Server. See Container engines and ArcGIS Notebook Server for an introduction to container engines and how they are used in ArcGIS Notebook Server.

Download and install a container engine

There are two container engines available for Linux systems: Docker Engine and Mirantis Container Runtime.

If you're running Ubuntu or Red Hat Enterprise Linux Server, you can use either Docker edition.


Container engine	Operating system
Docker Engine Community edition 29.2.0 or later Note: If you are using Docker Engine version 29 or later and it was upgraded from a previous version, edit `/etc/docker/daemon.json` to enable containerd image store. See step 4 in Configure Docker settings and environments for more information.	Ubuntu Server LTS 24.04.3 Ubuntu Server LTS 22.04.5 Red Hat Enterprise Linux Server 8 update 10 Red Hat Enterprise Linux Server 9 update 7 Rocky Linux 8 update 10 Rocky Linux 9 update 7 AlmaLinux 8 update 10 AlmaLinux 9 update 7
Mirantis Container Runtime version 25.0.15 or later Note: Refer to the Mirantis Container Runtime 25.0 compatibility matrix for the most up to date information.	Ubuntu Server LTS 22.04.3 Ubuntu Server LTS 24.04.2 Red Hat Enterprise Linux Server 8 update 10 Red Hat Enterprise Linux Server 9 update 7 Oracle Linux 9 update 7 Rocky Linux 8 update 10 Rocky Linux 9 update 7 SUSE Linux Enterprise Server (SLES) 15 SP6

Mirantis Container Runtime

ArcGIS Notebook Server on Windows with Mirantis Container Runtime supports the following operating systems:


Operating system	Container engine	Additional requirements
Windows Server 2022 Standard and Datacenter	Mirantis Container Runtime version 25.0.15 or later	Optionally, you can install Hyper-V. Note: There are limitations to the maximum number of containers that can run with Hyper-V isolation on Windows Server Standard. See the Windows FAQ for more information.

Docker Engine from binaries

ArcGIS Notebook Server on Windows with Docker Engine from binaries supports the following operating systems and Docker Engine versions:


Operating system	Container engine	Additional requirements
Windows Server 2025 Standard and Datacenter Windows Server 2022 Standard and Datacenter	Docker Engine - Community version 29.2.0 or later	Optionally, you can install Hyper-V. Note: There are limitations to the maximum number of containers that can run with Hyper-V isolation on Windows Server Standard. See the Windows FAQ for more information.

Note:

Because Docker is a third-party software component, this topic does not detail the complete steps to install Docker. Review and refer to the Docker website for the most up-to-date information.

Install Mirantis Container Runtime on Red Hat Enterprise Linux Server, Ubuntu, SUSE Linux Enterprise Server, and Oracle Linux

To install Mirantis Container Runtime, you must obtain a trial or subscription for the software.

Uninstall any previous version of Docker on your machine.

Refer to the Docker documentation for that version for complete steps to uninstall.
Follow the steps in your Linux distribution's Mirantis Container Runtime install guide.

Note:

Currently, Mirantis does not have a separate installation guide for Rocky Linux, but the Red Hat Enterprise Linux installation guide can be followed for installation on Rocky Linux.

Note:

The document outlines the two methods you can use to install the software (from a Docker repository or through an RPM package).
Since Docker does not automatically start after installation and configuration, start the Docker daemon by running the following command:

$ sudo systemctl start docker
Verify that Docker is properly installed and can access container images by running the following command:

$ sudo docker run hello-world

Proceed to the Configure Docker settings and environments section below.

Install Docker Engine on Red Hat Enterprise Linux Server, Oracle Linux, Rocky Linux, or AlmaLinux

The Docker Engine edition is a free download but requires that you have a Docker account.

Uninstall any previous version of Docker on your machine.

Refer to the Docker documentation for that version for complete steps to uninstall.
Follow the steps in Install Docker Engine on RHEL.

The document outlines the two methods you can use to install the software (from a rpm repository or through a rpm package).

The Docker daemon starts automatically after installation.
Verify that Docker is properly installed and can access container images by running the following command:

$ sudo docker run hello-world

Proceed to the Configure Docker settings and environments section below.

Install Docker Engine on Ubuntu

The Docker Engine edition is a free download but requires that you have a Docker account.

Uninstall any previous version of Docker on your machine.

Refer to the Docker documentation for that version for complete steps to uninstall.
Follow the steps in Install Docker Engine on Ubuntu.

The document outlines the two methods you can use to install the software (from a Docker repository or through a DEB package).

The Docker daemon starts automatically after installation.
Verify that Docker is properly installed and can access container images by running the following command:

$ sudo docker run hello-world

Proceed to the Configure Docker settings and environments section below.

Configure Docker settings and environments

When the appropriate Docker edition is installed on your machine, configure Docker for use with ArcGIS Notebook Server.

Add your OS user account (or the account used to install ArcGIS Notebook Server) to the group named docker, which was automatically created at installation.

$ sudo usermod -aG docker <ArcGIS Notebook Server install account>
Sign out and sign back in to the OS user account for the changes to take effect.
Verify that you can run Docker commands from the account.

$ docker run hello-world
If you are using Docker Engine version 29 or later and it was upgraded from a previous version, edit /etc/docker/daemon.json to enable containerd image store.
```
{
  "features": {
    "containerd-snapshotter": true
  }
}
```
Note:

If daemon.json doesn't exist, create it.
Ensure that the /var directory has at least 75 GB of disk space.

Docker uses the /var directory as its local registry for container images. During the upgrade process for subsequent releases, new images will be copied to the /var directory as well. If there is insufficient space, either increase the allocation for the /var directory, or follow the substeps below to change the location of the Docker root directory.
1. Edit /etc/docker/daemon.json to set data-root to a local directory on your machine with sufficient space.
  
  Note:
  
  If this file does not exist, create it.
  
  Example path:
  
  {"data-root" : "/data/docker"}
  
  The following is an example of /etc/docker/daemon.json with containerd-snapshotter and data-root properties:
```
{
   "features": {
      "containerd-snapshotter": true
   },
   "data-root" : "/data/docker"
}
```
2. Remove /var/lib/docker and create a symbolic link that refers to the path specified in the previous step.
```
$ sudo mkdir /data/docker
$ sudo rm -rf /var/lib/docker
$ sudo ln -s /data/docker /var/lib/docker
```
3. This step is only required if using Docker container engine version 29. Remove /var/lib/containerd and create a symbolic link that refers to the path specified in the previous step.
```
$ sudo mkdir /data/containerd
$ sudo rm -rf /var/lib/containerd
$ sudo ln -s /data/containerd /var/lib/containerd
```

Restart the Docker service to apply the changes.

$ sudo systemctl stop docker.service
$ sudo systemctl stop docker.socket
$ sudo systemctl stop containerd
$ sudo systemctl start containerd
$ sudo systemctl start docker.service
$ sudo systemctl start docker.socket

You are now ready to install ArcGIS Notebook Server on your machine.

Container engine requirements

ArcGIS Notebook Server on Windows supports Mirantis Container Runtime and Docker Engine from binaries as container engines. See Container engines and ArcGIS Notebook Server for an introduction to container engines and how they are integrated in ArcGIS Notebook Server.

There are two container engines available for Linux systems: Docker Engine and Mirantis Container Runtime.

If you're running Ubuntu or Red Hat Enterprise Linux Server, you can use either Docker edition.


Container engine	Operating system
Docker Engine Community edition 29.2.0 or later Note: If you are using Docker Engine version 29 or later and it was upgraded from a previous version, edit `/etc/docker/daemon.json` to enable containerd image store. See step 4 in Configure Docker settings and environments for more information.	Ubuntu Server LTS 24.04.3 Ubuntu Server LTS 22.04.5 Red Hat Enterprise Linux Server 8 update 10 Red Hat Enterprise Linux Server 9 update 7 Rocky Linux 8 update 10 Rocky Linux 9 update 7 AlmaLinux 8 update 10 AlmaLinux 9 update 7
Mirantis Container Runtime version 25.0.15 or later Note: Refer to the Mirantis Container Runtime 25.0 compatibility matrix for the most up to date information.	Ubuntu Server LTS 22.04.3 Ubuntu Server LTS 24.04.2 Red Hat Enterprise Linux Server 8 update 10 Red Hat Enterprise Linux Server 9 update 7 Oracle Linux 9 update 7 Rocky Linux 8 update 10 Rocky Linux 9 update 7 SUSE Linux Enterprise Server (SLES) 15 SP6

Mirantis Container Runtime

ArcGIS Notebook Server on Windows with Mirantis Container Runtime supports the following operating systems:


Operating system	Container engine	Additional requirements
Windows Server 2022 Standard and Datacenter	Mirantis Container Runtime version 25.0.15 or later	Optionally, you can install Hyper-V. Note: There are limitations to the maximum number of containers that can run with Hyper-V isolation on Windows Server Standard. See the Windows FAQ for more information.

Docker Engine from binaries

ArcGIS Notebook Server on Windows with Docker Engine from binaries supports the following operating systems and Docker Engine versions:


Operating system	Container engine	Additional requirements
Windows Server 2025 Standard and Datacenter Windows Server 2022 Standard and Datacenter	Docker Engine - Community version 29.2.0 or later	Optionally, you can install Hyper-V. Note: There are limitations to the maximum number of containers that can run with Hyper-V isolation on Windows Server Standard. See the Windows FAQ for more information.

Install Mirantis Container Runtime

Complete the following steps to install Mirantis Container Runtime:

Uninstall any previous version of Docker on your machine.
Do not enable the Containers feature on your local server prior to installing Mirantis Container Runtime. If this feature is already enabled, disable it on your server machine. See Install or Uninstall Roles, Role Services, or Features in the Microsoft documentation for more information.
Follow the steps in Install Mirantis Container Runtime on Windows Server in the Mirantis documentation to obtain and run the install.ps1 installation script for Mirantis Container Runtime for Windows Server.

To run the installation script, use the code below:

./install.ps1
Verify that Mirantis Container Runtime is installed and has been started by running the following command:

docker run hello-world:nanoserver
Once completed, follow the steps in Configure your Docker component to configure Mirantis Container Runtime.

Install Docker Engine from binaries

Complete the following steps to install Docker Engine from binaries:

Uninstall any previous version of Docker on your machine.
Disable the Containers feature on your local server if it is enabled.

See the Microsoft documentation for more information.
Enable the Windows Containers feature by running the following command in Microsoft PowerShell with administrative privileges:

Add-WindowsFeature Containers
Follow the prompts to restart your machine.
Verify the installation of the Containers feature by running the following command:

Get-WindowsFeature Containers
Follow the instructions in the Install server and client binaries on Windows section in the Docker documentation.

Note:

Docker Engine from binaries does not update automatically. You must manually update to newer versions of Docker. See the Install Docker Engine from binaries documentation for more information on the limitations of using Docker from binaries in a production environment. Although this page recommends using Docker Desktop, ArcGIS Notebook Server with Windows Containers does not support Docker Desktop on Windows as a container engine.
Add the docker directory path, for example, C:\Program Files\docker, to the Path environment variable in System variables.
Verify your installation and Docker daemon running status by running the following command:

docker version
Once completed, follow the steps in Configure your Docker component to configure Docker Engine.

Configure your Docker component

Complete the following steps to configure your Docker component:

If the account used to install ArcGIS Notebook Server is not part of the administrator group, perform the following steps:
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.
  
  If a docker-users group does not already exist, create one.
4. Click the Add button, locate the account you used to install ArcGIS Notebook Server, and choose it. Click OK to confirm.
5. Click OK to close the group dialog box.
6. Create a configuration file at C:\ProgramData\docker\config\daemon.json to set a security group for Docker.
7. Edit C:\ProgramData\docker\config\daemon.json to add the docker-users group.
```
{
  "group" : "docker-users"
}
```
Configure your Docker service to listen on a named pipe with the following command:

sc config docker binpath= "\"C:\Program Files\docker\dockerd.exe\" --run-service -H npipe://"
Restart Docker with the following command:
```
net stop docker
net start docker
```
Once the Docker component is installed, restart your machine.

Note:

Each time you install or upgrade the Docker component, you must restart the machine.

Change the default Docker image installation location

Optionally, to change the default Docker image installation location, complete the following steps:

Edit the file at C:\ProgramData\docker\config\daemon.json.
Change the default Docker image installation location by setting the data-root location to your chosen location on your local machine.
```
 {
"data-root": "d:\\\\docker"
}
```
Save daemon.json.
Restart Docker by running the following command:
```
net stop docker
net start docker
```

You are now ready to install ArcGIS Notebook Server on your machine.

Configure a non-default temporary directory for Docker

Docker Engine 29.4 and later supports configuring a non-default temporary directory using the DOCKER_TMPDIR environment variable. This environment variable enables Docker to use a directory other than the default C:\ temp location for temporary storage, for example during post-installation when loading the Notebook runtime image. Follow the steps below to configure a non-default temporary directory for Docker:

Create a temporary directory on a non-default drive.

Example:

d:\docker-temp
In Windows, click to System properties > Advanced > Environment variables > System variables.
Set a system-wide environment variable with the following information:

Variable name:DOCKER_TMPDIR

Variable value: <new temporary directory created in step 1>
Restart the Docker service:
```
net stop docker
net start docker
```