Upgrading OpenVidu Pro



Be careful when upgrading your version of OpenVidu Pro:
  • Never upgrade across multiple major versions: to upgrade from 2.16.0 to 2.18.0, you must first go through 2.17.0.
  • Read carefully the Release Notes of any new version you plan to upgrade. Sometimes there are breaking changes that will require you to update your application.

Migrating from 2.22.0 to 2.23.0 🔗

Depending of the type of deployment you have (AWS or On Premises), you will need to follow one of the following instructions:

Migrating from 2.22.0 to 2.23.0 (AWS Cloudformation - Single master deployment) 🔗


Upgrading process for this kind of deployment is exactly the same as Migrating from 2.22.0 to 2.23.0 OpenVidu Pro (AWS with Cloudformation).

Remember to use OPENVIDU_EDITION=enterprise to run the deployment as OpenVidu enterprise.

Migrating from 2.22.0 to 2.23.0 (On premises - Single master deployment) 🔗


Upgrading process for this kind of deployment is exactly the same as Migrating from 2.22.0 to 2.23.0 OpenVidu Pro (On premises).

Remember to use OPENVIDU_EDITION=enterprise to run the deployment as OpenVidu enterprise.

Migrating from 2.22.0 to 2.23.0 (AWS Cloudformation - High Availability deployment) 🔗


For OpenVidu Enterprise with High Availability, the upgrading process can not be done manually because it would require a lot of different changes on different machines. Instead, OpenVidu Enterprise with High Availability uses a S3 bucket to preserve its configuration and recordings. You can access to it from your CloudFormation panel, at the Resources section.

To upgrade you will need to deploy the newer Cloudformation template of the version you want to deploy. If you want to keep in your new deployment your configuration and recordings, follow from step 1) to 5), Otherwise just start from step 3):


1) Clone your current S3 bucket with all of your data to a new S3 bucket. You do not need any tool installed on your machine. You can open your AWS cloudshell and execute:

aws s3api create-bucket \
    --bucket <new-bucket-v2.23.0> \
    --region <your-region>
aws s3 sync s3://<bucket-v2.22.0> s3://<new-bucket-v2.23.0>

2) Remove from the new bucket the file named .env, located in the root directory of the bucket. This is because we want OpenVidu Enterprise to generate a new one for us.

3) Deploy the Cloudformation template of 2.23.0 from this instructions. If you've followed steps 1 and 2, put at the OpenVidu S3 bucket parameter your new bucket, otherwise just keep the parameter blank.

4) Wait for the deployment to be in healthy state

5) Check your new S3 bucket (or check the new-bucket-v2.23.0 you have created if you followed steps 1 and 2), and move your old configuration to the .env configuration of the new bucket. You can follow this section to see how to change and restart OpenVidu master nodes.



Migrating from 2.21.0 to 2.22.0 🔗

Depending of the type of deployment you have (AWS or On Premises), you will need to follow one of the following instructions:

Migrating from 2.21.0 to 2.22.0 (AWS Cloudformation - Single master deployment) 🔗


Upgrading process for this kind of deployment is exactly the same as Migrating from 2.21.0 to 2.22.0 OpenVidu Pro (AWS with Cloudformation).

Remember to use OPENVIDU_EDITION=enterprise to run the deployment as OpenVidu enterprise.

Migrating from 2.21.0 to 2.22.0 (On premises - Single master deployment) 🔗


Upgrading process for this kind of deployment is exactly the same as Migrating from 2.21.0 to 2.22.0 OpenVidu Pro (On premises).

Remember to use OPENVIDU_EDITION=enterprise to run the deployment as OpenVidu enterprise.

Migrating from 2.21.0 to 2.22.0 (AWS Cloudformation - High Availability deployment) 🔗


For OpenVidu Enterprise with High Availability, the upgrading process can not be done manually because it would require a lot of different changes on different machines. Instead, OpenVidu Enterprise with High Availability uses a S3 bucket to preserve its configuration and recordings. You can access to it from your CloudFormation panel, at the Resources section.

To upgrade you will need to deploy the newer Cloudformation template of the version you want to deploy. If you want to keep in your new deployment your configuration and recordings, follow from step 1) to 5), Otherwise just start from step 3):


1) Clone your current S3 bucket with all of your data to a new S3 bucket. You do not even need any tool installed on your machine. You can open your AWS cloudshell and execute:

aws s3api create-bucket \
    --bucket <new-bucket-v2.22.0> \
    --region <your-region>
aws s3 sync s3://<bucket-v2.21.0> s3://<new-bucket-v2.22.0>

2) Remove from the new bucket the file named .env, located in the root directory of the bucket. This is because we want OpenVidu Enterprise to generate a new one for us.

3) Deploy the Cloudformation template of 2.22.0 from this instructions. If you've followed steps 1 and 2, put at the OpenVidu S3 bucket parameter your new bucket, Otherwise just keep the parameter blank.

4) Wait for the deployment to be in healthy state

5) Check your new S3 bucket (or check the new-bucket-v2.22.0 you have created if you followed steps 1 and 2), and move your old configuration to the .env configuration of the new bucket. You can follow this section to see how to change and restart OpenVidu master nodes.



Migrating from 2.20.0 to 2.21.0 🔗

Depending of the type of deployment you have (AWS or On Premises), you will need to follow one of the following instructions:

Migrating from 2.20.0 to 2.21.0 (AWS Cloudformation - Single master deployment) 🔗


Upgrading process for this kind of deployment is exactly the same as Migrating from 2.20.0 to 2.21.0 OpenVidu Pro (AWS with Cloudformation).

Remember to use OPENVIDU_EDITION=enterprise to run the deployment as OpenVidu enterprise.

Migrating from 2.20.0 to 2.21.0 (On premises - Single master deployment) 🔗


Upgrading process for this kind of deployment is exactly the same as Migrating from 2.20.0 to 2.21.0 OpenVidu Pro (On premises).

Remember to use OPENVIDU_EDITION=enterprise to run the deployment as OpenVidu enterprise.

Migrating from 2.20.0 to 2.21.0 (AWS Cloudformation - High Availability deployment) 🔗


For OpenVidu Enterprise with High Availability, the upgrading process can not be done manually because it would require a lot of different changes on different machines. Instead, OpenVidu Enterprise with High Availability uses a S3 bucket to preserve its configuration and recordings. You can access to it from your CloudFormation panel, at the Resources section.

To upgrade you will need to deploy the newer Cloudformation template of the version you want to deploy. If you want to keep in your new deployment your configuration and recordings, follow from step 1) to 5), Otherwise just start from step 3):


1) Clone your current S3 bucket with all of your data to a new S3 bucket. You do not even need any tool installed on your machine. You can open your AWS cloudshell and execute:

aws s3api create-bucket \
    --bucket <new-bucket-v2.21.0> \
    --region <your-region>
aws s3 sync s3://<bucket-v2.20.0> s3://<new-bucket-v2.21.0>

2) Remove from the new bucket the file named .env, located in the root directory of the bucket. This is because we want OpenVidu Enterprise to generate a new one for us.

3) Deploy the Cloudformation template of 2.21.0 from this instructions. If you've followed steps 1 and 2, put at the OpenVidu S3 bucket parameter your new bucket, Otherwise just keep the parameter blank.

4) Wait for the deployment to be in healthy state

5) Check your new S3 bucket (or check the new-bucket-v2.21.0 you have created if you followed steps 1 and 2), and move your old configuration to the .env configuration of the new bucket. You can follow this section to see how to change and restart OpenVidu master nodes.



General notes when upgrading 🔗

  • Remember to update openvidu-browser library in your clients. Comply version compatibility according to Releases page.
  • In case you have mobile applications: the previous minor version of openvidu-browser is always compatible with the next minor version of openvidu-server. This way you can upgrade your openvidu-server while giving your clients time to update their applications. Applications using the previous and the new version of openvidu-browser can coexist in the new openvidu-server version. For example, if you upgrade openvidu-server to 2.16.0, it will work fine with applications using both openvidu-browser 2.15.0 and 2.16.0. Of course, you must notify your users to update their applications until all of them are using openvidu-browser 2.16.0.