| 1 |
.. _webdav: |
| 2 |
|
| 3 |
====== |
| 4 |
WebDAV |
| 5 |
====== |
| 6 |
|
| 7 |
Configuration |
| 8 |
============= |
| 9 |
|
| 10 |
.. sidebar:: davdriveprefix |
| 11 |
|
| 12 |
|change-default-config| |
| 13 |
|
| 14 |
.. include:: /imap/reference/manpages/configs/imapd.conf.rst |
| 15 |
:start-after: startblob davdriveprefix |
| 16 |
:end-before: endblob davdriveprefix |
| 17 |
|
| 18 |
When enabled, the WebDAV module allows Cyrus to function as a storage server. |
| 19 |
This module uses a subset of the mailbox hierarchy as collections, the toplevel |
| 20 |
of which is specified by the ``davdriveprefix`` option. The public storage hierarchy |
| 21 |
lives at the toplevel of the shared mailbox namespace. A user's personal |
| 22 |
storage hierarchy will be a child of their Inbox. |
| 23 |
|
| 24 |
For example, using the default value for davdriveprefix, a collection named photos |
| 25 |
for user "murch" would reside in the mailbox named ``user.murch.#drive.photos``. |
| 26 |
A user would access their storage at |
| 27 |
``https://<servername>/dav/<davdriveprefix>/user/<userid>``, which for |
| 28 |
the example above, comes to: ``https://<servername>/dav/drive/user/murch``. |
| 29 |
|
| 30 |
.. warning:: |
| 31 |
|
| 32 |
Note that mailboxes in the storage hierarchies (those under `davdriveprefix`) |
| 33 |
**should not** be accessed with an IMAP client as doing so will leave a mailbox |
| 34 |
in a state unsuitable for WebDAV. To this end, storage mailboxes will not |
| 35 |
returned by Cyrus imapd in response to an IMAP client's request for the |
| 36 |
available mailbox list, but Cyrus imapd can not otherwise prevent an IMAP client |
| 37 |
from accessing them. |
| 38 |
|
| 39 |
Administration |
| 40 |
============== |
| 41 |
|
| 42 |
Provisioning |
| 43 |
------------ |
| 44 |
|
| 45 |
The WebDAV module will automatically create a toplevel (root) collection for a |
| 46 |
user the first time that the user authenticates to the WebDAV server. Note that |
| 47 |
the user MUST have an existing IMAP Inbox in order for the root collection to be |
| 48 |
created. |
| 49 |
|
| 50 |
Storage access controls |
| 51 |
----------------------- |
| 52 |
|
| 53 |
Cyrus uses the same :ref:`access controls for storage <calendar_ACL>` as it |
| 54 |
does for calendars, except that the scheduling rights (7, 8, 9) have no use with |
| 55 |
storage and are ignored. |