forked from ngti/jinglenodes
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.md.orig
106 lines (74 loc) · 4.23 KB
/
README.md.orig
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
Jingle Nodes Relay
==================
[](http://blog.jinglenodes.org)
What is Jingle Nodes?
---------------------
Jingle Nodes is an XMPP Extension that enable users to share and discover P2P Media Relays that can be used to enable Voice and Video Chat via Jingle.
It is the simplest solution to communicate *freely* with your friends without being attached to a closed service providers like Skype, Telecom nor SIP Provider!
Jingle Nodes comes in place with the goal of making easy to setup relay for Jingle Clients, making the task of setting them up close to trivial. It also allow every buddy in your contact list to be a potential Node, enabling also P2P sharing.
Communication Sharing made simple!
XEP Location: [Jingle Nodes XEP](http://xmpp.org/extensions/xep-0278.html)
Technically, Jingle Nodes is a Standard Jingle RTP Server/Proxy, intend to provide easy to use Relay that can be used in ICE-UDP and also on RAW-UDP Jingle Clients.
Why Jingle Nodes?
-----------------
In the creation of the very first version of the Jingle Protocol, one of the main goals was to achieve a P2P enable protocol, that would depend on XMPP for routing, but would be also able to negotiate sessions and exchange content without main proxy servers like present SIP deployments.
After 5 years we still don't have any massive deployments containing and fully supported the current specifications, and even the closer to the specification ones are suffering when P2P is not possible and relay is required and there is no available ones.
That is the problem Jingle Nodes proposes to solve.
[](http://www.gliffy.com/pubdoc/1765239/L.jpg)
This project is sponsored by NLnet Foundation:
[](http://www.nlnet.nl)
The Jingle Nodes Logo is a generous contribution from:
[Fernando Lins - Graphic and Interface Designer](http://fernandolins.net)
Installation
------------
This project can be downloaded from this page as git project and must be compiled with [rebar](git://github.com/basho/rebar.git) and [Erlang/OTP](http://erlang.org). The commands perform:
```
git clone git://github.com/bosqueviejo/jinglenodes.git
cd jinglenodes
rebar get-deps compile generate
```
In the ```rel/jinglenodes``` directory should be the embeded generation. Can be packed as zip or tar file to put on production.
Configuration
-------------
The configuration file is in ```rel/jinglenodes/etc/app.config```, you need to configure the following sections:
```erlang
{jn_component, [
{port_range, {10000, 50000}},
{throttle, {10, 60}},
{public_ip, "88.88.88.88"},
{handler, jingle_handler},
{broadcast, "events.server.com"},
{discount, 60}
]},
```
Note that the info related to [ecomponent](https://github.com/pepeyuilop/ecomponent) can be reviewed in it own site.
The params means:
<<<<<<< HEAD
Compiling and Installing
XML parsing library (REQUIRED)
Tested libraries are:
. Expat: recommended. Tested: 2.0.1
. LibXML2: only experimental support.
o OpenSSL (optional)
It's the only TLS engine supported for now.
. Tested version: 0.9.8e
o zlib (optional)
It's the only compression engine supported for now.
. Tested version: 1.2.3
Suggested Library Install
build-essential make autoconf libxml2 libxml2-dev zlib1g zlib1g-dev libssl-dev libcrypto++ libcrypto++-dev libexpat1-dev
Building
rebar clean
rebar get-deps
rebar compile
rebar generate
=======
* ```port_range```, the range for select ports (could be from 1024 to 65535).
* ```throttle```, has two values:
* ```max_per_period``` (the first) is the time (in seconds) between checks relay channels.
* ```period_seconds``` (the second) is the timeout (in seconds) for channels.
* ```public_ip```, is the host as an IP in the IQ request channel result.
* ```handler```, the handler to be used. The fix value in this moment is ```jingle_handler```.
* ```broadcast```, the server to send the notify events.
* ```discount```, reduce the notification time of call duration.
>>>>>>> 53d4a096c33b330fe5a017b24044861ef83b3a57