explore
Resources
more
legal
support
Industries
Truetime Solutions™
Truetime Solutions™
Products
Resources
Technology
Partners
Red5 Pro
Red5 Cloud
Red5 Pro
Red5 Cloud

Red5 Documentation

 

Create Stream Manager 2.0 Instance
Discuss on Slack

Create Stream Manager 2.0 Instance

The Stream Manager 2.0 instance is the cornerstone of Red5 Pro’s architecture, providing a comprehensive solution for managing, orchestrating, and scaling your streaming infrastructure.

Stream Manager 2.0 instance consists of multiple Docker containers (microservices) and runs using Docker Compose.

Create Stream Manager 2.0 Instance

Go to DigitalOcean → Droplets → Create Droplet

  • Select region: Example → Bangalore (blr1) or any preferred DigitalOcean region
  • Choose an image (OS): Ubuntu 22.04 LTS (x64)
  • Choose a plan: We recommend a CPU-Optimized Droplet with at least 4 vCPUs / 8GB RAM
  • Authentication:
    • Select the SSH key you added earlier
    • OR create a new key directly in DigitalOcean if not already added
  • VPC Network: Choose the existing VPC created in previous step (e.g. red5pro-autoscaling-vpc)
  • Firewall: Choose the firewall rule of nodes created earlier (e.g. red5pro-autoscaling-sm-fw)
  • Hostname: Provide a label for the instance, e.g. red5pro-autoscaling-sm-instance
  • Click Create Droplet

Create new DNS record for Stream Manager 2.0 Instance

The default configuration requires creating a DNS record and using an SSL certificate on the Stream Manager 2.0 instance to allow clients to publish and subscribe to WebRTC streams using a browser.

  1. Find the public IPv4 address of your Stream Manager 2.0 Droplet.
  2. Create an A record in your DNS provider to point the DNS name to the public IP address.
red5pro-sm2.example.com - 1.2.3.4

If you choose not to install a domain name and SSL certificate, you will not be able to publish WebRTC streams. However, you will still be able to publish RTMP and RTSP streams and subscribe to WebRTC, RTMP, and RTSP streams. In this case, you will need to use the docker-compose.yml file that does not include SSL certificate configuration. Example: autoscaling-without-ssl

Install Stream Manager 2.0 Instance

  1. Connect to your Droplet via SSH as root user: ssh -i ssh_private_key.pem root@<STREAM_MANAGER_PUBLIC_IP>

  2. Install docker with docker-compose-plugin, follow the public documentation.

  3. Create folder for Stream Manager 2.0 files.

sudo mkdir /usr/local/stream-manager
  1. Pull Stream Manager 2.0 docker-compose examples from our public repository red5pro-stream-manager-2-examples.
git clone https://github.com/red5pro/red5pro-stream-manager-2-examples.git
  1. Choose one deployment type from examples. Example with SSL ceritificate: autoscaling-with-ssl
  2. Copy files from folder autoscaling-with-ssl to the folder /usr/local/stream-manager
sudo cp -r ./red5pro-stream-manager-2-examples/autoscaling-with-ssl/. /usr/local/stream-manager/
  1. Go to the Stream Manager folder
cd /usr/local/stream-manager/
  1. Create folder for SSL certificate
sudo mkdir /usr/local/stream-manager/letsencrypt
  1. Rename docker compose variables file
sudo mv /usr/local/stream-manager/.example.env /usr/local/stream-manager/.env
  1. Make the script update_run.sh executable
sudo chmod +x /usr/local/stream-manager/update_run.sh
  1. Set main Stream Manager 2.0 variables in the .env file: /usr/local/stream-manager/.env
R5AS_AUTH_SECRET=<SECRET_KEY>
R5AS_AUTH_USER=<USER_NAME>
R5AS_AUTH_PASS=<PASSWORD>
R5AS_PROXY_USER=<PROXY_USER>
R5AS_PROXY_PASS=<PROXY_PASSWORD>
R5AS_CLOUD_PLATFORM_TYPE=<PLATFORM_TYPE>
KAFKA_HOST=<PRIVATE_IP>
TRAEFIK_HOST=<DNS_NAME>
TRAEFIK_SSL_EMAIL=<EMAIL>
R5P_LICENSE_KEY=<LICENSE_KEY>
  • R5AS_AUTH_SECRET – Authentication secret used to create and authenticate JWTs. Example: 12345abcd
  • R5AS_AUTH_USER – Authentication user name used to get JWT token. Example: admin
  • R5AS_AUTH_PASS – Authentication user password used to get JWT token. Example: password
  • R5AS_PROXY_USER – Authentication user name used for proxy settings. Example: proxy_user
  • R5AS_PROXY_PASS – Authentication user password used for proxy settings. Example: proxy_password
  • R5AS_CLOUD_PLATFORM_TYPE – Cloud platform type (OCI,AWS,LINODE,DO). Example: DO
  • KAFKA_HOST – Kafka server IP address. In this deployment Kafka server on the Stream Manager 2.0 instance so you will need to set Private IP address of this instance. Example: 10.0.0.10
  • TRAEFIK_HOST – Stream Manager 2.0 domain name: This should be the same domain name you used to create the DNS record. Example: red5pro-sm2.example.com
  • TRAEFIK_SSL_EMAIL – The email address that will be used for the SSL certificate. Example:email@example.com
  • R5P_LICENSE_KEY – Red5 Pro license key which will be using on the Red5 Pro nodes. It should be active Red5 Pro license key, Startup Pro level or higher.
  1. Set Digital Ocean Cloud specific variables in the /usr/local/stream-manager/.env file.
DIGITAL_OCEAN_API_TOKEN=<API_TOKEN>
DIGITAL_OCEAN_SSH_KEY_NAME=<SSH_KEY_NAME>
DIGITAL_OCEAN_PROJECT_NAME=<PROJECT_NAME>

You should have these variables from the previous steps.

  • DIGITAL_OCEAN_API_TOKEN – DigitalOcean API token to authenticate with cloud
  • DIGITAL_OCEAN_SSH_KEY_NAME – SSH key name. It will be using for SSH connect to Red5 Pro nodes
  • DIGITAL_OCEAN_PROJECT_NAME – DigitalOcean project name to create all resource in specified project

Example .env file configuration for DigitalOcean:

R5AS_AUTH_SECRET=12345abcd
R5AS_AUTH_USER=admin
R5AS_AUTH_PASS=password
R5AS_PROXY_USER=proxy_user
R5AS_PROXY_PASS=proxy_password
R5AS_CLOUD_PLATFORM_TYPE=DO
KAFKA_HOST=10.10.0.10
TRAEFIK_HOST=red5pro-sm2.example.com
TRAEFIK_SSL_EMAIL=email@example.com
R5P_LICENSE_KEY=1111-2222-3333-4444
DIGITAL_OCEAN_API_TOKEN=dop_v1_xxxxxxxx
DIGITAL_OCEAN_SSH_KEY_NAME=example-ssh-key-name
DIGITAL_OCEAN_PROJECT_NAME=example-do-project-name
  1. Start/Stop Stream Manager 2.0 – docker compose
  • sudo docker compose up -d – Start the Docker Compose services defined in the docker-compose.yml file in detached mode.
  • sudo docker compose up – Start the Docker Compose services defined in the docker-compose.yml file.
  • sudo docker compose logs -f – Follow the logs of all running services in real-time.
  • sudo docker compose down – Stop and remove all the services defined in the docker-compose.yml file.

To run Docker Compose commands, you should be in the directory containing the docker-compose.yml file. In this case, it is the /usr/local/stream-manager directory.

  1. Create service to allow for ease of startup/shutdown of Stream Manager 2.0, in addition to automatically starting the service on server reboot, you will want to add a systemd unit file for Stream Manager 2.0.
  • Create a service file:
sudo nano /lib/systemd/system/sm.service
  • Add the following content to the service file:
[Unit]
Description=Stream Manager 2.0
Requires=docker.service
After=docker.service
StartLimitIntervalSec=60

[Service]
WorkingDirectory=/usr/local/stream-manager
ExecStart=/usr/bin/docker compose up
ExecStop=/usr/bin/docker compose down
TimeoutStartSec=0
Restart=on-failure
StartLimitBurst=3

[Install]
WantedBy=multi-user.target
  • Start the service:
sudo systemctl start sm.service
  • Stop the service:
sudo systemctl stop sm.service
  • Restart the service:
sudo systemctl restart sm.service
  • Enable the service to start on boot:
sudo systemctl enable sm.service
  • Check the status of the service:
sudo systemctl status sm.service
  1. Verify Stream Manager 2.0

To verify that the Stream Manager 2.0 is running correctly, open your web browser and navigate to the following URL: https://<STREAM_MANAGER_DOMAIN_NAME>. If you are using the Stream Manager 2.0 without an SSL certificate and domain name, use http://<STREAM_MANAGER_IP_ADDRESS> instead.

You should see the Stream Manager 2.0 interface if everything is set up correctly.