Upgrade the server

Steps for updating to a newer version within the HelpChat Server 13 series (for example, 13.0 to 13.1).

Recommended: online upgrade

If the server is connected to the internet, the simplest way is to upgrade from the admin console. Click "Help and support" in the lower-left corner, then "Online upgrade". No manual steps are needed.

The manual update steps are below.

Windows Server

Warning

Stop the HelpChat Server service before updating.

Back up the current files

Back up these two files so you can roll back if needed:

text

helpchatsvr.exe
bin\hcupdater.exe

Replace the files

Copy these two files from the new version into the installation directory, overwriting the old files:

text

helpchatsvr.exe       → root of the installation directory
bin\hcupdater.exe     → bin subdirectory of the installation directory

Start and verify

Start HelpChat Server, then sign in from a client and confirm that everything works.

Linux Server

Warning

Stop the HelpChat Server service before updating.

The steps below assume the installation directory is /opt/helpchat_server/. Replace it with your actual path.

Back up the current files

bash

cp /opt/helpchat_server/helpchatsvr     /opt/helpchat_server/helpchatsvr.bak
cp /opt/helpchat_server/bin/hcupdater   /opt/helpchat_server/bin/hcupdater.bak

Replace the files

bash

cp helpchatsvr   /opt/helpchat_server/
cp bin/hcupdater /opt/helpchat_server/bin/

chmod +x /opt/helpchat_server/helpchatsvr
chmod +x /opt/helpchat_server/bin/hcupdater

Start and verify

bash

sudo ./helpchatsvr start

Notes

The configuration file helpchatsvr.ini does not need changes; the new version is compatible with it. Data directories such as imdata and public need no action.

helpchat_office.db and helpchat_market.db in the imdata directory are database files. Never overwrite or delete them, and back them up regularly.

Rolling back

If problems appear after the update, restore the backup files and restart the service:

bash

cp /opt/helpchat_server/helpchatsvr.bak     /opt/helpchat_server/helpchatsvr
cp /opt/helpchat_server/bin/hcupdater.bak   /opt/helpchat_server/bin/hcupdater