Environment Variables

VertiGIS Studio Access Control runs as a Windows service. Some of the low-level settings for Access Control are provided as environment variables of the service.

In most deployments there is no need to directly manage the environment variables. These settings are managed for you by the Access Control Post Installer application. This documentation is provided for reference and to support advanced deployment scenarios.

 

Misconfiguration of environment variables can affect the operation and security of your Access Control deployment and the ArcGIS Servers associated with it.

 

To modify the environment variables of VertiGIS Studio Access Control:

  1. On the machine running Access Control, open a command prompt as an administrator.

  2. Change the directory to C:\Program Files\VertiGIS\VertiGIS Studio Access Control\dist\bin

  3. Run the command nssm edit geocortexaccesscontrol

    A service editor application opens.

  4. Locate the Environment tab (you may need to scroll to the right) and select it.

    The editor presents a newline-separated list of KEY=VALUE environment variables.

    Copy 
    APP_HOST=localhost
    APP_PORT=5080
    APP_BACKEND_URL=http://localhost:5080/
    APP_FRONTEND_PATH=/vertigisstudio/accesscontrol/
    APP_DATA_PATH=C:\ProgramData\Geocortex\Access Control
    OTHER_VARIABLE_NAME=value

  5. Modify the environment variables as desired.

  6. To save your changes, click the Edit service button.

  7. Open the Windows services.msc dialog and restart the VertiGIS Studio Access Control service.

    The environment variables are only read by Access Control when the service starts.

Common Environment Variables

The following table summarizes some of the commonly used environment variables supported by Access Control. All settings are case-sensitive.

Variable Name

Description

APP_BACKEND_URL

The backend URL of Access Control on the local server.

For example: http://localhost:5080/

APP_BASE_PATH

The file path of the Access Control application.

For example: C:\Program Files\VertiGIS\VertiGIS Studio Access Control\web

APP_DATA_PATH

The file path of the Access Control data directory used to store configuration and logs.

For example: C:\ProgramData\Geocortex\Access Control

APP_FRONTEND_PATH

The virtual path of Access Control as exposed by your web server (typically IIS).

For example: /vertigisstudio/accesscontrol/

APP_HOST

The host name Access Control listens on.

For example: localhost

APP_PORT

The port Access Control listens on.

For example: 5080

APP_PROXY_BACKEND_URL

The URL of the backend ArcGIS Server to proxy requests to when Access Control receives a request to http://<accesscontrol-server>/arcgis.

For example: https://localhost:6443

APP_PROXY_X_FORWARDED_REQUEST_CONTEXT

The value to assign to the X-Forwarded-Request-Context header on requests to the backend ArcGIS Server.

For example: https://<external-address>/arcgis