From 01400d967d1b1bca4ab5382ce58f683b964fd3ec Mon Sep 17 00:00:00 2001 From: Unrud Date: Mon, 29 May 2017 02:04:42 +0200 Subject: [PATCH] Add documentation for clients --- use.md | 151 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 151 insertions(+) diff --git a/use.md b/use.md index e8140a8e..c827158e 100644 --- a/use.md +++ b/use.md @@ -3,3 +3,154 @@ layout: page title: Clients permalink: /clients/ --- + +Radicale has been tested with: + + * [Android](https://android.com/) with + [DAVdroid](https://davdroid.bitfire.at/) + * [GNOME Calendar](https://wiki.gnome.org/Apps/Calendar), + [Contacts](https://wiki.gnome.org/Apps/Contacts) and + [Evolution](https://wiki.gnome.org/Apps/Evolution) + * [Mozilla Thunderbird](https://www.mozilla.org/thunderbird/) with + [CardBook](https://addons.mozilla.org/thunderbird/addon/cardbook/) and + [Lightning](https://www.mozilla.org/projects/calendar/) + * [InfCloud](https://www.inf-it.com/open-source/clients/infcloud/), + [CalDavZAP](https://www.inf-it.com/open-source/clients/caldavzap/) and + [CardDavMATE](https://www.inf-it.com/open-source/clients/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. + +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://user@localhost:5232/user/calendar.ics`). Manual creation of +calendars and address books is described in the last chapter. + +## 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://user@localhost:5232/user/calendar.ics`). + +## 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](https://en.wikipedia.org/wiki/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: + +```json +{"tag": "VCALENDAR"} +``` + +The calendar is now available add the URL path ``/user/calendar.ics``. +For address books the file must contain: + +```json +{"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: + +```shell +$ curl -u user -X MKCOL 'http://user@localhost:5232/user/calendar.ics' --data \ +' + + + + + + + + + + + + + + + + + +' +``` + +To create a new address book run something like: + +```shell +$ curl -u user -X MKCOL 'http://localhost:5232/user/addressbook.ics' --data \ +' + + + + + + + + + + + +' +``` + +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: + +```shell +$ curl -u user -X DELETE 'http://localhost:5232/user/calendar.ics' +```