Skip to content
This repository has been archived by the owner on Mar 17, 2023. It is now read-only.

Latest commit

 

History

History
131 lines (84 loc) · 5.88 KB

README.md

File metadata and controls

131 lines (84 loc) · 5.88 KB
Raw

Updating Rocket.Chat

Rocket.Chat ships updates frequently to introduce new capabilities, fix bugs, and in some cases address potential security issues. Each of these updates improves Rocket.Chat to provide valuable and secure capabilities to our users.

Workspace admins should monitor new releases and our release notes here to determine whether updates should be applied to their workspace. We recommend that workspaces are kept current with Rocket.Chat releases.

{% hint style="danger" %}

  • For a successful update, you must not skip any major version. That is, say you want to move from version 1.x.x to say 4.x.x, you need to traverse chronologically 1.x.x -> 2.x.x -> 3.x.x -> 4.x.x. Ideally, it's even better to make more granular steps, and not skip more than two minor versions at a time.

  • Upgrading to v5 requires you to be on at least 4.x. {% endhint %}

  • Updating on Docker

  • Updating on Snap

Updating Rocket.Chat on Docker

Provided your workspace was deployed using Docker and Docker Compose, you can update the rocketchat docker image and the version of your Rocket.Chat server to the latest or any version following any of these guides.

{% hint style="success" %} Updating the Rocket.Chat image doesn't affect your data, since it exists in the mongo image. {% endhint %}

{% hint style="info" %} In updating, make sure your MongoDB version is supported with the desired version of Rocket.Chat. See https://github.com/RocketChat/Rocket.Chat/releases {% endhint %}

Updating to Latest

{% hint style="info" %} Make sure the Rocket.Chat image value in the compose file points to the latest tag on the registry. {% endhint %}

You can update directly to the latest version of Rocket.Chat by:

  • Pulling the Rocket.Chat image with the latest tag
docker pull registry.rocket.chat/rocketchat/rocket.chat:latest
  • Stop and restart the existing container
docker-compose stop rocketchat
docker-compose rm rocketchat
docker-compose up -d rocketchat

Updating to a specific version

To update your Rocket.Chat server to a specific version, follow these steps:

  • In your deployment directory, edit your .env or compose.yml file to point to the desired Rocket.Chat version
Changing version in .env

In the .env file, change the RELEASE value to your specified version.

RELEASE=<desired version>

OR

Changing version in compose.yml

In the compose.yml file, change the rocketchat service image value to point to an image in the rocketchat registry image with a tag of your desired version.

services:
  rocketchat:
    image:registry.rocket.chat/rocketchat/rocket.chat:<desired version>
  • Stop and restart the existing rocketchat container by running
docker-compose stop rocketchat
docker-compose rm rocketchat
docker-compose up -d rocketchat

See available-images.md for more on rocketchat docker images.

Updating Rocket.Chat Snap

The Rocket.Chat snap installation puts you on the latest track at the time of installation, which means you will always get the latest releases on that track.

{% hint style="info" %} It is highly advised to back up your data before upgrading. {% endhint %}

Before performing a major version update, it is recommended to check our forum's announcement section: https://forums.rocket.chat/c/announcements/10 as major releases are usually delayed by a couple of weeks. This happens so that feedback is gotten and minor patches are made before pushing out.

You can force an update by running:

sudo snap refresh rocketchat-server

Updating to a major version requires a track change learn more about this in this discussion https://forums.rocket.chat/t/introducing-snap-tracks/5890.

Switching to a particular track is done by executing the following command. You will only receive updates relating to this track.

sudo snap switch rocketchat-server --channel=x.x/stable

Besides the latest track, there is also stable, candidate and edge.

More details on what channels are: https://snapcraft.io/docs/channels

To update to a new version, execute

sudo snap refresh rocketchat-server --channel=x.x.x/stable

{% embed url="https://docs.rocket.chat/getting-support#mongodb-versions" %}

{% content-ref url="../../deploy-rocket.chat/prepare-for-your-rocket.chat-deployment/rapid-deployment-methods/docker-and-docker-compose/docker-containers/mongodb-mmap-to-wiredtiger-migration.md" %} mongodb-mmap-to-wiredtiger-migration.md {% endcontent-ref %}