Difference between revisions of "Caldav carddav Bundles"

(CentOS 6)
(Alternative 1: Apache vhost (recommended))
Line 12: Line 12:
  
 
=== Alternative 1: Apache vhost (recommended) ===
 
=== Alternative 1: Apache vhost (recommended) ===
Please edit your file /etc/apache2/ox6.conf so that ''' the existing configuration for ox as well as the new configuration for CalDAV and CardDav are placed inside a virtual host '''.
+
Please edit your file /etc/apache2/ox6.conf so that ''' the existing OX configuration as well as the CalDAV/CardDav configuration are placed inside their own virtual hosts sections.'''.
  
 
This is an <b>example</b> where MYSERVER.TLD is the domain-name of the ox-server:
 
This is an <b>example</b> where MYSERVER.TLD is the domain-name of the ox-server:

Revision as of 09:18, 12 October 2012

Installation and Configuration of the CalDAV- and CardDAV-bundles

The Open-Xchange server can be accessed via it's CalDAV- and CardDAV-interfaces to allow the synchronization of Calendar- and Contact-data with external applications like the Mac OS X iCal and Address Book clients. The synchronization protocols are available and supported for all customers with a valid Open-Xchange license of Open-Xchange Server Edition and Open-Xchange Hosting Edition starting with Version 6.20.1 Rev5.

CalDAV and CardDAV are standard protocols for the exchange of calendar data and address data respectively. The CalDAV interface publishes all the user's calendar folders via CalDAV so the user can subscribe to them in a client application. Similarly, the CardDAV interface publishes the user's contact folders. Depending on the used client, the user can either subscribe one or more folders, or access all available data in an aggregated way.

User Guide and Client Configuration

Please find further information regarding the client configuration at CalDAVClients and CardDAVClients.

Webserver Configuration

In order to redirect DAV requests to the appropiate servlets, the webserver's configuration may need to be adjusted using one of the following alternatives.

Alternative 1: Apache vhost (recommended)

Please edit your file /etc/apache2/ox6.conf so that the existing OX configuration as well as the CalDAV/CardDav configuration are placed inside their own virtual hosts sections..

This is an example where MYSERVER.TLD is the domain-name of the ox-server:

  $ vi /etc/apache2/ox6.conf 
NameVirtualHost *:80
<VirtualHost *:80>
       ServerName dav.MYSERVER.TLD
       ErrorLog /tmp/dav.err.log
       TransferLog /tmp/dav.access.log
       <Proxy />
               Order allow,deny
               Allow from all
       </Proxy>
       ProxyPass / ajp://localhost:8009/servlet/dav/ smax=0 ttl=60 retry=5
</VirtualHost>

<VirtualHost *:80>
       ServerName MYSERVER.TLD
       ServerAdmin webmaster@localhost
       DocumentRoot /var/www/

       <Directory /var/www/>
               AllowOverride None
               Order allow,deny
               allow from all
               RedirectMatch ^/$ /ox6/
               Options +FollowSymLinks +SymLinksIfOwnerMatch
       </Directory>
       # deflate
      AddOutputFilterByType DEFLATE text/html text/plain text/javascript application/javascript text/css text/xml application/xml text/x-js application/x-javascript

       # pre-compressed files
       AddType text/javascript .jsz
       AddType text/css .cssz
       AddType text/xml .xmlz
        AddType text/plain .po

       AddEncoding gzip .jsz .cssz .xmlz
       SetEnvIf Request_URI "\.(jsz|cssz|xmlz)$" no-gzip

       ExpiresActive On

       <Location /ox6>
               # Expires (via ExpiresByType to override global settings)
               ExpiresByType image/gif "access plus 6 months"
               ExpiresByType image/png "access plus 6 months"
               ExpiresByType image/jpg "access plus 6 months"
               ExpiresByType image/jpeg "access plus 6 months"
               ExpiresByType text/css "access plus 6 months"
               ExpiresByType text/html "access plus 6 months"
               ExpiresByType text/xml "access plus 6 months"
               ExpiresByType text/javascript "access plus 6 months"
               ExpiresByType text/x-js "access plus 6 months"
               ExpiresByType application/x-javascript "access plus 6 months"
               ExpiresDefault "access plus 6 months"
               Header append Cache-Control "private"
               Header unset Last-Modified
               Header unset Vary
               # Strip version
               RewriteEngine On
               RewriteRule v=\w+/(.+) $1 [L]
               # Turn off ETag
               Header unset ETag
               FileETag None
       </Location>

       <Location /ox6/ox.html>
               ExpiresByType text/html "now"
               ExpiresDefault "now"
               Header unset Last-Modified
               Header set Cache-Control "no-store, no-cache, must-revalidate, post-check=0, pre-check=0"
               # Turn off ETag
               Header unset ETag
               FileETag None
       </Location>

       <Location /ox6/index.html>
               ExpiresByType text/html "now"
               ExpiresDefault "now"
               Header unset Last-Modified
               Header set Cache-Control "no-store, no-cache, must-revalidate, post-check=0, pre-check=0"
               # Turn off ETag
               Header unset ETag
               FileETag None
       </Location>
</VirtualHost>

If you use this method, you have to make sure that dav.MYSERVER.TLD is reachable, your dns configuration need an entry for this name. Take care of the the dav.* logfiles, the example writes them without logrotation to /tmp.

Alternative 2: Apache useragent detection

For environments where it is inconvenient to setup a vhost there is the possibility to redirect to relevant servlets another way: Via useragent detection. This is not recommended for the following reason: Per definition this is a whitelist-approach and any client sending a useragent-string not explicitly listed in the configuration will not be able to connect . Useragent-strings may also change between different versions of an application or may even be actively changed into something non-standard.

  $ vi /etc/apache2/ox6.conf
 RewriteEngine On
 RewriteCond %{HTTP_USER_AGENT}      Calendar           [OR]
 RewriteCond %{HTTP_USER_AGENT}      DataAccess         [OR]
 RewriteCond %{HTTP_USER_AGENT}      DAVKit             [OR]
 RewriteCond %{HTTP_USER_AGENT}      Lightning          [OR]
 RewriteCond %{HTTP_USER_AGENT}      Adresboek          [OR]
 RewriteCond %{HTTP_USER_AGENT}      dataaccessd        [OR]
 RewriteCond %{HTTP_USER_AGENT}      Preferences        [OR]
 RewriteCond %{HTTP_USER_AGENT}      Adressbuch         [OR]
 RewriteCond %{HTTP_USER_AGENT}      AddressBook        [OR]
 RewriteCond %{HTTP_USER_AGENT}      Address%20Book     [OR]
 RewriteCond %{HTTP_USER_AGENT}      CalendarStore      [OR]
 RewriteCond %{HTTP_USER_AGENT}      CoreDAV
 RewriteRule (.*)                  ajp://localhost:8009/servlet/dav$1     [P]

Note: The address book app on OSX 10.6 uses a localized user-agent string. If you're expecting clients with non-english language settings, you need to add the translated user-agent string to these rewrite rules. For example: "Adressbuch" for german OSX clients.


Which packages do I need?

To get CalDAV and CardDAV up and running you need the following packages:

  • open-xchange-webdav-directory - Assembles the *DAV interfaces into a common tree. This is needed for publishing certain properties so clients accept the OX is a WebDAV Server.
  • open-xchange-webdav-acl - The WebDAV equivalent of the /ajax/user interface. Allows clients to discover the current and other users and their addressbooks and calendars.
  • open-xchange-carddav - The CardDAV interface exposing the users addressbook via carddav
  • open-xchange-caldav - The CalDAV inteface exposing the users calendars via caldav


Install on OX AppSuite

Debian GNU/Linux 8.0

Add the following entry to /etc/apt/sources.list.d/open-xchange.list if not already present:

deb https://software.open-xchange.com/OX6/updates/DebianJessie/ /
# if you have a valid maintenance subscription, please uncomment the 
# following and add the ldb account data to the url so that the most recent
# packages get installed
# deb https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/OX6/updates/updates/DebianJessie/ /

and run

$ apt-get update
$ apt-get install open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory

Debian GNU/Linux 9.0

Add the following entry to /etc/apt/sources.list.d/open-xchange.list if not already present:

deb https://software.open-xchange.com/OX6/updates/DebianStretch/ /
# if you have a valid maintenance subscription, please uncomment the 
# following and add the ldb account data to the url so that the most recent
# packages get installed
# deb https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/OX6/updates/updates/DebianStretch/ /

and run

$ apt-get update
$ apt-get install open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory

SUSE Linux Enterprise Server 12

Add the package repository using zypper if not already present:

$ zypper ar https://software.open-xchange.com/OX6/updates/SLE_12 ox

If you have a valid maintenance subscription, please run the following command and add the ldb account data to the url so that the most recent packages get installed:

$ zypper ar https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/OX6/updates/updates/SLES11 ox-updates

and run

$ zypper ref
$ zypper in open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory

RedHat Enterprise Linux 6

Start a console and create a software repository file if not already present:

$ vim /etc/yum.repos.d/ox.repo

[ox]
name=Open-Xchange
baseurl=https://software.open-xchange.com/OX6/updates/RHEL6/
gpgkey=https://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m
# if you have a valid maintenance subscription, please uncomment the 
# following and add the ldb account data to the url so that the most recent
# packages get installed
# [ox-updates]
# name=Open-Xchange Updates
# baseurl=https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/OX6/updates/updates/RHEL6/
# gpgkey=https://software.open-xchange.com/oxbuildkey.pub
# enabled=1
# gpgcheck=1
# metadata_expire=0m

and run

$ yum update
$ yum install open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory

RedHat Enterprise Linux 7

Start a console and create a software repository file if not already present:

$ vim /etc/yum.repos.d/ox.repo

[ox]
name=Open-Xchange
baseurl=https://software.open-xchange.com/OX6/updates/RHEL7/
gpgkey=https://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m
# if you have a valid maintenance subscription, please uncomment the 
# following and add the ldb account data to the url so that the most recent
# packages get installed
# [ox-updates]
# name=Open-Xchange Updates
# baseurl=https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/OX6/updates/updates/RHEL7/
# gpgkey=https://software.open-xchange.com/oxbuildkey.pub
# enabled=1
# gpgcheck=1
# metadata_expire=0m

and run

$ yum update
$ yum install open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory

CentOS 6

Start a console and create a software repository file if not already present:

$ vim /etc/yum.repos.d/ox.repo

[ox]
name=Open-Xchange
baseurl=https://software.open-xchange.com/OX6/updates/RHEL6/
gpgkey=https://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m
# if you have a valid maintenance subscription, please uncomment the 
# following and add the ldb account data to the url so that the most recent
# packages get installed
# [ox-updates]
# name=Open-Xchange Updates
# baseurl=https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/OX6/updates/updates/RHEL6/
# gpgkey=https://software.open-xchange.com/oxbuildkey.pub
# enabled=1
# gpgcheck=1
# metadata_expire=0m

and run

$ yum update
$ yum install open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory

CentOS 7

Start a console and create a software repository file if not already present:

$ vim /etc/yum.repos.d/ox.repo

[ox]
name=Open-Xchange
baseurl=https://software.open-xchange.com/OX6/updates/RHEL7/
gpgkey=https://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m
# if you have a valid maintenance subscription, please uncomment the 
# following and add the ldb account data to the url so that the most recent
# packages get installed
# [ox-updates]
# name=Open-Xchange Updates
# baseurl=https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/OX6/updates/updates/RHEL7/
# gpgkey=https://software.open-xchange.com/oxbuildkey.pub
# enabled=1
# gpgcheck=1
# metadata_expire=0m

and run

$ yum update
$ yum install open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory


Installation on Open-Xchange v6.22

Debian GNU/Linux 6.0

Add the following entry to /etc/apt/sources.list if not already present:

deb http://software.open-xchange.com/OX6/6.22/6.22.0/backend/DebianSqueeze/all/

and run

$ apt-get update
$ apt-get install open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory

SUSE Linux Enterprise Server 11

Add the package repository using zypper if not already present:

$ zypper ar http://software.open-xchange.com/OX6/6.22/6.22.0/backend/SLES11 ox

and run

$ zypper ref
$ zypper in open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory

RedHat Enterprise Linux 6

Start a console and create a software repository file if not already present:

$ vim /etc/yum.repos.d/ox.repo
[ox]
name=Open-Xchange
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL6/
gpgkey=http://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m

and run

$ yum update
$ yum install open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory

RedHat Enterprise Linux 5

Start a console and create a software repository file if not already present:

$ vim /etc/yum.repos.d/ox.repo
[ox]
name=Open-Xchange
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL5/
gpgkey=http://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m

and run

$ yum update
$ yum install open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory

CentOS 5

Start a console and create a software repository file if not already present:

$ vim /etc/yum.repos.d/ox.repo
[ox]
name=Open-Xchange
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL5/
gpgkey=http://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m

and run

$ yum update
$ yum install open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory

CentOS 6

Start a console and create a software repository file if not already present:

$ vim /etc/yum.repos.d/ox.repo
[ox]
name=Open-Xchange
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL6/
gpgkey=http://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m

and run

$ yum update
$ yum install open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory

CalDAV Configuration

The following configuration options are available in the configuration files caldav.properties and caldav.yml:

com.openexchange.caldav.enabled

The property com.openexchange.caldav.enabled governs whether a user has access to the CalDAV interface. This can be configured along the config cascade, in the default setting, everyone that has access to the infostore also has access to caldav. This is achieved in the following way:

/opt/open-xchange/etc/groupware/caldav.properties:

 com.openexchange.caldav.enabled=false

/opt/open-xchange/etc/groupware/contextSets/caldav.yml

 premium:
     com.openexchange.caldav.enabled: true
     withTags: ucInfostore

This means: In general CalDAV is turned off, but using the contextSets feature of the config cascade it is turned on for everyone that has infostore access.

com.openexchange.caldav.tree

Configures the ID of the folder tree used by the CalDAV interface. Currently, this should be set to the default value of '0'.

com.openexchange.caldav.interval.start

Defines the minimum end time of appointments to be synchronized via the CalDAV interface, relative to the current date. Possible values are "one_month" (default), "one_year" and "six_months".

com.openexchange.caldav.interval.end

Defines the maximum start time of appointments to be synchronized via the CalDAV interface, relative to the current date. Possible values are "one_year" (default) and "two_years".

com.openexchange.caldav.url

Tells users where to find a caldav folder. This can be displayed in frontends. You can use the variables [hostname] and [folderId]. If you chose to deploy caldav as a virtual host (say 'dav.open-xchange.com') use https://dav.open-xchange.com/caldav/[folderId] as the value. If you are using user-agent sniffing use https://[hostname]/caldav/[folderId].


CardDAV Configuration

The following configuration options are available in the configuration files carddav.properties and carddav.yml:

com.openexchange.carddav.enabled

Similarly to CalDAV, the property com.openexchange.carddav.enabled governs whether CardDAV is available for a certain user. This is configured exactly like CalDAV with the config cascade only enabling this for users that have access to the infostore:

/opt/open-xchange/etc/groupware/carddav.properties:

 com.openexchange.carddav.enabled=false

/opt/open-xchange/etc/groupware/contextSets/carddav.yml

 premium:
     com.openexchange.carddav.enabled: true
     withTags: ucInfostore

com.openexchange.carddav.ignoreFolders

A comma-separated list of folder IDs to exclude from the synchronization. Use this to disable syncing of very large folders (e.g. the global address list in large contexts, which always has ID 6). By default, no folders are excluded.

com.openexchange.carddav.tree

Configures the ID of the folder tree used by the CardDAV interface. Currently, this should be set to the default value of '0'.

com.openexchange.carddav.exposedCollections

Controls which collections are exposed via the CardDAV interface. Possible values are '0', '1' and '2'. A value of '1' makes each visible folder available as a resource collection, while '2' only exposes an aggregated collection containing all contact resources from all visible folders. The default value '0' exposes either an aggregated collection or individual collections for each folder, depending on the client's user-agent that is matched against the pattern in 'userAgentForAggregatedCollection'.

com.openexchange.carddav.userAgentForAggregatedCollection

Regular expression to match against the client's user-agent to decide whether the aggregated collection is exposed or not. The default pattern matches all known varieties of the Mac OS Addressbook client, that doesn't support multiple collections. Only used if 'exposedCollections' is set to '0'. The pattern is used case insensitive.

com.openexchange.carddav.reducedAggregatedCollection

Specifies if all visible folders are used to create the aggregated collection, or if a reduced set of folders only containing the global addressbook and the personal contacts folders should be used. This setting only influences the aggregated collection that is used for clients that don't support multiple collections. Possible values are 'true' and 'false.