README.md

DjRadicale

Radicale is a free and open-source CalDAV and CardDAV server.

DjRadicale is an Django Application for integration Radicale with a Django.

Features

With all features that Radicale have you will also get:

• Django Models as a storage backend (it's possible to use any database supported by Django)
• Django Admin web interface for browsing/editing stored data
• Django Authentication as an authentication backend
• Permissions backend based on regexp stored in Django Settings
• Django Settings as a Radicale config

Requirements

• Python >= 3.0
• Django >= 1.11
• Radicale >= 1.1.6, <2

Installation

Install using PIP

$ pip install djradicale

Configuration

Modify your settings.py

INSTALLED_APPS = (
    ...
    'djradicale',
    ...
)

DJRADICALE_CONFIG = {
    'server': {
        'base_prefix': '/pim/',
        'realm': 'Radicale - Password Required',
    },
    'encoding': {
        'request': 'utf-8',
        'stock': 'utf-8',
    },
    'auth': {
        'type': 'custom',
        'custom_handler': 'djradicale.auth.django',
    },
    'rights': {
        'type': 'custom',
        'custom_handler': 'djradicale.rights.django',
    },
    'storage': {
        'type': 'custom',
        'custom_handler': 'djradicale.storage.django',
    },
    'well-known': {
        'carddav': '/pim/%(user)s/addressbook.vcf',
        'caldav': '/pim/%(user)s/calendar.ics',
    },
}

DJRADICALE_RIGHTS = {
    'rw': {
        'user': '.+',
        'collection': '^%(login)s/[a-z0-9\.\-_]+\.(vcf|ics)$',
        'permission': 'rw',
    },
    'rw-root': {
        'user': '.+',
        'collection': '^%(login)s$',
        'permission': 'rw',
    },
}

Modify you urls.py

urlpatterns = [
    ...
    url(r'^' + settings.DJRADICALE_CONFIG['server']['base_prefix'].lstrip('/'),
        include(('djradicale.urls', 'djradicale'))),
    ...
]

well-known urls configuration

You need to choose an implementation for handling of the "well-known" urls

External DjRadicale implementation

Add this to your urls'py:

from djradicale.views import WellKnownView

urlpatterns = [
    ...
    url(r'^\.well-known/(?P<type>(caldav|carddav))$',
        WellKnownView.as_view(), name='djradicale_well-known'),
    ...
]

Internal Radicale implementation

Some clients does not work with it.

Add this to your urls'py:

from djradicale.views import DjRadicaleView

urlpatterns = [
    ...
    url(r'^\.well-known/(?P<type>(caldav|carddav))$',
        DjRadicaleView.as_view(), name='djradicale_well-known'),
    ...
]