README

   1 Introduction
   2 ============
   3
   4 pidgin-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     * Microsoft Office 365
   9     * Microsoft Business Productivity Online Suite (BPOS)
  10     * Microsoft Lync Server
  11     * Microsoft Office Communications Server (OCS 2007/2007 R2)
  12     * Microsoft Live Communications Server (LCS 2003/2005)
  13     * Reuters Messaging
  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
  26     * Group (Lync 2010) or Persistent (Lync 2013) chat
  27     * Enhanced presence
  28     * Calendar integration with Exchange 2007/2010
  29     * Contact details information - company, phones, web site, etc.
  30     * Contact search - [MS-PRES] and [MS-DLX] methods supported
  31     * Encrypted file transfer
  32     * Call initiation through PBX
  33     * NTLMv2, Kerberos & TLS-DSK authentication support
  34     * TLS encryption support
  35     * Translated to many languages
  36
  37 The plugin has backends for
  38
  39     * Pidgin/Finch (libpurple)
  40     * Adium (libpurple)
  41     * Miranda
  42     * Telepathy (under development)
  43
  44 Advantages over Office Communicator products
  45 ============================================
  46
  47     * Available on broader range of platforms: Linux, *BSD, Maemo, OSX,
  48       commercial UNIX, Windows.
  49     * Ability to simultaneously connect to several Office Communicator
  50       accounts in addition to public IM network accounts like MSN, AOL,
  51       Yahoo. For example one account is in vendor company and another is
  52       in client company.
  53     * Keeps history of communications in environments without Outlook. For
  54       example in companies where Lotus Notes is deployed as a default
  55       groupware client instead of Outlook.
  56     * Lotus Notes/Domino calendar integration. Unique to SIPE.
  57     * Open development model, open source product. License is GPLv2+
  58
  59
  60 Support
  61 =======
  62
  63 The Pidgin project does not support third-party plugins! If you have problems
  64 with this plugin then please check out the support forums:
  65
  66     http://sourceforge.net/p/sipe/discussion/
  67
  68 Bugs should be reported here:
  69
  70     https://sourceforge.net/p/sipe/bugs/
  71
  72
  73 Localization
  74 ============
  75
  76 SIPE has already been localized for several languages. You can help to
  77 translate SIPE to your native language at Transifex:
  78
  79     https://www.transifex.com/projects/p/pidgin-sipe/r/mob/
  80
  81 The service offers a convenient web editor and automatic submission to the
  82 repository.
  83
  84
  85 Installing from a distribution repository
  86 =========================================
  87
  88 Many Open Source OS distributions have a ready-made package "pidgin-sipe".
  89 Before trying to compile it from the source code yourself, you should try
  90 to install this package with the standard installation method provided by
  91 your OS.
  92
  93
  94 Do It Yourself I: compiling against "pidgin" package
  95 ====================================================
  96
  97 If you already have installed the "pidgin" package from your distribution
  98 repository and want compile pidgin-sipe from source code yourself, then you
  99 need to install the necessary headers first. Depending on your distribution
 100 you'll need to install one of the following packages
 101
 102         libpurple-dev
 103         libpurple-devel
 104
 105 For the compilation you'll need to install a C compiler and some of the
 106 following packages
 107
 108         libtool
 109         intltool
 110
 111         pkg-config
 112         libglib2.0-dev
 113         libxml2-dev
 114         libgmime-2.4-dev  (optional)
 115         libgmime-2.6-dev  (optional)
 116
 117         pkgconfig
 118         libglib2-devel
 119         libxml2-devel
 120         gettext-devel
 121         gmime-devel       (optional)
 122
 123 You have to choose between NSS or OpenSSL for the crypto backend. You'll
 124 need one of the following packages
 125
 126         for NSS:
 127         libnss3-dev
 128         nss-devel
 129         mozilla-nss-devel
 130
 131         for OpenSSL:
 132         libssl-dev
 133         openssl-devel
 134
 135 If you want to enable Kerberos authentication support then you'll need one
 136 of the following packages
 137
 138         libkrb5-dev
 139         krb5-devel
 140
 141 If you want to enable Voice & Video features then you'll need some of the
 142 following packages
 143
 144         libnice-dev           (>= 0.1.0)
 145         libgstreamer0.10-dev
 146
 147         libnice-devel         (>= 0.1.0)
 148         gstreamer-devel
 149
 150 Now you should be able to compile the source code with
 151
 152         ./configure --prefix=/usr
 153         make
 154
 155 If you get errors then you are missing some required package. After
 156 successful compilation you can install pidgin-sipe with:
 157
 158         su -c "make install"
 159
 160 If you get errors from configure or libtool about version conflicts then
 161 you need to regenerate the autoconf files. You'll need these additional
 162 packages
 163
 164         autoconf
 165         automake
 166
 167 Now you should be able to regenerate the files with
 168
 169         autoreconf --verbose --install --force
 170
 171 After that go back to the configure step above.
 172
 173
 174 Do It Yourself II: compiling against self-compiled pidgin
 175 =========================================================
 176
 177 If you have compiled pidgin from source code yourself then you'll have to
 178 specify the correct installation path in configure. Usually pidgin is
 179 installed in /usr/local so the following command should work
 180
 181         ./configure --prefix=/usr/local
 182
 183 The rest of the steps are the same as in the previous section.