osp-video
Warning
This feature will be deprecated soon and will probably be removed by the end of 2026. This feature will be replaced by osp-media shortly.
Definition
Difference between TURN and STUN
Note
TURN and STUN are both communication protocols used for real-time communication applications such as Voice over IP (VoIP), video conferencing, and instant messaging. However, they have different functions.
The TURN (Traversal Using Relay NAT) protocol is used to bypass Network Address Translation (NAT) issues. NAT is a network routing technique that allows multiple computers to share a single public IP address. However, NAT can prevent real-time communication because local computer IP addresses are not visible on the Internet. The TURN protocol bypasses this problem by using a relay server that allows clients to communicate directly with each other.
The STUN (Session Traversal Utilities for NAT) protocol is used to determine the IP address and port of a client behind a NAT. The STUN server is used to identify the client’s IP address and port to enable direct communication between clients.
In summary, TURN is used to bypass NAT issues, while STUN is used to determine the IP address and port of a client behind a NAT.
List of configuration files
Filename |
Short description |
Format |
Documentation |
|---|---|---|---|
module.service |
Each service is defined in a separate file and then combined into a unified compose stack file |
yml |
See the Swarm administration or Official documentation |
module.video |
Defines the video module. |
json |
|
owner-server.video |
Defines the connection to a Kurento server. |
json |
|
owner.video |
Defines a stream |
json |
|
controller.video |
A value to command if the stream is enabled or not. |
json |
Environment Variables
All modules env variables
Variable Name |
Default Value |
Usage |
|---|---|---|
PROMETHEUS_PORT |
9100 |
The internal port used for Openmetrics exposition. |
DISPATCHER_HOST |
modules_configuration-dispatcher_main |
The hostname on which the modules can fetch the configuration. |
DISPATCHER_PORT |
10000 |
The port used by the module to listen for configuration request. |
USE_LEGACY_RESTART |
Not set |
When this flag is enabled, the container will terminate itself whenever a restart is needed (for example, after a configuration change). This is the legacy restart (before version 2.1.0). Otherwise, the system will simply restart the process running inside the container. |
CUSTOM_JVM_OPTIONS |
Not set |
Allow to inject JVM options. See Configuration changes for more information. |
ALLOW_VERSION_MISMATCH |
Not set |
Allow to disable the version check when a new configuration is published to a module. By default, a module will not be restarted if its configuration does not match its version. |
Dedicated variables
None