SIP SIMPLE Client SDK

= Installation guide =

[[TOC(WikiStart, Sip*, depth=3)]]

== Supported platforms ==

Currently i386, amd64 and ppc architectures have been tested and are fully supported on the following operating systems:

* Linux
* MacOSX
* FreeBSD

Porting to other operating systems (like Windows, Symbian and iPhone OS) should be possible as long as Python environment and [http://www.pjsip.org/sip_media_features.htm#platforms PJSIP] are supported by
that platform. The MSRP library is not yet fully working on ARM processors.

== Debian package ==

For people running Debian 5.0 or and Ubuntu 8.10 on i386 and amd64 architectures there is an official public repository provided by AG Projects. To use it, add these lines in /etc/apt/sources.list

{{{
# AG Projects software
deb http://ag-projects.com/debian unstable main
deb-src http://ag-projects.com/debian unstable main
}}}

Install the AG Projects debian software signing key:

{{{
wget http://download.ag-projects.com/agp-debian-gpg.key
apt-key add agp-debian-gpg.key
}}}

After that, run:

{{{
apt-get update
apt-get install sipclient
}}}

== Development version ==

The source code is managed using [http://darcs.net darcs] version control tool. The darcs repository can be fetched with:

{{{
darcs get http://devel.ag-projects.com/repositories/python-sipsimple
}}}

To obtain the incremental changes after the initial get, go to the sipsimpleclient directory and run:

{{{
cd python-sipsimple
darcs pull
}}}

== Building instructions ==

Building instructions for the corresponding platforms are available at:

* [source:docs/INSTALL.linux INSTALL.linux]
* [source:docs/INSTALL.osx INSTALL.osx]
* [source:docs/INSTALL.freebsd INSTALL.freebsd]

== Upgrade instructions ==

* [browser:docs/Upgrade.txt Upgrade guide]

== How to un-install ==

* [browser:docs/UnINSTALL.txt Uninstall guide]