================== Supported Software ================== Client applications =================== The following software has been reported to work well with vdirsyncer, however, none of it is regularly tested. Calendars --------- - khal_, a CLI calendar application supporting :doc:`vdir `. You can use :py:class:`vdirsyncer.storage.FilesystemStorage` with it. - Many graphical calendar apps such as dayplanner_, Orage_ or rainlendar_ save a calendar in a single ``.ics`` file. You can use :py:class:`vdirsyncer.storage.SingleFileStorage` with those. .. _khal: http://lostpackets.de/khal/ .. _dayplanner: http://www.day-planner.org/ .. _Orage: http://www.kolumbus.fi/~w408237/orage/ .. _rainlendar: http://www.rainlendar.net/ Contacts -------- - khard_, a commandline addressbook supporting :doc:`vdir `. You can use :py:class:`vdirsyncer.storage.FilesystemStorage` with it. - `The ppl addressbook `_ uses a storage format similar to :doc:`vdir `. There are some pitfalls though, `see the notes on the related issue `_. - contactquery.c_, a small program explicitly written for querying vdirs from mutt. - mates_, a commandline addressbook supporting :doc:`vdir `. .. _khard: https://github.com/scheibler/khard/ .. _contactquery.c: https://github.com/t-8ch/snippets/blob/master/contactquery.c .. _mates: https://github.com/untitaker/mates.rs .. _supported-servers: Supported servers ================= CalDAV and CardDAV servers not listed here may work anyway. Radicale -------- Radicale is a very lightweight server, however, it intentionally doesn't implement the CalDAV and CardDAV standards completely, which might lead to issues even with very well-written clients. That said, vdirsyncer is continuously tested against the git version and the latest PyPI release of Radicale_. Older versions have substantial deficiencies, and using them is neither supported nor encouraged. - Radicale doesn't `support time ranges in the calendar-query of CalDAV `_, so setting ``start_date`` and ``end_date`` for :py:class:`vdirsyncer.storage.CaldavStorage` will have no or unpredicted consequences. - `Versions of Radicale older than 0.9b1 choke on RFC-conform queries for all items of a collection `_. You have to set ``item_types = ["VTODO", "VEVENT"]`` in :py:class:`vdirsyncer.storage.CaldavStorage` for vdirsyncer to work with those versions. .. _Radicale: http://radicale.org/ ownCloud -------- Vdirsyncer is continuously tested against the latest version of ownCloud_. - *Versions older than 7.0.0:* ownCloud uses SabreDAV, which had problems detecting collisions and race-conditions. The problems were reported and are fixed in SabreDAV's repo, and the corresponding fix is also in ownCloud since 7.0.0. See :gh:`16` for more information. .. _ownCloud: https://owncloud.org/ FastMail -------- Vdirsyncer is irregularly tested against FastMail_. There are no known issues with it. `FastMail's support pages `_ provide the settings to use:: [storage cal] type = caldav url = https://caldav.messagingengine.com/ username = ... password = ... [storage card] type = carddav url = https://carddav.messagingengine.com/ username = ... password = ... .. _FastMail: https://www.fastmail.com/ iCloud ------ Vdirsyncer is irregularly tested against iCloud_. There are no known issues with it. :: [storage cal] type = caldav url = https://caldav.icloud.com/ username = ... password = ... [storage card] type = carddav url = https://contacts.icloud.com/ username = ... password = ... .. _iCloud: https://www.icloud.com/ DavMail (Exchange, Outlook) --------------------------- Using vdirsyncer with DavMail_ is currently not recommended (if even possible). - DavMail (or the server it is proxying) handles URLs case-insensitively. See :gh:`144`. .. _DavMail: http://davmail.sourceforge.net/ Baikal ------ Vdirsyncer is continuously tested against the latest version of Baikal_. - Baikal up to ``0.2.7`` also uses an old version of SabreDAV, with the same issue as ownCloud, see :gh:`160`. .. _Baikal: http://baikal-server.com/ Google ------ Vdirsyncer can currently download events from Google Calendar, but any writing/uploading is explicitly prohibited by Google. `Google's support forum `_ explains how to set up its CalDAV support:: [storage cal] type = caldav url = https://www.google.com/calendar/dav/ username = ... password = ... read_only = true Unfortunately vdirsyncer current doesn't support Google Contacts in any way. See :gh:`8` for the discussion.