Devolutions Gateway configuration with Devolutions Server

This topic describes how to configure Devolutions Server to connect with Devolutions Gateway. There are two ways to install a Devolutions Gateway: the Side-by-side Installation and the Standalone Installation.

Many gateways can be used by Devolutions Server, but only one Devolutions Gateway can be installed on a machine.

If your clients fail to connect with Devolutions Gateway, ensure the certificate contains the entire chain. This certificate chain includes any intermediate certificates. For example:Root Certificate Authority – Secure Certificate Authority – Purchased XYZ Certificate

Differences between Side-by-side and Standalone installation

The Side-by-side Installation will be used if you need to install Devolutions Gateway on the same machine where Devolutions Server is hosted. It is a simplified installation process that will automatically configure the new Devolutions Gateway with information from the Devolutions Server instance (access URI and public key).

To install Devolutions Gateway on another machine than the one where Devolutions Server is hosted, you need to follow the Standalone Installation process. The procedure is similar, but you will need to provide more information about your Devolutions Server instance to complete it.

Side-by-side Installation

To set up a free Devolutions Gateway, it must be installed using the Side-by-side configuration. It creates a gateway capable of handling up to 5 concurrent sessions.

This method supports more sessions if there is an available Devolutions Gateway license(s). This installation process is the easier of the two. However, this method is recommended for simpler network layouts.

  1. From the Devolutions Server Console, click on the Companions tab.

    Companions tab
    Companions tab

  2. In the Devolutions Gateway section, click on Install.

  3. Choose Side-by-side Installation.

    Side-by-side
    Side-by-side

    It is possible to download an .msi file to install Devolutions Gateway on an offline Devolutions Server.

  4. If default values do not work for your environment, enter the desired settings.

    1. HTTP Listener: HTTP(s) port to reach the Gateway. (7171 is default)
    2. TCP Listener: port used for the RDP sessions. (8181 is default)
  5. Click OK.

    OK Button
    OK Button

  6. Go to the Devolutions Server web interface, connect with an administrator account.

  7. Go to Administration – Devolutions Gateway.

    Devolutions Gateway
    Devolutions Gateway

  8. Click on the Ping button for the desired gateway in the list to see if a connection can successfully be made. If the page was already open, refresh it first.

    Ping
    Ping

Standalone Installation

The Standalone method allows Devolutions Gateway to be installed on a separate server than Devolutions Server. It could be for performance purposes or access networks that Devolutions Server cannot access.

The Devolutions Server Console must be installed on the server on which Devolutions Gateway will be installed.

  1. From the Devolutions Server Console, click on the Companions tab.

    Companions Tab
    Companions Tab

  2. In the Devolutions Gateway section, click on Install.

  3. Choose Standalone Installation.

    Standalone
    Standalone

  4. Choose between Download version & Install from msi file.

    It is possible to download an .msi file to install Devolutions Gateway on an offline Devolutions Server.

  5. Click Next.

    Download version or msi file
    Download version or msi file

  6. Enter the Access URI information, for example https://gateway.example.com.

    Listeners
    Listeners

  7. Choose the Devolutions Gateway Listeners ports (by default they are 7171 and 8181).

    1. If HTTPS is chosen instead of HTTP in the step above, the Certificate Configuration will be needed.
    2. Certificate file: Needs to be a full chain certificate (.pfx, .p12, .pem, .crt).
    3. Certificate password: Only needed if a .pfx or .p12 certificate was used.
    4. Private key file: Only needed if a .pem or .crt was used as a certificate.

    Do not share the private key with other users, as it can be used to decrypt the communication between a user and Devolutions Gateway. Only the public key should be shared.

  8. Click Next.

  9. Choose between:

    • Use public key from Devolutions Server instance 'Devolutions Server': this option is used if the installed Devolutions Gateway is on the same server as the Devolutions Server;
    • From file: If installing Devolutions Gateway on another computer, download the public key from the Devolutions Server you want to pair with that Devolutions Gateway. It is located under Administration – Devolutions Gateway.
      Download public key
      Download public key
  10. Click Next.

    Key Pair Configuration
    Key Pair Configuration

  11. Click Install.

    Summary
    Summary

  12. Click Close.

    Installation Summary
    Installation Summary

  13. On the Devolutions Server web interface, connect with an administrator account.

  14. Go to Administration – Devolutions Gateway.

    Devolutions Gateway
    Devolutions Gateway

  15. Click on the Add button on the top right corner.

    Add Button
    Add Button

  16. Enter the following information.

    1. Name: Name of the gateway that will be displayed in Remote Desktop Manager.
    2. Description: Description of the gateway.
    3. Set as default: If enabled, this gateway will be selected by default when configuring Remote Desktop Manager.
    4. Devolutions Gateway URL: The Devolutions Gateway URL and Port that Devolutions Server will connect to, for example: https://gateway.example.com:7171.
    5. TCP Listening Port: Set the port with the same TCP port value configured in the Devolutions Server Console.
  17. Click on Save.

    Devolutions Gateway Information
    Devolutions Gateway Information

The gateway should now be visible in the list. It is possible to verify the status of the gateway with the Ping button.

Ping
Ping

Give us Feedback