A CalDAV/CardDAV server
Xandikos is a lightweight yet complete CardDAV/CalDAV server that backs onto a Git repository.
Xandikos (Ξανδικός or Ξανθικός) takes its name from the name of the March month in the ancient Macedonian calendar, used in Macedon in the first millennium BC.
Extended documentation can be found on the home page.
The following standards are implemented:
The following standards are not implemented:
See DAV compliance for more detail on specification compliancy.
Xandikos has been tested and works with the following CalDAV/CardDAV clients:
At the moment, Xandikos supports Python 3 (see pyproject.toml for specific version) as well as Pypy 3. It also uses Dulwich, Jinja2, icalendar, and defusedxml.
E.g. to install those dependencies on Debian:
sudo apt install python3-dulwich python3-defusedxml python3-icalendar python3-jinja2
Or to install them using pip:
python setup.py developDocker
A Dockerfile is also provided; see the comments on the top of the file for
configuration instructions. The docker image is regularly built and
published at ghcr.io/jelmer/xandikos
. See
examples/docker-compose.yml
and the
man page for more info.
Xandikos can either directly listen on a plain HTTP socket, or it can sit behind a reverse HTTP proxy.
To run a standalone (no authentication) instance of Xandikos, with a pre-created calendar and addressbook (storing data in $HOME/dav):
./bin/xandikos --defaults -d $HOME/dav
A server should now be listening on localhost:8080.
Note that Xandikos does not create any collections unless --defaults is specified. You can also either create collections from your CalDAV/CardDAV client, or by creating git repositories under the contacts or calendars directories it has created.
The easiest way to run Xandikos in production is by running a reverse HTTP proxy like Apache or nginx in front of it. The xandikos script can either listen on the local host on a particular port, or it can listen on a unix domain socket.
For example init system configurations, see examples/.
Some clients can automatically discover the calendars and addressbook URLs from a DAV server (if they support RFC:5397). For such clients you can simply provide the base URL to Xandikos during setup.
Clients that lack such automated discovery (e.g. Thunderbird Lightning) require
the direct URL to a calendar or addressbook. In this case you
should provide the full URL to the calendar or addressbook; if you initialized
Xandikos using the --defaults
argument mentioned in the previous section,
these URLs will look something like this:
http://dav.example.com/user/calendars/calendar http://dav.example.com/user/contacts/addressbook
Contributions to Xandikos are very welcome. If you run into bugs or have feature requests, please file issues on GitHub. If you're interested in contributing code or documentation, please read CONTRIBUTING. Issues that are good for new contributors are tagged new-contributor on GitHub.
There is a #xandikos IRC channel on the OFTC IRC network, and a Xandikos mailing list.
Twice a month we will interview people behind open source businesses. We will talk about how they are building a business on top of open source projects.
We'll never share your email with anyone else.