Page MenuHomePhabricator
Files F7232060

No OneTemporary
Actions

View Options

diff --git a/docs/Dependencies.txt b/docs/Dependencies.txt
index 056c382b..f5a0b339 100644
--- a/docs/Dependencies.txt
+++ b/docs/Dependencies.txt
@@ -1,50 +1,56 @@
-Dependencies for SIP SIMPLE client SDK
---------------------------------------
+SIP SIMPLE client SDK dependencies
+----------------------------------
Home page: http://sipsimpleclient.org
- * python http://python.org 2.7
- * python-application http://pypi.python.org/simple/python-application >=2.8.0
- * python-cjson http://pypi.python.org/pypi/python-cjson/ >=1.0.5
- * python-dateutil http://niemeyer.net/python-dateutil >=1.4
- * python-eventlib http://download.ag-projects.com/SipClient >=0.1.0
- * python-greenlet http://pypi.python.org/pypi/greenlet >=0.3.2
- * python-gnutls http://pypi.python.org/simple/python-gnutls >=1.1.9
- * python-lxml http://codespeak.net/lxml >=2.1.2
- * python-otr http://pypi.python.org/pypi/python-otr/ >=1.2.0
- * python-msrplib http://download.ag-projects.com/MSRP >=0.20.0
- * python-xcaplib http://download.ag-projects.com/XCAP >=1.0.17
- * cython http://www.cython.org >=0.19.0
- * dnspython http://www.dnspython.org >=1.9.0
- * twisted http://twistedmatrix.com/trac >=8.1.0
- * zope-interface http://www.zope.org >=3.3.1
-
-Other libraries:
-
- * ffmpeg (libavformat, libswscale, libavcodec, libavutil) (>= 2.7)
+
+Packages available from AG Projects:
+
+ * python3-application http://pypi.python.org/simple/python-application
+ * python3-eventlib http://download.ag-projects.com/SipSimpleSDK/Python3/
+ * python3-gnutls http://download.ag-projects.com/SipSimpleSDK/Python3/
+ * python3-otr http://download.ag-projects.com/SipSimpleSDK/Python3/
+ * python3-msrplib http://download.ag-projects.com/SipSimpleSDK/Python3/
+ * python3-xcaplib http://download.ag-projects.com/SipSimpleSDK/Python3/
+
+
+Packages available within the OS distribution:
+
+ * python http://python.org >= 3.6.5
+ * python3-lxml http://pypi.org/project/lxml/
+ * python3-greenlet http://pypi.python.org/pypi/greenlet
+ * cython http://www.cython.org
+ * dnspython http://www.dnspython.org
+ * twisted http://twistedmatrix.com
+ * zope-interface http://www.zope.org
+
+
+Other libraries (C):
+
+ * ffmpeg (libavformat, libswscale, libavcodec, libavutil)
* libx264 (recent snapshot)
* libvpx (>= 1.3.0)
- * libasund2
+ * libasound2
* libuuid
* libsqlite3
* pkg-config
* openssl
To compile the video dependencies (ffmpeg / libx264 / libvpx):
export SIPSIMPLE_FFMPEG_PATH=$HOME/work/ag-projects/video/local
NOTE: yasm is required in order to enable asm optimizations. It does not
come preinstalled on OSX, so it has to be manually installed. (brew install
yasm will do)
NOTE: libx264 and libvpx can be installed also using Homebrew on OSX.
For ffmpeg:
./configure --enable-shared --disable-static --enable-memalign-hack --enable-gpl --enable-libx264 --disable-avdevice --disable-swresample --disable-postproc --prefix=$SIPSIMPLE_FFMPEG_PATH
make
make install
diff --git a/docs/Install.debian b/docs/Install.debian
index b3cfb464..e59d5ce4 100644
--- a/docs/Install.debian
+++ b/docs/Install.debian
@@ -1,84 +1,77 @@
-SIP SIMPLE client SDK installation on Debian
---------------------------------------------
+SIP SIMPLE SDK installation on Debian
+-------------------------------------
Home page: http://sipsimpleclient.org
This document describes the installation procedure on Debian operating
systems from the official public repository maintained by AG Projects.
Configure Repository
--------------------
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)
----------------------
-
-deb http://ag-projects.com/debian unstable main
-deb-src http://ag-projects.com/debian unstable main
-
-
-Debian Stable (Wheezy)
+Debian Stable (Buster)
-----------------------
deb http://ag-projects.com/debian stable main
deb-src http://ag-projects.com/debian stable main
Update the list of available packages:
sudo apt-get update
Install SIP SIMPLE client SDK:
sudo apt-get install python-sipsimple
Install the Command Line Clients:
sudo apt-get install sipclients
Creating Debian Packages
------------------------
Install the building dependencies:
sudo apt-get install cython cython-dbg python-setuptools devscripts \
debhelper python-all-dev python-all-dbg libasound2-dev libssl-dev libsqlite3-dev
For adding Video support:
sudo apt-get install libv4l-dev libavcodec-dev libavformat-dev libavutil-dev \
libswscale-dev libswresample-dev libx264-dev libvpx-dev libavcodec-extra
Note: do NOT use the Debian-Multimedia repositories.
For Ubuntu variants:
sudo apt-get install libv4l-dev libavcodec-dev libavformat-dev libavutil-dev \
libswscale-dev libswresample-dev libx264-dev libvpx-dev libavcodec-extra53
Obtain the source code using darcs as described in Install.linux document.
Create under each repository a clean distribution file:
python setup.py sdist
Go to the ./dist directory and untar the file created at the step above.
Go to the newly created directory and type:
debuild -us -uc
The .deb and related files are built in the upper directory.
diff --git a/docs/Install.linux b/docs/Install.linux
index 193da0b5..c70f81de 100644
--- a/docs/Install.linux
+++ b/docs/Install.linux
@@ -1,109 +1,99 @@
-SIP SIMPLE client SDK installation on Linux
--------------------------------------------
+SIP SIMPLE SDK installation on Linux
+------------------------------------
Home page: http://sipsimpleclient.org
-This document described the installation procedure on Linux operating
-systems.
+
+This document described the installation procedure on
+Linux operating systems.
Step 1. Prerequisites
---------------------
Both i386 or amd64 architectures are supported. Install the C compiling
-environment, Python 2.7 and the development version for the following
+environment, Python 3 and the development version for the following
packages:
* openssl
* ffmpeg
-Step 2. Install dependencies
-----------------------------
+Step 2. Install system dependencies
+-----------------------------------
See Dependencies.txt for detailed description of the required libraries and
their minimum version number.
Use the appropriate package manager for your Linux distribution to install
the following packages, notice the minimum version numbers.
You can use the easy_install script provided by the python-setuptools
package to install the packages:
-sudo pip install -U cython dnspython lxml python-gnutls python-otr \
-python-application twisted python-dateutil greenlet
-
-
-Step 3. Install SIP SIMPLE client SDK
--------------------------------------
-
-The SDK consists of four parts:
-
- 1. python-eventlib
- 2. XCAP library
- 3. MSRP library
- 4. SIP SIMPLE library
-
-# Eventlib
-if [ -d python-eventlib ]; then
- cd python-eventlib
- darcs pull -a
- sudo python setup.py install
-else
- darcs get http://devel.ag-projects.com/repositories/python-eventlib
- cd python-eventlib
- sudo python setup.py install
-fi
-cd ..
-
-# XCAP library
-if [ -d python-xcaplib ]; then
- cd python-xcaplib
- darcs pull -a
- sudo python setup.py install
-else
- darcs get http://devel.ag-projects.com/repositories/python-xcaplib
- cd python-xcaplib
- sudo python setup.py install
-fi
-cd ..
-
-# MSRP library
-if [ -d python-msrplib ]; then
- cd python-msrplib
- darcs pull -a
- sudo python setup.py install
-else
- darcs get http://devel.ag-projects.com/repositories/python-msrplib
- cd python-msrplib
- sudo python setup.py install
-fi
-cd ..
-
-# SIP SIMPLE
-if [ -d python-sipsimple ]; then
- cd python-sipsimple
- darcs pull -a
-else
- darcs get --set-scripts-executable http://devel.ag-projects.com/repositories/python-sipsimple
-fi
-cd..
-
-cd python-sipsimple
-python setup.py build_ext --pjsip-clean-compile
-sudo python setup.py install
-
-Additional, you can install the command line interface scripts that can be
-used to test the SDK.
-
-if [ -d sipclients ]; then
- cd sipclients
- darcs pull -a
-else
- darcs get --set-scripts-executable http://devel.ag-projects.com/repositories/sipclients
-fi
-cd..
-
-sudo python setup.py install
+sudo pip3 install -U cython dnspython lxml twisted python-dateutil \
+greenlet zope.interface
+
+
+Step 3. Install AG Projects dependencies
+----------------------------------------
+
+ - python3-application
+ - python3-eventlib
+ - python3-gnutls
+ - python3-otr
+ - python3-msrplib
+ - python3-xcaplib
+
+
+For each of them, in the exact order as listed above, retrieve the packages
+as follows:
+
+
+Using darcs:
+
+darcs clone http://devel.ag-projects.com/repositories/PROJECT
+
+replace PROJECT with each of the names above
+
+As tar archives from:
+
+http://download.ag-projects.com/SipSimpleSDK/Python3/
+
+Install these packages by going into each directory.
+
+Using pip inside your virtual environment:
+
+pip3 install --user .
+
+System-wide using setup.py:
+
+sudo python3 setup.py install
+
+As a debian package:
+
+./makedeb.sh
+
+The debian package can be found inside ./dist folder
+
+sudo dpkg -i *.deb
+
+
+Step 4. Install the SDK
+-----------------------
+
+The SDK consists of two packages:
+
+ - python3-sipsimple
+ - sipclients3
+
+Install them similar to the dependencies above.
+
+
+Step 5. Testing the SDK
+-----------------------
+
+Use the command line tools provided by sipclients3 package, the binaries
+start with sip- prefix
diff --git a/docs/Install.ubuntu b/docs/Install.ubuntu
index f769d6b2..ca74426e 100644
--- a/docs/Install.ubuntu
+++ b/docs/Install.ubuntu
@@ -1,38 +1,38 @@
-SIP SIMPLE client SDK installation on Ubuntu
---------------------------------------------
+SIP SIMPLE SDK installation on Ubuntu
+-------------------------------------
Home page: http://sipsimpleclient.org
This document describes the installation procedure on Ubuntu operating
systems from the official public repository maintained by AG Projects.
Configure Repository
--------------------
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 the repository to /etc/apt/sources.list (run commands as root):
echo "deb http://ag-projects.com/ubuntu `lsb_release -c -s` main" >> /etc/apt/sources.list
echo "deb-src http://ag-projects.com/ubuntu `lsb_release -c -s` main" >> /etc/apt/sources.list
Update the list of available packages:
sudo apt-get update
Install SIP SIMPLE client SDK:
sudo apt-get install python-sipsimple
Install the Command Line Clients:
sudo apt-get install sipclients

File Metadata

Mime Type
text/x-diff
Expires
Sat, Dec 28, 7:14 AM (1 d, 5 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
3452668
Default Alt Text
(11 KB)

Event Timeline