The following steps guide you through the Portal for ArcGIS silent installation process.
Note:
If you're upgrading to 10.9, see Upgrade your ArcGIS Enterprise portal for more information.
Preparing to install Portal for ArcGIS
- Verify that your site meets the minimum system requirements.
- Log in to your machine as a user with administrative privileges. You cannot install Portal for ArcGIS as a root user.
- Open the ports as described in Ports used by Portal for ArcGIS.
- Close all noncritical applications on your server.
- Browse to the downloaded folder containing the Portal for ArcGIS setup or insert the Portal for ArcGIS media into the appropriate drive to automatically start the setup program.
You are now ready to proceed with the Portal for ArcGIS installation.
Installing Portal for ArcGIS silently on Linux
- Read the license agreement located at <CD_ROOT or untar directory>/Documentation/EULA.pdf and accept the terms.
- Run the setup silently at the prompt. See the sample syntax below:
<CD_ROOT or untar directory>/Setup -m silent -l yes
Usage: Setup [Options]
Option Description -m; --mode MODE
Optional. Defaults to GUI.
MODE is one of the following: silent, console, or gui.
-l; --license-agreement CHOICE
Required for silent mode. CHOICE can be Yes or No.
Yes indicates that you have read and agreed to the Esri Master Agreement (E204, E300). Visit http://www.esri.com/legal/licensing-translations to read the agreement.
-d; --directory DIRECTORY
Optional. By default, Portal for ArcGIS is installed in the user's $HOME directory. DIRECTORY specifies a different installation directory.
The /arcgis/portal path is appended to the installation directory.
If you're pointing the setup to a previous installation directory, the content in that directory is automatically used in the new installation. Content from installations prior to version 10.2 is not supported.
-v; --verbose
Installer runs in verbose mode.
-h; --help
Displays command line help and exits.
-e; --examples
Displays usage examples of these options and exits.
Note:
You can also use the createportal command line utility to create a portal once Portal for ArcGIS has been installed.
Using the createportal command line utility to create a portal
You can use the createportal utility in the following ways:
- Run the createportal utility as an administrator from a command prompt and specify the first name, last name, user name, password, email, secret question, answer, and content directory parameters.
- Provide a createportal.properties file containing specified parameters.
To use the createportal command line utility, run the createportal.sh script with -h or -help as follows:
<Portal for ArcGIS Installation Directory>/tools/createportal/createportal.sh -help
Example usage with the utility: createportal.sh [-fn <arg>] [-ln <arg>] [-u <arg>] [-p <arg>] [-e <arg>] [-qi <arg>] [-qa <arg>] [-d <arg>] [ -lf <arg>] [ -ut <arg>]
Example usage with a file: createportal.sh [-f <FILE>]
Note:
When you reference a path in the createportal.properties file, you need to escape the backslash, for example, C:\\arcgisportal or \\\\<Absolute path to>\\<portal arcgisportal>.
| Option | Description |
|---|---|
-fn; --firstname | First name for an initial administrative account used to configure the portal. Ensure that multiple-word entries are enclosed in quotes. |
-ln; --lastname | Last name for an initial administrative account used to configure the portal. Ensure that multiple-word entries are enclosed in quotes. |
-u; --username | User name for an initial administrative account used to configure the portal. The user name can be composed of numbers 0–9, the ASCII letters a–z and A–Z, and the dot character (.). |
-p; --password | Password for the initial administrative account used to configure the portal. The password can be composed of numbers 0–9, the ASCII letters a–z and A–Z, and the dot character (.). |
-e; --email | Email address for an initial administrative account used to configure the portal. |
-qi; --question | Index of the secret question to retrieve a forgotten password. Available questions with respective index numbers are as follows:
|
-qa; --answer | Answer to the secret question you chose for the parameter -qi . Ensure that multiple-word entries are enclosed in quotes. |
-d; --contentDirectory | Absolute path and name of the content directory used to store data hosted in the portal. By default, the portal content directory is created locally at this location: <Portal for ArcGIS Installation Directory>/usr/arcgisportal |
-f; --file | The properties file for the createportal utility. By default, the createportal.properties file can be found at this location: <Portal for ArcGIS Installation Directory>\tools\createportal |
| -lf; --licenseFile | This is the path to the portal license file. |
| -ut; --userTypeID | This is the ID of the user type for the initial administrator. This parameter is optional. To generate a list of compatible user types available to your organization for the -ut parameter, run the listadministratorusertypes utility. If a user type ID is not specified, and the portal license file contains a single compatible user type, that user type will be assigned. If the license file contains multiple compatible user types, a temporary user type will be assigned, and the initial administrator will have to select a user type after logging in. |
-h; --help | Displays the command line help and exits. |
The following is an example of the createportal.properties file: #
#
# Portal for ArcGIS site creation properties
#
# First name for initial administrator account
PORTAL_ADMIN_FIRSTNAME =
# Last name for initial administrator account
PORTAL_ADMIN_LASTNAME =
# User name for initial administrator account
# Can only have the numbers 0-9, the ASCII letters a-z, A-Z and the dot character (.)
PORTAL_ADMIN_USERNAME =
# Password for primary site administrator.
# Can only have the numbers 0-9, the ASCII letters a-z, A-Z and the dot character (.)
PORTAL_ADMIN_PASSWORD =
# Initially, leave PORTAL_ADMIN_PASSWORD_ENCRYPTED set to false.
# When you run the tool the first time, the password will be
# encrypted and PORTAL_ADMIN_PASSWORD_ENCRYPTED will change to true
PORTAL_ADMIN_PASSWORD_ENCRYPTED = false
# E-mail address for initial administrator account
# e.g username@domain.com
PORTAL_ADMIN_EMAIL =
#This is the index of the secret question to retrieve a forgotten password.
#The list of questions with their respective index numbers is as follows:
#1, What city were you born in ?"
#2, What was your high school mascot?"
#3, What is your mother's maiden name?"
#4, What was the make of your first car?"
#5, What high school did you go to?"
#6, What is the last name of your best friend?"
#7, What is the middle name of your youngest sibling?"
#8, What is the name of the street on which you grew up?"
#9, What is the name of your favorite fictional character?"
#10, What is the name of your favorite pet?"
#11, What is the name of your favorite restaurant?"
#12, What is the title of your favorite book?"
#13, What is your dream job?"
#14, Where did you go on your first date?");
PORTAL_ADMIN_SECURITY_QUESTION_INDEX =
# Answer to the secret question
# e.g \"My Answer\"
PORTAL_ADMIN_SECURITY_QUESTION_ANSWER =
# Portal content directory where portal will store default and user-generated content.
# By default, the portal content directory will be created locally,
# e.g./<Portal for ArcGIS installation directory>/usr/arcgisportal.
PORTAL_CONTENT_DIRECTORY =
# The path to the portal license file
PORTAL_LICENSE_FILE =
# The ID of the user type for the Initial Administrator
PORTAL_USER_TYPE_ID =
You will receive a message that the portal was created successfully before the tool exits.
Using the listadministratorusertypes command line utility to identify compatible user types
To identify a list of user type IDs licensed for your organization that are compatible with the Administrator role, run the listadministratorusertypes command line utility. This will provide a list of inputs for the -ut parameter in the createportal tool. Run the tool with -la as shown below, using the portal license file as the input:
<Portal for ArcGIS Installation Directory>/tools/createportal/listadministratorusertypes.sh
Example usage with the utility: listadministratorusertypes.sh [-la <arg>] or listadministratorusertypes.sh [--listadministratorusertypes <arg>]
Post installation configuration
If you want Portal for ArcGIS to start with the operating system, complete the steps specific to your operating system below.
Operating systems that support systemd
If your operating system supports the use of systemd to bootstrap and manage processes (for example, if you're using Red Hat 7.x), follow these steps to configure Portal for ArcGIS to start with the operating system.
- In a command shell, switch to root user.
- Copy the <Portal for ArcGIS installation directory>/framework/etc/arcgisportal.service unit file to /etc/systemd/system. Once the file is copied, confirm that /etc/systemd/system/arcgisportal.service has its file permissions set to 600.
Note:
This file is installed with Portal for ArcGIS 10.9.
- Still as root user, run the following command to automatically create the links in /etc/systemd/system/multi-user.target.wants:
# systemctl enable arcgisportal.service - To verify that the systemd service is properly configured, restart the service and check its status.
# systemctl stop arcgisportal.service # systemctl start arcgisportal.service # systemctl status arcgisportal.serviceNote:
To prevent a service from producing too many threads and consuming all server resources, systemd v228 and later included in SLES12 SP2 and later set the maximum number of threads to be created at 512. Users on SLES12 may need to enable and raise this limit if it is a heavily used system. To enable and raise this limit, as root user, uncomment and edit the following line in the arcgisportal.service unit file before deploying it to the /etc/systemd/system folder: # TasksMax=512
- End the root user session.
- Reboot the operating system and verify that Portal for ArcGIS restarts properly.
Operating systems that support SysV
If your operating system supports the use of SysV to bootstrap and manage processes, follow these steps to configure Portal for ArcGIS to start with the operating system.
- In a command shell, switch to root user.
- Copy the <Portal for ArcGIS installation directory>/framework/etc/arcgisportal shell script to the appropriate supported Linux distribution-based locations provided below:
- RHEL: /etc/rc.d/init.d/
- SUSE: /etc/init.d/
- Change the directory to the applicable init.d folder, and check the arcgisportal script to confirm that root has at least read and execute permissions.
- Edit the script as follows:
Update the portalhome variable to the Portal for ArcGIS installation directory, for example, /home/username/arcgis/portal.
For RHEL only, add the line below just before # Description: Portal for ArcGIS Service:
# chkconfig: 35 99 01
Save the edits to the arcgisportal script.
- Still as root user, run the following commands to automatically create the links in /etc/rc*.d with the appropriate run levels:
- RHEL:
$ chkconfig --add arcgisportal $ chkconfig arcgisportal on - SUSE:
$ insserv arcgisportal $ chkconfig arcgisportal on
- RHEL:
- End the root user session.
- Reboot the operating system, and verify that Portal for ArcGIS restarts properly.