mirror of
https://github.com/samsonjs/vdirsyncer.git
synced 2026-03-25 08:55:50 +00:00
38 lines
953 B
ReStructuredText
38 lines
953 B
ReStructuredText
==========
|
|
vdirsyncer
|
|
==========
|
|
|
|
vdirsyncer synchronizes your calendars and addressbooks between two storages.
|
|
The supported storages are CalDAV, CardDAV, arbitrary HTTP resources, `vdir
|
|
<https://github.com/untitaker/vdir>`_ and some more. The documentation contains
|
|
a full `list of supported storages <storages>`.
|
|
|
|
It aims to be for CalDAV and CardDAV what `OfflineIMAP
|
|
<http://offlineimap.org/>`_ is for IMAP.
|
|
|
|
How to use
|
|
==========
|
|
|
|
vdirsyncer requires Python >= 2.7 or Python >= 3.3.
|
|
|
|
As all Python packages, vdirsyncer can be installed with ``pip``::
|
|
|
|
pip install --user vdirsyncer
|
|
|
|
Then copy ``example.cfg`` to ``~/.vdirsyncer/config`` and edit it. You can use the
|
|
`VDIRSYNCER_CONFIG` environment variable to change the path vdirsyncer will
|
|
read the config from.
|
|
|
|
Run ``vdirsyncer --help`` and read on:
|
|
|
|
Table of Contents
|
|
=================
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
storages
|
|
keyring
|
|
server_support
|
|
troubleshooting
|
|
license
|