mirror of
https://github.com/samsonjs/vdirsyncer.git
synced 2026-04-27 14:57:41 +00:00
Formatting fixes
This commit is contained in:
parent
811f378ece
commit
cae0abe8c1
4 changed files with 42 additions and 39 deletions
44
docs/api.rst
44
docs/api.rst
|
|
@ -11,24 +11,26 @@ General Section
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
[general]
|
[general]
|
||||||
status_path = ...
|
status_path = ...
|
||||||
#processes = 0
|
#processes = 0
|
||||||
|
|
||||||
- ``status_path``: A directory where vdirsyncer will store metadata for the
|
|
||||||
next sync. The data is needed to determine whether a new item means it has
|
|
||||||
been added on one side or deleted on the other.
|
|
||||||
|
|
||||||
- ``processes``: Optional, defines the amount of maximal connections to use
|
- ``status_path``: A directory where vdirsyncer will store metadata for the
|
||||||
for syncing. By default there is no limit, which means vdirsyncer will try
|
next sync. The data is needed to determine whether a new item means it has
|
||||||
to open a connection for each collection to be synced. The value ``0`` is
|
been added on one side or deleted on the other.
|
||||||
ignored. Setting this to ``1`` will only synchronize one collection at a
|
|
||||||
time.
|
- ``processes``: Optional, defines the amount of maximal connections to use for
|
||||||
|
syncing. By default there is no limit, which means vdirsyncer will try to
|
||||||
While this often greatly increases performance, you might have valid reasons
|
open a connection for each collection to be synced. The value ``0`` is
|
||||||
to set this to a smaller number. For example, your DAV server running on a
|
ignored. Setting this to ``1`` will only synchronize one collection at a
|
||||||
Raspberry Pi is so slow that multiple connections don't help much, since the
|
time.
|
||||||
CPU and not the network is the bottleneck.
|
|
||||||
|
While this often greatly increases performance, you might have valid reasons
|
||||||
|
to set this to a smaller number. For example, your DAV server running on a
|
||||||
|
Raspberry Pi is so slow that multiple connections don't help much, since the
|
||||||
|
CPU and not the network is the bottleneck.
|
||||||
|
|
||||||
.. _pair_config:
|
.. _pair_config:
|
||||||
|
|
||||||
|
|
@ -36,17 +38,18 @@ Pair Section
|
||||||
------------
|
------------
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
[pair pair_name]
|
[pair pair_name]
|
||||||
a = ...
|
a = ...
|
||||||
b = ...
|
b = ...
|
||||||
#conflict_resolution = ...
|
#conflict_resolution = ...
|
||||||
|
|
||||||
- ``a`` and ``b`` reference the storages to sync by their names.
|
- ``a`` and ``b`` reference the storages to sync by their names.
|
||||||
|
|
||||||
- ``conflict_resolution``: Optional, define how conflicts should be handled.
|
- ``conflict_resolution``: Optional, define how conflicts should be handled. A
|
||||||
A conflict occurs when one item changed on both sides since the last sync.
|
conflict occurs when one item changed on both sides since the last sync.
|
||||||
Valid values are ``a wins`` and ``b wins``. By default, vdirsyncer will
|
Valid values are ``a wins`` and ``b wins``. By default, vdirsyncer will show
|
||||||
show an error and abort the synchronization.
|
an error and abort the synchronization.
|
||||||
|
|
||||||
.. _storage_config:
|
.. _storage_config:
|
||||||
|
|
||||||
|
|
@ -54,12 +57,13 @@ Storage Section
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
[storage storage_name]
|
[storage storage_name]
|
||||||
type = ...
|
type = ...
|
||||||
|
|
||||||
- ``type`` defines which kind of storage is defined. See :ref:`storages`.
|
- ``type`` defines which kind of storage is defined. See :ref:`storages`.
|
||||||
|
|
||||||
- Any further parameters are passed on to the storage class.
|
- Any further parameters are passed on to the storage class.
|
||||||
|
|
||||||
.. _storages:
|
.. _storages:
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,15 +2,15 @@
|
||||||
Troubleshooting
|
Troubleshooting
|
||||||
===============
|
===============
|
||||||
|
|
||||||
- **[Errno 185090050] _ssl.c:343: error:0B084002:x509 certificate
|
- **[Errno 185090050] _ssl.c:343: error:0B084002:x509 certificate
|
||||||
routines:X509_load_cert_crl_file:system lib**
|
routines:X509_load_cert_crl_file:system lib**
|
||||||
|
|
||||||
vdirsyncer cannot find the path to your certificate bundle, you need to
|
vdirsyncer cannot find the path to your certificate bundle, you need to
|
||||||
supply it as a parameter to ``verify`` in your config file, e.g.::
|
supply it as a parameter to ``verify`` in your config file, e.g.::
|
||||||
|
|
||||||
verify = /usr/share/ca-certificates/cacert.org/cacert.org_root.crt
|
verify = /usr/share/ca-certificates/cacert.org/cacert.org_root.crt
|
||||||
|
|
||||||
- **During sync an error occurs: TypeError: request() got an unexpected keyword
|
- **During sync an error occurs: TypeError: request() got an unexpected keyword
|
||||||
argument 'verify'**
|
argument 'verify'**
|
||||||
|
|
||||||
You need to update your version of requests.
|
You need to update your version of requests.
|
||||||
|
|
|
||||||
|
|
@ -5,11 +5,11 @@ Tutorial
|
||||||
Installation
|
Installation
|
||||||
============
|
============
|
||||||
|
|
||||||
- Make sure you have Python 2.7+ or Python 3.3+ installed.
|
- Make sure you have Python 2.7+ or Python 3.3+ installed.
|
||||||
|
|
||||||
- ``pip install --user vdirsyncer``.
|
- ``pip install --user vdirsyncer``.
|
||||||
|
|
||||||
- Check if the ``vdirsyncer`` command is available.
|
- Check if the ``vdirsyncer`` command is available.
|
||||||
|
|
||||||
Configuration
|
Configuration
|
||||||
=============
|
=============
|
||||||
|
|
@ -69,14 +69,14 @@ But what if we want to synchronize multiple addressbooks from the same server?
|
||||||
Of course we could create new pairs and storages for each addressbook, but that
|
Of course we could create new pairs and storages for each addressbook, but that
|
||||||
is very tedious to do. Instead we will use a shortcut:
|
is very tedious to do. Instead we will use a shortcut:
|
||||||
|
|
||||||
- Remove the last segment from the URL, so that it ends with ``.../bob/``
|
- Remove the last segment from the URL, so that it ends with ``.../bob/``
|
||||||
instead of ``.../bob/default/``.
|
instead of ``.../bob/default/``.
|
||||||
|
|
||||||
- Add the following line to the *pair* section::
|
- Add the following line to the *pair* section::
|
||||||
|
|
||||||
[pair my_contacts]
|
[pair my_contacts]
|
||||||
...
|
...
|
||||||
collections = default,work
|
collections = default,work
|
||||||
|
|
||||||
This will synchronize
|
This will synchronize
|
||||||
``https://owncloud.example.com/remote.php/carddav/addressbooks/bob/default/``
|
``https://owncloud.example.com/remote.php/carddav/addressbooks/bob/default/``
|
||||||
|
|
|
||||||
|
|
@ -60,7 +60,6 @@ class HttpStorage(Storage):
|
||||||
|
|
||||||
A simple example::
|
A simple example::
|
||||||
|
|
||||||
# HTTP CALENDAR
|
|
||||||
[pair holidays]
|
[pair holidays]
|
||||||
a = holidays_local
|
a = holidays_local
|
||||||
b = holidays_remote
|
b = holidays_remote
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue