Skip to main content

Create an ArcGIS Velocity site

An ArcGIS Velocity site is an individual deployment of Velocity. You must federate it with your ArcGIS organization.

Note:

ArcGIS Velocity supports only single-machine sites.

Use the site configuration wizard to create your ArcGIS Velocity site

To use the site configuration wizard to create a Velocity site, complete the following steps:

  1. Open a web browser and provide a URL in the following format: https://velocity.example.com:7143/arcgis/home.

    For example, https://velocity-server-name.domain.com:7143/arcgis/home

    Note:

    Accept the security warnings presented by your browser to begin the Velocity site configuration steps.

  2. In the ArcGIS Velocity for ArcGIS Enterprise Setup Wizard, click Create New Site.

  3. Provide a username and password for the Velocity primary site administrator account and click Next.

    Tip:

    The password must be at least eight characters long.

    Note:

    The Velocity primary site administrator account is not an operating system account, and Velocity manages it separately from other accounts in your user store. For more information, refer to accounts used by Velocity.

  4. Provide the paths for Log Root, Configuration Root, and Configuration Backup directories, and click Next.

    By default, the following locations are used:

    Directory

    Location

    Description

    Log Root

    <ArcGIS Velocity installation directory>\data\logs-root

    <ArcGIS Velocity installation directory>/data/logs-root

    The storage location of logs generated by feeds, analytics, feed lifecycle orchestration, streams, and more.

    Configuration Root

    <ArcGIS Velocity installation directory>\data\config-root

    <ArcGIS Velocity installation directory>/data/config-root

    The location of Velocity site and configuration store content.

    Configuration Backups

    <ArcGIS Velocity installation directory>\config-backups

    <ArcGIS Velocity installation directory>/config-backups

    The location of Velocity site backup configuration files that are automatically created every 24 hours.

  5. In the Machine Hostname section, choose Yes, use this value if the detected hostname is correct. Otherwise, choose No, specify a different value and provide the hostname.

    If your deployment uses a reverse proxy, you can optionally configure a WebContextURL after the site creation.

    Note:

    If the specified value is an IP address instead of a hostname, ensure the Velocity machine can resolve that IP address to the hostname that Velocity uses for network communication. If it cannot, add the hostname and IP address to the machine's hosts file.

    For example, on Windows, edit C:\Windows\System32\drivers\etc\hosts and add an entry that maps the configured hostname to the IP address that Velocity uses for network communication: <IP-address-used-by-Velocity> <hostname>.

    For example, if Velocity uses 127.0.0.1 and the configured hostname is velocity.example.com, add 127.0.0.1 velocity.example.com.

    Note:

    If the specified value is an IP address instead of a hostname, ensure the Velocity machine can resolve that IP address to the hostname that Velocity uses for network communication. If it cannot, add the hostname and IP address to the machine's hosts file.

    For example, on Linux, edit /etc/hosts and add an entry that maps the configured hostname to the IP address that Velocity uses for network communication: <IP-address-used-by-Velocity> <hostname>.

    For example, if Velocity uses 127.0.0.1 and the configured hostname is velocity.example.com, add 127.0.0.1 velocity.example.com.

  6. Review the information in the Configuration Summary section, and click Finish.

    A confirmation message appears indicating that Velocity is installed and the site is created. The Velocity home page then opens.

    Note:

    At this step in the configuration process, the following warning message is expected: ArcGIS Velocity is not federated. Please ensure your instance of Velocity is federated to a portal.

  7. Continue to configure certificates for Velocity.

Use the createsite command line utility to create your ArcGIS Velocity site

You can use the createsite command line utility to create a new ArcGIS Velocity site after you install ArcGIS Velocity. Two options available for using the createsite utility are as follows:

  • Run the createsite utility from a command prompt and specify user name, password, config-store, and directory parameters.

  • Run the createsite utility with a createsite.properties file that contains the parameters.

For the usage of the createsite command line utility, run the createsite.bat script with -h or --help:

<ArcGIS Velocity installation directory>\tools\createsite\createsite.bat -h

Example usage with the utility:

createsite.bat [-u <arg>] [-p <arg>] [-d <arg>] [-c <arg>]

Example usage using a file:

createsite.bat [-f <FILE>]
Note:

When you reference a path in the createsite.properties file, you must escape the backslash, for example, C:\\arcgisserver\\config-store or \\\\<Absolute path to>\\<Server config-store>.

For the usage of the createsite command line utility, run the createsite.sh script with -h or --help:

<ArcGIS Velocity installation directory>/tools/createsite/createsite.sh -h

Example usage with the utility:

createsite.sh [-u <arg>] [-p <arg>] [-d <arg>] [-c <arg>]

Example usage using a file:

createsite.sh [-f <FILE>]

The following table describes the command line parameters for the utility:

Option

Description

-u; --username

(Required)

User name for the primary site administrator.

The user name cannot contain the following characters: \ / : * ? | < > "

-p; --password

(Required)

Password for the primary site administrator.

The password cannot contain the following characters: \ / : * ? | < > "

-d; --directory

(Required)

The root server directory. The utility creates the server directories in this directory, for example:

C:\arcgisvelocityserver\directories

or

\\<Absolute path to>\<Server directory>

The root server directory. The utility creates the server directories under this directory, for example:

<ArcGIS Velocity installation directory>/usr/directories

-c; --configstore (Required)

The configuration store for the ArcGIS Velocity site. The utility creates the configuration store in this directory, for example:

C:\arcgisvelocityserver\config-store

or

\\<Absolute path to>\<Server config-store>

The configuration store for the ArcGIS Velocity site. The utility creates the configuration store under this directory, for example:

<ArcGIS Velocity installation directory>/usr/configstore

-r; --recoveryCodesFile (Optional)

The recovery codes file used to generate the site invariant keys.

If you do not specify this parameter, the tool randomly generates a new recovery codes file named recovery_codes.txt and stores it in the following folder:

<ArcGIS Velocity installation directory>\framework\etc
<ArcGIS Velocity installation directory>/framework/etc

-l; --logSettings (Optional)

A log directory, or a quoted log settings JSON object containing logDir, for example:

"C:\Program Files\ArcGIS\Velocity\logs"

or

"{\"level\":\"INFO\",\"logDir\":\"C:/Program Files/ArcGIS/Velocity/logs\"}"
<ArcGIS Velocity installation directory>/data/logs-root

or

'{"level":"INFO","logDir":"<ArcGIS Velocity installation directory>/data/logs-root"}'

-n; --hostname (Optional)

The external hostname or IP address for the site, for example:

velocity.example.com

-b; --backupsDirectory (Optional)

The configuration backups directory. The default location is configbackups under the server directories, for example:

C:\arcgisvelocityserver\directories\configbackups

or

\\<Absolute path to>\<Server directory>\configbackups
<ArcGIS Velocity installation directory>/usr/directories/configbackups

-f; --file

The properties file for the createsite utility. By default, the createsite.properties file can be found at this location:

<ArcGIS Velocity installation directory>\tools\createsite
<ArcGIS Velocity installation directory>/tools/createsite
Note:

The createsite utility updates the properties file when it runs. Place this file in a folder where your account has write access.

-h; --help

Displays command line help and exits.

The following is an example of the createsite.properties file:

#
# Configuration properties for ArcGIS Velocity Enterprise site creation.
# Copy this sample to a private, writable location before editing.
# Run createsite.bat with -f <path-to-properties-file>.
# A recovery codes file is not required.
#

# Required user name for the initial site administrator.
SERVER_ADMIN_USERNAME =

# Required password for the initial site administrator.
SERVER_ADMIN_PASSWORD =

# Initially leave this false. The tool encrypts the password in this file
# and changes this flag to true when it reads the file.
# When replacing the password with a new plaintext value, reset this to false.
SERVER_ADMIN_PASSWORD_ENCRYPTED = false

# Required server directories location.
# Example: C:/path/to/velocity/directories.
SERVER_DIRECTORIES_PATH =

# Required configuration-store location.
# Example: C:/path/to/velocity/config-store.
# Windows paths may use forward slashes, or escaped backslashes (C:\\path\\...).
SERVER_CONFIGSTORE_PATH =

# Optional log directory, or a one-line log settings JSON object containing logDir.
# Leave blank to use the server defaults.
# Example: {"level":"INFO","logDir":"C:/path/to/velocity/logs"}
# Prefer forward slashes for Windows paths: C:/velocity/logs.
# Escape backslashes for Java properties (C:\\velocity\\logs) in a plain
# directory, and use four per separator inside JSON: {"logDir":"C:\\\\velocity\\\\logs"}.
SERVER_LOG_SETTINGS =

# Optional external hostname or IP address. Leave blank to retain the current hostname.
SERVER_HOSTNAME =

# Optional configuration-backups directory (the configbackups SYSTEM directory).
# Leave blank to use configbackups under SERVER_DIRECTORIES_PATH, or under the
# configuration store when no server directories override is supplied.
# Set this explicitly to use the wizard's default <VELOCITY_HOME>/config-backups.
SERVER_CONFIGBACKUPS_PATH =

# Optional recovery codes file used to generate the site invariant keys. If not provided,
# the create site process generates one in <installdir>/framework/etc/.
# Example: C:\\Users\\<username>\\Documents\\<filename>.txt, or \\\\<AbsolutePath To File>\\<filename>.txt.
# The file must be a .txt file.
RECOVERY_CODES_FILE =
#
# Configuration properties for ArcGIS Velocity Enterprise site creation.
# Copy this sample to a private, writable location before editing.
# Run createsite.sh with -f <path-to-properties-file>.
# A recovery codes file is not required.
#

# Required user name for the initial site administrator.
SERVER_ADMIN_USERNAME =

# Required password for the initial site administrator.
SERVER_ADMIN_PASSWORD =

# Initially leave this false. The tool encrypts the password in this file
# and changes this flag to true when it reads the file.
# When replacing the password with a new plaintext value, reset this to false.
SERVER_ADMIN_PASSWORD_ENCRYPTED = false

# Required server directories location.
# Example: /path/to/velocity/directories.
SERVER_DIRECTORIES_PATH =

# Required configuration-store location.
# Example: /path/to/velocity/config-store.
SERVER_CONFIGSTORE_PATH =

# Optional log directory, or a one-line log settings JSON object containing logDir.
# Leave blank to use the server defaults.
# Example: /path/to/velocity/logs or {"level":"INFO","logDir":"/path/to/velocity/logs"}
SERVER_LOG_SETTINGS =

# Optional external hostname or IP address. Leave blank to retain the current hostname.
SERVER_HOSTNAME =

# Optional configuration-backups directory (the configbackups SYSTEM directory).
# Leave blank to use configbackups under SERVER_DIRECTORIES_PATH, or under the
# configuration store when no server directories override is supplied.
# Set this explicitly to use the wizard's default <VELOCITY_HOME>/config-backups.
SERVER_CONFIGBACKUPS_PATH =

# Optional recovery codes file used to generate the site invariant keys. If not provided,
# the create site process generates one in <installdir>/framework/etc/.
# Example: /<AbsolutePathToFile>/<filename>.txt.
# The file must be a .txt file.
RECOVERY_CODES_FILE =

The tool displays a message that the ArcGIS Velocity site was created successfully before it exits.