Migrate from HipChat Server to HipChat Data Center

If you previously used HipChat Server, and are ready to migrate to a HipChat Data Center deployment, use this guide and the HipChat Data Center deployment guides to set up your new deployment and migrate users.

On this page:

A note for large HipChat Server deployments

If you are migrating from a HipChat Server instance with more than 5 million messages, let us know here so we can help you plan your migration.

If your HipChat Server instance contains fewer than 5 million messages, carry on!

How do I find out how many messages I have? (Click for instructions)

HipChat Server tracks how many messages have been sent on your deployment on the Status page in the Server admin section. However, retention settings and message deletion can make this number inaccurate.

To get an accurate message count, connect to the HipChat Server deployment and run a script.

  1. Connect to the HipChat Server deployment (with the admin account), using your terminal or shell.
  2. Copy the script below to the server.
    You can either create the file locally as message_counter.sh and then use scp to copy the file to the HipChat Server machine, or you can create a new file directly on the HipChat Server machine and then paste the script contents into the file.

    # This script counts the message entries directly from the database
    # 06-21-17
    # Must run inside HipChat Server command line interface
    counts=$(curl 'localhost:9200/_cat/indices?v' | awk 'FNR > 1 {print $6}')
    for number in $counts
    echo "Total messages: $total"
  3. Once you have the script on the server, make it executable using the following command:
    chmod + x message_counter . sh

  4. Finally, execute (run) the script using the following command:
    ./message_counter .s h

The script runs and returns the number of messages in your deployment. If it's over 5 million, contact Support.

Before you begin

Hold your horses!  Before you do anything:

  1. Read the architecture information, and decide how you will deploy HipChat Data Center.
    HipChat Data Center is currently available for deployment on VMware and AWS only, however you can now deploy it either with a single HipChat node, or with a three-HipChat-node cluster for scale or higher availability. Regardless of how many HipChat nodes you deploy, you also need to provide the external data stores for the service and manage SSL termination within your network.
  2. Plan your deployment. 
    Use the information in the HipChat Data Center system requirements to determine what component servers and services you need in order to deploy.
    (warning) The requirements guide also includes important sizing information, so don't skip it!
  3. Read the full deployment guide to understand the deployment process, and check the release notes for your destination version. 
    The release notes will alert you if you need to do anything special before you deploy.
  4. Deploy and test on an evaluation instance first.
    We don't need to tell you this, it's just a good practice. 

  5. Deploy your production HipChat Data Center cluster.
    Head's up, you can only import an archive into an empty cluster. You should plan to take notes during your evaluation, and either reinstall using those notes, or use the snapshots tip below to reset your cluster. 

    A Pro Tip if you're comfortable using snapshots...

    If you want to reuse a test cluster for production, make sure that it is provisioned appropriately for your final deployment scale, and take a snapshot of all nodes, services, and data stores in their empty state.

    Because you can only import a HipChat data archive into an empty cluster, this will help you restore the cluster to a good state to run the import and become a production instance.

  6. Schedule an outage or maintenance window for your deployment. 
    Although we designed the upgrade process to minimize downtime for your deployment, you should do this just in case.

Deploy a HipChat Data Center cluster

  1. Choose the Deployment option that best serves your organization, and deploy the required components.
  2. Configure the components using the instructions in the Configuration requirements for HipChat Data Center.
  3. Finally, Deploy HipChat Data Center to the prepared cluster, and configure your instance's optional features.

Be sure to verify that the deployment is up and running, and that the database and file store are working correctly before proceeding.

Export your HipChat Server data

  1. Export the data from your production HipChat Server instance.

  2. Make a list of the integrations and API tokens on your old HipChat Server instance. (You'll re-enable and reconfigure them on the new HipChat Data Center instance once it's set up.)

    An exported HipChat archive does not include the integrations on your HipChat Server instance, emoticons, any passwords or API tokens, any users' room auto-join information, or server settings.

Prepare the HipChat Data Center deployment

  1. Verify that the destination HipChat Data Center cluster is up and functioning correctly. All external data stores must be configured before you import your data archive.
  2. Run the sudo dont-blame-hipchat command. (This allows you to write to the file store in the next step.)
  3. Copy the data archive file to the NFS host and put it in the /file_store/shared directory .

Import the archive

  1. Import the data archive into your HipChat Data Center deployment.
  2. Restore the integrations (now called add-ons) and API tokens that you were using in HipChat Server.

Connect to a external authentication sources or import users

If your organization uses an external authentication source (such as Active Directory, LDAP, Crowd, or a SAML identity provider such as Okta or OneLogin), connect your new HipChat Data Center instance to that source or provider after you import the data from your old server.

See the instructions for external directories (LDAP, Active Directory, Crowd and JIRA) and SAML providers for more details.

Verify the deployment

Test your deployment to make sure that all of the functionality is working as intended. You should confirm that:

  • users can log in using your organization's authentication source
  • users can view (and if enabled, edit) their profile information
  • users can send and receive messages in chat rooms
  • emoticons are working in chat messages
  • any integrations that are enabled are working
  • users can upload and view files
  • users can search for messages in their chat history
  • if enabled, users can send and receive 1-to-1 chats
  • if enabled, video chat is working

Notify and let your users in

Once you've confirmed that the new HipChat Data Center deployment is up and running, tell your users and let them log in!  Woohoo!

Last modified on Oct 19, 2017

Was this helpful?

Provide feedback about this article

Not finding the help you need?

Ask the community

Powered by Confluence and Scroll Viewport.