diff --git a/docs/Dependencies.txt b/docs/Dependencies.txt index f5a0b339..a3c953d4 100644 --- a/docs/Dependencies.txt +++ b/docs/Dependencies.txt @@ -1,56 +1,57 @@ SIP SIMPLE client SDK dependencies ---------------------------------- Home page: http://sipsimpleclient.org 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 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 + * zope-interface http://www.zope.org + * openssl Other libraries (C): * ffmpeg (libavformat, libswscale, libavcodec, libavutil) - * libx264 (recent snapshot) - * libvpx (>= 1.3.0) + * libx264 + * libvpx * 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.linux b/docs/Install.linux index c70f81de..f0a25b3d 100644 --- a/docs/Install.linux +++ b/docs/Install.linux @@ -1,99 +1,98 @@ SIP SIMPLE SDK installation on Linux ------------------------------------ Home page: http://sipsimpleclient.org 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 3 and the development version for the following -packages: +Install the C compiling environment, Python 3 and the development version +for the following packages: * openssl * ffmpeg 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 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: +Using pip3 inside your user 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 + - sipclients3 (for testing all SDK functions) 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.osx b/docs/Install.osx index 621354d2..f0d59003 100644 --- a/docs/Install.osx +++ b/docs/Install.osx @@ -1,39 +1,42 @@ Installation procedure for SIP SIMPLE SDK on MacOSX --------------------------------------------------- Home page: http://sipsimpleclient.org This document describes the installation procedure on MacOSX >= 10.14 The installation procedure consists of the steps described below: Step 1. Prerequisites Step 2. Install dependencies Step 3. Install SIP SIMPLE SDK Step 1. Prerequisites --------------------- * MacOSX >= 10.14 * Apple Developer tools (XCode 11) * Homebrew from http://brew.sh Step 2. Install dependencies ---------------------------- See Dependencies.txt for detailed description of the required libraries and their minimum version number. A. Install the C dependencies, the software will be installed under /usr/local folder by default with Homebrew: -brew install darcs gnutls yasm pkg-config x264 libvpx mpfr libmpc python3 +brew install darcs gnutls yasm pkg-config x264 libvpx mpfr libmpc brew install -s ffmpeg + Step 3. Install SIP SIMPLE SDK +------------------------------ See Install.linux document +