Radicale/use.md

layout	title	permalink
page	Clients	/clients/

Radicale has been tested with:

• Android with DAVdroid
• GNOME Calendar, Contacts and Evolution
• Mozilla Thunderbird with CardBook and Lightning
• InfCloud, CalDavZAP and CardDavMATE

Many clients do not support the creation of new calendars and address books. You have to use another client for this or create them manually (unfortunately this is quite complicated). A future release of Radicale 2.x.x will come with a built-in web interface that lets you create and manage collections conveniently. Manual creation of calendars and address books is described in the last chapter.

In some clients you can just enter the URL of the Radicale server (e.g. http://localhost:5232) and your user name. In others, you have to enter the URL of the collection directly (e.g. http://localhost:5232/user/calendar.ics).

DAVdroid

Enter the URL of the Radicale server (e.g. http://localhost:5232) and your user name. DAVdroid will show all existing calendars and address books and you can create new.

GNOME Calendar, Contacts and Evolution

GNOME Calendar and Contacts do not support adding WebDAV calendars and address books directly, but you can add them in Evolution.

In Evolution add a new calendar and address book respectively with WebDAV. Enter the URL of the Radicale server (e.g. http://localhost:5232) and your user name. Clicking on the search button will list the existing calendars and address books.

Thunderbird

CardBook

Add a new address book on the network with CardDAV. You have to enter the full URL of the collection (e.g. http://localhost:5232/user/addressbook.ics) and your user name.

Lightning

Add a new calendar on the network with CalDAV. You have to enter the full URL of the collection (e.g. http://localhost:5232/user/calendar.ics). If you want to add calendars from different users on the same server, you can specify the user name in the URL (e.g. http://user@localhost...)

InfCloud, CalDavZAP and CardDavMATE

Set the URL of the Radicale server in config.js. If InfCloud is not hosted on the same server and port as Radicale, the browser will deny access to the Radicale server, because of the same-origin policy. You have to add additional HTTP header in the headers section of Radicale's configuration. The documentation of InfCloud has more details on this.

Manual creation of calendars and address books

This is not the recommended way of creating and managing your calendars and address books. Use a client with support for it if possible (e.g. DAVdroid).

Direct editing of the storage

To create a new collection, you have to create the corresponding folder in the file system storage (e.g. collection-root/user/calendar.ics). To tell Radicale and clients that the collection is a calendar, you have to create the file .Radicale.props with the following content in the folder:

{"tag": "VCALENDAR"}

The calendar is now available at the URL path /user/calendar.ics. For address books the file must contain:

{"tag": "VADDRESSBOOK"}

Calendar and address book collections must not have any child collections. Clients with automatic discovery of collections will only show calendars and addressbooks that are direct children of the path /USERNAME/.

Delete collections by deleting the corresponding folders.

HTTP requests with curl

To create a new calendar run something like:

$ curl -u user -X MKCOL 'http://localhost:5232/user/calendar.ics' --data \
'<?xml version="1.0" encoding="UTF-8" ?>
<create xmlns="DAV:" xmlns:C="urn:ietf:params:xml:ns:caldav" xmlns:I="http://apple.com/ns/ical/">
  <set>
    <prop>
      <resourcetype>
        <collection />
        <C:calendar />
      </resourcetype>
      <C:supported-calendar-component-set>
        <C:comp name="VEVENT" />
        <C:comp name="VJOURNAL" />
        <C:comp name="VTODO" />
      </C:supported-calendar-component-set>
      <displayname></displayname>
      <C:calendar-description></C:calendar-description>
      <I:calendar-color></I:calendar-color>
    </prop>
  </set>
</create>'

To create a new address book run something like:

$ curl -u user -X MKCOL 'http://localhost:5232/user/addressbook.ics' --data \
'<?xml version="1.0" encoding="UTF-8" ?>
<create xmlns="DAV:" xmlns:CR="urn:ietf:params:xml:ns:carddav">
  <set>
    <prop>
      <resourcetype>
        <collection />
        <CR:addressbook />
      </resourcetype>
      <displayname></displayname>
      <CR:addressbook-description></CR:addressbook-description>
    </prop>
  </set>
</create>'

The collection /USERNAME will be created automatically, when the user authenticates to Radicale for the first time. Clients with automatic discovery of collections will only show calendars and address books that are direct children of the path /USERNAME/.

Delete the collections by running something like:

$ curl -u user -X DELETE 'http://localhost:5232/user/calendar.ics'