Custom SSL certificate setup

Configure the server configuration file (server_settings.json)

The configurations are loaded into the application at start-up. Any configuration updated or inserted into the configuration file require the application to be restarted to be processed by the application.

Enable custom SSL certificate usage

Modify the field below within the server configuration file to make the server use the custom SSL certificate at the specified path

    "use_custom_ssl_certificate": false,

Set custom SSL certificate path

Modify the field below within the server configuration file to add the path to the SSL certificate file

  "custom_server_certificate_path": "!!! REPLACE WITH THE PATH TO THE SERVER PRIVATE CERTIFICATE !!!",

Set custom SSL certificate password

Modify the field below within the server configuration file to add the password for the SSL certificate file

  "custom_server_certificate_password": "!!! REPLACE WITH SERVER PRIVATE CERTIFICATE PASSWORD !!!",

Generate self-signed SSL certificate (certificate_generation.json)

To generate an SSL certificate, stop the server, open the certificate_generation.json, configure the fields, and set the generate_key value to true. Afterwards, start the server application to generate the SSL certificate.

{
  "generate_certificate": false,
  "client_certificate_file_name": "!!! REPLACE WITH DESIRED CERTIFICATE FILE NAME !!!",
  "server_certificate_file_name": "!!! REPLACE WITH DESIRED CERTIFICATE FILE NAME !!!",
  "CN": "!!! REPLACE WITH DESIRED CERTIFICATE ISSUER COMMON NAME !!!",
  "DN": "!!! REPLACE WITH DESIRED CERTIFICATE ISSUER DOMAIN NAME !!!",
  "number_of_days_after_which_certificate_expires": 365,
  "key_encryption_strength_in_bits": 2048,
  "private_certificate_password": "!!! REPLACE WITH DESIRED PRIVATE CERTIFICATE PASSWORD !!!"
}

Set the public key certificate file name

The client certificate file is a certificate file that contains only the public key. This certificate can be used to add the SSL certificate to the certificate store, as well as sharing it to other computers without compromising the SSL certificate's security. To set a name, modify the field below in the certificate_generation.json file. The client certificate name must include the file extension too, and the recommended one is .crt.

  "client_certificate_file_name": "client_cert.crt"

Set the private key certificate file name

The server certificate file is a certificate file that contains both the public key and the private key. This certificate is used by the server to encrypt the HTTP connection and it must be set int the **** field, within the server configuration file, if the server needs to be set to run self-signed certificates. To set a name, modify the field below in the certificate_generation.json file. The server certificate name must include the file extension too, and the recommended one is .pfx, because the certificate file contains both the private key and the public key and it is also password protected.

  "server_certificate_file_name": "!!! REPLACE WITH DESIRED CERTIFICATE FILE NAME !!!"

Set the common name and domain name of the certificate

The common name is the origin of the website domain that the certificate applies too (e.g. address = http:\example.com CN = example.com). The domain name is an alternative website domain origin that the certificate applies too (e.g. alternative_address = http:\altrnative.com DN = altrnative.com). To set the the common name and domain name, modify the fields below within the certificate_generation.json file.

  "CN": "!!! REPLACE WITH DESIRED CERTIFICATE ISSUER COMMON NAME !!!",
  "DN": "!!! REPLACE WITH DESIRED CERTIFICATE ISSUER DOMAIN NAME !!!",

Set the number of days until the certificate expires

To set the number of days until the certificate expires, modify the field below within the certificate_generation.json file.

  "number_of_days_after_which_certificate_expires": 365,

Set the key encryption strength in bits

To set the key encryption strength in bits, modify the field below within the certificate_generation.json file.

  "key_encryption_strength_in_bits": 2048,

Set the SSL certificate password

To set the SSL certificate password, modify the field below within the certificate_generation.json file.

  "private_certificate_password": "!!! REPLACE WITH DESIRED PRIVATE CERTIFICATE PASSWORD !!!"