Web Server Configuration

These properties configure the behaviour of the Embedded Web Server.

The following properties configure how the Embedded Web Server serves web applications.

Key name in the configuration file: webServerEnabled

Value type: Boolean

Possible values: true or false

Default value: true

Defines whether Iotellect Server's integrated web server is enabled. If it's disabled, all web-based services (Web UI, Web Services, etc.) are not available.

Key name in the configuration file: webServiceEnabled

Value type: Boolean

Possible values: true or false

Default value: true

Defines if the  Iotellect Server Web Service is available for other applications.

Key name in the configuration file: webServiceUseResponseEncoding

Value type: Boolean

Possible values: true or false

Default value: true

When enabled, the Web Service will use URL encoding when responding to SOAP client requests.

Key name in the configuration file: webNonSecureAccessEnabled

Value type: Boolean

Possible values: true or false

Default value: true

Defines if Iotellect Server Web Applications may be accessed using a non-secure HTTP protocol. Normally this option should be disabled to allow only secure HTTPS (SSL-based) access.

Key name in the configuration file: webAppletAndJavaWSEnabled

Value type: Boolean

Possible values: true or false

Default value: false

Defines whether the Client Applet and Java Web Start is available for execution.

Key name in the configuration file: webConnectionType

Value type: Integer

Possible values: Do Not Allow Remote Connections, Any Remote Connections and Only Preconfigured Connections

Default value: Do Not Allow Remote Connections

This option enables and controls operation in Standalone Web Server mode.

Key name in the configuration file: webConnectionPreconfigured

Value type: Data Table

This table defines a list of fixed connections that a Standalone Web Server can establish to external Iotellect servers. The table is only used if Connection Type is set to Only Preconfigured Connections.

Key name in the configuration file: webCustomErrorConnectionMessage

Value type: String

Expression that is evaluated before sending and error message to the login page. Its default table contains one record with three fields: error message (“message” string field), error code (“code” integer field), and connection name (“connectionName” string field). The expression should return error message text. If the expression is not set or results to an empty string then the standard error message will be used.

Key name in the configuration file: webAppsAliases

Value type: String

Possible values: One or more network host names separated by commas

Default value: "" (empty)

Defines the host name(s) by which Iotellect Server Web Applications (Web Admin, Web Service, HTTP Proxy, etc.) can be accessed. This option will work if the specified host names are correctly setup in the DNS. It should be set in addition to configuring your DNS server.

Key name in the configuration file: webAppsSslPort

Value type: Integer

Possible values: 1-65535

Default value: 8443

Defines the port number on which Web Admin application will be available. You can change this option's value to 443 if there are no other web servers listening on this port. 443 is the default HTTPS port number. It is not recommended to use 80 as the value of this option, because 80 is default port number for non-secure HTTP protocol.

Key name in the configuration file: webAppsNonSslPort

Value type: Integer

Possible values: 1-65535

Default value: 8080

Defines the port number on which Iotellect Server Web Applications will be available. You can change this option's value to 80 if there are no other web servers listening on this port. 80 is the default HTTP port number.

Key name in the configuration file: httpSessionTimeout

Value type: Long

Possible values: any

Default value: 3600000

Timeout for HTTP sessions (in milliseconds). Browser sessions without user activity will be maintained until the elapse of the timeout period.

Key name in the configuration file: certificate

Value type: String

Possible values: any

Default value: Default

Alias of an SSL/TLS certificate to use for authentication. The certificate with that alias must exist in the Client Certificate storage of the Iotellect server.

Key name in the configuration file: appReadBufferSize

Value type: Long

Possible values: 1 or more

Default value: 8192

Each connection that is opened up by web server gets associated with a read byte buffer. This attribute controls the size of this buffer. By default this read buffer is sized at 8192 bytes. For lower concurrency, you can increase this to buffer more data. For an extreme amount of keep alive connections, decrease this number or increase your heap size.

Key name in the configuration file: appWriteBufferSize

Value type: Long

Possible values: 1 or more

Default value: 8192

Each connection that is opened up by web server gets associated with a write byte buffer. This attribute controls the size of this buffer. By default this write buffer is sized at 8192 bytes. For low concurrency you can increase this to buffer more response data. For an extreme amount of keep alive connections, decrease this number or increase your heap size. The default value here is pretty low, you should up it if you are not dealing with tens of thousands concurrent connections.

Key name in the configuration file: maxThreads

Value type: Integer

Possible values: 1 or more

Default value: 200

Limits the number of threads the embedded web server can use.

Key name in the configuration file: accessLogEnabled

Value type: Boolean

Possible values: true or false

Default value: false

Activates the writing of access log files for each web application deployed within the web server.

Key name in the configuration file: webSocketCompressionDisabled

Value type: Boolean

Possible values: true or false

Default value: true

Enables Web Socket message compression using the Apache Tomcat Server's built-in extensions.

Key name in the configuration file: enableHttp2

Value type: Boolean

Possible values: true or false

Default value: true

When enabled, the web server uses the HTTP/2 protocol for data transfer. When disabled, the server will use the HTTP/1.1 protocol, potentially resulting in slower load times, but avoiding HTTP/2 protocol errors.

Key name in the configuration file: webAppsWidgetsMode

Value type: Integer

Possible values: 0 (widgets will run on server machine) or 1 (widgets will run on client machine).

Default value: 0

Defines whether the widgets will run on the server or on a client device when Web UI is being operated.

The following properties configure the security settings of the Embedded Web Server.

Defines the duration for which an access token remains valid, ensuring that after the specified period, users must reauthenticate for continued access.

Key name in the configuration file: tokenExpirationPeriod

Value type: Long

Possible values: Any positive length of time.

Default value: 1 Hour

Specifies the timeframe during which a refresh token can be used to obtain new access tokens, enhancing security by limiting the lifespan of refresh tokens.

Key name in the configuration file: refreshTokenExpirationPeriod

Value type: Long

Possible values: Any positive length of time.

Default value: 1 Day

Represents a confidential cryptographic key used for securing communication between the client and the server, safeguarding against unauthorized access and data tampering.

Key name in the configuration file: secretKey

Value type: String

Possible values: Any string.

Default value: Randomly generated.

Initiates the creation of a new secret key, providing a mechanism to regularly refresh cryptographic keys and enhance the overall security posture.

Key name in the configuration file: generateSecretKey

Value type: Boolean

Possible values: True or False.

Default value: True

Specifies a comma-separated list of domains permitted to make cross-origin requests, preventing unauthorized domains from accessing sensitive data and resources through Cross-Origin Resource Sharing (CORS). The star character (*) allows requests from any origin.

Key name in the configuration file: allowedOrigins

Value type: String

Possible values: Comma-separated list of domains.

Default value: Null

Sets the frequency at which the server checks the expiration status of access tokens, ensuring timely identification and revocation of expired tokens for heightened security.

Key name in the configuration file: sessionExpirationCheckPeriod

Value type: Long

Possible values: Any positive length of time.

Default value: 30 Seconds.

Was this page helpful?

Tell us more

Send

Thank you!