Web Server (ws)
Description
Provides access to the system API over HTTP and WebSocket and serves static files of system and role web applications. For API access, performs authorization and works with HTTP sessions by setting and using cookies. For some endpoints, token authorization is available using the `Authorization: Bearer <integration_point.token_local>` header.
Made redundant and scaled in Active-Active mode.
On role startup, the certificate specified in the *certdir* parameter is checked. If validation fails, the role starts with an immutable certificate. The certificate can be overridden through domain settings.
Code |
|
Operation mode |
|
Redundancy mode |
|
Site types |
|
Layer |
|
Placement |
|
State preservation and recovery on restart |
|
Application |
|
Limitations
-
Present in the initial configuration.
-
Is a border role and uses a TLS certificate for HTTPS and WSS connections.
Parameters
| Name | Type | Default | Description | ||
|---|---|---|---|---|---|
|
|
required |
Name. May consist of Latin letters and digits and must start with a letter. |
||
|
|
required |
Role type. Possible values: |
||
|
|
empty |
Additional role options. Contains a JSON object or list. |
||
|
|
empty |
Role activity flag. When set to false, the role does not participate in validation and is not started. |
||
|
|
empty |
Limit on the number of CPU logical cores used. Default: 0 - unlimited. |
||
|
|
empty |
Default logging level set specifically for the role instance (microservice type). More |
||
|
|
|
Flag allowing parameter differences in roles of the same group. Default: false - not allowed. |
||
|
required |
Role identifier. |
|||
|
|
Flag indicating whether the role is allocated to a separate node. |
|||
|
empty |
Alias of the server directory for storing autoprovision files. |
|||
|
empty |
Alias of the server directory for storing certificates ('server.crt' and 'server.key' files). This parameter is used only when the certificate specified in domain settings is not applied (settings.certificate_pem):
|
|||
|
empty |
Password for decrypting the certificate private key file. Secret: ciphertext when read; the plaintext value is not returned via API and is decrypted by the service when used; a plaintext value can be supplied on input (Encryption and keys). |
|||
|
|
List of HTTP interfaces.
If only the loopback interface 127.0.0.1 is left in the http_ifaces list, this setting can automatically prevent HTTP use by any clients except local ones. |
|||
|
|
List of HTTPS interfaces.
|
|||
|
|
Local web server port for open TCP connections. |
|||
|
|
Local web server port for TLS connections. |
|||
|
empty |
Local web server port for open TCP connections through PROXY PROTOCOL. |
|||
|
empty |
Local web server port for TLS connections through PROXY PROTOCOL. |
|||
|
|
List of monitored virtual interfaces (Virtual IP). If some virtual interfaces are specified in the list, the web server instance monitors their appearance before starting the service.
The target use of a virtual interface assumes the following combination of settings:
|
|||
|
|
Port operation mode.
When redirecting to https, the scheme changes but the host name is preserved if access is by domain name. |
|||
|
empty |
Supported user authorization methods.
Does not affect third-party token authentication. |
|||
|
empty |
TLS port operation mode.
The CA certificate that signed the certificates issued to devices is used for chain validation and can be placed in the :SYNC/common/cacerts folder in PEM format. |
|||
|
true |
Forced spam filter switch for the microservice instance. By default, the spam filter is not blocked but is inactive because master domain settings do not set the limit density. |
|||
|
|
Interval in seconds during which the server does not return 5xx responses to sent requests but instead periodically retries the request. |
|||
|
|
Maximum number of simultaneously executed "rest" WebSocket requests to the domain center of one domain from a microservice instance. |
|||
|
|
Maximum number of simultaneously executed "rest" requests to the domain center from one WebSocket connection. |
|||
|
empty |
Request servicing mode
|
|||
|
|
Access to dmsquery requests (websocket token and user API): an arbitrary
Integration channel roles include the roles of the bound user. |
|||
|
List of keys for building various web server groups and specifying lists as access points for product layer microservices and for selecting the web server to which VCS connects. |
||||
|
0 |
Priority number when building web server lists and specifying them as access points for product layer microservices and selecting the web server to which VCS connects. |
|||
|
|
Switch for special WebSocket logging level configuration.
|
|||
|
|
WebSocket protocol message logging level.
|
|||
|
empty |
Alias of the server directory with web server static resources. |
|||
|
empty |
List of additional static headers added to every HTTP(S) response. |
|||
|
empty |
Web application metadata set suffix: when set to |
Configuration example
Configuration management is performed in an application available to master domain administrators. The application hides the full configuration content, but it is still available through the API.
The configuration contains a section describing all instances of all roles. Parameters are defined for each specific role instance.
{
"name": "ws1",
"roletype": "ws",
"roleid": 11230,
"certdir": "alias://paths/default_certdir",
"keypass": "eb9c4458016d3f1e378d02004c4f4f50",
"httpport": 80,
"httpsport": 443,
"http_ifaces": ["eth0", "eth2"],
"https_ifaces": [],
"ports_mode": "both",
"service_mode": "both",
"websock_debug_level_enabled": 1,
"websock_debug_level": 2
}