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

Latest commit

 

History

History
84 lines (41 loc) · 6.07 KB

Deploying_OpenVidu_Pro.md

File metadata and controls

84 lines (41 loc) · 6.07 KB
Raw

Deploying OpenVidu Pro

OpenVidu Pro is available through Amazon Web Services (you will need an AWS account)

1) Steps towards configuration

A) Access to the console of AWS Cloud Formation

Go to CloudFormation

B) Click on Create Stack

C) Option Specify an Amazon S3 template URL with the following URL

https://s3-eu-west-1.amazonaws.com/aws.openvidu.io/cfn-OpenViduServerPro-cluster-latest.yaml

2) Configure your OpenVidu Server Pro

Fill each section of the form with the appropriate values as stated below.

Stack name

The name of your deployment

SSL Certificate Configuration

This is the kind of certificate you will be using in your deployment. Three different options are offered:

  • selfsigned: use a selfsigned certificate. This options is meant for testing and developing environments. Leave the rest of the fields with their default value

  • letsencrypt: use an automatic certificate by Let's Encrypt. This way you don't have to worry about providing your own certificate. You simply have to enter an email account where Let's Encrypt will send its messages, your fully qualified domain name and one AWS Elastic IP for the same region you selected before (allocate one if you don't have it). Of course, you will need to register this Elastic IP in your DNS hosting service and associate it with your fully qualified domain name. Only after this association between the Elastic IP and your domain name is effective your deployment with Let's Encrypt will work fine.

  • owncert: use your own certificate. You must provide one AWS Elastic IP for the same region you selected before (allocate one if you don't have it), and your public certificate and private key, both accessible through uris (an Amazon S3 bucket is the best way to do it). Leave the default values for Email and Fully qualified domain name fields.

OpenVidu Configuration

These fields respectively configure the following system properties of OpenVidu Server: OPENVIDU_SECRET, OPENVIDU_RECORDING_PUBLIC_ACCESS, OPENVIDU_RECORDING_NOTIFICATION, OPENVIDU_STREAMS_VIDEO_MAX_RECV_BANDWIDTH, OPENVIDU_STREAMS_VIDEO_MIN_RECV_BANDWIDTH, OPENVIDU_STREAMS_VIDEO_MAX_SEND_BANDWIDTH, OPENVIDU_STREAMS_VIDEO_MIN_SEND_BANDWIDTH

Openvidu Security Group

These fields allow you to limit the IPs that will be able to connect to OpenVidu Server Pro.

WARNING: be careful when limiting these IP ranges

  • Port 4443 access Range: OpenVidu Server Pro REST API and client access point. This should be set to 0.0.0.0/0 if you want any client to be able to use your deployment
  • Port 3478 access Range: TURN server port. This should be set to 0.0.0.0/0 if you want any client to be able to use your deployment, as you never know which user might need a TURN connection to be able to send and receive media
  • SSH Port access Range can be limited as you want, as it provides SSH access to the server with the proper private key through port 22
  • HTTPS and HTTP (ports 443 and 80) access Range: HTTPS access range will determine the directions able to connect to Kibana dashboard. If you are using Let's Encrypt SSL configuration, set HTTP access range to 0.0.0.0/0, as Let's Encrypt will need to access your server through port 80.
  • UDP Port access Range and TCP Port access Range: limits the clients that will be able to establish TCP and UDP connections to your OpenVidu Server Pro. So again, if you want to provide service to any client these should be set to 0.0.0.0/0
  • MinOpenPort and MaxOpenPort: determine what ports will be available to establish the media connections, so the generous default value is a good choice. If you change the values leaving out any of the previously stated ports, the deployment may fail

Kibana Dashboard Set the user and password for accessing Kibana dashboard.

Other configuration

Choose the size of your instance (see OpenVidu performance FAQ) and a Key Pair (create one if you don't have any).

You are ready to go. Click on Next 🡆 Next 🡆 Create stack to finally deploy your OpenVidu Server Pro.

3) Connecting to your OpenVidu Server Pro

Now you just have to wait until Stack status is set to CREATE_COMPLETE. Then you will have a production-ready setup with all the advanced features provided by OpenVidu Pro.

If status reaches CREATE_FAILED, check out this FAQ.

To connect to OpenVidu Inspector and the Kibana dashboard, simply access Outputs tab. There you will have both URLs to access both services.

To consume OpenVidu REST API, use URL https://OPENVIDUPRO_PUBLIC_IP:4443. For example, in the image above that would be https://ec2-34-246-186-94.eu-west-1.compute.amazonaws.com:4443

Regarding the compatibility of openvidu-browser and server SDKs (REST API, openvidu-java-client, openvidu-node-client), use the same version numbers as stated for openvidu-server in Releases page. For example, for OpenVidu Pro 2.9.0, use the artifact versions indicated in 2.9.0 release table