Add an SSL Certificate

This applies to: Visual Data Discovery

Symphony supports SSL certificates so that a secure connection between the Symphony server and the browser can be established. In particular, Symphony supports two common formats for SSL certificates - JKS and PKCS12. For information on creating a keystore or Certificate Signing Request (CSR) for use with Symphony, see https://www.digicert.com/kb/code-signing/java-code-signing-guide.htm.

To enable HTTPS and a secure browser connection, the SSL certificate needs to be copied into the appropriate Symphony directory and the proper parameters be added to the zoomdata.properties configuration file.

Perform the following steps:

  1. From your terminal, SSH to your Symphony server.
  2. Stop Symphony microservices. See Stop Symphony Microservices.
  3. Copy your SSL keystore file to the /etc/zoomdata or /opt/zoomdata/conf directory. To obtain the SSL keystore file, work with your website domain provider.
  4. Use the following command to access and open the zoomdata.properties file: 
    vi /etc/zoomdata/zoomdata.properties

    If the .properties file does not exist, this command will create the file.

  5. Add the following lines to the zoomdata.properties file: 
    server.port=8443
    server.ssl.enabled=true
    server.ssl.key-store=/etc/zoomdata/<keystore_name>     
    server.ssl.key-store-password=<your_keystore_password>

    Replace the placeholders <keystore_name> and <your_keystore_password> with your keystore details. Symphony supports the JKS and PKCS12 certificate formats.

  6. Save and exit the .properties file.
  7. Start Symphony microservices. See Start Symphony Microservices.

After the Symphony server has successfully restarted, open a new browser and check for a secure connection (that is, HTTPS).

Revert the SSL Certificate to the Default Version

If you need to remove the SSL certificate, you must edit the zoomdata.properties file so that the SSL certificate is reverted back to the default version. Edit the zoomdata.properties file as follows:

server.ssl.key-store=/opt/zoomdata/conf/keystore   
keystorePass=changeit

Remember to save and exit the .properties file. Then restart Symphony microservices. See Restart Symphony Microservices.

This reverts the SSL connection to the original self-signed certificate preinstalled with Symphony.