Radicale Documentation

A simple CalDAV (calendar) and CardDAV (contact) server.

5,115 stars Python Python 1 file · ~1,329 tokens #caldav#carddav#icalendar#python
RAW Doc

Docker & Self-Hosted Deployment Verified OCI

Deploy Radicale on any server, homelab, or cloud container platform.

1-Click Terminal Command
bash (docker run) 
docker run -d --name radicale -p 5232:5232 --restart always ghcr.io/kozea/radicale:stable
Configured Services & Ports
⚙️ radicale
image: ghcr.io/kozea/radicale:stable
🔌 Ports: 5232:5232
docker-compose.yml
yaml (docker-compose.yml) 
name: Radicale
services:
    radicale:
        image: ghcr.io/kozea/radicale:stable
        ports:
        - 5232:5232
        volumes:
          - config:/etc/radicale
          - data:/var/lib/radicale

volumes:
  config:
    name: radicale-config
    driver: local
    driver_opts:
      type: none
      o: bind
      device: ./config
  data:
    name: radicale-data
    driver: local
    driver_opts:
      type: none
      o: bind
      device: ./data

Technical Documentation: Kozea/Radicale

ℹ️ Provenance: Multi-Tier Ingestion · CodeWiki Reference

Overview (`README.md`)

Radicale


Radicale is a small but powerful CalDAV (calendars, to-do lists) and CardDAV
(contacts) server, that:

  • Shares calendars and contact lists through CalDAV, CardDAV and HTTP.
  • Supports events, todos, journal entries and business cards.
  • Works out-of-the-box, no complicated setup or configuration required.
  • Can limit access by authentication.
  • Can secure connections with TLS.
  • Works with many CalDAV and CardDAV clients
  • Stores all data on the file system in a simple folder structure.
  • Can be extended with plugins.
  • Is GPLv3-licensed free software.

For the complete documentation, please visit
Radicale master Documentation.

Additional hints can be found

Before reporting an issue, please check

Overview (`caldav_compat_tests/README.md`)

CalDAV compatibility tests

These tests use the caldav client
library together with
caldav-server-tester to
run a battery of CalDAV client/server interoperability checks against a
real Radicale server (started as a subprocess, listening on a free
localhost port).

The observed feature-support levels are compared against a known baseline
(EXPECTED_DEVIATIONS in test_compatibility.py). The goal is to catch
compatibility regressions: if Radicale starts failing (or passing) a
check differently than before, this test fails.

See also: Kozea/Radicale#1911.

Running the tests

UV

lang=shell
uv run --extra caldav_test pytest caldav_compat_tests

Tox

lang=shell
tox -c pyproject.toml -e caldav_compat_test

Pip

lang=shell
pip install -e ".[caldav_test]"
pytest caldav_compat_tests

Pinned client library versions

The observed feature report depends not only on caldav-server-tester, but
also on the caldav client library (which defines the feature model and
how results are reported) and on the libraries it uses to evaluate search
and recurrence results (icalendar, icalendar-searcher,
recurring-ical-events). A new release of any of them can change the
report without any change to Radicale.

They are therefore all pinned to exact, known-good versions in the
caldav_test extra in pyproject.toml. That is the only place they are
pinned: CI, tox, uv and pip all install them via that extra. Bump them
deliberately in their own PR, updating EXPECTED_DEVIATIONS in the same
PR if the new versions change observed behaviour.

Updating the baseline

If a change to Radicale (or a new release of caldav-server-tester)
intentionally changes the observed compatibility, run the tests, inspect
the failure output (it includes the full compatibility report and diff),
and update EXPECTED_DEVIATIONS in test_compatibility.py accordingly.
Please explain the change in the pull request description.

To print a full compatibility report by hand, point caldav-server-tester
(installed as part of the caldav_test extra) directly at a running
Radicale instance:

lang=shell
caldav-server-tester --caldav-url http://127.0.0.1:5232/ \
    --caldav-username tester --caldav-password testpassword \
    --diff

Overview (`integ_tests/README.md`)

Integration tests

These tests use Playwright to run the tests agains a full Radicale instance.

First time install

You need to install playwright. The easiest way to do this is to create a .venv with playwright inside. You can do this by trying to run the integ tests and then entering the .venv

UV

Assuming you use uv to run/create your .venvs, note that the invocation will fail:

lang=shell
uv run --extra integ_test pytest integ_tests
source .venv/bin/activate

then run

lang=shell
playwright install --with-deps

Tox

Tox will install the needed browser automatically. However, it will not automatically install the needed system depedencies, since those would need root permissions. To install all playwright with all needed libraries, run:

lang=shell
tox -c pyproject.toml -e integ_test exec -- playwright install --with-deps

Running the tests

UV

if you use uv, you can run

lang=shell
uv run --extra dev pytest integ_tests

Tox

if you use tox, you can run

lang=shell
tox -c pyproject.toml -e integ_test

Overview (`radicale/web/README.md`)

Built-in web UI

If you have tsc installed, you can type-check all JavaScript using

lang=shell
tsc -p radicale/web/jsconfig.json --noEmit --pretty

--- METRICS ---

Explore Related Technologies & Topics

View All 9,111+ Repositories →

Discover similar high-velocity repositories, agent skills, and OpenAPI specifications across the ecosystem.

#caldav Browse caldav catalog → #carddav Browse carddav catalog → #icalendar Browse icalendar catalog → #python Browse python catalog → ⚡ MCP Servers Model Context Protocol → 🧠 Agent Skills Prompt & rule files → 🔌 OpenAPI Specs REST & Swagger schemas →