Akonadi

Introduction

This page is mainly concerned with troubleshooting Akonadi, as there are inevitable glitches in early stages of migration. For many people the first signs of Akonadi activity will be in KDE SC 4.4, and many will be confused by it. For a brief description of the purpose of Akonadi, see 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.

Understanding the Structure

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.

Troubleshooting Tips

• When reporting problems with the Akonadi server, always include the comprehensive self-test report. This report can be obtained from the self-test dialog which shows up whenever the Akonadi server was unable to start successfully. You can find the selftest dialog in the kcmmodule that is accessable via 'kcmshell4 kcm_akonadi'.

• Starting the Akonadi server manually on the command line can result in additional useful information. This can be done by running akonadictl start on a console. Similar, with akonadictl stop the Akonadi server can be stopped again. akonadictl status gives more useful information.

Common Problems

Kontact doesn't start - and doesn't tell me anything

If Kontact doesn't start, and you see no error messages, check that Akonadi is running. Akonadi should start on demand, but currently (January 2010) it doesn't. You have to start it before Kontact will start up if you have any migrated resources (most likely KAddressBook). Use the AkonadiTray icon to start it.

Kontact doesn't start - version II

Kontact has been known to be hit after an update. If this happens, try starting KMail, KOrganizer or any of the other applications from KRunner (or Konsole). Chances are high that they will work as stand-alone apps while you find what went wrong.

Folder not found: "/Local"

Many people have reported this error, when Kontact would not start. There seems to be a bug in the migration that is telling KMail to look for local mail in /home/anne/.local/share/Local, a directory that had not been set up. The cure for this is not to attempt to correct it, but, with KMail/Kontact closed, to open the Akonadi Console (user krunner, Alt-F2, or 'akonadiconsole' in konsole), and remove the resource that it says is for local mail. You should now find that you can start Kontact or KMail, and that a new resource will be created, pointing to /home/anne/.local/share/local-mail

There are other new folders under ~/.local/share/

Yes. If your addressbook has migrated correctly a new resource will have been created as ~/.local/share/contacts/

What are /usr/bin/akonadi_maildir_resource and /usr/bin/akonadi_maildispatcher_agent?

The akonadi_maildir_resource is created automatically by the akonadi_maildispatcher_agent, while the latter is always started together with the Akonadi server as it provides basic functionality (e.g. sending mail) that is used by all mail applications that are (and will be) based on Akonadi. So it is ok that these two are running, as a user you can simply ignore them. This autogenerated akonadi_maildir_resource will always point to ~/.local/share/local-mail/ which is your 'Local folders' account where your local folders and emails will be stored.

At this point, in KDE SC 4.4, mail is not yet being migrated.

Nepomuk Indexing Agents have been Disabled

Kontact is now working, but you keep seeing this notice:

The most common reason for this notice is that Nepomuk is simply disabled in System Settings. Please try enabling it in System Settings under Advanced / Desktop Search / Basic Settings by checking "Nepomuk Semantik Desktop" and clicking Apply.

If this does not help (or if the option was already checked when you got the error) and if you have previously been using prereleases of KDE SC 4.4, you may be affected by a change to the database layout (due to an upgrade of the Virtuoso database server from version 5 to version 6; production releases of KDE SC 4.4 are expected to be shipped with Virtuoso version 6). The following commands should get it working again:

qdbus org.kde.NepomukServer /nepomukserver org.kde.NepomukServer.quit

rm -r ~/.kde/share/apps/nepomuk

rm -r ~/.kde4/share/apps/nepomuk

nepomukserver

Note that the above commands will not enable Nepomuk permanently if it isn't already enabled, you have to use System Settings for that.

A running Nepomuk is necessary to have a working Akonadi, and thus a working Kontact. However, you can disable the Strigi file indexer, it is not needed for Kontact. Strigi file indexing is used for desktop searching only, which is unrelated to Kontact. Just make sure Nepomuk itself is running correctly for Kontact.

In Kontact, Nepomuk is used for many different things, ranging from displaying upcoming birthdays, over handling free/busy lists to showing a contact photo in the message viewer. If Nepomuk is not running, several different things in Kontact will cease to work. The notice is there to warn you about the reduced functionality. Enabling Nepomuk as described above fixes the problem.

You can check if Nepomuk is correctly running by typing akonadictl status.

I want to use my current Address Book and Organizer - Can I?

Yes. When you use the Akonadi Console to add a resource it allows you to choose as Standard Addressbook - point that to your std.vcf should work fine. Migration does not destroy your old addressbook. You can continue to use it, though you will lose any benefits that Akonadi can bring. Alternatively you can have both an Akonadi addressbook and your original one, for a time, if you feel safer that way.

I can't see any details in my Address Book

At the moment, the cause of this is not identified, but the cure is simple. Close Kontact, and start KAddressBook as a stand-alone application. After you close it you will be able to use it within Kontact. It seems that something is not being triggered when Kontact launches, and I expect this to be identified and fixed soon.

My contacts don't show when I use the Select button in KMail

Check System Settings > Advanced tab > KDE Resources. Make sure that your Akonadi controlled address book(s) are listed there - add them if necessary. At the same time, it's a good idea to make your main Akonadi addressbook, usually called Personal Contacts, is set to be the default.

How do I get my Groupware addressbook back?

Two solutions: using the old framework or the new one.

Old framework: In akonadiconsole, add a "KDE Address Book (traditional)". The KDE Address Book means you can set up old kresources for Akonadi. In the configuration of "KDE Address Book (traditional)", you point it to an "IMAP over KMail" KResource and in KMail, the groupware options should be enabled. This should work for Kolab, eGroupware and similar addressbooks - you will need to check the options to make sure that the correct type is selected.

New framework (only tested with kolab): In the akonadi configuration module (run 'kcmshell4 kcm_akonadi' to see it), add an "IMAP E-Mail Server" resource, and set up your mail server name, username and password, then click Auto-Detect. Then add a kolab resource. The next step is to wait for the imap resource to synchronize, this can take quite a long time. The status will appear in the akonadi configuration module. If nothing happens, try restarting akonadiserver. After some time the kolab addressbook(s) should appear in kaddressbook.

You experience long delays when sending mail

This is accompanied by KMail freezing until the mail is actually dispatched.

A bug has been found in the way Nepomuk checks addresses, which can cause huge delays. This is fixed for SC 4.4.1. Until that is with us, there is this work-around:

Close Kontact or KMail and KAddressbook if you are running stand-alone apps. Disable Strigi in SystemSettings. Stop Nepomuk, delete the database and restart nepomukserver. The actual commands you need are (as user)

qdbus org.kde.NepomukServer /nepomukserver org.kde.NepomukServer.quit
rm -r ~/.kde/share/apps/nepomuk	rm -r ~/.kde4/share/apps/nepomuk
nepomukserver

This will, of course, wipe out all the database, including any tags you've added. In theory, I understand that it's possible to do a more selective wipe of the database. If this matters to you you can find the instructions at

http://techbase.kde.org/Development/Tutorials/Metadata/Nepomuk/TipsAndTricks#Remove_all_Strigi-indexed_data

Some Technical Issues

Nepomuk

Starting with KDE 4.4, it is required that Nepomuk is running in order for Akonadi to work correctly. Akonadi will check this and display an error dialog on startup if this is not the case.

Nepomuk only works with the Virtuoso backend. You can check whether the Nepomuk is running with the correct backend by using the Akonadi self-test dialog, as described above.

Although Nepomuk is required to be running, you can still disable Strigi file indexing, which is usually the most resource-intensive part of the Nepomuk framework.

Apparmor

Some distributions using Apparmor have it set up in a way that prevents Akonadi from running its internal database server. This can result in a variety of fuzzy error messages, including but not limited to the following:

• unknown error 255 when running akonadictl
• "DB error: 'Could not open required defaults file: /home/$username/.local/share/akonadi/mysql.conf"

You can solve this by running aa-complain mysqld with root privileges then reload apparmor. On KUbuntu this is:

sudo aa-complain mysqld
sudo /etc/init.d/apparmor reload

Note that you might be using Apparmor even if it does not show up in the process list.

Also note that some distributions ship an additional mysqld binary called mysqld-akonadi which has AppArmor set up correctly. If that's the case on your system and you see this problem nevertheless, there are two possible reasons:

• Akonadi still uses mysqld instead of mysqld-akonadi. You can change that in Systemsettings -> Advanced -> Akonadi -> Server configuration.
• AppArmor is not setup correctly for mysqld-akonadi either. Try running the aa-complain command noted above with mysqld-akonadi instead of mysqld.

---

You will also experience this problem if you are running an encrypted home directory using encryptfs combined with AppArmor as the Akonadi apparmor profile currently does not account for an ecrypted home (common with Ubuntu Jaunty users). Error messages with include:

• dmesg produces:

     ecryptfs_do_create: Failure to create dentry in lower fs; rc = [-13]
     ecryptfs_create: Failed to create file inlower filesystem

• Akonadi will list the following errors:

     Akonadi server process not registered at D-Bus

The fix is to edit the following file "/etc/apparmor.d/usr.sbin.mysqld-akonadi". Below the line:

      @{HOME}/.local/share/akonadi/** rwk,

Add a new line:

      @{HOME}/.Private/** rwk,

Restart apparmor and restart akonadi.

Missing Prerequisite

To use Akonadi you need to have the following packages installed (names might differ depending on your distribution):

• The MySQL server (called mysql on OpenSuse)
• The Qt4 MySQL plugin (called libqt4-sql-mysql on OpenSuse)

If you compile Qt4 yourself, make sure to tell the configure script to build in MySQL support by passing it the '-plugin-sql-mysql' option. If configure cannot locate the necessary MySQL client code (i.e, says "MySQL support cannot be enabled due to functionality tests") then ensure that the corresponding package is installed (typically called [lib]mysql[client]-dev[el]). Also, depending on the install location of the MySQL headers, additional parameters to configure might be needed (eg. -I /usr/include/mysql on OpenSuse).

If you get the Qt4 direct from Nokia, such as a download of

 qt-sdk-linux-x86_64-opensource-2009.05.bin

you will ( by the command "akonadictl start") get an error at Test 1:

 Database driver not found.
 Details: The QtSQL driver 'QMYSQL' is required by your current Akonadi server configuration.
 The following drivers are installed: QSQLITE.
 Make sure the required driver is installed.

The driver you need is libqsqlmysql.so

Unfortunately this driver is not part of the distribution (until january 2010). You need to compile the source. Download it

 qt-everywhere-opensource-src-4.6.0.tar.bz

configure and make as above. But the make install doesn't copy the driver. So you have to copy it by yourself:

 cp <qt-src-dir>/qt-everywhere-opensource-src-4.6.0/plugins/sqldrivers/libqsqlmysql.so /usr/local/bin/sqldrivers/ 

But the Revision 4.6.1, such as qt-sdk-linux-x86_64-opensource-2010.xx.bin has the driver you needed.

Environment Setup

The Akonadi server searches for Akonadi agents and resources in the paths defined in the XDG_DATA_DIRS environment variable. If Akonadi complains about not finding agents or resources, check if this variable is set correctly. Also keep in mind that even if set in a current console session, it might not have been set when starting the server. Starting the server manually in the current console session excludes this cause.

mysqld: unknown variable 'innodb_file_per_table=1'

If the MySQL server log contains the following error: [ERROR] /usr/libexec/mysqld: unknown variable 'innodb_file_per_table=1' [ERROR] Aborting

then your MySQL server was built without the InnoDB support which is required by Akonadi.

Table 'mysql. servers' doesn't exist

If MySQL server log contains the following error: [ERROR] Can't open and lock privilege tables: Table 'mysql.servers' doesn't exist [ERROR] Cannot open mysql.db [ERROR] Cannot open mysql.user [ERROR] Cannot open mysql.event then, most probably, you don't have your MySQL configuration file in place. Copy it from /usr/share/config/akonadi/mysql-global.conf into ~/.config/akonadi/mysql-local.conf. (For debian and openSuSE users the file ist located in /etc/akonadi/mysql-global.conf). Then open it and uncomment the line sql_mode=strict_trans_tables. If, after that, you get the following errors: [ERROR] Plugin 'InnoDB' init function returned error. [ERROR] Plugin 'InnoDB' registration as a STORAGE ENGINE failed. [ERROR] Unknown/unsupported table type: innodb [ERROR] Aborting then in the same file find the line that starts just like the one above (which you have uncommented), but has additional parameters, separated by commas (something like sql_mode=strict_trans_tables,strict_all_tables, ...etc). Comment the shorter sql_mode=... line and uncomment the longer one.

On openSUSE 11.2 running the command mysql_install_db --datadir=$HOME/.local/share/akonadi/db_data/ will fix this problem.

Can't initialize character set latin1

If you get the following error when starting Akonadi:

Character set 'latin1' is not a compiled character set and is not specified in the '/usr/share/mysql/charsets/Index.xml' file Nepomuk QueryServer interface not available! Connecting to deprecated signal QDBusConnectionInterface::serviceOwnerChanged(QString,QString,QString) DataStore::unhideAllPimItems() Character set 'latin1' is not a compiled character set and is not specified in the '/usr/share/mysql/charsets/Index.xml' file Database error: Cannot open database. Last driver error: "QMYSQL: Unable to connect" Last database error: "Can't initialize character set latin1 (path: /usr/share/mysql/charsets/)" Database error: Cannot open database. Last driver error: "QMYSQL: Unable to connect" Last database error: "Can't initialize character set latin1 (path: /usr/share/mysql/charsets/)"

then you're probably using a MySQL server which has a version > 5.1.42. There is a known regression in MySQL 5.1.43 and 5.1.44 which prevents MySQL from starting.

See http://bugs.kde.org/226960 for more details.

Restarting after a previous error

If you had problems starting Akonadi and fixed those (such as a missing package or the Apparmor problem) make sure that the Akonadi server is completely shut down before trying to start it again, by calling akonadictl stop on the command line. You can confirm that it was indeed shut down completely by running akonadictl status.

Under some circumstances the Akonadi server can be stuck in a partially running state after a failure which will prevent the next attempt to start it to fail as well. Please file a bug report if you run into this problem including the self-test report of the initial problem.

The so-called "Gentoo-Assert"

That's an especially nasty problem that so far only affects users of source-based distributions, most prominently Gentoo. It is named after MySQL assertions like the following example and is most likely caused by a MySQL protocol mismatch between the MySQL server and the client library or the Qt MySQL driver.

akonadiserver: libmysql.c:4301: setup_one_fetch_function: Assertion `param->buffer_length != 0' failed.

It is extremely hard to diagnose as the assertion mentioned above are only triggered sometimes. Instead you'll get a wide range of weird symptoms:

• ASAP protocol logs show successful creation of objects which are supposedly no longer available when the next commands accesses them again.
• SQL protocol logs show INSERT or UPDATE commands with values that mismatch the corresponding column types and nevertheless succeed.
• SQL protocol logs showing large apparently random record ids which are nevertheless considered valid.

References:

• http://forum.kde.org/viewtopic.php?f=20&t=61738
• http://bugs.gentoo.org/show_bug.cgi?id=267513
• https://bugs.kde.org/202623 (contains a possible solution)
• http://bbs.archlinux.org/viewtopic.php?id=78358

Possible solution: Rebuild the Qt MySQL driver after upgrading MySQL (which most likely caused this problem in the first place).