Warning

Kurento is a low-level platform to create WebRTC applications from scratch. You will be responsible of managing STUN/TURN servers, networking, scalability, etc. If you are new to WebRTC, we recommend using OpenVidu instead.

OpenVidu is an easier to use, higher-level, Open Source platform based on Kurento.

Welcome to Kurento

Kurento Media Server (KMS) is a multimedia server package that can be used to develop advanced video applications for WebRTC platforms. It is an Open Source project, with source code released under the terms of Apache License Version 2.0 and available on GitHub.

Start here: Introduction to Kurento and Getting Started, and then learn to write Kurento applications with Tutorials.

The main documentation for the project is organized into different sections:

• User Documentation

• Feature Documentation

• Project Documentation

Information about development of Kurento itself is also available:

• Release Notes

• Developer Documentation

User Documentation

• Introduction to Kurento
  • What is Kurento?
  • Why a WebRTC media server?
  • Why Kurento Media Server?
  • Kurento Design Principles
• About OpenVidu
• Getting Started
• Installation Guide
  • Amazon Web Services
  • Docker image
  • Local Installation
  • STUN/TURN server install
  • Check your installation
• Installing Nightly Builds
  • Kurento Media Server
  • Kurento Java Client
  • Kurento JavaScript Client
• Configuration
  • Debug Logging
  • STUN/TURN Server
  • Network Interface
  • WebRTC Bitrate
  • RTP Ports
  • Advanced Settings
• Tutorials
  • Hello World
  • WebRTC Magic Mirror
  • RTP Receiver
  • WebRTC One-To-Many broadcast
  • WebRTC One-To-One video call
  • WebRTC One-To-One video call with recording and filtering
  • WebRTC Many-To-Many video call (Group Call)
  • Media Elements metadata
  • WebRTC Media Player
  • WebRTC outgoing Data Channels
  • WebRTC incoming Data Channel
  • WebRTC recording
  • WebRTC statistics
  • Chroma Filter
  • Crowd Detector Filter
  • Plate Detector Filter
  • Pointer Detector Filter
• Writing Kurento Applications
  • Global Architecture
  • Application Architecture
  • Media Plane
• Writing Kurento Modules
  • Scaffolding and development
  • Installation and usage
  • Examples
• Frequently Asked Questions
  • NAT, ICE, STUN, TURN
  • Kurento in Docker
  • Media Pipeline
• Troubleshooting Issues
  • Media Server Crashes
  • Corrupted Video
  • Other Media Server issues
  • Application Server
  • WebRTC failures
  • Docker issues
  • Element-specific info
  • Browser
• Support
  • Community Support
  • Commercial Support

Feature Documentation

• Client API Reference
  • Java Client
  • JavaScript Client
  • Kurento Js Utils
• Kurento Modules
  • Media Elements and Media Pipelines
  • Endpoints
  • Filters
  • Hubs
  • Example Modules
• Kurento Protocol
  • JSON-RPC message format
  • Kurento API over JSON-RPC
  • Network issues
  • Example: WebRTC in loopback
  • Creating a custom Kurento Client
• Kurento Utils JS
  • Overview
  • How to use it
  • Examples
  • Using data channels
  • Reference documentation
  • Souce code
  • Build for browser
• Securing Kurento Applications
  • Securing Application Servers
  • Securing Kurento Media Server
• Endpoint Events
  • MediaObject events
  • MediaElement events
  • BaseRtpEndpoint events
  • WebRtcEndpoint events
  • Sample sequence of events: WebRtcEndpoint
• NAT Traversal
  • WebRTC with ICE
  • RTP without ICE
• WebRTC Statistics
  • Introduction
  • API description
  • Example
• Debug Logging
  • Default levels
  • Verbose logging
  • Logs Location
  • Log Contents
  • Logging levels and components

Project Documentation

• Kurento Team
• Contribution Guide
  • Did you find a bug?
  • Did you fix a bug?
  • Did you fix whitespace, format code, or make a purely cosmetic patch?
  • Do you intend to add a new feature or change an existing one?
  • Thanks for helping
• Code of Conduct
• Release Notes
  • 7.0.1 (UNRELEASED)
  • 7.0.0 (March 2023)
  • 6.18.0 (September 2022)
  • 6.17.0 (March 2022)
  • 6.16.0 (March 2021)
  • 6.15.0 (November 2020)
  • 6.14.0 (June 2020)
  • 6.13.2 (May 2020)
  • 6.13.0 (December 2019)
  • 6.12.0 (October 2019)
  • 6.11.0 (July 2019)
  • 6.10.0 (Apr 2019)
  • 6.9.0 (Dec 2018)
  • 6.8.1 (Oct 2018)
  • 6.7.2 (May 2018)

Developer Documentation

• Developer Guide
  • Introduction
  • Code repositories
  • Development 101
  • Build from sources
  • Install debug symbols
  • Run and debug with GDB
  • Work on a forked library
  • Create Deb packages
  • Unit Tests
  • How-To
• Continuous Integration
• Release Procedures
  • Introduction
  • Release order
  • FIRST: Open a new Release Process
  • Kurento Media Server
  • Kurento JavaScript client
  • Kurento Java client
  • Docker images
  • Kurento documentation
  • LAST: Close the Release Process
• Security Hardening
  • Hardening validation
  • Hardening in Kurento
  • PIC/PIE in GCC
  • PIC/PIE in CMake
• Writing this documentation
  • Building locally
  • Kurento documentation Style Guide
  • Sphinx documentation generator
  • Read the Docs builds
• Testing
  • E2E Tests
  • Running Java tests
  • Kurento Testing Framework explained

Knowledge Base

• Browser Details
  • Firefox
  • Safari
  • Chrome
  • Command-line
  • WebRTC JavaScript API
  • Browser MTU
  • Bandwidth Estimation
  • Video Encoding
• Congestion Control (RMCAT)
  • Google Congestion Control
  • Meaning of REMB
• H.264 video codec
  • Profiles and Levels
  • NAL Units (NALU)
  • SPS, PPS
  • GStreamer caps
  • GStreamer “codec_data”
• Memory Fragmentation
  • Problem background
  • Solution
  • Using Jemalloc
  • Other suggestions
• MP4 recording format
  • MP4 metadata issues
• NAT Types and NAT Traversal
  • Basic Concepts
  • Types of NAT
  • Types of NAT in the Real World
  • NAT Traversal
• RTP Streaming Commands
  • RTP sender examples
  • RTP receiver examples
  • SRTP examples
  • Additional Notes
• Apple Safari
  • Codec issues
  • HTML policies for video playback
• Self-Signed Certificates
  • Using a local domain
  • Trusting a self-signed certificate
• Glossary

Indices and tables

• Index

• Search Page