Difference between revisions of "Akonadi"

(More specifics on the 100% CPU issue)
m (Added detail: "At the time of writing" is August, 2011. See History pages. Made a link more conspicuous.)
(46 intermediate revisions by 14 users not shown)
Line 5: Line 5:
  
 
<!--T:2-->
 
<!--T:2-->
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 [[Special:myLanguage/Plasma|Plasma]] widgets also use '''Akonadi''' to store and retrieve calendar events, notes, etc.
  
<!--T:3-->
+
<!--T:12-->
The page [[Special:myLanguage/KAddressBook_4.4|KAddressBook]] will help you get your new-style address book working smoothly with '''KMail'''.
+
At the time of writing (August, 2011), 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=== <!--T:4-->
+
</translate><span id="ApplicationTable"></span><translate>
 +
</translate>
 +
:{|
 +
{{AppItem|KMail|<translate>
 +
<!--T:37-->
 +
View-pim-mail.png|
 +
KMail</translate>}}<translate><!--T:38-->
 +
Mail Client
 +
Uses '''Akonadi''' to store emails
 +
</translate>
 +
|-
 +
{{AppItem|KAddressBook|<translate>
 +
<!--T:39-->
 +
View-pim-contacts.png|
 +
KAddressBook</translate>}}<translate><!--T:40-->
 +
Contact Manager
 +
Uses '''Akonadi''' to store contact information
 +
</translate>
 +
|-
 +
{{AppItem|KOrganizer|<translate>
 +
<!--T:41-->
 +
View-pim-calendar.png|
 +
KOrganizer</translate>}}<translate><!--T:42-->
 +
Personal Organizer
 +
Uses '''Akonadi''' to store calendars, events, journals, etc.
 +
</translate>
 +
|-
 +
{{AppItem|KJots|<translate>
 +
<!--T:43-->
 +
kjots.png|
 +
KJots</translate>}}<translate><!--T:44-->
 +
Note Taking Application
 +
Uses '''Akonadi''' to store notes
 +
</translate>
 +
|-
 +
{{AppItem|KAlarm|<translate>
 +
<!--T:49-->
 +
kalarm.png|
 +
KAlarm</translate>}}<translate>
 +
<!--T:50-->
 +
Personal alarm scheduler
 +
Uses '''Akonadi''' to store alarms
 +
</translate>
 +
|}<translate>
  
<!--T:5-->
 
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.
 
  
== Troubleshooting Tips and Common Problems == <!--T:6-->
+
<!--T:14-->
 +
In addition to this, plasma widgets like the '''Digital Clock''' widget, the '''Notes''' widget also use '''Akonadi''' to store and retrieve events and notes.
  
<!--T:7-->
+
==Controlling the Akonadi server== <!--T:15-->
If you have any problems with getting '''Akonadi''' working please visit [[Special:myLanguage/Akonadi_4.4/Troubleshooting|the Troubleshooting page]].
 
  
<!--T:8-->
+
<!--T:59-->
For help getting address books recognised, please see [[Special:myLanguage/KAddressBook_4.4|KAddressBook]].
+
The '''Akonadi''' control module started by the context menu of the '''Akonadi''' tray icon 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 <code>akonadictl</code>. Using this method, you can get additional useful information on the console.
  
<!--T:10-->
+
<!--T:17-->
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.
+
To start the '''Akonadi''' server,
  
<!--T:11-->
+
<!--T:18-->
Disable the Nepomuk search plugin. It is suspected that this is the cause of the problem. Please report back, here, on the Forum, or on IRC #kde-www if you try it.
+
{{Input|1=akonadictl start}}
 +
 
 +
<!--T:19-->
 +
To stop the '''Akonadi''' server,
 +
 
 +
<!--T:20-->
 +
{{Input|1=akonadictl stop}}
 +
 
 +
<!--T:21-->
 +
To restart a running '''Akonadi''' server,
 +
 
 +
<!--T:22-->
 +
{{Input|1=akonadictl restart}}
 +
 
 +
<!--T:23-->
 +
To query the status of the '''Akonadi''' server,
 +
 
 +
<!--T:24-->
 +
{{Input|1=akonadictl status}}
 +
 
 +
===Disabling the Akonadi subsystem=== <!--T:56-->
 +
 
 +
<!--T:57-->
 +
The '''Akonadi''' server is started by any '''Akonadi'''-enabled application. If you don't want Akonadi to be started after login, you have to 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 (see the "Display Events" option) .  You must remove any widgets that may start it from your start-up, if you wish Akonadi to start only when you start '''KMail''' or other applications.
 +
 
 +
 
 +
<!--T:26-->
 +
{{Remember|1=If you don't want to have '''Akonadi''' running on your system at all, you can not use any of the '''Akonadi'''-enabled applications. Such applications will not work when '''Akonadi''' is disabled using the steps below. See the list of [[Special:myLanguage/Akonadi#ApplicationTable|Akonadi-enabled applications]]. Also note, that some '''Plasma''' widgets, such as the '''Digital Clock''' uses '''Akonadi'''.}}
 +
 
 +
<!--T:27-->
 +
The '''Akonadi''' server is launched automatically at login whenever any '''Akonadi'''-enabled application requests access to it.
 +
 
 +
<!--T:28-->
 +
To disable the '''Akonadi''' subsystem, shut down the running Akonadi server from the control module or the command line:
 +
 
 +
<!--T:29-->
 +
{{Input|1=akonadictl stop}}
 +
 
 +
<!--T:58-->
 +
To ensure that Akonadi is not started, check that no applications require it at login. In particular, open the Plasma clock applet preferences, go to <menuchoice>Calendar</menuchoice> and uncheck <menuchoice>Show events</menuchoice> to prevent Plasma from requesting information from Akonadi and thus allowing it to start.
 +
 
 +
==Frequently Asked Questions== <!--T:34-->
 +
 
 +
=== Where is my data now? === <!--T:45-->
 +
 
 +
<!--T:46-->
 +
A full explanation of where the data is stored and Akonadi's interaction with it is available in [http://blogs.kde.org/node/4503 Andras Mantia's blog]
 +
 
 +
=== How to upgrade my PostgreSQL database? === <!--T:60-->
 +
 
 +
<!--T:61-->
 +
After updating your PostgreSQL server to a new major version, sometimes you will have to convert your Akonadi database for use with this new version. Instructions can be found on [[Special:myLanguage/Akonadi/Postgres_update|this page]].
 +
 
 +
=== Migration problems === <!--T:47-->
 +
 
 +
<!--T:35-->
 +
'''Akonadi's''' [[Special:myLanguage/Glossary#Akonadi|Glossary entry]] has a brief description of Akonadi's purpose, and other useful links. [[Special:myLanguage/Akonadi_and_AddressBook|This page]] explains how '''Akonadi''' and '''KAddressBook''' work together.
  
 
<!--T:9-->
 
<!--T:9-->
 
[[Category:System]]
 
[[Category:System]]
 
</translate>
 
</translate>

Revision as of 00:47, 5 August 2019

Other languages:
Bahasa Indonesia • ‎Deutsch • ‎English • ‎Nederlands • ‎Türkçe • ‎català • ‎dansk • ‎español • ‎français • ‎galego • ‎hrvatski • ‎italiano • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎suomi • ‎svenska • ‎čeština • ‎Ελληνικά • ‎русиньскый • ‎русский • ‎українська • ‎አማርኛ • ‎中文(中国大陆)‎ • ‎中文(台灣)‎

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 (August, 2011), 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

View-pim-mail.png Mail Client

Uses Akonadi to store emails

KAddressBook

View-pim-contacts.png Contact Manager

Uses Akonadi to store contact information

KOrganizer

View-pim-calendar.png Personal Organizer

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

KJots

Kjots.png Note Taking Application

Uses Akonadi to store notes

KAlarm

Kalarm.png Personal alarm scheduler

Uses Akonadi to store alarms

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 started by the context menu of the Akonadi tray icon 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. Using this method, you can get additional useful information on the console.

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

The Akonadi server is started by any Akonadi-enabled application. If you don't want Akonadi to be started after login, you have to 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 (see the "Display Events" option) . You must remove any widgets that may start it from your start-up, if you wish Akonadi to start only when you start KMail or other applications.


Flag-red.png
Remember
If you don't want to have Akonadi running on your system at all, you can not use any of the Akonadi-enabled applications. Such applications will not work when Akonadi is disabled using the steps below. See the list of Akonadi-enabled applications. Also note, that some Plasma widgets, such as the Digital Clock uses Akonadi.


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

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

akonadictl stop

To ensure that Akonadi is not started, check that no applications require it at login. In particular, open the Plasma clock applet preferences, go to Calendar and uncheck Show events to prevent Plasma from requesting information from Akonadi and thus allowing it to start.

Frequently Asked Questions

Where is my data now?

A full explanation of where the data is stored and Akonadi's interaction with it is available in Andras Mantia's blog

How to upgrade my PostgreSQL database?

After updating your PostgreSQL server to a new major version, sometimes you will have to convert your Akonadi database for use with this new version. Instructions can be found on this page.

Migration problems

Akonadi's Glossary entry has a brief description of Akonadi's purpose, and other useful links. This page explains how Akonadi and KAddressBook work together.


This page was last edited on 5 August 2019, at 00:47. Content is available under Creative Commons License SA 4.0 unless otherwise noted.