libopensync-plugin-akonadi README

This is a plugin to sync Akonadi-based PIM data with other devices via OpenSync
0.22. This is NOT compatible with OpenSync 0.30 or greater.

Once installed, verify the plugin is detected by OpenSync.
  > msynctool --listplugins
  # akonadi-sync

To use this plugin, add the "akonadi-sync" plugin as a member to an OpenSync
sync group.  For example, with msynctool:
  > msynctool --addgroup test 
  > msynctool --addmember test akonadi-sync

This plugin has an optional configuration to choose which collection to add new
items to.  This needs the Akonadi collection id. Either use kitchensync to
select the collection or look at the debug output of the plugin:
  > mkdir ~/logs; OSYNC_TRACE=~/logs msynctool --sync test 
  > grep "collection id" ~/logs/*
  # [AKONADI-SYNC] INFORMATION: Fetching items from collection id 4 name Personal Contacts 
  # [AKONADI-SYNC] INFORMATION: Fetching items from collection id 6 name akonadi_ical_resource_0

If editing manually, make sure the configuration file must adhere to the
following format:
<?xml version="1.0"?>
<config>
    <!-- Akonadi collection ID to write to (integers); leave blank for first available -->
    <contacts>{YOUR_CONTACTS_COLLECTION_ID_GOES_HERE}</contacts>
    <events>{YOUR_EVENTS_COLLECTION_ID__GOES_HERE}</events>
</config>