Prev Next

Using HTTPS (SSL)

In order for the Pro Cloud Server to use an HTTPS (SSL) port a valid SSL certificate is required. Having obtained a valid certificate, the certificate file and your private key file need to be concatenated to create a server.pem file. The server.pem file must then be added to the Pro Cloud Server installation's 'Service' folder (e.g. C:\Program Files (x86)\Sparx Systems\Pro Cloud Server\Service).

Configuring the Pro Cloud Server to use HTTPS

Step

Description

See also

1

Obtain a signed SSL certificate. For the Pro Cloud Server you will require the certificate file and your private key file (both should be base64 encoded).

Note, this is the same process used when obtaining an SSL certificate for a website which uses HTTPS. There are many ways to achieve this, and the specific details are beyond the scope of this documentation.

In general, it is preferred to use a certificate that has been signed by a globally trusted root Certificate Authority (CA). Some certificate authorities provide a service of signing SSL certificates for a fee; there are also free options available such as 'Let's Encrypt'.

In some cases (e.g. for testing purposes, or for setups that are entirely within a closed network) you may consider using a self-signed certificate, or create your own Certificate Authority and use this to sign your certificate/s. See the Self-Signed SSL Certificates and Using Your Own Certificate Authority (CA)topics for details.

Self-Signed SSL Certificates Using Your Own Certificate Authority (CA)

2

Create a server.pem file by concatenating your certificate file and private key file. For example, use the following command:

Windows: copy /b cloud.mycompany.com.crt+cloud.mycompany.com.key server.pem

Linux: cat cloud.mycompany.com.crt cloud.mycompany.com.key > server.pem

3

Copy the server.pem to the Pro Cloud Server installation's 'Service' folder (e.g. C:\Program Files (x86)\Sparx Systems\Pro Cloud Server\Service).

4

If you have not already, configure a Pro Cloud Server port which has the protocol set to HTTPS (for a new installation Port 805 is set to use HTTPS by default). See the Add a Port Definition topic for details.

Add a Port Definition

5

Restart the Pro Cloud Server service.

6

Check the Pro Cloud Server log file (e.g. C:\Program Files (x86)\Sparx Systems\Pro Cloud Server\Service\Logs\SSProCloudServerLog-1.log) and confirm that the port opened successfully. For example:

2022-01-01 15:00:03 [INFO]:  Thread X  SUCCESS Bound and listening on soap port 805 (https)

Learn More