SipInstallation

Version 45 (Adrian Georgescu, 03/13/2009 11:58 am)

1 1 Adrian Georgescu
= Installation guide =
2 20 Adrian Georgescu
3 22 Adrian Georgescu
[[TOC(WikiStart, Sip*, depth=3)]]
4 1 Adrian Georgescu
 
5 23 Adrian Georgescu
== Supported platforms ==
6 23 Adrian Georgescu
7 33 Adrian Georgescu
Currently i386, amd64 and ppc architectures have been tested and are fully supported on the following operating systems:
8 23 Adrian Georgescu
9 28 Adrian Georgescu
 * Linux
10 28 Adrian Georgescu
 * MacOSX
11 28 Adrian Georgescu
 * FreeBSD
12 23 Adrian Georgescu
13 43 Adrian Georgescu
Porting to other operating systems (like Windows, Symbian and iPhone) should be possible as long as Python environment and [http://www.pjsip.org/sip_media_features.htm#platforms PJSIP] are supported by 
14 37 Adrian Georgescu
that platform. The MSRP library is not yet fully working on ARM processors.
15 1 Adrian Georgescu
16 37 Adrian Georgescu
== Debian package ==
17 37 Adrian Georgescu
18 44 Adrian Georgescu
For people running Debian 5.0 or Ubuntu 8.10 there is a debian package ready for use available from the public repository provided by AG Projects. To install the debian package  add these lines in /etc/apt/sources.list
19 37 Adrian Georgescu
20 37 Adrian Georgescu
{{{
21 37 Adrian Georgescu
# AG Projects software
22 37 Adrian Georgescu
deb     http://ag-projects.com/debian unstable main
23 37 Adrian Georgescu
deb-src http://ag-projects.com/debian unstable main
24 37 Adrian Georgescu
}}}
25 37 Adrian Georgescu
26 37 Adrian Georgescu
Install the AG Projects debian software signing key:
27 37 Adrian Georgescu
28 37 Adrian Georgescu
{{{
29 37 Adrian Georgescu
wget http://download.ag-projects.com/agp-debian-gpg.key
30 37 Adrian Georgescu
apt-key add agp-debian-gpg.key
31 37 Adrian Georgescu
}}}
32 37 Adrian Georgescu
33 37 Adrian Georgescu
After that, run:
34 37 Adrian Georgescu
35 37 Adrian Georgescu
{{{
36 37 Adrian Georgescu
apt-get update
37 38 Adrian Georgescu
apt-get install sipclient
38 37 Adrian Georgescu
}}}
39 37 Adrian Georgescu
40 37 Adrian Georgescu
41 38 Adrian Georgescu
== Development version ==
42 1 Adrian Georgescu
43 35 Adrian Georgescu
The source code is managed using [http://darcs.net darcs] version control tool. The darcs repository can be fetched with:
44 1 Adrian Georgescu
45 1 Adrian Georgescu
{{{
46 14 Adrian Georgescu
darcs get http://devel.ag-projects.com/repositories/python-sipsimple
47 1 Adrian Georgescu
}}}
48 1 Adrian Georgescu
49 1 Adrian Georgescu
To obtain the incremental changes after the initial get, go to the sipsimpleclient directory and run:
50 1 Adrian Georgescu
51 1 Adrian Georgescu
{{{
52 14 Adrian Georgescu
cd python-sipsimple
53 1 Adrian Georgescu
darcs pull
54 1 Adrian Georgescu
}}}
55 1 Adrian Georgescu
56 25 Adrian Georgescu
== Building instructions ==
57 1 Adrian Georgescu
58 1 Adrian Georgescu
Building instructions for the corresponding platforms are available at:
59 1 Adrian Georgescu
60 1 Adrian Georgescu
 * [source:docs/INSTALL.linux INSTALL.linux]
61 1 Adrian Georgescu
 * [source:docs/INSTALL.osx INSTALL.osx]
62 1 Adrian Georgescu
 * [source:docs/INSTALL.freebsd INSTALL.freebsd]
63 17 Adrian Georgescu
64 45 Adrian Georgescu
The build process can be fine-tuned for various options (like for using a specific version of underlying pjsip library):
65 45 Adrian Georgescu
66 45 Adrian Georgescu
{{{
67 45 Adrian Georgescu
adigeo@ag-imac3:python setup.py build_ext --help
68 45 Adrian Georgescu
Common commands: (see '--help-commands' for more)
69 45 Adrian Georgescu
70 45 Adrian Georgescu
  setup.py build      will build the package underneath 'build/'
71 45 Adrian Georgescu
  setup.py install    will install the package
72 45 Adrian Georgescu
73 45 Adrian Georgescu
Global options:
74 45 Adrian Georgescu
  --verbose (-v)  run verbosely (default)
75 45 Adrian Georgescu
  --quiet (-q)    run quietly (turns verbosity off)
76 45 Adrian Georgescu
  --dry-run (-n)  don't actually do anything
77 45 Adrian Georgescu
  --help (-h)     show detailed help message
78 45 Adrian Georgescu
79 45 Adrian Georgescu
Options for 'PJSIP_build_ext' command:
80 45 Adrian Georgescu
  --build-lib (-b)        directory for compiled extension modules
81 45 Adrian Georgescu
  --build-temp (-t)       directory for temporary files (build by-products)
82 45 Adrian Georgescu
  --inplace (-i)          ignore build-lib and put compiled extensions into
83 45 Adrian Georgescu
                          the source directory alongside your pure Python
84 45 Adrian Georgescu
                          modules
85 45 Adrian Georgescu
  --include-dirs (-I)     list of directories to search for header files
86 45 Adrian Georgescu
                          (separated by ':')
87 45 Adrian Georgescu
  --define (-D)           C preprocessor macros to define
88 45 Adrian Georgescu
  --undef (-U)            C preprocessor macros to undefine
89 45 Adrian Georgescu
  --libraries (-l)        external C libraries to link with
90 45 Adrian Georgescu
  --library-dirs (-L)     directories to search for external C libraries
91 45 Adrian Georgescu
                          (separated by ':')
92 45 Adrian Georgescu
  --rpath (-R)            directories to search for shared C libraries at
93 45 Adrian Georgescu
                          runtime
94 45 Adrian Georgescu
  --link-objects (-O)     extra explicit link objects to include in the link
95 45 Adrian Georgescu
  --debug (-g)            compile/link with debugging information
96 45 Adrian Georgescu
  --force (-f)            forcibly build everything (ignore file timestamps)
97 45 Adrian Georgescu
  --compiler (-c)         specify the compiler type
98 45 Adrian Georgescu
  --swig-cpp              make SWIG create C++ files (default is C)
99 45 Adrian Georgescu
  --swig-opts             list of SWIG command line options
100 45 Adrian Georgescu
  --swig                  path to the SWIG executable
101 45 Adrian Georgescu
  --pyrex-cplus           generate C++ source files
102 45 Adrian Georgescu
  --pyrex-create-listing  write errors to a listing file
103 45 Adrian Georgescu
  --pyrex-include-dirs    path to the Cython include files (separated by ':')
104 45 Adrian Georgescu
  --pyrex-c-in-temp       put generated C files in temp directory
105 45 Adrian Georgescu
  --pyrex-gen-pxi         generate .pxi file for public declarations
106 45 Adrian Georgescu
  --pjsip-svn-repo        PJSIP SVN repository to checkout from
107 45 Adrian Georgescu
  --pjsip-svn-revision    PJSIP SVN revision to fetch
108 45 Adrian Georgescu
  --pjsip-clean-compile   Clean PJSIP tree before compilation
109 45 Adrian Georgescu
  --help-compiler         list available compilers
110 45 Adrian Georgescu
111 45 Adrian Georgescu
usage: setup.py [global_opts] cmd1 [cmd1_opts] [cmd2 [cmd2_opts] ...]
112 45 Adrian Georgescu
   or: setup.py --help [cmd1 cmd2 ...]
113 45 Adrian Georgescu
   or: setup.py --help-commands
114 45 Adrian Georgescu
   or: setup.py cmd --help
115 45 Adrian Georgescu
116 45 Adrian Georgescu
}}}
117 45 Adrian Georgescu
118 45 Adrian Georgescu
119 19 Adrian Georgescu
== Upgrade instructions ==
120 15 Adrian Georgescu
121 15 Adrian Georgescu
 * [browser:docs/Upgrade.txt Upgrade guide]
122 1 Adrian Georgescu
123 26 Adrian Georgescu
== How to un-install ==
124 15 Adrian Georgescu
125 15 Adrian Georgescu
 * [browser:docs/UnINSTALL.txt Uninstall guide]