= Installation =

[[TOC(Installation,Configuration,Testing, depth=2)]]

Supported Platforms: Linux (i386 and amd64 architectures)

== Current Release ==

Version 1.2.1 has been released on June 23rd, 2010.

== Components ==

=== OpenXCAP ===

The XCAP server itself. Mandatory component.

=== opensips-mi-proxy ===

Optional component. It replaces the standard OpenSIPS xml-rpc module, which is required to issue the refreshWatchers command in OpenSIPS when the the policy stored in the pres-rules XCAP document for a given presentity has been changed. Compared to the built-in xml-rpc module it is  able to listen on a custom IP address and provides an access list for the clients allowed to connect.

=== soap-simple-proxy ===

Optional component. It is used to access XCAP documents by using SOAP/XML requests, it can be used to build a web page to perform XCAP requests for pres-rules and pidf-manipulation documents.

=== python-xcaplib ===

Optional component. XCAP client library that can be used for developing an XCAP client (Python only) or for testing the server using the xcapclient command line utility.

== Dependencies ==

 * Python 2.5 or 2.6 http://www.python.org
 * Twisted Core, Twisted Web and Twisted Web 2 >= 8.1.0 http://twistedmatrix.com
 * python-lxml >= 2.0.7 http://codespeak.net/lxml)
 * python-application >= 1.2.0 http://pypi.python.org/pypi/python-application
 * python-gnutls >=1.8.1 http://pypi.python.org/pypi/python-gnutls
 * python-mysqldb >=1.2.2 http://pypi.python.org/simple/mysql-python
 * python-imaging >=1.1.7 http://pypi.python.org/simple/PIL/

== Debian Packages ==

Install the AG Projects debian software signing key:

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

Add these lines to /etc/apt/sources.list:

=== Debian Unstable (Sid) ===

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

=== Debian Stable (Lenny) ===

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

=== Ubuntu Karmic (9.10) ===

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

=== Ubuntu Lucid (10.04) ===

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

Update the list of available packages:

{{{
sudo apt-get update
}}}

Install OpenXCAP:

{{{
sudo apt-get install openxcap
}}}

Install opensips-mi-proxy (on the machine running OpenSIPS):

{{{
sudo apt-get install opensips-mi-proxy
}}}

Install soap-simple-proxy:

{{{
sudo apt-get install soap-simple-proxy
}}}

Install xcap-client library:

{{{
sudo apt-get install python-xcaplib
}}}

== Tar Archives ==

The software is available as a tar archive at:

http://download.ag-projects.com/XCAP/

Extract it using tar xzvf openxcap-version.tar.gz and change directory to the newly created openxcap directory.

Install the software:

{{{
cd openxcap
sudo python setup.py install
}}}

== Version Control Repository ==

The source code is managed using darcs version control tool. The darcs repository can be fetched with:

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

Other packages like python-xcaplib, soap-simple-proxy and opensips-mi-proxy can be obtained in the same way. 

To obtain the incremental changes after the initial get:

{{{
cd openxcap
darcs pull -a
}}}

After completing this chapter, go to [wiki:Configuration] section.