varunwachaspati / jscommunicator Goto Github PK

Introduction
------------

JSCommunicator is a SIP communication tool developed in HTML and JavaScript.

Please see http://jscommunicator.org for more details about features,
examples, mailing lists and the latest source code.

Requirements
------------

To use JSCommunicator, you require a SIP proxy that supports the
SIP over WebSockets transport.

Only recent versions of the SIP proxies support WebSockets.

  repro from reSIProcate
    http://www.resiprocate.org

  Kamailio
    http://www.kamailio.org

You need to have the following JavaScript libraries available in your
web server or CMS:

  JsSIP (we currently rely on the code from the develop branch)

  jQuery (v1.4 or greater has been tested)

  jQuery UI

  jQuery.i18n.properties

  ArbiterJS (v1.0 has been tested)

  Font Awesome (v4.1 or greater has been tested, earlier versions
    do not work)

All requirements can be easily fetched using either of the following
methods:

 * on a Debian/Ubuntu system, use the "deb-setup.sh" script

 * on other systems, see the "code_grabber" script

Use cases
---------

 * Standalone:
   - include the HTML fragment into a static HTML page,
     possibly using Server Side Includes (SSI).  Make sure the
     page references all the required JavaScript source files.

 * In a CMS, wiki or other publishing platform:
   - include the HTML fragment into a block in a page
     managed by a CMS.  Configure the CMS to send the JavaScript to
     the user or include <script> tags within the content body with
     the phone fragment.

Integration
-----------

ArbiterJS is used to provide a loosely-coupled mechanism for integration
with other JavaScript modules used in the same page/site.

For example, you can:

 * send a signal to JSCommunicator telling it which destination to dial

 * receive notifications from JSCommunicator when calls are made
   or received and use this information to query or update an
   address book or CMS, display related information about the caller
   in another part of the screen, etc

For an example, see the files:

 event-demo.shtml
 event-demo.js

Credits
-------

JSCommunicator is based on the JsSIP library and inspired by the
TryIt.jssip.net and RetroRTC demo applications produced by Versatica.

License
-------

JSCommunicator
http://jscommunicator.org

Copyright (C) 2013-2014  Daniel Pocock http://danielpocock.com

The JavaScript code in this page is free software: you can
redistribute it and/or modify it under the terms of the GNU
General Public License (GNU GPL) as published by the Free Software
Foundation, either version 2 of the License, or (at your option)
any later version.  The code is distributed WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE.  See the GNU GPL for more details.

You may distribute non-source (e.g., minimized or compacted) forms of
that code without the full copy of the GNU GPL normally required
provided you include this license notice and a URL
through which recipients can access the Corresponding Source.