Akonadi/en: Difference between revisions

Revision as of 04:53, 7 August 2011

Introduction

The Akonadi framework is responsible for providing applications with a centralized database to store, index and retrieve the user's personal information. This includes the user's emails, contacts, calendars, events, journals, alarms, notes, etc. In SC 4.4, KAddressBook became the first application to start using the Akonadi framework. In SC 4.7, KMail, KOrganizer, KJots, etc. were updated to use Akonadi as well. In addition, several Plasma widgets also use Akonadi to store and retrieve calendar events, notes, etc.

At the time of writing, the following applications are enabled to use the Akonadi framework to centrally store and access user data. Follow through to each application's page to learn more.

KMail
	Mail Client Uses Akonadi to store emails
KAddressBook
	Contact Manager Uses Akonadi to store contact information
KOrganizer
	Personal Organizer Uses Akonadi to store calendars, events, journals, etc.
KJots
	Note Taking Application Uses Akonadi to store notes

In addition to this, plasma widgets like the Digital Clock widget, the Notes widget also use Akonadi to store and retrieve events and notes.

Controlling the Akonadi server

The Akonadi control module in System Settings provides an easy means to starting, stopping, restarting and querying the status of the Akonadi server. You may also accomplish this from the commandline using the command akonadictl.

To start the Akonadi server,

akonadictl start

To stop the Akonadi server,

akonadictl stop

To restart a running Akonadi server,

akonadictl restart

To query the status of the Akonadi server,

akonadictl status

Disabling the Akonadi subsystem

Warning

Disabling the Akonadi subsystem causes all Akonadi-enabled applications to not have access to the user's data. This means you will not be able to use any of the above applications while Akonadi is turned off. If you understand this and still wish to disable the Akonadi subsystem, read on.

The Akonadi server is launched automatically at login whenever any Akonadi-enabled application requests access to it.

To disable the Akonadi subsystem, first, shut down the running Akonadi server from the control module or the command line:

akonadictl stop

Now, edit the file ~/.config/akonadi/akonadiserverrc and change StartServer from true to false:

StartServer=false

The Akonadi server should no longer launch automatically on login.

Note

The Akonadi server will still be started by any Akonadi-enabled application. Ensure that no akonadi-enabled application is launched at login or thereafter. Remember to check Plasma widgets as well — the Digital Clock widget in the default panel, for instance uses Akonadi to (optionally) display Calendar events and this is enabled in its settings by default.

Frequently Asked Questions

Refer to the Troubleshooting page for resolving glitches during migration. Akonadi's Glossary entry has a brief description of its purpose and other useful links. This page explains how Akonadi and KAddressBook work together.

If you are experiencing 100% CPU usage by the virtuoso-t process when using Akonadi and related applications, try this proposed workaround while it is being investigated: In KRunner's configuration page, disable the Nepomuk search plugin and the Contact plugin. Then, log out and back in. For further information and inputs, report back here or on the Forum or on the IRC channel #kontact.

@@ Line 3: / Line 3: @@
 ==Introduction==
-In KDE Software Compilation 4.4 '''KAddressBook''' became the first application to use '''Akonadi'''.  There are inevitable glitches in early stages of migration, and [[Special:myLanguage/Akonadi_4.4/Troubleshooting|the Troubleshooting page]] will help solve them.  For a brief description of the purpose of '''Akonadi''', see [[Special:myLanguage/Glossary#Akonadi|this Glossary entry]].  You will also find useful links to further reading.  Once the inevitable teething troubles are over '''Akonadi''' will provide a power-house usable by many applications.
+The '''Akonadi''' framework is responsible for providing applications with a centralized database to store, index and retrieve the user's personal information. This includes the user's emails, contacts, calendars, events, journals, alarms, notes, etc. In SC 4.4, [[Special:myLanguage/KAddressBook|KAddressBook]] became the first application to start using the '''Akonadi''' framework. In SC 4.7,
+[[Special:myLanguage/KMail|KMail]], [[Special:myLanguage/KOrganizer|KOrganizer]], [[Special:myLanguage/KJots|KJots]], etc. were updated to use '''Akonadi''' as well. In addition, several '''Plasma''' widgets also use '''Akonadi''' to store and retrieve calendar events, notes, etc.
-The page [[Special:myLanguage/KAddressBook/index|KAddressBook]] will help you get your new-style address book working smoothly with '''KMail'''.
+At the time of writing, the following applications are enabled to use the '''Akonadi''' framework to centrally store and access user data. Follow through to each application's page to learn more.
-===Understanding the Structure===
+:{|
+|colspan="2"|[[Special:myLanguage/KMail|KMail]]
+|-
+|[[Image:View-pim-mail.png|48px|link=Special:myLanguage/KMail]]||Mail Client
+Uses '''Akonadi''' to store emails
+|-
+|colspan="2"|[[Special:myLanguage/KAddressBook|KAddressBook]]
+|-
+|[[Image:View-pim-contacts.png|48px|link=Special:myLanguage/KAddressBook]]||Contact Manager
+Uses '''Akonadi''' to store contact information
+|-
+|colspan="2"|[[Special:myLanguage/KOrganizer|KOrganizer]]
+|-
+|[[Image:View-pim-calendar.png|48px|link=Special:myLanguage/KOrganizer]]||Personal Organizer
+Uses '''Akonadi''' to store calendars, events, journals, etc.
+|-
+|colspan="2"|[[Special:myLanguage/KJots|KJots]]
+|-
+|[[Image:kjots.png|48px|link=Special:myLanguage/KJots]]||Note Taking Application
+Uses '''Akonadi''' to store notes
+|}
-You can, of course, simply use '''Kontact''' to manage all your address book, but if you have a backup system in place, for instance, you'll want to know where your data is, and how it's handled.  The page [[Special:myLanguage/Akonadi_and_AddressBook|Akonadi and AddressBook]] will help.
+In addition to this, plasma widgets like the Digital Clock widget, the Notes widget also use Akonadi to store and retrieve events and notes.
-== Troubleshooting Tips and Common Problems ==
+==Controlling the Akonadi server==
-If you have any problems with getting '''Akonadi''' working please visit [[Special:myLanguage/Akonadi_4.4/Troubleshooting|the Troubleshooting page]].
+The Akonadi control module in System Settings provides an easy means to starting, stopping, restarting and querying the status of the Akonadi server. You may also accomplish this from the commandline using the command akonadictl.
-For help getting address books recognised, please see [[Special:myLanguage/KAddressBook/index|KAddressBook]].
+To start the Akonadi server,
-If you are experiencing 100% CPU usage by the ''virtuoso-t'' process when using Akonadi and related programs from KDE PIM 4.6, you should try this proposed workaround while it is being investigated.  In KRunner's configuration page, disable the Nepomuk search plugin and the Contact plugin, then log out and back in.
+{{Input|1=akonadictl start}}
-It is suspected that this is the cause of the problem.  Please report back, here, on the Forum, or on IRC #kontact if you try it.
+To stop the Akonadi server,
+{{Input|1=akonadictl stop}}
+To restart a running Akonadi server,
+{{Input|1=akonadictl restart}}
+To query the status of the Akonadi server,
+{{Input|1=akonadictl status}}
+===Disabling the Akonadi subsystem===
+{{Warning|1=Disabling the Akonadi subsystem causes all Akonadi-enabled applications to not have access to the user's data. This means you will not be able to use any of the above applications while Akonadi is turned off. If you understand this and still wish to disable the Akonadi subsystem, read on.}}
+The Akonadi server is launched automatically at login whenever any Akonadi-enabled application requests access to it.
+To disable the Akonadi subsystem, first, shut down the running Akonadi server from the control module or the command line:
+{{Input|1=akonadictl stop}}
+Now, edit the file <tt>~/.config/akonadi/akonadiserverrc</tt> and change <tt>StartServer</tt> from true to false:
+{{Output|1=StartServer=false}}
+The Akonadi server should no longer launch automatically on login.
+{{Note|1=The Akonadi server will still be started by any Akonadi-enabled application. Ensure that no akonadi-enabled application is launched at login or thereafter. Remember to check Plasma widgets as well — the Digital Clock widget in the default panel, for instance uses Akonadi to (optionally) display Calendar events and this is enabled in its settings by default.}}
+==Frequently Asked Questions==
+Refer to [[Special:myLanguage/Akonadi_4.4/Troubleshooting|the Troubleshooting page]] for resolving glitches during migration. Akonadi's [[Special:myLanguage/Glossary#Akonadi|Glossary entry]] has a brief description of its purpose and other useful links. [[Special:myLanguage/Akonadi_and_AddressBook|This]] page explains how Akonadi and KAddressBook work together.
+If you are experiencing 100% CPU usage by the ''virtuoso-t'' process when using Akonadi and related applications, try this proposed workaround while it is being investigated: In KRunner's configuration page, disable the Nepomuk search plugin and the Contact plugin. Then, log out and back in. For further information and inputs, report back here or on the Forum or on the IRC channel #kontact.
 [[Category:System]]