Akonadi: Difference between revisions

Latest revision as of 22:37, 29 December 2020

Other languages:

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
	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 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.

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.

@@ Line 1: / Line 1: @@
-{{Template:I18n/Language Navigation Bar|Akonadi}}
+<languages />
+<translate>
-==Introduction==
+==Introduction== <!--T:1-->
-IN KDE Software Compilation 4.4 KAddressBook became the first application to use Akonadi.  There are inevitable glitches in early stages of migration, and '''[[Akonadi_4.4/Troubleshooting|the Troubleshooting page]]''' will help solve them.  For a brief description of the purpose of Akonadi, see '''[[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 page '''[[KAddressBook_4.4|KAddressBook]]''' will help you get your new-style addressbook working smoothly with KMail.
+<!--T:2-->
+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.
-===Understanding the Structure===
+<!--T:12-->
-You can, of course, simply use Kontact to manage all your addressbook, 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 '''[[Akonadi_and_AddressBook]]''' will help.
+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.
-== Troubleshooting Tips and Common Problems ==
+</translate><span id="ApplicationTable"></span><translate>
-If you have any problems with getting Akonadi working please visit '''[[Akonadi_4.4/Troubleshooting|the Troubleshooting page]]'''.
+</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>
+|}<translate>
-For help getting addressbooks recognised, please see '''[[KAddressBook_4.4|KAddressBook]]'''
+<!--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.
+==Controlling the Akonadi server== <!--T:15-->
+<!--T:59-->
+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:17-->
+To start the '''Akonadi''' server,
+<!--T:18-->
+{{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-->
 [[Category:System]]
+</translate>