Caldav carddav Bundles: Difference between revisions

From Open-Xchange
No edit summary
 
(16 intermediate revisions by 4 users not shown)
Line 1: Line 1:
= Installation and Configuration of the CalDAV- and CardDAV-bundles =
This article is valid until the version 7.10.2 of the Open Xchange Server. For newer versions please visit https://documentation.open-xchange.com/latest/middleware/miscellaneous/caldav_carddav.html
 
<!-- = 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 Calendar and Address Book clients.
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 Calendar and Address Book clients.
Line 54: Line 56:
   RewriteCond %{HTTP_USER_AGENT}      DataAccess        [OR]
   RewriteCond %{HTTP_USER_AGENT}      DataAccess        [OR]
   RewriteCond %{HTTP_USER_AGENT}      DAVKit            [OR]
   RewriteCond %{HTTP_USER_AGENT}      DAVKit            [OR]
  RewriteCond %{HTTP_USER_AGENT}      DAVx5              [OR]
  RewriteCond %{HTTP_USER_AGENT}      OpenSync          [OR]
  RewriteCond %{HTTP_USER_AGENT}      "DAVdroid"        [OR]
   RewriteCond %{HTTP_USER_AGENT}      Lightning          [OR]
   RewriteCond %{HTTP_USER_AGENT}      Lightning          [OR]
  RewriteCond %{HTTP_USER_AGENT}      Thunderbird        [OR]
   RewriteCond %{HTTP_USER_AGENT}      Adresboek          [OR]
   RewriteCond %{HTTP_USER_AGENT}      Adresboek          [OR]
   RewriteCond %{HTTP_USER_AGENT}      dataaccessd        [OR]
   RewriteCond %{HTTP_USER_AGENT}      dataaccessd        [OR]
Line 63: Line 69:
   RewriteCond %{HTTP_USER_AGENT}      CalendarStore      [OR]
   RewriteCond %{HTTP_USER_AGENT}      CalendarStore      [OR]
   RewriteCond %{HTTP_USER_AGENT}      CalendarAgent      [OR]
   RewriteCond %{HTTP_USER_AGENT}      CalendarAgent      [OR]
  RewriteCond %{HTTP_USER_AGENT}      CalDAV%20Sync%20Adapter [OR]
  RewriteCond %{HTTP_USER_AGENT}      CalDavSynchronizer [OR]
   RewriteCond %{HTTP_USER_AGENT}      accountsd          [OR]
   RewriteCond %{HTTP_USER_AGENT}      accountsd          [OR]
   RewriteCond %{HTTP_USER_AGENT}      eM\ Client         [OR]
   RewriteCond %{HTTP_USER_AGENT}      "eM Client"        [OR]
  RewriteCond %{HTTP_USER_AGENT}      "OX Sync"          [OR]
   RewriteCond %{HTTP_USER_AGENT}      CalDav            [OR]
   RewriteCond %{HTTP_USER_AGENT}      CalDav            [OR]
   RewriteCond %{HTTP_USER_AGENT}      CoreDAV
   RewriteCond %{HTTP_USER_AGENT}      CoreDAV           [OR]
  RewriteCond %{HTTP_USER_AGENT}      remindd
  RewriteCond %{HTTP_USER_AGENT}      "!Open-Xchange Calendar Feed Client"
   RewriteRule (.*)                  http://localhost:8009/servlet/dav$1    [P] # for grizzly http service
   RewriteRule (.*)                  http://localhost:8009/servlet/dav$1    [P] # for grizzly http service


'''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.
'''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.


'''Note:''' Depending on the specific configuration, such a global definition of the rewrite rules might not be appropriate. However, the rules may also be defined inside a <code>Directory</code> context. More details are available at http://httpd.apache.org/docs/current/mod/mod_rewrite.html#rewriterule .
'''Note:''' Depending on the specific configuration, such a global definition of the rewrite rules might not be appropriate. However, the rules may also be defined inside a <code>Directory</code> context. More details are available at http://httpd.apache.org/docs/current/mod/mod_rewrite.html#rewriterule.
 
'''Note:''' This Alternative 2 is not supported by Open-Xchange Sync App. Please use Alternative 1 for OX Sync App


== Autodiscovery ==
== Autodiscovery ==
Line 86: Line 95:
  _carddav._tcp.MYSERVER.TLD.      10800 IN SRV      10 1  80 dav.MYSERVER.TLD.
  _carddav._tcp.MYSERVER.TLD.      10800 IN SRV      10 1  80 dav.MYSERVER.TLD.


Additionally, a rewrite-rule similar to the following example should be added to the webserver configuration of the virtual host to enable the bootstrapping process:
Additionally, a rewrite-rule similar to the following example should be added to the webserver configuration of the virtual host to enable the bootstrapping process. The rewrite target must be the root of your DAV server.
The well-known aliases should be added for your DAV vhost and on the vhost serving the host matching the mail domain:


  RewriteEngine On
  RewriteEngine On
Line 92: Line 102:
  RewriteCond %{REQUEST_URI} ^/\.well-known/carddav
  RewriteCond %{REQUEST_URI} ^/\.well-known/carddav
  RewriteRule (.*) / [L,R]
  RewriteRule (.*) / [L,R]
In the case of not serving the DAV service on the vhost root additionally some DNS TXT records are recommended:
_caldavs._tcp.MYSERVER.TLD.      10800 IN TXT  path=/servlet/dav
_caldav._tcp.MYSERVER.TLD.      10800 IN TXT  path=/servlet/dav
_carddavs._tcp.MYSERVER.TLD.    10800 IN TXT  path=/servlet/dav
_carddav._tcp.MYSERVER.TLD.      10800 IN TXT  path=/servlet/dav


== Installation on OX App Suite ==
== Installation on OX App Suite ==


=== Debian GNU/Linux 7.0 (valid until v7.8.2)===
=== Debian GNU/Linux 9.0 ===


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


  deb https://software.open-xchange.com/products/appsuite/7.8.2/backend/DebianWheezy/ /
  deb https://software.open-xchange.com/products/appsuite/stable/backend/DebianStretch/ /


  # if you have a valid maintenance subscription, please uncomment the  
  # 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
  # following and add the ldb account data to the url so that the most recent
  # packages get installed
  # packages get installed
  # deb https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/7.8.2/backend/updates/DebianWheezy/ /
  # deb https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/stable/backend/updates/DebianStretch/ /


and run
and run
Line 111: Line 129:
  $ apt-get install open-xchange-dav
  $ apt-get install open-xchange-dav


=== Debian GNU/Linux 8.0===
=== Debian GNU/Linux 10.0 ===


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


  deb https://software.open-xchange.com/products/appsuite/stable/backend/DebianJessie/ /
  deb https://software.open-xchange.com/products/appsuite/stable/backend/DebianBuster/ /


  # if you have a valid maintenance subscription, please uncomment the  
  # 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
  # following and add the ldb account data to the url so that the most recent
  # packages get installed
  # packages get installed
  # deb https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/stable/backend/updates/DebianJessie/ /
  # deb https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/stable/backend/updates/DebianBuster/ /


and run
and run
Line 127: Line 145:
  $ apt-get install open-xchange-dav
  $ apt-get install open-xchange-dav


=== SUSE Linux Enterprise Server 11 (valid until v7.8.2)===
=== SUSE Linux Enterprise Server 12 (valid until 7.10.3)===
 
Add the package repository using zypper if not already present:
 
$ zypper ar https://software.open-xchange.com/products/appsuite/7.8.2/backend/SLES11 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/products/appsuite/stable/backend/updates/SLES11 ox-updates
 
and run
 
$ zypper ref
$ zypper in open-xchange-dav
 
=== SUSE Linux Enterprise Server 12===


Add the package repository using zypper if not already present:
Add the package repository using zypper if not already present:


  $ zypper ar https://software.open-xchange.com/products/appsuite/stable/backend/SLE_12 ox
  $ zypper ar https://software.open-xchange.com/products/appsuite/7.10.3/backend/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:
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/products/appsuite/stable/backend/updates/SLES11 ox-updates
  $ zypper ar https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/7.10.3/backend/updates/SLES11 ox-updates


and run
and run
Line 157: Line 160:
  $ zypper in open-xchange-dav
  $ zypper in open-xchange-dav


=== RedHat Enterprise Linux 6===
=== RedHat Enterprise Linux 6 (valid until 7.10.3)===


Start a console and create a software repository file if not already present:
Start a console and create a software repository file if not already present:
Line 165: Line 168:
  [ox]
  [ox]
  name=Open-Xchange
  name=Open-Xchange
  baseurl=https://software.open-xchange.com/products/appsuite/stable/backend/RHEL6/
  baseurl=https://software.open-xchange.com/products/appsuite/7.10.3/backend/RHEL6/
  gpgkey=https://software.open-xchange.com/oxbuildkey.pub
  gpgkey=https://software.open-xchange.com/oxbuildkey.pub
  enabled=1
  enabled=1
Line 176: Line 179:
  # [ox-updates]
  # [ox-updates]
  # name=Open-Xchange Updates
  # name=Open-Xchange Updates
  # baseurl=https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/stable/backend/updates/RHEL6/
  # baseurl=https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/7.10.3/backend/updates/RHEL6/
  # gpgkey=https://software.open-xchange.com/oxbuildkey.pub
  # gpgkey=https://software.open-xchange.com/oxbuildkey.pub
  # enabled=1
  # enabled=1
Line 187: Line 190:
  $ yum install open-xchange-dav
  $ yum install open-xchange-dav


===RedHat Enterprise Linux 7===
===RedHat Enterprise Linux 7 ===


Start a console and create a software repository file if not already present:
Start a console and create a software repository file if not already present:
Line 217: Line 220:
  $ yum install open-xchange-dav
  $ yum install open-xchange-dav


===CentOS 6===
===CentOS 6 (valid until 7.10.3)===


Start a console and create a software repository file if not already present:
Start a console and create a software repository file if not already present:
Line 225: Line 228:
  [ox]
  [ox]
  name=Open-Xchange
  name=Open-Xchange
  baseurl=https://software.open-xchange.com/products/appsuite/stable/backend/RHEL6/
  baseurl=https://software.open-xchange.com/products/appsuite/7.10.3/backend/RHEL6/
  gpgkey=https://software.open-xchange.com/oxbuildkey.pub
  gpgkey=https://software.open-xchange.com/oxbuildkey.pub
  enabled=1
  enabled=1
Line 236: Line 239:
  # [ox-updates]
  # [ox-updates]
  # name=Open-Xchange Updates
  # name=Open-Xchange Updates
  # baseurl=https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/stable/backend/updates/RHEL6/
  # baseurl=https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/7.10.3/backend/updates/RHEL6/
  # gpgkey=https://software.open-xchange.com/oxbuildkey.pub
  # gpgkey=https://software.open-xchange.com/oxbuildkey.pub
  # enabled=1
  # enabled=1
Line 315: Line 318:
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:
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:
/opt/open-xchange/etc/carddav.properties:
   com.openexchange.carddav.enabled=false
   com.openexchange.carddav.enabled=false


/opt/open-xchange/etc/groupware/contextSets/carddav.yml
/opt/open-xchange/etc/contextSets/carddav.yml
   premium:
   premium:
       com.openexchange.carddav.enabled: true
       com.openexchange.carddav.enabled: true
Line 336: Line 339:


===com.openexchange.carddav.reducedAggregatedCollection===
===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.
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. -->


[[Category: Clients]]
[[Category: Clients]]
[[Category: Administrator]]
[[Category: Administrator]]
[[Category: AppSuite]]
[[Category: AppSuite]]

Latest revision as of 10:50, 8 December 2021

This article is valid until the version 7.10.2 of the Open Xchange Server. For newer versions please visit https://documentation.open-xchange.com/latest/middleware/miscellaneous/caldav_carddav.html