Akonadi

    From KDE UserBase Wiki
    Revision as of 18:23, 6 August 2011 by Karthikp (talk | contribs) (Changed the flow of the page to link to related pages more logically.)

    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

    File:KMail.png Mail Client

    Uses Akonadi to store emails

    KAddressBook

    Contact Manager

    Uses Akonadi to store contact information

    KOrganizer

    File:KOrganizer.png Personal Organizer

    Uses Akonadi to store calendars, events, journals, etc.

    KJots

    File:KJots.png 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.


    Shut down the Akonadi server from the control module or the command line:

    akonadictl stop

    Now, to disable autostarting the Akonadi server during login, edit the file ~/.config/akonadi/akonadiserverrc and change StartServer from true to false:

    StartServer=false

    The Akonadi server will no longer launch automatically.

    Note

    The Akonadi server will still be started by any Akonadi-enabled application. Ensure that no akonadi-enabled application is launched or running. 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.