purple: improve Adium server hack
[siplcs.git] / README
blobaeb5f2277b539ddcdec282edcc31da129aefee5c
1 Introduction
2 ============
4 pidgin-sipe is a third-party plugin for the Pidgin multi-protocol instant
5 messenger. It implements the extended version of SIP/SIMPLE used by various
6 products:
8     * Microsoft Lync Server 2010
9     * Microsoft Office Communications Server (OCS 2007/2007 R2)
10     * Microsoft Live Communications Server (LCS 2003/2005)
11     * Reuters Messaging
13 With this plugin you should be able to replace your Microsoft Office
14 Communicator client with Pidgin.
17 Features
18 ========
20 The plugin has support for
22     * Instant Messaging (IM)
23     * Multiparty chat
24     * Enhanced presence
25     * Calendar integration with Exchange 2007/2010
26     * Contact details information - company, phones, web site, etc.
27     * Contact search - [MS-PRES] and [MS-DLX] methods supported
28     * Encrypted file transfer
29     * Call initiation through PBX
30     * NTLMv2, Kerberos & TLS-DSK authentication support
31     * TLS encryption support
32     * Translated to many languages
35 Advantages over Office Communicator products
36 ============================================
38     * Available on broader range of platforms: Linux, *BSD, Maemo, OSX,
39       commercial UNIX, Windows.
40     * Ability to simultaneously connect to several Office Communicator 
41       accounts in addition to public IM network accounts like MSN, AOL,
42       Yahoo. For example one account is in vendor company and another is 
43       in client company.
44     * Keeps history of communications in environments without Outlook. For
45       example in companies where Lotus Notes is deployed as a default
46       groupware client instead of Outlook.
47     * Lotus Notes/Domino calendar integration. Unique to SIPE.
48     * Open development model, open source product. License is GPLv2+
51 Support
52 =======
54 The Pidgin project does not support third-party plugins! If you have problems
55 with this plugin then please check out the support forums:
57     http://sf.net/projects/sipe/forums/
59 Bugs should be reported here:
61     https://sourceforge.net/tracker/?atid=949931&group_id=194563
64 Localization
65 ============
67 SIPE has already been localized for several languages. You can help to
68 translate SIPE to your native language at Transifex:
70     https://www.transifex.net/projects/p/pidgin-sipe/r/mob/
72 The service offers a convenient web editor and automatic submission to the
73 repository.
76 Installing from a distribution repository
77 =========================================
79 Many Open Source OS distributions have a ready-made package "pidgin-sipe".
80 Before trying to compile it from the source code yourself, you should try
81 to install this package with the standard installation method provided by
82 your OS.
85 Do It Yourself I: compiling against "pidgin" package
86 ====================================================
88 If you already have installed the "pidgin" package from your distribution
89 repository and want compile pidgin-sipe from source code yourself, then you
90 need to install the necessary headers first. Depending on your distribution
91 you'll need to install one of the following packages
93         libpurple-dev
94         libpurple-devel
96 For the compilation you'll need to install a C compiler and some of the
97 following packages
99         libtool
100         intltool
101         libglib2.0-dev
102         libglib2-devel
103         libxml2-dev
104         libxml2-devel
105         libnss3-dev
106         nss-devel
107         mozilla-nss-devel
108         gettext-devel
110 Now you should be able to compile the source code with
112         ./configure --prefix=/usr
113         make
115 If you get errors then you are missing some required package. After
116 successful compilation you can install pidgin-sipe with:
118         su -c "make install"
120 If you get errors from configure or libtool about version conflicts then
121 you need to regenerate the autoconf files. You'll need these additional
122 packages
124         autoconf
125         automake
127 Now you should be able to regenerate the files with
129         autoreconf --verbose --install --force
131 After that go back to the configure step above.
134 Do It Yourself II: compiling against self-compiled pidgin
135 =========================================================
137 If you have compiled pidgin from source code yourself then you'll have to
138 specify the correct installation path in configure. Usually pidgin is
139 installed in /usr/local so the following command should work
141         ./configure --prefix=/usr/local
143 The rest of the steps are the same as in the previous section.