Guidelines for Updating Rocket.Chat

Updating your Rocket.Chat workspace can be a straightforward process, but it's important to follow some key steps to avoid issues. This guide will walk you through the essential preparations and point you to the right resources to ensure a smooth update.

1. Plan your update

Before you begin, take a moment to plan your update. This is the most crucial step for a successful process.

• Check release notes: Each new version of Rocket.Chat comes with new features, bug fixes, or security improvements. Review the release notes for your target version to understand what's new and if there are any breaking changes that might affect your users.

• Select a supported target version: Make sure the version you're updating to is a supported release. You can check the support dates for each version in the Version Durability documentation.

• Check system requirements: Confirm that your hardware meets the system requirements for the new version. This helps prevent performance issues after the update.

• Avoid skipping versions: It's important to update sequentially, especially between major versions. For example, if you are on version 1.x.x and want to update to 4.x.x, you should first update to 2.x.x, then 3.x.x, and finally 4.x.x. Skipping versions can lead to compatibility problems.

2. Back up your data

Always create a full backup of your Rocket.Chat instance before starting an update. This includes both your database and any custom configurations. A backup is your safety net, allowing you to restore your workspace to its previous state if anything goes wrong. For detailed instructions, see the MongoDB Backup and Restore guide.

3. Update Rocket.Chat

Once you've completed your preparations, you can proceed with the update. The specific steps depend on how your workspace is deployed. Follow the guide that matches your deployment method:

• Docker: See the Update Rocket.Chat on Docker guide.

• Kubernetes: Visit the Update Rocket.Chat on Kubernetes guide.

• Podman: Refer to Update Rocket.Chat on Podman.

• Other methods

  • DigitalOcean: Go to Update Rocket.Chat on Digital Ocean.

  • Snaps: See the Update Rocket.Chat on Snaps guide.

  • Ubuntu: Visit the Update Rocket.Chat on Ubuntu guide.

  • CentOS: Go to Update Rocket.Chat on CentOS guide.

  • Debian: Visit the Update Rocket.Chat on Debian guide.

  • Windows: Refer to Update Rocket.Chat on Windows.

4. Update MongoDB

Each Rocket.Chat release has specific supported MongoDB versions. After updating Rocket.Chat, you may also need to update your MongoDB database to ensure compatibility. For instance, you can find the required versions for any release in the Engine versions section of the GitHub release notes:

You can also find detailed information on the supported MongoDB versions for each release in the MongoDB support requirements documentation.

See the following flowchart and the demo for a detailed walkthrough on updating your workspace from older versions (such as 1.x.x with MMAP) to the latest version with the supported MongoDB release:

To update your desktop and mobile apps, refer to Install Desktop & Mobile App.