ws/ExternalRoutedHosts
Collection for specifying DNS names for master site web servers whose requests the web server routes by special scenarios: serving externally hosted static content and proxying http and websocket requests.
TLS certificates are supported, including regular automatic issuance using the LetsEncrypt service.
When creating routes, port type bindings can be used to perform different routing for open ports and ports with TLS certificates. For example, this way all insecure connections can be redirected to the TLS port. This is also available for main domain names and IP addresses, so this functionality is an alternative to the ws microservice 'ports_mode' parameter.
Importantly, for hostnames created this way, certificates are configured individually without binding to the platform main domain tree. However, a fallback mode applies: if no route is found for a specific request arriving at such a hostname, the call is passed to the main platform processing dispatcher. Therefore, to exclude main API processing for a hostname, add the general path '/' at the end of the route list (separately for http and websocket).
Served by the webserver microservice.
Storage type: category.
| Field | Description |
|---|---|
|
Identifier |
|
DNS name or IP address routed to the site server or servers. The main list of system resource and API endpoints is appended to the end of the route list specified for any host. The value '*' can be used for all other domains, including when the Host header is not passed in the request. It is assumed that one entity uniquely describes one host, i.e., one entity is created for a host. However, another arrangement is possible; see the 'priority' field for details. |
|
Record priority for the case of several records bound to the same 'host'. Default 0. If there are several active records for one host, their routes ('routes') are merged into one list in increasing order of the priority field value. And when ACME mode is enabled ('acme_enabled'), a certificate is issued only for one of such records with the same 'host', also guided by the priority value. |
|
Enabled flag. Default |
|
Route list sorted in descending order. An array of objects containing fields:
|
|
Mode for saving client transitions to the ws/ArchiveReferers collection for all record routes (a route can override the mode with the
|
|
Flag for enabling automatic LetsEncrypt certificate issuance. Default false. Makes sense only for domain names. Certificate issuance is performed by the mware microservice. The 'acme.sh' package is used for certificate issuance. Before requesting LetsEncrypt, the domain name availability and its correct addressing to the current site are checked (a secondary check is performed using an external proxy server). The operation is skipped if one of the conditions holds:
|
|
Certificate PEM content. Uploaded by the administrator or filled automatically after certificate issuance. Used when TLS requests arrive. The certificate is applied by ws microservice instances when requests arrive for the configured DNS name. |