README.rst

   1 Backup CardDAV vCards into git
   2 ==============================
   3
   4 Small script to backup address books stored on a CardDAV server into
   5 a local git repository.
   6 Git commit messages contain the names of modified, added and deleted contacts
   7 so it's easy to find out when someone was modified, and thus easy to find
   8 lost contacts.
   9
  10 Tested with vdirsyncer 0.19.2 and Nextcloud 23.
  11
  12
  13 Setup
  14 -----
  15 1. Install `vdirsyncer`__ 0.19.x
  16 2. Clone this repository
  17 3. Run ``./backup.sh``. Directory ``contacts`` will be created and a
  18    sample sync configuration will be added
  19 4. In ``contacts`` directory adjust ``vdirsyncer-config``
  20    and test it with::
  21
  22      vdirsyncer --config=vdirsyncer-config discover
  23
  24    Create all local collections when asked.
  25 5. In ``contacts`` run::
  26
  27      vdirsyncer --config=vdirsyncer-config metasync
  28
  29 6. Run ``./backup.sh`` which should commit all contacts to git.
  30 7. Setup a cronjob on your home server to run ``backup.sh`` every night
  31
  32
  33 __ http://vdirsyncer.pimutils.org/en/stable/
  34
  35
  36 About
  37 -----
  38 This script was written by `Christian Weiske <https://cweiske.de/>`_
  39 and is licensed under the AGPL v3.