Akonadi: Difference between revisions

From KDE Wiki Sandbox
No edit summary
(Remove KAlarm from list)
 
(38 intermediate revisions by 13 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 '''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 [[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>
</translate>
:{|
:{|
{{AppItem|KMail|<translate>
{{AppItem|KMail|<translate>
<!--T:37-->
View-pim-mail.png|
View-pim-mail.png|
KMail</translate>}}<translate>Mail Client
KMail</translate>}}<translate><!--T:38-->
Mail Client
Uses '''Akonadi''' to store emails
Uses '''Akonadi''' to store emails
</translate>
</translate>
|-
|-
{{AppItem|KAddressBook|<translate>
{{AppItem|KAddressBook|<translate>
<!--T:39-->
View-pim-contacts.png|
View-pim-contacts.png|
KAddressBook</translate>}}<translate>Contact Manager
KAddressBook</translate>}}<translate><!--T:40-->
Contact Manager
Uses '''Akonadi''' to store contact information
Uses '''Akonadi''' to store contact information
</translate>
</translate>
|-
|-
{{AppItem|KOrganizer|<translate>
{{AppItem|KOrganizer|<translate>
<!--T:41-->
View-pim-calendar.png|
View-pim-calendar.png|
KOrganizer</translate>}}<translate>Personal Organizer
KOrganizer</translate>}}<translate><!--T:42-->
Personal Organizer
Uses '''Akonadi''' to store calendars, events, journals, etc.
Uses '''Akonadi''' to store calendars, events, journals, etc.
</translate>
</translate>
|-
|-
{{AppItem|KJots|<translate>
{{AppItem|KJots|<translate>
<!--T:43-->
kjots.png|
kjots.png|
KJots</translate>}}<translate>Note Taking Application
KJots</translate>}}<translate><!--T:44-->
Note Taking Application
Uses '''Akonadi''' to store notes
Uses '''Akonadi''' to store notes
</translate>
</translate>
Line 40: Line 49:


<!--T:14-->
<!--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== <!--T:15-->
==Controlling the Akonadi server== <!--T:15-->


<!--T:16-->
<!--T:59-->
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 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-->
To start the Akonadi server,
To start the '''Akonadi''' server,


<!--T:18-->
<!--T:18-->
Line 54: Line 63:


<!--T:19-->
<!--T:19-->
To stop the Akonadi server,
To stop the '''Akonadi''' server,


<!--T:20-->
<!--T:20-->
Line 60: Line 69:


<!--T:21-->
<!--T:21-->
To restart a running Akonadi server,
To restart a running '''Akonadi''' server,


<!--T:22-->
<!--T:22-->
Line 66: Line 75:


<!--T:23-->
<!--T:23-->
To query the status of the Akonadi server,
To query the status of the '''Akonadi''' server,


<!--T:24-->
<!--T:24-->
{{Input|1=akonadictl status}}
{{Input|1=akonadictl status}}


===Disabling the Akonadi subsystem=== <!--T:25-->
===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-->
{{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.}}
{{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-->
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-->
<!--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, 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:30-->
<!--T:58-->
Now, edit the file <tt>~/.config/akonadi/akonadiserverrc</tt> and change <tt>StartServer</tt> from true to false:
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-->


<!--T:31-->
=== Where is my data now? === <!--T:45-->
{{Output|1=StartServer=false}}


<!--T:32-->
<!--T:46-->
The Akonadi server should no longer launch automatically on login.
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]


<!--T:33-->
=== How to upgrade my PostgreSQL database? === <!--T:60-->
{{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== <!--T:34-->
<!--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-->
<!--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.
'''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: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.


<!--T:9-->
<!--T:9-->
[[Category:System]]
[[Category:System]]
</translate>
</translate>

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.

Retrieved from "https://wikisandbox.kde.org/index.php?title=Akonadi&oldid=462121"