Akonadi: Difference between revisions
m (→Introduction: Add KAlarm) |
(Remove KAlarm from list) |
||
| (27 intermediate revisions by 12 users not shown) | |||
| Line 6: | Line 6: | ||
<!--T:2--> | <!--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, | 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/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:12--> | <!--T:12--> | ||
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. | 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. | ||
</translate><span id="ApplicationTable"></span><translate> | </translate><span id="ApplicationTable"></span><translate> | ||
| Line 44: | Line 44: | ||
Note Taking Application | Note Taking Application | ||
Uses '''Akonadi''' to store notes | Uses '''Akonadi''' to store notes | ||
</translate> | </translate> | ||
|}<translate> | |}<translate> | ||
| Line 60: | Line 53: | ||
==Controlling the Akonadi server== <!--T:15--> | ==Controlling the Akonadi server== <!--T:15--> | ||
<!--T: | <!--T:59--> | ||
The '''Akonadi''' control module | 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--> | <!--T:17--> | ||
| Line 87: | Line 80: | ||
{{Input|1=akonadictl status}} | {{Input|1=akonadictl status}} | ||
===Disabling the Akonadi subsystem=== <!--T: | ===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--> | <!--T:26--> | ||
{{Remember|1=If you don't want to have '''Akonadi''' running on your system, you can not use any of the '''Akonadi'''-enabled applications. Such applications will | {{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--> | <!--T:27--> | ||
| Line 96: | Line 93: | ||
<!--T:28--> | <!--T:28--> | ||
To disable the '''Akonadi''' subsystem | To disable the '''Akonadi''' subsystem, shut down the running Akonadi server from the control module or the command line: | ||
<!--T:29--> | <!--T:29--> | ||
{{Input|1=akonadictl stop}} | {{Input|1=akonadictl stop}} | ||
<!--T: | <!--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--> | ==Frequently Asked Questions== <!--T:34--> | ||
| Line 119: | Line 107: | ||
<!--T:46--> | <!--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] | 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--> | === Migration problems === <!--T:47--> | ||
<!--T:35--> | <!--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> | ||
Latest revision as of 22:37, 29 December 2020
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.
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 and uncheck 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.