enaio® gateway

enaio® 10.10

enaio® gateway is a proxy that is used as the central authentication component and communications interface between the core services and microservices.

enaio® gateway must always be installed downstream from all core services so that enaio® gateway can read the URLs of the other core services from the server registry.

enaio® gateway must be configured for the authentication of enaio® webclient and enaio® webclient as a desktop application and to set up encrypted data transmission (HTTPS).

In multi-server systems, the core services should only be registered on a single server; if not, the URL end points of all core services should be unified manually.

Installation

The following installation requirements must be met:

enaio® server runs and is reachable.

The core services have been installed.

enaio® gateway is installed as a service via osgateway_setup.exe located in the directory \Backend\Gateway\.

enaio® gateway uses port 80 by default. If this port is not free, a free port must be specified during installation. The default port for HTTPS is 443.

The following data must be entered during the installation process:

Service name, service display name, and port
enaio® address and port
Name and password of the technical user

enaio® gateway requires an administrator service account.

The runtime environment (JDK and application server) will also be automatically installed.

The installed runtime environment should be used only for this core service, because the runtime environment is also updated when the core service is updated. If other enaio® components or third-party components are run in the runtime environment, update errors may occur or the other components may no longer function after the update.

The installation automatically registers the service on enaio® server with its URLs and service endpoints. These URLs can be viewed and edited in enaio® enterprise-manager under Server properties > Category: Services > Gateway.

In multi-server systems, the core services should only be registered on a single server; if not, the URL end points of all core services should be unified manually.

Logging

enaio® gateway logs according to the settings in the application-prod.yml file from the \apps\os_gateway\config\ installation directory.

logging:
  file:
    name: ./../../logs/osgateway.log
  config: ./config/logging.xml
                                                            

You can customize the configuration.

Updates

To update enaio® gateway, updated setups are made available via the service portal.