Configuring the proxy service - OnGuard 5.1.3

Lenel OnGuard Plugin Guide 5.1.3

Applies to
OnGuard 5.1.3
Last updated
2023-10-27
Content type
Guides > Plugin and extension guides
Language
English
Product
OnGuard
Version
5.1
Category
Plugin and extension guides

To transfer information between Security Center and your OnGuard system, you must configure a proxy to connect the plugin to the OpenAccess API, which retrieves information from the OnGuard database.

Before you begin

  • Download and install the OnGuard plugin.
  • Obtain OnGuard user credentials which have access to the OpenAccess API and the necessary rights.
    NOTE: It is recommended that you perform tests using your system administrator account.

What you should know

  • The proxy is installed as part of the plugin.
  • The configuration page for the proxy opens in a web browser when the installation of the plugin is complete.

Procedure

  1. In your web browser, open the proxy configuration page at https://<IP address of the Security Center server hosting the plugin>:<Web server port>/config/.
    The default web server port is 1312.
    NOTE: You must be a Windows administrator on the server that hosts the web page for the proxy.
  2. In the Third-party configuration section, enter the following:
    Endpoint
    The IP address and port number of the OpenAccess API. This is typically entered as https://<IP address of the server hosting the OpenAccess API>:<Port used to communicate with OpenAccess API>. For example, this could be https://192.168.1.2:8080/.
    Username
    The username required to log into OpenAccess.
    NOTE: Do not include the domain name in the username. If you are using a Windows account, you must specify the directory this account belongs to in the Proxy Settings tab of the plugin role.
    Password
    The password required to log into OpenAccess.
  3. Click Save.
  4. In the Web server configuration section, enter the following:
    Web server port
    The port on which the proxy will host its web configuration server and its API. This API is used to communicate from the plugin to the proxy and request data from OpenAccess.
    Password
    The password used to access the proxy. This is set during the installation process of the plugin.
  5. Click Apply.
    NOTE: You may need to restart the proxy service in the Windows Services console for some changes to take effect.