AppSuite:OX System Requirements: Difference between revisions

From Open-Xchange
 
(179 intermediate revisions by 8 users not shown)
Line 1: Line 1:
= OX App Suite Requirements - Open-Xchange supported components overview =
= OX App Suite v7 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.
The following table provides an overview about the supported components of OX App Suite v7 and further products. This overview makes no claim to be complete.
 
Open-Xchange Server 6 overview tables about the supported components are available at [[OX_System_Requirements|OX 6 Requirements - Open-Xchange supported components overview]]


Information about Maintenance expiries of components, versions and browser support, can be found in the [[AppSuite:Versioning_and_Numbering#Maintenance_expires|Maintenance Expires Table]]
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 ==
== Hardware Requirements ==
=== General Assumptions ===
=== 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.
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:
This means in particular, but not only:


* Infrastructure is "quasi-static". We don't need to take into account things like VMs coming and going dynamically, dynamic IPs, volatile ("ephemeral") data
* 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.
* "Database as a service" is not allowed. This typically is a highly customized "MySQL like" storage engine, and not a true MySQL, and we can't control flavor, version, setup, etc. If need for configuration changes is identified, we won't be able to change anything.
* The only supported "Database as a service" solution is AWS RDS for MariaDB as defined by belows compatibility table.
 
So to summarize: we expect any virtualized platform to behave and work just like a well-known non-virtualized / physical platform.


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.
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.
Line 25: Line 23:


=== High Level Design / OS setup ===
=== High Level Design / OS setup ===
Operate services separately (USM, Document/Image Converters) as described in Cluster 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).
Clocks between all nodes must be synchronized (e.g. via NTP).
Line 34: Line 33:


=== Node Sizing ===
=== Node Sizing ===
==== OX App Suite Middleware ====
* Max. 8 GB heap per JVM + 4 GB system memory for other daemons and the OS (buffers, caches)
* 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)
* 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
* Disk space
** 5 GB for OS and software
** 8 GB for OS and software
** <code>2 * system memory</code> of free disk space (i.e. 12 GB RAM => 24 GB free disk space) for file spooling, log files, heap and core dumps
** 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 ===
=== Untested/Unsupported Deployments ===
* Changes to Garbage Collector settings
* Changes to Garbage Collector settings
* Running in containerized environments (Docker, rkt)
* Running in containerized environments (Docker, rkt)
* Elasticity/High velocity of nodes going up and down: Services are sometimes stateful and demand static configuration
* 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  
* 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
* Multi-site active-active


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


{|border="2" rules="all" align="left">
{| class="wikitable" id="ganz_oben"
  |'''Distribution'''
  |'''Distribution'''
  |'''Versions'''
  |'''Versions'''
Line 62: Line 66:
  |&nbsp;
  |&nbsp;
|-
|-
  |Suse Linux Enterprise Server
  | Red Hat Enterprise Linux
  |12
  | RHEL v7, RHEL v8
  |
  |
|-
|-
  |Red Hat Enterprise Linux
  | CentOS
  |6,7
  | v7 , v8
| Install from RHEL package repositories
|-
| Debian
| v11 (Bullseye), v12 (Bookworm)
  |
  |
|-
|-
  |CentOS
  | Univention Corporate Server
  |6,7
  | v4.4, v5.0
|Install from RHEL package repositories
|-
|Debian
|8 (Jessie), 9 (stretch)
  |
  |
|-
|Amazon Linux
|2
|Install from RHEL package repositories (from App Suite v7.10.1)
|-
|-
|}
|}
Line 86: Line 86:
=== Java ===
=== Java ===


OX App Suite Middleware requires OpenJDK headless JRE 8 or 9.
OX App Suite Middleware requires OpenJDK headless JRE 8 or 9. Linux distributions might offer only packages for OpenJDK 11 JRE or higher, which are not suitable for OX App Suite. It is in those cases required to install Eclipse Temurin 8 JRE with HotSpot VM (successor of Adoptium). A comprehensive installation guide can be found at https://adoptium.net/de/installation/linux/. The correct JRE package is '''temurin-8-jdk'''.
 
'''Please note:''' For Debian 8 (Jessie) OpenJDK 8 is only available via the [https://packages.debian.org/search?keywords=jessie-backports jessie-backports] repository.


=== Databases ===
=== Databases ===


OX App Suite uses MySQL with the InnoDB storage engine as its primary data store. The following vendors and products are supported.
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">
{| class="wikitable" id="ganz_oben"
  |'''Vendor'''
  |'''Vendor'''
  |'''Product'''
  |'''Product'''
Line 105: Line 103:
  |Oracle
  |Oracle
  |MySQL Community Edition, Standard Edition, Enterprise Edition
  |MySQL Community Edition, Standard Edition, Enterprise Edition
  |[5.6.x, 5.7.x]
  |v5.6.x, v5.7.x
|-
|-
  |MariaDB
  |MariaDB
  |MariaDB Server, Galera Cluster
  |MariaDB Server, Galera Cluster
  |[10.1.x, 10.2.x]
  |v10.1.x, v10.2.x, v10.4.x, v10.5.x, v10.6.x
|-
|Percona
|XtraDB Cluster
|[5.6.x, 5.7.x]
|-
|-
  |Amazon
<!-- |Amazon
  |AWS RDS for MariaDB
  |AWS RDS for MariaDB
  |10.2.x (from App Suite v7.10.1)
  |10.2.x<br>Discontinued Support with end of life of OX App Suite v7.10.5 -->
|-
|Amazon
|AWS RDS for MySQL
|5.7.x (from App Suite v7.10.1)
|-
|-
|}
|}


=== Important Notes ===
==== Important Notes ====


* 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, MariaDB or Percona as well as for example Red Hat Software Collections.
* 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'''.
* Required MySQL configuration differs between App Suite 7.8.4 and 7.10.0 and also between the different database systems in terms of SQL modes. See [[My.cnf]] for details.
* 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 upgrades from App Suite <= 7.8.2 to >= 7.10.0 a comprehensive database upgrade guide exists: [[AppSuite:7_10_Database_Migration]]
 
* 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 ==
== File Storage ==
Line 139: Line 142:
=== Persistent Data ===
=== Persistent Data ===


Persistent data like OX Drive files, PIM attachments etc. needs to be stored in a distributed file system 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.
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 ====
==== Object Storages ====
Line 145: Line 148:
OX App Suite ships with different optional adapters to support object storages.
OX App Suite ships with different optional adapters to support object storages.


{|border="2" rules="all" align="left">
{| class="wikitable" id="ganz_oben"
  |'''Vendor'''
  |'''Vendor'''
  |'''Product'''
  |'''Product'''
Line 170: Line 173:
  |Sproxyd HTTP API
  |Sproxyd HTTP API
  |See also [[AppSuite:Scality_File_Store]]
  |See also [[AppSuite:Scality_File_Store]]
|-
|OpenStack
|Swift
|Object Storage API V1
|Support for Swift is experimental and could be removed again in the future. See also [[AppSuite:Swift_File_Store]]
|-
|-
|}
|}
Line 180: Line 178:
== Desktop Browser (Minimum display resolution: 1024 x 768)==
== Desktop Browser (Minimum display resolution: 1024 x 768)==


{|border="2" rules="all" align="left">
{| class="wikitable" id="ganz_oben"
   |'''Browser'''
   |'''Browser'''
   |'''OX App Suite User Front-End'''
   |'''OX App Suite User Front-End'''
Line 187: Line 185:
   |&nbsp;
   |&nbsp;
  |-
  |-
   |Microsoft Internet Explorer 10/11
   |Google Chrome (latest & previous version)
   |v7.6.3
   |v7.10.6
|-
|-
   |Microsoft Internet Explorer 11/Edge
   |Mozilla Firefox (latest & current ESR-Version)
   |v7.8.4, v7.10.0, v7.10.1
   |v7.10.6
  |-
  |-
   |Mozilla Firefox (latest & previous version)
   |Apple Safari (latest & previous version; macOS only)
   |v7.8.4, v7.10.0, v7.10.1
   |v7.10.6
  |-
  |-
   |Google Chrome (latest & previous version)
   |Microsoft Edge (Chromium-based)
   |v7.8.4, v7.10.0, v7.10.1
   |v7.10.6
  |-
  |-
   |Apple Safari (10.01 & 10.03 & 12.0; Mac OS X only)
   |Microsoft Internet Explorer 10/11
   |v7.8.4, v7.10.0, v7.10.1
   |v7.6.3
  |-
  |-
|}
|}
Line 206: Line 204:
== Mobile Device Support==
== Mobile Device Support==


{|border="2" rules="all" align="left">
{| class="wikitable" id="ganz_oben"
   |'''Mobile Device'''
   |'''Mobile Device'''
   |'''Supported Browser'''
   |'''Supported Browser'''
Line 217: Line 215:
   |&nbsp;
   |&nbsp;
  |-
  |-
   |iPhone on iOS 11 / iOS 12
   |iPhone on iOS 16 / iOS 17 / iOS 18 / iPad OS
   |Safari
   |Safari
   |v7.8.4, v7.10.0, v7.10.1
   |v7.10.6
   |3G connections (512/256kBit/s, 350ms latency)
   |3G connections (512/256kBit/s, 350ms latency)
  |-
  |-
   |Smartphone on Android 4.1 or later
   |Smartphone on Android 4.1 or later
   |Chrome (latest & previous version)
   |Chrome (latest & previous version)
   |v7.8.4, v7.10.0
   |v7.10.6
   |3G connections (512/256kBit/s, 350ms latency)
   |3G connections (512/256kBit/s, 350ms latency)
|}
|}
Line 230: Line 228:
== Tablet Support==
== Tablet Support==


{|border="2" rules="all" align="left">
{| class="wikitable" id="ganz_oben"
   |'''Tablet'''
   |'''Tablet'''
   |'''Supported Browser'''
   |'''Supported Browser'''
Line 241: Line 239:
   |&nbsp;
   |&nbsp;
  |-
  |-
   |Apple iPad (all devices) on iOS 11 / iOS 12
   |Apple iPad (all devices) on iOS 16 / iOS 17 / iOS 18/ iPad OS
   |Safari
   |Safari
   |v7.8.4, v7.10.0, v7.10.1
   |v7.10.6
   |3G connections (512/256kBit/s, 350ms latency)
   |3G connections (512/256kBit/s, 350ms latency)
  |-
  |-
   |Tablets on Android 4.1 or later
   |Tablets on Android 4.1 or later
   |Chrome (latest & previous version)
   |Chrome (latest & previous version)
   |v7.8.4, v7.10.0, v7.10.1
   |v7.10.6
   |3G connections (512/256kBit/s, 350ms latency)
   |3G connections (512/256kBit/s, 350ms latency)
|}
|}


== Calendar/Contact synchronization Apple Mac OS X ==
== Calendar/Contact synchronization Apple macOS ==


{|border="2" rules="all" align="left">
{| class="wikitable" id="ganz_oben"
   |'''Requirement'''
   |'''Requirement'''
   |Calendar synchronization with CalDAV
   |Calendar synchronization with CalDAV
Line 263: Line 261:
   |&nbsp;
   |&nbsp;
|-
|-
   |Mac OS X 10.11 (El Capitan)
   |macOS 14.0 (Sonoma)
   |[[File:check.gif]]
   |[[File:check.gif]]
   |[[File:check.gif]]
   |[[File:check.gif]]
|-
|-
   |macOS 10.12, 10.13 (Sierra & High Sierra)
   |macOS 15.0 (Sequoia)
   |[[File:check.gif]]
   |[[File:check.gif]]
   |[[File:check.gif]]
   |[[File:check.gif]]
|-
|}
|}


== Calendar/Contact synchronization Apple iOS ==
== Calendar/Contact synchronization Apple iOS ==


{|border="2" rules="all" align="left">
{| class="wikitable" id="ganz_oben"
   |'''Requirement'''
   |'''Requirement'''
   |Calendar synchronization with CalDAV
   |Calendar synchronization with CalDAV
Line 284: Line 281:
   |&nbsp;
   |&nbsp;
|-
|-
   |Apple iOS 10 / iOS 11 / iOS 12
   |Apple iOS 16 / iOS 17 / iOS 18 / iPad OS
   |[[File:check.gif]]
   |[[File:check.gif]]
   |[[File:check.gif]]
   |[[File:check.gif]]
Line 292: Line 289:
== Mobility Solution - Supported-  Platforms, Features and Devices ==
== Mobility Solution - Supported-  Platforms, Features and Devices ==


{|border="2" rules="all" align="left">
{| class="wikitable" id="ganz_oben"
   |'''Feature/Technology/Device'''
   |'''Feature/Technology/Device'''
   |[http://oxpedia.org/wiki/index.php?title=OXtender_for_Business_Mobility '''OXtender for Business Mobility'''] (availalble for App Suite, OXHE, OXSE)
   |[http://oxpedia.org/wiki/index.php?title=OXtender_for_Business_Mobility '''Connector for Business Mobility''']
  |-  
  |-  
   |&nbsp;
   |&nbsp;
   |&nbsp;
   |&nbsp;
|-
  |Exchange Active Sync 2.5
  |[[File:check.gif]]
  |-
  |-
   |Exchange Active Sync 12.1
   |Exchange Active Sync 12.1
Line 311: Line 305:
   |[[File:check.gif]]
   |[[File:check.gif]]
|-
|-
   |Personal PIM folder
   |Calendar/Contact synchronization Apple iOS/Android
   |[[File:check.gif]]  
   |[[File:check.gif]]  
|-
|-
Line 326: Line 320:
   |&nbsp;
   |&nbsp;
  |-
  |-
  |Windows Phone 8 (latest & previous minor versions), Windows Phone 10 (latest & previous minor versions)
   |Apple iOS 16 / iOS 17 / iOS 18 / iPad OS
  |[[File:check.gif]]
|-
   |Apple iOS 10 / iOS 11 / iOS 12
   |[[File:check.gif]]
   |[[File:check.gif]]
  |-
  |-
   |Android 4.1 or later
   |Android 8 (Oreo) or later with latest Gmail app.
   |[[File:check.gif]]
   |[[File:check.gif]]
  |-
  |-
|}
|}


== OX Drive for Clients ==
== OX Drive Clients ==


{|border="2" rules="all" align="left">
{| class="wikitable" id="ganz_oben"
   |'''Requirement'''
   |'''Requirement'''
   |'''System / Platform'''
   |'''System / Platform'''
Line 345: Line 336:
   |&nbsp;
   |&nbsp;
   |&nbsp;
   |&nbsp;
|-
  |OX App Suite
  |OX App Suite v7.8.4, OX App Suite v7.10.0
  |-
  |-
   |OX Drive for Windows
   |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 App Suite 7.10.6<br>Latest versions of Windows 10 and above (no support for Windows RT and emulators)
  |-
  |-
   |OX Drive for Mac OS
   |OX Drive for Apple macOS
   |Mac OS X 10.11 (El Capitan), macOS 10.12, 10.13 (Sierra & High Sierra)
   |OX App Suite 7.10.6<br>macOS Sonoma 14, macOS Sequoia 15, Intel- and Apple Silicon-based devices are both supported
  |-
  |-
   |OX Drive for iOS
   |OX Drive for Apple iOS
   |Apple iOS 10, Apple iOS 11, Apple iOS 12
   |OX App Suite 7.10.6<br>iOS / iPadOS 15 and above
  |-
  |-
   |OX Drive for Android
   |OX Drive for Android
   |Smartphone on Android 4.1 or later with Chrome (latest & previous version), Tablets on Android 4.1 or later with Chrome (latest & previous version)
   |OX App Suite 7.10.6<br>Smartphones and tablets running Android 10.0 and above
|-
|}
 
== OX Mail App ==
 
{|border="2" rules="all" align="left">
  |'''Requirement'''
  |'''System / Platform / User Interface'''
|-
  |&nbsp;
  |&nbsp;
|-
  |[http://oxpedia.org/wiki/index.php?title=AppSuite:Main_Page_Quickinstall#Quick_Installation_Guide OX App Suite]
  |OX App Suite v7.8.4 or later
|-
  |[http://oxpedia.org/wiki/index.php?title=AppSuite:Mobile_API_Facade Mobile API Facade]
  |Mobile API Facade v1.0.2 or later (until OX App Suite v7.8.4)<br>Mobile API Facade v1.2.0 or later (from OX App Suite v7.10.0)<br>Mobile API Facade v1.4.0 or later (from OX App Suite v7.10.1)
|-
  |Push Notification Package
  |Package "open-xchange-mobile-api-facade-push-certificates" (available to App Suite licensees only)
|-
  |OX Mail App v2.0 for iOS
  |iOS 10, iOS 11, iOS 12 <br>Server reachable via TLS 1.2
|-
  |OX Mail App v2.0 for Android
  |Android 5.0 (Lollipop) or higher<br>Server reachable via TLS 1.2
  |-
  |-
|}
|}
Line 391: Line 353:
== OX Sync App ==
== OX Sync App ==


{|border="2" rules="all" align="left">
{| class="wikitable" id="ganz_oben"
   |'''Requirement'''
   |'''Requirement'''
   |'''System / Platform / User Interface'''
   |'''System / Platform / User Interface'''
Line 399: Line 361:
  |-
  |-
   |OX App Suite
   |OX App Suite
   |OX App Suite v7.8.4, OX App Suite v7.10.0
   |OX App Suite 7.10.6
  |-
  |-
   |OX Sync App for Android
   |OX Sync App for Android
   |Smartphone on Android 4.0 or later
   |Smartphone on Android 5.0 or later
  |-
  |-
|}
|}
Line 408: Line 370:
== OX Guard ==
== OX Guard ==


{|border="2" rules="all" align="left">
{| class="wikitable" id="ganz_oben"
   |'''Requirement'''
   |'''Requirement'''
   |'''System / Platform / User Interface'''
   |'''System / Platform / User Interface'''
Line 416: Line 378:
  |-
  |-
   |OX App Suite
   |OX App Suite
   |OX Guard since v2.6.0: OX App Suite v7.8.3<br>OX Guard since v2.8.0: OX App Suite v7.8.4<br>OX Guard since v2.10.0: OX App Suite v7.10.0
   |OX Guard since v2.10.7: OX App Suite v7.10.6
  |-
  |-
   |Mobile Device and Tablet Support
   |Mobile Device and Tablet Support
   |Apple iPhone on iOS 10 / iOS 11 / iOS 12: Safari (latest version & previous version)<br>Smartphone on Android 4.1 or later: Chrome (latest & previous version)<br>Apple iPad (all devices) on iOS 10 / iOS 11 / iOS 12: Safari Safari (latest version & previous version)<br>Tablets on Android 4.1 or later: Chrome (latest & previous version)
   |Apple iPhone on iOS 16 / iOS 17 / iOS 18/ iPad OS: Safari (latest version & previous version)<br>Smartphone on Android 4.1 or later: Chrome (latest & previous version)<br>Apple iPad (all devices) on iOS 16 / iOS 17 / iOS 18 / iPad OS: Safari Safari (latest version & previous version)<br>Tablets on Android 4.1 or later: Chrome (latest & previous version)
|-
|}
 
== eM Client for OX App Suite ==
 
{|border="2" rules="all" align="left">
  |'''Requirement'''
  |[http://oxpedia.org/wiki/index.php?title=AppSuite:EM_Client_for_OX_App_Suite '''eM Client for OX App Suite''']
|-
  |&nbsp;
  |&nbsp;
|-
  |OX App Suite
  |OX App Suite v7.8.4, OX App Suite v7.10.0
  |-
  |-
  |Client PC operating system
  |Latest versions of Windows 8 (no support of start screen tiles), latest versions of Windows 10 (no support of Mac OS X clients with emulators and Windows RT)
  |-
|}
|}


Latest revision as of 07:25, 17 September 2024

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

The following table provides an overview about the supported components of OX App Suite v7 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 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 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 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:

Distribution Versions Remarks
     
Red Hat Enterprise Linux RHEL v7, RHEL v8
CentOS v7 , v8 Install from RHEL package repositories
Debian v11 (Bullseye), v12 (Bookworm)
Univention Corporate Server v4.4, v5.0

Java

OX App Suite Middleware requires OpenJDK headless JRE 8 or 9. Linux distributions might offer only packages for OpenJDK 11 JRE or higher, which are not suitable for OX App Suite. It is in those cases required to install Eclipse Temurin 8 JRE with HotSpot VM (successor of Adoptium). A comprehensive installation guide can be found at https://adoptium.net/de/installation/linux/. The correct JRE package is temurin-8-jdk.

Databases

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

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, v10.5.x, v10.6.x

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

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.

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)

Browser OX App Suite User Front-End
   
Google Chrome (latest & previous version) v7.10.6
Mozilla Firefox (latest & current ESR-Version) v7.10.6
Apple Safari (latest & previous version; macOS only) v7.10.6
Microsoft Edge (Chromium-based) v7.10.6
Microsoft Internet Explorer 10/11 v7.6.3

Mobile Device Support

Mobile Device Supported Browser OX App Suite User Front-End Minimum Speed Requirements
       
iPhone on iOS 16 / iOS 17 / iOS 18 / iPad OS Safari v7.10.6 3G connections (512/256kBit/s, 350ms latency)
Smartphone on Android 4.1 or later Chrome (latest & previous version) v7.10.6 3G connections (512/256kBit/s, 350ms latency)

Tablet Support

Tablet Supported Browser OX App Suite User Front-End Minimum Speed Requirements
       
Apple iPad (all devices) on iOS 16 / iOS 17 / iOS 18/ iPad OS Safari v7.10.6 3G connections (512/256kBit/s, 350ms latency)
Tablets on Android 4.1 or later Chrome (latest & previous version) v7.10.6 3G connections (512/256kBit/s, 350ms latency)

Calendar/Contact synchronization Apple macOS

Requirement Calendar synchronization with CalDAV Contacts synchronization with CardDAV
     
macOS 14.0 (Sonoma) Check.gif Check.gif
macOS 15.0 (Sequoia) Check.gif Check.gif

Calendar/Contact synchronization Apple iOS

Requirement Calendar synchronization with CalDAV Contacts synchronization with CardDAV
     
Apple iOS 16 / iOS 17 / iOS 18 / iPad OS Check.gif Check.gif

Mobility Solution - Supported- Platforms, Features and Devices

Feature/Technology/Device Connector for Business Mobility
   
Exchange Active Sync 12.1 Check.gif
   
Access and creation of emails Check.gif
Calendar/Contact synchronization Apple iOS/Android Check.gif
Public and Shared PIM folder Cross.gif
Global address book Check.gif
Push E-Mail Check.gif
   
Apple iOS 16 / iOS 17 / iOS 18 / iPad OS Check.gif
Android 8 (Oreo) or later with latest Gmail app. Check.gif

OX Drive Clients

Requirement System / Platform
   
OX Drive for Windows OX App Suite 7.10.6
Latest versions of Windows 10 and above (no support for Windows RT and emulators)
OX Drive for Apple macOS OX App Suite 7.10.6
macOS Sonoma 14, macOS Sequoia 15, Intel- and Apple Silicon-based devices are both supported
OX Drive for Apple iOS OX App Suite 7.10.6
iOS / iPadOS 15 and above
OX Drive for Android OX App Suite 7.10.6
Smartphones and tablets running Android 10.0 and above

OX Sync App

Requirement System / Platform / User Interface
   
OX App Suite OX App Suite 7.10.6
OX Sync App for Android Smartphone on Android 5.0 or later

OX Guard

Requirement System / Platform / User Interface
   
OX App Suite OX Guard since v2.10.7: OX App Suite v7.10.6
Mobile Device and Tablet Support Apple iPhone on iOS 16 / iOS 17 / iOS 18/ iPad OS: Safari (latest version & previous version)
Smartphone on Android 4.1 or later: Chrome (latest & previous version)
Apple iPad (all devices) on iOS 16 / iOS 17 / iOS 18 / iPad OS: Safari Safari (latest version & previous version)
Tablets on Android 4.1 or later: Chrome (latest & previous version)
Retrieved from "https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:OX_System_Requirements&oldid=28865"