HTML5 Gateways Management¶
The HTML5 Gateways module lists the HTML5 Gateways declared on the platform and lets you add, edit or remove them. An HTML5 Gateway handles the launching of resources reachable through the browser (HTML5 RDP, HTML5 SSH, etc.), relying on an HTTP or WebSocket protocol.
This page is aimed at an administrator or an integrator managing the HTML5 Gateway fleet and its pairing. Assigning an HTML5 Gateway to a site is done from the Sites module, not from this one.
Related tutorial
See Create a pairing token for an Edge Gateway, whose HTML5 Gateway tab details the procedure and the expected form of the certificate CN.
HTML5 Gateway list¶
The module opens on a paginated grid of the declared HTML5 Gateways.
| Column | Description |
|---|---|
| Name | Edge Gateway name, preceded by an icon reflecting its connection state (online, offline, waiting for pairing). |
| URL | Public URL exposed by the Edge Gateway. |
| Description | Free description entered at creation. |
| Sites | Sites the HTML5 Gateway is attached to. |
| Protocol | Protocol used by the Edge Gateway: HTTP or WebSocket. |
| Version | Edge Gateway version. When a master and a backup instance exist, both versions are displayed on two lines. |
Actions available in the toolbar:
| Action | Description |
|---|---|
| + (Add) | Opens the Add HTML5 Gateway window. |
| Edit | Opens the Edit HTML5 Gateway window for the selected Edge Gateway. Also triggered by a double-click. |
| × (Delete) | Deletes the selected Edge Gateways after confirmation. Multiple selection is supported. |
| Search | Filters on a substring of the name, 700 ms after the last keystroke (or immediately with Enter). |
| Pagination | 15, 25 or 50 rows per page. |
Add an HTML5 Gateway¶
The + button opens the Add HTML5 Gateway window.
General information¶
| Field | Description |
|---|---|
| Name | Mandatory, 50 characters at most. Allowed characters: unaccented letters, digits, é, è, à, ô, â, parentheses, space, -, /, . and _. |
| URL | Mandatory. Public URL of the Edge Gateway, as configured in its commonParameters.conf file. |
| Description | Free text. |
| Protocol | Protocol used to talk to the Edge Gateway: HTTP (default value) or WebSocket. |
Paring Token¶
The Create a pairing token checkbox reveals the Paring Token section, hidden by default.
| Field | Description |
|---|---|
| SSL certificate | Gateway certificate to upload. A drop-down list sets the expected format — pkcs12 (default) or pem — and the file selector then only accepts the matching extension, .p12 or .pem. |
| Certificate or private key password | Passphrase of the certificate, where applicable. |
| Pairing key validity period | Date and time beyond which the token can no longer be used. Default: today + 7 days, formatted DD/MM/YYYY HH:MM. |
| IP authorized to use the token | Public IP address the Edge Gateway is allowed to pair from. This is the address as seen by the Mediation Controller: behind a NAT, enter the public address. |
The last two fields are unlocked by the certificate
Pairing key validity period and IP authorized to use the token stay inactive as long as no valid certificate file has been chosen. A file whose extension does not match the selected format therefore leaves them inactive — until a compliant file is provided.
The Validate button saves the Edge Gateway. If saving produces a pairing token, a Paring Token window opens, displays the key and states that it is to be used when installing the gateway. It closes with Close: the key has to be copied from the window.
Edit an HTML5 Gateway¶
Select an Edge Gateway in the list and click the Properties icon (or double-click the row). The Edit HTML5 Gateway window is pre-filled with the current configuration.
The fields are the same as at creation, including the Name, which remains editable. The following rules apply on top:
- Pairing key validity period and IP authorized to use the token can only be changed on an Edge Gateway waiting for pairing;
- an Authentication Token field, read-only, appears on an Edge Gateway waiting for pairing.
Delete an HTML5 Gateway¶
Select one or more Edge Gateways and click the × button. A confirmation is requested. Multiple selection is supported.
| Message | Cause |
|---|---|
| The following HTML5 gateway is currently being used: | The Edge Gateway is attached to one or more sites. It must be detached before deletion. The names concerned follow the message, and a plural variant exists for a multiple deletion. |
| Deletion failed for the following HTML5 gateway: | Deletion failed on the Edge Gateway side. The names in error follow the message. |
Error messages on saving¶
| Message | Cause |
|---|---|
| This gateway already exists. | An HTML5 Gateway already bears that name. |
| Invalid Name | The submitted name was rejected by the server. |
| The CN of the Edge Gateway certificate sent does not match the expected CN | The certificate does not carry the expected CN. The message gives the CN found and the expected one. |
| Invalid certificate or private key password | The supplied passphrase does not open the certificate. |
| The given gateway is unreachable. | The Edge Gateway does not answer; the operation is abandoned. |
| Actions on HTML5 gateways have been disabled. | HTML5 Gateway management is disabled on the platform: no operation succeeds. |