Skip to content

Latest commit

 

History

History
157 lines (79 loc) · 4.54 KB

README.md

File metadata and controls

157 lines (79 loc) · 4.54 KB

Kurento media server Docker image

GitHub release Build Status Docker Pulls

This image contains all the tools and dependencies that are needed to build a Kurento media server from source.

What is Kurento media server?

Kurento is an open source software project providing a platform suitable for creating modular applications with advanced real-time communication capabilities.

Kurento is part of FIWARE. For further information on the relationship of FIWARE and Kurento check the Kurento FIWARE Catalog Entry

Kurento is part of the NUBOMEDIA research initiative.

www.kurento.org

github.com/kurento

Kurento Logo

Documentation

The Kurento project provides detailed documentation including tutorials, installation and development guides. A simplified version of the documentation can be found on readthedocs.org. The Open API specification a.k.a. Kurento Protocol is also available on apiary.io.

How to use this image

Build Kurento-media-server

To build the Kurento-media-server from source, you need to take a few simple steps:

Clone the kurento-omni-build project:

git clone https://github.com/Kurento/kms-omni-build.git

Enter the kurento-omni-build project directory:

cd kms-omni-build/

Update kurento-omni-build project sub modules:

git submodule update --init --recursive
git submodule update --remote

Run the Kurento-media-server build in the Dockerized environment:

docker run --rm -v $(PWD):/.kms -e TYPE=Debug flexconstructor/kms-builder:latest

Run unit tests

docker run --rm -v $(PWD):/.kms -e TYPE=Debug -w /.kms/build_Debug flexconstructor/kms-builder:latest make check

Build submodules:

docker run --rm  -v $(PWD):/.kms  -w /.kms/$(module-name) flexconstructor/kms-builder:latest compile_project.py --base_url https://github.com/Kurento compile 

Environment variables

TYPE

Project build type. CMake accepts the following build types: Debug, Release, RelWithDebInfo. So, for a Release build, you would run TYPE=Release instead of TYPE=Debug.

Default: Debug

GST_DEBUG

Can be used to set the debug level of Kurento logs.

Default: 3,Kurento*:3,kms*:3,sdp*:3,webrtc*:4,*rtpendpoint:4,rtp*handler:4,rtpsynchronizer:4,agnosticbin:4

DEB_BUILD_OPTIONS

You can export is DEB_BUILD_OPTIONS, in order to disable any of unit testing, doc generation (which at the Debian level is mostly nothing, this doesn’t refer to the whole Kurento project documentation site), and binary stripping. For example:


docker run --rm  -v $(PWD):/.kms  -w /.kms/$(module-name) -e DEB_BUILD_OPTIONS="nocheck nodoc nostrip" flexconstructor/kms-builder:latest compile_project.py --base_url https://github.com/Kurento compile 

Image versions

X

Latest version of major X Kurento branch.

X.Y

Latest version of minor X.Y Kurento branch.

X.Y.Z

Latest build of concrete X.Y.Z version of Kurento.

X.Y.Z-rN

Concrete N build of concrete X.Y.Z version of Kurento.

License

Kurento itself is licensed under Apache 2.0 license.

Kurento Docker image is licensed under MIT license.

Issues

We can't notice comments in the DockerHub so don't use them for reporting issue or asking question.

If you have any problems with or questions about this image, please contact us through a GitHub issue.