SSL certificate deployment

Configure an SSL certificate for HelpChat so that all messages, files and other data exchanged between clients and the server are protected by SSL encryption.

Info

HelpChat was originally designed for LAN deployment, physically isolated from the public internet to keep data secure. It also fully supports deployment on public servers, with SSL encryption protecting all communication links.

1. Prepare a domain and certificate

Choose a domain or subdomain, for example www.helpchat.com, then buy a certificate from an SSL certificate vendor.

Name the generated certificate file and key file as follows:

text

cert.crt
key.pem

2. Place the certificate files

Put both files in the ssl/ subdirectory under the server root directory:

text

HelpChat Server/
└── ssl/
    ├── cert.crt
    └── key.pem

3. Edit the configuration file

Edit config/server.ini and change two parameters in the [server] section:

config/server.ini

[server]
usessl  = 1
svraddr = www.testname.com

usessl: set to 1 to enable it once the SSL certificate is in place.

svraddr: the domain name clients use to sign in to the server. Enter only the full domain name, without the https:// prefix.

Warning

svraddr is what makes push notifications reach mobile clients. The hckernel process uses this address to connect locally to the hclogin process to send push notifications. The default value is 127.0.0.1; after configuring an SSL certificate you must change it to the correct domain name. This behavior applies from version 11.1.5.

4. Notes

Danger

Once an SSL certificate is configured, all HelpChat clients can sign in only with the domain name bound to the SSL certificate as the server address. Any other address will fail to sign in.

If your website also uses HelpChat online customer service, make sure the SSL certificate configured here and the one for the website domain are the same certificate.