Installation Guide

Supported Platforms: Linux (i386 and amd64 architectures)

Current Release

Version 3.1.0 has been released on April 24th, 2025.

Components

OpenXCAP

The XCAP server itself. Mandatory component.

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 3 - http://www.python.org
Twisted - http://twistedmatrix.com
python-lxml - https://lxml.de
python3-application - https://github.com/AGProjects/python3-application
python3-gnutls - https://github.com/AGProjects/python3-gnutls
Fast API - https://fastapi.tiangolo.com/
Uvicorn - https://www.uvicorn.org
SQLModel - https://sqlmodel.tiangolo.com
python3-sipsimple - https://sipsimpleclient.org

The precise requirements and versions are listed in requirements.txt.

For OpenSIPS support/REST API, python3-sipsimple is required.

Debian Packages

Debian and Ubuntu repository installation instructions are available here.

After that, run:

sudo apt-get update

Install OpenXCAP:

sudo apt-get install openxcap

Install optional xcap-client library:

sudo apt-get install python3-xcaplib

Tar Archives

OpenXCAP and related software can be downloaded as tar archives from Github and from 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 can be obtained in the same way.

To obtain the incremental changes after the initial get:

cd openxcap
darcs pull -a

After completing this the install, go to Presence Tutorial section to view the setup process. Or you can view the full INSTALL on GitHub.