| blob | 294f5e8d453dc7c8b302f8c9051e8c776a7d22c4 |
1 Information for packagers of KDEPIM
2 =====================================
4 This document gives some hints to packagers on what is needed to provide
5 a sane installation and packaging for KDEPIM.
7 Akonadi is a key component of KDEPIM that is used by almost all applications.
8 It depends on several components to be properly installed and configured,
9 which are listed below.
11 Also, this document discusses other topics which are of importance for
12 packagers, such as the GPG support.
15 Baloo
16 ------------------
17 Akonadi uses Baloo for all kind of searches.
19 MySQL
20 -----
21 Akonadi needs a relational database to keep metadata about the PIM data it
22 manages. There exists different backends for MySQL, PostgreSQL and SQLite.
23 While it might be tempting to use the SQLite backend to reduce dependencies,
24 we highly discourage to use it, because it is not yet finished, can lose
25 your data, has performance problems and is not automatically tested yet!
27 The PostgreSQL backend has some more testing, however we discourage the
28 use of it as well, because it will make the migration path much harder once
29 we'll switch to Virtuoso as SQL backend in the future. So please make MySQL a
30 hard (runtime) dependency for Akonadi and compile the Qt library with support
31 for MySQL (can be done as plugin as well).
34 Akonadi
35 -------
36 Having a working installation of Baloo and MySQL should
37 normally result in a working installation of Akonadi. Akonadi provides a self
38 test dialog to make sure it really works. Please make sure all tests in this
39 self test dialog pass. The test can be found in a control center module that is
40 started with 'kcmshell4 kcm_akonadi'. The test is in the tab 'Akonadi Server
41 Configuration' and is started with the 'Test...' button.
44 KDEPIM-Runtime
45 --------------
46 (most of) The kdepim applications can use one or several Akonadi Resources in order
47 to fetch and store PIM data.
49 It is usually a good idea to install the kdepim-runtime package when installing
50 one of the KDEPIM applications. As the module name indicates, it is only needed at
51 runtime.
53 The kdepim-runtime module contains applications and plugins, for example
54 Akonadi resources or KIO slaves, that are needed by all applications making use
55 of the PIM API in kdepimlibs.
57 Third-party applications which use the PIM API can be installed without installing
58 the rest of KDEPIM, only KDEPIM-Runtime (and of course kdepimlibs) is needed.
60 If you don't install KDEPIM-Runtime for third-party applications which use the PIM
61 API of kdepimlibs, these applications will fail to work at runtime.
63 Note that not all parts of kdepimlibs require KDEPIM-Runtime at runtime, only
64 the parts that access the Akonadi store in some way, like 'kcalcore', 'kabc' or
65 'akonadi'. Other parts, like 'kmime' or 'gpgme++' are not accessing the Akonadi
66 store and therefore don't need KDEPIM-Runtime.
69 Kontact Plugins
70 ---------------
71 Kontact is a container application which embeds other PIM applications such as
72 KMail and KOrganizer. For an application to be embedded in Kontact, it needs to
73 provide a Kontact plugin. These Kontact plugins reside under kontact/plugins,
74 while the applications itself are in the top-level folder. This is important
75 when splitting up the KDEPIM module in several packages. The Kontact plugin
76 should be packaged together with its application. It is an error to install a
77 Kontact plugin without installing the associated application, this will make
78 Kontact crash. As an example, assume you want to provide a separate package for
79 KNode. This package should contain KNode from the knode/ directory, and the
80 Kontact plugin from the kontact/plugins/knode directory. kontact/plugins/knode
81 should not be installed when knode/ is not installed.
84 GPG Support
85 -----------
86 Crypto operations are supported in multiple places in KDEPIM: KMail provides
87 support for dealing with signed and encrypted mails, and Kleopatra is an
88 application that manages certificates and GPG keys. For this to work, GPG needs
89 to be installed and configured correctly. An easy way to check if you have a
90 working GPG installation is to run the self test in Kleopatra, which checks many
91 aspects of the GPG installation. After starting Kleopatra, the self test can be
92 found in the menu under 'Settings->Perform Self Test'. Please make sure the self
93 test passes. Another way to test is sending an encrypted and signed message
94 with KMail, and later decrypting the received message. Note that saving as draft
95 is not enough here, you need to actually send the mail.
97 A common packaging error is that gpg-agent is not running or that it is wrongly
98 configured. This will result in KMail failing on crypto operations with error
99 messages that give no indication of the real problem, such as 'bad passphrase'.
102 Libraries inside KDEPIM
103 -----------------------
104 There are several libraries in the KDEPIM module, such as 'libkdepim', 'libkleo'
105 or 'libksieve'. There is no guarantee for a stable API or ABI in those
106 libraries. API and ABI stability is only guaranteed for kdepimlibs. The
107 libraries of the KDEPIM module are generally work in progress and therefore
108 change a lot, API and ABI breakage can occur at any moment.
110 Therefore, please make sure to always ship the libraries with the exact same
111 revision numbers as the applications. This is always the case for the tags
112 created for KDE SC versions.
114 As an example, shipping libkdepim from KDE SC 4.4.1 together with KMail from KDE
115 SC 4.4.2 is an error, and can result in failure at runtime, since this libkdepim
116 is not binary compatible with that KMail.
119 Further resources
120 ----------------
121 Some frequently occurring problems with Akonadi are collected under
122 http://userbase.kde.org/Akonadi#Some_Technical_Issues.
124 For further questions feel free to contact the KDE PIM developers on
125 kde-pim@kde.org or ask on freenode IRC channel #kontact or #akonadi