Statistics
| Branch: | Revision:

janus-gateway @ e67b71f9

Name Size Revision Age Author Comment
  certs ba642639 over 6 years meetecho Restored markdown file describing the certifica...
  conf e67b71f9 over 4 years Lorenzo Miniero Configurable session timeout value
  docs f8a87946 almost 5 years Lorenzo Miniero Bumbed version number and small fixes to the docs
  events 5e1c5670 almost 5 years Lorenzo Miniero Transport-related events
  html e67b71f9 over 4 years Lorenzo Miniero Configurable session timeout value
  plugins 0f1922af over 4 years Chad Phillips Fix typo in textroom plugin log message for lis...
  postprocessing 8485d095 almost 5 years Lorenzo Miniero Added manpages for janus and janus-pp-rec (addr...
  transports 0bd51c56 over 4 years Lorenzo Miniero Add LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT for se...
.editorconfig 85 Bytes 126017e7 about 6 years Saúl Ibarra Corretgé Add .editorconfig file See http://editorconfig...
.gitattributes 15 Bytes f4fb2029 about 7 years Jack Leigh Autotoolize build system Set PLUGINDIR and CON...
.gitignore 688 Bytes 6c173b76 over 5 years Lorenzo Miniero Event handler plugins, first draft
CONTRIBUTING.md 1.4 KB 9355a077 about 6 years Lorenzo Miniero Documentation on how to effectively debug Janus
COPYING 34.8 KB ff428862 almost 5 years Lorenzo Miniero Added license exception to explicitly allow lin...
Makefile.am 12 KB 8485d095 almost 5 years Lorenzo Miniero Added manpages for janus and janus-pp-rec (addr...
README.md 17.2 KB e8dca0bc almost 5 years Lorenzo Miniero Autodetect libsrtp version (1.5.x vs 2.0.x)
apierror.c 1.85 KB 54582a6a about 6 years Lorenzo Miniero Added possibility to limit scope of auth tokens...
apierror.h 3.28 KB 54582a6a about 6 years Lorenzo Miniero Added possibility to limit scope of auth tokens...
auth.c 6.33 KB 54582a6a about 6 years Lorenzo Miniero Added possibility to limit scope of auth tokens...
auth.h 3.37 KB 54582a6a about 6 years Lorenzo Miniero Added possibility to limit scope of auth tokens...
autogen.sh 124 Bytes c5631d7c over 6 years meetecho Fix to autogen.sh after latest pull request #125
bower.json 987 Bytes 2a4ab6cd almost 6 years Ancor Gonzalez Sosa Use the bundled adapter.js instead of an extern...
config.c 12.4 KB 45b70d73 almost 6 years Pierce Lopez config comment stripping was off-by-one, fix an...
config.h 5.8 KB 2512456f almost 6 years Lorenzo Miniero Removed dependency from libini_config, changed ...
configure.ac 21.2 KB e8dca0bc almost 5 years Lorenzo Miniero Autodetect libsrtp version (1.5.x vs 2.0.x)
debug.h 2.87 KB 950786bd almost 6 years Jay Ridgeway remove timed wait, reduce locking, tabs
dtls-bio.c 5.6 KB 9276d9ed about 5 years Lorenzo Miniero Fixed typo
dtls-bio.h 1.28 KB b7de914c about 5 years Lorenzo Miniero Changes to DTLS BIO filter for OpenSSL 1.1.0
dtls.c 35.4 KB 997c72f7 almost 5 years Lorenzo Miniero Shimmed libsrtp2 API
dtls.h 7.85 KB 997c72f7 almost 5 years Lorenzo Miniero Shimmed libsrtp2 API
emacs.el 574 Bytes 392491a8 over 5 years Andreas Girgensohn emacs.el to set the Janus coding style in Emacs
events.c 8.41 KB a906be89 almost 5 years Lorenzo Miniero Unref events queue when shutting down
events.h 1.46 KB d97e0296 over 5 years Lorenzo Miniero Added queue and thread for actually broadcastin...
ice.c 155 KB fe81f5ca over 4 years Lorenzo Miniero Changed default MAX nack queue to 300ms instead...
ice.h 30.8 KB c8ca0de5 almost 5 years Lorenzo Miniero Opaque identifier to contextualise handles
janus-valgrind.supp 1.88 KB f82162cf almost 6 years Lorenzo Miniero Renamed valgrind suppression file (see #429)
janus.1 5.41 KB 8485d095 almost 5 years Lorenzo Miniero Added manpages for janus and janus-pp-rec (addr...
janus.c 180 KB e67b71f9 over 4 years Lorenzo Miniero Configurable session timeout value
janus.ggo 3.17 KB e67b71f9 over 4 years Lorenzo Miniero Configurable session timeout value
janus.h 11.3 KB 13913e3f about 5 years Lorenzo Miniero Fixed small typos in documentation
log.c 5.51 KB cda1586e almost 6 years Lorenzo Miniero Don't close standard file descriptors, let freo...
log.h 1.77 KB 13913e3f about 5 years Lorenzo Miniero Fixed small typos in documentation
mach_gettime.h 2.06 KB 02d70f5d almost 5 years Akagi201 support for old macOS
mainpage.dox 134 KB e67b71f9 over 4 years Lorenzo Miniero Configurable session timeout value
mutex.h 2.34 KB 632d740c almost 6 years Lorenzo Miniero Removed frequent sleeps in HTTP transport module
package.json 620 Bytes 487c006b over 5 years Ferdinand Full Add janus.nojquery.js to files array at the pac...
record.c 7.41 KB df5b546d almost 5 years Lorenzo Miniero Use free instead of g_free for strings allocate...
record.h 3.29 KB ff2d3e1a over 5 years Lorenzo Miniero Support for recording data channel text message...
rtcp.c 28.7 KB ac37a9e3 almost 5 years Lorenzo Miniero Modified RTCP code to recognize XR packets
rtcp.h 13.6 KB ac37a9e3 almost 5 years Lorenzo Miniero Modified RTCP code to recognize XR packets
rtp.c 5.45 KB fefbbe2d almost 5 years Alex Smirnov Fix getting min/max values in janus_rtp_header_...
rtp.h 5.15 KB 1227d096 almost 5 years Emmanuel Riou fix MACOS endianness issue (due to lack of stan...
sctp.c 44.6 KB 8faeb95d about 5 years Lorenzo Miniero Removed some unneeded extra verbosity
sctp.h 7.03 KB 5dc9a256 almost 6 years Lorenzo Miniero Use single GAsyncQueue for incoming/outgoing da...
sdp-utils.c 15.2 KB 749e08e1 about 5 years Lorenzo Miniero Fixed a few leaks
sdp-utils.h 4.78 KB 79a64810 about 5 years Lorenzo Miniero Added fmts list, and fixed datachannels negotia...
sdp.c 38.5 KB 3cc61ddb almost 5 years Lorenzo Miniero Added support for (some) RTP extensions
sdp.h 4.22 KB 13913e3f about 5 years Lorenzo Miniero Fixed small typos in documentation
turnrest.c 8.86 KB e3ec3404 over 5 years Lorenzo Miniero Allow configuration of HTTP method to use to co...
turnrest.h 2.57 KB e3ec3404 over 5 years Lorenzo Miniero Allow configuration of HTTP method to use to co...
utils.c 14.2 KB 5e1c5670 almost 5 years Lorenzo Miniero Transport-related events
utils.h 11.7 KB 5e1c5670 almost 5 years Lorenzo Miniero Transport-related events

Latest revisions

# Date Author Comment
e67b71f9 02/09/2017 04:00 PM Lorenzo Miniero

Configurable session timeout value

fe81f5ca 02/09/2017 02:10 PM Lorenzo Miniero

Changed default MAX nack queue to 300ms instead of 1 second

a83b3717 02/09/2017 12:11 PM Lorenzo Miniero

Updated janus.js documentation

61c1a7fc 02/09/2017 11:58 AM Lorenzo Miniero

Merge branch 'master' of github.com:meetecho/janus-gateway

83b36fcc 02/09/2017 11:57 AM Lorenzo Miniero

Added withCredentials support to XHR requests in janus[.nojquery].js (fixes #742)

c169d7a0 02/08/2017 05:48 PM Lorenzo Miniero

Merge pull request #767 from thehunmonkgroup/fix-textoom-list-log-message

Fix typo in textroom plugin log message for list command

0bd51c56 02/08/2017 11:46 AM Lorenzo Miniero

Add LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT for secure websockets if supported (fixes #768)

0f1922af 02/07/2017 11:39 PM Chad Phillips

Fix typo in textroom plugin log message for list command

24684f54 02/07/2017 06:16 PM Lorenzo Miniero

Added DevDay Napoli presentation to video resources in FAQ

7568e3a8 02/07/2017 06:14 PM Lorenzo Miniero

Added FOSDEM2017 presentation on Event Handlers to video resources in FAQ

View all revisions | View revisions

README


Janus WebRTC Gateway

Janus is an open source, general purpose, WebRTC gateway designed and developed by Meetecho. This version of the gateway can only be installed on Linux systems: next versions will take into account cross compilation on different environments.

For some online demos and documentations, make sure you pay the project website a visit!

To discuss Janus with us and other users, there's a Google Group called meetecho-janus that you can use. If you encounter issues, though, please submit an issue on github instead.

Dependencies

To install it, you'll need to satisfy the following dependencies:

  • Jansson
  • libnice
  • OpenSSL (at least v1.0.1e)
  • libsrtp (at least v1.5 suggested)
  • usrsctp (only needed if you are interested in Data Channels)
  • libmicrohttpd (only needed if you are interested in REST support for the Janus API)
  • libwebsockets (only needed if you are interested in WebSockets support for the Janus API)
  • cmake (only needed if you are interested in WebSockets and/or BoringSSL support, as they make use of it)
  • rabbitmq-c (only needed if you are interested in RabbitMQ support for the Janus API)
  • paho.mqtt.c (only needed if you are interested in MQTT support for the Janus API)
  • libcurl (only needed if you are interested in the TURN REST API support)

A couple of plugins depend on a few more libraries:

  • Sofia-SIP (only needed for the SIP plugin)
  • libopus (only needed for the bridge plugin)
  • libogg (only needed for the voicemail plugin)
  • libcurl (only needed if you are interested in RTSP support in the Streaming plugin or in the sample Event Handler plugin)

Additionally, you'll need the following libraries and tools:

All of those libraries are usually available on most of the most common distributions. Installing these libraries on a recent Fedora, for instance, is very simple:

yum install libmicrohttpd-devel jansson-devel libnice-devel \
   openssl-devel libsrtp-devel sofia-sip-devel glib-devel \
   opus-devel libogg-devel libcurl-devel pkgconfig gengetopt \
   libtool autoconf automake

Notice that you may have to yum install epel-release as well if you're attempting an installation on a CentOS machine instead.

On Ubuntu or Debian, it would require something like this:

aptitude install libmicrohttpd-dev libjansson-dev libnice-dev \
    libssl-dev libsrtp-dev libsofia-sip-ua-dev libglib2.0-dev \
    libopus-dev libogg-dev libcurl4-openssl-dev pkg-config gengetopt \
    libtool automake
  • Note: please notice that libopus may not be available out of the box on Ubuntu or Debian, unless you're using a recent version (e.g., Ubuntu 14.04 LTS). In that case, you'll have to install it manually.

In case you're interested in compiling the sample Event Handler plugin, you'll need to install the development version of libcurl as well (usually libcurl-devel on Fedora/CentOS, libcurl4-openssl-dev on Ubuntu/Debian).

If your distro ships a pre-1.5 version of libsrtp, it may be better to uninstall that version and install 1.5 or 2.0.0 manually. In fact, 1.4.x is known to cause several issues with WebRTC. Installation of version 1.5.4 is quite straightforward:

wget https://github.com/cisco/libsrtp/archive/v1.5.4.tar.gz
tar xfv v1.5.4.tar.gz
cd libsrtp-1.5.4
./configure --prefix=/usr --enable-openssl
make shared_library && sudo make install

The instructions for version 2.0.0 is practically the same:

wget https://github.com/cisco/libsrtp/archive/v2.0.0.tar.gz
tar xfv v2.0.0.tar.gz
cd libsrtp-2.0.0
./configure --prefix=/usr --enable-openssl
make shared_library && sudo make install

The Janus configure script autodetects which one you have installed and links to the correct library automatically, choosing v2.0.0 if both are installed. If you want v1.5.4 to be picked, pass --disable-libsrtp2 when configuring Janus to force it to use the older version instead.

  • Note: when installing libsrtp, no matter which version, you may need to pass --libdir=/usr/lib64 to the configure script if you're installing on a x86_64 distribution.

If you want to make use of BoringSSL instead of OpenSSL (e.g., because you want to take advantage of --enable-dtls-settimeout), you'll have to manually install it to a specific location. Use the following steps:

git clone https://boringssl.googlesource.com/boringssl
cd boringssl
# Don't barf on errors
sed -i s/" -Werror"//g CMakeLists.txt
# Build
mkdir -p build
cd build
cmake -DCMAKE_CXX_FLAGS="-lrt" ..
make
cd ..
# Install
sudo mkdir -p /opt/boringssl
sudo cp -R include /opt/boringssl/
sudo mkdir -p /opt/boringssl/lib
sudo cp build/ssl/libssl.a /opt/boringssl/lib/
sudo cp build/crypto/libcrypto.a /opt/boringssl/lib/

Once the library is installed, you'll have to pass an additional --enable-boringssl flag to the configure script, as by default Janus will be build assuming OpenSSL will be used. If you were using OpenSSL and want to switch to BoringSSL, make sure you also do a make clean in the Janus folder before compiling with the new BoringSSL support.

For what concerns usrsctp, which is needed for Data Channels support, it is usually not available in repositories, so if you're interested in them (support is optional) you'll have to install it manually. It is a pretty easy and standard process:

git clone https://github.com/sctplab/usrsctp
cd usrsctp
./bootstrap
./configure --prefix=/usr && make && sudo make install
  • Note: you may need to pass --libdir=/usr/lib64 to the configure script if you're installing on a x86_64 distribution.

The same applies for libwebsockets, which is needed for the optional WebSockets support. If you're interested in supporting WebSockets to control Janus, as an alternative (or replacement) to the default plain HTTP REST API, you'll have to install it manually:

git clone git://git.libwebsockets.org/libwebsockets
cd libwebsockets
# If you want the stable version of libwebsockets, uncomment the next line
# git checkout v1.5-chrome47-firefox41
mkdir build
cd build
cmake -DCMAKE_INSTALL_PREFIX:PATH=/usr -DCMAKE_C_FLAGS="-fpic" ..
make && sudo make install
  • Note: if libwebsockets.org is unreachable for any reason, replace the first line with this:

    git clone https://github.com/warmcat/libwebsockets.git

The same applies for Eclipse Paho MQTT C client library, which is needed for the optional MQTT support. If you're interested in integrating MQTT queues as an alternative (or replacement) to HTTP and/or WebSockets to control Janus, you can install the latest version with the following steps:

git clone https://github.com/eclipse/paho.mqtt.c.git
cd paho.mqtt.c
make && sudo make install
  • Note: you may want to set up a different install path for the library, to achieve that, replace the last command by 'sudo prefix=/usr make install'.

Finally, the same can be said for rabbitmq-c as well, which is needed for the optional RabbitMQ support. In fact, several different versions of the library can be found, and the versions usually available in most distribution repositories are not up-do-date with respect to the current state of the development. As such, if you're interested in integrating RabbitMQ queues as an alternative (or replacement) to HTTP and/or WebSockets to control Janus, you can install the latest version with the following steps:

git clone https://github.com/alanxz/rabbitmq-c
cd rabbitmq-c
git submodule init
git submodule update
autoreconf -i
./configure --prefix=/usr && make && sudo make install
  • Note: you may need to pass --libdir=/usr/lib64 to the configure script if you're installing on a x86_64 distribution.

To conclude, should you be interested in building the gateway documentation as well, you'll need some additional tools too:

On Fedora:

yum install doxygen graphviz

On Ubuntu/Debian:

aptitude install doxygen graphviz

Compile

Once you have installed all the dependencies, get the code:

git clone https://github.com/meetecho/janus-gateway.git
cd janus-gateway

Then just use:

sh autogen.sh

to generate the configure file. After that, configure and compile as usual to start the whole compilation process:

./configure --prefix=/opt/janus
make
make install

Since Janus requires configuration files for both the core and its modules in order to work, you'll probably also want to install the default configuration files to use, which you can do this way:

make configs

Remember to only do this once, or otherwise a subsequent make configs will overwrite any configuration file you may have modified in the meanwhile.

If you're installed the above libraries but are not interested in Data Channels, WebSockets, MQTT and/or RabbitMQ (or you don't care about any of them), you can disable them when configuring:

./configure --disable-websockets --disable-data-channels --disable-rabbitmq --disable-mqtt

If the libraries are not installed, instead, no need to manually disable them, as the configure script will skip them automatically and disable the related features by itself. A summary of what's going to be built will always appear after you do a configure, allowing you to double check if what you need and don't need is there.

If Doxygen and graphviz are available, the process can also build the documentation for you. By default the compilation process will not try to build the documentation, so if you instead prefer to build it, use the --enable-docs configuration option:

./configure --enable-docs

You can also selectively enable/disable other features (e.g., specific plugins you don't care about, or whether or not you want to build the recordings post-processor). Use the --help option when configuring for more info.

Building on MacOS

While most of the above instructions will work when compiling Janus on MacOS as well, there are a few aspects to highlight when doing that.

First of all, you can use brew to install most of the dependencies:

brew tap homebrew/boneyard
brew install jansson libnice openssl libusrsctp libmicrohttpd libwebsockets cmake rabbitmq-c sofia-sip opus libogg libcurl glib pkg-config gengetopt autoconf automake libtool

For what concerns libsrtp, which needs to be installed manually, just pass /usr/local as a prefix when configuring, and proceed as normal:

[..]
./configure --prefix=/usr/local
[..]

Finally, you may need to provide a custom prefix and PKG_CONFIG_PATH when configuring Janus as well:

./configure --prefix=/usr/local/janus PKG_CONFIG_PATH=/usr/local/opt/openssl/lib/pkgconfig

Everything else works exactly the same way as on Linux.

Configure and start

To start the gateway, you can use the janus executable. There are several things you can configure, either in a configuration file:

<installdir>/etc/janus/janus.cfg

or on the command line:

<installdir>/bin/janus --help

janus 0.2.2

Usage: janus [OPTIONS]...

-h, --help                    Print help and exit
-V, --version                 Print version and exit
-b, --daemon                  Launch Janus in background as a daemon
                              (default=off)
-N, --disable-stdout          Disable stdout based logging  (default=off)
-L, --log-file=path           Log to the specified file (default=stdout only)
-i, --interface=ipaddress     Interface to use (will be the public IP)
-P, --plugins-folder=path     Plugins folder (default=./plugins)
-C, --config=filename         Configuration file to use
-F, --configs-folder=path     Configuration files folder (default=./conf)
-c, --cert-pem=filename       DTLS certificate
-k, --cert-key=filename       DTLS certificate key
-S, --stun-server=filename    STUN server(:port) to use, if needed (e.g.,
                              gateway behind NAT, default=none)
-1, --nat-1-1=ip              Public IP to put in all host candidates,
                              assuming a 1:1 NAT is in place (e.g., Amazon
                              EC2 instances, default=none)
-E, --ice-enforce-list=list   Comma-separated list of the only interfaces to
                              use for ICE gathering; partial strings are
                              supported (e.g., eth0 or eno1,wlan0,
                              default=none)
-X, --ice-ignore-list=list    Comma-separated list of interfaces or IP
                              addresses to ignore for ICE gathering;
                              partial strings are supported (e.g.,
                              vmnet8,192.168.0.1,10.0.0.1 or
                              vmnet,192.168., default=vmnet)
-6, --ipv6-candidates         Whether to enable IPv6 candidates or not
                              (experimental)  (default=off)
-l, --libnice-debug           Whether to enable libnice debugging or not
                              (default=off)
-I, --ice-lite                Whether to enable the ICE Lite mode or not
                              (default=off)
-T, --ice-tcp                 Whether to enable ICE-TCP or not (warning: only
                              works with ICE Lite)
                              (default=off)
-U, --bundle                  Whether to force BUNDLE or not (whether audio,
                              video and data will always be bundled)
                              (default=off)
-u, --rtcp-mux                Whether to force rtcp-mux or not (whether RTP
                              and RTCP will always be muxed)  (default=off)
-q, --max-nack-queue=number   Maximum size of the NACK queue per user for
                              retransmissions
-r, --rtp-port-range=min-max  Port range to use for RTP/RTCP (only available
                              if the installed libnice supports it)
-d, --debug-level=1-7         Debug/logging level (0=disable debugging,
                              7=maximum debug level; default=4)
-D, --debug-timestamps        Enable debug/logging timestamps  (default=off)
-o, --disable-colors          Disable color in the logging  (default=off)
-a, --apisecret=randomstring  API secret all requests need to pass in order
                              to be accepted by Janus (useful when wrapping
                              Janus API requests in a server, none by
                              default)
-A, --token-auth              Enable token-based authentication for all
                              requests  (default=off)
-e, --event-handlers          Enable event handlers  (default=off)

Options passed through the command line have the precedence on those specified in the configuration file. To start the gateway, simply run:

<installdir>/bin/janus

This will start the gateway, and have it look at the configuration file.

As far as transports are concerned (that is, with respect to how you can interact with your Janus instance), using the default configuration files provided after issuing a make configs will result in Janus only enabling an HTTP webserver (port 8088) and a plain WebSocket server (8188), assuming the related transport modules have been compiled, of course. To enable HTTPS or Secure WebSockets support, edit the related transport configuration file accordingly. You can also change the base path that the webserver uses: by default this is /janus, but you can change it to anything you want and with any nesting you want (e.g., /mypath, /my/path, or /my/really/nested/path). This is done to allow you to more easily customize rules in any frontend you may have (e.g., Apache in front of your services). Please notice that the path configuration is not provided for WebSockets, instead, as it is not needed there. The RabbitMQ module, if compiled, is disabled by default, so you'll have to enable it manually if interested in it.

To test whether it's working correctly, you can use the demos provided with this package in the html folder: these are exactly the same demos available online on the project website. Just copy the file it contains in a webserver, or use a userspace webserver to serve the files in the html folder (e.g., with php or python), and open the index.html page in either Chrome or Firefox. A list of demo pages exploiting the different plugins will be available. Remember to edit the transport/port details in the demo JavaScript files if you changed any transport-related configuration from its defaults.

Help us!

Any thought, feedback or (hopefully not!) insult is welcome!

Developed by @meetecho

Also available in: Atom