How to Run OpenToonix

This is a step-by-step guide on how to run OpenToonix.

Table of contents (click to open)

• Requirements

• Running OpenToonix

  • Running Using Makefile
  • Running Using Only Necessary Software

Requirements

• Java Version 17 (Opyional when using make) - For running both HTTP and RTMP servers
• Docker - For running OpenToonix in a Docker container
• Node.js Version 22 (Optional when using make) - For running both AMF server and Assets Gateway
• Make (Only for Windows 10/11 and Debian-based Linux distributions) (Optional when using necessary software to run OpenToonix) - For running OpenToonix using the Makefile
• Red5 Server Version 1.3.25 (Optional when using make) - For running RTMP server

Running OpenToonix

Running Using Makefile

For running OpenToonix using the Makefile, follow the following steps:

1. Download the Makefile from this repository.

2. If you haven't installed any of the necessary software for running OpenToonix, run the command make all for installing all necessary software and running OpenToonix and skip the following steps. Otherwise, run any of the following commands to install missing software or skip this step:

   # Install Java
   $ make install-jdk
   
   # Install Node.js
   $ make install-node
   
   # Install Red5 Server
   $ make install-red5

3. Run OpenToonix by running the command make run.

Note: For Debian-based Linux distributions, you will need to have wget installed by running the command sudo apt install wget.

Note: For Windows, you will need to use Windows Subsystem for Linux (WSL), or install make using Chocolatey by running the command choco install make and then run necessary make commands from Git Bash or Cygwin.

Running Using Only Necessary Software

For running OpenToonix using only necessary software, check out the following links for running each component:

• HTTP Server
• AMF Server
• RTMP Server
• Assets Gateway