Gateway Configuration Options

The following table contains a list of the options that you can add to your gateway.conf file. If you are on a Windows platform, these options correspond to the gateway properties available from the Gateway Services tab of the AcuToWeb control panel.

Option Description
LOGFILE Name of the log file used to record the level of information specified by LOG_LEVEL.

Example: LOGFILE C:\etc\log\gateway.log

LOG_LEVEL The level of logging that is carried out. Permissible values are:
0
Logs startup/connection information, and the loaded gateway configuration.
1
Logs startup/connection information, tracing, and generic error reporting.
2
Logs protocol information, tracing, and protocol error reporting.
4
Logs detailed protocol information, tracing, and specific acuthin message handler information tracing (TC_W_BITMAP, TC_W_ICON…)
8
Logs a hexdump of the transmission data.

To specify more than one level, add the values together.

Example: to log protocol info(4) and transmission data(8), specify LOG_LEVEL 12

USE_SSL Enables to use of SSL when connecting through the gateway

Example: USE_SSL 1

SSL_KEY_FILE Specifies the key file to use when SSL is enabled

Example: SSL_KEY_FILE C:\certs\my-web-key.key

SSL_CRT_FILE Specifies the certificate file to use when SSL is enabled

Example: SSL_CRT_FILE C:\certs\my-web-cert.crt

ACURCL The IP address or host name of the AcuConnect server to be used

Example: ACURCL 127.0.0.1

ACURCL_PORT The port number of the AcuConnect server to be used

Example: ACURCL_PORT 5632

WEBSERVER_PORT The port number that receives HTTP requests and routes them to the AcuToWeb Gateway

Example: WEBSERVER_PORT 3000

TCP_PORT The port that the Gateway is listening on, and uniquely identifies the service

Example: TCP_PORT 8009

PUBLIC_ROOT_DIR The location of the AcuToWeb website files

Example: PUBLIC_ROOT_DIR .\web

FILE_CACHE The location of cached files, which needs to be a writable directory

Example: FILE_CACHE C:\tmp\Web\cache

PATH_FILL_COMBO The location of fillcombo.js: the JavaScript file that is used to populate a drop-down list in the Alias field of the Connection Setup screen.

Example: PATH_FILL_COMBO C:\my-acutoweb\fillcombo.js

The following excerpt of fillcombo.js adds aliases for the Calculator and Tour applications:

[
{"type": "category", "text": "Main Applications"},
{"type": "elem", "text": "Calculator", "value": "calc-alias"},
{"type": "elem", "text": "Tour", "value": "tour-alias"}
]
CUSTOMIZE_CSS The name and file location of a cascading style sheet to be used as a theme when running your application through AcuToWeb. You may specify more than one CUSTOMIZE_CSS option to have multiple style sheets in effect at one time. See Cascading Style Sheets for more information.

Example: CUSTOMIZE_CSS FX=../Web/_CSS/examples/ThemeFX.css

AUTHORIZED_ACCESS When set to 1, the web page prompts for a username and password before trying to connect. These details are verified in the AcuConnect access file.

Example: AUTHORIZED_ACCESS 1

HANDSHAKE_TIMEOUT The interval (in seconds) after which the handshake between the Gateway and AcuConnect will time out. This setting has no effect on other communications. The default value is 3 (seconds). Increase the value if the Gateway and AcuConnect are on different machines and/or there are network issues

Example: HANDSHAKE_TIMEOUT 3

WS_COMPRESSION Enables or disables WebSocket compression

Example: WS_COMPRESSION 1

MAX_PKG_SIZE The maximum size of packages exchanged between the client and the server (in bytes). Messages bigger than the default will be split; messages smaller than the default will be sent immediately without waiting for the buffer to be filled (and therefore this setting would have no effect). The default is 64000 (bytes)

Example: MAX_PKG_SIZE 64000