1
0
Fork 0
mirror of https://github.com/Kozea/Radicale.git synced 2025-06-29 16:55:32 +00:00
Radicale/use.md

157 lines
5.4 KiB
Markdown
Raw Normal View History

2016-08-11 19:03:50 +02:00
---
layout: page
title: Clients
permalink: /clients/
---
2017-05-29 02:04:42 +02:00
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 \
'<?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:
```shell
$ 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:
```shell
$ curl -u user -X DELETE 'http://localhost:5232/user/calendar.ics'
```