Install ArcGIS Notebook Server silently

You can install and authorize ArcGIS Notebook Server using command line parameters, as opposed to using the installation wizard.

Tip:

The installation mode that you choose determines the default uninstallation mode. For example, if you install silently from the command line, the uninstallation defaults to uninstalling silently from the command line.

Before installing ArcGIS Notebook Server, review the system requirements.

Note:

Command line parameters are case sensitive. If you have trouble getting your installation to work, confirm the case matches each property as shown in the code examples below.

Prepare to install ArcGIS Notebook Server

Before proceeding with the installation, complete these steps:

Sign in to My Esri and obtain the necessary files. You need the following:
- Your ArcGIS Notebook Server software download.
- Your authorization file.
- One or both Docker container images, depending on your license. These container images contain all of the components needed for ArcGIS Notebooks to run. To learn more, see Container engines and ArcGIS Notebook Server.
Verify that each machine on which you'll install ArcGIS Notebook Server meets the system requirements.
Modify the firewall of each machine to allow communication on port 11443, which ArcGIS Notebook Server uses.

Specify the installation location

By default, ArcGIS Notebook Server is installed at C:\Program Files\ArcGIS\NotebookServer\.

Use the INSTALLDIR property to change the installation location for ArcGIS Notebook Server from this default location, if desired. If you do not run this command, the default location is used.

<setup directory>\setup.exe /qb INSTALLDIR=C:\NotebookServer ACCEPTEULA=yes

Ensure the user has full permissions to the ArcGIS Notebook Server installation directory. The user account used to install ArcGIS Notebook Server is the account used to run the software.

Configure the Windows account

The ArcGIS Notebook Server account must be configured when the software is installed silently. For production systems, it is recommended that you designate a preexisting account that resides in your domain or Active Directory and follows your organization's security policy.

If command line parameters are not used to configure the ArcGIS Notebook Server account during silent installations, the account is set to the Local System account.

Use the following command line parameters to configure the account.

Pass account credentials directly

Caution:

If the ArcGIS Notebook Server account is not defined during a silent (/qb) installation, or the credentials are not valid, the setup displays a warning message during installation. The message can be closed by clicking OK. Under these circumstances, the ArcGIS Notebook Server account is set to the Local System account.

USER_NAME=<operating system account>

The account can be a domain account or a local account. If you are using a domain account, it must already exist. If you are using a local account, the account is created if it does not already exist. If the account is not valid, a message box appears during installation indicating the account or password is invalid.
MSA=TRUE

This parameter should only be used with a Managed Service Account. A Managed Service Account must already exist on your domain. Do not use this parameter with a local account or a domain account with password. A Managed Service Account will not use the PASSWORD parameter.
PASSWORD=<account password>

This is the password for the account specified for the USER_NAME parameter. If the password is not valid, a message box appears during installation indicating the account or password is invalid.

See the examples below.

Using a domain account

<path to the ArcGIS Notebook Server setup download>\setup.exe /qb ACCEPTEULA=yes USER_NAME=mydomain\mydomainaccount PASSWORD=my.password

Using a new or existing local account

<path to the ArcGIS Notebook Server setup download>\setup.exe /qb ACCEPTEULA=yes USER_NAME=myaccount PASSWORD=my.password

Using a Managed Service Account

<path to the ArcGIS Notebook Server setup download>\setup.exe /qb ACCEPTEULA=yes MSA=TRUE USER_NAME=mydomain\mymsa

Import account credentials from a file

You can also use a server configuration file to import your Windows account credentials. Server configuration files can be exported during ArcGIS Notebook Server installation and used in future installations. To import credentials from an existing server configuration file, set the following two parameters:

ACCOUNT—If you're importing credentials from a file, set this parameter to UseConfigFile (matching the case exactly). There are no other valid values for this parameter.
CONFIGPATH—Specify the full path and name of the server configuration file you are using.

<setup directory>\setup.exe /qb ACCOUNT=UseConfigFile CONFIGPATH=\\networkmachine\serverconfigs\standardaccount.xml ACCEPTEULA=yes

Export credentials to a server configuration file

You can export the account credentials used in the current ArcGIS Notebook Server installation to reuse in a future installation. The server configuration file that is created is an encrypted .xml file.

When exporting a server configuration file to a network share, the Local System account on the machine where ArcGIS Notebook Server is being installed must have write permissions to the network share. For example, if you're installing ArcGIS Notebook Server on a machine named Turing, the Local System account on Turing must have write permission to the network share. If the permissions are not set, the server configuration file may not be exported successfully.

Note:

If you are unsure how to correctly set permissions for the network share, contact your system administrator or export the server configuration file locally and copy it to the network share.

Use the following two command line parameters to export ArcGIS Notebook Server account credentials to a server configuration file:

EXPORTCONFIG—Set this parameter as Yes to export the account information set for the USER_NAME and PASSWORD parameters to a server configuration file. This parameter is set to No by default.
CONFIGPATH—Specify the full path and name of the server configuration file you want to create, including the file extension .xml. The specified folder must already exist.

Add your OS user account (the account that will install ArcGIS Notebook Server) to a Unix group named docker. This workflow is documented on the Docker website.

Note:

Installing ArcGIS Notebook Server with the root account is not supported.

Install ArcGIS Notebook Server silently from the command line

Follow these steps to install ArcGIS Notebook Server silently from the command line.

By default, ArcGIS Notebook Server will be installed at ${HOME}/arcgis/notebookserver.

Open a command shell as the user who will run ArcGIS Notebook Server. Browse to the directory where you downloaded the ArcGIS Notebook Server tar.gz file from My Esri.
Uncompress the tar.gz file with the following command:

tar -xvzf ArcGIS_Notebook_Server_Linux_<version>.tar.gz
Browse to the directory where the file was uncompressed and to <untar directory>/Documentation/EULA.pdf. Read the license agreement.

From the directory, run the setup silently and authorize it using a .prvc file. The syntax is as follows:

<untar directory>/Setup -m silent -l yes -a <full path to .prvc file>

The parameters of the command line tool are as follows:


Parameter	Description
`-m; --mode MODE`	(Optional) The install mode: `silent` or `GUI`. The default is `GUI`.
`-l; --license-agreement CHOICE`	Required for silent mode, either `yes` or no. Yes indicates that you have read and agreed to the Esri Master Agreement (E204, E300). You can review the agreement at any time.
`-a; --authorization-file PATH_TO_FILE`	(Optional) The absolute file path to the authorization or provisioning file provided by Esri. If this option is not used, you must authorize the software after installation, as detailed in the next section.
`-d; --directory DIRECTORY`	(Optional) By default, ArcGIS Notebook Server is installed to your ${HOME} directory. DIRECTORY specifies a different installation directory. The path `/arcgis/notebookserver/` is appended to the installation directory. The name of the installation directory should be lowercase. The samples and data bundled with the installation require the data path to be lowercase.
`-v; --verbose`	(Optional) Run the installer in verbose mode.
`-h; --help`	Displays the command line help and exits.
`-e; --examples`	Displays usage examples of each option and exits.

Modify your OS privileges to allow systemd to bootstrap and manage processes on ArcGIS Notebook Server. This allows the service to start immediately when the machine starts.
1. Within 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 check its status to verify 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.

Authorize your software silently

If you did not authorize your software during installation, run SoftwareAuthorization.exe with the following syntax to authorize ArcGIS Notebook Server silently. You must have all user information complete in the authorization or provisioning file before running the file.

If you have an authorization file and your machine is connected to the internet:

<ArcGIS Notebook Server install directory>\tools\SoftwareAuthorization\SoftwareAuthorization.exe /S /Ver <Version> /LIF <full path and name of authorization file>

If you did not authorize your software during installation, run the software authorization with the following syntax to authorize ArcGIS Notebook Server silently. Run the following command to view all options for authorization:

<ArcGIS Notebook Server install directory>/tools/authorizeSoftware --help

Authorize in a disconnected environment

You can authorize ArcGIS Notebook Server in a disconnected environment using a provisioning (.prvc) file. During the process, a file is generated for you to send to Esri to complete the process.

At the prompt, run the command provided below after the ArcGIS Notebook Server installation is complete:

<ArcGIS Notebook Server install directory>\tools\SoftwareAuthorization\SoftwareAuthorization.exe /F <full path to the .prvc file> /O <full path to authorization file output>

<ArcGIS Notebook Server install directory>/tools/authorizeSoftware -f <full path to the .prvc file> -o <full path to authorization file output>
When the output information file has been created, do one of the following:
- Browse to the Esri self service site. Follow the instructions on the screen to upload your authorization information file and download your .ecp authorization file.
- Send your authorization information file by email to authorize@esri.com. Esri will send your .ecp authorization file back to you in an email.
When you have received your .ecp authorization file using either above method, run the authorizeSoftware script again to process it and complete the server authorization process:

<ArcGIS Notebook Server install directory>\tools\SoftwareAuthorization\SoftwareAuthorization.exe /F <full path to the .ecp file>

<ArcGIS Notebook Server install directory>/tools/authorizeSoftware -f <full path to the .ecp file>

Repeat this workflow for each machine on which you want to install ArcGIS Notebook Server.

After installing all software, Configure ArcGIS Notebook Server after installation and create your server site. There is an option to create the site using the createsite command line utility.