Upgrading Hipchat Server
This page provides instructions on upgrading Hipchat Server and is intended for IT administrators.
Upgrading
We offer two software update channels: production and Beta. Typically, the production update channel is older than the Beta channel. By default, you get the production channel when you upgrade. You can choose to upgrade to the Beta channel.
You can upgrade Hipchat Server through the Hipchat web app or CLI.
The Hipchat Server upgrade process will also install new OS packages if the release contains any.
This page
Related pages
Upgrading using the web app
Before you start upgrading, back up Hipchat Server and check our end of support announcements for changes that may impact you.
- Open a web browser and browse to the URL for your Hipchat server web app. For example, browse to https://hipchat.yourcompany.com/
- Click the Server admin tab at the top.
- Click the Upgrade tab. A message states whether your system is up to date.
- Optional: If you want to upgrade to the Beta channel, click Beta, then Change upgrade channel.
- Click Upgrade to the latest version.
A message appears informing you Hipchat users will be disconnected temporarily while you upgrade. - Click OK.
Upgrade using the CLI
Before you start upgrading, back up Hipchat Server.
To check whether Hipchat Server is up to date:
hipchat upgrade --check
To view the current upgrade channel:
hipchat upgrade --show
To set the current upgrade channel to the Beta channel:
hipchat upgrade --channel beta
To set the current upgrade channel to the production channel:
hipchat upgrade --channel production
To upgrade using the current channel:
hipchat upgrade --upgrade
Use an outbound proxy server to upgrade
If your company requires use of a Proxy Server for outbound network traffic, you can configure Hipchat Server to check for updates using an outbound proxy server. This step is optional and is not required in order to upgrade.
Enter the following commands in the CLI:
hipchat upgrade --proxy http://user:password@proxy.example.com:portnumber
hipchat upgrade --check
hipchat upgrade --upgrade
If your proxy server does client SSL certificate validation, make sure to install your certificate before running the upgrade.
Verify your upgrade
You should always verify that the upgrade succeeded and that the server is functioning normally after the upgrade finishes. This section gives you a few steps to run once the upgrade is done.
To verify that the upgrade succeeded you need access to the server backend.
Check for the upgrade success message in the logs and validate the new version is up:
grep -A1 "Upgrade Completed Successfully" /var/log/hipchat/update.log
Check that all services are up, running fine, and are monitored:
monit status | grep -A2 "^Process "
Compare the package versions in the manifest to the Debian packages installed to verify that all the new Hipchat packages were installed.
cat /file_store/archive/hipchat.server.manifest | grep hc- | rev | cut -d/ -f1 | rev > /tmp/manifest_packages.txt dpkg -l | grep hc-
- Check that important Hipchat features are working:
- Internal and LDAP login
- Private and room chats with attachments
- Integrations
- Push email notifications
- Directory synchronization
Verify if the FQDN information is still valid
cat /etc/hosts cat /hipchat/config/site.json
Check HipChat clients unable to connect to HipChat Server: Couldn't load HipChat if that is not the case.
Troubleshooting
Sometimes instability in the internet or network connection causes the upgrade check or upgrade process to fails. To retry an upgrade, use the following command:
hipchat upgrade --force-upgrade
You may also want to review the external directory setup (if you have configured this on the instance) after the upgrade to ensure that everything is working as expected.
For more troubleshooting information, see Connectivity Issues When Upgrading and the Hipchat Server Knowledge Base.