~ubuntu-branches/ubuntu/saucy/resiprocate/saucy-proposed

« back to all changes in this revision

Viewing changes to apps/sipdial/README.txt

  • Committer: Package Import Robot
  • Author(s): Daniel Pocock
  • Date: 2012-05-17 19:29:59 UTC
  • Revision ID: package-import@ubuntu.com-20120517192959-vv00m77isztdy64q
Tags: upstream-1.8.2
ImportĀ upstreamĀ versionĀ 1.8.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
 
 
2
 
 
3
Make/install:
 
4
-------------
 
5
 
 
6
  sipdialer is built as part of the main reSIProcate build
 
7
  when you pass the option --with-apps to configure
 
8
 
 
9
    ./configure --with-ssl --with-apps
 
10
 
 
11
  From the top level of the reSIProcate source tree, running
 
12
  the command
 
13
 
 
14
    make install
 
15
 
 
16
  should install sipdialer to $bindir (default /usr/local/bin)
 
17
 
 
18
The configuration file:
 
19
-----------------------
 
20
 
 
21
  The configuration file must be located in $HOME/.sipdial/sipdial.cfg
 
22
 
 
23
  You can copy the the example file included in the source
 
24
 
 
25
  The parameter callerUserAgentVariety describes the type of phone
 
26
  that will make the outgoing call.  Each VoIP phone implements 
 
27
  support for click-to-dial in a different way.  These phones are
 
28
  supported, and the same mechanisms may work with other phones
 
29
  from the same manufacturer:
 
30
 
 
31
  PolycomIP501:  adds the header field "AlertInfo: AA"
 
32
  LinksysSPA941: adds the attribute answer-after=0 to header Callinfo
 
33
  Cisco7940:     same as generic
 
34
  Generic:       adds no special header fields
 
35
 
 
36
  In all cases, sipdialer sends a SIP REFER message to the phone.
 
37
 
 
38
Using TLS
 
39
---------
 
40
 
 
41
  sipdial expects to use TLS to security the exchange of
 
42
  SIP REFER messages.
 
43
 
 
44
  sipdial expects to find CA root certificates in files matching
 
45
  the pattern ~/.sipdial/certs/root_cert_*.pem
 
46
 
 
47
  If multiple certificates are concatenated in a PEM file, it will only
 
48
  load the first.
 
49
 
 
50
  To symlink all the standard root certs on a Debian system, you
 
51
  can do the following:
 
52
 
 
53
    mkdir -p ~/.sipdial/certs && \
 
54
      cd /etc/ssl/certs && \
 
55
      for i in *.pem ;
 
56
        do ln -s /etc/ssl/certs/$i ~/.sipdial/certs/root_cert_${i}
 
57
      done
 
58
 
 
59
  In ~/.sipdial/sipdial.cfg, the callerUserAgentAddress must use
 
60
  a sips URI:
 
61
 
 
62
    callerUserAgentAddress sips:mydeskphone@example.org
 
63
 
 
64
Install in gconf:
 
65
-----------------
 
66
  
 
67
Use the shell scipt/commands below to register the dialer with gconf.
 
68
gconf aware applications like Mozilla will then be able to use the dialer
 
69
to handle sip: and tel: URIs
 
70
 
 
71
for scheme in tel sip sips;
 
72
do
 
73
  gconftool-2 -t string \
 
74
   -s /desktop/gnome/url-handlers/$scheme/command "/usr/local/bin/sipdialer %s"
 
75
  gconftool-2 -t bool \
 
76
   -s /desktop/gnome/url-handlers/$scheme/needs_terminal false 
 
77
  gconftool-2 -t bool \
 
78
   -s /desktop/gnome/url-handlers/$scheme/enabled true
 
79
done
 
80
 
 
81
Usage:
 
82
------
 
83
 
 
84
  E.164 format:
 
85
   sipdialer tel:+442071357000
 
86
 
 
87
  Local format:
 
88
   sipdialer tel:00442071357000
 
89
 
 
90
  SIP addresses:
 
91
   sipdialer sip:442071357000@lvdx.com
 
92
 
 
93
 
 
94
Testing with a SIP proxy:
 
95
-------------------------
 
96
 
 
97
  The reSIProcate package includes the `repro' SIP proxy, which is ideal
 
98
  for testing tools such as sipdial.
 
99
 
 
100
  Alternatively, you may also test with products like Kamailio, OpenSIPS,
 
101
  sipXpbx or possibly FreeSWITCH or Asterisk.
 
102
 
 
103
  Whichever proxy/PBX you choose must permit/recognise the SIP REFER request. 
 
104
 
 
105
 
 
106
 
 
107
/* ====================================================================
 
108
 *
 
109
 * Copyright (c) 2007 Daniel Pocock  All rights reserved.
 
110
 *
 
111
 * Redistribution and use in source and binary forms, with or without
 
112
 * modification, are permitted provided that the following conditions
 
113
 * are met:
 
114
 *
 
115
 * 1. Redistributions of source code must retain the above copyright
 
116
 *    notice, this list of conditions and the following disclaimer.
 
117
 *
 
118
 * 2. Redistributions in binary form must reproduce the above copyright
 
119
 *    notice, this list of conditions and the following disclaimer in
 
120
 *    the documentation and/or other materials provided with the
 
121
 *    distribution.
 
122
 *
 
123
 * 3. Neither the name of the author(s) nor the names of any contributors
 
124
 *    may be used to endorse or promote products derived from this software
 
125
 *    without specific prior written permission.
 
126
 *
 
127
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) AND CONTRIBUTORS "AS IS" AND
 
128
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 
129
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 
130
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR(S) OR CONTRIBUTORS BE LIABLE
 
131
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 
132
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 
133
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 
134
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 
135
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 
136
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 
137
 * SUCH DAMAGE.
 
138
 *
 
139
 * ====================================================================
 
140
 *
 
141
 *
 
142
 */
 
143