Statistics
| Branch: | Revision:

janus-gateway @ f82a8605

Name Size Revision Age Author Comment
  certs ba642639 over 6 years meetecho Restored markdown file describing the certifica...
  conf f82a8605 about 6 years Lorenzo Miniero Configurable logging and daemonization
  docs 0bdf298c about 6 years Lorenzo Miniero Show docs creation/update time in html pages
  html 86239cd6 about 6 years Lorenzo Miniero Allow admin UI to show either raw or prettified...
  plugins 947c8e04 about 6 years Lorenzo Miniero Use TAG_IF for NUTAG_SIPS_URL
  postprocessing ccd7cada about 6 years Lorenzo Miniero Allow for console and/or logfile output (to hoo...
  transports 8a8cd115 about 6 years Florian P. Nierhaus fixup patch according to janus coding style
.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 623 Bytes d0fe7929 over 6 years Lorenzo Miniero Added configuration files to .gitignore
CONTRIBUTING.md 1.4 KB 9355a077 over 6 years Lorenzo Miniero Documentation on how to effectively debug Janus
COPYING 34.3 KB d3c229a7 over 7 years meetecho Changed license from AGPLv3 to GPLv3
Makefile.am 9.51 KB ccd7cada about 6 years Lorenzo Miniero Allow for console and/or logfile output (to hoo...
README.md 13.4 KB f82a8605 about 6 years Lorenzo Miniero Configurable logging and daemonization
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 almost 7 years meetecho Fix to autogen.sh after latest pull request #125
bower.json 1.05 KB 0743efd9 over 6 years Ancor Gonzalez Sosa Prevent bower to use a too recent adapter.js J...
config.c 12.5 KB 2512456f about 6 years Lorenzo Miniero Removed dependency from libini_config, changed ...
config.h 5.8 KB 2512456f about 6 years Lorenzo Miniero Removed dependency from libini_config, changed ...
configure.ac 13.4 KB e27f5612 about 6 years Lorenzo Miniero Updated version in configure.ac
debug.h 2.87 KB 950786bd about 6 years Jay Ridgeway remove timed wait, reduce locking, tabs
dtls-bio.c 4.07 KB a470441d over 6 years Lorenzo Miniero Fixed issue in janus_dtls_bio_filter_ctrl (issu...
dtls-bio.h 1.18 KB cb50c46d over 6 years meetecho Made starting MTU value for the BIO filter conf...
dtls.c 26.2 KB 7cc5c0f3 about 6 years Lorenzo Miniero Fixed parsing of fingerprints so that they can ...
dtls.h 7.45 KB 8b8d2ccd about 6 years Lorenzo Miniero Added some timing related details to the handle...
ice.c 132 KB 44a08169 about 6 years Lorenzo Miniero Don't gather TCP candidates if ICE-TCP support ...
ice.h 30.3 KB a9c14041 about 6 years Lorenzo Miniero Added an UDP server (random port) to act as bla...
janus.c 159 KB f82a8605 about 6 years Lorenzo Miniero Configurable logging and daemonization
janus.ggo 2.79 KB f82a8605 about 6 years Lorenzo Miniero Configurable logging and daemonization
janus.h 9.99 KB 973baaa0 about 6 years Saúl Ibarra Corretgé core: raise default buffer size to 8192
janus.supp 2.85 KB a82a2dd6 about 7 years Philip Withnall build: Add a Valgrind suppressions file This c...
log.c 5.41 KB f82a8605 about 6 years Lorenzo Miniero Configurable logging and daemonization
log.h 1.75 KB f82a8605 about 6 years Lorenzo Miniero Configurable logging and daemonization
mach_gettime.h 2 KB b1c60d34 almost 7 years Yulius Tjahjadi Janus build fixes for OSX
mainpage.dox 113 KB f82a8605 about 6 years Lorenzo Miniero Configurable logging and daemonization
mutex.h 1.61 KB 6dd1c12c about 7 years meetecho Several fixes Improved DTLS timer and retransmi...
record.c 5.68 KB a41aab17 about 6 years Lorenzo Miniero Use janus_get_real_time instead of janus_get_mo...
record.h 2.98 KB 6089eb4e about 6 years Lorenzo Miniero Changed recordings header to contain more info ...
rtcp.c 22.7 KB 11a33f5c over 6 years meetecho Fixed detection of incoming RTCP packets (audio...
rtcp.h 10 KB 11a33f5c over 6 years meetecho Fixed detection of incoming RTCP packets (audio...
rtp.h 1.25 KB b1c60d34 almost 7 years Yulius Tjahjadi Janus build fixes for OSX
sctp.c 45.1 KB 202d13d9 about 6 years Lorenzo Miniero Decreased verbosity for some lines (info to ver...
sctp.h 6.87 KB 5f030f23 over 6 years meetecho Removed unneeded ready flag in the SCTP stack m...
sdp.c 46.8 KB 7cc5c0f3 about 6 years Lorenzo Miniero Fixed parsing of fingerprints so that they can ...
sdp.h 4.54 KB 6dd1c12c about 7 years meetecho Several fixes Improved DTLS timer and retransmi...
turnrest.c 8.59 KB 1f067658 about 6 years Lorenzo Miniero Converted memory allocations to GLib ones, and ...
turnrest.h 2.49 KB 355bacc6 over 6 years meetecho Added support for the TURN REST API (draft-uber...
utils.c 7.49 KB 638695a1 about 6 years Lorenzo Miniero Added fix from #366 and #367 to other plugins a...
utils.h 4.07 KB 8caad21f about 6 years Lorenzo Miniero Add a new helper method to get the system real ...

Latest revisions

# Date Author Comment
f82a8605 11/26/2015 10:52 AM Lorenzo Miniero

Configurable logging and daemonization

c65dc498 11/26/2015 09:35 AM Lorenzo Miniero

Merge pull request #392 from ploxiln/error_string_leakfix

janus_process_error(): use buf on stack

130f7d2a 11/25/2015 08:46 PM Pierce Lopez

janus_process_error(): use buf on stack, avoid leaking allocated error string buf

4e1324c3 11/25/2015 05:04 PM Lorenzo Miniero

Update janus_log_console when initializing

ccd7cada 11/25/2015 04:45 PM Lorenzo Miniero

Allow for console and/or logfile output (to hook to config/cmd line)
Fix undefined reference in post processing due to new log code
A few changes to align the code style to the code base

f5a75a2a 11/25/2015 04:41 PM Lorenzo Miniero

Merge pull request #389 from jayridge/bufferedlogging

janus buffered logging

a68d3d64 11/25/2015 03:01 PM Jay Ridgeway

ditch vasprintf from glib printf routines

86239cd6 11/25/2015 11:59 AM Lorenzo Miniero

Allow admin UI to show either raw or prettified handle info

e36fd727 11/23/2015 02:37 PM Lorenzo Miniero

Use new audio mute functions in videoroom demo

13944742 11/23/2015 01:27 PM Jay Ridgeway

free buffers and synchronization fixes

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)
  • Sofia-SIP
  • 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 support, as libwebsockets makes use of it)
  • rabbitmq-c (only needed if you are interested in RabbitMQ support for the Janus API)

A couple of plugins depend on a few more libraries:

  • libopus (only needed for the bridge plugin)
  • libogg (only needed for the voicemail 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 pkgconfig gengetopt libtool autoconf automake

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 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.

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

wget https://github.com/cisco/libsrtp/archive/v1.5.0.tar.gz
tar xfv v1.5.0.tar.gz
cd libsrtp-1.5.0
./configure --prefix=/usr --enable-openssl
make libsrtp.so && 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.

If you want to make use of BoringSSL instead of OpenSSL for any reason (read here for some background on this), you'll have to manually install a specific version of the library to a specific location. Use the following steps:

git clone https://boringssl.googlesource.com/boringssl
cd boringssl
# We need a specific revision
git checkout 12fe1b25ead258858309d22ffa9e1f9a316358d7
# 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
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

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

To also automatically install the default configuration files to use, also do a:

make configs

If you're not interested in Data Channels, WebSockets and/or RabbitMQ (or you don't care about either of them) you can disable them when configuring:

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

If Doxygen and graphviz are available, the process will also build the documentation for you. If you prefer not to build it, use the --disable-docs configuration option:

./configure --disable-docs

You can also selectively enable/disable other features (e.g., specific plugins you don't care about). Use the --help option when configuring for more info.

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.1.0

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       HTTPS/DTLS certificate
-k, --cert-key=filename       HTTPS/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)

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. By default, only an HTTP webserver is started. To enable HTTPS support, edit the configuration file accordingly or use the command line. The webserver will make use of the same certificates provided for DTLS. 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 has no effect on the WebSockets usage of the API, instead, as it is not needed there.

In the absence of a configuration file, the only mandatory options to specify in the command line are the ones related to the DTLS certificate. A default certificate is provided with this package in the certs folder, which you can use launching the executable with these parameters:

<installdir>/bin/janus -c /path/to/mycert.pem -k /path/to/mycert.key

At this point, the gateway will be listening on the 8088 port (or whatever you changed that to) of your machine. 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, and open the index.html page in either Chrome or Firefox. A list of demo pages exploiting the different plugins will be available.

Help us!

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

Developed by @meetecho

Also available in: Atom