Akonadi: Difference between revisions
m (→Disabling the Akonadi subsystem: clarified the disabling section) |
(Marked this version for translation) |
||
| Line 8: | Line 8: | ||
[[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. | [[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. | ||
<!--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, 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. | ||
<!--T:13--> | |||
:{| | :{| | ||
|colspan="2"|[[Special:myLanguage/KMail|KMail]] | |colspan="2"|[[Special:myLanguage/KMail|KMail]] | ||
| Line 32: | Line 34: | ||
|} | |} | ||
<!--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. | 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== | ==Controlling the Akonadi server== <!--T:15--> | ||
<!--T:16--> | |||
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. | 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. | ||
<!--T:17--> | |||
To start the Akonadi server, | To start the Akonadi server, | ||
<!--T:18--> | |||
{{Input|1=akonadictl start}} | {{Input|1=akonadictl start}} | ||
<!--T:19--> | |||
To stop the Akonadi server, | To stop the Akonadi server, | ||
<!--T:20--> | |||
{{Input|1=akonadictl stop}} | {{Input|1=akonadictl stop}} | ||
<!--T:21--> | |||
To restart a running Akonadi server, | To restart a running Akonadi server, | ||
<!--T:22--> | |||
{{Input|1=akonadictl restart}} | {{Input|1=akonadictl restart}} | ||
<!--T:23--> | |||
To query the status of the Akonadi server, | To query the status of the Akonadi server, | ||
<!--T:24--> | |||
{{Input|1=akonadictl status}} | {{Input|1=akonadictl status}} | ||
===Disabling the Akonadi subsystem=== | ===Disabling the Akonadi subsystem=== <!--T:25--> | ||
<!--T:26--> | |||
{{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.}} | {{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.}} | ||
<!--T:27--> | |||
The Akonadi server is launched automatically at login whenever any Akonadi-enabled application requests access to it. | The Akonadi server is launched automatically at login whenever any Akonadi-enabled application requests access to it. | ||
<!--T:28--> | |||
To disable the Akonadi subsystem, first, shut down the running Akonadi server from the control module or the command line: | To disable the Akonadi subsystem, first, shut down the running Akonadi server from the control module or the command line: | ||
<!--T:29--> | |||
{{Input|1=akonadictl stop}} | {{Input|1=akonadictl stop}} | ||
<!--T:30--> | |||
Now, edit the file <tt>~/.config/akonadi/akonadiserverrc</tt> and change <tt>StartServer</tt> from true to false: | Now, edit the file <tt>~/.config/akonadi/akonadiserverrc</tt> and change <tt>StartServer</tt> from true to false: | ||
<!--T:31--> | |||
{{Output|1=StartServer=false}} | {{Output|1=StartServer=false}} | ||
<!--T:32--> | |||
The Akonadi server should no longer launch automatically on login. | The Akonadi server should no longer launch automatically on login. | ||
<!--T:33--> | |||
{{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.}} | {{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== | ==Frequently Asked Questions== <!--T:34--> | ||
<!--T:35--> | |||
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. | 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. | ||
<!--T:36--> | |||
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. | 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. | ||
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
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
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.