README

   1 Introduction
   2 ============
   3
   4 SIPE is a third-party plugin for the Pidgin/Adium/Miranda/Telepathy
   5 multi-protocol instant messaging clients/frameworks. It implements the
   6 extended version of SIP/SIMPLE used by various products:
   7
   8     * Skype for Business
   9     * Microsoft Office 365
  10     * Microsoft Business Productivity Online Suite (BPOS)
  11     * Microsoft Lync Server
  12     * Microsoft Office Communications Server (OCS 2007/2007 R2)
  13     * Microsoft Live Communications Server (LCS 2003/2005)
  14     * Reuters Messaging
  15
  16 With this plugin you should be able to replace your Microsoft Office
  17 Communicator client with Pidgin/Adium/Miranda/Telepathy.
  18
  19
  20 Features
  21 ========
  22
  23 The plugin has support for
  24
  25     * Instant Messaging (IM)
  26     * Multiparty chat (OCS 2005) or conference (OCS 2007+)
  27     * Group chat (Lync 2010) or Persistent chat (Lync 2013) - [MS-XCCOSIP]
  28     * Enhanced presence
  29     * Calendar integration with Exchange 2007+ (can be disabled)
  30     * Contact details information - company, phones, photo, web site, etc.
  31     * Unified Contact Store (Lync 2013) - [MS-OXWSCOS]
  32     * Contact search - [MS-PRES] and [MS-DLX] methods supported
  33     * Encrypted file transfer (OCS2007: send & receive, Lync: receive only)
  34     * Voice & Video calls
  35     * Call initiation through PBX
  36     * NTLMv2, Kerberos & TLS-DSK authentication methods
  37     * Single Sign-On (depends on OS and authentication method)
  38     * Automatic SSL/TLS protection for SIP/HTTP connections
  39     * Crypto implementation using NSS or OpenSSL
  40     * Localization
  41
  42 The plugin has backends for
  43
  44     * Pidgin/Finch (libpurple)
  45     * Adium (libpurple)
  46     * Miranda
  47     * Telepathy (under development)
  48
  49
  50 Advantages over Office Communicator products
  51 ============================================
  52
  53     * Available on broader range of platforms: Linux, *BSD, Maemo, OSX,
  54       commercial UNIX, Windows.
  55     * Ability to simultaneously connect to several Office Communicator
  56       accounts in addition to public IM network accounts like MSN, AOL,
  57       Yahoo. For example one account is in vendor company and another is
  58       in client company.
  59     * Keeps history of communications in environments without Outlook. For
  60       example in companies where Lotus Notes is deployed as a default
  61       groupware client instead of Outlook.
  62     * Lotus Notes/Domino calendar integration. Unique to SIPE.
  63     * Open development model, open source product. License is GPLv2+
  64
  65
  66 Support
  67 =======
  68
  69 The Pidgin or Adium projects do not support third-party plugins! Please do
  70 not ask questions about SIPE in their forums or report SIPE problems to their
  71 bug trackers.
  72
  73 If you set up your Office Communicator/Lync account with SIPE for the first
  74 time then please make sure to read this page:
  75
  76     https://sourceforge.net/p/sipe/wiki/How%20to%20setup%20an%20account/
  77
  78 If you encounter problems then please make sure to check out the Frequently
  79 Asked Question page:
  80
  81     https://sourceforge.net/p/sipe/wiki/faq/
  82
  83 If you still have problems then please check the support forum if another
  84 user encountered the same problem and maybe solved it already:
  85
  86     http://sourceforge.net/p/sipe/discussion/
  87
  88 If you think that you have found a bug in SIPE then please report it to the
  89 SIPE bug tracker:
  90
  91     https://sourceforge.net/p/sipe/bugs/
  92
  93 The SIPE project kindly requests that you do not ignore the instructions that
  94 appear at the head of the "Create Ticket" page. These instructions are there
  95 for a reason and if you ignore them then you will only cause unnecessary work
  96 for the project and yourself. Please do not report missing features as bugs.
  97
  98 New or missing features can be requested here:
  99
 100     https://sourceforge.net/p/sipe/feature-requests/
 101
 102
 103 Localization
 104 ============
 105
 106 SIPE has already been localized for several languages. You can help to
 107 translate SIPE to your native language at Transifex:
 108
 109     https://www.transifex.com/stefanb/pidgin-sipe/
 110
 111 The service offers a convenient web editor.
 112
 113
 114 Installing from a distribution repository
 115 =========================================
 116
 117 Many Open Source OS distributions have a ready-made package "pidgin-sipe".
 118 Before trying to compile it from the source code yourself you should try
 119 to install this package with the standard installation method provided by
 120 your OS.
 121
 122 Once you have SIPE installed and are connected to your account you can check
 123 from the following Pidgin menu
 124
 125         Accounts -> <SIPE Account> -> About SIPE plugin...
 126
 127 which optional features have been enabled in your SIPE build.
 128
 129
 130 Do It Yourself I: compiling against "pidgin" package
 131 ====================================================
 132
 133 NOTE: for instructions how to setup a build environment on Windows to
 134       compile the Windows Pidgin plugin, please read:
 135
 136         https://developer.pidgin.im/wiki/BuildingWinPidgin
 137
 138 NOTE: for instructions how to cross-compile the Windows Pidgin plugin on
 139       Linux, please read:
 140
 141         contrib/mingw-cross-compile/README.txt
 142
 143 NOTE: for instructions how to compile the SIPEAdiumPlugin on Mac OS X,
 144       please read:
 145
 146         src/adium/README.adium
 147
 148
 149 If you already have installed the "pidgin" package from your distribution
 150 repository and want compile SIPE from source code yourself, then you need to
 151 install the necessary headers first. Depending on your distribution you'll
 152 need to install one of the following packages
 153
 154         libpurple-dev
 155         libpurple-devel
 156
 157 For the compilation you'll need to install a C compiler and some of the
 158 following packages
 159
 160         libtool
 161         intltool
 162
 163         pkg-config
 164         libglib2.0-dev
 165         libxml2-dev
 166         libgmime-2.4-dev  (optional)
 167         libgmime-2.6-dev  (optional)
 168
 169         pkgconfig
 170         libglib2-devel
 171         libxml2-devel
 172         gettext-devel
 173         gmime-devel       (optional)
 174
 175 You have to choose between NSS or OpenSSL for the crypto backend. You'll
 176 need one of the following packages
 177
 178         for NSS:
 179         libnss3-dev
 180         nss-devel
 181         mozilla-nss-devel
 182
 183         for OpenSSL:
 184         libssl-dev
 185         openssl-devel
 186
 187 If you want to enable Kerberos authentication support then you'll need one
 188 of the following packages
 189
 190         libkrb5-dev
 191         krb5-devel
 192
 193 If you additionally want to disable the internal NTLM implementation and
 194 authenticate with NTLM via GSSAPI then you'll need one of the following
 195 packages
 196
 197         gssntlmssp-devel
 198
 199 If you want to enable Voice & Video features then you'll need some of the
 200 following packages. You need to install the same version of the GStreamer
 201 development packages which where used to compile Pidgin!
 202
 203         libnice-dev                 (>= 0.1.0)
 204         libgstreamer0.10-dev
 205 or      libgstreamer1.0-dev
 206         for encryption support (at compile time):
 207         libpurple-dev               (>= 2.10.12)
 208         libnice-dev                 (>= 0.1.13)
 209         libgstreamer1.0-dev
 210         for encryption support (at run time):
 211         libfarstream-0.2
 212         gstreamer1.0-plugins-bad
 213
 214         libnice-devel               (>= 0.1.0)
 215         gstreamer-devel
 216 or      gstreamer1-devel
 217         for encryption support (at compile time):
 218         libpurple-devel             (>= 2.10.12)
 219         libnice-devel               (>= 0.1.13)
 220         gstreamer1-devel
 221         for encryption support (at run time):
 222         farstream02
 223         gstreamer1-plugins-bad-free
 224
 225 Now you should be able to compile the source code with
 226
 227         ./configure --prefix=/usr
 228         make
 229
 230 If you get errors then you are missing some required package. After
 231 successful compilation you can install SIPE with:
 232
 233         su -c "make install"
 234
 235 If you get errors from configure or libtool about version conflicts then
 236 you need to regenerate the autoconf files. You'll need these additional
 237 packages
 238
 239         autoconf
 240         automake
 241
 242 Now you should be able to regenerate the files with
 243
 244         autoreconf --verbose --install --force
 245
 246 After that go back to the configure step above.
 247
 248
 249 Do It Yourself II: compiling against self-compiled pidgin
 250 =========================================================
 251
 252 If you have compiled pidgin from source code yourself then you'll have to
 253 specify the correct installation path in configure. Usually pidgin is
 254 installed in /usr/local so the following command should work
 255
 256         ./configure --prefix=/usr/local
 257
 258 The rest of the steps are the same as in the previous section.