diff --git a/AUTHORS.rst b/AUTHORS.rst index d35b316..699890b 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -8,6 +8,7 @@ In alphabetical order: - Clément Mondon - Hugo Osvaldo Barrera - Julian Mehne +- Malte Kiefer - Marek Marczykowski-Górecki - Markus Unterwaditzer - Michael Adler diff --git a/docs/index.rst b/docs/index.rst index 84b9a43..740d15a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -26,6 +26,7 @@ It aims to be for CalDAV and CardDAV what `OfflineIMAP partial-sync config supported + tutorials/index problems .. toctree:: diff --git a/docs/tutorials/claws-mail.rst b/docs/tutorials/claws-mail.rst new file mode 100644 index 0000000..d3508f4 --- /dev/null +++ b/docs/tutorials/claws-mail.rst @@ -0,0 +1,93 @@ +Vdirsyncer with Claws Mail +========================== + +First of all, Claws-Mail only supports **read-only** functions for vCards. It +can only read contacts, but there's no editor. + +Preparation +----------- + +We need to install vdirsyncer, for that look :doc:`here `. Then +we need to create some folders:: + + mkdir ~/.vdirsyncer + mkdir ~/.contacts + +Configuration +------------- + +Now we create the configuration for vdirsyncer. Open +``~/.vdirsyncer/config`` with a text editor. The config should look like +this: + +.. code:: ini + + [general] + status_path = "~/.vdirsyncer/status/" + + [storage local] + type = "singlefile" + path = "~/.contacts/%s.vcf" + + [storage online] + type = "carddav" + url = "CARDDAV_LINK" + username = "USERNAME" + password = "PASSWORD" + read_only = true + + [pair contacts] + a = "local" + b = "online" + collections = ["from a", "from b"] + conflict_resolution = "b wins" + +- In the general section, we define the status folder path, for discovered + collections and generally stuff that needs to persist between syncs. +- In the local section we define that all contacts should be sync in a single + file and the path for the contacts. +- In the online section you must change the url, username and password to your + setup. We also set the storage to read-only such that no changes get + synchronized back. Claws-Mail should not be able to do any changes anyway, + but this is one extra safety step in case files get corrupted or vdirsyncer + behaves eratically. You can leave that part out if you want to be able to + edit those files locally. +- In the last section we configure that online contacts win in a conflict + situation. Configure this part however you like. A correct value depends on + which side is most likely to be up-to-date. + +Sync +---- + +Now we discover and sync our contacts:: + + vdirsyncer discover contacts + vdirsyncer sync contacts + +Claws Mail +---------- + +Open Claws-Mail. Got to **Tools** => **Addressbook**. + +Click on **Addressbook** => **New vCard**. Choose a name for the book. + +Then search for the for the vCard in the folder **~/.contacts/**. Click +ok, and you we will see your conatcts. + +.. note:: + + Claws-Mail shows only contacts that have a mail address. + +Crontab +------- + +On the end we create a crontab, so that vdirsyncer syncs automatically +every 30 minutes our contacts:: + + contab -e + +On the end of that file enter this line:: + + */30 * * * * /usr/local/bin/vdirsyncer sync > /dev/null + +And you're done! diff --git a/docs/tutorials/index.rst b/docs/tutorials/index.rst new file mode 100644 index 0000000..17f6a02 --- /dev/null +++ b/docs/tutorials/index.rst @@ -0,0 +1,13 @@ +=============== +Other tutorials +=============== + +The following section contains tutorials not explicitly about any particular +core function of vdirsyncer. They usually show how to integrate vdirsyncer with +third-party software. Because of that, it may be that the information regarding +that other software may only apply to specific versions of them. + +.. toctree:: + :maxdepth: 1 + + claws-mail