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