Open-Xchange - User contributions [en]

AppSuite:OX System Requirements

2021-10-15T08:48:14Z

Peter.horn: /* OX Drive for Clients */ Added notice about Apple Silicon support

= OX App Suite Requirements - Open-Xchange supported components overview =

The following table provides an overview about the supported components of OX App Suite and further products. This overview makes no claim to be complete.

Information about Maintenance expiries of components, versions and browser support, can be found in the [[AppSuite:Versioning_and_Numbering#Maintenance_expires|Maintenance Expires Table]]

== Hardware Requirements ==

=== General Assumptions ===

Open-Xchange App Suite Server (middleware services) is designed to run on physical servers or virtual machines of the same flavor. Cloud environments might be used in terms of Infrastructure as a Service (IaaS), meaning that all components need to be deployed in a classical manner on virtual machines.

This means in particular, but not only:

* Infrastructure is supposed to be "quasi-static". Automatic replacement of broken nodes is fine as long as this is always an exceptional case. Scaling out or reducing number of nodes must always be a conscious task and closely monitored.
* The only supported "Database as a service" solution is AWS RDS for MariaDB as defined by belows compatibility table.

Especially we expect the virtual hardware to be not over-provisioned. Each VM must have dedicated resources with respect to CPU cores, RAM, IOPS, storage, network bandwidth, network latency, etc.

Network is expected to be flat, inside one datacenter, no multi-datacenter, no segments. No packet loss, low latency.

'''Disclaimer: All recommendations below are without guarantee and can differ for specific deployments. For mid- and large-scale setups a detailed deployment planning and sizing tests are mandatory and should be agreed on with OX Professional Services.'''

=== High Level Design / OS setup ===

Operate services separately (USM, Document/Image Converters) as described in [https://oxpedia.org/wiki/index.php?title=AppSuite:Running_a_cluster Cluster Setup].

Clocks between all nodes must be synchronized (e.g. via NTP).

Open file/max process limits need to be adjusted properly. Based on the used Linux distribution and init system configuration will differ, see Resource Limits for further explanation.

Platform Architecture: 64 bit versions (x84_64) of the supported [[#Software Requirements | Linux distributions]]

=== Node Sizing ===

==== OX App Suite Middleware ====

* Max. 8 GB heap per JVM + 4 GB system memory for other daemons and the OS (buffers, caches)
* 4 CPU cores (virtual, physical or hyperthreads) for plain HTTP connections. If TLS is terminated on application nodes this might need to be doubled.
* Disk space
** 8 GB for OS and software
** Some services like Document Converter need SWAP partitions (~1 * RAM)
** 2 * system memory of free disk space (i.e. 12 GB RAM => 24 GB free disk space) for file spooling, log files, heap and core dumps

=== Untested/Unsupported Deployments ===

* Changes to Garbage Collector settings
* Running in containerized environments (Docker, rkt)
* Elasticity/High velocity of nodes going up and down: Services are sometimes stateful and demand static configuration
* Cloud platform services (PaaS) that promise to replacements for certain supported technologies but have not been verified by OX for these regards
* Multi-site active-active

== Software Requirements ==

=== Linux Distributions ===

OX App Suite is available as Linux packages for the following distributions:

{|border="2" rules="all" align="left">
|'''Distribution'''
|'''Versions'''
|'''Remarks'''
|-
| 
| 
| 
|-
|Red Hat Enterprise Linux
|7
|
|-
|CentOS
|7
|Install from RHEL package repositories
|-
|Debian
|9 (Stretch), 10 (Buster)
|
|-
|Univention Corporate Server
|4.4
|
|-
|Amazon Linux
|2
|Discontinued Support with end of life of OX App Suite v7.10.5
|-
|}

=== Java ===

OX App Suite Middleware requires OpenJDK headless JRE 8 or 9. Linux distributions might offer only packages for OpenJDK 11 JRE, which is not suitable for OX App Suite. It is in those cases required to install AdoptOpenJDK 8 JRE with HotSpot VM. A comprehensive installation guide can be found at https://adoptopenjdk.net/installation.html#linux-pkg. The correct JRE package is adoptopenjdk-8-hotspot-jre.

=== Databases ===

OX App Suite uses MySQL/MariaDB with the InnoDB storage engine as its primary data store. The following vendors and products are supported.

{|border="2" rules="all" align="left">
|'''Vendor'''
|'''Product'''
|'''Versions'''
|-
| 
| 
| 
|-
|Oracle
|MySQL Community Edition, Standard Edition, Enterprise Edition
|v5.6.x, v5.7.x
|-
|MariaDB
|MariaDB Server, Galera Cluster
|v10.1.x, v10.2.x, v10.4.x
|-
|Amazon
|AWS RDS for MariaDB
|10.2.x Discontinued Support with end of life of OX App Suite v7.10.5
|-
|}

==== Important Notes ====

* Open-Xchange does not plan to support '''MySQL 8 or higher'''. As MariaDB and MySQL are diverging and cannot be assumed drop-in replacements anymore, Open-Xchange will focus on MariaDB Server and MariaDB Galera Cluster. Future App Suite releases '''> 7.10.x''' might rely on features only available in '''MariaDB'''.
* Open-Xchange supports '''Percona XtraDB Cluster''' for existing customers with initial deployments done using '''App Suite 7.8.x or earlier'''. Those customers can continue to use Percona XtraDB Cluster throughout the 7.10.x release series. Like for MySQL, 7.10.x supports only versions 5.6 and 5.7. It is not planned to support Percona XtraDB Cluster beyond 7.10.x.

* For some Linux distributions the included MySQL/MariaDB packages are too old to be used with App Suite. It is mandatory then to install a supported version from '''upstream package sources'''. Possible sources are the official vendor repositories of MySQL or MariaDB as well as for example Red Hat Software Collections.
* Required '''MySQL/MariaDB configuration''' configuration differs between '''App Suite 7.8.4 and 7.10.x''' and also between the different database systems in terms of SQL modes. See [[My.cnf]] for details.
* For upgrades from App Suite <= 7.8.2 to >= 7.10.0 a comprehensive '''database upgrade guide''' exists: [[AppSuite:7_10_Database_Migration]]

== HTTP Reverse Proxy ==

An HTTP server with reverse proxy and load balancing capabilities is required in front of App Suite application servers. TLS termination, virtual hosts, path-based routing, sticky sessions and X-Forwarded headers are typical required features. OX strongly recommends [https://httpd.apache.org/ Apache httpd 2.x] for that. Configuration examples can be found in the quickinstall guides.

'''Important:''' For websocket support Apache httpd 2.4.x is needed, 2.2.x does not support the required ws_tunnel module. Websockets are mandatory for OX Documents starting with v7.10.3. Like with JRE and MySQL/MariaDB it might be necessary to use 3rd party packages to get the needed Linux packages. Especially for RHEL6 we recommend using Red Hat Software Collections.

== Webserver ==

[https://httpd.apache.org/ Apache httpd 2.x] is required as webserver to serve static App Suite UI content. Configuration examples can be found in the quickinstall guides.

== File Storage ==

=== Temporary Data ===

OX App Suite stores temporary files in the local file system, e.g. for spooling of uploaded data. Any file system supported by the installed JRE is suitable.

=== Persistent Data ===

Persistent data like OX Drive files, PIM attachments etc. and temporary attachment data need to be stored in a distributed file system as registered filestore that is available from all server nodes. For single-node setups a local file system mount point can be used, small to mid-scale setups can be powered by NFS. For large-scale setups object storages should be considered.

==== Object Storages ====

OX App Suite ships with different optional adapters to support object storages.

{|border="2" rules="all" align="left">
|'''Vendor'''
|'''Product'''
|'''API'''
|'''Remarks'''
|-
| 
| 
| 
| 
|-
|Amazon
|AWS S3
|S3 HTTP API
|See also [[AppSuite:S3_File_Store]]
|-
|CEPH
|RadosGW
|S3 HTTP API
|See also [[AppSuite:S3_File_Store]]
|-
|Scality
|Scality RING
|Sproxyd HTTP API
|See also [[AppSuite:Scality_File_Store]]
|-
|}

== Desktop Browser (Minimum display resolution: 1024 x 768)==

{|border="2" rules="all" align="left">
|'''Browser'''
|'''OX App Suite User Front-End'''
|-
| 
| 
|-
|Google Chrome (latest & previous version)
|v7.10.5
|-
|Mozilla Firefox (latest & current ESR-Version)
|v7.10.5
|-
|Apple Safari (latest & previous version; macOS only)
|v7.10.5
|-
|Microsoft Edge (Chromium-based)
|v7.10.5
|-
|Microsoft Internet Explorer 11
|v7.10.5
|-
|Microsoft Internet Explorer 10/11
|v7.6.3
|-
|}

== Mobile Device Support==

{|border="2" rules="all" align="left">
|'''Mobile Device'''
|'''Supported Browser'''
|'''OX App Suite User Front-End'''
|'''Minimum Speed Requirements'''
|-
| 
| 
| 
| 
|-
|iPhone on iOS 14 / iOS 15 / iPad OS
|Safari
|v7.10.5
|3G connections (512/256kBit/s, 350ms latency)
|-
|Smartphone on Android 4.1 or later
|Chrome (latest & previous version)
|v7.10.5
|3G connections (512/256kBit/s, 350ms latency)
|}

== Tablet Support==

{|border="2" rules="all" align="left">
|'''Tablet'''
|'''Supported Browser'''
|'''OX App Suite User Front-End'''
|'''Minimum Speed Requirements'''
|-
| 
| 
| 
| 
|-
|Apple iPad (all devices) on iOS 14 / iOS 15 / iPad OS
|Safari
|v7.10.5
|3G connections (512/256kBit/s, 350ms latency)
|-
|Tablets on Android 4.1 or later
|Chrome (latest & previous version)
|v7.10.5
|3G connections (512/256kBit/s, 350ms latency)
|}

== Calendar/Contact synchronization Apple macOS ==

{|border="2" rules="all" align="left">
|'''Requirement'''
|Calendar synchronization with CalDAV
|Contacts synchronization with CardDAV
|-
| 
| 
| 
|-
|macOS 10.14 (Mojave)
|[[File:check.gif]]
|[[File:check.gif]]
|-
|macOS 10.15 (Catalina)
|[[File:check.gif]]
|[[File:check.gif]]
|-
|macOS 11.0 (Big Sur)
|[[File:check.gif]]
|[[File:check.gif]]
|-
|}

== Calendar/Contact synchronization Apple iOS ==

{|border="2" rules="all" align="left">
|'''Requirement'''
|Calendar synchronization with CalDAV
|Contacts synchronization with CardDAV
|-
| 
| 
| 
|-
|Apple iOS 14 / iOS 15 / iPad OS
|[[File:check.gif]]
|[[File:check.gif]]
|-
|}

== Mobility Solution - Supported- Platforms, Features and Devices ==

{|border="2" rules="all" align="left">
|'''Feature/Technology/Device'''
|[http://oxpedia.org/wiki/index.php?title=OXtender_for_Business_Mobility '''OXtender for Business Mobility'''] (availalble for App Suite, OXHE, OXSE)
|-
| 
| 
|-
|Exchange Active Sync 2.5
|[[File:check.gif]]
|-
|Exchange Active Sync 12.1
|[[File:check.gif]]
|-
| 
| 
|-
|Access and creation of emails
|[[File:check.gif]]
|-
|Personal PIM folder
|[[File:check.gif]]
|-
|Public and Shared PIM folder
|[[File:cross.gif]]
|-
|Global address book
|[[File:check.gif]]
|-
|Push E-Mail
|[[File:check.gif]]
|-
| 
| 
|-
|Apple iOS 14 / iOS 15 / iPad OS
|[[File:check.gif]]
|-
|Android 8 (Oreo) or later with latest Gmail app.
|[[File:check.gif]]
|-
|}

== OX Drive Clients ==

{|border="2" rules="all" align="left">
|'''Requirement'''
|'''System / Platform'''
|-
| 
| 
|-
|OX App Suite
|OX App Suite 7.10.5
|-
|OX Drive for Windows
|Latest versions of Windows 10 (no support of macOS clients with emulators and Windows RT)
|-
|OX Drive for macOS
|macOS Mojave 10.14, macOS Catalina 10.15, macOS Big Sur 11, Intel- and Apple Silicon-based devices are both supported
|-
|OX Drive for iOS
|iOS / iPadOS 14 and above
|-
|OX Drive for Android
|Smartphones and tablets running Android 7.0 (API level 24) and above.
|-
|}

== OX Sync App ==

{|border="2" rules="all" align="left">
|'''Requirement'''
|'''System / Platform / User Interface'''
|-
| 
| 
|-
|OX App Suite
|OX App Suite 7.10.5
|-
|OX Sync App for Android
|Smartphone on Android 5.0 or later
|-
|}

== OX Guard ==

{|border="2" rules="all" align="left">
|'''Requirement'''
|'''System / Platform / User Interface'''
|-
| 
| 
|-
|OX App Suite
|OX Guard since v2.10.5: OX App Suite v7.10.5
|-
|Mobile Device and Tablet Support
|Apple iPhone on iOS 14 / iOS 15 / iPad OS: Safari (latest version & previous version) Smartphone on Android 4.1 or later: Chrome (latest & previous version) Apple iPad (all devices) on iOS 14 / iOS 15 / iPad OS: Safari Safari (latest version & previous version) Tablets on Android 4.1 or later: Chrome (latest & previous version)
|-
|}

[[Category: OX7]]
[[Category: AppSuite]]

AppSuite:OX System Requirements

2021-04-23T12:11:37Z

Peter.horn: /* OX Drive for Clients */

= OX App Suite Requirements - Open-Xchange supported components overview =

The following table provides an overview about the supported components of OX App Suite and further products. This overview makes no claim to be complete.

Information about Maintenance expiries of components, versions and browser support, can be found in the [[AppSuite:Versioning_and_Numbering#Maintenance_expires|Maintenance Expires Table]]

== Hardware Requirements ==

=== General Assumptions ===

Open-Xchange App Suite Server (middleware services) is designed to run on physical servers or virtual machines of the same flavor. Cloud environments might be used in terms of Infrastructure as a Service (IaaS), meaning that all components need to be deployed in a classical manner on virtual machines.

This means in particular, but not only:

* Infrastructure is supposed to be "quasi-static". Automatic replacement of broken nodes is fine as long as this is always an exceptional case. Scaling out or reducing number of nodes must always be a conscious task and closely monitored.
* The only supported "Database as a service" solution is AWS RDS for MariaDB as defined by belows compatibility table.

Especially we expect the virtual hardware to be not over-provisioned. Each VM must have dedicated resources with respect to CPU cores, RAM, IOPS, storage, network bandwidth, network latency, etc.

Network is expected to be flat, inside one datacenter, no multi-datacenter, no segments. No packet loss, low latency.

'''Disclaimer: All recommendations below are without guarantee and can differ for specific deployments. For mid- and large-scale setups a detailed deployment planning and sizing tests are mandatory and should be agreed on with OX Professional Services.'''

=== High Level Design / OS setup ===

Operate services separately (USM, Document/Image Converters) as described in [https://oxpedia.org/wiki/index.php?title=AppSuite:Running_a_cluster Cluster Setup].

Clocks between all nodes must be synchronized (e.g. via NTP).

Open file/max process limits need to be adjusted properly. Based on the used Linux distribution and init system configuration will differ, see Resource Limits for further explanation.

Platform Architecture: 64 bit versions (x84_64) of the supported [[#Software Requirements | Linux distributions]]

=== Node Sizing ===

==== OX App Suite Middleware ====

* Max. 8 GB heap per JVM + 4 GB system memory for other daemons and the OS (buffers, caches)
* 4 CPU cores (virtual, physical or hyperthreads) for plain HTTP connections. If TLS is terminated on application nodes this might need to be doubled.
* Disk space
** 8 GB for OS and software
** Some services like Document Converter need SWAP partitions (~1 * RAM)
** 2 * system memory of free disk space (i.e. 12 GB RAM => 24 GB free disk space) for file spooling, log files, heap and core dumps

=== Untested/Unsupported Deployments ===

* Changes to Garbage Collector settings
* Running in containerized environments (Docker, rkt)
* Elasticity/High velocity of nodes going up and down: Services are sometimes stateful and demand static configuration
* Cloud platform services (PaaS) that promise to replacements for certain supported technologies but have not been verified by OX for these regards
* Multi-site active-active

== Software Requirements ==

=== Linux Distributions ===

OX App Suite is available as Linux packages for the following distributions:

{|border="2" rules="all" align="left">
|'''Distribution'''
|'''Versions'''
|'''Remarks'''
|-
| 
| 
| 
|-
|Red Hat Enterprise Linux
|7
|
|-
|CentOS
|7
|Install from RHEL package repositories
|-
|Debian
|9 (Stretch), 10 (Buster)
|
|-
|Univention Corporate Server
|4.4
|
|-
|Amazon Linux
|2
|Discontinued Support with end of life of OX App Suite v7.10.5
|-
|}

=== Java ===

OX App Suite Middleware requires OpenJDK headless JRE 8 or 9. Linux distributions might offer only packages for OpenJDK 11 JRE, which is not suitable for OX App Suite. It is in those cases required to install AdoptOpenJDK 8 JRE with HotSpot VM. A comprehensive installation guide can be found at https://adoptopenjdk.net/installation.html#linux-pkg. The correct JRE package is adoptopenjdk-8-hotspot-jre.

=== Databases ===

OX App Suite uses MySQL/MariaDB with the InnoDB storage engine as its primary data store. The following vendors and products are supported.

{|border="2" rules="all" align="left">
|'''Vendor'''
|'''Product'''
|'''Versions'''
|-
| 
| 
| 
|-
|Oracle
|MySQL Community Edition, Standard Edition, Enterprise Edition
|v5.6.x, v5.7.x
|-
|MariaDB
|MariaDB Server, Galera Cluster
|v10.1.x, v10.2.x, v10.4.x
|-
|Amazon
|AWS RDS for MariaDB
|10.2.x Discontinued Support with end of life of OX App Suite v7.10.5
|-
|}

==== Important Notes ====

* Open-Xchange does not plan to support '''MySQL 8 or higher'''. As MariaDB and MySQL are diverging and cannot be assumed drop-in replacements anymore, Open-Xchange will focus on MariaDB Server and MariaDB Galera Cluster. Future App Suite releases '''> 7.10.x''' might rely on features only available in '''MariaDB'''.
* Open-Xchange supports '''Percona XtraDB Cluster''' for existing customers with initial deployments done using '''App Suite 7.8.x or earlier'''. Those customers can continue to use Percona XtraDB Cluster throughout the 7.10.x release series. Like for MySQL, 7.10.x supports only versions 5.6 and 5.7. It is not planned to support Percona XtraDB Cluster beyond 7.10.x.

* For some Linux distributions the included MySQL/MariaDB packages are too old to be used with App Suite. It is mandatory then to install a supported version from '''upstream package sources'''. Possible sources are the official vendor repositories of MySQL or MariaDB as well as for example Red Hat Software Collections.
* Required '''MySQL/MariaDB configuration''' configuration differs between '''App Suite 7.8.4 and 7.10.x''' and also between the different database systems in terms of SQL modes. See [[My.cnf]] for details.
* For upgrades from App Suite <= 7.8.2 to >= 7.10.0 a comprehensive '''database upgrade guide''' exists: [[AppSuite:7_10_Database_Migration]]

== HTTP Reverse Proxy ==

An HTTP server with reverse proxy and load balancing capabilities is required in front of App Suite application servers. TLS termination, virtual hosts, path-based routing, sticky sessions and X-Forwarded headers are typical required features. OX strongly recommends [https://httpd.apache.org/ Apache httpd 2.x] for that. Configuration examples can be found in the quickinstall guides.

'''Important:''' For websocket support Apache httpd 2.4.x is needed, 2.2.x does not support the required ws_tunnel module. Websockets are mandatory for OX Documents starting with v7.10.3. Like with JRE and MySQL/MariaDB it might be necessary to use 3rd party packages to get the needed Linux packages. Especially for RHEL6 we recommend using Red Hat Software Collections.

== Webserver ==

[https://httpd.apache.org/ Apache httpd 2.x] is required as webserver to serve static App Suite UI content. Configuration examples can be found in the quickinstall guides.

== File Storage ==

=== Temporary Data ===

OX App Suite stores temporary files in the local file system, e.g. for spooling of uploaded data. Any file system supported by the installed JRE is suitable.

=== Persistent Data ===

Persistent data like OX Drive files, PIM attachments etc. and temporary attachment data need to be stored in a distributed file system as registered filestore that is available from all server nodes. For single-node setups a local file system mount point can be used, small to mid-scale setups can be powered by NFS. For large-scale setups object storages should be considered.

==== Object Storages ====

OX App Suite ships with different optional adapters to support object storages.

{|border="2" rules="all" align="left">
|'''Vendor'''
|'''Product'''
|'''API'''
|'''Remarks'''
|-
| 
| 
| 
| 
|-
|Amazon
|AWS S3
|S3 HTTP API
|See also [[AppSuite:S3_File_Store]]
|-
|CEPH
|RadosGW
|S3 HTTP API
|See also [[AppSuite:S3_File_Store]]
|-
|Scality
|Scality RING
|Sproxyd HTTP API
|See also [[AppSuite:Scality_File_Store]]
|-
|}

== Desktop Browser (Minimum display resolution: 1024 x 768)==

{|border="2" rules="all" align="left">
|'''Browser'''
|'''OX App Suite User Front-End'''
|-
| 
| 
|-
|Google Chrome (latest & previous version)
|v7.10.3, 7.10.4, 7.10.5
|-
|Mozilla Firefox (latest & current ESR-Version)
|v7.10.3, 7.10.4, 7.10.5
|-
|Apple Safari (latest & previous version; macOS only)
|v7.10.3, 7.10.4, 7.10.5
|-
|Microsoft Edge (Chromium-based)
|v7.10.3, 7.10.4, 7.10.5
|-
|Microsoft Edge (Legacy)
|v7.10.3, 7.10.4
|-
|Microsoft Internet Explorer 11
|v7.10.3, 7.10.4
|-
|Microsoft Internet Explorer 10/11
|v7.6.3
|-
|}

== Mobile Device Support==

{|border="2" rules="all" align="left">
|'''Mobile Device'''
|'''Supported Browser'''
|'''OX App Suite User Front-End'''
|'''Minimum Speed Requirements'''
|-
| 
| 
| 
| 
|-
|iPhone on iOS 13 / iOS 14 / iPad OS
|Safari
|v7.10.3, 7.10.4, 7.10.5
|3G connections (512/256kBit/s, 350ms latency)
|-
|Smartphone on Android 4.1 or later
|Chrome (latest & previous version)
|v7.10.3, 7.10.4, 7.10.5
|3G connections (512/256kBit/s, 350ms latency)
|}

== Tablet Support==

{|border="2" rules="all" align="left">
|'''Tablet'''
|'''Supported Browser'''
|'''OX App Suite User Front-End'''
|'''Minimum Speed Requirements'''
|-
| 
| 
| 
| 
|-
|Apple iPad (all devices) on iOS 13 / iOS 14 / iPad OS
|Safari
|v7.10.3, 7.10.4, 7.10.5
|3G connections (512/256kBit/s, 350ms latency)
|-
|Tablets on Android 4.1 or later
|Chrome (latest & previous version)
|v7.10.3, 7.10.4, 7.10.5
|3G connections (512/256kBit/s, 350ms latency)
|}

== Calendar/Contact synchronization Apple macOS ==

{|border="2" rules="all" align="left">
|'''Requirement'''
|Calendar synchronization with CalDAV
|Contacts synchronization with CardDAV
|-
| 
| 
| 
|-
|macOS 10.14 (Mojave)
|[[File:check.gif]]
|[[File:check.gif]]
|-
|macOS 10.15 (Catalina)
|[[File:check.gif]]
|[[File:check.gif]]
|-
|macOS 11.0 (Big Sur)
|[[File:check.gif]]
|[[File:check.gif]]
|-
|}

== Calendar/Contact synchronization Apple iOS ==

{|border="2" rules="all" align="left">
|'''Requirement'''
|Calendar synchronization with CalDAV
|Contacts synchronization with CardDAV
|-
| 
| 
| 
|-
|Apple iOS 13 / iOS 14 / iPad OS
|[[File:check.gif]]
|[[File:check.gif]]
|-
|}

== Mobility Solution - Supported- Platforms, Features and Devices ==

{|border="2" rules="all" align="left">
|'''Feature/Technology/Device'''
|[http://oxpedia.org/wiki/index.php?title=OXtender_for_Business_Mobility '''OXtender for Business Mobility'''] (availalble for App Suite, OXHE, OXSE)
|-
| 
| 
|-
|Exchange Active Sync 2.5
|[[File:check.gif]]
|-
|Exchange Active Sync 12.1
|[[File:check.gif]]
|-
| 
| 
|-
|Access and creation of emails
|[[File:check.gif]]
|-
|Personal PIM folder
|[[File:check.gif]]
|-
|Public and Shared PIM folder
|[[File:cross.gif]]
|-
|Global address book
|[[File:check.gif]]
|-
|Push E-Mail
|[[File:check.gif]]
|-
| 
| 
|-
|Apple iOS 13 / iOS 14 / iPad OS
|[[File:check.gif]]
|-
|Android 8 (Oreo) or later with latest Gmail app.
|[[File:check.gif]]
|-
|}

== OX Drive for Clients ==

{|border="2" rules="all" align="left">
|'''Requirement'''
|'''System / Platform'''
|-
| 
| 
|-
|OX App Suite
|OX App Suite 7.10.5
|-
|OX Drive for Windows
|Latest versions of Windows 8, latest versions of Windows 10 (no support of macOS clients with emulators and Windows RT)
|-
|OX Drive for macOS
|macOS Mojave 10.14, macOS Catalina 10.15, macOS Big Sur 11
|-
|OX Drive for iOS
|iOS / iPadOS 11 and above
|-
|OX Drive for Android
|Smartphones and tablets running Android 7.0 (API level 24) and above.
|-
|}

== OX Sync App ==

{|border="2" rules="all" align="left">
|'''Requirement'''
|'''System / Platform / User Interface'''
|-
| 
| 
|-
|OX App Suite
|OX App Suite 7.10.5
|-
|OX Sync App for Android
|Smartphone on Android 5.0 or later
|-
|}

== OX Guard ==

{|border="2" rules="all" align="left">
|'''Requirement'''
|'''System / Platform / User Interface'''
|-
| 
| 
|-
|OX App Suite
|OX Guard since v2.10.3: OX App Suite v7.10.3, OX Guard since v2.10.4: OX App Suite v7.10.4, OX Guard since v2.10.5: OX App Suite v7.10.5
|-
|Mobile Device and Tablet Support
|Apple iPhone on iOS 13 / iOS 14 / iPad OS: Safari (latest version & previous version) Smartphone on Android 4.1 or later: Chrome (latest & previous version) Apple iPad (all devices) on iOS 13 / iOS 14 / iPad OS: Safari Safari (latest version & previous version) Tablets on Android 4.1 or later: Chrome (latest & previous version)
|-
|}

[[Category: OX7]]
[[Category: AppSuite]]

AppSuite:OX System Requirements

2021-04-19T07:37:00Z

Peter.horn: Corrected macOS writing style.

= OX App Suite Requirements - Open-Xchange supported components overview =

The following table provides an overview about the supported components of OX App Suite and further products. This overview makes no claim to be complete.

Information about Maintenance expiries of components, versions and browser support, can be found in the [[AppSuite:Versioning_and_Numbering#Maintenance_expires|Maintenance Expires Table]]

== Hardware Requirements ==

=== General Assumptions ===

Open-Xchange App Suite Server (middleware services) is designed to run on physical servers or virtual machines of the same flavor. Cloud environments might be used in terms of Infrastructure as a Service (IaaS), meaning that all components need to be deployed in a classical manner on virtual machines.

This means in particular, but not only:

* Infrastructure is supposed to be "quasi-static". Automatic replacement of broken nodes is fine as long as this is always an exceptional case. Scaling out or reducing number of nodes must always be a conscious task and closely monitored.
* The only supported "Database as a service" solution is AWS RDS for MariaDB as defined by belows compatibility table.

Especially we expect the virtual hardware to be not over-provisioned. Each VM must have dedicated resources with respect to CPU cores, RAM, IOPS, storage, network bandwidth, network latency, etc.

Network is expected to be flat, inside one datacenter, no multi-datacenter, no segments. No packet loss, low latency.

'''Disclaimer: All recommendations below are without guarantee and can differ for specific deployments. For mid- and large-scale setups a detailed deployment planning and sizing tests are mandatory and should be agreed on with OX Professional Services.'''

=== High Level Design / OS setup ===

Operate services separately (USM, Document/Image Converters) as described in [https://oxpedia.org/wiki/index.php?title=AppSuite:Running_a_cluster Cluster Setup].

Clocks between all nodes must be synchronized (e.g. via NTP).

Open file/max process limits need to be adjusted properly. Based on the used Linux distribution and init system configuration will differ, see Resource Limits for further explanation.

Platform Architecture: 64 bit versions (x84_64) of the supported [[#Software Requirements | Linux distributions]]

=== Node Sizing ===

==== OX App Suite Middleware ====

* Max. 8 GB heap per JVM + 4 GB system memory for other daemons and the OS (buffers, caches)
* 4 CPU cores (virtual, physical or hyperthreads) for plain HTTP connections. If TLS is terminated on application nodes this might need to be doubled.
* Disk space
** 8 GB for OS and software
** Some services like Document Converter need SWAP partitions (~1 * RAM)
** 2 * system memory of free disk space (i.e. 12 GB RAM => 24 GB free disk space) for file spooling, log files, heap and core dumps

=== Untested/Unsupported Deployments ===

* Changes to Garbage Collector settings
* Running in containerized environments (Docker, rkt)
* Elasticity/High velocity of nodes going up and down: Services are sometimes stateful and demand static configuration
* Cloud platform services (PaaS) that promise to replacements for certain supported technologies but have not been verified by OX for these regards
* Multi-site active-active

== Software Requirements ==

=== Linux Distributions ===

OX App Suite is available as Linux packages for the following distributions:

{|border="2" rules="all" align="left">
|'''Distribution'''
|'''Versions'''
|'''Remarks'''
|-
| 
| 
| 
|-
|Red Hat Enterprise Linux
|7
|
|-
|CentOS
|7
|Install from RHEL package repositories
|-
|Debian
|9 (Stretch), 10 (Buster)
|
|-
|Univention Corporate Server
|4.4
|
|-
|Amazon Linux
|2
|Discontinued Support with end of life of OX App Suite v7.10.5
|-
|}

=== Java ===

OX App Suite Middleware requires OpenJDK headless JRE 8 or 9. Linux distributions might offer only packages for OpenJDK 11 JRE, which is not suitable for OX App Suite. It is in those cases required to install AdoptOpenJDK 8 JRE with HotSpot VM. A comprehensive installation guide can be found at https://adoptopenjdk.net/installation.html#linux-pkg. The correct JRE package is adoptopenjdk-8-hotspot-jre.

=== Databases ===

OX App Suite uses MySQL/MariaDB with the InnoDB storage engine as its primary data store. The following vendors and products are supported.

{|border="2" rules="all" align="left">
|'''Vendor'''
|'''Product'''
|'''Versions'''
|-
| 
| 
| 
|-
|Oracle
|MySQL Community Edition, Standard Edition, Enterprise Edition
|v5.6.x, v5.7.x
|-
|MariaDB
|MariaDB Server, Galera Cluster
|v10.1.x, v10.2.x, v10.4.x
|-
|Amazon
|AWS RDS for MariaDB
|10.2.x Discontinued Support with end of life of OX App Suite v7.10.5
|-
|}

==== Important Notes ====

* Open-Xchange does not plan to support '''MySQL 8 or higher'''. As MariaDB and MySQL are diverging and cannot be assumed drop-in replacements anymore, Open-Xchange will focus on MariaDB Server and MariaDB Galera Cluster. Future App Suite releases '''> 7.10.x''' might rely on features only available in '''MariaDB'''.
* Open-Xchange supports '''Percona XtraDB Cluster''' for existing customers with initial deployments done using '''App Suite 7.8.x or earlier'''. Those customers can continue to use Percona XtraDB Cluster throughout the 7.10.x release series. Like for MySQL, 7.10.x supports only versions 5.6 and 5.7. It is not planned to support Percona XtraDB Cluster beyond 7.10.x.

* For some Linux distributions the included MySQL/MariaDB packages are too old to be used with App Suite. It is mandatory then to install a supported version from '''upstream package sources'''. Possible sources are the official vendor repositories of MySQL or MariaDB as well as for example Red Hat Software Collections.
* Required '''MySQL/MariaDB configuration''' configuration differs between '''App Suite 7.8.4 and 7.10.x''' and also between the different database systems in terms of SQL modes. See [[My.cnf]] for details.
* For upgrades from App Suite <= 7.8.2 to >= 7.10.0 a comprehensive '''database upgrade guide''' exists: [[AppSuite:7_10_Database_Migration]]

== HTTP Reverse Proxy ==

An HTTP server with reverse proxy and load balancing capabilities is required in front of App Suite application servers. TLS termination, virtual hosts, path-based routing, sticky sessions and X-Forwarded headers are typical required features. OX strongly recommends [https://httpd.apache.org/ Apache httpd 2.x] for that. Configuration examples can be found in the quickinstall guides.

'''Important:''' For websocket support Apache httpd 2.4.x is needed, 2.2.x does not support the required ws_tunnel module. Websockets are mandatory for OX Documents starting with v7.10.3. Like with JRE and MySQL/MariaDB it might be necessary to use 3rd party packages to get the needed Linux packages. Especially for RHEL6 we recommend using Red Hat Software Collections.

== Webserver ==

[https://httpd.apache.org/ Apache httpd 2.x] is required as webserver to serve static App Suite UI content. Configuration examples can be found in the quickinstall guides.

== File Storage ==

=== Temporary Data ===

OX App Suite stores temporary files in the local file system, e.g. for spooling of uploaded data. Any file system supported by the installed JRE is suitable.

=== Persistent Data ===

Persistent data like OX Drive files, PIM attachments etc. and temporary attachment data need to be stored in a distributed file system as registered filestore that is available from all server nodes. For single-node setups a local file system mount point can be used, small to mid-scale setups can be powered by NFS. For large-scale setups object storages should be considered.

==== Object Storages ====

OX App Suite ships with different optional adapters to support object storages.

{|border="2" rules="all" align="left">
|'''Vendor'''
|'''Product'''
|'''API'''
|'''Remarks'''
|-
| 
| 
| 
| 
|-
|Amazon
|AWS S3
|S3 HTTP API
|See also [[AppSuite:S3_File_Store]]
|-
|CEPH
|RadosGW
|S3 HTTP API
|See also [[AppSuite:S3_File_Store]]
|-
|Scality
|Scality RING
|Sproxyd HTTP API
|See also [[AppSuite:Scality_File_Store]]
|-
|}

== Desktop Browser (Minimum display resolution: 1024 x 768)==

{|border="2" rules="all" align="left">
|'''Browser'''
|'''OX App Suite User Front-End'''
|-
| 
| 
|-
|Google Chrome (latest & previous version)
|v7.10.3, 7.10.4, 7.10.5
|-
|Mozilla Firefox (latest & current ESR-Version)
|v7.10.3, 7.10.4, 7.10.5
|-
|Apple Safari (latest & previous version; macOS only)
|v7.10.3, 7.10.4, 7.10.5
|-
|Microsoft Edge (Chromium-based)
|v7.10.3, 7.10.4, 7.10.5
|-
|Microsoft Edge (Legacy)
|v7.10.3, 7.10.4
|-
|Microsoft Internet Explorer 11
|v7.10.3, 7.10.4
|-
|Microsoft Internet Explorer 10/11
|v7.6.3
|-
|}

== Mobile Device Support==

{|border="2" rules="all" align="left">
|'''Mobile Device'''
|'''Supported Browser'''
|'''OX App Suite User Front-End'''
|'''Minimum Speed Requirements'''
|-
| 
| 
| 
| 
|-
|iPhone on iOS 13 / iOS 14 / iPad OS
|Safari
|v7.10.3, 7.10.4, 7.10.5
|3G connections (512/256kBit/s, 350ms latency)
|-
|Smartphone on Android 4.1 or later
|Chrome (latest & previous version)
|v7.10.3, 7.10.4, 7.10.5
|3G connections (512/256kBit/s, 350ms latency)
|}

== Tablet Support==

{|border="2" rules="all" align="left">
|'''Tablet'''
|'''Supported Browser'''
|'''OX App Suite User Front-End'''
|'''Minimum Speed Requirements'''
|-
| 
| 
| 
| 
|-
|Apple iPad (all devices) on iOS 13 / iOS 14 / iPad OS
|Safari
|v7.10.3, 7.10.4, 7.10.5
|3G connections (512/256kBit/s, 350ms latency)
|-
|Tablets on Android 4.1 or later
|Chrome (latest & previous version)
|v7.10.3, 7.10.4, 7.10.5
|3G connections (512/256kBit/s, 350ms latency)
|}

== Calendar/Contact synchronization Apple macOS ==

{|border="2" rules="all" align="left">
|'''Requirement'''
|Calendar synchronization with CalDAV
|Contacts synchronization with CardDAV
|-
| 
| 
| 
|-
|macOS 10.14 (Mojave)
|[[File:check.gif]]
|[[File:check.gif]]
|-
|macOS 10.15 (Catalina)
|[[File:check.gif]]
|[[File:check.gif]]
|-
|macOS 11.0 (Big Sur)
|[[File:check.gif]]
|[[File:check.gif]]
|-
|}

== Calendar/Contact synchronization Apple iOS ==

{|border="2" rules="all" align="left">
|'''Requirement'''
|Calendar synchronization with CalDAV
|Contacts synchronization with CardDAV
|-
| 
| 
| 
|-
|Apple iOS 13 / iOS 14 / iPad OS
|[[File:check.gif]]
|[[File:check.gif]]
|-
|}

== Mobility Solution - Supported- Platforms, Features and Devices ==

{|border="2" rules="all" align="left">
|'''Feature/Technology/Device'''
|[http://oxpedia.org/wiki/index.php?title=OXtender_for_Business_Mobility '''OXtender for Business Mobility'''] (availalble for App Suite, OXHE, OXSE)
|-
| 
| 
|-
|Exchange Active Sync 2.5
|[[File:check.gif]]
|-
|Exchange Active Sync 12.1
|[[File:check.gif]]
|-
| 
| 
|-
|Access and creation of emails
|[[File:check.gif]]
|-
|Personal PIM folder
|[[File:check.gif]]
|-
|Public and Shared PIM folder
|[[File:cross.gif]]
|-
|Global address book
|[[File:check.gif]]
|-
|Push E-Mail
|[[File:check.gif]]
|-
| 
| 
|-
|Apple iOS 13 / iOS 14 / iPad OS
|[[File:check.gif]]
|-
|Android 8 (Oreo) or later with latest Gmail app.
|[[File:check.gif]]
|-
|}

== OX Drive for Clients ==

{|border="2" rules="all" align="left">
|'''Requirement'''
|'''System / Platform'''
|-
| 
| 
|-
|OX App Suite
|OX App Suite 7.10.5
|-
|OX Drive for Windows
|Latest versions of Windows 8, latest versions of Windows 10 (no support of Mac OS X clients with emulators and Windows RT)
|-
|OX Drive for macOS
|macOS Mojave 10.14, macOS Catalina 10.15, macOS Big Sur 11
|-
|OX Drive for iOS
|Apple iOS 13 / iOS 14 / iPad OS
|-
|OX Drive for Android
|Smartphone on Android 5.x or later with Chrome (latest & previous version), Tablets on Android 5.x or later with Chrome (latest & previous version)
|-
|}

== OX Sync App ==

{|border="2" rules="all" align="left">
|'''Requirement'''
|'''System / Platform / User Interface'''
|-
| 
| 
|-
|OX App Suite
|OX App Suite 7.10.5
|-
|OX Sync App for Android
|Smartphone on Android 5.0 or later
|-
|}

== OX Guard ==

{|border="2" rules="all" align="left">
|'''Requirement'''
|'''System / Platform / User Interface'''
|-
| 
| 
|-
|OX App Suite
|OX Guard since v2.10.3: OX App Suite v7.10.3, OX Guard since v2.10.4: OX App Suite v7.10.4, OX Guard since v2.10.5: OX App Suite v7.10.5
|-
|Mobile Device and Tablet Support
|Apple iPhone on iOS 13 / iOS 14 / iPad OS: Safari (latest version & previous version) Smartphone on Android 4.1 or later: Chrome (latest & previous version) Apple iPad (all devices) on iOS 13 / iOS 14 / iPad OS: Safari Safari (latest version & previous version) Tablets on Android 4.1 or later: Chrome (latest & previous version)
|-
|}

[[Category: OX7]]
[[Category: AppSuite]]

AppSuite:OX Drive

2021-04-19T07:20:58Z

Peter.horn: /* Enabling the Finder Extension on macOS */ Clarified the difference between opening an item in the App Suite and locally (which does not require the Finder extension).

Source of http://oxpedia.org/wiki/index.php?title=AppSuite:OX_Drive

= OX Drive =

In OX App Suite, Open-Xchange provides a cloud storage called OX Drive. It provides file- and folder synchronization across multiple devices in the simplest way for the end user, fully optimized for each device type. This article explains how to set up the server-side components for OX Drive, as well as details about the app setup.

== Key features ==

* Native Apps for Windows, macOS, iOS and Android
* Easy and attractive upsell properties (e.g. Upsell based on Quota limitations)
* Apps are specially designed for the devices they run on taking into account limitations such as battery life, screen limitations, bandwidth etc.
* Controlled synchronization of files across devices
* Storage management (e.g. quota control, upload limits)
* Connection type recognition and adaptation (e.g. Wi-Fi, cell network)

== Availability ==

OX Drive is a combination of two components:
* OX Drive in OX App Suite
* OX Drive Apps (optional native apps for synchronization)

OX Drive is available as native app for the following operating systems:
* OX Drive for Windows
* OX Drive for macOS
* OX Drive for iOS
* OX Drive for Android

== Requirements ==

You will find the requirements under [[AppSuite:OX_System_Requirements#OX_Drive_for_Clients|OX Drive App and Platform Requirements]]

= Server-side Installation and Configuration =

This chapter describes how the backend components of OX Drive are installed and configured on the server.

== Prerequisites ==

* Open-Xchange Server v7.10.5 and above (''open-xchange-core'')
* Grizzly HTTP connector (''open-xchange-grizzly''), see [[AppSuite:Grizzly]] for details, with ''Comet'' support enabled in ''grizzly.properties''
* Valid Push-Certificates / API keys for cloud-based notifications, see configuration below
* Enabled Hazelcast for inter-OX-communication, see [[AppSuite:Running_a_cluster]] for details

== Available packages ==

Open-Xchange Drive is available with the following backend packages:

* ''open-xchange-drive'' - The main server components for OX Drive
* ''open-xchange-drive-comet'' - Provides the Push interface via long-polling for the desktop apps
* ''open-xchange-drive-help-*'' - Online help in various languages for the OX Drive applications (these were called ''open-xchange-appsuite-help-drive-*'' in versions earlier than Open-Xchange Server v7.6.2)
* ''open-xchange-drive-restricted'' - Restricted components, including prerequisites for cloud-based push notifications

Installation on the server varies depending on the underlying distribution, details are available in the following chapters.

=== OX Drive for Windows ===

Additionally OX Drive for Windows can be provided to users by installing additional packages.

OX Drive for Windows is able to update itself and can be downloaded from the Web UI directly via the [[AppSuite:Client_Onboarding|App Onboarding Wizard]]. Therefore the wizard must be installed and configured for OX Drive users. Besides the client onboarding feature you need the following packages:

* ''open-xchange-drive-client-windows'' - The main server component to provide the app
* ''open-xchange-drive-client-windows-generic'' - The package providing the final binary files to be installed on users machines.

To make the app download available via the app onboarding wizard, you need to enable the according scenario. Edit ''/opt/open-xchange/etc/client-onboarding-scenarios.yml'' and get to the ''drivewindowsclientinstall'' section, where you have to set the ''enabled'' property to ''true''.

[[File:Drive_Update.png|500px|thumb|left|Drive Update Info]]

===== Custom branded apps =====

OX Drive for Windows can be purchased with a custom theming. In such cases, the according binary files need to be installed on the middleware servers. Instead of the ''open-xchange-drive-client-windows-generic'' package, a package containing the branded binaries will be provided as ''open-xchange-drive-client-windows-<brand-name>'' and needs to be installed. You MUST then set the property ''com.openexchange.drive.update.branding'' in ''/opt/open-xchange/etc/drive-client-windows.properties'' to ''<brand-name>'' accordingly.

It is also possible to provide multiple brands of the app via the same OX App Suite deployment, multiple ''open-xchange-drive-client-windows-<brand-name>'' packages can be installed in parallel. Which brand is available for a certain user is determined by the ''com.openexchange.drive.update.branding'' property, which can be overwritten via [[ConfigCascade|Config Cascade]] therefore.

App brands can be managed via command line tools. The tool ''/opt/open-xchange/sbin/listdriveclients'' lists all installed brands. After updating a certain brand by installing a newer package version or installing an additional one, no server restart is necessary. Instead ''/opt/open-xchange/sbin/reloaddriveclients'' can be executed to refresh the internal server state.

=== Redhat Enterprise Linux 7 or CentOS 7 ===

If not already done, add the following repositories to your Open-Xchange yum configuration:

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL7|backend}}
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=rhelname|pc2v=RHEL7|drive-help}}
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=rhelname|pc2v=RHEL7|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive-help/updates}}
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=rhelname|pc2v=RHEL7|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive-client-windows}}
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL7|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive}}
and run

$ yum update
$ yum install open-xchange-drive open-xchange-drive-comet open-xchange-drive-restricted open-xchange-drive-client-windows

=== Debian GNU/Linux 9.0 ===

If not already done, add the following repositories to your Open-Xchange apt configuration:

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianStretch|backend}}
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=debianname|pc2v=DebianStretch|drive-help}}
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianStretch|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|backend/updates|drive|updater}}
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=debianname|pc2v=DebianStretch|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive-help/updates}}
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=debianname|pc2v=DebianStretch|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive-client-windows}}
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianStretch|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive}}

and run

$ apt-get update
$ apt-get install open-xchange-drive open-xchange-drive-comet open-xchange-drive-restricted open-xchange-drive-client-windows

=== Debian GNU/Linux 10.0 ===

If not already done, add the following repositories to your Open-Xchange apt configuration:

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianBuster|backend}}
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=debianname|pc2v=DebianBuster|drive-help}}
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianBuster|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|backend/updates|drive|updater}}
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=debianname|pc2v=DebianBuster|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive-help/updates}}
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=debianname|pc2v=DebianBuster|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive-client-windows}}
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianBuster|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive}}
and run

$ apt-get update
$ apt-get install open-xchange-drive open-xchange-drive-comet open-xchange-drive-restricted open-xchange-drive-client-windows

=== OX Server Edition / App Suite for UCS ===

If you have purchased the OX Server Edition / App Suite for UCS, the OX Drive is part of the offering and after the installation/update available. The necessary package for push, is available with a valid license and can be installed via the Univention App Center.

* The new license is already registered at the LDB after purchase.
* Log on at the Univention Management Console (UMC)
* Make sure, that the correct LDB account has been selected in the UMC module "OX License Management"
* Click on "App Center" at the UMC und switch to the tab "Repository Settings"
* Within the component list, select "Open-Xchange Drive" and press the "Install" button

== Configuration ==

The following gives an overview about the most important settings to enable file synchronization via OX Drive, especially when it comes to real-time Push notifications for the apps.

All settings regarding the OX Drive backend component are located in the configuration file ''drive.properties''. The default configuration should be sufficient for a basic "up-and-running" setup (with the exception of defining the Push certificates and API keys for cloud-based app notifications, see next chapters). Please refer to the inline documentation of the configuration file for more advanced options.

Most properties located in configuration file ''drive.properties'' are now config-cascade aware. Therefore all settings can be set per user, per contextSet or per context. If there is no configuration per user, per contextSet or per context, the configuration in ''drive.properties'' will still be used as server-wide fallback.

When installing from scratch, the configuration file ''drive.properties'' is no longer shipped, as the default values are used. For more details, find an overview of configurable settings [https://documentation.open-xchange.com/7.10.5/middleware/administration.html here].

If no Push certificates and API keys are defined but cloud-based app notifications are enabled, the Push certificates and API keys from package ''open-xchange-drive-restricted'' are used as fallback, if this package is installed.

=== Push via Firebase Cloud Messaging (FCM) ===

The OX Drive application for Android devices is able to receive Push notifications from the Open-Xchange Server via [https://firebase.google.com/docs/cloud-messaging/ Firebase Cloud Messaging (FCM)]. To issue those Push messages, the backend needs to be provided with a suitable API key for the corresponding Android app application. The API key is included in the restricted components installation package ''open-xchange-drive-restricted'' for the "vanilla" Android app. Alternatively, the key can be specified directly in the ''drive.properties'' configuration file:

# Specifies the API key of the server application. Required if
# "com.openexchange.drive.events.gcm.enabled" is "true" and the package
# containing the restricted drive components is not installed.
com.openexchange.drive.events.gcm.key=

Push via FCM can be enabled via:

# Enables or disables push event notifications to apps using the Google
# Firebase Cloud Messaging (FCM) service. This requires a valid configuration for the
# FCM API key, see options below. Defaults to "false".
com.openexchange.drive.events.gcm.enabled=true

Please note that push via FCM needs to be enabled explicitly - also if ''open-xchange-drive-restricted'' is installed.

=== Push via Apple Push Notification service (APNs) ===

The OX Drive application for iOS and macOS devices is able to receive Push notifications from the Open-Xchange Server via [http://developer.apple.com/library/IOS/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Chapters/ApplePushService.html Apple Push Notification service (APNs)]. To issue those Push messages, the backend needs to be provided with a suitable keystore container file (PKCS #12) containing the APNs certificate and keys. Note that the macOS desktop app and the iOS mobile app are served separately with different certificates, so that both needs to be configured independently. The required certificates are already included in the restricted components installation package ''open-xchange-drive-restricted'' for the "vanilla" iOS and macOS applications. Therefore no additional configuration is needed. Alternatively, an external certificate can be specified directly in the ''drive.properties'' configuration file (the following only shows the setup for iOS). First, the path to the PKCS #12 container file needs to be specified at:

# Specifies the path to the local keystore file (PKCS #12) containing the APNS
# certificate and keys for the iOS application, e.g.
# "/opt/open-xchange/etc/drive-apns.p12". Required if
# "com.openexchange.drive.events.apn.enabled" is "true" and the package
# containing the restricted drive components is not installed.
com.openexchange.drive.events.apn.ios.keystore=

This file is opened by the backend using the password as supplied via:

# Specifies the password used when creating the referenced keystore containing
# the certificate of the iOS application. Note that blank or null passwords
# are in violation of the PKCS #12 specifications. Required if
# "com.openexchange.drive.events.apn.enabled" is "true" and the package
# containing the restricted drive components is not installed.
com.openexchange.drive.events.apn.ios.password=

Configuration also allows to switch between development and production environments, however, this setting should be ''true'' normally:

# Indicates which APNS service is used when sending push notifications to iOS
# devices. A value of "true" will use the production service, a value of
# "false" the sandbox service. Defaults to "true".
com.openexchange.drive.events.apn.ios.production=true

The OX backend contacts the APNs servers from time to time to get informed about apps no longer reachable apps where the applications was uninstalled. The interval can be defined with the following setting:

# Configures the interval between queries to the APN feedback service for the
# subscribed iOS devices. The value can be defined using units of measurement:
# "D" (=days), "W" (=weeks) and "H" (=hours). Defaults to "1D" (one day).
# Leaving this parameter empty disables the feedback queries on this node.
# Since each received feedback is processed cluster-wide, only one node in the
# cluster should be enabled here.
com.openexchange.drive.events.apn.ios.feedbackQueryInterval=1D

Please note that if you have multiple backend nodes in the cluster, it's recommended that only one node is configured to contact the feedback query service. Finally, Push notifications via APN for iOS can be enabled via:

# Enables or disables push event notifications to apps using the Apple Push
# Notification service (APNS) for macOS devices. This requires a valid
# configuration for the APNS certificate and keys, see either options below,
# or install the restricted components packages for drive. Defaults to
# "false".
com.openexchange.drive.events.apn.ios.enabled=false

As stated above, configuration for Push notifications via APN for the macOS desktop application is configured similarly, the relevant options are prefixed with ''com.openexchange.drive.events.apn.macos''. Please also note that push via APNS needs to be enabled explicitly - also if ''open-xchange-drive-restricted'' is installed.

=== Further Configuration ===

* The backend component of OX Drive supplies the apps with various hyperlinks, e.g. deep-links to files and folders in the groupware webinterface or an URL to the online help. In order to point to the suitable web interface, please ensure that the correct UI web path is configured via ''com.openexchange.UIWebPath'' located in ''server.properties''.
* As already mentioned above, the backend relies on the [https://grizzly.java.net/comet.html Comet] component of the Grizzly http connector for sending push notifications to the desktop apps. Therefore, ''com.openexchange.http.grizzly.hasCometEnabled'' needs to be set to ''true'' in ''grizzly.properties''.

= Enabling OX Drive for Users =

OX Drive is enabled for all users that have the capability ''com.openexchange.capability.drive''. Please note that users need to have the ''infostore'' permission set to use drive. So the users that have ''drive'' enabled must be a subset of those users with ''infostore'' permission. Since 7.6.0 we enforce this via the default configuration. You can also enable this cabaility globally with the following setting in the ''drive.properties'' configuration file:

# Enables or disables the "drive" module capability globally. The capability
# can also be set more fine-grained via config cascade. Per default it is only
# enabled for users that have the "infostore" permission set. This is configured
# in /opt/open-xchange/etc/contextSets/drive.yml.
com.openexchange.capability.drive=false

More details about capabilities can be found at [[AppSuite:Capabilities]]. Furthermore, this capability can be defined in a more granular way using the Config Cascade as described at [[ConfigCascade]].

= Installation of the Apps =

== Installation of macOS Desktop App ==

The OX Drive for macOS is provided via the Mac App Store:

* https://itunes.apple.com/app/ox-drive/id818195014?mt=12

=== Enabling the Finder Extension on macOS ===

In order to be able to open or share documents in the App Suite from Finder you need to enable the Drive Finder Extension.

How to enable the Drive Finder Extension on macOS:
# Open the System Preferences.
# In the System Preferences window select Extensions.
# In the Extensions window select Finder.
# Enable Drive Finder Extension.

== Installation of Windows Desktop App ==

See [[AppSuite:OX_Drive#OX_Drive_for_Windows|OX Drive for Windows]].

== Installation of Mobile Apps ==

The OX Drive App is available via the different App Stores:

* iOS: https://itunes.apple.com/app/ox-drive/id798570177?mt=8

* Android: https://play.google.com/store/apps/details?id=com.openexchange.drive.vanilla

== App Configuration and Deployment ==

The user needs to enter the server URL and provide his username and password to log in. Afterwards, app-specific synchronisation settings may be configured. More information is available in the online documentation which is accessible from within the app.

After the initial synchronization is completed, all further changes are synchronized instantly across all devices.

'''Note:''' Version v7.10.3 of the OX App Suite introduced optional multifactor authentication, see https://documentation.open-xchange.com/7.10.3/middleware/security_and_encryption/multifactor_authentication.html.
The OX Drive apps do not support this yet. If activated on the server, you will not be able to connect with the apps anymore.

AppSuite:OX Drive

2021-04-19T07:18:07Z

Peter.horn: /* Installation of macOS Desktop App */ It is called "Mac App Store" (distinct service), not to be confused with the iOS "App Store".

Source of http://oxpedia.org/wiki/index.php?title=AppSuite:OX_Drive

= OX Drive =

In OX App Suite, Open-Xchange provides a cloud storage called OX Drive. It provides file- and folder synchronization across multiple devices in the simplest way for the end user, fully optimized for each device type. This article explains how to set up the server-side components for OX Drive, as well as details about the app setup.

== Key features ==

* Native Apps for Windows, macOS, iOS and Android
* Easy and attractive upsell properties (e.g. Upsell based on Quota limitations)
* Apps are specially designed for the devices they run on taking into account limitations such as battery life, screen limitations, bandwidth etc.
* Controlled synchronization of files across devices
* Storage management (e.g. quota control, upload limits)
* Connection type recognition and adaptation (e.g. Wi-Fi, cell network)

== Availability ==

OX Drive is a combination of two components:
* OX Drive in OX App Suite
* OX Drive Apps (optional native apps for synchronization)

OX Drive is available as native app for the following operating systems:
* OX Drive for Windows
* OX Drive for macOS
* OX Drive for iOS
* OX Drive for Android

== Requirements ==

You will find the requirements under [[AppSuite:OX_System_Requirements#OX_Drive_for_Clients|OX Drive App and Platform Requirements]]

= Server-side Installation and Configuration =

This chapter describes how the backend components of OX Drive are installed and configured on the server.

== Prerequisites ==

* Open-Xchange Server v7.10.5 and above (''open-xchange-core'')
* Grizzly HTTP connector (''open-xchange-grizzly''), see [[AppSuite:Grizzly]] for details, with ''Comet'' support enabled in ''grizzly.properties''
* Valid Push-Certificates / API keys for cloud-based notifications, see configuration below
* Enabled Hazelcast for inter-OX-communication, see [[AppSuite:Running_a_cluster]] for details

== Available packages ==

Open-Xchange Drive is available with the following backend packages:

* ''open-xchange-drive'' - The main server components for OX Drive
* ''open-xchange-drive-comet'' - Provides the Push interface via long-polling for the desktop apps
* ''open-xchange-drive-help-*'' - Online help in various languages for the OX Drive applications (these were called ''open-xchange-appsuite-help-drive-*'' in versions earlier than Open-Xchange Server v7.6.2)
* ''open-xchange-drive-restricted'' - Restricted components, including prerequisites for cloud-based push notifications

Installation on the server varies depending on the underlying distribution, details are available in the following chapters.

=== OX Drive for Windows ===

Additionally OX Drive for Windows can be provided to users by installing additional packages.

OX Drive for Windows is able to update itself and can be downloaded from the Web UI directly via the [[AppSuite:Client_Onboarding|App Onboarding Wizard]]. Therefore the wizard must be installed and configured for OX Drive users. Besides the client onboarding feature you need the following packages:

* ''open-xchange-drive-client-windows'' - The main server component to provide the app
* ''open-xchange-drive-client-windows-generic'' - The package providing the final binary files to be installed on users machines.

To make the app download available via the app onboarding wizard, you need to enable the according scenario. Edit ''/opt/open-xchange/etc/client-onboarding-scenarios.yml'' and get to the ''drivewindowsclientinstall'' section, where you have to set the ''enabled'' property to ''true''.

[[File:Drive_Update.png|500px|thumb|left|Drive Update Info]]

===== Custom branded apps =====

OX Drive for Windows can be purchased with a custom theming. In such cases, the according binary files need to be installed on the middleware servers. Instead of the ''open-xchange-drive-client-windows-generic'' package, a package containing the branded binaries will be provided as ''open-xchange-drive-client-windows-<brand-name>'' and needs to be installed. You MUST then set the property ''com.openexchange.drive.update.branding'' in ''/opt/open-xchange/etc/drive-client-windows.properties'' to ''<brand-name>'' accordingly.

It is also possible to provide multiple brands of the app via the same OX App Suite deployment, multiple ''open-xchange-drive-client-windows-<brand-name>'' packages can be installed in parallel. Which brand is available for a certain user is determined by the ''com.openexchange.drive.update.branding'' property, which can be overwritten via [[ConfigCascade|Config Cascade]] therefore.

App brands can be managed via command line tools. The tool ''/opt/open-xchange/sbin/listdriveclients'' lists all installed brands. After updating a certain brand by installing a newer package version or installing an additional one, no server restart is necessary. Instead ''/opt/open-xchange/sbin/reloaddriveclients'' can be executed to refresh the internal server state.

=== Redhat Enterprise Linux 7 or CentOS 7 ===

If not already done, add the following repositories to your Open-Xchange yum configuration:

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL7|backend}}
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=rhelname|pc2v=RHEL7|drive-help}}
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=rhelname|pc2v=RHEL7|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive-help/updates}}
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=rhelname|pc2v=RHEL7|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive-client-windows}}
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL7|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive}}
and run

$ yum update
$ yum install open-xchange-drive open-xchange-drive-comet open-xchange-drive-restricted open-xchange-drive-client-windows

=== Debian GNU/Linux 9.0 ===

If not already done, add the following repositories to your Open-Xchange apt configuration:

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianStretch|backend}}
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=debianname|pc2v=DebianStretch|drive-help}}
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianStretch|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|backend/updates|drive|updater}}
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=debianname|pc2v=DebianStretch|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive-help/updates}}
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=debianname|pc2v=DebianStretch|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive-client-windows}}
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianStretch|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive}}

and run

$ apt-get update
$ apt-get install open-xchange-drive open-xchange-drive-comet open-xchange-drive-restricted open-xchange-drive-client-windows

=== Debian GNU/Linux 10.0 ===

If not already done, add the following repositories to your Open-Xchange apt configuration:

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianBuster|backend}}
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=debianname|pc2v=DebianBuster|drive-help}}
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianBuster|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|backend/updates|drive|updater}}
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=debianname|pc2v=DebianBuster|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive-help/updates}}
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=debianname|pc2v=DebianBuster|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive-client-windows}}
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianBuster|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive}}
and run

$ apt-get update
$ apt-get install open-xchange-drive open-xchange-drive-comet open-xchange-drive-restricted open-xchange-drive-client-windows

=== OX Server Edition / App Suite for UCS ===

If you have purchased the OX Server Edition / App Suite for UCS, the OX Drive is part of the offering and after the installation/update available. The necessary package for push, is available with a valid license and can be installed via the Univention App Center.

* The new license is already registered at the LDB after purchase.
* Log on at the Univention Management Console (UMC)
* Make sure, that the correct LDB account has been selected in the UMC module "OX License Management"
* Click on "App Center" at the UMC und switch to the tab "Repository Settings"
* Within the component list, select "Open-Xchange Drive" and press the "Install" button

== Configuration ==

The following gives an overview about the most important settings to enable file synchronization via OX Drive, especially when it comes to real-time Push notifications for the apps.

All settings regarding the OX Drive backend component are located in the configuration file ''drive.properties''. The default configuration should be sufficient for a basic "up-and-running" setup (with the exception of defining the Push certificates and API keys for cloud-based app notifications, see next chapters). Please refer to the inline documentation of the configuration file for more advanced options.

Most properties located in configuration file ''drive.properties'' are now config-cascade aware. Therefore all settings can be set per user, per contextSet or per context. If there is no configuration per user, per contextSet or per context, the configuration in ''drive.properties'' will still be used as server-wide fallback.

When installing from scratch, the configuration file ''drive.properties'' is no longer shipped, as the default values are used. For more details, find an overview of configurable settings [https://documentation.open-xchange.com/7.10.5/middleware/administration.html here].

If no Push certificates and API keys are defined but cloud-based app notifications are enabled, the Push certificates and API keys from package ''open-xchange-drive-restricted'' are used as fallback, if this package is installed.

=== Push via Firebase Cloud Messaging (FCM) ===

The OX Drive application for Android devices is able to receive Push notifications from the Open-Xchange Server via [https://firebase.google.com/docs/cloud-messaging/ Firebase Cloud Messaging (FCM)]. To issue those Push messages, the backend needs to be provided with a suitable API key for the corresponding Android app application. The API key is included in the restricted components installation package ''open-xchange-drive-restricted'' for the "vanilla" Android app. Alternatively, the key can be specified directly in the ''drive.properties'' configuration file:

# Specifies the API key of the server application. Required if
# "com.openexchange.drive.events.gcm.enabled" is "true" and the package
# containing the restricted drive components is not installed.
com.openexchange.drive.events.gcm.key=

Push via FCM can be enabled via:

# Enables or disables push event notifications to apps using the Google
# Firebase Cloud Messaging (FCM) service. This requires a valid configuration for the
# FCM API key, see options below. Defaults to "false".
com.openexchange.drive.events.gcm.enabled=true

Please note that push via FCM needs to be enabled explicitly - also if ''open-xchange-drive-restricted'' is installed.

=== Push via Apple Push Notification service (APNs) ===

The OX Drive application for iOS and macOS devices is able to receive Push notifications from the Open-Xchange Server via [http://developer.apple.com/library/IOS/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Chapters/ApplePushService.html Apple Push Notification service (APNs)]. To issue those Push messages, the backend needs to be provided with a suitable keystore container file (PKCS #12) containing the APNs certificate and keys. Note that the macOS desktop app and the iOS mobile app are served separately with different certificates, so that both needs to be configured independently. The required certificates are already included in the restricted components installation package ''open-xchange-drive-restricted'' for the "vanilla" iOS and macOS applications. Therefore no additional configuration is needed. Alternatively, an external certificate can be specified directly in the ''drive.properties'' configuration file (the following only shows the setup for iOS). First, the path to the PKCS #12 container file needs to be specified at:

# Specifies the path to the local keystore file (PKCS #12) containing the APNS
# certificate and keys for the iOS application, e.g.
# "/opt/open-xchange/etc/drive-apns.p12". Required if
# "com.openexchange.drive.events.apn.enabled" is "true" and the package
# containing the restricted drive components is not installed.
com.openexchange.drive.events.apn.ios.keystore=

This file is opened by the backend using the password as supplied via:

# Specifies the password used when creating the referenced keystore containing
# the certificate of the iOS application. Note that blank or null passwords
# are in violation of the PKCS #12 specifications. Required if
# "com.openexchange.drive.events.apn.enabled" is "true" and the package
# containing the restricted drive components is not installed.
com.openexchange.drive.events.apn.ios.password=

Configuration also allows to switch between development and production environments, however, this setting should be ''true'' normally:

# Indicates which APNS service is used when sending push notifications to iOS
# devices. A value of "true" will use the production service, a value of
# "false" the sandbox service. Defaults to "true".
com.openexchange.drive.events.apn.ios.production=true

The OX backend contacts the APNs servers from time to time to get informed about apps no longer reachable apps where the applications was uninstalled. The interval can be defined with the following setting:

# Configures the interval between queries to the APN feedback service for the
# subscribed iOS devices. The value can be defined using units of measurement:
# "D" (=days), "W" (=weeks) and "H" (=hours). Defaults to "1D" (one day).
# Leaving this parameter empty disables the feedback queries on this node.
# Since each received feedback is processed cluster-wide, only one node in the
# cluster should be enabled here.
com.openexchange.drive.events.apn.ios.feedbackQueryInterval=1D

Please note that if you have multiple backend nodes in the cluster, it's recommended that only one node is configured to contact the feedback query service. Finally, Push notifications via APN for iOS can be enabled via:

# Enables or disables push event notifications to apps using the Apple Push
# Notification service (APNS) for macOS devices. This requires a valid
# configuration for the APNS certificate and keys, see either options below,
# or install the restricted components packages for drive. Defaults to
# "false".
com.openexchange.drive.events.apn.ios.enabled=false

As stated above, configuration for Push notifications via APN for the macOS desktop application is configured similarly, the relevant options are prefixed with ''com.openexchange.drive.events.apn.macos''. Please also note that push via APNS needs to be enabled explicitly - also if ''open-xchange-drive-restricted'' is installed.

=== Further Configuration ===

* The backend component of OX Drive supplies the apps with various hyperlinks, e.g. deep-links to files and folders in the groupware webinterface or an URL to the online help. In order to point to the suitable web interface, please ensure that the correct UI web path is configured via ''com.openexchange.UIWebPath'' located in ''server.properties''.
* As already mentioned above, the backend relies on the [https://grizzly.java.net/comet.html Comet] component of the Grizzly http connector for sending push notifications to the desktop apps. Therefore, ''com.openexchange.http.grizzly.hasCometEnabled'' needs to be set to ''true'' in ''grizzly.properties''.

= Enabling OX Drive for Users =

OX Drive is enabled for all users that have the capability ''com.openexchange.capability.drive''. Please note that users need to have the ''infostore'' permission set to use drive. So the users that have ''drive'' enabled must be a subset of those users with ''infostore'' permission. Since 7.6.0 we enforce this via the default configuration. You can also enable this cabaility globally with the following setting in the ''drive.properties'' configuration file:

# Enables or disables the "drive" module capability globally. The capability
# can also be set more fine-grained via config cascade. Per default it is only
# enabled for users that have the "infostore" permission set. This is configured
# in /opt/open-xchange/etc/contextSets/drive.yml.
com.openexchange.capability.drive=false

More details about capabilities can be found at [[AppSuite:Capabilities]]. Furthermore, this capability can be defined in a more granular way using the Config Cascade as described at [[ConfigCascade]].

= Installation of the Apps =

== Installation of macOS Desktop App ==

The OX Drive for macOS is provided via the Mac App Store:

* https://itunes.apple.com/app/ox-drive/id818195014?mt=12

=== Enabling the Finder Extension on macOS ===

In order to be able to use the Finder to open documents or share objects on macOS, you need to enable the Drive Finder Extension.

How to enable the Drive Finder Extension on macOS:
# Open the System Preferences.
# In the System Preferences window select Extensions.
# In the Extensions window select Finder.
# Enable Drive Finder Extension.

== Installation of Windows Desktop App ==

See [[AppSuite:OX_Drive#OX_Drive_for_Windows|OX Drive for Windows]].

== Installation of Mobile Apps ==

The OX Drive App is available via the different App Stores:

* iOS: https://itunes.apple.com/app/ox-drive/id798570177?mt=8

* Android: https://play.google.com/store/apps/details?id=com.openexchange.drive.vanilla

== App Configuration and Deployment ==

The user needs to enter the server URL and provide his username and password to log in. Afterwards, app-specific synchronisation settings may be configured. More information is available in the online documentation which is accessible from within the app.

After the initial synchronization is completed, all further changes are synchronized instantly across all devices.

'''Note:''' Version v7.10.3 of the OX App Suite introduced optional multifactor authentication, see https://documentation.open-xchange.com/7.10.3/middleware/security_and_encryption/multifactor_authentication.html.
The OX Drive apps do not support this yet. If activated on the server, you will not be able to connect with the apps anymore.

AppSuite:OX Drive

2021-04-19T07:16:50Z

Peter.horn: Corrected macOS references to the official writing style.

Source of http://oxpedia.org/wiki/index.php?title=AppSuite:OX_Drive

= OX Drive =

In OX App Suite, Open-Xchange provides a cloud storage called OX Drive. It provides file- and folder synchronization across multiple devices in the simplest way for the end user, fully optimized for each device type. This article explains how to set up the server-side components for OX Drive, as well as details about the app setup.

== Key features ==

* Native Apps for Windows, macOS, iOS and Android
* Easy and attractive upsell properties (e.g. Upsell based on Quota limitations)
* Apps are specially designed for the devices they run on taking into account limitations such as battery life, screen limitations, bandwidth etc.
* Controlled synchronization of files across devices
* Storage management (e.g. quota control, upload limits)
* Connection type recognition and adaptation (e.g. Wi-Fi, cell network)

== Availability ==

OX Drive is a combination of two components:
* OX Drive in OX App Suite
* OX Drive Apps (optional native apps for synchronization)

OX Drive is available as native app for the following operating systems:
* OX Drive for Windows
* OX Drive for macOS
* OX Drive for iOS
* OX Drive for Android

== Requirements ==

You will find the requirements under [[AppSuite:OX_System_Requirements#OX_Drive_for_Clients|OX Drive App and Platform Requirements]]

= Server-side Installation and Configuration =

This chapter describes how the backend components of OX Drive are installed and configured on the server.

== Prerequisites ==

* Open-Xchange Server v7.10.5 and above (''open-xchange-core'')
* Grizzly HTTP connector (''open-xchange-grizzly''), see [[AppSuite:Grizzly]] for details, with ''Comet'' support enabled in ''grizzly.properties''
* Valid Push-Certificates / API keys for cloud-based notifications, see configuration below
* Enabled Hazelcast for inter-OX-communication, see [[AppSuite:Running_a_cluster]] for details

== Available packages ==

Open-Xchange Drive is available with the following backend packages:

* ''open-xchange-drive'' - The main server components for OX Drive
* ''open-xchange-drive-comet'' - Provides the Push interface via long-polling for the desktop apps
* ''open-xchange-drive-help-*'' - Online help in various languages for the OX Drive applications (these were called ''open-xchange-appsuite-help-drive-*'' in versions earlier than Open-Xchange Server v7.6.2)
* ''open-xchange-drive-restricted'' - Restricted components, including prerequisites for cloud-based push notifications

Installation on the server varies depending on the underlying distribution, details are available in the following chapters.

=== OX Drive for Windows ===

Additionally OX Drive for Windows can be provided to users by installing additional packages.

OX Drive for Windows is able to update itself and can be downloaded from the Web UI directly via the [[AppSuite:Client_Onboarding|App Onboarding Wizard]]. Therefore the wizard must be installed and configured for OX Drive users. Besides the client onboarding feature you need the following packages:

* ''open-xchange-drive-client-windows'' - The main server component to provide the app
* ''open-xchange-drive-client-windows-generic'' - The package providing the final binary files to be installed on users machines.

To make the app download available via the app onboarding wizard, you need to enable the according scenario. Edit ''/opt/open-xchange/etc/client-onboarding-scenarios.yml'' and get to the ''drivewindowsclientinstall'' section, where you have to set the ''enabled'' property to ''true''.

[[File:Drive_Update.png|500px|thumb|left|Drive Update Info]]

===== Custom branded apps =====

OX Drive for Windows can be purchased with a custom theming. In such cases, the according binary files need to be installed on the middleware servers. Instead of the ''open-xchange-drive-client-windows-generic'' package, a package containing the branded binaries will be provided as ''open-xchange-drive-client-windows-<brand-name>'' and needs to be installed. You MUST then set the property ''com.openexchange.drive.update.branding'' in ''/opt/open-xchange/etc/drive-client-windows.properties'' to ''<brand-name>'' accordingly.

It is also possible to provide multiple brands of the app via the same OX App Suite deployment, multiple ''open-xchange-drive-client-windows-<brand-name>'' packages can be installed in parallel. Which brand is available for a certain user is determined by the ''com.openexchange.drive.update.branding'' property, which can be overwritten via [[ConfigCascade|Config Cascade]] therefore.

App brands can be managed via command line tools. The tool ''/opt/open-xchange/sbin/listdriveclients'' lists all installed brands. After updating a certain brand by installing a newer package version or installing an additional one, no server restart is necessary. Instead ''/opt/open-xchange/sbin/reloaddriveclients'' can be executed to refresh the internal server state.

=== Redhat Enterprise Linux 7 or CentOS 7 ===

If not already done, add the following repositories to your Open-Xchange yum configuration:

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL7|backend}}
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=rhelname|pc2v=RHEL7|drive-help}}
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=rhelname|pc2v=RHEL7|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive-help/updates}}
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=rhelname|pc2v=RHEL7|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive-client-windows}}
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL7|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive}}
and run

$ yum update
$ yum install open-xchange-drive open-xchange-drive-comet open-xchange-drive-restricted open-xchange-drive-client-windows

=== Debian GNU/Linux 9.0 ===

If not already done, add the following repositories to your Open-Xchange apt configuration:

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianStretch|backend}}
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=debianname|pc2v=DebianStretch|drive-help}}
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianStretch|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|backend/updates|drive|updater}}
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=debianname|pc2v=DebianStretch|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive-help/updates}}
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=debianname|pc2v=DebianStretch|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive-client-windows}}
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianStretch|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive}}

and run

$ apt-get update
$ apt-get install open-xchange-drive open-xchange-drive-comet open-xchange-drive-restricted open-xchange-drive-client-windows

=== Debian GNU/Linux 10.0 ===

If not already done, add the following repositories to your Open-Xchange apt configuration:

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianBuster|backend}}
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=debianname|pc2v=DebianBuster|drive-help}}
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianBuster|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|backend/updates|drive|updater}}
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=debianname|pc2v=DebianBuster|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive-help/updates}}
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=debianname|pc2v=DebianBuster|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive-client-windows}}
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianBuster|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive}}
and run

$ apt-get update
$ apt-get install open-xchange-drive open-xchange-drive-comet open-xchange-drive-restricted open-xchange-drive-client-windows

=== OX Server Edition / App Suite for UCS ===

If you have purchased the OX Server Edition / App Suite for UCS, the OX Drive is part of the offering and after the installation/update available. The necessary package for push, is available with a valid license and can be installed via the Univention App Center.

* The new license is already registered at the LDB after purchase.
* Log on at the Univention Management Console (UMC)
* Make sure, that the correct LDB account has been selected in the UMC module "OX License Management"
* Click on "App Center" at the UMC und switch to the tab "Repository Settings"
* Within the component list, select "Open-Xchange Drive" and press the "Install" button

== Configuration ==

The following gives an overview about the most important settings to enable file synchronization via OX Drive, especially when it comes to real-time Push notifications for the apps.

All settings regarding the OX Drive backend component are located in the configuration file ''drive.properties''. The default configuration should be sufficient for a basic "up-and-running" setup (with the exception of defining the Push certificates and API keys for cloud-based app notifications, see next chapters). Please refer to the inline documentation of the configuration file for more advanced options.

Most properties located in configuration file ''drive.properties'' are now config-cascade aware. Therefore all settings can be set per user, per contextSet or per context. If there is no configuration per user, per contextSet or per context, the configuration in ''drive.properties'' will still be used as server-wide fallback.

When installing from scratch, the configuration file ''drive.properties'' is no longer shipped, as the default values are used. For more details, find an overview of configurable settings [https://documentation.open-xchange.com/7.10.5/middleware/administration.html here].

If no Push certificates and API keys are defined but cloud-based app notifications are enabled, the Push certificates and API keys from package ''open-xchange-drive-restricted'' are used as fallback, if this package is installed.

=== Push via Firebase Cloud Messaging (FCM) ===

The OX Drive application for Android devices is able to receive Push notifications from the Open-Xchange Server via [https://firebase.google.com/docs/cloud-messaging/ Firebase Cloud Messaging (FCM)]. To issue those Push messages, the backend needs to be provided with a suitable API key for the corresponding Android app application. The API key is included in the restricted components installation package ''open-xchange-drive-restricted'' for the "vanilla" Android app. Alternatively, the key can be specified directly in the ''drive.properties'' configuration file:

# Specifies the API key of the server application. Required if
# "com.openexchange.drive.events.gcm.enabled" is "true" and the package
# containing the restricted drive components is not installed.
com.openexchange.drive.events.gcm.key=

Push via FCM can be enabled via:

# Enables or disables push event notifications to apps using the Google
# Firebase Cloud Messaging (FCM) service. This requires a valid configuration for the
# FCM API key, see options below. Defaults to "false".
com.openexchange.drive.events.gcm.enabled=true

Please note that push via FCM needs to be enabled explicitly - also if ''open-xchange-drive-restricted'' is installed.

=== Push via Apple Push Notification service (APNs) ===

The OX Drive application for iOS and macOS devices is able to receive Push notifications from the Open-Xchange Server via [http://developer.apple.com/library/IOS/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Chapters/ApplePushService.html Apple Push Notification service (APNs)]. To issue those Push messages, the backend needs to be provided with a suitable keystore container file (PKCS #12) containing the APNs certificate and keys. Note that the macOS desktop app and the iOS mobile app are served separately with different certificates, so that both needs to be configured independently. The required certificates are already included in the restricted components installation package ''open-xchange-drive-restricted'' for the "vanilla" iOS and macOS applications. Therefore no additional configuration is needed. Alternatively, an external certificate can be specified directly in the ''drive.properties'' configuration file (the following only shows the setup for iOS). First, the path to the PKCS #12 container file needs to be specified at:

# Specifies the path to the local keystore file (PKCS #12) containing the APNS
# certificate and keys for the iOS application, e.g.
# "/opt/open-xchange/etc/drive-apns.p12". Required if
# "com.openexchange.drive.events.apn.enabled" is "true" and the package
# containing the restricted drive components is not installed.
com.openexchange.drive.events.apn.ios.keystore=

This file is opened by the backend using the password as supplied via:

# Specifies the password used when creating the referenced keystore containing
# the certificate of the iOS application. Note that blank or null passwords
# are in violation of the PKCS #12 specifications. Required if
# "com.openexchange.drive.events.apn.enabled" is "true" and the package
# containing the restricted drive components is not installed.
com.openexchange.drive.events.apn.ios.password=

Configuration also allows to switch between development and production environments, however, this setting should be ''true'' normally:

# Indicates which APNS service is used when sending push notifications to iOS
# devices. A value of "true" will use the production service, a value of
# "false" the sandbox service. Defaults to "true".
com.openexchange.drive.events.apn.ios.production=true

The OX backend contacts the APNs servers from time to time to get informed about apps no longer reachable apps where the applications was uninstalled. The interval can be defined with the following setting:

# Configures the interval between queries to the APN feedback service for the
# subscribed iOS devices. The value can be defined using units of measurement:
# "D" (=days), "W" (=weeks) and "H" (=hours). Defaults to "1D" (one day).
# Leaving this parameter empty disables the feedback queries on this node.
# Since each received feedback is processed cluster-wide, only one node in the
# cluster should be enabled here.
com.openexchange.drive.events.apn.ios.feedbackQueryInterval=1D

Please note that if you have multiple backend nodes in the cluster, it's recommended that only one node is configured to contact the feedback query service. Finally, Push notifications via APN for iOS can be enabled via:

# Enables or disables push event notifications to apps using the Apple Push
# Notification service (APNS) for macOS devices. This requires a valid
# configuration for the APNS certificate and keys, see either options below,
# or install the restricted components packages for drive. Defaults to
# "false".
com.openexchange.drive.events.apn.ios.enabled=false

As stated above, configuration for Push notifications via APN for the macOS desktop application is configured similarly, the relevant options are prefixed with ''com.openexchange.drive.events.apn.macos''. Please also note that push via APNS needs to be enabled explicitly - also if ''open-xchange-drive-restricted'' is installed.

=== Further Configuration ===

* The backend component of OX Drive supplies the apps with various hyperlinks, e.g. deep-links to files and folders in the groupware webinterface or an URL to the online help. In order to point to the suitable web interface, please ensure that the correct UI web path is configured via ''com.openexchange.UIWebPath'' located in ''server.properties''.
* As already mentioned above, the backend relies on the [https://grizzly.java.net/comet.html Comet] component of the Grizzly http connector for sending push notifications to the desktop apps. Therefore, ''com.openexchange.http.grizzly.hasCometEnabled'' needs to be set to ''true'' in ''grizzly.properties''.

= Enabling OX Drive for Users =

OX Drive is enabled for all users that have the capability ''com.openexchange.capability.drive''. Please note that users need to have the ''infostore'' permission set to use drive. So the users that have ''drive'' enabled must be a subset of those users with ''infostore'' permission. Since 7.6.0 we enforce this via the default configuration. You can also enable this cabaility globally with the following setting in the ''drive.properties'' configuration file:

# Enables or disables the "drive" module capability globally. The capability
# can also be set more fine-grained via config cascade. Per default it is only
# enabled for users that have the "infostore" permission set. This is configured
# in /opt/open-xchange/etc/contextSets/drive.yml.
com.openexchange.capability.drive=false

More details about capabilities can be found at [[AppSuite:Capabilities]]. Furthermore, this capability can be defined in a more granular way using the Config Cascade as described at [[ConfigCascade]].

= Installation of the Apps =

== Installation of macOS Desktop App ==

The OX Drive for macOS is provided via the Apple App Store:

* https://itunes.apple.com/app/ox-drive/id818195014?mt=12

=== Enabling the Finder Extension on macOS ===

In order to be able to use the Finder to open documents or share objects on macOS, you need to enable the Drive Finder Extension.

How to enable the Drive Finder Extension on macOS:
# Open the System Preferences.
# In the System Preferences window select Extensions.
# In the Extensions window select Finder.
# Enable Drive Finder Extension.

== Installation of Windows Desktop App ==

See [[AppSuite:OX_Drive#OX_Drive_for_Windows|OX Drive for Windows]].

== Installation of Mobile Apps ==

The OX Drive App is available via the different App Stores:

* iOS: https://itunes.apple.com/app/ox-drive/id798570177?mt=8

* Android: https://play.google.com/store/apps/details?id=com.openexchange.drive.vanilla

== App Configuration and Deployment ==

The user needs to enter the server URL and provide his username and password to log in. Afterwards, app-specific synchronisation settings may be configured. More information is available in the online documentation which is accessible from within the app.

After the initial synchronization is completed, all further changes are synchronized instantly across all devices.

'''Note:''' Version v7.10.3 of the OX App Suite introduced optional multifactor authentication, see https://documentation.open-xchange.com/7.10.3/middleware/security_and_encryption/multifactor_authentication.html.
The OX Drive apps do not support this yet. If activated on the server, you will not be able to connect with the apps anymore.