This is the documentation for the console version of File Gateway. The old version is no longer supported.
Documentation for the new version of File Gateway is located here.

Configuration through the web interface

File gateway web interface is used for easy service configuration and management. The Web interface form (Fig/ 1.1) provides the user with the following customizable options:

Page contents:

  1. URL of the web interface (Fig. 1.2). Only values like http://localhost:PORT/ are acceptable, where PORT is the port number. Access to the HTTP-protocol is set automatically for the user specified during installation.

    If the web interface is not available or the user that runs the service has been replaced, you need to manually set access to the HTTP-protocol. To do this:

    1. run the command line as an administrator;

    2. run the netsh http add urlacl url=http://+:8081/ user=SERVICE_USER command, where PORT is a port number (default port is 8080). Parameter /fileGateway/webInterface/@listenUrl in the configuration file svc.config, SERVICE_USER is the name of the user, on whose behalf the service is running.

      When you change the URL, you need to restart the service to apply your settings.

      If the user was replaced, the port can stay busy by the previous user. When going into the web interface error The Url reservation add failed, Error: 183. Cannot create a file when that file already exists will open.
      To solve the problem, you must delete permissions on the port from the previous user with the command netsh http delete urlacl url=http://+:8080/.


    Figure 1 – web interface settings

    When you change the URL, you need to restart the service to apply the settings (see Running File Gateway).

  2. enable/disable web-interface (Fig. 1.3) by setting a switch;

  3. allowing access only to the local computer web interface (Fig. 1.4). If the switch box is not activated, the web interface will be accessible from any computer.

To apply the settings, click Save (Fig. 1.5), and then restart the service.

Configuring in svc.config

To navigate to the file svc.config you need to paste %LOCALAPPDATA% into the Windows Explorer and press Enter on the keyboard, then go to the installation folder NSD.FileGateway.

To configure web interface, you must change the required parameters in the svc.config XML file. Valid options are presented in table 1.

Table 1 – File Gateway Setup Parameters

XPath-expression

Description

/fileGateway/webInterface/@enable

Activation of the service web-interface. Valid values:

  • true, if the web-interface is enabled
  • false, if disabled

/fileGateway/webInterface/@listenUrl

URL under which the web-interface is available. Only http://localhost:PORT/, type values are accepted, where PORT is port number

The service process must have access to the HTTP- protocol via the specified port

Access can be granted using command

netsh http add urlacl url=http://+:8080/ user=SERVICE_USER

SERVICE_USER – user name under which the service is running. The command must be run by an administrator.

/fileGateway/webInterface/@localOnly

Mode of accessing the service’s web-interface. Valid values:

  • true, if the web-interface is available only on the same machine that runs the service
  • false, if the web-interface is available everywhere
  • No labels