#pimsync

Documentation | Source | Issues | Patches | Chat

This is the repository for pimsync, the rewrite and successor of vdirsyncer.

For documentation (including usage, compilation, installation and packaging), see the online documentation website. This website also includes an HTML version of the manual pages.

#Building the documentation website

You can build the documentation website locally with make site. This requires the following extra dependencies:

• mandoc
• py3-sphinx

Open the file docs/build/html/index.html to view the site locally.

The raw pages are also readable from the docs/ directory inside this repository.

#Developer documentation

The underlying synchronisation implementation is implemented in the vstorage library. If you want to make a different user interface based on pimsync, then you'll want to use this library. Pimsync itself merely parses a configuration file and executes the algorithms implemented in vstorage.

The following libraries were also developed as part of this project:

• libdav: CalDav and CardDav client implementations. Repository, documentation.
• davcli: CalDav and CardDav command line tool. Repository.
• vparser: Non-validating flexible parser for iCalendar and vCard data. Repository, documentation.

#JMAP support

JMAP support is currently experimental and must be enabled at build time via:

cargo build --features jmap 

#Contributing

See [HACKING.md].

#Thanks

Special thanks to the NLnet foundation that helped receive financial support from the NGI Zero Entrust program of the European Commission since early 2023.

#Licence

Copyright 2023-2024 Hugo Osvaldo Barrera
Licensed under the EUPL, Version 1.2 only
SPDX-License-Identifier: EUPL-1.2