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 (old OCS2007 method only)
  34     * Voice & Video calls (unencrypted only)
  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
 123 Do It Yourself I: compiling against "pidgin" package
 124 ====================================================
 125
 126 NOTE: for instructions how to setup a build environment on Windows to
 127       compile the Windows Pidgin plugin, please read:
 128
 129         https://developer.pidgin.im/wiki/BuildingWinPidgin
 130
 131 NOTE: for instructions how to cross-compile the Windows Pidgin plugin on
 132       Linux, please read:
 133
 134         contrib/mingw-cross-compile/README.txt
 135
 136 NOTE: for instructions how to compile the SIPEAdiumPlugin on Mac OS X,
 137       please read:
 138
 139         src/adium/README.adium
 140
 141
 142 If you already have installed the "pidgin" package from your distribution
 143 repository and want compile SIPE from source code yourself, then you need to
 144 install the necessary headers first. Depending on your distribution you'll
 145 need to install one of the following packages
 146
 147         libpurple-dev
 148         libpurple-devel
 149
 150 For the compilation you'll need to install a C compiler and some of the
 151 following packages
 152
 153         libtool
 154         intltool
 155
 156         pkg-config
 157         libglib2.0-dev
 158         libxml2-dev
 159         libgmime-2.4-dev  (optional)
 160         libgmime-2.6-dev  (optional)
 161
 162         pkgconfig
 163         libglib2-devel
 164         libxml2-devel
 165         gettext-devel
 166         gmime-devel       (optional)
 167
 168 You have to choose between NSS or OpenSSL for the crypto backend. You'll
 169 need one of the following packages
 170
 171         for NSS:
 172         libnss3-dev
 173         nss-devel
 174         mozilla-nss-devel
 175
 176         for OpenSSL:
 177         libssl-dev
 178         openssl-devel
 179
 180 If you want to enable Kerberos authentication support then you'll need one
 181 of the following packages
 182
 183         libkrb5-dev
 184         krb5-devel
 185
 186 If you additionally want to disable the internal NTLM implementation and
 187 authenticate with NTLM via GSSAPI then you'll need one of the following
 188 packages
 189
 190         gssntlmssp-devel
 191
 192 If you want to enable Voice & Video features then you'll need some of the
 193 following packages
 194
 195         libnice-dev           (>= 0.1.0)
 196         libgstreamer0.10-dev
 197
 198         libnice-devel         (>= 0.1.0)
 199         gstreamer-devel
 200
 201 Now you should be able to compile the source code with
 202
 203         ./configure --prefix=/usr
 204         make
 205
 206 If you get errors then you are missing some required package. After
 207 successful compilation you can install SIPE with:
 208
 209         su -c "make install"
 210
 211 If you get errors from configure or libtool about version conflicts then
 212 you need to regenerate the autoconf files. You'll need these additional
 213 packages
 214
 215         autoconf
 216         automake
 217
 218 Now you should be able to regenerate the files with
 219
 220         autoreconf --verbose --install --force
 221
 222 After that go back to the configure step above.
 223
 224
 225 Do It Yourself II: compiling against self-compiled pidgin
 226 =========================================================
 227
 228 If you have compiled pidgin from source code yourself then you'll have to
 229 specify the correct installation path in configure. Usually pidgin is
 230 installed in /usr/local so the following command should work
 231
 232         ./configure --prefix=/usr/local
 233
 234 The rest of the steps are the same as in the previous section.