https://wiki.open-xchange.com/wiki/api.php?action=feedcontributions&feedformat=atom&user=Sonja.krause-harder
Open-Xchange - User contributions [en]
2026-06-30T15:31:57Z
User contributions
MediaWiki 1.39.7
https://wiki.open-xchange.com/wiki/index.php?title=OXLoadBalancingClustering_SessionLoadbalancing&diff=21362
OXLoadBalancingClustering SessionLoadbalancing
2016-01-27T10:49:17Z
<p>Sonja.krause-harder: </p>
<hr />
<div>Please see [[AppSuite:Grizzly]]</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:OX_Drive&diff=21211
AppSuite:OX Drive
2016-01-07T10:12:51Z
<p>Sonja.krause-harder: Remove all references to repo updater/updates -- it does not exist.</p>
<hr />
<div>= OX Drive =<br />
<br />
In OX App Suite, Open-Xchange provides a cloud storage called OX Drive. It provides file- and folder synchronization across multiple devices in the most 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 client setup.<br />
<br />
== Key features ==<br />
<br />
* Native Apps for Windows, Mac OS, iOS and Android<br />
* Easy and attractive upsell properties (e.g. Upsell based on Quota limitations)<br />
* Clients are specially designed for the devices they run on taking into account limitations such as battery life, screen limitations, bandwidth etc.<br />
* Controlled synchronization of files across devices<br />
* Storage management (e.g. quota control, upload limits)<br />
* Connection type recognition and adaptation (e.g. Wi-Fi, cell network)<br />
<br />
== Availability ==<br />
<br />
OX Drive is a combination of two components:<br />
* OX Drive in OX App Suite<br />
* OX Drive Clients (optional native client components for synchronization)<br />
<br />
OX Drive is available for the following native clients:<br />
* OX Drive for Windows<br />
* OX Drive for Mac OS<br />
* OX Drive for iOS<br />
* OX Drive for Android<br />
<br />
== Requirements ==<br />
<br />
You will find the requirements under [[AppSuite:OX_System_Requirements#OX_Drive_for_Clients|OX Drive Client and Platform Requirements]]<br />
<br />
= Server-side Installation and Configuration =<br />
<br />
This chapter describes how the backend components of OX Drive are installed and configured on the server.<br />
<br />
== Prerequisites ==<br />
<br />
* Open-Xchange Server v7.4.2 and above (''open-xchange-core'')<br />
* Grizzly HTTP connector (''open-xchange-grizzly''), see [[AppSuite:Grizzly]] for details, with ''Comet'' support enabled in ''grizzly.properties''<br />
* Valid Push-Certificates / API keys for cloud-based notifications, see configuration below<br />
* Enabled Hazelcast for inter-OX-communication, see [[AppSuite:Running_a_cluster]] for details<br />
<br />
== Available packages ==<br />
<br />
Open-Xchange Drive is available with the following backend packages:<br />
<br />
* ''open-xchange-drive'' - The main server components for OX Drive<br />
* ''open-xchange-drive-comet'' - Provides the Push interface via long-polling for the desktop clients<br />
* ''open-xchange-updater-drive'' - Adds the OX Drive application to the Windows desktop auto-updater<br />
* ''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)<br />
* ''open-xchange-drive-restricted'' - Restricted components, including prerequisites for cloud-based push notifications<br />
<br />
Installation on the server varies depending on the underlying distribution, details are available in the following chapters.<br />
<br />
=== Redhat Enterprise Linux 6 or CentOS 6 ===<br />
<br />
If not already done, add the following repositories to your Open-Xchange yum configuration:<br />
<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|backend}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=rhelname|pc2v=RHEL6|drive-help}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|backend/updates|drive|updater}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive-help/updates}}<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-drive open-xchange-drive-comet open-xchange-drive-restricted open-xchange-updater-drive<br />
<br />
=== Redhat Enterprise Linux 7 or CentOS 7 ===<br />
<br />
If not already done, add the following repositories to your Open-Xchange yum configuration:<br />
<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL7|backend}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=rhelname|pc2v=RHEL7|drive-help}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL7|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|backend/updates|drive|updater}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=rhelname|pc2v=RHEL7|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive-help/updates}}<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-drive open-xchange-drive-comet open-xchange-drive-restricted open-xchange-updater-drive<br />
<br />
=== Debian GNU/Linux 7.0 ===<br />
<br />
If not already done, add the following repositories to your Open-Xchange apt configuration:<br />
<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianWheezy|backend}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=debianname|pc2v=DebianWheezy|drive-help}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianWheezy|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|backend/updates|drive|updater}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=debianname|pc2v=DebianWheezy|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive-help/updates}}<br />
and run<br />
<br />
$ apt-get update<br />
$ apt-get install open-xchange-drive open-xchange-drive-comet open-xchange-drive-restricted open-xchange-updater-drive<br />
<br />
=== Debian GNU/Linux 8.0 ===<br />
<br />
If not already done, add the following repositories to your Open-Xchange apt configuration:<br />
<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianJessie|backend}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=debianname|pc2v=DebianJessie|drive-help}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianJessie|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|backend/updates|drive|updater}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=debianname|pc2v=DebianJessie|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive-help/updates}}<br />
and run<br />
<br />
$ apt-get update<br />
$ apt-get install open-xchange-drive open-xchange-drive-comet open-xchange-drive-restricted open-xchange-updater-drive<br />
<br />
=== SUSE Linux Enterprise Server 11 ===<br />
<br />
Add the package repository using zypper if not already present:<br />
<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLES11|backend}}<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=susename|pc2v=SLES11|drive-help}}<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLES11|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|backend/updates|drive|updater}}<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=susename|pc2v=SLES11|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive-help/updates}}<br />
<br />
and run<br />
<br />
$ zypper ref<br />
$ zypper in open-xchange-drive open-xchange-drive-comet open-xchange-drive-restricted open-xchange-updater-drive<br />
<br />
=== SUSE Linux Enterprise Server 12 ===<br />
<br />
Add the package repository using zypper if not already present:<br />
<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLE_12|backend}}<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=susename|pc2v=SLE_12|drive-help}}<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLE_12|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|backend/updates|drive|updater}}<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=susename|pc2v=SLE_12|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive-help/updates}}<br />
<br />
and run<br />
<br />
$ zypper ref<br />
$ zypper in open-xchange-drive open-xchange-drive-comet open-xchange-drive-restricted open-xchange-updater-drive<br />
<br />
=== OX Server Edition / App Suite for UCS ===<br />
<br />
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.<br />
<br />
* The new license is already registered at the LDB after purchase.<br />
* Log on at the Univention Management Console (UMC)<br />
* Make sure, that the correct LDB account has been selected in the UMC module "OX License Management"<br />
* Click on "App Center" at the UMC und switch to the tab "Repository Settings"<br />
* Within the component list, select "Open-Xchange Drive" and press the "Install" button<br />
<br />
== Configuration ==<br />
<br />
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 client applications.<br />
<br />
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 client notifications, see next chapters). Please refer to the inline documentation of the configuration file for more advanced options. <br />
<br />
=== Push via Google Cloud Messaging (GCM) ===<br />
<br />
The OX Drive application for Android devices is able to receive Push notifications from the Open-Xchange Server via [http://developer.android.com/google/gcm/index.html Google Cloud Messaging (GCM)]. To issue those Push messages, the backend needs to be provided with a suitable API key for the corresponding Android client application. The API key is included in the restricted components installation package ''open-xchange-drive-restricted'' for the "vanilla" Android client application. Alternatively, the key can be specified directly in the ''drive.properties'' configuration file:<br />
<br />
# Specifies the API key of the server application. Required if <br />
# "com.openexchange.drive.events.gcm.enabled" is "true" and the package <br />
# containing the restricted drive components is not installed.<br />
com.openexchange.drive.events.gcm.key=<br />
<br />
Push via GCM can be enabled via:<br />
<br />
# Enables or disables push event notifications to clients using the Google<br />
# Cloud Messaging (GCM) service. This requires a valid configuration for the <br />
# GCM API key, see options below. Defaults to "false". <br />
com.openexchange.drive.events.gcm.enabled=true<br />
<br />
Please note that push via GCM needs to be enabled explicitly - also if ''open-xchange-drive-restricted'' is installed.<br />
<br />
=== Push via Apple Push Notification service (APNs) ===<br />
<br />
The OX Drive application for iOS and Mac OS 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 Mac OS desktop client and the iOS mobile client are served separately with different certificates, so that both needs to be configured independantly. The required certificates are already included in the restricted components installation package ''open-xchange-drive-restricted'' for the "vanilla" iOS and Mac OS client applications. Alternatively, the 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:<br />
<br />
# Specifies the path to the local keystore file (PKCS #12) containing the APNS <br />
# certificate and keys for the iOS application, e.g. <br />
# "/opt/open-xchange/etc/drive-apns.p12". Required if <br />
# "com.openexchange.drive.events.apn.enabled" is "true" and the package <br />
# containing the restricted drive components is not installed.<br />
com.openexchange.drive.events.apn.ios.keystore=<br />
<br />
This file is opened by the backend using the password as supplied via: <br />
<br />
# Specifies the password used when creating the referenced keystore containing<br />
# the certificate of the iOS application. Note that blank or null passwords <br />
# are in violation of the PKCS #12 specifications. Required if <br />
# "com.openexchange.drive.events.apn.enabled" is "true" and the package <br />
# containing the restricted drive components is not installed.<br />
com.openexchange.drive.events.apn.ios.password=<br />
<br />
Configuration also allows to swith between development and production environments, however, this setting should be ''true'' normally:<br />
<br />
# Indicates which APNS service is used when sending push notifications to iOS<br />
# devices. A value of "true" will use the production service, a value of <br />
# "false" the sandbox service. Defaults to "true".<br />
com.openexchange.drive.events.apn.ios.production=true<br />
<br />
The OX backend contacts the APNs servers from time to time to get informed about clients no longer reachable clients where the applications was uninstalled. The interval can be defined with the following setting: <br />
<br />
# Configures the interval between queries to the APN feedback service for the<br />
# subscribed iOS devices. The value can be defined using units of measurement: <br />
# "D" (=days), "W" (=weeks) and "H" (=hours). Defaults to "1D" (one day). <br />
# Leaving this parameter empty disables the feedback queries on this node. <br />
# Since each received feedback is processed cluster-wide, only one node in the <br />
# cluster should be enabled here. <br />
com.openexchange.drive.events.apn.ios.feedbackQueryInterval=1D<br />
<br />
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:<br />
<br />
# Enables or disables push event notifications to clients using the Apple Push<br />
# Notification service (APNS) for Mac OS devices. This requires a valid <br />
# configuration for the APNS certificate and keys, see either options below, <br />
# or install the restricted components packages for drive. Defaults to <br />
# "false". <br />
com.openexchange.drive.events.apn.ios.enabled=false<br />
<br />
As stated above, configuration for Push notifications via APN for the Mac OS 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.<br />
<br />
=== Further Configuration ===<br />
<br />
* The backend component of OX Drive supplies the clients 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''.<br />
* 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 clients. Therefore, ''com.openexchange.http.grizzly.hasCometEnabled'' needs to be set to ''true'' in ''grizzly.properties''.<br />
<br />
= Enabling OX Drive for Users =<br />
<br />
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:<br />
<br />
# Enables or disables the "drive" module capability globally. The capability<br />
# can also be set more fine-grained via config cascade. Per default it is only<br />
# enabled for users that have the "infostore" permission set. This is configured<br />
# in /opt/open-xchange/etc/contextSets/drive.yml.<br />
com.openexchange.capability.drive=false<br />
<br />
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]].<br />
<br />
= Installation of the Clients =<br />
<br />
== Installation of Mac OS X Desktop Client ==<br />
<br />
The OX Drive for Mac OS X will be provided via the Apple App Store:<br />
<br />
* https://itunes.apple.com/app/ox-drive/id818195014?mt=12<br />
<br />
== Installation of Windows Desktop Client ==<br />
<br />
The OX Drive for Windows will be provided direct at the OX App Suite via the [[AppSuite:Open-Xchange_Updater|OX Updater]].<br />
<br />
== Installation on Mobile Clients ==<br />
<br />
The OX Drive App is available via the different App Stores:<br />
<br />
* iOS: https://itunes.apple.com/app/ox-drive/id798570177?mt=8<br />
<br />
* Android: https://play.google.com/store/apps/details?id=com.openexchange.drive.vanilla<br />
<br />
<br />
== Client Configuration and Deployment ==<br />
<br />
The user needs to enter the server URL and provide his username and password. Afterwards, client-specific settings may be configured. This includes the synchronization mode (All files / Favorites only) and Photostream settings on mobile devices, or the local root synchronization folder for the desktop applications. More information is available in the online documentation. <br />
<br />
After the initial synchronization is completed, all further changes are synchronized instantly across all devices.<br />
<br />
<br />
= FAQ =<br />
<br />
'''How to limit the maximum file size, a configured ''MAX_UPLOAD_SIZE'' seems to have no effect for uploads from OX Drive clients?'''<br />
<br />
This setting has no effect for files uploaded from OX Drive clients, since big uploads may also be processed via multiple requests in smaller chunks. We plan to offer a separate configuration option in a future release.<br />
<br />
'''There are strange files and folders on the backend, where do they come from, is it safe to delete them?'''<br />
<br />
To support chunked uploads, and to optimize the synchronization process, the synchronization logic may create various temporary files (''.drive'' directory and contained files). They only appear in the web interface if the setting ''Show hidden files and folders'' is enabled, and are removed automatically if not accessed for a specific period (default: 1 day).<br />
<br />
'''Not all files and folders get synchronized. Are there any restrictions?'''<br />
<br />
Yes, please consult the online help for a detailed list of excluded files and folders.<br />
<br />
'''How do I synchronize a shared or public folder?'''<br />
<br />
Currently, only the synchronization of a single root folder (and all of it's subfolders) is possible. For the mobile client applications, this is always the default personal drive folder of the user, while the desktop clients allow to choose which folder to synchronize. The synchronization of multiple root folders is scheduled for a future release.</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:OX_Mail&diff=20791
AppSuite:OX Mail
2015-10-20T14:59:30Z
<p>Sonja.krause-harder: </p>
<hr />
<div>= OX Mail =<br />
<br />
OX Mail is a native mobile phone app built specifically for smartphone users who already have a valid OX App Suite account. The app is designed to let users access their OX App Suite email environment directly from a smartphone native client.<br />
<br />
OX Mail enables users to synchronize mails between a variety of smartphone devices and OX App Suite. OX Mail consists of two elements: The OX Mail component that is built into OX App Suite and the native OX Mail app.<br />
<br />
The OX Mail app has been designed specifically for ease-of-use and is available for both iOS and Android.<br />
<br />
'''Please Note: The OX Mail app will be available in September. With this app Open-Xchange has also created a new branding concept for the customers and partners. More information can be found in the chapter [http://oxpedia.org/wiki/index.php?title=AppSuite:OX_Mail#Integrated_Branding.2FCustomization_Concept_for_Partners_and_Customers Branding/Customization Concept for Partners and Customers]'''<br />
<br />
== Requirements ==<br />
<br />
=== Server-side Installation and Configuration ===<br />
<br />
With OX Mail, OX App Suite supports server based PUSH functionality.<br />
<br />
Dovecot customers can use the special PUSH plugin without any additional costs. The plugin will be provided via the Dovecot software repository for Dovecot Pro and community edition. '''Please Note, the installation of the latest Dovecot v2.2.19 release is required'''<br />
<br />
'''Please Note: The Open-Xchange package 'open-xchange-push-imapidle' which provides mail push functionality by using the IMAP IDLE command to generate push events when new mail arrives, is not officially supported with OX Mail (app).'''<br />
<br />
If you are not using the Dovecot Push Plugin your mail backend has to actively notify the Open-Xchange middleware servers of new emails. This might require the creation of an additional OX middleware plugin to receive those notifications. For further details please contact your assigned pre-sales / prof. services contact.<br />
<br />
'''Please Note, the installation of the latest OX App Suite version is required.'''<br />
<br />
You will finde the client requirements under [[AppSuite:OX_System_Requirements#OX_Mail_for_Clients|OX Mail requirements]]<br />
<br />
== Key Benefits ==<br />
<br />
* Supports email PUSH notification for personal Inbox – emails show up immediately on the device<br />
* Quick and easy to set up with the start-up wizard<br />
* Intuitive, simple to use, design <br />
* Familiar smartphone experience<br />
* Available for both iOS and Android – download app from App Store for free<br />
<br />
A more detailed overview of OX Mail, can be found at: http://software.open-xchange.com/products/mail/doc/OX_Mail_Product_Guide.pdf<br />
<br />
== Pricing & Availability ==<br />
<br />
OX Mail will be available in September 2015.<br />
<br />
This email app is available for both iOS and Android and can be downloaded for free from the corresponding App Stores. Availability will be confirmed by Open-Xchange via the usual communication channels. <br />
<br />
'''Please note:''' The exact date when the clients become available depends on the approval process of the respective app stores. <br />
<br />
The Open-Xchange Middleware components can be downloaded from the respective download repositories as normal.<br />
<br />
Please contact your Open-Xchange account manager for further information and pricing details.<br />
<br />
= Enabling OX Mail for Users =<br />
<br />
OX Mail is enabled for all users that have the capability ''com.openexchange.capability.mobile_mail_app'' <br />
<br />
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]].<br />
<br />
IMPORTANT: <br />
By default, the capability for the OX Mail app is set to false for all users. It can be changed by editing the corresponding capability in the "permissions.properties" config file, or if you need a more fine grained selection of enabled users, you can use the well known provisioning tools / config cascade.<br />
<br />
= Installation of the Clients =<br />
<br />
The OX Mail will be available via the different App Stores for iOS and Android by September 2015<br />
<br />
= OX Mail Server-side Installation and Configuration =<br />
<br />
This chapter describes how the backend components of OX Mail are installed and configured on the server.<br />
<br />
== Available packages ==<br />
<br />
OX Mail is available with the following backend packages:<br />
<br />
* ''open-xchange-mobile-push-certificates'' - Certificates for cloud-based push notifications<br />
* ''open-xchange-mailapp-backend'' - The main server components for OX Mail<br />
* ''open-xchange-mobile-push-plugin'' - Provides Push functionality<br />
<br />
Installation on the server varies depending on the underlying distribution, details are available in the following chapters.<br />
<br />
=== Redhat Enterprise Linux 6 or CentOS 6 ===<br />
<br />
Add the following repositories to your Open-Xchange yum configuration:<br />
<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail|mailapp}}<br />
<br />
and run<br />
<br />
$ yum install open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin<br />
<br />
=== Debian GNU/Linux 6.0 (Squeeze) ===<br />
<br />
Add the following repositories to your Open-Xchange apt configuration:<br />
<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianSqueeze|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=debianname|pc2v=DebianSqueeze|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail|mailapp}}<br />
<br />
and run<br />
<br />
$ apt-get update<br />
$ apt-get install open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin<br />
<br />
=== Debian GNU/Linux 7.0 (Wheezy) ===<br />
<br />
Add the following repositories to your Open-Xchange apt configuration:<br />
<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianWheezy|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=debianname|pc2v=DebianWheezy|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail|mailapp}}<br />
<br />
and run<br />
<br />
$ apt-get update<br />
$ apt-get install open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin<br />
<br />
= Setup Description for Mobile Push =<br />
<br />
== Setup of the Open-Xchange Node==<br />
<br />
The existing push framework of the Open-Xchange Middleware has been extended by the capability to spawn "permanent" listeners for incoming new message deliveries. Up to that point the life cycle for a listener was bound to at least one active session, which is associated with a client that is allowed to receive push notifications.<br />
<br />
With introduction of the previously mentioned capability, listeners can be started without the need for an existent session right on the start of an Open-Xchange Middleware node. In addition those permanent listeners are spread approximately even over capable cluster members as - dependent on the underlying implementation - a listener representation may open/hold resources (socket connections) in order to receive notifications about new message deliveries.<br />
<br />
To prepare a certain Open-Xchange Middleware node to spawn permanent push listeners the following properties need to be configured in file '/opt/open-xchange/etc/mail-push.properties':<br />
<br />
* com.openexchange.push.allowPermanentPush<br>This is the general switch to enable/disable support for permanent listeners on a node. Thus needs to be set to "true"<br />
* com.openexchange.push.allowedClient<br>Specify the comma-separated list of clients which are allowed to receive notifications about new mails, “open-xchange-mailapp” should be added here if you plan to use it in combination with the new mobile-push feature.<br />
* com.openexchange.push.credstorage.enabled<br>As permanent listeners are required to run without an active session, the credential storage can be used to store user credentials in installations that do not support a master authentication to the mail storage Hence, if the property "com.openexchange.mail.passwordSource" (mail.properties) is not set to "global" this property is required to be set to "true"<br />
* com.openexchange.push.credstorage.passcrypt<br>This property is required if "com.openexchange.push.credstorage.enabled" is set to "true". It does specify the passphrase to use to symmetrically encrypt the stored credentials. The passphrase is required to be equal on each cluster member.<br />
* com.openexchange.push.credstorage.rdb<br>Once the credential storage is enabled, Open-Xchange offers two ways of storing the user-associated login/password combination. In cluster memory (default) or persisted to database. While the first way ensures that no user credentials are persisted nowhere in the Open-Xchange installation, it has the big disadvantage the stored credentials are gone once the last cluster members gets shut-down. Therefore there is also the possibility to store the credentials inside the database. Of course, no matter where the credentials are stored, they are encrypted using the value from com.openexchange.push.credstorage.passcrypt" property<br />
<br />
With setting the properties above the configuration on the Open-Xchange Middleware node is prepared to spawn permanent listeners.<br />
<br />
Now an appropriate push bundle/package needs to be installed that supports spawning permanent listeners. Currently Open-Xchange ships with three implementations:<br />
* open-xchange-push-dovecot<br />
* open-xchange-push-imapidle (Not recommended, therefore disabled for IMAP-IDLE by default. com.openexchange.push.imapidle.supportsPermanentListeners=false)<br />
* open-xchange-push-mailnotify<br />
<br />
Putting all together the following execution flow is taken to decide whether permanent listeners are spawned or not:<br />
<br />
[[Image:ox_mail_push_configuration_2.png|500px]]<br />
<br />
To check at any time what listeners are currently running, there is a new command-line tool "/opt/open-xchange/sbin/listpushusers" that outputs the user-id/context-id pair along-side with the information if the listener is of permanent nature or bound to an active session:<br />
<br />
[[Image:ox_mail_push_configuration_3.png|500px]]<br />
<br />
An exemplary out put might look like:<br />
~# /opt/open-xchange/sbin/listpushusers<br />
user=249, context=1, permanent=true<br />
user=402, context=1, permanent=true<br />
<br />
== Setup of the Mobile Push ==<br />
An appropriate registration for a capable client is required to create a permanent listener for a certain user. As of now, only the Open-Xchange Mail App performs such a registration request to mark the user to have a permanent listener using the newly introduced Mobile Push interfaces of the Open-Xchange Middleware.<br />
The Mobile Push feature is installed by the following packages:<br />
* open-xchange-mobile-push-plugin<br />
* open-xchange-mobile-push-certificates (Only certificates and licenses)<br />
<br />
Simply said the main purpose of the Mobile Push functionality is to register an OSGi event handler converting an incoming OSGi event with topic "com/openexchange/push" to an appropriate native push reaching the mobile device using either<br />
* APN or<br />
* GCM<br />
<br />
=== Client subscription ===<br />
To be able to do so, the client has to perform a subscribe request against the Mobile Push interface. Such a subscribe call mainly performs two things<br />
<br />
1. Storing the data into the database that is needed to initiate a APN/GCM push request<br><br />
2. Registering & starting a permanent listener in the push framework<br><br />
<br />
=== Handling of OSGi events ===<br />
<br />
Moreover, the OSGi events with topic "com/openexchange/push" are spread remotely throughout the Open-Xchange cluster. To avoid that each node yields a native push event for the mobile device, the OSGi event handler of the Mobile Push does only consider local events. This fact implies that each node that broadcasts OSGi events with topic "com/openexchange/push" is required to have the open-xchange-mobile-push packages installed; otherwise the OSGi event is not handled.<br />
<br />
=== Mobile Push configuration ===<br />
The setup of the Mobile Push functionality includes proper configuration of the communication with the APN/GCM services, which is performed in file 'mobilepushevent.properties':<br />
* com.openxchange.mobilepush.events.gcm.enabled<br>General switch to enable/disable communication with GCM service<br />
* com.openxchange.mobilepush.events.gcm.key<br>Specifies the GCM key in order to authenticate against the GCM service and to forward push messages to that service. Required if "com.openxchange.mobilenotifier.events.gcm.enabled" is "true" and you want to use a different key than provided by open-xchange-mobile-push-certificates. Otherwise the key from open-xchange-mobile-push-certificates is used.<br />
* com.openxchange.mobilepush.events.apn.ios.enabled<br>General switch to enable/disable communication with APN service<br />
* com.openxchange.mobilepush.events.apn.ios.keystore<br>Specifies the path to the local keystore file (PKCS #12) containing the APNS certificate and keys for the iOS application. Required if "com.openxchange.mobilepush.events.apn.ios.enabled" is "true" and you want to use a different certificate than provided by open-xchange-mobile-push-certificates. Otherwise the certificate from open-xchange-mobile-push-certificates is used.<br />
* com.openxchange.mobilepush.events.apn.ios.password<br>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.openxchange.mobilepush.events.apn.ios.enabled" is "true" and you want to use a different certificate than provided by open-xchange-mobile-push-certificates.<br />
<br />
= Setup of the Dovecot Push =<br />
<br />
Dovecot Push plug-in requires METADATA support on Dovecot side, but it should only be enabled for OX IMAP sessions and not for any other IMAP clients directly. Enabling can be done with e.g. the remote directive "remote 1.2.3.0/24 { imap_metadata = yes }" and specifying the IP ranges of OX. Metadata configuration is also described in the article http://wiki2.dovecot.org/ImapMetadata. Please note, the mail_attribute_dict setting also needs to be defined.<br />
<br />
The following picture should demonstrate how the overall communication flow between Mail App, Open-Xchange Middleware, and the Dovecot Push plug-in takes place. That communication flow requires the "open-xchange-push-dovecot" package to be installed on the Open-Xchange Middleware nodes and the Dovecot "http-notify" plug-in.<br />
<br />
[[Image:ox_mail_push_configuration_4.png|500px]]<br />
<br />
Once the Open-Xchange Mail App is installed on the user’s mobile device and it is allowed to show notifications about a new message delivery, the Mail App performs a subscription call to the Open-Xchange Middleware Servers using a fully authenticated session.<br />
<br />
When the "open-xchange-push-dovecot" package is installed, the previous subscribe call requests it to spawn a permanent listener. Such a listener simply tells the Dovecot server to notify about new message delivery events for the associated user by executing a special SETMETADATA command. Hence, it does not open or use any resources other than firing a single IMAP command to the Dovecot IMAP Server.<br />
<br />
Whenever a "new message delivery" event occurs, the Dovecot Server performs a HTTP callback against a configurable HTTP end-point of the Open-Xchange Middleware providing crucial information about the newly delivered message with a simple JSON body. That incoming HTTP callback is then turned into an appropriate OSGi event with topic "com/openexchange/push".<br />
<br />
That event is in turn handled by the Mobile Push event handler, which uses the event’s information to request an APN/GCM push to the mobile device.<br />
<br />
== Configuration of Dovecot "http-notify" plug-in ==<br />
<br />
To use push notifications, both the "notify" and the "push_notification" plugins need to be activated. For LMTP delivery, this is required:<br />
<br />
protocol lmtp {<br />
mail_plugins = $mail_plugins notify push_notification<br />
}<br />
<br />
If you also want push notifications to work for LDA-based delivery, you would need additional configuration:<br />
<br />
protocol lda {<br />
mail_plugins = $mail_plugins notify push_notification<br />
}<br />
<br />
The HTTP end-point (URL + authentication information) to use is configured in the Dovecot configuration file. The appropriate configuration options will contain the HTTP URL denoting the end-point to connect to as well as the authentication information for Basic Authentication as configured by properties "com.openexchange.rest.services.basic-auth.login" and "com.openexchange.rest.services.basic-auth.password".<br />
The URL to configure in Dovecot configuration follows this pattern.<br />
<http|https> + "://" + <login> + ":" + <password> + "@" + <host> + ":" + <port> + "/preliminary/http-notify/v1/notify"<br />
<br />
E.g.<br />
plugin {<br />
push_notification_driver = ox:url=http://login:pass@node1.domain.tld:8009/preliminary/http-notify/v1/notify<br />
}<br />
<br />
Furthermore, it is also possible to specify more than one HTTP end-point to connect to if a new message delivery occurs. Thus the configuration section mentioned above may be extended by additional "push_notification_driver" entries; e.g. push_notification_driver2, push_notification_driver3, etc.<br />
<br />
Please note that the path "/preliminary/http-notify/v1/notify" denotes the internal REST API of the Open-Xchange Middleware, which is not publicly accessible. The administrator can decide whether to add that path to the Apache configuration (see also [[AppSuite:Apache_Configuration]] and [[AppSuite:Grizzly]]) through a Location/ProxyPass directive:<br />
<br />
<Location /preliminary><br />
Order Deny,Allow<br />
Deny from all<br />
# Only allow access from servers within the network. Do not expose this<br />
# location outside of your network. In case you use a load balancing service in front<br />
# of your Apache infrastructure you should make sure that access to /preliminary will<br />
# be blocked from the internet / outside clients. Examples:<br />
# Allow from 192.168.0.1<br />
# Allow from 192.168.1.1 192.168.1.2<br />
# Allow from 192.168.0.<br />
ProxyPass /preliminary balancer://oxcluster/preliminary<br />
</Location><br />
<br />
In case the "user=" sent by OX in the push_notification_driver url data does not match the IMAP login of a user, Dovecot ignores it. This can be overridden by defining "user_from_metadata" in the push_notification_driver url, e.g. <br />
<br />
push_notification_driver = ox:url=http://example.com/ user_from_metadata<br />
<br />
= Integrated Branding/Customization Concept for Partners and Customers =<br />
<br />
With OX Mail it is also possible for customers and partners to add branding elements to the app. During the installation of the app a user is presented with a list of preconfigured providers. When a provider is selected the app is automatically setup and branded for that provider.<br />
<br />
For both design reasons, as well as app store restrictions, branding in this context means:<br />
* The app design is “Super Flat”. This means there are not many elements that can be, or need to be, styled in order to match a particular brand.<br />
* The app does not contain or use any logos of any sort. <br />
* At install time the app uses a startup wizard in combination with a hosted configuration service. The wizard gives the end user the option to select a provider from a list. When this is done the app will retrieve the branding information from the configuration service and changes its theme accordingly. <br />
<br />
== Branding / Customization Process ==<br />
<br />
In order to participate you will need to provide specific information such as:<br />
<br />
* Confirmation that you are running OX App Suite 7.6.2 including the latest patch.<br />
* A full URL where your OX App Suite service can be reached by a web client.<br />
* Two test accounts on your OX App Suite service, where we can verify that the OX App Suite system works as expected.<br />
* A “logo” and “name” of your service. This information will be used in the app itself.<br />
* Optional: A preferred color (CI color) that Open-Xchange will use for the app if a user chooses their service from the provider list.<br />
<br />
=== Steps ===<br />
<br />
# Please download the Questionnaire from [http://knowledgebase.open-xchange.com/fileadmin/user_upload/open-xchange/document/misc/Questionnaire_OX_Mail_Branding.pdf Open-Xchange Download Server]<br />
# Please fill out the Questionnaire and send it to your Open-Xchange account manager.<br />
# Open-Xchange will check the data. If all information are available, Open-Xchange will add your personal brand to the live OX Mail app. Please Note: The exact date when your brand becomes available depends on the approval process and could take 5 to 10 days. Open-Xchange won't communicate an exact date. Please check by your self.<br />
<br />
[[Category: OX7]]<br />
[[Category: AppSuite]]<br />
[[Category: OXMailapp]]</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:OX_Mail&diff=20790
AppSuite:OX Mail
2015-10-20T14:43:57Z
<p>Sonja.krause-harder: </p>
<hr />
<div>= OX Mail =<br />
<br />
OX Mail is a native mobile phone app built specifically for smartphone users who already have a valid OX App Suite account. The app is designed to let users access their OX App Suite email environment directly from a smartphone native client.<br />
<br />
OX Mail enables users to synchronize mails between a variety of smartphone devices and OX App Suite. OX Mail consists of two elements: The OX Mail component that is built into OX App Suite and the native OX Mail app.<br />
<br />
The OX Mail app has been designed specifically for ease-of-use and is available for both iOS and Android.<br />
<br />
'''Please Note: The OX Mail app will be available in September. With this app Open-Xchange has also created a new branding concept for the customers and partners. More information can be found in the chapter [http://oxpedia.org/wiki/index.php?title=AppSuite:OX_Mail#Integrated_Branding.2FCustomization_Concept_for_Partners_and_Customers Branding/Customization Concept for Partners and Customers]'''<br />
<br />
== Requirements ==<br />
<br />
=== Server-side Installation and Configuration ===<br />
<br />
With OX Mail, OX App Suite supports server based PUSH functionality.<br />
<br />
Dovecot customers can use the special PUSH plugin without any additional costs. The plugin will be provided via the Dovecot software repository for Dovecot Pro and community edition. '''Please Note, the installation of the latest Dovecot v2.2.19 release is required'''<br />
<br />
'''Please Note: The Open-Xchange package 'open-xchange-push-imapidle' which provides mail push functionality by using the IMAP IDLE command to generate push events when new mail arrives, is not officially supported with OX Mail (app).'''<br />
<br />
If you are not using the Dovecot Push Plugin your mail backend has to actively notify the Open-Xchange middleware servers of new emails. This might require the creation of an additional OX middleware plugin to receive those notifications. For further details please contact your assigned pre-sales / prof. services contact.<br />
<br />
'''Please Note, the installation of the latest OX App Suite version is required.'''<br />
<br />
You will finde the client requirements under [[AppSuite:OX_System_Requirements#OX_Mail_for_Clients|OX Mail requirements]]<br />
<br />
== Key Benefits ==<br />
<br />
* Supports email PUSH notification for personal Inbox – emails show up immediately on the device<br />
* Quick and easy to set up with the start-up wizard<br />
* Intuitive, simple to use, design <br />
* Familiar smartphone experience<br />
* Available for both iOS and Android – download app from App Store for free<br />
<br />
A more detailed overview of OX Mail, can be found at: http://software.open-xchange.com/products/mail/doc/OX_Mail_Product_Guide.pdf<br />
<br />
== Pricing & Availability ==<br />
<br />
OX Mail will be available in September 2015.<br />
<br />
This email app is available for both iOS and Android and can be downloaded for free from the corresponding App Stores. Availability will be confirmed by Open-Xchange via the usual communication channels. <br />
<br />
'''Please note:''' The exact date when the clients become available depends on the approval process of the respective app stores. <br />
<br />
The Open-Xchange Middleware components can be downloaded from the respective download repositories as normal.<br />
<br />
Please contact your Open-Xchange account manager for further information and pricing details.<br />
<br />
= Enabling OX Mail for Users =<br />
<br />
OX Mail is enabled for all users that have the capability ''com.openexchange.capability.mobile_mail_app'' <br />
<br />
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]].<br />
<br />
IMPORTANT: <br />
By default, the capability for the OX Mail app is set to false for all users. It can be changed by editing the corresponding capability in the "permissions.properties" config file, or if you need a more fine grained selection of enabled users, you can use the well known provisioning tools / config cascade.<br />
<br />
= Installation of the Clients =<br />
<br />
The OX Mail will be available via the different App Stores for iOS and Android by September 2015<br />
<br />
= OX Mail Server-side Installation and Configuration =<br />
<br />
This chapter describes how the backend components of OX Mail are installed and configured on the server.<br />
<br />
== Available packages ==<br />
<br />
OX Mail is available with the following backend packages:<br />
<br />
* ''open-xchange-mobile-push-certificates'' - Certificates for cloud-based push notifications<br />
* ''open-xchange-mailapp-backend'' - The main server components for OX Mail<br />
* ''open-xchange-mobile-push-plugin'' - Provides Push functionality<br />
<br />
Installation on the server varies depending on the underlying distribution, details are available in the following chapters.<br />
<br />
=== Redhat Enterprise Linux 6 or CentOS 6 ===<br />
<br />
Add the following repositories to your Open-Xchange yum configuration:<br />
<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail|mailapp}}<br />
<br />
and run<br />
<br />
$ yum install open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin<br />
<br />
=== Debian GNU/Linux 6.0 (Squeeze) ===<br />
<br />
Add the following repositories to your Open-Xchange apt configuration:<br />
<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianSqueeze|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=debianname|pc2v=DebianSqueeze|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail|mailapp}}<br />
<br />
and run<br />
<br />
$ apt-get update<br />
$ apt-get install open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin<br />
<br />
=== Debian GNU/Linux 7.0 (Wheezy) ===<br />
<br />
Add the following repositories to your Open-Xchange apt configuration:<br />
<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianWheezy|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=debianname|pc2v=DebianWheezy|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail|mailapp}}<br />
<br />
and run<br />
<br />
$ apt-get update<br />
$ apt-get install open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin<br />
<br />
= Setup Description for Mobile Push =<br />
<br />
== Setup of the Open-Xchange Node==<br />
<br />
The existing push framework of the Open-Xchange Middleware has been extended by the capability to spawn "permanent" listeners for incoming new message deliveries. Up to that point the life cycle for a listener was bound to at least one active session, which is associated with a client that is allowed to receive push notifications.<br />
<br />
With introduction of the previously mentioned capability, listeners can be started without the need for an existent session right on the start of an Open-Xchange Middleware node. In addition those permanent listeners are spread approximately even over capable cluster members as - dependent on the underlying implementation - a listener representation may open/hold resources (socket connections) in order to receive notifications about new message deliveries.<br />
<br />
To prepare a certain Open-Xchange Middleware node to spawn permanent push listeners the following properties need to be configured in file '/opt/open-xchange/etc/mail-push.properties':<br />
<br />
* com.openexchange.push.allowPermanentPush<br>This is the general switch to enable/disable support for permanent listeners on a node. Thus needs to be set to "true"<br />
* com.openexchange.push.allowedClient<br>Specify the comma-separated list of clients which are allowed to receive notifications about new mails, “open-xchange-mailapp” should be added here if you plan to use it in combination with the new mobile-push feature.<br />
* com.openexchange.push.credstorage.enabled<br>As permanent listeners are required to run without an active session, the credential storage can be used to store user credentials in installations that do not support a master authentication to the mail storage Hence, if the property "com.openexchange.mail.passwordSource" (mail.properties) is not set to "global" this property is required to be set to "true"<br />
* com.openexchange.push.credstorage.passcrypt<br>This property is required if "com.openexchange.push.credstorage.enabled" is set to "true". It does specify the passphrase to use to symmetrically encrypt the stored credentials. The passphrase is required to be equal on each cluster member.<br />
* com.openexchange.push.credstorage.rdb<br>Once the credential storage is enabled, Open-Xchange offers two ways of storing the user-associated login/password combination. In cluster memory (default) or persisted to database. While the first way ensures that no user credentials are persisted nowhere in the Open-Xchange installation, it has the big disadvantage the stored credentials are gone once the last cluster members gets shut-down. Therefore there is also the possibility to store the credentials inside the database. Of course, no matter where the credentials are stored, they are encrypted using the value from com.openexchange.push.credstorage.passcrypt" property<br />
<br />
With setting the properties above the configuration on the Open-Xchange Middleware node is prepared to spawn permanent listeners.<br />
<br />
Now an appropriate push bundle/package needs to be installed that supports spawning permanent listeners. Currently Open-Xchange ships with three implementations:<br />
* open-xchange-push-dovecot<br />
* open-xchange-push-imapidle (Not recommended, therefore disabled for IMAP-IDLE by default. com.openexchange.push.imapidle.supportsPermanentListeners=false)<br />
* open-xchange-push-mailnotify<br />
<br />
Putting all together the following execution flow is taken to decide whether permanent listeners are spawned or not:<br />
<br />
[[Image:ox_mail_push_configuration_2.png|500px]]<br />
<br />
To check at any time what listeners are currently running, there is a new command-line tool "/opt/open-xchange/sbin/listpushusers" that outputs the user-id/context-id pair along-side with the information if the listener is of permanent nature or bound to an active session:<br />
<br />
[[Image:ox_mail_push_configuration_3.png|500px]]<br />
<br />
An exemplary out put might look like:<br />
~# /opt/open-xchange/sbin/listpushusers<br />
user=249, context=1, permanent=true<br />
user=402, context=1, permanent=true<br />
<br />
== Setup of the Mobile Push ==<br />
An appropriate registration for a capable client is required to create a permanent listener for a certain user. As of now, only the Open-Xchange Mail App performs such a registration request to mark the user to have a permanent listener using the newly introduced Mobile Push interfaces of the Open-Xchange Middleware.<br />
The Mobile Push feature is installed by the following packages:<br />
* open-xchange-mobile-push<br />
* open-xchange-mobile-push-certificates (Only certificates and licenses)<br />
<br />
Simply said the main purpose of the Mobile Push functionality is to register an OSGi event handler converting an incoming OSGi event with topic "com/openexchange/push" to an appropriate native push reaching the mobile device using either<br />
* APN or<br />
* GCM<br />
<br />
=== Client subscription ===<br />
To be able to do so, the client has to perform a subscribe request against the Mobile Push interface. Such a subscribe call mainly performs two things<br />
<br />
1. Storing the data into the database that is needed to initiate a APN/GCM push request<br><br />
2. Registering & starting a permanent listener in the push framework<br><br />
<br />
=== Handling of OSGi events ===<br />
<br />
Moreover, the OSGi events with topic "com/openexchange/push" are spread remotely throughout the Open-Xchange cluster. To avoid that each node yields a native push event for the mobile device, the OSGi event handler of the Mobile Push does only consider local events. This fact implies that each node that broadcasts OSGi events with topic "com/openexchange/push" is required to have the open-xchange-mobile-push packages installed; otherwise the OSGi event is not handled.<br />
<br />
=== Mobile Push configuration ===<br />
The setup of the Mobile Push functionality includes proper configuration of the communication with the APN/GCM services, which is performed in file 'mobilepushevent.properties':<br />
* com.openxchange.mobilepush.events.gcm.enabled<br>General switch to enable/disable communication with GCM service<br />
* com.openxchange.mobilepush.events.gcm.key<br>Specifies the GCM key in order to authenticate against the GCM service and to forward push messages to that service. Required if "com.openxchange.mobilenotifier.events.gcm.enabled" is "true" and you want to use a different key than provided by open-xchange-mobile-push-certificates. Otherwise the key from open-xchange-mobile-push-certificates is used.<br />
* com.openxchange.mobilepush.events.apn.ios.enabled<br>General switch to enable/disable communication with APN service<br />
* com.openxchange.mobilepush.events.apn.ios.keystore<br>Specifies the path to the local keystore file (PKCS #12) containing the APNS certificate and keys for the iOS application. Required if "com.openxchange.mobilepush.events.apn.ios.enabled" is "true" and you want to use a different certificate than provided by open-xchange-mobile-push-certificates. Otherwise the certificate from open-xchange-mobile-push-certificates is used.<br />
* com.openxchange.mobilepush.events.apn.ios.password<br>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.openxchange.mobilepush.events.apn.ios.enabled" is "true" and you want to use a different certificate than provided by open-xchange-mobile-push-certificates.<br />
<br />
= Setup of the Dovecot Push =<br />
<br />
Dovecot Push plug-in requires METADATA support on Dovecot side, but it should only be enabled for OX IMAP sessions and not for any other IMAP clients directly. Enabling can be done with e.g. the remote directive "remote 1.2.3.0/24 { imap_metadata = yes }" and specifying the IP ranges of OX. Metadata configuration is also described in the article http://wiki2.dovecot.org/ImapMetadata. Please note, the mail_attribute_dict setting also needs to be defined.<br />
<br />
The following picture should demonstrate how the overall communication flow between Mail App, Open-Xchange Middleware, and the Dovecot Push plug-in takes place. That communication flow requires the "open-xchange-push-dovecot" package to be installed on the Open-Xchange Middleware nodes and the Dovecot "http-notify" plug-in.<br />
<br />
[[Image:ox_mail_push_configuration_4.png|500px]]<br />
<br />
Once the Open-Xchange Mail App is installed on the user’s mobile device and it is allowed to show notifications about a new message delivery, the Mail App performs a subscription call to the Open-Xchange Middleware Servers using a fully authenticated session.<br />
<br />
When the "open-xchange-push-dovecot" package is installed, the previous subscribe call requests it to spawn a permanent listener. Such a listener simply tells the Dovecot server to notify about new message delivery events for the associated user by executing a special SETMETADATA command. Hence, it does not open or use any resources other than firing a single IMAP command to the Dovecot IMAP Server.<br />
<br />
Whenever a "new message delivery" event occurs, the Dovecot Server performs a HTTP callback against a configurable HTTP end-point of the Open-Xchange Middleware providing crucial information about the newly delivered message with a simple JSON body. That incoming HTTP callback is then turned into an appropriate OSGi event with topic "com/openexchange/push".<br />
<br />
That event is in turn handled by the Mobile Push event handler, which uses the event’s information to request an APN/GCM push to the mobile device.<br />
<br />
== Configuration of Dovecot "http-notify" plug-in ==<br />
<br />
To use push notifications, both the "notify" and the "push_notification" plugins need to be activated. For LMTP delivery, this is required:<br />
<br />
protocol lmtp {<br />
mail_plugins = $mail_plugins notify push_notification<br />
}<br />
<br />
If you also want push notifications to work for LDA-based delivery, you would need additional configuration:<br />
<br />
protocol lda {<br />
mail_plugins = $mail_plugins notify push_notification<br />
}<br />
<br />
The HTTP end-point (URL + authentication information) to use is configured in the Dovecot configuration file. The appropriate configuration options will contain the HTTP URL denoting the end-point to connect to as well as the authentication information for Basic Authentication as configured by properties "com.openexchange.rest.services.basic-auth.login" and "com.openexchange.rest.services.basic-auth.password".<br />
The URL to configure in Dovecot configuration follows this pattern.<br />
<http|https> + "://" + <login> + ":" + <password> + "@" + <host> + ":" + <port> + "/preliminary/http-notify/v1/notify"<br />
<br />
E.g.<br />
plugin {<br />
push_notification_driver = ox:url=http://login:pass@node1.domain.tld:8009/preliminary/http-notify/v1/notify<br />
}<br />
<br />
Furthermore, it is also possible to specify more than one HTTP end-point to connect to if a new message delivery occurs. Thus the configuration section mentioned above may be extended by additional "push_notification_driver" entries; e.g. push_notification_driver2, push_notification_driver3, etc.<br />
<br />
Please note that the path "/preliminary/http-notify/v1/notify" denotes the internal REST API of the Open-Xchange Middleware, which is not publicly accessible. The administrator can decide whether to add that path to the Apache configuration (see also [[AppSuite:Apache_Configuration]] and [[AppSuite:Grizzly]]) through a Location/ProxyPass directive:<br />
<br />
<Location /preliminary><br />
Order Deny,Allow<br />
Deny from all<br />
# Only allow access from servers within the network. Do not expose this<br />
# location outside of your network. In case you use a load balancing service in front<br />
# of your Apache infrastructure you should make sure that access to /preliminary will<br />
# be blocked from the internet / outside clients. Examples:<br />
# Allow from 192.168.0.1<br />
# Allow from 192.168.1.1 192.168.1.2<br />
# Allow from 192.168.0.<br />
ProxyPass /preliminary balancer://oxcluster/preliminary<br />
</Location><br />
<br />
In case the "user=" sent by OX in the push_notification_driver url data does not match the IMAP login of a user, Dovecot ignores it. This can be overridden by defining "user_from_metadata" in the push_notification_driver url, e.g. <br />
<br />
push_notification_driver = ox:url=http://example.com/ user_from_metadata<br />
<br />
= Integrated Branding/Customization Concept for Partners and Customers =<br />
<br />
With OX Mail it is also possible for customers and partners to add branding elements to the app. During the installation of the app a user is presented with a list of preconfigured providers. When a provider is selected the app is automatically setup and branded for that provider.<br />
<br />
For both design reasons, as well as app store restrictions, branding in this context means:<br />
* The app design is “Super Flat”. This means there are not many elements that can be, or need to be, styled in order to match a particular brand.<br />
* The app does not contain or use any logos of any sort. <br />
* At install time the app uses a startup wizard in combination with a hosted configuration service. The wizard gives the end user the option to select a provider from a list. When this is done the app will retrieve the branding information from the configuration service and changes its theme accordingly. <br />
<br />
== Branding / Customization Process ==<br />
<br />
In order to participate you will need to provide specific information such as:<br />
<br />
* Confirmation that you are running OX App Suite 7.6.2 including the latest patch.<br />
* A full URL where your OX App Suite service can be reached by a web client.<br />
* Two test accounts on your OX App Suite service, where we can verify that the OX App Suite system works as expected.<br />
* A “logo” and “name” of your service. This information will be used in the app itself.<br />
* Optional: A preferred color (CI color) that Open-Xchange will use for the app if a user chooses their service from the provider list.<br />
<br />
=== Steps ===<br />
<br />
# Please download the Questionnaire from [http://knowledgebase.open-xchange.com/fileadmin/user_upload/open-xchange/document/misc/Questionnaire_OX_Mail_Branding.pdf Open-Xchange Download Server]<br />
# Please fill out the Questionnaire and send it to your Open-Xchange account manager.<br />
# Open-Xchange will check the data. If all information are available, Open-Xchange will add your personal brand to the live OX Mail app. Please Note: The exact date when your brand becomes available depends on the approval process and could take 5 to 10 days. Open-Xchange won't communicate an exact date. Please check by your self.<br />
<br />
[[Category: OX7]]<br />
[[Category: AppSuite]]<br />
[[Category: OXMailapp]]</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:OX_Mail&diff=20789
AppSuite:OX Mail
2015-10-20T11:11:28Z
<p>Sonja.krause-harder: Fix #41701</p>
<hr />
<div>= OX Mail =<br />
<br />
OX Mail is a native mobile phone app built specifically for smartphone users who already have a valid OX App Suite account. The app is designed to let users access their OX App Suite email environment directly from a smartphone native client.<br />
<br />
OX Mail enables users to synchronize mails between a variety of smartphone devices and OX App Suite. OX Mail consists of two elements: The OX Mail component that is built into OX App Suite and the native OX Mail app.<br />
<br />
The OX Mail app has been designed specifically for ease-of-use and is available for both iOS and Android.<br />
<br />
'''Please Note: The OX Mail app will be available in September. With this app Open-Xchange has also created a new branding concept for the customers and partners. More information can be found in the chapter [http://oxpedia.org/wiki/index.php?title=AppSuite:OX_Mail#Integrated_Branding.2FCustomization_Concept_for_Partners_and_Customers Branding/Customization Concept for Partners and Customers]'''<br />
<br />
== Requirements ==<br />
<br />
=== Server-side Installation and Configuration ===<br />
<br />
With OX Mail, OX App Suite supports server based PUSH functionality.<br />
<br />
Dovecot customers can use the special PUSH plugin without any additional costs. The plugin will be provided via the Dovecot software repository for Dovecot Pro and community edition. '''Please Note, the installation of the latest Dovecot v2.2.19 release is required'''<br />
<br />
'''Please Note: The Open-Xchange package 'open-xchange-push-imapidle' which provides mail push functionality by using the IMAP IDLE command to generate push events when new mail arrives, is not officially supported with OX Mail (app).'''<br />
<br />
If you are not using the Dovecot Push Plugin your mail backend has to actively notify the Open-Xchange middleware servers of new emails. This might require the creation of an additional OX middleware plugin to receive those notifications. For further details please contact your assigned pre-sales / prof. services contact.<br />
<br />
'''Please Note, the installation of the latest OX App Suite version is required.'''<br />
<br />
You will finde the client requirements under [[AppSuite:OX_System_Requirements#OX_Mail_for_Clients|OX Mail requirements]]<br />
<br />
== Key Benefits ==<br />
<br />
* Supports email PUSH notification for personal Inbox – emails show up immediately on the device<br />
* Quick and easy to set up with the start-up wizard<br />
* Intuitive, simple to use, design <br />
* Familiar smartphone experience<br />
* Available for both iOS and Android – download app from App Store for free<br />
<br />
A more detailed overview of OX Mail, can be found at: http://software.open-xchange.com/products/mail/doc/OX_Mail_Product_Guide.pdf<br />
<br />
== Pricing & Availability ==<br />
<br />
OX Mail will be available in September 2015.<br />
<br />
This email app is available for both iOS and Android and can be downloaded for free from the corresponding App Stores. Availability will be confirmed by Open-Xchange via the usual communication channels. <br />
<br />
'''Please note:''' The exact date when the clients become available depends on the approval process of the respective app stores. <br />
<br />
The Open-Xchange Middleware components can be downloaded from the respective download repositories as normal.<br />
<br />
Please contact your Open-Xchange account manager for further information and pricing details.<br />
<br />
= Enabling OX Mail for Users =<br />
<br />
OX Mail is enabled for all users that have the capability ''com.openexchange.capability.mobile_mail_app'' <br />
<br />
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]].<br />
<br />
IMPORTANT: <br />
By default, the capability for the OX Mail app is set to false for all users. It can be changed by editing the corresponding capability in the "permissions.properties" config file, or if you need a more fine grained selection of enabled users, you can use the well known provisioning tools / config cascade.<br />
<br />
= Installation of the Clients =<br />
<br />
The OX Mail will be available via the different App Stores for iOS and Android by September 2015<br />
<br />
= OX Mail Server-side Installation and Configuration =<br />
<br />
This chapter describes how the backend components of OX Mail are installed and configured on the server.<br />
<br />
== Available packages ==<br />
<br />
OX Mail is available with the following backend packages:<br />
<br />
* ''open-xchange-mobile-push-certificates'' - Certificates for cloud-based push notifications<br />
* ''open-xchange-mailapp-backend'' - The main server components for OX Mail<br />
* ''open-xchange-mobile-push-plugin'' - Provides Push functionality<br />
<br />
Installation on the server varies depending on the underlying distribution, details are available in the following chapters.<br />
<br />
=== Redhat Enterprise Linux 6 or CentOS 6 ===<br />
<br />
Add the following repositories to your Open-Xchange yum configuration:<br />
<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail|mailapp}}<br />
<br />
and run<br />
<br />
$ yum install open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin<br />
<br />
=== Debian GNU/Linux 6.0 (Squeeze) ===<br />
<br />
Add the following repositories to your Open-Xchange apt configuration:<br />
<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianSqueeze|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=debianname|pc2v=DebianSqueeze|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail|mailapp}}<br />
<br />
and run<br />
<br />
$ apt-get update<br />
$ apt-get install open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin<br />
<br />
=== Debian GNU/Linux 7.0 (Wheezy) ===<br />
<br />
Add the following repositories to your Open-Xchange apt configuration:<br />
<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianWheezy|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=debianname|pc2v=DebianWheezy|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail|mailapp}}<br />
<br />
and run<br />
<br />
$ apt-get update<br />
$ apt-get install open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin<br />
<br />
= Setup Description for Mobile Push =<br />
<br />
== Setup of the Open-Xchange Node==<br />
<br />
The existing push framework of the Open-Xchange Middleware has been extended by the capability to spawn "permanent" listeners for incoming new message deliveries. Up to that point the life cycle for a listener was bound to at least one active session, which is associated with a client that is allowed to receive push notifications.<br />
<br />
With introduction of the previously mentioned capability, listeners can be started without the need for an existent session right on the start of an Open-Xchange Middleware node. In addition those permanent listeners are spread approximately even over capable cluster members as - dependent on the underlying implementation - a listener representation may open/hold resources (socket connections) in order to receive notifications about new message deliveries.<br />
<br />
To prepare a certain Open-Xchange Middleware node to spawn permanent push listeners the following properties need to be configured in file '/opt/open-xchange/etc/mail-push.properties':<br />
<br />
* com.openexchange.push.allowPermanentPush<br>This is the general switch to enable/disable support for permanent listeners on a node. Thus needs to be set to "true"<br />
* com.openexchange.push.allowedClient<br>Specify the comma-separated list of clients which are allowed to receive notifications about new mails, “open-xchange-mailapp” should be added here if you plan to use it in combination with the new mobile-push feature.<br />
* com.openexchange.push.credstorage.enabled<br>As permanent listeners are required to run without an active session, the credential storage can be used to store user credentials in installations that do not support a master authentication to the mail storage Hence, if the property "com.openexchange.mail.passwordSource" (mail.properties) is not set to "global" this property is required to be set to "true"<br />
* com.openexchange.push.credstorage.passcrypt<br>This property is required if "com.openexchange.push.credstorage.enabled" is set to "true". It does specify the passphrase to use to symmetrically encrypt the stored credentials. The passphrase is required to be equal on each cluster member.<br />
* com.openexchange.push.credstorage.rdb<br>Once the credential storage is enabled, Open-Xchange offers two ways of storing the user-associated login/password combination. In cluster memory (default) or persisted to database. While the first way ensures that no user credentials are persisted nowhere in the Open-Xchange installation, it has the big disadvantage the stored credentials are gone once the last cluster members gets shut-down. Therefore there is also the possibility to store the credentials inside the database. Of course, no matter where the credentials are stored, they are encrypted using the value from com.openexchange.push.credstorage.passcrypt" property<br />
<br />
With setting the properties above the configuration on the Open-Xchange Middleware node is prepared to spawn permanent listeners.<br />
<br />
Now an appropriate push bundle/package needs to be installed that supports spawning permanent listeners. Currently Open-Xchange ships with three implementations:<br />
* open-xchange-push-dovecot<br />
* open-xchange-push-imapidle (Not recommended, therefore disabled for IMAP-IDLE by default. com.openexchange.push.imapidle.supportsPermanentListeners=false)<br />
* open-xchange-push-mailnotify<br />
<br />
Putting all together the following execution flow is taken to decide whether permanent listeners are spawned or not:<br />
<br />
[[Image:ox_mail_push_configuration_2.png|500px]]<br />
<br />
To check at any time what listeners are currently running, there is a new command-line tool "/opt/open-xchange/sbin/listpushusers" that outputs the user-id/context-id pair along-side with the information if the listener is of permanent nature or bound to an active session:<br />
<br />
[[Image:ox_mail_push_configuration_3.png|500px]]<br />
<br />
An exemplary out put might look like:<br />
~# /opt/open-xchange/sbin/listpushusers<br />
user=249, context=1, permanent=true<br />
user=402, context=1, permanent=true<br />
<br />
== Setup of the Mobile Push ==<br />
An appropriate registration for a capable client is required to create a permanent listener for a certain user. As of now, only the Open-Xchange Mail App performs such a registration request to mark the user to have a permanent listener using the newly introduced Mobile Push interfaces of the Open-Xchange Middleware.<br />
The Mobile Push feature is installed by the following packages:<br />
* open-xchange-mobile-push<br />
* open-xchange-mobile-push-restricted (Only certificates and licenses)<br />
<br />
Simply said the main purpose of the Mobile Push functionality is to register an OSGi event handler converting an incoming OSGi event with topic "com/openexchange/push" to an appropriate native push reaching the mobile device using either<br />
* APN or<br />
* GCM<br />
<br />
=== Client subscription ===<br />
To be able to do so, the client has to perform a subscribe request against the Mobile Push interface. Such a subscribe call mainly performs two things<br />
<br />
1. Storing the data into the database that is needed to initiate a APN/GCM push request<br><br />
2. Registering & starting a permanent listener in the push framework<br><br />
<br />
=== Handling of OSGi events ===<br />
<br />
Moreover, the OSGi events with topic "com/openexchange/push" are spread remotely throughout the Open-Xchange cluster. To avoid that each node yields a native push event for the mobile device, the OSGi event handler of the Mobile Push does only consider local events. This fact implies that each node that broadcasts OSGi events with topic "com/openexchange/push" is required to have the open-xchange-mobile-push packages installed; otherwise the OSGi event is not handled.<br />
<br />
=== Mobile Push configuration ===<br />
The setup of the Mobile Push functionality includes proper configuration of the communication with the APN/GCM services, which is performed in file 'mobilepushevent.properties':<br />
* com.openxchange.mobilepush.events.gcm.enabled<br>General switch to enable/disable communication with GCM service<br />
* com.openxchange.mobilepush.events.gcm.key<br>Specifies the GCM key in order to authenticate against the GCM service and to forward push messages to that service. Required if "com.openxchange.mobilenotifier.events.gcm.enabled" is "true" and you want to use a different key than provided by open-xchange-mobile-push-restricted. Otherwise the key from open-xchange-mobile-push-restricted is used.<br />
* com.openxchange.mobilepush.events.apn.ios.enabled<br>General switch to enable/disable communication with APN service<br />
* com.openxchange.mobilepush.events.apn.ios.keystore<br>Specifies the path to the local keystore file (PKCS #12) containing the APNS certificate and keys for the iOS application. Required if "com.openxchange.mobilepush.events.apn.ios.enabled" is "true" and you want to use a different certificate than provided by open-xchange-mobile-push-restricted. Otherwise the certificate from open-xchange-mobile-push-restricted is used.<br />
* com.openxchange.mobilepush.events.apn.ios.password<br>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.openxchange.mobilepush.events.apn.ios.enabled" is "true" and you want to use a different certificate than provided by open-xchange-mobile-push-restricted.<br />
<br />
= Setup of the Dovecot Push =<br />
<br />
Dovecot Push plug-in requires METADATA support on Dovecot side, but it should only be enabled for OX IMAP sessions and not for any other IMAP clients directly. Enabling can be done with e.g. the remote directive "remote 1.2.3.0/24 { imap_metadata = yes }" and specifying the IP ranges of OX. Metadata configuration is also described in the article http://wiki2.dovecot.org/ImapMetadata. Please note, the mail_attribute_dict setting also needs to be defined.<br />
<br />
The following picture should demonstrate how the overall communication flow between Mail App, Open-Xchange Middleware, and the Dovecot Push plug-in takes place. That communication flow requires the "open-xchange-push-dovecot" package to be installed on the Open-Xchange Middleware nodes and the Dovecot "http-notify" plug-in.<br />
<br />
[[Image:ox_mail_push_configuration_4.png|500px]]<br />
<br />
Once the Open-Xchange Mail App is installed on the user’s mobile device and it is allowed to show notifications about a new message delivery, the Mail App performs a subscription call to the Open-Xchange Middleware Servers using a fully authenticated session.<br />
<br />
When the "open-xchange-push-dovecot" package is installed, the previous subscribe call requests it to spawn a permanent listener. Such a listener simply tells the Dovecot server to notify about new message delivery events for the associated user by executing a special SETMETADATA command. Hence, it does not open or use any resources other than firing a single IMAP command to the Dovecot IMAP Server.<br />
<br />
Whenever a "new message delivery" event occurs, the Dovecot Server performs a HTTP callback against a configurable HTTP end-point of the Open-Xchange Middleware providing crucial information about the newly delivered message with a simple JSON body. That incoming HTTP callback is then turned into an appropriate OSGi event with topic "com/openexchange/push".<br />
<br />
That event is in turn handled by the Mobile Push event handler, which uses the event’s information to request an APN/GCM push to the mobile device.<br />
<br />
== Configuration of Dovecot "http-notify" plug-in ==<br />
<br />
To use push notifications, both the "notify" and the "push_notification" plugins need to be activated. For LMTP delivery, this is required:<br />
<br />
protocol lmtp {<br />
mail_plugins = $mail_plugins notify push_notification<br />
}<br />
<br />
If you also want push notifications to work for LDA-based delivery, you would need additional configuration:<br />
<br />
protocol lda {<br />
mail_plugins = $mail_plugins notify push_notification<br />
}<br />
<br />
The HTTP end-point (URL + authentication information) to use is configured in the Dovecot configuration file. The appropriate configuration options will contain the HTTP URL denoting the end-point to connect to as well as the authentication information for Basic Authentication as configured by properties "com.openexchange.rest.services.basic-auth.login" and "com.openexchange.rest.services.basic-auth.password".<br />
The URL to configure in Dovecot configuration follows this pattern.<br />
<http|https> + "://" + <login> + ":" + <password> + "@" + <host> + ":" + <port> + "/preliminary/http-notify/v1/notify"<br />
<br />
E.g.<br />
plugin {<br />
push_notification_driver = ox:url=http://login:pass@node1.domain.tld:8009/preliminary/http-notify/v1/notify<br />
}<br />
<br />
Furthermore, it is also possible to specify more than one HTTP end-point to connect to if a new message delivery occurs. Thus the configuration section mentioned above may be extended by additional "push_notification_driver" entries; e.g. push_notification_driver2, push_notification_driver3, etc.<br />
<br />
Please note that the path "/preliminary/http-notify/v1/notify" denotes the internal REST API of the Open-Xchange Middleware, which is not publicly accessible. The administrator can decide whether to add that path to the Apache configuration (see also [[AppSuite:Apache_Configuration]] and [[AppSuite:Grizzly]]) through a Location/ProxyPass directive:<br />
<br />
<Location /preliminary><br />
Order Deny,Allow<br />
Deny from all<br />
# Only allow access from servers within the network. Do not expose this<br />
# location outside of your network. In case you use a load balancing service in front<br />
# of your Apache infrastructure you should make sure that access to /preliminary will<br />
# be blocked from the internet / outside clients. Examples:<br />
# Allow from 192.168.0.1<br />
# Allow from 192.168.1.1 192.168.1.2<br />
# Allow from 192.168.0.<br />
ProxyPass /preliminary balancer://oxcluster/preliminary<br />
</Location><br />
<br />
In case the "user=" sent by OX in the push_notification_driver url data does not match the IMAP login of a user, Dovecot ignores it. This can be overridden by defining "user_from_metadata" in the push_notification_driver url, e.g. <br />
<br />
push_notification_driver = ox:url=http://example.com/ user_from_metadata<br />
<br />
= Integrated Branding/Customization Concept for Partners and Customers =<br />
<br />
With OX Mail it is also possible for customers and partners to add branding elements to the app. During the installation of the app a user is presented with a list of preconfigured providers. When a provider is selected the app is automatically setup and branded for that provider.<br />
<br />
For both design reasons, as well as app store restrictions, branding in this context means:<br />
* The app design is “Super Flat”. This means there are not many elements that can be, or need to be, styled in order to match a particular brand.<br />
* The app does not contain or use any logos of any sort. <br />
* At install time the app uses a startup wizard in combination with a hosted configuration service. The wizard gives the end user the option to select a provider from a list. When this is done the app will retrieve the branding information from the configuration service and changes its theme accordingly. <br />
<br />
== Branding / Customization Process ==<br />
<br />
In order to participate you will need to provide specific information such as:<br />
<br />
* Confirmation that you are running OX App Suite 7.6.2 including the latest patch.<br />
* A full URL where your OX App Suite service can be reached by a web client.<br />
* Two test accounts on your OX App Suite service, where we can verify that the OX App Suite system works as expected.<br />
* A “logo” and “name” of your service. This information will be used in the app itself.<br />
* Optional: A preferred color (CI color) that Open-Xchange will use for the app if a user chooses their service from the provider list.<br />
<br />
=== Steps ===<br />
<br />
# Please download the Questionnaire from [http://knowledgebase.open-xchange.com/fileadmin/user_upload/open-xchange/document/misc/Questionnaire_OX_Mail_Branding.pdf Open-Xchange Download Server]<br />
# Please fill out the Questionnaire and send it to your Open-Xchange account manager.<br />
# Open-Xchange will check the data. If all information are available, Open-Xchange will add your personal brand to the live OX Mail app. Please Note: The exact date when your brand becomes available depends on the approval process and could take 5 to 10 days. Open-Xchange won't communicate an exact date. Please check by your self.<br />
<br />
[[Category: OX7]]<br />
[[Category: AppSuite]]<br />
[[Category: OXMailapp]]</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=OX6:Installing_OX_Language_Packages&diff=20783
OX6:Installing OX Language Packages
2015-10-15T10:49:14Z
<p>Sonja.krause-harder: Reverted edits by Cutmasta (talk) to last revision by Choeger</p>
<hr />
<div>== Installing Open-Xchange Server Language Packages ==<br />
<br />
=== Where to get the language packages? ===<br />
<br />
The packages are contained in the standard Open-Xchange installation repositories.<br />
<br />
For a complete list of currently available languages, have a look at [[Available_Translations]].<br />
<br />
=== How to install? ===<br />
<br />
Use the package manager from your preferred distribution to search for packages with names<br />
<br />
on 6.20.x:<br />
<br />
open-xchange-lang*<br />
open-xchange-gui-lang*<br />
<br />
on 6.22.x:<br />
<br />
open-xchange-l10n*<br />
open-xchange-gui-l10n*<br />
<br />
<br />
==== OX AE ====<br />
<br />
Log into UDM and search for language packages using pattern <tt>open-xchange*lang*</tt><br />
<br />
<br />
[[File:udmoxlang.jpg|center|600px|]]<br />
<br />
[[Category: OX6]]<br />
<br />
'''Important:''' Currently the additionally installed languages are only available within Open-Xchange Groupware and cannot be set within Univention Directory Manager.</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:OX_Mail&diff=20315
AppSuite:OX Mail
2015-09-02T10:36:16Z
<p>Sonja.krause-harder: /* Available packages */</p>
<hr />
<div>= OX Mail (In Progress)=<br />
<br />
OX Mail is a native mobile phone app built specifically for smartphone users who already have a valid OX App Suite account. The app is designed to let users access their OX App Suite email environment directly from a smartphone native client.<br />
<br />
OX Mail enables users to synchronize mails between a variety of smartphone devices and OX App Suite. OX Mail consists of two elements: The OX Mail component that is built into OX App Suite and the native OX Mail app.<br />
<br />
The OX Mail app has been designed specifically for ease-of-use and is available for both iOS and Android.<br />
<br />
'''Please Note: The OX Mail app will be available in September. With this app Open-Xchange has also created a new branding concept for the customers and partners. More information can be found in the chapter [http://oxpedia.org/wiki/index.php?title=AppSuite:OX_Mail#Integrated_Branding.2FCustomization_Concept_for_Partners_and_Customers Branding/Customization Concept for Partners and Customers]'''<br />
<br />
== Requirements ==<br />
<br />
=== Server-side Installation and Configuration ===<br />
<br />
With OX Mail, OX App Suite supports server based PUSH functionality. One of the main requirements for push functionality is the use of the Dovecot mail backend. In addition the following conditions should be met: <br />
<br />
* Dovecot Customers with less than 100,000 users: Customers can use the special PUSH plugin without any additional costs. The plugin will be provided via the Open-Xchange software repository for customers with a valid Open-Xchange App Suite license.<br />
* Dovecot Pro Customers with more than a 100,000 users: PUSH plugin use is covered under this license without incurring additional costs.<br />
* If you are not using the Dovecot Push Plugin your mail backend has to actively notify the Open-Xchange middleware servers of new emails. This might require the creation of an additional OX middleware plugin to receive those notifications.<br />
* '''Installed latest OX App Suite Public Patch v7.6.2-rev31 (week 36 2015)'''<br />
<br />
For further details please contact your assigned pre-sales / prof. services contact.<br />
<br />
You will finde the client requirements under [[AppSuite:OX_System_Requirements#OX_Mail_for_Clients|OX Mail requirements]]<br />
<br />
== Key Benefits ==<br />
<br />
* Supports email PUSH notification – emails show up immediately on the device<br />
* Quick and easy to set up with the start-up wizard<br />
* Intuitive, simple to use, design <br />
* Familiar smartphone experience<br />
* Available for both iOS and Android – download app from App Store for free<br />
* Low support requirements<br />
<br />
A more detailed overview of OX Mail, can be found at: http://software.open-xchange.com/products/mail/doc/OX_Mail_Product_Guide.pdf<br />
<br />
== Pricing & Availability ==<br />
<br />
OX Mail will be available in September 2015.<br />
<br />
This email app is available for both iOS and Android and can be downloaded for free from the corresponding App Stores. Availability will be confirmed by Open-Xchange via the usual communication channels. <br />
<br />
'''Please note:''' The exact date when the clients become available depends on the approval process of the respective app stores. <br />
<br />
The Open-Xchange Middleware components can be downloaded from the respective download repositories as normal.<br />
<br />
Please contact your Open-Xchange account manager for further information and pricing details.<br />
<br />
= Enabling OX Mail for Users =<br />
<br />
OX Mail is enabled for all users that have the capability ''com.openexchange.capability.mobile_mail_app'' <br />
<br />
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]].<br />
<br />
IMPORTANT: <br />
By default, the capability for the OX Mail app is set to false for all users. It can be changed by editing the corresponding capability in the "permissions.properties" config file, or if you need a more fine grained selection of enabled users, you can use the well known provisioning tools / config cascade.<br />
<br />
= Installation of the Clients =<br />
<br />
The OX Mail will be available via the different App Stores for iOS and Android by September 2015<br />
<br />
= OX Mail Server-side Installation and Configuration =<br />
<br />
This chapter describes how the backend components of OX Mail are installed and configured on the server.<br />
<br />
== Available packages ==<br />
<br />
OX Mail is available with the following backend packages:<br />
<br />
* ''open-xchange-mobile-push-certificates'' - Certificates for cloud-based push notifications<br />
* ''open-xchange-mailapp-backend'' - The main server components for OX Mail<br />
* ''open-xchange-mobile-push-plugin'' - ???<br />
* ''open-xchange-push-dovecot'' - ???<br />
<br />
Installation on the server varies depending on the underlying distribution, details are available in the following chapters.<br />
<br />
=== Redhat Enterprise Linux 6 or CentOS 6 ===<br />
<br />
Add the following repositories to your Open-Xchange yum configuration:<br />
<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail|mailapp}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/dovecot/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|dovecot-push}}<br />
<br />
and run<br />
<br />
$ yum install open-xchange-push-dovecot open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin<br />
<br />
=== Debian GNU/Linux 6.0 (Squeeze) ===<br />
<br />
Add the following repositories to your Open-Xchange apt configuration:<br />
<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianSqueeze|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=debianname|pc2v=DebianSqueeze|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail|mailapp}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/dovecot/stable|pc2n=debianname|pc2v=DebianSqueeze|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|dovecot-push}}<br />
<br />
and run<br />
<br />
$ apt-get update<br />
$ apt-get install open-xchange-push-dovecot open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin<br />
<br />
<br />
=== Debian GNU/Linux 7.0 (Wheezy) ===<br />
<br />
Add the following repositories to your Open-Xchange apt configuration:<br />
<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianWheezy|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=debianname|pc2v=DebianWheezy|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail|mailapp}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/dovecot/stable|pc2n=debianname|pc2v=DebianWheezy|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|dovecot-push}}<br />
<br />
and run<br />
<br />
$ apt-get update<br />
$ apt-get install open-xchange-push-dovecot open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin<br />
<br />
=== SUSE Linux Enterprise Server 11 ===<br />
<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLES11|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=susename|pc2v=SLES11|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail|mailapp}}<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/dovecot/stable|pc2n=susename|pc2v=SLES11|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|dovecot-push}}<br />
<br />
and run<br />
<br />
$ zypper ref<br />
$ zypper install open-xchange-push-dovecot open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin<br />
<br />
= Setup Description for Mobile Push =<br />
<br />
== Setup of the Open-Xchange Node==<br />
<br />
The existing push framework of the Open-Xchange Middleware has been extended by the capability to spawn "permanent" listeners for incoming new message deliveries. Up to that point the life cycle for a listener was bound to at least one active session, which is associated with a client that is allowed to receive push notifications.<br />
<br />
With introduction of the previously mentioned capability, listeners can be started without the need for an existent session right on the start of an Open-Xchange Middleware node. In addition those permanent listeners are spread approximately even over capable cluster members as - dependent on the underlying implementation - a listener representation may open/hold resources (socket connections) in order to receive notifications about new message deliveries.<br />
<br />
To prepare a certain Open-Xchange Middleware node to spawn permanent push listeners the following properties need to be configured in file '/opt/open-xchange/etc/mail-push.properties':<br />
<br />
* com.openexchange.push.allowPermanentPush<br>This is the general switch to enable/disable support for permanent listeners on a node. Thus needs to be set to "true"<br />
* com.openexchange.push.allowedClient<br>Specify the comma-separated list of clients which are allowed to receive notifications about new mails, “open-xchange-mailapp” should be added here if you plan to use it in combination with the new mobile-push feature.<br />
* com.openexchange.push.credstorage.enabled<br>As permanent listeners are required to run without an active session, the credential storage can be used to store user credentials in installations that do not support a master authentication to the mail storage Hence, if the property "com.openexchange.mail.passwordSource" (mail.properties) is not set to "global" this property is required to be set to "true"<br />
* com.openexchange.push.credstorage.passcrypt<br>This property is required if "com.openexchange.push.credstorage.enabled" is set to "true". It does specify the passphrase to use to symmetrically encrypt the stored credentials. The passphrase is required to be equal on each cluster member.<br />
* com.openexchange.push.credstorage.rdb<br>Once the credential storage is enabled, Open-Xchange offers two ways of storing the user-associated login/password combination. In cluster memory (default) or persisted to database. While the first way ensures that no user credentials are persisted nowhere in the Open-Xchange installation, it has the big disadvantage the stored credentials are gone once the last cluster members gets shut-down. Therefore there is also the possibility to store the credentials inside the database. Of course, no matter where the credentials are stored, they are encrypted using the value from com.openexchange.push.credstorage.passcrypt" property<br />
<br />
With setting the properties above the configuration on the Open-Xchange Middleware node is prepared to spawn permanent listeners.<br />
<br />
Now an appropriate push bundle/package needs to be installed that supports spawning permanent listeners. Currently Open-Xchange ships with three implementations:<br />
* open-xchange-push-dovecot<br />
* open-xchange-push-imapidle (Not recommended, therefore disabled for IMAP-IDLE by default. com.openexchange.push.imapidle.supportsPermanentListeners=false)<br />
* open-xchange-push-mailnotify<br />
<br />
Putting all together the following execution flow is taken to decide whether permanent listeners are spawned or not:<br />
<br />
[[Image:ox_mail_push_configuration_2.png|500px]]<br />
<br />
To check at any time what listeners are currently running, there is a new command-line tool "/opt/open-xchange/sbin/listpushusers" that outputs the user-id/context-id pair along-side with the information if the listener is of permanent nature or bound to an active session:<br />
<br />
[[Image:ox_mail_push_configuration_3.png|500px]]<br />
<br />
An exemplary out put might look like:<br />
~# /opt/open-xchange/sbin/listpushusers<br />
user=249, context=1, permanent=true<br />
user=402, context=1, permanent=true<br />
<br />
== Setup of the Mobile Push ==<br />
An appropriate registration for a capable client is required to create a permanent listener for a certain user. As of now, only the Open-Xchange Mail App performs such a registration request to mark the user to have a permanent listener using the newly introduced Mobile Push interfaces of the Open-Xchange Middleware.<br />
The Mobile Push feature is installed by the following packages:<br />
* open-xchange-mobile-push<br />
* open-xchange-mobile-push-restricted (Only certificates and licenses)<br />
<br />
Simply said the main purpose of the Mobile Push functionality is to register an OSGi event handler converting an incoming OSGi event with topic "com/openexchange/push" to an appropriate native push reaching the mobile device using either<br />
* APN or<br />
* GCM<br />
<br />
=== Client subscription ===<br />
To be able to do so, the client has to perform a subscribe request against the Mobile Push interface. Such a subscribe call mainly performs two things<br />
<br />
1. Storing the data into the database that is needed to initiate a APN/GCM push request<br><br />
2. Registering & starting a permanent listener in the push framework<br><br />
<br />
=== Handling of OSGi events ===<br />
<br />
Moreover, the OSGi events with topic "com/openexchange/push" are spread remotely throughout the Open-Xchange cluster. To avoid that each node yields a native push event for the mobile device, the OSGi event handler of the Mobile Push does only consider local events. This fact implies that each node that broadcasts OSGi events with topic "com/openexchange/push" is required to have the open-xchange-mobile-push packages installed; otherwise the OSGi event is not handled.<br />
<br />
=== Mobile Push configuration ===<br />
The setup of the Mobile Push functionality includes proper configuration of the communication with the APN/GCM services, which is performed in file 'mobilepushevent.properties':<br />
* com.openxchange.mobilepush.events.gcm.enabled<br>General switch to enable/disable communication with GCM service<br />
* com.openxchange.mobilepush.events.gcm.key<br>Specifies the GCM key in order to authenticate against the GCM service and to forward push messages to that service. Required if "com.openxchange.mobilenotifier.events.gcm.enabled" is "true" and you want to use a different key than provided by open-xchange-mobile-push-restricted. Otherwise the key from open-xchange-mobile-push-restricted is used.<br />
* com.openxchange.mobilepush.events.apn.ios.enabled<br>General switch to enable/disable communication with APN service<br />
* com.openxchange.mobilepush.events.apn.ios.keystore<br>Specifies the path to the local keystore file (PKCS #12) containing the APNS certificate and keys for the iOS application. Required if "com.openxchange.mobilepush.events.apn.ios.enabled" is "true" and you want to use a different certificate than provided by open-xchange-mobile-push-restricted. Otherwise the certificate from open-xchange-mobile-push-restricted is used.<br />
* com.openxchange.mobilepush.events.apn.ios.password<br>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.openxchange.mobilepush.events.apn.ios.enabled" is "true" and you want to use a different certificate than provided by open-xchange-mobile-push-restricted.<br />
<br />
= Setup of the Dovecot Push =<br />
<br />
Dovecot Push plug-in requires METADATA support on Dovecot side. Please read this article for enabling METADATA support in the Dovecot configuration: http://wiki2.dovecot.org/ImapMetadata<br />
<br />
The following picture should demonstrate how the overall communication flow between Mail App, Open-Xchange Middleware, and the Dovecot Push plug-in takes place. That communication flow requires the "open-xchange-push-dovecot" package to be installed on the Open-Xchange Middleware nodes and the Dovecot "http-notify" plug-in.<br />
<br />
[[Image:ox_mail_push_configuration_4.png|500px]]<br />
<br />
Once the Open-Xchange Mail App is installed on the user’s mobile device and it is allowed to show notifications about a new message delivery, the Mail App performs a subscription call to the Open-Xchange Middleware Servers using a fully authenticated session.<br />
<br />
When the "open-xchange-push-dovecot" package is installed, the previous subscribe call requests it to spawn a permanent listener. Such a listener simply tells the Dovecot server to notify about new message delivery events for the associated user by executing a special SETMETADATA command. Hence, it does not open or use any resources other than firing a single IMAP command to the Dovecot IMAP Server.<br />
<br />
Whenever a "new message delivery" event occurs, the Dovecot Server performs a HTTP callback against a configurable HTTP end-point of the Open-Xchange Middleware providing crucial information about the newly delivered message with a simple JSON body. That incoming HTTP callback is then turned into an appropriate OSGi event with topic "com/openexchange/push".<br />
<br />
That event is in turn handled by the Mobile Push event handler, which uses the event’s information to request an APN/GCM push to the mobile device.<br />
<br />
== Configuration of Dovecot "http-notify" plug-in ==<br />
<br />
To use push notifications, both the "notify" and the "push_notification" plugins need to be activated. For LMTP delivery, this is required:<br />
<br />
protocol lmtp {<br />
mail_plugins = $mail_plugins notify push_notification<br />
}<br />
<br />
If you also want push notifications to work for LDA-based delivery, you would need additional configuration:<br />
<br />
protocol lda {<br />
mail_plugins = $mail_plugins notify push_notification<br />
}<br />
<br />
The HTTP end-point (URL + authentication information) to use is configured in the Dovecot configuration file. The appropriate configuration options will contain the HTTP URL denoting the end-point to connect to as well as the authentication information for Basic Authentication as configured by properties "com.openexchange.rest.services.basic-auth.login" and "com.openexchange.rest.services.basic-auth.password".<br />
The URL to configure in Dovecot configuration follows this pattern.<br />
<http|https> + "://" + <login> + ":" + <password> + "@" + <host> + ":" + <port> + "/preliminary/http-notify/v1/notify"<br />
<br />
E.g.<br />
plugin {<br />
push_notification_driver = ox:url=http://login:pass@node1.domain.tld:8009/preliminary/http-notify/v1/notify<br />
}<br />
<br />
Furthermore, it is also possible to specify more than one HTTP end-point to connect to if a new message delivery occurs. Thus the configuration section mentioned above may be extended by additional "push_notification_driver" entries; e.g. push_notification_driver2, push_notification_driver3, etc.<br />
<br />
Please note that the path "/preliminary/http-notify/v1/notify" denotes the internal REST API of the Open-Xchange Middleware, which is not publicly accessible. The administrator can decide whether to add that path to the Apache configuration (see also [[AppSuite:Apache_Configuration]] and [[AppSuite:Grizzly]]) through a Location/ProxyPass directive:<br />
<br />
<Location /preliminary><br />
Order Deny,Allow<br />
Deny from all<br />
# Only allow access from servers within the network. Do not expose this<br />
# location outside of your network. In case you use a load balancing service in front<br />
# of your Apache infrastructure you should make sure that access to /preliminary will<br />
# be blocked from the internet / outside clients. Examples:<br />
# Allow from 192.168.0.1<br />
# Allow from 192.168.1.1 192.168.1.2<br />
# Allow from 192.168.0.<br />
ProxyPass /preliminary balancer://oxcluster/preliminary<br />
</Location><br />
<br />
= Integrated Branding/Customization Concept for Partners and Customers =<br />
<br />
With OX Mail it is also possible for customers and partners to add branding elements to the app. During the installation of the app a user is presented with a list of preconfigured providers. When a provider is selected the app is automatically setup and branded for that provider.<br />
<br />
For both design reasons, as well as app store restrictions, branding in this context means:<br />
* The app design is “Super Flat”. This means there are not many elements that can be, or need to be, styled in order to match a particular brand.<br />
* The app does not contain or use any logos of any sort. <br />
* At install time the app uses a startup wizard in combination with a hosted configuration service. The wizard gives the end user the option to select a provider from a list. When this is done the app will retrieve the branding information from the configuration service and changes its theme accordingly. <br />
<br />
== Branding / Customization Process ==<br />
<br />
In order to participate you will need to provide specific information such as:<br />
<br />
* Confirmation that you are running OX App Suite 7.6.2 including the latest patch.<br />
* A full URL where your OX App Suite service can be reached by a web client.<br />
* Two test accounts on your OX App Suite service, where we can verify that the OX App Suite system works as expected.<br />
* A “logo” and “name” of your service. This information will be used in the app itself.<br />
* Optional: A preferred color (CI color) that Open-Xchange will use for the app if a user chooses their service from the provider list.<br />
<br />
=== Steps ===<br />
<br />
# Please download the Questionnaire from [http://knowledgebase.open-xchange.com/fileadmin/user_upload/open-xchange/document/misc/Questionnaire_OX_Mail_Branding.pdf Open-Xchange Download Server]<br />
# Please fill out the Questionnaire and send it to your Open-Xchange account manager.<br />
# Open-Xchange will check the data. If all information are available, Open-Xchange will add your personal brand to the live OX Mail app. Please Note: The exact date when your brand becomes available depends on the approval process and could take 5 to 10 days. Open-Xchange won't communicate an exact date. Please check by your self.</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:OX_Mail&diff=20309
AppSuite:OX Mail
2015-09-02T09:00:13Z
<p>Sonja.krause-harder: </p>
<hr />
<div>= OX Mail (In Progress)=<br />
<br />
OX Mail is a native mobile phone app built specifically for smartphone users who already have a valid OX App Suite account. The app is designed to let users access their OX App Suite email environment directly from a smartphone native client.<br />
<br />
OX Mail enables users to synchronize mails between a variety of smartphone devices and OX App Suite. OX Mail consists of two elements: The OX Mail component that is built into OX App Suite and the native OX Mail app.<br />
<br />
The OX Mail app has been designed specifically for ease-of-use and is available for both iOS and Android.<br />
<br />
'''Please Note: The OX Mail app will be available in September. With this app Open-Xchange has also created a new branding concept for the customers and partners. More information can be found in the chapter [http://oxpedia.org/wiki/index.php?title=AppSuite:OX_Mail#Integrated_Branding.2FCustomization_Concept_for_Partners_and_Customers Branding/Customization Concept for Partners and Customers]'''<br />
<br />
== Requirements ==<br />
<br />
=== Server-side Installation and Configuration ===<br />
<br />
With OX Mail, OX App Suite supports server based PUSH functionality. One of the main requirements for push functionality is the use of the Dovecot mail backend. In addition the following conditions should be met: <br />
<br />
* Dovecot Customers with less than 100,000 users: Customers can use the special PUSH plugin without any additional costs. The plugin will be provided via the Open-Xchange software repository for customers with a valid Open-Xchange App Suite license.<br />
* Dovecot Pro Customers with more than a 100,000 users: PUSH plugin use is covered under this license without incurring additional costs.<br />
* If you are not using the Dovecot Push Plugin your mail backend has to actively notify the Open-Xchange middleware servers of new emails. This might require the creation of an additional OX middleware plugin to receive those notifications. <br />
<br />
For further details please contact your assigned pre-sales / prof. services contact.<br />
<br />
You will finde the client requirements under [[AppSuite:OX_System_Requirements#OX_Mail_for_Clients|OX Mail requirements]]<br />
<br />
== Key Benefits ==<br />
<br />
* Supports email PUSH notification – emails show up immediately on the device<br />
* Quick and easy to set up with the start-up wizard<br />
* Intuitive, simple to use, design <br />
* Familiar smartphone experience<br />
* Available for both iOS and Android – download app from App Store for free<br />
* Low support requirements<br />
<br />
A more detailed overview of OX Mail, can be found at: http://software.open-xchange.com/products/mail/doc/OX_Mail_Product_Guide.pdf<br />
<br />
== Pricing & Availability ==<br />
<br />
OX Mail will be available in September 2015.<br />
<br />
This email app is available for both iOS and Android and can be downloaded for free from the corresponding App Stores. Availability will be confirmed by Open-Xchange via the usual communication channels. <br />
<br />
'''Please note:''' The exact date when the clients become available depends on the approval process of the respective app stores. <br />
<br />
The Open-Xchange Middleware components can be downloaded from the respective download repositories as normal.<br />
<br />
Please contact your Open-Xchange account manager for further information and pricing details.<br />
<br />
= Enabling OX Mail for Users =<br />
<br />
OX Mail is enabled for all users that have the capability ''com.openexchange.capability.mobile_mail_app'' <br />
<br />
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]].<br />
<br />
IMPORTANT: <br />
By default, the capability for the OX Mail app is set to false for all users. It can be changed by editing the corresponding capability in the "permissions.properties" config file, or if you need a more fine grained selection of enabled users, you can use the well known provisioning tools / config cascade.<br />
<br />
= Installation of the Clients =<br />
<br />
The OX Mail will be available via the different App Stores for iOS and Android by September 2015<br />
<br />
= OX Mail Server-side Installation and Configuration =<br />
<br />
This chapter describes how the backend components of OX Mail are installed and configured on the server.<br />
<br />
== Available packages ==<br />
<br />
OX Mail is available with the following backend packages:<br />
<br />
* ''open-xchange-mail'' - The main server components for OX Mail<br />
* ''open-xchange-mobile-push-restricted'' - Restricted components, including prerequisites for cloud-based push notifications<br />
<br />
Installation on the server varies depending on the underlying distribution, details are available in the following chapters.<br />
<br />
=== Redhat Enterprise Linux 6 or CentOS 6 ===<br />
<br />
Add the following repositories to your Open-Xchange yum configuration:<br />
<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail|mailapp}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/dovecot/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|dovecot-push}}<br />
<br />
and run<br />
<br />
$ yum install open-xchange-push-dovecot open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin<br />
<br />
=== Debian GNU/Linux 6.0 (Squeeze) ===<br />
<br />
Add the following repositories to your Open-Xchange apt configuration:<br />
<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianSqueeze|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=debianname|pc2v=DebianSqueeze|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail|mailapp}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/dovecot/stable|pc2n=debianname|pc2v=DebianSqueeze|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|dovecot-push}}<br />
<br />
and run<br />
<br />
$ apt-get update<br />
$ apt-get install open-xchange-push-dovecot open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin<br />
<br />
<br />
=== Debian GNU/Linux 7.0 (Wheezy) ===<br />
<br />
Add the following repositories to your Open-Xchange apt configuration:<br />
<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianWheezy|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=debianname|pc2v=DebianWheezy|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail|mailapp}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/dovecot/stable|pc2n=debianname|pc2v=DebianWheezy|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|dovecot-push}}<br />
<br />
and run<br />
<br />
$ apt-get update<br />
$ apt-get install open-xchange-push-dovecot open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin<br />
<br />
=== SUSE Linux Enterprise Server 11 ===<br />
<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLES11|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=susename|pc2v=SLES11|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail|mailapp}}<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/dovecot/stable|pc2n=susename|pc2v=SLES11|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|dovecot-push}}<br />
<br />
and run<br />
<br />
$ zypper ref<br />
$ zypper install open-xchange-push-dovecot open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin<br />
<br />
<br />
= Setup Description for Mobile Push =<br />
<br />
== Setup of the Open-Xchange Node==<br />
<br />
The existing push framework of the Open-Xchange Middleware has been extended by the capability to spawn "permanent" listeners for incoming new message deliveries. Up to that point the life cycle for a listener was bound to at least one active session, which is associated with a client that is allowed to receive push notifications.<br />
<br />
With introduction of the previously mentioned capability, listeners can be started without the need for an existent session right on the start of an Open-Xchange Middleware node. In addition those permanent listeners are spread approximately even over capable cluster members as - dependent on the underlying implementation - a listener representation may open/hold resources (socket connections) in order to receive notifications about new message deliveries.<br />
<br />
To prepare a certain Open-Xchange Middleware node to spawn permanent push listeners the following properties need to be configured in file '/opt/open-xchange/etc/mail-push.properties':<br />
<br />
* com.openexchange.push.allowPermanentPush<br>This is the general switch to enable/disable support for permanent listeners on a node. Thus needs to be set to "true"<br />
* com.openexchange.push.allowedClient<br>Specify the comma-separated list of clients which are allowed to receive notifications about new mails, “open-xchange-mailapp” should be added here if you plan to use it in combination with the new mobile-push feature.<br />
* com.openexchange.push.credstorage.enabled<br>As permanent listeners are required to run without an active session, the credential storage can be used to store user credentials in installations that do not support a master authentication to the mail storage Hence, if the property "com.openexchange.mail.passwordSource" (mail.properties) is not set to "global" this property is required to be set to "true"<br />
* com.openexchange.push.credstorage.passcrypt<br>This property is required if "com.openexchange.push.credstorage.enabled" is set to "true". It does specify the passphrase to use to symmetrically encrypt the stored credentials. The passphrase is required to be equal on each cluster member.<br />
* com.openexchange.push.credstorage.rdb<br>Once the credential storage is enabled, Open-Xchange offers two ways of storing the user-associated login/password combination. In cluster memory (default) or persisted to database. While the first way ensures that no user credentials are persisted nowhere in the Open-Xchange installation, it has the big disadvantage the stored credentials are gone once the last cluster members gets shut-down. Therefore there is also the possibility to store the credentials inside the database. Of course, no matter where the credentials are stored, they are encrypted using the value from com.openexchange.push.credstorage.passcrypt" property<br />
<br />
With setting the properties above the configuration on the Open-Xchange Middleware node is prepared to spawn permanent listeners.<br />
<br />
Now an appropriate push bundle/package needs to be installed that supports spawning permanent listeners. Currently Open-Xchange ships with three implementations:<br />
* open-xchange-push-dovecot<br />
* open-xchange-push-imapidle (Not recommended, therefore disabled for IMAP-IDLE by default. com.openexchange.push.imapidle.supportsPermanentListeners=false)<br />
* open-xchange-push-mailnotify<br />
<br />
Putting all together the following execution flow is taken to decide whether permanent listeners are spawned or not:<br />
<br />
[[Image:ox_mail_push_configuration_2.png|500px]]<br />
<br />
To check at any time what listeners are currently running, there is a new command-line tool "/opt/open-xchange/sbin/listpushusers" that outputs the user-id/context-id pair along-side with the information if the listener is of permanent nature or bound to an active session:<br />
<br />
[[Image:ox_mail_push_configuration_3.png|500px]]<br />
<br />
An exemplary out put might look like:<br />
~# /opt/open-xchange/sbin/listpushusers<br />
user=249, context=1, permanent=true<br />
user=402, context=1, permanent=true<br />
<br />
== Setup of the Mobile Push ==<br />
An appropriate registration for a capable client is required to create a permanent listener for a certain user. As of now, only the Open-Xchange Mail App performs such a registration request to mark the user to have a permanent listener using the newly introduced Mobile Push interfaces of the Open-Xchange Middleware.<br />
The Mobile Push feature is installed by the following packages:<br />
* open-xchange-mobile-push<br />
* open-xchange-mobile-push-restricted (Only certificates and licenses)<br />
<br />
Simply said the main purpose of the Mobile Push functionality is to register an OSGi event handler converting an incoming OSGi event with topic "com/openexchange/push" to an appropriate native push reaching the mobile device using either<br />
* APN or<br />
* GCM<br />
<br />
=== Client subscription ===<br />
To be able to do so, the client has to perform a subscribe request against the Mobile Push interface. Such a subscribe call mainly performs two things<br />
<br />
1. Storing the data into the database that is needed to initiate a APN/GCM push request<br><br />
2. Registering & starting a permanent listener in the push framework<br><br />
<br />
=== Handling of OSGi events ===<br />
<br />
Moreover, the OSGi events with topic "com/openexchange/push" are spread remotely throughout the Open-Xchange cluster. To avoid that each node yields a native push event for the mobile device, the OSGi event handler of the Mobile Push does only consider local events. This fact implies that each node that broadcasts OSGi events with topic "com/openexchange/push" is required to have the open-xchange-mobile-push packages installed; otherwise the OSGi event is not handled.<br />
<br />
=== Mobile Push configuration ===<br />
The setup of the Mobile Push functionality includes proper configuration of the communication with the APN/GCM services, which is performed in file 'mobilepushevent.properties':<br />
* com.openxchange.mobilepush.events.gcm.enabled<br>General switch to enable/disable communication with GCM service<br />
* com.openxchange.mobilepush.events.gcm.key<br>Specifies the GCM key in order to authenticate against the GCM service and to forward push messages to that service. Required if "com.openxchange.mobilenotifier.events.gcm.enabled" is "true" and you want to use a different key than provided by open-xchange-mobile-push-restricted. Otherwise the key from open-xchange-mobile-push-restricted is used.<br />
* com.openxchange.mobilepush.events.apn.ios.enabled<br>General switch to enable/disable communication with APN service<br />
* com.openxchange.mobilepush.events.apn.ios.keystore<br>Specifies the path to the local keystore file (PKCS #12) containing the APNS certificate and keys for the iOS application. Required if "com.openxchange.mobilepush.events.apn.ios.enabled" is "true" and you want to use a different certificate than provided by open-xchange-mobile-push-restricted. Otherwise the certificate from open-xchange-mobile-push-restricted is used.<br />
* com.openxchange.mobilepush.events.apn.ios.password<br>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.openxchange.mobilepush.events.apn.ios.enabled" is "true" and you want to use a different certificate than provided by open-xchange-mobile-push-restricted.<br />
<br />
= Setup of the Dovecot Push =<br />
<br />
Dovecot Push plug-in requires METADATA support on Dovecot side. Please read this article for enabling METADATA support in the Dovecot configuration: http://wiki2.dovecot.org/ImapMetadata<br />
<br />
The following picture should demonstrate how the overall communication flow between Mail App, Open-Xchange Middleware, and the Dovecot Push plug-in takes place. That communication flow requires the "open-xchange-push-dovecot" package to be installed on the Open-Xchange Middleware nodes and the Dovecot "http-notify" plug-in.<br />
<br />
[[Image:ox_mail_push_configuration_4.png|500px]]<br />
<br />
Once the Open-Xchange Mail App is installed on the user’s mobile device and it is allowed to show notifications about a new message delivery, the Mail App performs a subscription call to the Open-Xchange Middleware Servers using a fully authenticated session.<br />
<br />
When the "open-xchange-push-dovecot" package is installed, the previous subscribe call requests it to spawn a permanent listener. Such a listener simply tells the Dovecot server to notify about new message delivery events for the associated user by executing a special SETMETADATA command. Hence, it does not open or use any resources other than firing a single IMAP command to the Dovecot IMAP Server.<br />
<br />
Whenever a "new message delivery" event occurs, the Dovecot Server performs a HTTP callback against a configurable HTTP end-point of the Open-Xchange Middleware providing crucial information about the newly delivered message with a simple JSON body. That incoming HTTP callback is then turned into an appropriate OSGi event with topic "com/openexchange/push".<br />
<br />
That event is in turn handled by the Mobile Push event handler, which uses the event’s information to request an APN/GCM push to the mobile device.<br />
<br />
== Configuration of Dovecot "http-notify" plug-in ==<br />
<br />
To use push notifications, both the "notify" and the "push_notification" plugins need to be activated. For LMTP delivery, this is required:<br />
<br />
protocol lmtp {<br />
mail_plugins = $mail_plugins notify push_notification<br />
}<br />
<br />
If you also want push notifications to work for LDA-based delivery, you would need additional configuration:<br />
<br />
protocol lda {<br />
mail_plugins = $mail_plugins notify push_notification<br />
}<br />
<br />
The HTTP end-point (URL + authentication information) to use is configured in the Dovecot configuration file. The appropriate configuration options will contain the HTTP URL denoting the end-point to connect to as well as the authentication information for Basic Authentication as configured by properties "com.openexchange.rest.services.basic-auth.login" and "com.openexchange.rest.services.basic-auth.password".<br />
The URL to configure in Dovecot configuration follows this pattern.<br />
<http|https> + "://" + <login> + ":" + <password> + "@" + <host> + ":" + <port> + "/preliminary/http-notify/v1/notify"<br />
<br />
E.g.<br />
plugin {<br />
push_notification_driver = ox:url=http://login:pass@node1.domain.tld:8009/preliminary/http-notify/v1/notify<br />
}<br />
<br />
Furthermore, it is also possible to specify more than one HTTP end-point to connect to if a new message delivery occurs. Thus the configuration section mentioned above may be extended by additional "push_notification_driver" entries; e.g. push_notification_driver2, push_notification_driver3, etc.<br />
<br />
Please note that the path "/preliminary/http-notify/v1/notify" denotes the internal REST API of the Open-Xchange Middleware, which is not publicly accessible. The administrator can decide whether to add that path to the Apache configuration (see also [[AppSuite:Apache_Configuration]] and [[AppSuite:Grizzly]]) through a Location/ProxyPass directive:<br />
<br />
<Location /preliminary><br />
Order Deny,Allow<br />
Deny from all<br />
# Only allow access from servers within the network. Do not expose this<br />
# location outside of your network. In case you use a load balancing service in front<br />
# of your Apache infrastructure you should make sure that access to /preliminary will<br />
# be blocked from the internet / outside clients. Examples:<br />
# Allow from 192.168.0.1<br />
# Allow from 192.168.1.1 192.168.1.2<br />
# Allow from 192.168.0.<br />
ProxyPass /preliminary balancer://oxcluster/preliminary<br />
</Location><br />
<br />
= Integrated Branding/Customization Concept for Partners and Customers =<br />
<br />
With OX Mail it is also possible for customers and partners to add branding elements to the app. During the installation of the app a user is presented with a list of preconfigured providers. When a provider is selected the app is automatically setup and branded for that provider.<br />
<br />
For both design reasons, as well as app store restrictions, branding in this context means:<br />
* The app design is “Super Flat”. This means there are not many elements that can be, or need to be, styled in order to match a particular brand.<br />
* The app does not contain or use any logos of any sort. <br />
* At install time the app uses a startup wizard in combination with a hosted configuration service. The wizard gives the end user the option to select a provider from a list. When this is done the app will retrieve the branding information from the configuration service and changes its theme accordingly. <br />
<br />
== Branding / Customization Process ==<br />
<br />
In order to participate you will need to provide specific information such as:<br />
<br />
* Confirmation that you are running OX App Suite 7.6.2 including the latest patch.<br />
* A full URL where your OX App Suite service can be reached by a web client.<br />
* Two test accounts on your OX App Suite service, where we can verify that the OX App Suite system works as expected.<br />
* A “logo” and “name” of your service. This information will be used in the app itself.<br />
* Optional: A preferred color (CI color) that Open-Xchange will use for the app if a user chooses their service from the provider list.<br />
<br />
=== Steps ===<br />
<br />
# Please download the Questionnaire from [http://knowledgebase.open-xchange.com/fileadmin/user_upload/open-xchange/document/misc/Questionnaire_OX_Mail_Branding.pdf Open-Xchange Download Server]<br />
# Please fill out the Questionnaire and send it to your Open-Xchange account manager.<br />
# Open-Xchange will check the data. If all information are available, Open-Xchange will add your personal brand to the live OX Mail app. Please Note: The exact date when your brand becomes available depends on the approval process and could take 5 to 10 days. Open-Xchange won't communicate an exact date. Please check by your self.</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=User:Sonja.krause-harder&diff=20308
User:Sonja.krause-harder
2015-09-02T08:57:51Z
<p>Sonja.krause-harder: </p>
<hr />
<div>=== Redhat Enterprise Linux 6 or CentOS 6 ===<br />
<br />
Add the following repositories to your Open-Xchange yum configuration:<br />
<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail|mailapp}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/dovecot/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|dovecot-push}}<br />
<br />
and run<br />
<br />
$ yum install open-xchange-push-dovecot open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin<br />
<br />
=== Debian GNU/Linux 6.0 (Squeeze) ===<br />
<br />
Add the following repositories to your Open-Xchange apt configuration:<br />
<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianSqueeze|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=debianname|pc2v=DebianSqueeze|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail|mailapp}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/dovecot/stable|pc2n=debianname|pc2v=DebianSqueeze|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|dovecot-push}}<br />
<br />
and run<br />
<br />
$ apt-get update<br />
$ apt-get install open-xchange-push-dovecot open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin<br />
<br />
<br />
=== Debian GNU/Linux 7.0 (Wheezy) ===<br />
<br />
Add the following repositories to your Open-Xchange apt configuration:<br />
<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianWheezy|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=debianname|pc2v=DebianWheezy|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail|mailapp}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/dovecot/stable|pc2n=debianname|pc2v=DebianWheezy|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|dovecot-push}}<br />
<br />
and run<br />
<br />
$ apt-get update<br />
$ apt-get install open-xchange-push-dovecot open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin<br />
<br />
=== SUSE Linux Enterprise Server 11 ===<br />
<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLES11|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=susename|pc2v=SLES11|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail|mailapp}}<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/dovecot/stable|pc2n=susename|pc2v=SLES11|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|dovecot-push}}<br />
<br />
and run<br />
<br />
$ zypper ref<br />
$ zypper install open-xchange-push-dovecot open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=User:Sonja.krause-harder&diff=20307
User:Sonja.krause-harder
2015-09-02T08:55:40Z
<p>Sonja.krause-harder: </p>
<hr />
<div>=== Redhat Enterprise Linux 6 or CentOS 6 ===<br />
<br />
Add the following repositories to your Open-Xchange yum configuration:<br />
<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail|mailapp}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/dovecot/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|dovecot-push}}<br />
<br />
$ yum install open-xchange-push-dovecot open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin<br />
<br />
=== Debian GNU/Linux 6.0 (Squeeze) ===<br />
<br />
Add the following repositories to your Open-Xchange apt configuration:<br />
<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianSqueeze|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=debianname|pc2v=DebianSqueeze|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail|mailapp}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/dovecot/stable|pc2n=debianname|pc2v=DebianSqueeze|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|dovecot-push}}<br />
<br />
$ apt-get update<br />
$ apt-get install open-xchange-push-dovecot open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin<br />
<br />
<br />
=== Debian GNU/Linux 7.0 (Wheezy) ===<br />
<br />
Add the following repositories to your Open-Xchange apt configuration:<br />
<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianWheezy|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=debianname|pc2v=DebianWheezy|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail|mailapp}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/dovecot/stable|pc2n=debianname|pc2v=DebianWheezy|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|dovecot-push}}<br />
<br />
$ apt-get update<br />
$ apt-get install open-xchange-push-dovecot open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin<br />
<br />
=== SUSE Linux Enterprise Server 11 ===<br />
<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLES11|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=susename|pc2v=SLES11|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail|mailapp}}<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/dovecot/stable|pc2n=susename|pc2v=SLES11|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|dovecot-push}}<br />
<br />
$ zypper ref<br />
$ zypper install open-xchange-push-dovecot open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=User:Sonja.krause-harder&diff=20306
User:Sonja.krause-harder
2015-09-02T08:50:20Z
<p>Sonja.krause-harder: /* Redhat Enterprise Linux 6 or CentOS 6 */</p>
<hr />
<div>=== Redhat Enterprise Linux 6 or CentOS 6 ===<br />
<br />
Add the following repositories to your Open-Xchange yum configuration:<br />
<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mailapp}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/dovecot/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|dovecot-push}}<br />
<br />
$ yum install open-xchange-push-dovecot open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=User:Sonja.krause-harder&diff=20305
User:Sonja.krause-harder
2015-09-02T08:35:40Z
<p>Sonja.krause-harder: </p>
<hr />
<div>=== Redhat Enterprise Linux 6 or CentOS 6 ===<br />
<br />
Add the following repositories to your Open-Xchange yum configuration:<br />
<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|documentconverter|readerengine}}<br />
<br />
$ yum install readerengine open-xchange-documentconverter open-xchange-documents-ui-viewer open-xchange-documents-ui-static</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=User:Sonja.krause-harder&diff=20304
User:Sonja.krause-harder
2015-09-02T08:33:37Z
<p>Sonja.krause-harder: </p>
<hr />
<div>=== Redhat Enterprise Linux 6 or CentOS 6 ===<br />
<br />
Add the following repositories to your Open-Xchange yum configuration:<br />
<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|documentconverter|readerengine}}<br />
<br />
$ yum install readerengine open-xchange-documentconverter open-xchange-documents-ui-viewer open-xchange-documents-ui-static</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=User:Sonja.krause-harder&diff=20303
User:Sonja.krause-harder
2015-09-02T08:32:37Z
<p>Sonja.krause-harder: </p>
<hr />
<div>=== Redhat Enterprise Linux 6 or CentOS 6 ===<br />
<br />
Add the following repositories to your Open-Xchange yum configuration:<br />
<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|documentconverter|readerengine}}<br />
<br />
$ yum install readerengine open-xchange-documentconverter open-xchange-documents-ui-viewer open-xchange-documents-ui-static</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=Jolokia_LoginCounter_HOWTO&diff=19360
Jolokia LoginCounter HOWTO
2015-04-20T10:40:20Z
<p>Sonja.krause-harder: /* Access specific information */</p>
<hr />
<div>= HOWTO - Access Login Counter data with Jolokia = <br />
<br />
This article describes how to access information exposed through JMX by Open-Xchange with the Jolokia JMX-to-HTTP bridge, using "Login Counter" as an example.<br />
<br />
== Install Open-Xchange ==<br />
<br />
See http://oxpedia.org/wiki/index.php?title=AppSuite:Main_Page_AppSuite#quickinstall if you don't have Open-Xchange installed yet. Jolokia is part of the base product, no extra packages are needed.<br />
<br />
== Enable Jolokia == <br />
<br />
(See also https://oxpedia.org/wiki/index.php?title=Jolokia)<br />
<br />
In <code>etc/jolokia.properties</code>, enable Jolokia by setting the following properties:<br />
<br />
com.openexchange.jolokia.start = true<br />
com.openexchange.jolokia.user = youruser<br />
com.openexchange.jolokia.password = yourpassword<br />
<br />
Jolokia will not be enabled when no user/password is set.<br />
<br />
You can optionally adjust this setting:<br />
<br />
com.openexchange.jolokia.servlet.name = /monitoring/jolokia<br />
<br />
If you do, you need to adjust the examples below as well.<br />
<br />
== Allow access from other hosts ==<br />
<br />
This is an optional step, if you want to access the Jolokia interface from other hosts than localhost. This may be very helpful during the development phase of a project. Please be aware that this interface exposes lots of "interesting" data, so if you remove the restriction to localhost, you need to ensure by other means (network setup, firewalls, web server configuration, ...) that no unauthorised access is possible on production systems.<br />
<br />
In <code>etc/jolokia.properties</code>, set:<br />
<br />
com.openexchange.jolokia.restrict.to.localhost = false<br />
<br />
In your web server configuration, enable access to the jolokia servlet. For Apache this is possible by adding a ProxyPass directive for each OX host in the cluster:<br />
<br />
ProxyPass /monitoring/ox1/jolokia http://ox1-ip:8009/monitoring/jolokia<br />
ProxyPass /monitoring/ox2/jolokia http://ox2-ip:8009/monitoring/jolokia<br />
...<br />
<br />
On a default installation as described by our installation guides, this would be in <code>proxy_http.conf</code>.<br />
<br />
Reload your apache config and restart open-xchange for the changes to take effect.<br />
<br />
== Access the Jolokia interface ==<br />
<br />
On localhost, call:<br />
<br />
$ curl http://yourname:yourpassword@localhost:8009/monitoring/jolokia/list > ox.json<br />
<br />
If you enabled access from other hosts, you can also use a standard web browser. Open e.g.<br />
<br />
http://<yourserver>/monitoring/ox1/jolokia/list<br />
<br />
You'll be asked for user name and password through a standard HTTP auth window.<br />
<br />
== Access specific information ==<br />
<br />
The ox.json file you received in the last step gives you complete documentation what data is available through this interface.<br />
<br />
As an example, the "Login Counter" interface (which is also used by the [http://oxpedia.org/wiki/index.php?title=AppSuite:Logincounter logincounter command line tool]) is described like this:<br />
<br />
<pre>"com.openexchange.reporting": {<br />
"name=Login Counter": {<br />
"desc": "Information on the management interface of the MBean",<br />
"op": {<br />
"getLastLoginTimeStamp": {<br />
"ret":"java.util.List",<br />
"desc":"Operation exposed for management",<br />
"args": [<br />
{"desc":"","name":"p1","type":"int"},<br />
{"desc":"","name":"p2","type":"int"},<br />
{"desc":"","name":"p3","type":"java.lang.String"}<br />
]<br />
},<br />
"getNumberOfLogins": {<br />
"ret":"java.util.Map",<br />
"desc":"Operation exposed for management",<br />
"args": [<br />
{"desc":"","name":"p1","type":"java.util.Date"},<br />
{"desc":"","name":"p2","type":"java.util.Date"},<br />
{"desc":"","name":"p3","type":"boolean"},<br />
{"desc":"","name":"p4","type":"java.lang.String"}<br />
]<br />
}<br />
}<br />
}<br />
}</pre><br />
<br />
<br />
See http://www.jolokia.org/reference/html/protocol.html for detailed documentation how to use the Jolokia interface, especially http://www.jolokia.org/reference/html/protocol.html#serialization for the list of datatypes that can be passed as arguments and received in return values.<br />
<br />
To know what the parameters <code>p1</code>, <code>p2</code>, etc. mean, you need to look at the source code. (See http://oxpedia.org/wiki/index.php?title=SourceCodeAccess for information how to download it.)<br />
<br />
In the example above, to get the number of logins in a specific timeframe and with a specific client, we need to call the method <code>getNumberOfLogins</code> with the parameters <code>startDate</code>, <code>endDate</code>, <code>aggregate</code> and <code>clientstring</code>. They correspond to the command line parameters to the <code>logincounter</code> command line tool as described on:<br />
<br />
http://oxpedia.org/wiki/index.php?title=AppSuite:Logincounter<br />
<br />
In curl this call would look like this:<br />
<br />
$ curl http://yourname:yourpassword@localhost:8009/monitoring/jolokia/exec/com.openexchange.reporting:name=Login%20Counter/getNumberOfLogins/2015-01-01T00:00:00/2015-01-31T23:59:59/true/open-xchange-appsuite/<br />
<br />
If you have enabled access to the Jolokia interface from other hosts, the same information can be viewed in any web browser:<br />
http://<yourserver>/monitoring/ox1/jolokia/exec/com.openexchange.reporting:name=Login%20Counter/getNumberOfLogins/2015-01-01T00:00:00/2015-01-31T23:59:59/true/open-xchange-appsuite/<br />
<br />
[[Category:AppSuite]]<br />
[[Category:Server]]<br />
[[Category:Administrator]]</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=Jolokia_LoginCounter_HOWTO&diff=19359
Jolokia LoginCounter HOWTO
2015-04-20T10:35:50Z
<p>Sonja.krause-harder: /* Access specific information */</p>
<hr />
<div>= HOWTO - Access Login Counter data with Jolokia = <br />
<br />
This article describes how to access information exposed through JMX by Open-Xchange with the Jolokia JMX-to-HTTP bridge, using "Login Counter" as an example.<br />
<br />
== Install Open-Xchange ==<br />
<br />
See http://oxpedia.org/wiki/index.php?title=AppSuite:Main_Page_AppSuite#quickinstall if you don't have Open-Xchange installed yet. Jolokia is part of the base product, no extra packages are needed.<br />
<br />
== Enable Jolokia == <br />
<br />
(See also https://oxpedia.org/wiki/index.php?title=Jolokia)<br />
<br />
In <code>etc/jolokia.properties</code>, enable Jolokia by setting the following properties:<br />
<br />
com.openexchange.jolokia.start = true<br />
com.openexchange.jolokia.user = youruser<br />
com.openexchange.jolokia.password = yourpassword<br />
<br />
Jolokia will not be enabled when no user/password is set.<br />
<br />
You can optionally adjust this setting:<br />
<br />
com.openexchange.jolokia.servlet.name = /monitoring/jolokia<br />
<br />
If you do, you need to adjust the examples below as well.<br />
<br />
== Allow access from other hosts ==<br />
<br />
This is an optional step, if you want to access the Jolokia interface from other hosts than localhost. This may be very helpful during the development phase of a project. Please be aware that this interface exposes lots of "interesting" data, so if you remove the restriction to localhost, you need to ensure by other means (network setup, firewalls, web server configuration, ...) that no unauthorised access is possible on production systems.<br />
<br />
In <code>etc/jolokia.properties</code>, set:<br />
<br />
com.openexchange.jolokia.restrict.to.localhost = false<br />
<br />
In your web server configuration, enable access to the jolokia servlet. For Apache this is possible by adding a ProxyPass directive for each OX host in the cluster:<br />
<br />
ProxyPass /monitoring/ox1/jolokia http://ox1-ip:8009/monitoring/jolokia<br />
ProxyPass /monitoring/ox2/jolokia http://ox2-ip:8009/monitoring/jolokia<br />
...<br />
<br />
On a default installation as described by our installation guides, this would be in <code>proxy_http.conf</code>.<br />
<br />
Reload your apache config and restart open-xchange for the changes to take effect.<br />
<br />
== Access the Jolokia interface ==<br />
<br />
On localhost, call:<br />
<br />
$ curl http://yourname:yourpassword@localhost:8009/monitoring/jolokia/list > ox.json<br />
<br />
If you enabled access from other hosts, you can also use a standard web browser. Open e.g.<br />
<br />
http://<yourserver>/monitoring/ox1/jolokia/list<br />
<br />
You'll be asked for user name and password through a standard HTTP auth window.<br />
<br />
== Access specific information ==<br />
<br />
The ox.json file you received in the last step gives you complete documentation what data is available through this interface.<br />
<br />
As an example, the "Login Counter" interface (which is also used by the [http://oxpedia.org/wiki/index.php?title=AppSuite:Logincounter logincounter command line tool]) is described like this:<br />
<br />
<pre>"com.openexchange.reporting": {<br />
"name=Login Counter": {<br />
"desc": "Information on the management interface of the MBean",<br />
"op": {<br />
"getLastLoginTimeStamp": {<br />
"ret":"java.util.List",<br />
"desc":"Operation exposed for management",<br />
"args": [<br />
{"desc":"","name":"p1","type":"int"},<br />
{"desc":"","name":"p2","type":"int"},<br />
{"desc":"","name":"p3","type":"java.lang.String"}<br />
]<br />
},<br />
"getNumberOfLogins": {<br />
"ret":"java.util.Map",<br />
"desc":"Operation exposed for management",<br />
"args": [<br />
{"desc":"","name":"p1","type":"java.util.Date"},<br />
{"desc":"","name":"p2","type":"java.util.Date"},<br />
{"desc":"","name":"p3","type":"boolean"},<br />
{"desc":"","name":"p4","type":"java.lang.String"}<br />
]<br />
}<br />
}<br />
}<br />
}</pre><br />
<br />
<br />
See http://www.jolokia.org/reference/html/protocol.html for detailed documentation how to use the Jolokia interface, especially http://www.jolokia.org/reference/html/protocol.html#serialization for the list of datatypes that can be passed as arguments and received in return values.<br />
<br />
To know what the parameters <code>p1</code>, <code>p2</code>, etc. mean, you need to look at the source code. (See http://oxpedia.org/wiki/index.php?title=SourceCodeAccess for information how to download it.)<br />
<br />
In the example above, to get the number of logins in a specific timeframe and with a specific client, we need to call the method getNumberOfLogins with the parameters startDate, endDate, aggregate and clientstring. They correspond to the command line parameters to the logincounter tool as described on:<br />
<br />
http://oxpedia.org/wiki/index.php?title=AppSuite:Logincounter<br />
<br />
In curl this call would look like this:<br />
<br />
$ curl http://yourname:yourpassword@localhost:8009/monitoring/jolokia/exec/com.openexchange.reporting:name=Login%20Counter/getNumberOfLogins/2015-01-01T00:00:00/2015-01-31T23:59:59/true/open-xchange-appsuite/<br />
<br />
If you have enabled access to the Jolokia interface from other hosts, the same information can be viewed in any web browser:<br />
http://<yourserver>/monitoring/ox1/jolokia/exec/com.openexchange.reporting:name=Login%20Counter/getNumberOfLogins/2015-01-01T00:00:00/2015-01-31T23:59:59/true/open-xchange-appsuite/<br />
<br />
[[Category:AppSuite]]<br />
[[Category:Server]]<br />
[[Category:Administrator]]</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=Jolokia_LoginCounter_HOWTO&diff=19358
Jolokia LoginCounter HOWTO
2015-04-20T10:28:56Z
<p>Sonja.krause-harder: </p>
<hr />
<div>= HOWTO - Access Login Counter data with Jolokia = <br />
<br />
This article describes how to access information exposed through JMX by Open-Xchange with the Jolokia JMX-to-HTTP bridge, using "Login Counter" as an example.<br />
<br />
== Install Open-Xchange ==<br />
<br />
See http://oxpedia.org/wiki/index.php?title=AppSuite:Main_Page_AppSuite#quickinstall if you don't have Open-Xchange installed yet. Jolokia is part of the base product, no extra packages are needed.<br />
<br />
== Enable Jolokia == <br />
<br />
(See also https://oxpedia.org/wiki/index.php?title=Jolokia)<br />
<br />
In <code>etc/jolokia.properties</code>, enable Jolokia by setting the following properties:<br />
<br />
com.openexchange.jolokia.start = true<br />
com.openexchange.jolokia.user = youruser<br />
com.openexchange.jolokia.password = yourpassword<br />
<br />
Jolokia will not be enabled when no user/password is set.<br />
<br />
You can optionally adjust this setting:<br />
<br />
com.openexchange.jolokia.servlet.name = /monitoring/jolokia<br />
<br />
If you do, you need to adjust the examples below as well.<br />
<br />
== Allow access from other hosts ==<br />
<br />
This is an optional step, if you want to access the Jolokia interface from other hosts than localhost. This may be very helpful during the development phase of a project. Please be aware that this interface exposes lots of "interesting" data, so if you remove the restriction to localhost, you need to ensure by other means (network setup, firewalls, web server configuration, ...) that no unauthorised access is possible on production systems.<br />
<br />
In <code>etc/jolokia.properties</code>, set:<br />
<br />
com.openexchange.jolokia.restrict.to.localhost = false<br />
<br />
In your web server configuration, enable access to the jolokia servlet. For Apache this is possible by adding a ProxyPass directive for each OX host in the cluster:<br />
<br />
ProxyPass /monitoring/ox1/jolokia http://ox1-ip:8009/monitoring/jolokia<br />
ProxyPass /monitoring/ox2/jolokia http://ox2-ip:8009/monitoring/jolokia<br />
...<br />
<br />
On a default installation as described by our installation guides, this would be in <code>proxy_http.conf</code>.<br />
<br />
Reload your apache config and restart open-xchange for the changes to take effect.<br />
<br />
== Access the Jolokia interface ==<br />
<br />
On localhost, call:<br />
<br />
$ curl http://yourname:yourpassword@localhost:8009/monitoring/jolokia/list > ox.json<br />
<br />
If you enabled access from other hosts, you can also use a standard web browser. Open e.g.<br />
<br />
http://<yourserver>/monitoring/ox1/jolokia/list<br />
<br />
You'll be asked for user name and password through a standard HTTP auth window.<br />
<br />
== Access specific information ==<br />
<br />
The ox.json file you received in the last step gives you a complete documentation what data is available through this interface.<br />
<br />
As an example, the "Login Counter" interface (which is also used by the [http://oxpedia.org/wiki/index.php?title=AppSuite:Logincounter logincounter command line tool]) is described like this:<br />
<br />
<pre>"com.openexchange.reporting": {<br />
"name=Login Counter": {<br />
"desc": "Information on the management interface of the MBean",<br />
"op": {<br />
"getLastLoginTimeStamp": {<br />
"ret":"java.util.List",<br />
"desc":"Operation exposed for management",<br />
"args": [<br />
{"desc":"","name":"p1","type":"int"},<br />
{"desc":"","name":"p2","type":"int"},<br />
{"desc":"","name":"p3","type":"java.lang.String"}<br />
]<br />
},<br />
"getNumberOfLogins": {<br />
"ret":"java.util.Map",<br />
"desc":"Operation exposed for management",<br />
"args": [<br />
{"desc":"","name":"p1","type":"java.util.Date"},<br />
{"desc":"","name":"p2","type":"java.util.Date"},<br />
{"desc":"","name":"p3","type":"boolean"},<br />
{"desc":"","name":"p4","type":"java.lang.String"}<br />
]<br />
}<br />
}<br />
}<br />
}</pre><br />
<br />
<br />
See http://www.jolokia.org/reference/html/protocol.html for detailed documentation how to use the Jolokia interface, especially http://www.jolokia.org/reference/html/protocol.html#serialization for the list of datatypes that can be passed as arguments and received in return values.<br />
<br />
To know what the parameters <code>p1</code>, <code>p2</code>, etc. mean, you need to look at the source code. (See http://oxpedia.org/wiki/index.php?title=SourceCodeAccess for information how to download it.)<br />
<br />
In the example above, to get the number of logins in a specific timeframe and with a specific client, we need to call the method getNumberOfLogins with the parameters startDate, endDate, aggregate and clientstring. They correspond to the command line parameters to the logincounter tool as described on:<br />
<br />
http://oxpedia.org/wiki/index.php?title=AppSuite:Logincounter<br />
<br />
In curl this call would look like this:<br />
<br />
$ curl http://yourname:yourpassword@localhost:8009/monitoring/jolokia/exec/com.openexchange.reporting:name=Login%20Counter/getNumberOfLogins/2015-01-01T00:00:00/2015-01-31T23:59:59/true/open-xchange-appsuite/<br />
<br />
If you have enabled access to the Jolokia interface from other hosts, the same information can be viewed in any web browser:<br />
http://<yourserver>/monitoring/ox1/jolokia/exec/com.openexchange.reporting:name=Login%20Counter/getNumberOfLogins/2015-01-01T00:00:00/2015-01-31T23:59:59/true/open-xchange-appsuite/<br />
<br />
[[Category:AppSuite]]<br />
[[Category:Server]]<br />
[[Category:Administrator]]</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=Jolokia&diff=19357
Jolokia
2015-04-20T10:28:31Z
<p>Sonja.krause-harder: </p>
<hr />
<div><div class="title">Jolokia</div><br />
<br />
'''Summary:''' This article tells you to use Jolokia, a JMX bridge, that is available vom AppSuite v7.4.0 on.<br />
<br />
__TOC__<br />
<br />
= How to interact with Jolokia for Open-Xchange=<br />
<br />
Open-Xchange does support Jolokia as a remote JMX-Bridge over HTTP.<br />
<br />
By Version 7.4.0 ongoing, it is located inside Open-Xchange Bundle and configured by jolokia.properties<br />
<br />
Additional information can be found at http://www.jolokia.org/ .<br />
<br />
== jolokia.properties ==<br />
{|width="100%" style="table-layout: fixed" class='wikitable sortable' border='1'<br />
! scope="col" width="30%" | Key<br />
! scope="col" width="20%" | Default value<br />
! scope="col" width="35%" | Comment<br />
|-<br />
| com.openexchange.jolokia.start<br />
| false<br />
| start switch for jolokia<br />
|-<br />
| com.openexchange.jolokia.servlet.name<br />
| /monitoring/jolokia<br />
| <nowiki>Under what servlet name jolokia will be published, please bear in mind that this should not be forwarded by apache and kept internal</nowiki><br />
|-<br />
| com.openexchange.jolokia.user<br />
| <br />
| <nowiki>User used for authentication with HTTP Basic Authentication. If not given, Jolokia will not start!</nowiki><br />
|-<br />
| com.openexchange.jolokia.password<br />
| <br />
| <nowiki>Password used for authentification, if not set "secret" is used.</nowiki><br />
|-<br />
| com.openexchange.jolokia.restrict.to.localhost<br />
| true<br />
| <nowiki>This setting will restrict jolokia access to localhost. It is completly ignored when a jolokia-access.xml is present</nowiki><br />
|}<br />
<br />
Keep in mind that Jolokia will not start unless you set <code> com.openexchange.jolokia.start = true </code> , <code> com.openexchange.jolokia.user = yourUser</code> and to <code> com.openexchange.jolokia.password = yourPassword</code>.<br />
<br />
When using Munin-Scripts with Jolokia, this user and password also need to be changed.<br />
<br />
== Running Jolokia ==<br />
<br />
As Jolokia represents a JMX-Interface it is highly recommended '''not''' to forward it to the internet!<br />
<br />
This is by default set through the use of <code>com.openexchange.jolokia.restrict.to.localhost = true</code> and can be changed by either setting it to <code>false</code> or providing a <code>jolokia-access.xml</code> inside <code>/opt/open-xchange/etc/</code><br />
<br />
For further information how to setup this file, http://www.jolokia.org/reference/html/security.html is a good start as all those settings are usable.<br />
<br />
=== Jolokia with Grizzly ===<br />
<br />
When using Grizzly and munin scripts on the same machine, you can connect to jolokia directly with the servers address, e.g.: <code>http://localhost:8009/monitoring/jolokia</code>.<br />
When connecting through another machine, a best practise is to use the same forwarding as described below.<br />
<br />
== Example ==<br />
<br />
For a more detailed example, see https://oxpedia.org/wiki/index.php?title=Jolokia_LoginCounter_HOWTO<br />
<br />
[[Category:AppSuite]]<br />
[[Category:Server]]<br />
[[Category:Administrator]]</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=Jolokia_LoginCounter_HOWTO&diff=19356
Jolokia LoginCounter HOWTO
2015-04-20T10:27:07Z
<p>Sonja.krause-harder: /* Access specific information */</p>
<hr />
<div>= HOWTO - Access Login Counter data with Jolokia = <br />
<br />
This article describes how to access information exposed through JMX by Open-Xchange with the Jolokia JMX-to-HTTP bridge, using "Login Counter" as an example.<br />
<br />
== Install Open-Xchange ==<br />
<br />
See http://oxpedia.org/wiki/index.php?title=AppSuite:Main_Page_AppSuite#quickinstall if you don't have Open-Xchange installed yet. Jolokia is part of the base product, no extra packages are needed.<br />
<br />
== Enable Jolokia == <br />
<br />
(See also https://oxpedia.org/wiki/index.php?title=Jolokia)<br />
<br />
In <code>etc/jolokia.properties</code>, enable Jolokia by setting the following properties:<br />
<br />
com.openexchange.jolokia.start = true<br />
com.openexchange.jolokia.user = youruser<br />
com.openexchange.jolokia.password = yourpassword<br />
<br />
Jolokia will not be enabled when no user/password is set.<br />
<br />
You can optionally adjust this setting:<br />
<br />
com.openexchange.jolokia.servlet.name = /monitoring/jolokia<br />
<br />
If you do, you need to adjust the examples below as well.<br />
<br />
== Allow access from other hosts ==<br />
<br />
This is an optional step, if you want to access the Jolokia interface from other hosts than localhost. This may be very helpful during the development phase of a project. Please be aware that this interface exposes lots of "interesting" data, so if you remove the restriction to localhost, you need to ensure by other means (network setup, firewalls, web server configuration, ...) that no unauthorised access is possible on production systems.<br />
<br />
In <code>etc/jolokia.properties</code>, set:<br />
<br />
com.openexchange.jolokia.restrict.to.localhost = false<br />
<br />
In your web server configuration, enable access to the jolokia servlet. For Apache this is possible by adding a ProxyPass directive for each OX host in the cluster:<br />
<br />
ProxyPass /monitoring/ox1/jolokia http://ox1-ip:8009/monitoring/jolokia<br />
ProxyPass /monitoring/ox2/jolokia http://ox2-ip:8009/monitoring/jolokia<br />
...<br />
<br />
On a default installation as described by our installation guides, this would be in <code>proxy_http.conf</code>.<br />
<br />
Reload your apache config and restart open-xchange for the changes to take effect.<br />
<br />
== Access the Jolokia interface ==<br />
<br />
On localhost, call:<br />
<br />
$ curl http://yourname:yourpassword@localhost:8009/monitoring/jolokia/list > ox.json<br />
<br />
If you enabled access from other hosts, you can also use a standard web browser. Open e.g.<br />
<br />
http://<yourserver>/monitoring/ox1/jolokia/list<br />
<br />
You'll be asked for user name and password through a standard HTTP auth window.<br />
<br />
== Access specific information ==<br />
<br />
The ox.json file you received in the last step gives you a complete documentation what data is available through this interface.<br />
<br />
As an example, the "Login Counter" interface (which is also used by the [http://oxpedia.org/wiki/index.php?title=AppSuite:Logincounter logincounter command line tool]) is described like this:<br />
<br />
<pre>"com.openexchange.reporting": {<br />
"name=Login Counter": {<br />
"desc": "Information on the management interface of the MBean",<br />
"op": {<br />
"getLastLoginTimeStamp": {<br />
"ret":"java.util.List",<br />
"desc":"Operation exposed for management",<br />
"args": [<br />
{"desc":"","name":"p1","type":"int"},<br />
{"desc":"","name":"p2","type":"int"},<br />
{"desc":"","name":"p3","type":"java.lang.String"}<br />
]<br />
},<br />
"getNumberOfLogins": {<br />
"ret":"java.util.Map",<br />
"desc":"Operation exposed for management",<br />
"args": [<br />
{"desc":"","name":"p1","type":"java.util.Date"},<br />
{"desc":"","name":"p2","type":"java.util.Date"},<br />
{"desc":"","name":"p3","type":"boolean"},<br />
{"desc":"","name":"p4","type":"java.lang.String"}<br />
]<br />
}<br />
}<br />
}<br />
}</pre><br />
<br />
<br />
See http://www.jolokia.org/reference/html/protocol.html for detailed documentation how to use the Jolokia interface, especially http://www.jolokia.org/reference/html/protocol.html#serialization for the list of datatypes that can be passed as arguments and received in return values.<br />
<br />
To know what the parameters <code>p1</code>, <code>p2</code>, etc. mean, you need to look at the source code. (See http://oxpedia.org/wiki/index.php?title=SourceCodeAccess for information how to download it.)<br />
<br />
In the example above, to get the number of logins in a specific timeframe and with a specific client, we need to call the method getNumberOfLogins with the parameters startDate, endDate, aggregate and clientstring. They correspond to the command line parameters to the logincounter tool as described on:<br />
<br />
http://oxpedia.org/wiki/index.php?title=AppSuite:Logincounter<br />
<br />
In curl this call would look like this:<br />
<br />
$ curl http://yourname:yourpassword@localhost:8009/monitoring/jolokia/exec/com.openexchange.reporting:name=Login%20Counter/getNumberOfLogins/2015-01-01T00:00:00/2015-01-31T23:59:59/true/open-xchange-appsuite/<br />
<br />
If you have enabled access to the Jolokia interface from other hosts, the same information can be viewed in any web browser:<br />
http://<yourserver>/monitoring/ox1/jolokia/exec/com.openexchange.reporting:name=Login%20Counter/getNumberOfLogins/2015-01-01T00:00:00/2015-01-31T23:59:59/true/open-xchange-appsuite/</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=Jolokia_LoginCounter_HOWTO&diff=19355
Jolokia LoginCounter HOWTO
2015-04-20T10:26:41Z
<p>Sonja.krause-harder: /* Access the Jolokia interface */</p>
<hr />
<div>= HOWTO - Access Login Counter data with Jolokia = <br />
<br />
This article describes how to access information exposed through JMX by Open-Xchange with the Jolokia JMX-to-HTTP bridge, using "Login Counter" as an example.<br />
<br />
== Install Open-Xchange ==<br />
<br />
See http://oxpedia.org/wiki/index.php?title=AppSuite:Main_Page_AppSuite#quickinstall if you don't have Open-Xchange installed yet. Jolokia is part of the base product, no extra packages are needed.<br />
<br />
== Enable Jolokia == <br />
<br />
(See also https://oxpedia.org/wiki/index.php?title=Jolokia)<br />
<br />
In <code>etc/jolokia.properties</code>, enable Jolokia by setting the following properties:<br />
<br />
com.openexchange.jolokia.start = true<br />
com.openexchange.jolokia.user = youruser<br />
com.openexchange.jolokia.password = yourpassword<br />
<br />
Jolokia will not be enabled when no user/password is set.<br />
<br />
You can optionally adjust this setting:<br />
<br />
com.openexchange.jolokia.servlet.name = /monitoring/jolokia<br />
<br />
If you do, you need to adjust the examples below as well.<br />
<br />
== Allow access from other hosts ==<br />
<br />
This is an optional step, if you want to access the Jolokia interface from other hosts than localhost. This may be very helpful during the development phase of a project. Please be aware that this interface exposes lots of "interesting" data, so if you remove the restriction to localhost, you need to ensure by other means (network setup, firewalls, web server configuration, ...) that no unauthorised access is possible on production systems.<br />
<br />
In <code>etc/jolokia.properties</code>, set:<br />
<br />
com.openexchange.jolokia.restrict.to.localhost = false<br />
<br />
In your web server configuration, enable access to the jolokia servlet. For Apache this is possible by adding a ProxyPass directive for each OX host in the cluster:<br />
<br />
ProxyPass /monitoring/ox1/jolokia http://ox1-ip:8009/monitoring/jolokia<br />
ProxyPass /monitoring/ox2/jolokia http://ox2-ip:8009/monitoring/jolokia<br />
...<br />
<br />
On a default installation as described by our installation guides, this would be in <code>proxy_http.conf</code>.<br />
<br />
Reload your apache config and restart open-xchange for the changes to take effect.<br />
<br />
== Access the Jolokia interface ==<br />
<br />
On localhost, call:<br />
<br />
$ curl http://yourname:yourpassword@localhost:8009/monitoring/jolokia/list > ox.json<br />
<br />
If you enabled access from other hosts, you can also use a standard web browser. Open e.g.<br />
<br />
http://<yourserver>/monitoring/ox1/jolokia/list<br />
<br />
You'll be asked for user name and password through a standard HTTP auth window.<br />
<br />
== Access specific information ==<br />
<br />
The ox.json file you received in the last step gives you a complete documentation what data is available through this interface.<br />
<br />
As an example, the "Login Counter" interface (which is also used by the [http://oxpedia.org/wiki/index.php?title=AppSuite:Logincounter logincounter command line tool]) is described like this:<br />
<br />
<pre>"com.openexchange.reporting": {<br />
"name=Login Counter": {<br />
"desc": "Information on the management interface of the MBean",<br />
"op": {<br />
"getLastLoginTimeStamp": {<br />
"ret":"java.util.List",<br />
"desc":"Operation exposed for management",<br />
"args": [<br />
{"desc":"","name":"p1","type":"int"},<br />
{"desc":"","name":"p2","type":"int"},<br />
{"desc":"","name":"p3","type":"java.lang.String"}<br />
]<br />
},<br />
"getNumberOfLogins": {<br />
"ret":"java.util.Map",<br />
"desc":"Operation exposed for management",<br />
"args": [<br />
{"desc":"","name":"p1","type":"java.util.Date"},<br />
{"desc":"","name":"p2","type":"java.util.Date"},<br />
{"desc":"","name":"p3","type":"boolean"},<br />
{"desc":"","name":"p4","type":"java.lang.String"}<br />
]<br />
}<br />
}<br />
}<br />
}</pre><br />
<br />
<br />
See http://www.jolokia.org/reference/html/protocol.html for detailed documentation how to use the Jolokia interface, especially http://www.jolokia.org/reference/html/protocol.html#serialization for the list of datatypes that can be passed as arguments and received in return values.<br />
<br />
To know what the parameters <code>p1</code>, <code>p2</code>, etc. mean, you need to look at the source code. (See http://oxpedia.org/wiki/index.php?title=SourceCodeAccess for information how to download it.)<br />
<br />
In the example above, to get the number of logins in a specific timeframe and with a specific client, we need to call the method getNumberOfLogins with the parameters startDate, endDate, aggregate and clientstring. They correspond to the command line parameters to the logincounter tool as described on:<br />
<br />
http://oxpedia.org/wiki/index.php?title=AppSuite:Logincounter<br />
<br />
In curl this call would look like this:<br />
<br />
$ curl http://yourname:yourpassword@localhost:8009/monitoring/jolokia/exec/com.openexchange.reporting:name=Login%20Counter/getNumberOfLogins/2015-01-01T00:00:00/2015-01-31T23:59:59/true/open-xchange-appsuite/<br />
<br />
If you have enabled access to the Jolokia interface from other hosts, the same information can be viewed in any web browser:<br />
<br />
http://<yourserver>/monitoring/jolokia/exec/com.openexchange.reporting:name=Login%20Counter/getNumberOfLogins/2015-01-01T00:00:00/2015-01-31T23:59:59/true/open-xchange-appsuite/</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=Jolokia_LoginCounter_HOWTO&diff=19354
Jolokia LoginCounter HOWTO
2015-04-20T10:23:15Z
<p>Sonja.krause-harder: </p>
<hr />
<div>= HOWTO - Access Login Counter data with Jolokia = <br />
<br />
This article describes how to access information exposed through JMX by Open-Xchange with the Jolokia JMX-to-HTTP bridge, using "Login Counter" as an example.<br />
<br />
== Install Open-Xchange ==<br />
<br />
See http://oxpedia.org/wiki/index.php?title=AppSuite:Main_Page_AppSuite#quickinstall if you don't have Open-Xchange installed yet. Jolokia is part of the base product, no extra packages are needed.<br />
<br />
== Enable Jolokia == <br />
<br />
(See also https://oxpedia.org/wiki/index.php?title=Jolokia)<br />
<br />
In <code>etc/jolokia.properties</code>, enable Jolokia by setting the following properties:<br />
<br />
com.openexchange.jolokia.start = true<br />
com.openexchange.jolokia.user = youruser<br />
com.openexchange.jolokia.password = yourpassword<br />
<br />
Jolokia will not be enabled when no user/password is set.<br />
<br />
You can optionally adjust this setting:<br />
<br />
com.openexchange.jolokia.servlet.name = /monitoring/jolokia<br />
<br />
If you do, you need to adjust the examples below as well.<br />
<br />
== Allow access from other hosts ==<br />
<br />
This is an optional step, if you want to access the Jolokia interface from other hosts than localhost. This may be very helpful during the development phase of a project. Please be aware that this interface exposes lots of "interesting" data, so if you remove the restriction to localhost, you need to ensure by other means (network setup, firewalls, web server configuration, ...) that no unauthorised access is possible on production systems.<br />
<br />
In <code>etc/jolokia.properties</code>, set:<br />
<br />
com.openexchange.jolokia.restrict.to.localhost = false<br />
<br />
In your web server configuration, enable access to the jolokia servlet. For Apache this is possible by adding a ProxyPass directive for each OX host in the cluster:<br />
<br />
ProxyPass /monitoring/ox1/jolokia http://ox1-ip:8009/monitoring/jolokia<br />
ProxyPass /monitoring/ox2/jolokia http://ox2-ip:8009/monitoring/jolokia<br />
...<br />
<br />
On a default installation as described by our installation guides, this would be in <code>proxy_http.conf</code>.<br />
<br />
Reload your apache config and restart open-xchange for the changes to take effect.<br />
<br />
== Access the Jolokia interface ==<br />
<br />
On localhost, call:<br />
<br />
$ curl http://yourname:yourpassword@localhost:8009/monitoring/jolokia/list > ox.json<br />
<br />
If you enabled access from other hosts, you can also use a standard web browser. Open<br />
<br />
http://<yourserver>/monitoring/jolokia/list<br />
<br />
You'll be asked for user name and password through a standard HTTP auth window.<br />
<br />
== Access specific information ==<br />
<br />
The ox.json file you received in the last step gives you a complete documentation what data is available through this interface.<br />
<br />
As an example, the "Login Counter" interface (which is also used by the [http://oxpedia.org/wiki/index.php?title=AppSuite:Logincounter logincounter command line tool]) is described like this:<br />
<br />
<pre>"com.openexchange.reporting": {<br />
"name=Login Counter": {<br />
"desc": "Information on the management interface of the MBean",<br />
"op": {<br />
"getLastLoginTimeStamp": {<br />
"ret":"java.util.List",<br />
"desc":"Operation exposed for management",<br />
"args": [<br />
{"desc":"","name":"p1","type":"int"},<br />
{"desc":"","name":"p2","type":"int"},<br />
{"desc":"","name":"p3","type":"java.lang.String"}<br />
]<br />
},<br />
"getNumberOfLogins": {<br />
"ret":"java.util.Map",<br />
"desc":"Operation exposed for management",<br />
"args": [<br />
{"desc":"","name":"p1","type":"java.util.Date"},<br />
{"desc":"","name":"p2","type":"java.util.Date"},<br />
{"desc":"","name":"p3","type":"boolean"},<br />
{"desc":"","name":"p4","type":"java.lang.String"}<br />
]<br />
}<br />
}<br />
}<br />
}</pre><br />
<br />
<br />
See http://www.jolokia.org/reference/html/protocol.html for detailed documentation how to use the Jolokia interface, especially http://www.jolokia.org/reference/html/protocol.html#serialization for the list of datatypes that can be passed as arguments and received in return values.<br />
<br />
To know what the parameters <code>p1</code>, <code>p2</code>, etc. mean, you need to look at the source code. (See http://oxpedia.org/wiki/index.php?title=SourceCodeAccess for information how to download it.)<br />
<br />
In the example above, to get the number of logins in a specific timeframe and with a specific client, we need to call the method getNumberOfLogins with the parameters startDate, endDate, aggregate and clientstring. They correspond to the command line parameters to the logincounter tool as described on:<br />
<br />
http://oxpedia.org/wiki/index.php?title=AppSuite:Logincounter<br />
<br />
In curl this call would look like this:<br />
<br />
$ curl http://yourname:yourpassword@localhost:8009/monitoring/jolokia/exec/com.openexchange.reporting:name=Login%20Counter/getNumberOfLogins/2015-01-01T00:00:00/2015-01-31T23:59:59/true/open-xchange-appsuite/<br />
<br />
If you have enabled access to the Jolokia interface from other hosts, the same information can be viewed in any web browser:<br />
<br />
http://<yourserver>/monitoring/jolokia/exec/com.openexchange.reporting:name=Login%20Counter/getNumberOfLogins/2015-01-01T00:00:00/2015-01-31T23:59:59/true/open-xchange-appsuite/</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=Jolokia_LoginCounter_HOWTO&diff=19353
Jolokia LoginCounter HOWTO
2015-04-20T10:21:37Z
<p>Sonja.krause-harder: /* HOWTO - Access Login Counter with Jolokia */</p>
<hr />
<div>= HOWTO - Access Login Counter data with Jolokia = <br />
<br />
This article describes how to access information exposed through JMX by Open-Xchange with the Jolokia JMX-to-HTTP bridge, using "Login Counter" as an example.<br />
<br />
== Install Open-Xchange ==<br />
<br />
See http://oxpedia.org/wiki/index.php?title=AppSuite:Main_Page_AppSuite#quickinstall if you don't have Open-Xchange installed yet. Jolokia is part of the base product, no extra packages are needed.<br />
<br />
== Enable Jolokia == <br />
<br />
(See also https://oxpedia.org/wiki/index.php?title=Jolokia)<br />
<br />
In <code>etc/jolokia.properties</code>, enable Jolokia by setting the following properties:<br />
<br />
com.openexchange.jolokia.start = true<br />
com.openexchange.jolokia.user = youruser<br />
com.openexchange.jolokia.password = yourpassword<br />
<br />
Jolokia will not be enabled when no user/password is set.<br />
<br />
You can optionally adjust this setting:<br />
<br />
com.openexchange.jolokia.servlet.name = /monitoring/jolokia<br />
<br />
If you do, you need to adjust the examples below as well.<br />
<br />
== Allow access from other hosts ==<br />
<br />
This is an optional step, if you want to access the Jolokia interface from other hosts than localhost. This may be very helpful during the development phase of a project. Please be aware that this interface exposes lots of "interesting" data, so if you remove the restriction to localhost, you need to ensure by other means (network setup, firewalls, web server configuration, ...) that no unauthorised access is possible on production systems.<br />
<br />
In <code>etc/jolokia.properties</code>, set:<br />
<br />
com.openexchange.jolokia.restrict.to.localhost = false<br />
<br />
In your web server configuration, enable access to the jolokia servlet. For Apache this is possible by adding a ProxyPass directive for each OX host in the cluster:<br />
<br />
ProxyPass /monitoring/ox1/jolokia http://ox1-ip:8009/monitoring/jolokia<br />
ProxyPass /monitoring/ox2/jolokia http://ox2-ip:8009/monitoring/jolokia<br />
...<br />
<br />
On a default installation as described by our installation guides, this would be in <code>proxy_http.conf</code>.<br />
<br />
Reload your apache config and restart open-xchange for the changes to take effect.<br />
<br />
== Access the Jolokia interface ==<br />
<br />
On localhost, call:<br />
<br />
$ curl http://yourname:yourpassword@localhost:8009/monitoring/jolokia/list > ox.json<br />
<br />
If you enabled access from other hosts, you can also use a standard web browser. Open<br />
<br />
http://<yourserver>/monitoring/jolokia/list<br />
<br />
You'll be asked for user name and password through a standard HTTP auth window.<br />
<br />
== Access specific information ==<br />
<br />
The ox.json file you received in the last step gives you a complete documentation what data is available through this interface.<br />
<br />
As an example, the "Login Counter" interface (which is also used by the [http://oxpedia.org/wiki/index.php?title=AppSuite:Logincounter logincounter command line tool]) is described like this:<br />
<br />
<pre>"com.openexchange.reporting": {<br />
"name=Login Counter": {<br />
"desc": "Information on the management interface of the MBean",<br />
"op": {<br />
"getLastLoginTimeStamp": {<br />
"ret":"java.util.List",<br />
"desc":"Operation exposed for management",<br />
"args": [<br />
{"desc":"","name":"p1","type":"int"},<br />
{"desc":"","name":"p2","type":"int"},<br />
{"desc":"","name":"p3","type":"java.lang.String"}<br />
]<br />
},<br />
"getNumberOfLogins": {<br />
"ret":"java.util.Map",<br />
"desc":"Operation exposed for management",<br />
"args": [<br />
{"desc":"","name":"p1","type":"java.util.Date"},<br />
{"desc":"","name":"p2","type":"java.util.Date"},<br />
{"desc":"","name":"p3","type":"boolean"},<br />
{"desc":"","name":"p4","type":"java.lang.String"}<br />
]<br />
}<br />
}<br />
}<br />
}</pre><br />
<br />
<br />
See http://www.jolokia.org/reference/html/protocol.html for detailed documentation how to use the Jolokia interface, especially http://www.jolokia.org/reference/html/protocol.html#serialization for the list of datatypes that can be passed as arguments and received in return values.<br />
<br />
To know what the parameters <code>p1</code>, <code>p2</code>, etc. mean, you need to look at the source code. (See http://oxpedia.org/wiki/index.php?title=SourceCodeAccess for information how to download it.)<br />
<br />
In the example above, to get the number of logins in a specific timeframe and with a specific client, we need to call the method getNumberOfLogins with the parameters startDate, endDate, aggregate and clientstring. They correspond to the command line parameters to the logincounter tool as described on:<br />
<br />
http://oxpedia.org/wiki/index.php?title=AppSuite:Logincounter<br />
<br />
In curl this call would look like this:<br />
<br />
$ curl http://yourname:yourpassword@localhost:8009/monitoring/jolokia/exec/com.openexchange.reporting:name=Login%20Counter/getNumberOfLogins/2015-01-01T00:00:00/2015-01-31T23:59:59/true/open-xchange-appsuite/<br />
<br />
If you have enabled access to the Jolokia interface from other hosts, the same information can be viewed in any web browser:<br />
<br />
http://<yourserver>/monitoring/jolokia/exec/com.openexchange.reporting:name=Login%20Counter/getNumberOfLogins/2015-01-01T00:00:00/2015-01-31T23:59:59/true/open-xchange-appsuite/</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=Jolokia_LoginCounter_HOWTO&diff=19352
Jolokia LoginCounter HOWTO
2015-04-20T10:20:59Z
<p>Sonja.krause-harder: Created page with "= HOWTO - Access Login Counter with Jolokia = This article describes how to access information exposed through JMX by Open-Xchange with the Jolokia JMX-to-HTTP bridge, using..."</p>
<hr />
<div>= HOWTO - Access Login Counter with Jolokia = <br />
<br />
This article describes how to access information exposed through JMX by Open-Xchange with the Jolokia JMX-to-HTTP bridge, using "Login Counter" as an example.<br />
<br />
== Install Open-Xchange ==<br />
<br />
See http://oxpedia.org/wiki/index.php?title=AppSuite:Main_Page_AppSuite#quickinstall if you don't have Open-Xchange installed yet. Jolokia is part of the base product, no extra packages are needed.<br />
<br />
== Enable Jolokia == <br />
<br />
(See also https://oxpedia.org/wiki/index.php?title=Jolokia)<br />
<br />
In <code>etc/jolokia.properties</code>, enable Jolokia by setting the following properties:<br />
<br />
com.openexchange.jolokia.start = true<br />
com.openexchange.jolokia.user = youruser<br />
com.openexchange.jolokia.password = yourpassword<br />
<br />
Jolokia will not be enabled when no user/password is set.<br />
<br />
You can optionally adjust this setting:<br />
<br />
com.openexchange.jolokia.servlet.name = /monitoring/jolokia<br />
<br />
If you do, you need to adjust the examples below as well.<br />
<br />
== Allow access from other hosts ==<br />
<br />
This is an optional step, if you want to access the Jolokia interface from other hosts than localhost. This may be very helpful during the development phase of a project. Please be aware that this interface exposes lots of "interesting" data, so if you remove the restriction to localhost, you need to ensure by other means (network setup, firewalls, web server configuration, ...) that no unauthorised access is possible on production systems.<br />
<br />
In <code>etc/jolokia.properties</code>, set:<br />
<br />
com.openexchange.jolokia.restrict.to.localhost = false<br />
<br />
In your web server configuration, enable access to the jolokia servlet. For Apache this is possible by adding a ProxyPass directive for each OX host in the cluster:<br />
<br />
ProxyPass /monitoring/ox1/jolokia http://ox1-ip:8009/monitoring/jolokia<br />
ProxyPass /monitoring/ox2/jolokia http://ox2-ip:8009/monitoring/jolokia<br />
...<br />
<br />
On a default installation as described by our installation guides, this would be in <code>proxy_http.conf</code>.<br />
<br />
Reload your apache config and restart open-xchange for the changes to take effect.<br />
<br />
== Access the Jolokia interface ==<br />
<br />
On localhost, call:<br />
<br />
$ curl http://yourname:yourpassword@localhost:8009/monitoring/jolokia/list > ox.json<br />
<br />
If you enabled access from other hosts, you can also use a standard web browser. Open<br />
<br />
http://<yourserver>/monitoring/jolokia/list<br />
<br />
You'll be asked for user name and password through a standard HTTP auth window.<br />
<br />
== Access specific information ==<br />
<br />
The ox.json file you received in the last step gives you a complete documentation what data is available through this interface.<br />
<br />
As an example, the "Login Counter" interface (which is also used by the [http://oxpedia.org/wiki/index.php?title=AppSuite:Logincounter logincounter command line tool]) is described like this:<br />
<br />
<pre>"com.openexchange.reporting": {<br />
"name=Login Counter": {<br />
"desc": "Information on the management interface of the MBean",<br />
"op": {<br />
"getLastLoginTimeStamp": {<br />
"ret":"java.util.List",<br />
"desc":"Operation exposed for management",<br />
"args": [<br />
{"desc":"","name":"p1","type":"int"},<br />
{"desc":"","name":"p2","type":"int"},<br />
{"desc":"","name":"p3","type":"java.lang.String"}<br />
]<br />
},<br />
"getNumberOfLogins": {<br />
"ret":"java.util.Map",<br />
"desc":"Operation exposed for management",<br />
"args": [<br />
{"desc":"","name":"p1","type":"java.util.Date"},<br />
{"desc":"","name":"p2","type":"java.util.Date"},<br />
{"desc":"","name":"p3","type":"boolean"},<br />
{"desc":"","name":"p4","type":"java.lang.String"}<br />
]<br />
}<br />
}<br />
}<br />
}</pre><br />
<br />
<br />
See http://www.jolokia.org/reference/html/protocol.html for detailed documentation how to use the Jolokia interface, especially http://www.jolokia.org/reference/html/protocol.html#serialization for the list of datatypes that can be passed as arguments and received in return values.<br />
<br />
To know what the parameters <code>p1</code>, <code>p2</code>, etc. mean, you need to look at the source code. (See http://oxpedia.org/wiki/index.php?title=SourceCodeAccess for information how to download it.)<br />
<br />
In the example above, to get the number of logins in a specific timeframe and with a specific client, we need to call the method getNumberOfLogins with the parameters startDate, endDate, aggregate and clientstring. They correspond to the command line parameters to the logincounter tool as described on:<br />
<br />
http://oxpedia.org/wiki/index.php?title=AppSuite:Logincounter<br />
<br />
In curl this call would look like this:<br />
<br />
$ curl http://yourname:yourpassword@localhost:8009/monitoring/jolokia/exec/com.openexchange.reporting:name=Login%20Counter/getNumberOfLogins/2015-01-01T00:00:00/2015-01-31T23:59:59/true/open-xchange-appsuite/<br />
<br />
If you have enabled access to the Jolokia interface from other hosts, the same information can be viewed in any web browser:<br />
<br />
http://<yourserver>/monitoring/jolokia/exec/com.openexchange.reporting:name=Login%20Counter/getNumberOfLogins/2015-01-01T00:00:00/2015-01-31T23:59:59/true/open-xchange-appsuite/</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:OX_Drive&diff=19242
AppSuite:OX Drive
2015-03-16T11:24:25Z
<p>Sonja.krause-harder: </p>
<hr />
<div>= OX Drive =<br />
<br />
In OX App Suite, Open-Xchange provides a cloud storage called OX Drive. It provides file- and folder synchronization across multiple devices in the most 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 client setup.<br />
<br />
== Key features ==<br />
<br />
* Native Apps for Windows, Mac OS, iOS and Android<br />
* Easy and attractive upsell properties (e.g. Upsell based on Quota limitations)<br />
* Clients are specially designed for the devices they run on taking into account limitations such as battery life, screen limitations, bandwidth etc.<br />
* Controlled synchronization of files across devices<br />
* Storage management (e.g. quota control, upload limits)<br />
* Connection type recognition and adaptation (e.g. Wi-Fi, cell network)<br />
<br />
== Availability ==<br />
<br />
OX Drive is a combination of two components:<br />
* OX Drive in OX App Suite<br />
* OX Drive Clients (optional native client components for synchronization)<br />
<br />
OX Drive is available for the following native clients:<br />
* OX Drive for Windows<br />
* OX Drive for Mac OS<br />
* OX Drive for iOS<br />
* OX Drive for Android<br />
<br />
== Requirements ==<br />
<br />
You will find the requirements under [[AppSuite:OX_System_Requirements#OX_Drive_for_Clients|OX Drive Client and Platform Requirements]]<br />
<br />
= Server-side Installation and Configuration =<br />
<br />
This chapter describes how the backend components of OX Drive are installed and configured on the server.<br />
<br />
== Prerequisites ==<br />
<br />
* Open-Xchange Server v7.4.2 and above (''open-xchange-core'')<br />
* Grizzly HTTP connector (''open-xchange-grizzly''), see [[AppSuite:Grizzly]] for details, with ''Comet'' support enabled in ''grizzly.properties''<br />
* Valid Push-Certificates / API keys for cloud-based notifications, see configuration below<br />
* Enabled Hazelcast for inter-OX-communication, see [[AppSuite:Running_a_cluster]] for details<br />
<br />
== Available packages ==<br />
<br />
Open-Xchange Drive is available with the following backend packages:<br />
<br />
* ''open-xchange-drive'' - The main server components for OX Drive<br />
* ''open-xchange-drive-comet'' - Provides the Push interface via long-polling for the desktop clients<br />
* ''open-xchange-updater-drive'' - Adds the OX Drive application to the Windows desktop auto-updater<br />
* ''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)<br />
* ''open-xchange-drive-restricted'' - Restricted components, including prerequisites for cloud-based push notifications<br />
<br />
Installation on the server varies depending on the underlying distribution, details are available in the following chapters.<br />
<br />
=== Redhat Enterprise Linux 6 or CentOS 6 ===<br />
<br />
If not already done, add the following repositories to your Open-Xchange yum configuration:<br />
<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|backend}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=rhelname|pc2v=RHEL6|drive-help}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|backend/updates|drive|updater|updater/updates}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive-help/updates}}<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-drive open-xchange-drive-comet open-xchange-drive-restricted open-xchange-updater-drive<br />
<br />
=== Debian GNU/Linux 6.0 ===<br />
<br />
If not already done, add the following repositories to your Open-Xchange apt configuration:<br />
<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianSqueeze|backend}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=debianname|pc2v=DebianSqueeze|drive-help}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianSqueeze|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|backend/updates|drive|updater|updater/updates}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=debianname|pc2v=DebianSqueeze|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive-help/updates}}<br />
and run<br />
<br />
$ apt-get update<br />
$ apt-get install open-xchange-drive open-xchange-drive-comet open-xchange-drive-restricted open-xchange-updater-drive<br />
<br />
=== Debian GNU/Linux 7.0 ===<br />
<br />
If not already done, add the following repositories to your Open-Xchange apt configuration:<br />
<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianWheezy|backend}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=debianname|pc2v=DebianWheezy|drive-help}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianWheezy|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|backend/updates|drive|updater|updater/updates}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=debianname|pc2v=DebianWheezy|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive-help/updates}}<br />
and run<br />
<br />
$ apt-get update<br />
$ apt-get install open-xchange-drive open-xchange-drive-comet open-xchange-drive-restricted open-xchange-updater-drive<br />
<br />
=== SUSE Linux Enterprise Server 11 ===<br />
<br />
Add the package repository using zypper if not already present:<br />
<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLES11|backend}}<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=susename|pc2v=SLES11|drive-help}}<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLES11|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|backend/updates|drive|updater|updater/updates}}<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=susename|pc2v=SLES11|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive-help/updates}}<br />
<br />
and run<br />
<br />
$ zypper ref<br />
$ zypper in open-xchange-drive open-xchange-drive-comet open-xchange-drive-restricted open-xchange-updater-drive<br />
<br />
=== OX Server Edition / App Suite for UCS ===<br />
<br />
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.<br />
<br />
* The new license is already registered at the LDB after purchase.<br />
* Log on at the Univention Management Console (UMC)<br />
* Make sure, that the correct LDB account has been selected in the UMC module "OX License Management"<br />
* Click on "App Center" at the UMC und switch to the tab "Repository Settings"<br />
* Within the component list, select "Open-Xchange Drive" and press the "Install" button<br />
<br />
== Configuration ==<br />
<br />
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 client applications.<br />
<br />
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 client notifications, see next chapters). Please refer to the inline documentation of the configuration file for more advanced options. <br />
<br />
=== Push via Google Cloud Messaging (GCM) ===<br />
<br />
The OX Drive application for Android devices is able to receive Push notifications from the Open-Xchange Server via [http://developer.android.com/google/gcm/index.html Google Cloud Messaging (GCM)]. To issue those Push messages, the backend needs to be provided with a suitable API key for the corresponding Android client application. The API key is included in the restricted components installation package ''open-xchange-drive-restricted'' for the "vanilla" Android client application. Alternatively, the key can be specified directly in the ''drive.properties'' configuration file:<br />
<br />
# Specifies the API key of the server application. Required if <br />
# "com.openexchange.drive.events.gcm.enabled" is "true" and the package <br />
# containing the restricted drive components is not installed.<br />
com.openexchange.drive.events.gcm.key=<br />
<br />
Push via GCM can be enabled via:<br />
<br />
# Enables or disables push event notifications to clients using the Google<br />
# Cloud Messaging (GCM) service. This requires a valid configuration for the <br />
# GCM API key, see options below. Defaults to "false". <br />
com.openexchange.drive.events.gcm.enabled=true<br />
<br />
Please note that push via GCM needs to be enabled explicitly - also if ''open-xchange-drive-restricted'' is installed.<br />
<br />
=== Push via Apple Push Notification service (APNs) ===<br />
<br />
The OX Drive application for iOS and Mac OS 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 Mac OS desktop client and the iOS mobile client are served separately with different certificates, so that both needs to be configured independantly. The required certificates are already included in the restricted components installation package ''open-xchange-drive-restricted'' for the "vanilla" iOS and Mac OS client applications. Alternatively, the 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:<br />
<br />
# Specifies the path to the local keystore file (PKCS #12) containing the APNS <br />
# certificate and keys for the iOS application, e.g. <br />
# "/opt/open-xchange/etc/drive-apns.p12". Required if <br />
# "com.openexchange.drive.events.apn.enabled" is "true" and the package <br />
# containing the restricted drive components is not installed.<br />
com.openexchange.drive.events.apn.ios.keystore=<br />
<br />
This file is opened by the backend using the password as supplied via: <br />
<br />
# Specifies the password used when creating the referenced keystore containing<br />
# the certificate of the iOS application. Note that blank or null passwords <br />
# are in violation of the PKCS #12 specifications. Required if <br />
# "com.openexchange.drive.events.apn.enabled" is "true" and the package <br />
# containing the restricted drive components is not installed.<br />
com.openexchange.drive.events.apn.ios.password=<br />
<br />
Configuration also allows to swith between development and production environments, however, this setting should be ''true'' normally:<br />
<br />
# Indicates which APNS service is used when sending push notifications to iOS<br />
# devices. A value of "true" will use the production service, a value of <br />
# "false" the sandbox service. Defaults to "true".<br />
com.openexchange.drive.events.apn.ios.production=true<br />
<br />
The OX backend contacts the APNs servers from time to time to get informed about clients no longer reachable clients where the applications was uninstalled. The interval can be defined with the following setting: <br />
<br />
# Configures the interval between queries to the APN feedback service for the<br />
# subscribed iOS devices. The value can be defined using units of measurement: <br />
# "D" (=days), "W" (=weeks) and "H" (=hours). Defaults to "1D" (one day). <br />
# Leaving this parameter empty disables the feedback queries on this node. <br />
# Since each received feedback is processed cluster-wide, only one node in the <br />
# cluster should be enabled here. <br />
com.openexchange.drive.events.apn.ios.feedbackQueryInterval=1D<br />
<br />
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:<br />
<br />
# Enables or disables push event notifications to clients using the Apple Push<br />
# Notification service (APNS) for Mac OS devices. This requires a valid <br />
# configuration for the APNS certificate and keys, see either options below, <br />
# or install the restricted components packages for drive. Defaults to <br />
# "false". <br />
com.openexchange.drive.events.apn.ios.enabled=false<br />
<br />
As stated above, configuration for Push notifications via APN for the Mac OS 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.<br />
<br />
=== Further Configuration ===<br />
<br />
* The backend component of OX Drive supplies the clients 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''.<br />
* 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 clients. Therefore, ''com.openexchange.http.grizzly.hasCometEnabled'' needs to be set to ''true'' in ''grizzly.properties''.<br />
<br />
= Enabling OX Drive for Users =<br />
<br />
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:<br />
<br />
# Enables or disables the "drive" module capability globally. The capability<br />
# can also be set more fine-grained via config cascade. Per default it is only<br />
# enabled for users that have the "infostore" permission set. This is configured<br />
# in /opt/open-xchange/etc/contextSets/drive.yml.<br />
com.openexchange.capability.drive=false<br />
<br />
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]].<br />
<br />
= Installation of the Clients =<br />
<br />
== Installation of Mac OS X Desktop Client ==<br />
<br />
The OX Drive for Mac OS X will be provided via the Apple App Store:<br />
<br />
* https://itunes.apple.com/app/ox-drive/id818195014?mt=12<br />
<br />
== Installation of Windows Desktop Client ==<br />
<br />
The OX Drive for Windows will be provided direct at the OX App Suite via the [[AppSuite:Open-Xchange_Updater|OX Updater]].<br />
<br />
== Installation on Mobile Clients ==<br />
<br />
The OX Drive App is available via the different App Stores:<br />
<br />
* iOS: https://itunes.apple.com/app/ox-drive/id798570177?mt=8<br />
<br />
* Android: https://play.google.com/store/apps/details?id=com.openexchange.drive.vanilla<br />
<br />
<br />
== Client Configuration and Deployment ==<br />
<br />
The user needs to enter the server URL and provide his username and password. Afterwards, client-specific settings may be configured. This includes the synchronization mode (All files / Favorites only) and Photostream settings on mobile devices, or the local root synchronization folder for the desktop applications. More information is available in the online documentation. <br />
<br />
After the initial synchronization is completed, all further changes are synchronized instantly across all devices.<br />
<br />
<br />
= FAQ =<br />
<br />
'''How to limit the maximum file size, a configured ''MAX_UPLOAD_SIZE'' seems to have no effect for uploads from OX Drive clients?'''<br />
<br />
This setting has no effect for files uploaded from OX Drive clients, since big uploads may also be processed via multiple requests in smaller chunks. We plan to offer a separate configuration option in a future release.<br />
<br />
'''There are strange files and folders on the backend, where do they come from, is it safe to delete them?'''<br />
<br />
To support chunked uploads, and to optimize the synchronization process, the synchronization logic may create various temporary files (''.drive'' directory and contained files). They only appear in the web interface if the setting ''Show hidden files and folders'' is enabled, and are removed automatically if not accessed for a specific period (default: 1 day).<br />
<br />
'''Not all files and folders get synchronized. Are there any restrictions?'''<br />
<br />
Yes, please consult the online help for a detailed list of excluded files and folders.<br />
<br />
'''How do I synchronize a shared or public folder?'''<br />
<br />
Currently, only the synchronization of a single root folder (and all of it's subfolders) is possible. For the mobile client applications, this is always the default personal drive folder of the user, while the desktop clients allow to choose which folder to synchronize. The synchronization of multiple root folders is scheduled for a future release.</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:OX_Drive&diff=19241
AppSuite:OX Drive
2015-03-16T11:20:20Z
<p>Sonja.krause-harder: </p>
<hr />
<div>= OX Drive =<br />
<br />
In OX App Suite, Open-Xchange provides a cloud storage called OX Drive. It provides file- and folder synchronization across multiple devices in the most 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 client setup.<br />
<br />
== Key features ==<br />
<br />
* Native Apps for Windows, Mac OS, iOS and Android<br />
* Easy and attractive upsell properties (e.g. Upsell based on Quota limitations)<br />
* Clients are specially designed for the devices they run on taking into account limitations such as battery life, screen limitations, bandwidth etc.<br />
* Controlled synchronization of files across devices<br />
* Storage management (e.g. quota control, upload limits)<br />
* Connection type recognition and adaptation (e.g. Wi-Fi, cell network)<br />
<br />
== Availability ==<br />
<br />
OX Drive is a combination of two components:<br />
* OX Drive in OX App Suite<br />
* OX Drive Clients (optional native client components for synchronization)<br />
<br />
OX Drive is available for the following native clients:<br />
* OX Drive for Windows<br />
* OX Drive for Mac OS<br />
* OX Drive for iOS<br />
* OX Drive for Android<br />
<br />
== Requirements ==<br />
<br />
You will find the requirements under [[AppSuite:OX_System_Requirements#OX_Drive_for_Clients|OX Drive Client and Platform Requirements]]<br />
<br />
= Server-side Installation and Configuration =<br />
<br />
This chapter describes how the backend components of OX Drive are installed and configured on the server.<br />
<br />
== Prerequisites ==<br />
<br />
* Open-Xchange Server v7.4.2 and above (''open-xchange-core'')<br />
* Grizzly HTTP connector (''open-xchange-grizzly''), see [[AppSuite:Grizzly]] for details, with ''Comet'' support enabled in ''grizzly.properties''<br />
* Valid Push-Certificates / API keys for cloud-based notifications, see configuration below<br />
* Enabled Hazelcast for inter-OX-communication, see [[AppSuite:Running_a_cluster]] for details<br />
<br />
== Available packages ==<br />
<br />
Open-Xchange Drive is available with the following backend packages:<br />
<br />
* ''open-xchange-drive'' - The main server components for OX Drive<br />
* ''open-xchange-drive-comet'' - Provides the Push interface via long-polling for the desktop clients<br />
* ''open-xchange-updater-drive'' - Adds the OX Drive application to the Windows desktop auto-updater<br />
* ''open-xchange-appsuite-help-drive-*'' - Online help in various languages for the OX Drive applications<br />
* ''open-xchange-drive-restricted'' - Restricted components, including prerequisites for cloud-based push notifications<br />
<br />
Installation on the server varies depending on the underlying distribution, details are available in the following chapters.<br />
<br />
=== Redhat Enterprise Linux 6 or CentOS 6 ===<br />
<br />
If not already done, add the following repositories to your Open-Xchange yum configuration:<br />
<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|backend}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=rhelname|pc2v=RHEL6|drive-help}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|backend/updates|drive|updater|updater/updates}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive-help/updates}}<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-drive open-xchange-drive-comet open-xchange-drive-restricted open-xchange-updater-drive<br />
<br />
=== Debian GNU/Linux 6.0 ===<br />
<br />
If not already done, add the following repositories to your Open-Xchange apt configuration:<br />
<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianSqueeze|backend}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=debianname|pc2v=DebianSqueeze|drive-help}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianSqueeze|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|backend/updates|drive|updater|updater/updates}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=debianname|pc2v=DebianSqueeze|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive-help/updates}}<br />
and run<br />
<br />
$ apt-get update<br />
$ apt-get install open-xchange-drive open-xchange-drive-comet open-xchange-drive-restricted open-xchange-updater-drive<br />
<br />
=== Debian GNU/Linux 7.0 ===<br />
<br />
If not already done, add the following repositories to your Open-Xchange apt configuration:<br />
<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianWheezy|backend}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=debianname|pc2v=DebianWheezy|drive-help}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianWheezy|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|backend/updates|drive|updater|updater/updates}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=debianname|pc2v=DebianWheezy|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive-help/updates}}<br />
and run<br />
<br />
$ apt-get update<br />
$ apt-get install open-xchange-drive open-xchange-drive-comet open-xchange-drive-restricted open-xchange-updater-drive<br />
<br />
=== SUSE Linux Enterprise Server 11 ===<br />
<br />
Add the package repository using zypper if not already present:<br />
<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLES11|backend}}<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=susename|pc2v=SLES11|drive-help}}<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLES11|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|backend/updates|drive|updater|updater/updates}}<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=susename|pc2v=SLES11|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive-help/updates}}<br />
<br />
and run<br />
<br />
$ zypper ref<br />
$ zypper in open-xchange-drive open-xchange-drive-comet open-xchange-drive-restricted open-xchange-updater-drive<br />
<br />
=== OX Server Edition / App Suite for UCS ===<br />
<br />
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.<br />
<br />
* The new license is already registered at the LDB after purchase.<br />
* Log on at the Univention Management Console (UMC)<br />
* Make sure, that the correct LDB account has been selected in the UMC module "OX License Management"<br />
* Click on "App Center" at the UMC und switch to the tab "Repository Settings"<br />
* Within the component list, select "Open-Xchange Drive" and press the "Install" button<br />
<br />
== Configuration ==<br />
<br />
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 client applications.<br />
<br />
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 client notifications, see next chapters). Please refer to the inline documentation of the configuration file for more advanced options. <br />
<br />
=== Push via Google Cloud Messaging (GCM) ===<br />
<br />
The OX Drive application for Android devices is able to receive Push notifications from the Open-Xchange Server via [http://developer.android.com/google/gcm/index.html Google Cloud Messaging (GCM)]. To issue those Push messages, the backend needs to be provided with a suitable API key for the corresponding Android client application. The API key is included in the restricted components installation package ''open-xchange-drive-restricted'' for the "vanilla" Android client application. Alternatively, the key can be specified directly in the ''drive.properties'' configuration file:<br />
<br />
# Specifies the API key of the server application. Required if <br />
# "com.openexchange.drive.events.gcm.enabled" is "true" and the package <br />
# containing the restricted drive components is not installed.<br />
com.openexchange.drive.events.gcm.key=<br />
<br />
Push via GCM can be enabled via:<br />
<br />
# Enables or disables push event notifications to clients using the Google<br />
# Cloud Messaging (GCM) service. This requires a valid configuration for the <br />
# GCM API key, see options below. Defaults to "false". <br />
com.openexchange.drive.events.gcm.enabled=true<br />
<br />
Please note that push via GCM needs to be enabled explicitly - also if ''open-xchange-drive-restricted'' is installed.<br />
<br />
=== Push via Apple Push Notification service (APNs) ===<br />
<br />
The OX Drive application for iOS and Mac OS 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 Mac OS desktop client and the iOS mobile client are served separately with different certificates, so that both needs to be configured independantly. The required certificates are already included in the restricted components installation package ''open-xchange-drive-restricted'' for the "vanilla" iOS and Mac OS client applications. Alternatively, the 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:<br />
<br />
# Specifies the path to the local keystore file (PKCS #12) containing the APNS <br />
# certificate and keys for the iOS application, e.g. <br />
# "/opt/open-xchange/etc/drive-apns.p12". Required if <br />
# "com.openexchange.drive.events.apn.enabled" is "true" and the package <br />
# containing the restricted drive components is not installed.<br />
com.openexchange.drive.events.apn.ios.keystore=<br />
<br />
This file is opened by the backend using the password as supplied via: <br />
<br />
# Specifies the password used when creating the referenced keystore containing<br />
# the certificate of the iOS application. Note that blank or null passwords <br />
# are in violation of the PKCS #12 specifications. Required if <br />
# "com.openexchange.drive.events.apn.enabled" is "true" and the package <br />
# containing the restricted drive components is not installed.<br />
com.openexchange.drive.events.apn.ios.password=<br />
<br />
Configuration also allows to swith between development and production environments, however, this setting should be ''true'' normally:<br />
<br />
# Indicates which APNS service is used when sending push notifications to iOS<br />
# devices. A value of "true" will use the production service, a value of <br />
# "false" the sandbox service. Defaults to "true".<br />
com.openexchange.drive.events.apn.ios.production=true<br />
<br />
The OX backend contacts the APNs servers from time to time to get informed about clients no longer reachable clients where the applications was uninstalled. The interval can be defined with the following setting: <br />
<br />
# Configures the interval between queries to the APN feedback service for the<br />
# subscribed iOS devices. The value can be defined using units of measurement: <br />
# "D" (=days), "W" (=weeks) and "H" (=hours). Defaults to "1D" (one day). <br />
# Leaving this parameter empty disables the feedback queries on this node. <br />
# Since each received feedback is processed cluster-wide, only one node in the <br />
# cluster should be enabled here. <br />
com.openexchange.drive.events.apn.ios.feedbackQueryInterval=1D<br />
<br />
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:<br />
<br />
# Enables or disables push event notifications to clients using the Apple Push<br />
# Notification service (APNS) for Mac OS devices. This requires a valid <br />
# configuration for the APNS certificate and keys, see either options below, <br />
# or install the restricted components packages for drive. Defaults to <br />
# "false". <br />
com.openexchange.drive.events.apn.ios.enabled=false<br />
<br />
As stated above, configuration for Push notifications via APN for the Mac OS 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.<br />
<br />
=== Further Configuration ===<br />
<br />
* The backend component of OX Drive supplies the clients 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''.<br />
* 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 clients. Therefore, ''com.openexchange.http.grizzly.hasCometEnabled'' needs to be set to ''true'' in ''grizzly.properties''.<br />
<br />
= Enabling OX Drive for Users =<br />
<br />
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:<br />
<br />
# Enables or disables the "drive" module capability globally. The capability<br />
# can also be set more fine-grained via config cascade. Per default it is only<br />
# enabled for users that have the "infostore" permission set. This is configured<br />
# in /opt/open-xchange/etc/contextSets/drive.yml.<br />
com.openexchange.capability.drive=false<br />
<br />
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]].<br />
<br />
= Installation of the Clients =<br />
<br />
== Installation of Mac OS X Desktop Client ==<br />
<br />
The OX Drive for Mac OS X will be provided via the Apple App Store:<br />
<br />
* https://itunes.apple.com/app/ox-drive/id818195014?mt=12<br />
<br />
== Installation of Windows Desktop Client ==<br />
<br />
The OX Drive for Windows will be provided direct at the OX App Suite via the [[AppSuite:Open-Xchange_Updater|OX Updater]].<br />
<br />
== Installation on Mobile Clients ==<br />
<br />
The OX Drive App is available via the different App Stores:<br />
<br />
* iOS: https://itunes.apple.com/app/ox-drive/id798570177?mt=8<br />
<br />
* Android: https://play.google.com/store/apps/details?id=com.openexchange.drive.vanilla<br />
<br />
<br />
== Client Configuration and Deployment ==<br />
<br />
The user needs to enter the server URL and provide his username and password. Afterwards, client-specific settings may be configured. This includes the synchronization mode (All files / Favorites only) and Photostream settings on mobile devices, or the local root synchronization folder for the desktop applications. More information is available in the online documentation. <br />
<br />
After the initial synchronization is completed, all further changes are synchronized instantly across all devices.<br />
<br />
<br />
= FAQ =<br />
<br />
'''How to limit the maximum file size, a configured ''MAX_UPLOAD_SIZE'' seems to have no effect for uploads from OX Drive clients?'''<br />
<br />
This setting has no effect for files uploaded from OX Drive clients, since big uploads may also be processed via multiple requests in smaller chunks. We plan to offer a separate configuration option in a future release.<br />
<br />
'''There are strange files and folders on the backend, where do they come from, is it safe to delete them?'''<br />
<br />
To support chunked uploads, and to optimize the synchronization process, the synchronization logic may create various temporary files (''.drive'' directory and contained files). They only appear in the web interface if the setting ''Show hidden files and folders'' is enabled, and are removed automatically if not accessed for a specific period (default: 1 day).<br />
<br />
'''Not all files and folders get synchronized. Are there any restrictions?'''<br />
<br />
Yes, please consult the online help for a detailed list of excluded files and folders.<br />
<br />
'''How do I synchronize a shared or public folder?'''<br />
<br />
Currently, only the synchronization of a single root folder (and all of it's subfolders) is possible. For the mobile client applications, this is always the default personal drive folder of the user, while the desktop clients allow to choose which folder to synchronize. The synchronization of multiple root folders is scheduled for a future release.</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:OX_Drive&diff=19240
AppSuite:OX Drive
2015-03-16T11:16:47Z
<p>Sonja.krause-harder: </p>
<hr />
<div>= OX Drive =<br />
<br />
In OX App Suite, Open-Xchange provides a cloud storage called OX Drive. It provides file- and folder synchronization across multiple devices in the most 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 client setup.<br />
<br />
== Key features ==<br />
<br />
* Native Apps for Windows, Mac OS, iOS and Android<br />
* Easy and attractive upsell properties (e.g. Upsell based on Quota limitations)<br />
* Clients are specially designed for the devices they run on taking into account limitations such as battery life, screen limitations, bandwidth etc.<br />
* Controlled synchronization of files across devices<br />
* Storage management (e.g. quota control, upload limits)<br />
* Connection type recognition and adaptation (e.g. Wi-Fi, cell network)<br />
<br />
== Availability ==<br />
<br />
OX Drive is a combination of two components:<br />
* OX Drive in OX App Suite<br />
* OX Drive Clients (optional native client components for synchronization)<br />
<br />
OX Drive is available for the following native clients:<br />
* OX Drive for Windows<br />
* OX Drive for Mac OS<br />
* OX Drive for iOS<br />
* OX Drive for Android<br />
<br />
== Requirements ==<br />
<br />
You will find the requirements under [[AppSuite:OX_System_Requirements#OX_Drive_for_Clients|OX Drive Client and Platform Requirements]]<br />
<br />
= Server-side Installation and Configuration =<br />
<br />
This chapter describes how the backend components of OX Drive are installed and configured on the server.<br />
<br />
== Prerequisites ==<br />
<br />
* Open-Xchange Server v7.4.2 and above (''open-xchange-core'')<br />
* Grizzly HTTP connector (''open-xchange-grizzly''), see [[AppSuite:Grizzly]] for details, with ''Comet'' support enabled in ''grizzly.properties''<br />
* Valid Push-Certificates / API keys for cloud-based notifications, see configuration below<br />
* Enabled Hazelcast for inter-OX-communication, see [[AppSuite:Running_a_cluster]] for details<br />
<br />
== Available packages ==<br />
<br />
Open-Xchange Drive is available with the following backend packages:<br />
<br />
* ''open-xchange-drive'' - The main server components for OX Drive<br />
* ''open-xchange-drive-comet'' - Provides the Push interface via long-polling for the desktop clients<br />
* ''open-xchange-updater-drive'' - Adds the OX Drive application to the Windows desktop auto-updater<br />
* ''open-xchange-appsuite-help-drive-*'' - Online help in various languages for the OX Drive applications<br />
* ''open-xchange-drive-restricted'' - Restricted components, including prerequisites for cloud-based push notifications<br />
<br />
Installation on the server varies depending on the underlying distribution, details are available in the following chapters.<br />
<br />
=== Redhat Enterprise Linux 6 or CentOS 6 ===<br />
<br />
If not already done, add the following repositories to your Open-Xchange yum configuration:<br />
<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|backend}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=rhelname|pc2v=RHEL6|drive-help}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|backend/updates|drive|updater|updater/updates}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive-help/updates}}<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-drive open-xchange-drive-comet open-xchange-drive-restricted open-xchange-updater-drive<br />
<br />
=== Debian GNU/Linux 6.0 ===<br />
<br />
If not already done, add the following repositories to your Open-Xchange apt configuration:<br />
<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianSqueeze|backend}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=debianname|pc2v=DebianSqueeze|drive-help}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianSqueeze|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|backend/updates|drive|updater|updater/updates}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/drive/stable|pc2n=debianname|pc2v=DebianSqueeze|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|drive-help/updates}}<br />
and run<br />
<br />
$ apt-get update<br />
$ apt-get install open-xchange-drive open-xchange-drive-comet open-xchange-drive-restricted open-xchange-updater-drive<br />
<br />
=== Debian GNU/Linux 7.0 ===<br />
<br />
If not already done, add the following repositories to your Open-Xchange apt configuration:<br />
<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianWheezy|backend}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianWheezy|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|backend/updates|drive|updater|updater/updates}}<br />
<br />
and run<br />
<br />
$ apt-get update<br />
$ apt-get install open-xchange-drive open-xchange-drive-comet open-xchange-drive-restricted open-xchange-updater-drive<br />
<br />
=== SUSE Linux Enterprise Server 11 ===<br />
<br />
Add the package repository using zypper if not already present:<br />
<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLES11|backend}}<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLES11|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|backend/updates|drive|updater|updater/updates}}<br />
<br />
and run<br />
<br />
$ zypper ref<br />
$ zypper in open-xchange-drive open-xchange-drive-comet open-xchange-drive-restricted open-xchange-updater-drive<br />
<br />
=== OX Server Edition / App Suite for UCS ===<br />
<br />
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.<br />
<br />
* The new license is already registered at the LDB after purchase.<br />
* Log on at the Univention Management Console (UMC)<br />
* Make sure, that the correct LDB account has been selected in the UMC module "OX License Management"<br />
* Click on "App Center" at the UMC und switch to the tab "Repository Settings"<br />
* Within the component list, select "Open-Xchange Drive" and press the "Install" button<br />
<br />
== Configuration ==<br />
<br />
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 client applications.<br />
<br />
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 client notifications, see next chapters). Please refer to the inline documentation of the configuration file for more advanced options. <br />
<br />
=== Push via Google Cloud Messaging (GCM) ===<br />
<br />
The OX Drive application for Android devices is able to receive Push notifications from the Open-Xchange Server via [http://developer.android.com/google/gcm/index.html Google Cloud Messaging (GCM)]. To issue those Push messages, the backend needs to be provided with a suitable API key for the corresponding Android client application. The API key is included in the restricted components installation package ''open-xchange-drive-restricted'' for the "vanilla" Android client application. Alternatively, the key can be specified directly in the ''drive.properties'' configuration file:<br />
<br />
# Specifies the API key of the server application. Required if <br />
# "com.openexchange.drive.events.gcm.enabled" is "true" and the package <br />
# containing the restricted drive components is not installed.<br />
com.openexchange.drive.events.gcm.key=<br />
<br />
Push via GCM can be enabled via:<br />
<br />
# Enables or disables push event notifications to clients using the Google<br />
# Cloud Messaging (GCM) service. This requires a valid configuration for the <br />
# GCM API key, see options below. Defaults to "false". <br />
com.openexchange.drive.events.gcm.enabled=true<br />
<br />
Please note that push via GCM needs to be enabled explicitly - also if ''open-xchange-drive-restricted'' is installed.<br />
<br />
=== Push via Apple Push Notification service (APNs) ===<br />
<br />
The OX Drive application for iOS and Mac OS 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 Mac OS desktop client and the iOS mobile client are served separately with different certificates, so that both needs to be configured independantly. The required certificates are already included in the restricted components installation package ''open-xchange-drive-restricted'' for the "vanilla" iOS and Mac OS client applications. Alternatively, the 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:<br />
<br />
# Specifies the path to the local keystore file (PKCS #12) containing the APNS <br />
# certificate and keys for the iOS application, e.g. <br />
# "/opt/open-xchange/etc/drive-apns.p12". Required if <br />
# "com.openexchange.drive.events.apn.enabled" is "true" and the package <br />
# containing the restricted drive components is not installed.<br />
com.openexchange.drive.events.apn.ios.keystore=<br />
<br />
This file is opened by the backend using the password as supplied via: <br />
<br />
# Specifies the password used when creating the referenced keystore containing<br />
# the certificate of the iOS application. Note that blank or null passwords <br />
# are in violation of the PKCS #12 specifications. Required if <br />
# "com.openexchange.drive.events.apn.enabled" is "true" and the package <br />
# containing the restricted drive components is not installed.<br />
com.openexchange.drive.events.apn.ios.password=<br />
<br />
Configuration also allows to swith between development and production environments, however, this setting should be ''true'' normally:<br />
<br />
# Indicates which APNS service is used when sending push notifications to iOS<br />
# devices. A value of "true" will use the production service, a value of <br />
# "false" the sandbox service. Defaults to "true".<br />
com.openexchange.drive.events.apn.ios.production=true<br />
<br />
The OX backend contacts the APNs servers from time to time to get informed about clients no longer reachable clients where the applications was uninstalled. The interval can be defined with the following setting: <br />
<br />
# Configures the interval between queries to the APN feedback service for the<br />
# subscribed iOS devices. The value can be defined using units of measurement: <br />
# "D" (=days), "W" (=weeks) and "H" (=hours). Defaults to "1D" (one day). <br />
# Leaving this parameter empty disables the feedback queries on this node. <br />
# Since each received feedback is processed cluster-wide, only one node in the <br />
# cluster should be enabled here. <br />
com.openexchange.drive.events.apn.ios.feedbackQueryInterval=1D<br />
<br />
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:<br />
<br />
# Enables or disables push event notifications to clients using the Apple Push<br />
# Notification service (APNS) for Mac OS devices. This requires a valid <br />
# configuration for the APNS certificate and keys, see either options below, <br />
# or install the restricted components packages for drive. Defaults to <br />
# "false". <br />
com.openexchange.drive.events.apn.ios.enabled=false<br />
<br />
As stated above, configuration for Push notifications via APN for the Mac OS 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.<br />
<br />
=== Further Configuration ===<br />
<br />
* The backend component of OX Drive supplies the clients 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''.<br />
* 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 clients. Therefore, ''com.openexchange.http.grizzly.hasCometEnabled'' needs to be set to ''true'' in ''grizzly.properties''.<br />
<br />
= Enabling OX Drive for Users =<br />
<br />
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:<br />
<br />
# Enables or disables the "drive" module capability globally. The capability<br />
# can also be set more fine-grained via config cascade. Per default it is only<br />
# enabled for users that have the "infostore" permission set. This is configured<br />
# in /opt/open-xchange/etc/contextSets/drive.yml.<br />
com.openexchange.capability.drive=false<br />
<br />
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]].<br />
<br />
= Installation of the Clients =<br />
<br />
== Installation of Mac OS X Desktop Client ==<br />
<br />
The OX Drive for Mac OS X will be provided via the Apple App Store:<br />
<br />
* https://itunes.apple.com/app/ox-drive/id818195014?mt=12<br />
<br />
== Installation of Windows Desktop Client ==<br />
<br />
The OX Drive for Windows will be provided direct at the OX App Suite via the [[AppSuite:Open-Xchange_Updater|OX Updater]].<br />
<br />
== Installation on Mobile Clients ==<br />
<br />
The OX Drive App is available via the different App Stores:<br />
<br />
* iOS: https://itunes.apple.com/app/ox-drive/id798570177?mt=8<br />
<br />
* Android: https://play.google.com/store/apps/details?id=com.openexchange.drive.vanilla<br />
<br />
<br />
== Client Configuration and Deployment ==<br />
<br />
The user needs to enter the server URL and provide his username and password. Afterwards, client-specific settings may be configured. This includes the synchronization mode (All files / Favorites only) and Photostream settings on mobile devices, or the local root synchronization folder for the desktop applications. More information is available in the online documentation. <br />
<br />
After the initial synchronization is completed, all further changes are synchronized instantly across all devices.<br />
<br />
<br />
= FAQ =<br />
<br />
'''How to limit the maximum file size, a configured ''MAX_UPLOAD_SIZE'' seems to have no effect for uploads from OX Drive clients?'''<br />
<br />
This setting has no effect for files uploaded from OX Drive clients, since big uploads may also be processed via multiple requests in smaller chunks. We plan to offer a separate configuration option in a future release.<br />
<br />
'''There are strange files and folders on the backend, where do they come from, is it safe to delete them?'''<br />
<br />
To support chunked uploads, and to optimize the synchronization process, the synchronization logic may create various temporary files (''.drive'' directory and contained files). They only appear in the web interface if the setting ''Show hidden files and folders'' is enabled, and are removed automatically if not accessed for a specific period (default: 1 day).<br />
<br />
'''Not all files and folders get synchronized. Are there any restrictions?'''<br />
<br />
Yes, please consult the online help for a detailed list of excluded files and folders.<br />
<br />
'''How do I synchronize a shared or public folder?'''<br />
<br />
Currently, only the synchronization of a single root folder (and all of it's subfolders) is possible. For the mobile client applications, this is always the default personal drive folder of the user, while the desktop clients allow to choose which folder to synchronize. The synchronization of multiple root folders is scheduled for a future release.</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=Template:Oxinstaller&diff=19129
Template:Oxinstaller
2015-02-26T14:47:02Z
<p>Sonja.krause-harder: </p>
<hr />
<div>'''Important:''' You should have your Open-Xchange license code at hand. If you do not plan to license Open-Xchange, you can use the option ''--no-license'' instead. Please also check [[OXReportClient]] documentation for more information about configuring a supported and maintained Open-Xchange server.<br />
<br />
'''Important:''' For MAX_MEMORY_FOR_JAVAVM a rule of thumb for simple installations is half available system memory. The value must be in MB. For example "1024" for 1GB .<br />
<br />
$ /opt/open-xchange/sbin/oxinstaller --add-license=YOUR-OX-LICENSE-CODE \<br />
--servername=oxserver --configdb-pass=db_password \<br />
--master-pass=admin_master_password {{#ifeq: {{{connector}}} | http |--network-listener-host|--ajp-bind-port}}=localhost --servermemory MAX_MEMORY_FOR_JAVAVM<br />
<br />
'''Note:''' In a clustered setup, <tt>{{#ifeq: {{{connector}}} | http |--network-listener-host|--ajp-bind-port}}</tt> must be set to <tt>*</tt><br />
<br />
Now is a good time to configure the way OX will authenticate to your mail server. Edit the file /opt/open-xchange/etc/mail.properties and change the com.openexchange.mail.loginSource to use. This is very important for servers that require your full email address to log in with.<br />
<br />
# adjust com.openexchange.mail.loginSource<br />
$ vim /opt/open-xchange/etc/mail.properties</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:Versioning_and_Numbering&diff=19128
AppSuite:Versioning and Numbering
2015-02-26T14:42:16Z
<p>Sonja.krause-harder: /* 2015 */ add messenger release</p>
<hr />
<div>=Versioning and Numbering of Open-Xchange Products=<br />
<br />
== Abbreviations ==<br />
<br />
The Open-Xchange versioning 2015 will be structured in the following way:<br><br><br />
'''<generation>.<major release>.<minor release> Rev<build number>'''<br><br />
<br />
{| border="1" cellpadding="3" cellspacing="0"<br />
!align="left" |Abbreviation<br />
!align="left" |Meaning<br />
!align="left" |Comparison<br />
|-<br />
|<generation><br />
|The first number is the product generation number. A new generation may contain new architecture, different technology and many more.<br />
|<font color="#008000">OX App Suite 7</font><font color="#FF0000"></font><br />
|-<br />
|<major release><br />
|The second version number (major release) indicates significant program changes in terms of added functionality. Major changes to design and enhancements of APIs are possible. All APIs shall be backward compatible, which means, that mainly new functions can be added. If Open-Xchange releases a new major release this will be an even number, unstable interim releases have odd numbers.<br />
|<font color="#008000">OX App Suite v7.6</font><font color="#FF0000"> </font><br />
|-<br />
|<minor release><br />
|The third version number (minor releases) indicates an update with consolidated bug fixes and non-intrusive feature enhancements. APIs and database will not be changed if this can be avoided. All changes must be backward compatible.<br />
|<font color="#008000">OX App Suite v7.6.1</font><font color="#FF0000"></font><br />
|-<br />
|<build number><br />
|The Rev-number (Revision) shows the progress of the development in single steps<br />
|<font color="#008000">OX App Suite v7.6.1-Rev3</font><font color="#FF0000"></font><br />
|-<br />
|<br />
|<br />
|<br />
|-<br />
|Public Patch Release / Patch Release<br />
|A Public Patch Release enables Open-Xchange to publish a feature together with a patch. This in turn enables Open-Xchange to react more flexibly to time requests for certain features, thus relieving minor releases and making it possible to shift them. Delivering a feature with a Public Patch Release requires:<br />
* It can be implemented without far-reaching side effects. This is especially true for features that are implemented as plug-ins. To a limited extend, features affecting a limited sub set of core functionality can be included. Technical pragmatism is fine to reach the goal (e.g., copy & paste of functionality instead of abstraction into a service). This pragmatism has to be leveled out though as soon as the feature is ported into a more flexible branch. <br />
*It can be deactivated and is deactivated by default. If a customer installs a Public Patch Release, the familiar feature set does not change. Only if explicitly activating the enhanced features, will they be available to the end user.<br />
*If features require changes to the data base schema or configuration files, they have to be developed in such a way that they do not impair the running system.<br />
*Side-effects of Public Patch Releases are evaluated by the respective developers. Together with the QA team, they make a test plan for checking for those side effects and other effects. <br />
|<br />
|}<br />
<br><br />
<br />
== Release Levels of Open-Xchange ==<br />
<br />
{| border="1" cellpadding="3" cellspacing="0"<br />
!align="left" |<font color="#008000">OX Release Level (new)<br />
!align="left" |<font color="#008000">New Generation<br />
!align="left" |<font color="#008000">Major Release<br />
!align="left" |<font color="#008000">Minor Release<br />
!align="left" |<font color="#008000">Patch Release<br />
!align="left" |<font color="#008000">Public Patch Release<br />
|-<br />
|'''Target Audience'''<br />
|All<br />
|Public/All<br />
|Maintenance customers & Partners<br />
|L3 Support Customers, Value Package Partners<br />
|Public/All<br />
|-<br />
|'''Purpose'''<br />
|Provide new technologies<br />
|Provide functional enhancements including Bug Fixes, accumulate earlier Patch Releases's/ major releases<br />
|Provide common bug fixes for all customers, accumulate previous Patch Release's<br />
|Provide fixes for severity level 1/2 tickets, for a specific Support Customer, small features, temporary until next Maintenance Release accumulative<br />
|Provide fixes for severity level 1/2 tickets, for all Support Customer, small features, temporary until next Maintenance Release accumulative<br />
|-<br />
|'''Frequency'''<br />
|Open-Xchange Roadmap<br />
|Decided by Open-Xchange<br />
|Decided by Open-Xchange<br />
|According to SLA<br />
|As soon as required<br />
|-<br />
|'''[[AppSuite:Version_Support_Committment|Support Committment]]'''<br />
|5 years after First Customer Shippment (FCS)<br />
|6 months after FCS (Latest Minor Release at the Major-Release cycle will be official supported)<br />
|Last Minor Release of a supported Major Release<br />
|Next (Public) Patch Release<br />
|Next Public Patch Release<br />
|-<br />
|'''Requested by'''<br />
|Product Management<br />
|Product Management, Professional Services<br />
|Support, QA, Product Management, Professional Services<br />
|Entitled Customer (Support, Professional Services)<br />
|Entitled Customer (Support, Professional Services), Product Management<br />
|-<br />
|'''Compatibility requirements/backward compatibility'''<br />
|<br />
|Database updates, Changes of configuration files<br />
|Backward compatibility to last major release. In urgent cases there could be database updates or configuration file changes<br />
|Backward compatibility to last major release<br />
|Backward compatibility to last major release<br />
|-<br />
|'''Test Efforts OX (QA)'''<br />
|Smoke Tests, Always Tests, Bug Fix Tests, Feature Tests, Dependencies Tests, Heuristic Tests, Performance Tests<br />
|Smoke Tests, Always Tests, Bug Fix Tests, Feature Tests, Dependencies Tests, Heuristic Tests, Performance Tests<br />
|Smoke Test, Always Tests, Bug Fix Tests, Dependencies Tests, Heuristic Tests, Performance Tests<br />
|Smoke Tests, Always Tests, Bug Fix Tests - Support: Fix Approval<br />
|Smoke Tests, Always Tests, Bug Fix Tests - Fix Approval<br />
|-<br />
|'''Test Efforts Customer/Partner'''<br />
|Smoke Tests, Bug Fix Tests, New Feature Tests, Integration Tests<br />
|Smoke Tests, Bug Fix Tests, New Feature Tests, Integration Tests<br />
|Smoke Tests, Bug Fix Tests, Integration Tests<br />
|Smoke Tests, Bug Fix Approval<br />
|Smoke Tests<br />
|-<br />
|}<br />
<br><br />
<br />
== Open-Xchange Server 6 ==<br />
<br />
=== Editions ===<br />
{| border="1" cellpadding="3" cellspacing="0"<br />
!align="left" width="50"|Abbreviation<br />
!align="left" width="200"|Description<br />
!align="left" |Target usage<br />
|-<br />
|OX:HE<br />
|Open-Xchange Hosting Edition<br />
|Designed for organizations that want to provide a scalable, multi-tenant e-mail and collaboration solution to their customers. Focus: Software-as-a-Service offerings<br />
|-<br />
|OX:SE<br />
|Open-Xchange Server Edition<br />
|Designed for medium and large size organizations, educational institutions and public administrations seeking a customizable communication solution. Focus: System Integrators<br />
|-<br />
|OX:SEforUCS<br />
|Open-Xchange Server Edition for Univention Corporate Server<br />
|Integration to in-house customer environments<br />
|}<br />
<br />
== Open-Xchange App Suite ==<br />
<br />
=== Editions ===<br />
{| border="1" cellpadding="3" cellspacing="0"<br />
!align="left" width="50"|Abbreviation<br />
!align="left" width="200"|Description<br />
!align="left" |Target usage<br />
|-<br />
|OX App Suite<br />
|Open-Xchange App Suite Community Version<br />
|Need to revitalize business growth and increase your competitive advantage? OX App Suite integrates smoothly into existing infrastructures and massively scales across multi-tenant architectures securely and reliably. Offer your users a seamless messaging experience to deliver branded, app-economy services and take back the user experience. German engineered and designed for a mobile world, OX App Suite uses open API's to deliver device independent access to email and messaging, social collaboration and digital media via a rich web-based interface. Through a modular App-based portal, HTML5 interoperability gives providers a new basis to up-sell and cross-sell white-labeled services and mobile applications.<br />
|}<br />
<br />
== Releases ==<br />
<br />
===[http://oxpedia.org/wiki/index.php?title=Versioning_and_Numbering_2007 2007]===<br />
<br />
===[http://oxpedia.org/wiki/index.php?title=Versioning_and_Numbering_2008 2008]===<br />
<br />
===[http://oxpedia.org/wiki/index.php?title=Versioning_and_Numbering_2009 2009]===<br />
<br />
===[http://oxpedia.org/wiki/index.php?title=Versioning_and_Numbering_2010 2010]===<br />
<br />
===[http://oxpedia.org/wiki/index.php?title=Versioning_and_Numbering_2011 2011]===<br />
<br />
===[http://oxpedia.org/wiki/index.php?title=Versioning_and_Numbering_2012 2012]===<br />
<br />
===[http://oxpedia.org/wiki/index.php?title=Versioning_and_Numbering_2013 2013]===<br />
<br />
===[http://oxpedia.org/wiki/index.php?title=Versioning_and_Numbering_2014 2014]===<br />
<br />
===2015 ===<br />
<br />
'''Please Note: Minor and Major Product Releases in bold'''<br />
<br />
{| border="1" cellpadding="3" cellspacing="0"<br />
!align="left" |GA<br />
!align="left" |Product<br />
!align="left" |Major Release<br />
!align="left" |Minor Release<br />
!align="left" |Public Patch Releases<br />
!align="left" |Shipped Packages<br />
|-<br />
|2015-01-12<br />
|OX App Suite / OX 6 Backend v7.4.2<br />
|<br />
|<br />
|[[File:check.gif]]<br />
|Open-Xchange App Suite / OX 6 backend backend 7.4.2-rev42<br />
|-<br />
|2015-01-12<br />
|OX App Suite / OX 6 Backend v7.6.0<br />
|<br />
|<br />
|[[File:check.gif]]<br />
|Open-Xchange App Suite / OX 6 backend 7.6.0-rev36<br />
|-<br />
|2015-01-12<br />
|OX App Suite / OX 6 Backend v7.6.1<br />
|<br />
|<br />
|[[File:check.gif]]<br />
|Open-Xchange App Suite / OX 6 backend v7.6.1-rev14<br>Open-Xchange App Suite frontend v7.6.1-rev11<br>Open-Xchange Documentconverter v7.6.1-rev7<br />
|-<br />
|2015-01-14<br />
|OX Guard v1.2.0<br />
|<br />
|[[File:check.gif]]<br />
|<br />
|Open-Xchange Guard backend 1.2.0-rev4<br>Open-Xchange Guard frontend 1.2.0-rev3<br />
|-<br />
|2015-01-22<br />
|OX Documents v7.6.1 & OX Guard v1.2.0 for Univention Corporate Server<br />
|<br />
|[[File:check.gif]]<br />
|<br />
|OX Documents office-web v7.6.1-10<br>OX Documents office v7.6.1-9<br>OX Documents calcengine v7.6.1-9<br>Open-Xchange Guard backend 1.2.0-rev4<br>Open-Xchange Guard frontend 1.2.0-rev3<br />
|-<br />
|2015-01-27<br />
|OX App Suite / OX 6 Backend v7.6.1 / OX Documents v7.6.1<br />
|<br />
|<br />
|[[File:check.gif]]<br />
|Open-Xchange App Suite / OX 6 backend v7.6.1-rev16<br>Open-Xchange App Suite frontend v7.6.1-rev12<br>Open-Xchange App Suite USM v7.6.1-rev8<br>OX Documents App Suite office-web v7.6.1-11<br />
|-<br />
|2015-02-02<br />
|OX Guard v1.2.0<br />
|<br />
|<br />
|[[File:check.gif]]<br />
|Open-Xchange Guard backend 1.2.0-rev5<br />
|-<br />
|2015-02-09<br />
|OX App Suite v7.6.1 / OX 6 Backend v7.6.1<br />
|<br />
|<br />
|[[File:check.gif]]<br />
|Open-Xchange App Suite / OX 6 backend v7.6.1-rev18<br>Open-Xchange App Suite frontend v7.6.1-rev14<br />
|-<br />
|2015-02-10<br />
|OX App Suite Frontend v7.6.1 <br />
|<br />
|<br />
|[[File:check.gif]]<br />
|Open-Xchange App Suite frontend v7.6.1-rev15<br />
|-<br />
|2015-02-13<br />
|OX Connector for Business Mobility <br />
|<br />
|<br />
|[[File:check.gif]]<br />
|Open-Xchange App Suite EAS 7.6.1-rev8<br />
|-<br />
|2015-02-25<br />
|OX Messenger v1.0.0<br />
|[[File:check.gif]]<br />
|<br />
|<br />
|Open-Xchange Messenger v1.0.0-rev13<br />
|}<br />
<br />
==Maintenance expires==<br />
<br />
{| border="1" cellpadding="3" cellspacing="0"<br />
!align="left" |Product-, Release- and Component Name<br />
!align="left" |Planned Maintance expires<br />
|-<br />
|Starting with release v7.6.1, Open-Xchange supports Apple iOS 8 for mobile and tablet devices. Open-Xchange will discontinue support for Apple iOS 6 with the next minor release of OX App Suite, v7.6.2, planned for Q1 2015.<br />
|v7.6.2, planned for Q1 2015<br />
|-<br />
|Starting with release v7.6.1, Open-Xchange will support the new Apple Mac OS X 10.10 Yosemite (after the final launch) for Calendar/Contact synchronization and OX Drive. Open-Xchange will discontinue support for Apple Mac OS X 10.8 Mountain Lion with the next minor release of OX App Suite, v7.6.2, planned for Q1 2015.<br />
|v7.6.2, planned for Q1 2015<br />
|-<br />
|Open-Xchange will discontinue support for Debian Squeeze (Debian 6) with the next major release of OX App Suite v7.8.0, planned for Q2 2015. We encourage administrators to update to the latest operating system version of Debian.<br />
|v7.8.0, planned for Q2 2015<br />
|-<br />
|With the v7.8.0 release, Open-Xchange will discontinue support for the Random Token login method (sometimes also called Easy Login). Specifically, this means that the "login?action=redirect" call (see http://oxpedia.org/wiki/index.php?title=HTTP_API#Redirect) will be removed. Furthermore, the "com.openexchange.ajax.login.randomToken" setting will be removed from the "login.properties" file, and the "login?action=login" call will never contain the "random" token. We strongly encourage users of the Random Token login method to change their custom login implementations and use one of the supported methods.<br />
|v7.8.0, planned for Q2 2015<br />
|}<br />
<br />
==Maintenance expired (Archive)==<br />
<br />
{| border="1" cellpadding="3" cellspacing="0"<br />
!align="left" |Product-, Release- and Component Name<br />
!align="left" |Maintance expired<br />
|-<br />
|Open-Xchange discontinued support of all old Android stock browsers on mobile and tablet devices with the release of OX App Suite v7.6.1. OX App Suite is only supported on the new official stock browser, Chrome on Android.<br />
|Since OX App Suite v7.6.1: 2014-10-15<br />
|-<br />
|Support for AJP based communication between the HTTP server and the OX backend server. Open-Xchange already provides a new HTTP connector which is based on the Grizzly project. Download and configuration instructions are available at http://oxpedia.org/wiki/index.php?title=AppSuite:Grizzly<br />
|Since OX App Suite v7.6.0: 2014-06-25<br />
|-<br />
|Open-Xchange discontinued OX App Suite web frontend support for Internet Explorer 9 with the major release of OX App Suite v7.6.0.<br />
|Since OX App Suite v7.6.0: 2014-06-25<br />
|-<br />
|Open-Xchange discontinued Open-Xchange Server 6 and OX App Suite calendar and contact synchronization (CalDAV/CardDAV) support for Mac OS X 10.6 (Snow Leopard) and Mac OS X 10.7 (Lion) with the major release of OX App Suite v7.6.0.<br />
|Since OX App Suite v7.6.0: 2014-06-25<br />
|-<br />
|Open-Xchange discontinued Connector for Business Mobility support for Windows Mobile 6, 6.5, Symbian (Mail for Exchange 3.x), Apple iPhone iOS 5 and Blackberry with the major release of OX App Suite v7.6.0.<br />
|Since OX App Suite v7.6.0: 2014-06-25<br />
|-<br />
|With OX App Suite v7.4.2, the name of the “Files” app was changed to “Drive”. As part of our product strategy we developed clients for different desktop and mobile devices to provide improved file handling and synchronization.<br />
|Since OX App Suite v7.4.2: 2014-02-11<br />
|-<br />
|Debian 7 (Wheezy) was released by the Debian project on May 4th 2013. Both OX App Suite and Open-Xchange Server 6 support Debian 7 with OpenJDK 7 and MySQL 5.5 with this release of OX App Suite. Please note that the combination Debian 7 / OpenJDK 6 or Sun Java 6 will not be supported as a platform by Open-Xchange.<br />
|Since OX App Suite v7.4.0: 2013-09-26<br />
|-<br />
|Open-Xchange discontinued support for the currently available "showruntimestats" monitoring function (which fetches runtime information from the Java virtual machine and about the Open-Xchange Groupware backend). With OX App Suite v7.4.0, there is a new monitoring function using Jolokia for Open-Xchange. From v7.4.0 onwards, this is located inside the Open-Xchange Bundle and configured by jolokia.properties. Further information can be found at http://oxpedia.org/wiki/index.php?title=Jolokia<br />
|Since OX App Suite v7.4.0: 2013-09-26<br />
|-<br />
|Open-Xchange provided a new LDAP Contact Storage Integration Bundle. Open-Xchange discontinued support for the old bundle with OX App Suite v7.2.1. Further configuration information is available at the Open-Xchange Knowledgebase under: http://oxpedia.org/wiki/index.php?title=ContactStorageLDAP<br />
|Since OX App Suite v7.2.1: 2013-05-27<br />
|}<br />
<br />
== What version do I have installed ==<br />
<br />
Check [[UpdatingOXPackages#What_Service_Pack_do_I_have_installed.3F|this article]] to find out.<br />
<br />
<br />
[[Category: OX7]]<br />
[[Category: AppSuite]]</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=OX6:Using_Brands/Whitelabeling_with_Open-Xchange_Hosting_Edition&diff=19013
OX6:Using Brands/Whitelabeling with Open-Xchange Hosting Edition
2015-01-13T14:36:09Z
<p>Sonja.krause-harder: </p>
<hr />
<div>= Using multiple brands in Open-Xchange =<br />
<br />
== Task == <br />
<br />
You want to host the contexts of different brands in a single installation. These brands vary in some of their branding settings. You can define all these different brands via simple configuration files. A brand consists of a definition of properties like product name, logout url, session timeout url and also different [[Upsell]] properties to use.<br />
<br />
== Requirements == <br />
<br />
Please make sure you have the package <code>open-xchange-hostname-config-cascade</code> installed. Else the generated URLs for publications and notification mails won´t contain the branded domain/host name.<br />
<br />
== Solution ==<br />
<br />
Let's consider three brands we want to configure. We'll call them "Groupware4You", "CollaborationPro" and "OneStopShop". <br />
<br />
Branding in OX is governed by various ui properties. Please note that these examples are primarily OX6 frontend properties. App Suite uses different ones which are not covered here to explain the concept. With these you can:<br />
<br />
* Change the help path (ui/global/help/help_path)<br />
* Change the FAQ path (ui/global/help/faq_path)<br />
* Change where the ui redirects to, on logout (ui/global/logout_path)<br />
* Change where the ui redirects to on session expiration (ui/global/sessionExpired_path)<br />
* Change the ui direct link path (ui/global/directLink_path)<br />
* Change the url of the page that suggests UWA widgets (ui/global/uwa/link)<br />
* Change the product name in the about dialog (ui/product/name)<br />
* Change the product description in the about dialog (ui/product/description)<br />
* Change the vendor address in the about dialog (ui/product/vendor/address)<br />
* Change the path where the themes can be found (ui/global/theme/path)<br />
* Change the hostname for notification mails / publication URLs etc (com.openexchange.hostname)<br />
<br />
<br />
First, we create the default branding settings in the file '''/opt/open-xchange/etc/groupware/settings/branding.properties'''<br />
<br />
ui/global/help/help_path=[protocol]://groupware4you.com[path]/help/[language]<br />
ui/global/help/faq_path=[protocol]://groupware4you.com[path]/faq<br />
ui/global/logout_path=[protocol]://groupware4you.com[path]/logout<br />
ui/global/sessionExpired_path=[protocol]://groupware4you.com[path]/sessionExpired<br />
ui/global/directLink_path=[protocol]://groupware4you.com[path]#m=[module]&f=[folder]&i=[object_id]<br />
ui/global/uwa/link=http://groupware4you.com/uwa/widgets.html<br />
ui/product/name=Groupware 4 You<br />
ui/product/description=Groupware 4 You - The groupware for everyone<br />
ui/product/vendor/address=Some Address<br />
ui/global/theme/path=themes/<br />
modules/themes/default=GW4U Theme<br />
<br />
In '''/opt/open-xchange/etc/groupware/system.properties''' add the line:<br />
com.openexchange.hostname=groupware4you.com<br />
<br />
<br />
Next, let's define the two other brands. If a context belongs to a certain brand, the branding options will be overridden by the config cascade.<br />
<br />
Create a file '''/opt/open-xchange/etc/groupware/contextSets/branding.yml'''.<br />
<br />
cpro:<br />
withTags: cpro<br />
ui/global/help/help_path: "[protocol]://collabpro.com[path]/help/[language]"<br />
ui/global/help/faq_path: "[protocol]://collabpro.com[path]/faq"<br />
ui/global/logout_path: "[protocol]://collabpro.com[path]/logout"<br />
ui/global/sessionExpired_path: "[protocol]://collabpro.com[path]/sessionExpired"<br />
ui/global/directLink_path: "[protocol]://collabpro.com[path]#m=[module]&f=[folder]&i=[object_id]"<br />
ui/global/uwa/link: "http://collabpro.com/uwa/widgets.html"<br />
ui/product/name: "CollaborationPro"<br />
ui/product/description: "Don't just be a team, be a unit"<br />
ui/product/vendor/address: "Some Address"<br />
ui/global/theme/path: "themes/cpro/"<br />
com.openexchange.hostname: "collabpro.com"<br />
modules/themes/default: "Collab Theme"<br />
<br />
oss:<br />
withTags: oss<br />
ui/global/help/help_path: "[protocol]://OneStopShop.com[path]/help/[language]"<br />
ui/global/help/faq_path: "[protocol]://OneStopShop.com[path]/faq"<br />
ui/global/logout_path: "[protocol]://OneStopShop.com[path]/logout"<br />
ui/global/sessionExpired_path: "[protocol]://OneStopShop.com[path]/sessionExpired"<br />
ui/global/directLink_path: "[protocol]://OneStopShop.com[path]#m=[module]&f=[folder]&i=[object_id]"<br />
ui/global/uwa/link: "http://OneStopShop.com/uwa/widgets.html"<br />
ui/product/name: "One Stop Shop"<br />
ui/product/description: "One Stop Shop - Be informed"<br />
ui/product/vendor/address: "Some Address"<br />
ui/global/theme/path: "themes/oss/"<br />
com.openexchange.hostname: "OneStopShop.com"<br />
modules/themes/default: "OSS Theme"<br />
<br />
'''Important''': In the folder pointed to using <tt>ui/global/theme/path</tt> must be located a folder called "default" containing the default<br />
theme that brand should use. In addition, if you might want to remove the entries in the <tt>themes.properties</tt> in <tt>/opt/open-xchange/etc/groupware/settings</tt><br />
if users should only see themes depending on their brand.<br />
<br />
<br />
Now we'll tag the contexts. This will assign the contexts to a certain brand.<br />
<br />
''Groupware4You Contexts''<br />
'''changecontext -c1 ... --taxonomy/types=gw4u'''<br />
'''changecontext -c2 ... --taxonomy/types=gw4u'''<br />
<br />
''CollaborationPro Contexts''<br />
'''changecontext -c3 ... --taxonomy/types=cpro'''<br />
'''changecontext -c4 ... --taxonomy/types=cpro'''<br />
<br />
''OneStopShop Contexts''<br />
'''changecontext -c5 ... --taxonomy/types=oss'''<br />
'''changecontext -c6 ... --taxonomy/types=oss'''<br />
<br />
<br />
<br />
[[File:Branding_links_to_send_in_email.png|290px|thumb|left|links_in_email]] <br />
<br />
[[File:Branding_logout_url.png|290px|thumb|left|logouturl]] <br />
<br />
[[File:Branding_about_dialog_infostore_urls.png|290px|thumb|left|about_dialog_wizzard]] <br />
<br />
[[File:Branding_theme_wizzard_hostname.png|290px|thumb|left|wizzard_theme]]<br />
<br />
== Programming examples ==<br />
<br />
=== perl ===<br />
<br />
The file http://software.open-xchange.com/OX6/doc/SOAP/admin/branding-example.pl is an example on how to implement it in perl.<br />
<br />
=== C# ===<br />
<br />
Check [[Open-Xchange-SOAP-C-Sharp|Provision using C#]] on how to do the same in C#.</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:OX_Guard&diff=18707
AppSuite:OX Guard
2014-10-10T12:01:26Z
<p>Sonja.krause-harder: /* SUSE Linux Enterprise Server 11 */</p>
<hr />
<div>= OX Guard =<br />
<br />
OX Guard is a security solution that provides protection for email communications and files. Fully integrated with both OX as a Service and standard OX App Suite installations, it allows users to send and read encrypted messages and store and share encrypted files – and requires no additional setup or knowledge. OX Guard offers a simple way to increase security by limiting the opportunity for unauthorized access while data is en-route or in-storage, creating extra peace of mind.<br />
<br />
This article will guide you through the installation of Guard and describes the basic configuration and software requirements. As it is intended as a quick walk-through it assumes an existing installation of the operating system including a single server App Suite setup as well as average system administration skills. This guide will also show you how to setup a basic installation with none of the typically used distributed environment settings. The objective of this guide is:<br />
<br />
* To setup a single server installation<br />
* To setup a single Guard instance on an existing Open-Xchange installation, no cluster<br />
* To use the database service on the existing Open-Xchange installation for Guard, no replication<br />
* To provide a basic configuration setup, no mailserver configuration<br />
<br />
== Key features ==<br />
<br />
* Simple security at the touch of a button<br />
* Provides user based security - Separate from provider<br />
* Supplementary security to Provider based security - Layered<br />
* Powerful features yet simple to use and understand<br />
* Security - Inside and outside of the OX environment<br />
* Email and Drive integration<br />
* Uses proven PGP security<br />
<br />
== Availability ==<br />
<br />
If an OX App Suite customer would like to evaluate OX Guard integration, the first step is to contact OX Sales. OX Sales will then work on the request and send prices and license/API (for the hosted infrastructure) key details to the customer.<br />
<br />
== Requirements ==<br />
<br />
Please review following URL for remaining requirements <br />
<br />
Please review [[AppSuite:OX_System_Requirements#OX_Guard|OX Guard Requirements]] for a full list of requirements.<br />
<br />
Since OX Guard is a Microservice it can either be added to an existing Open-Xchange installation or it can be deployed on a dedicated environment without having any of the other Open-Xchange App Suite core services installed. OX App Suite v7.6.0 or later is required to operate this extension both in a single or multi server environments.<br />
<br />
Prerequisites:<br />
* Open-Xchange REST API<br />
* Grizzly HTTP connector (open-xchange-grizzly)<br />
* A supported Java Virtual Machine (Java 7)<br />
* An Open-Xchange App Suite installation v7.6.0 or later<br />
* Please Note: To get access to the latest minor features and bug fixes, you need to have a valid license. The article [[AppSuite:UpdatingOXPackages|Updating OX-Packages]] explains how that can be done.<br />
<br />
== Please Note ==<br />
<br />
OX Guard version 1.0 supports branding / theming using the configuration cascade, defining a templateID for a user or context. Additional details will be provided in customization documentation<br />
<br />
= Download and Installation =<br />
<br />
=== General ===<br />
The installation of the open-xchange-rest package which is required for Guard will eventually execute database update tasks if installed and activated. Please take this into account.<br />
<br />
=== Redhat Enterprise Linux 6 or CentOS 6 ===<br />
<br />
If not already done, add the following repositories to your Open-Xchange yum configuration:<br />
<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products|pc2n=rhelname|pc2v=RHEL6|appsuite/stable/guard-backend}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products|pc2n=rhelname|pc2v=RHEL6|appsuite/stable/guard-ui}}<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-rest open-xchange-guard open-xchange-guard-ui open-xchange-guard-ui-static<br />
<br />
=== Debian GNU/Linux 7.0 ===<br />
<br />
If not already done, add the following repositories to your Open-Xchange apt configuration:<br />
<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products|pc2n=debianname|pc2v=DebianWheezy|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|appsuite/stable/guard-backend}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products|pc2n=debianname|pc2v=DebianWheezy|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|appsuite/stable/guard-ui}}<br />
<br />
and run<br />
<br />
$ apt-get update<br />
$ apt-get install open-xchange-rest open-xchange-guard open-xchange-guard-ui open-xchange-guard-ui-static<br />
<br />
=== SUSE Linux Enterprise Server 11 ===<br />
<br />
Add the package repository using zypper if not already present:<br />
<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products|pc2n=susename|pc2v=SLES11|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|appsuite/stable/guard-backend}}<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products|pc2n=susename|pc2v=SLES11|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|appsuite/stable/guard-ui}}<br />
<br />
and run<br />
<br />
$ zypper ref<br />
$ zypper in open-xchange-rest open-xchange-guard open-xchange-guard-ui open-xchange-guard-ui-static<br />
<br />
Guard requires Java 1.7, which will be installed through the Guard packages, still SUSE Linux Enterprise Server 11 will not use Java 1.7 by default. Therefor we have to set Java 1.7 as the default instead of Java 1.6:<br />
<br />
$ update-alternatives --config java<br />
<br />
Now select the Java 1.7 JRE, example:<br />
<br />
There are 2 alternatives which provide `java'.<br />
<br />
Selection Alternative<br />
-----------------------------------------------<br />
* 1 /usr/lib64/jvm/jre-1.6.0-ibm/bin/java<br />
+ 2 /usr/lib64/jvm/jre-1.7.0-ibm/bin/java<br />
<br />
Press enter to keep the default[*], or type selection number: 2<br />
Using '/usr/lib64/jvm/jre-1.7.0-ibm/bin/java' to provide 'java'.<br />
<br />
= Update OX Guard =<br />
<br />
=== Redhat Enterprise Linux 6 or CentOS 6 ===<br />
<br />
If not already done, add the following repositories to your Open-Xchange yum configuration:<br />
<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|appsuite/7.6.0/guard-backend/updates}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|appsuite/7.6.0/guard-ui/updates}}<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum upgrade<br />
<br />
After the new packages are installed, the guard process needs a restart:<br />
<br />
<pre>$ /etc/init.d/open-xchange-guard restart</pre><br />
<br />
=== Debian GNU/Linux 7.0 ===<br />
<br />
If not already done, add the following repositories to your Open-Xchange apt configuration:<br />
<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products|pc2n=debianname|pc2v=DebianWheezy|appsuite/7.6.0/guard-backend/updates}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products|pc2n=debianname|pc2v=DebianWheezy|appsuite/7.6.0/guard-ui/updates}}<br />
<br />
Then run<br />
<br />
$ apt-get update<br />
$ apt-get dist-upgrade<br />
<br />
If you want to see, what apt-get is going to do without actually doing it, you can run:<br />
<br />
$ apt-get dist-upgrade -s<br />
<br />
After the new packages are installed, the guard process needs a restart:<br />
<br />
<pre>$ /etc/init.d/open-xchange-guard restart</pre><br />
<br />
=== SUSE Linux Enterprise Server 11 ===<br />
<br />
Add the package repository using zypper if not already present:<br />
<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products|pc2n=susename|pc2v=SLES11|appsuite/7.6.0/guard-backend/updates}}<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products|pc2n=susename|pc2v=SLES11|appsuite/7.6.0/guard-ui/updates}}<br />
<br />
and run<br />
<br />
$ zypper dup -r appsuite-7.6.0-guard-backend-updates<br />
$ zypper dup -r appsuite-7.6.0-guard-ui-updates<br />
<br />
You might need to run<br />
<br />
$ zypper ref<br />
<br />
to update the repository metadata before running ''zypper up''.<br />
<br />
After the new packages are installed, the guard process needs a restart:<br />
<br />
<pre>$ open-xchange-guard restart</pre><br />
<br />
= Configuration =<br />
<br />
The following gives an overview of the most important settings to enable Guard for users on the Open-Xchange installation. Some of those settings have to be modified in order to establish the database and REST API access from the Guard service. All settings relating to the Guard backend component are located in the configuration file guard.properties located in /opt/open-xchange/guard/etc. The default configuration should be sufficient for a basic "up-and-running" setup (with the exception of defining the database username and password). Please refer to the inline documentation of the configuration file for more advanced options.<br />
<br />
$ vim /opt/open-xchange/guard/etc/guard.properties<br />
<br />
Open-Xchange config_db host - Guard will establish a connection to the config_db<br />
<br />
com.openexchange.guard.configdbHostname=localhost<br />
<br />
Guard database for storing user keys<br />
<br />
com.openexchange.guard.oxguardDatabaseHostname=localhost<br />
<br />
Username and Password for the two databases above<br />
<br />
com.openexchange.guard.databaseUsername=openexchange<br />
com.openexchange.guard.databasePassword=db_password<br />
<br />
Open-Xchange REST API host<br />
<br />
com.openexchange.guard.restApiHostname=localhost<br />
<br />
External URL for this Open-Xchange installation. This setting will be used to generate the link to the secure content for external recipients<br />
<br />
com.openexchange.guard.externalEmailURL=URL_TO_OX<br />
<br />
== Configure services ==<br />
<br />
=== Apache ===<br />
<br />
Configure the mod_proxy_http module by adding the Guard API.<br />
<br />
'''Redhat Enterprise Linux 6 or CentOS 6'''<br />
$ vim /etc/httpd/conf.d/proxy_http.conf<br />
<br />
'''Debian GNU/Linux 7.0 and SUSE Linux Enterprise Server 11'''<br />
$ vim /etc/apache2/conf.d/proxy_http.conf<br />
<br />
<Proxy balancer://oxguard><br />
Order deny,allow<br />
Allow from all<br><br />
BalancerMember http://localhost:8080/oxguard timeout=1800 smax=0 ttl=60 retry=60 loadfactor=100 route=OX1<br />
ProxySet stickysession=JSESSIONID|jsessionid scolonpathdelim=ON<br />
SetEnv proxy-initial-not-pooled<br />
SetEnv proxy-sendchunked<br />
</Proxy><br><br />
<br />
ProxyPass /appsuite/api/oxguard balancer://oxguard<br />
<br />
'''Please Note:''' The Guard API settings must be inserted before the existing “<Proxy /appsuite/api>” parameter.<br />
<br />
After the configuration is done, restart the Apache webserver<br />
<br />
$ apachectl restart<br />
<br />
=== Open-Xchange ===<br />
<br />
Please add the following settings to a new configuration file on the Open-Xchange backend servers:<br />
<br />
$ vim /opt/open-xchange/etc/guard.properties<br />
<br />
# OX GUard general permission, required to activate Guard in the AppSuite UI.<br />
com.openexchange.capability.guard=true<br />
<br />
# Default theme template id for all users that have no custom template id configured.<br />
com.openexchange.guard.templateID=0<br />
<br />
=== SELinux ===<br />
<br />
Running SELinux prohibits your local Open-Xchange backend service to connect to localhost:8080, which is where the Guard backend service listens to. In order to allow localhost connections to 8080 execute the following:<br />
<br />
$ setsebool -P httpd_can_network_connect 1<br />
<br />
== Initiating the Guard database and key store ==<br />
<br />
Once the Guard configuration (database and backend configuration) and the service configuration has been applied, the Guard administration script needs to be executed in order to create the Guard databases. The administration script also takes care of the creation of the master keys and the master password file in /opt/open-xchange/guard. The initiation only needs to be done once for a multi server setup, for details please see “Optional / Clustering”.<br />
<br />
/opt/open-xchange/guard/sbin/guard init<br />
<br />
'''Please Note:''' It is important to understand that the master password file located at /opt/open-xchange/guard/oxguardpass is required to reset user passwords, without them the administrator will not be able to reset user passwords anymore in the future. The file contains the passwords used to encrypt the master database key, as well as passwords used to encrypt protected data in the users table.<br />
<br />
== Start Guard ==<br />
<br />
The services have been configured and the database has been initiated, it's time to start Guard<br />
<br />
$ /etc/init.d/open-xchange-guard start<br />
<br />
== Enabling Guard for Users ==<br />
<br />
Guard provides two capabilities for users in the environment:<br />
<br />
* '''Guard Mail:''' com.openexchange.capability.guard:mail<br />
* '''Guard Drive:''' com.openexchange.capability.guard:drive<br />
<br />
Each of those two Guard components is enabled for all users that have the according capability configured. Please note that users need to have the Drive permission set to use Guard Drive. So the users that have Guard Drive enabled must be a subset of those users with OX Drive permission. Since v7.6.0 we enforce this via the default configuration. Those capabilities can be activated for specific user by using the Open-Xchange provisioning scripts:<br />
<br />
'''Guard Mail:'''<br />
$ /opt/open-xchange/sbin/changeuser -c 1 -A oxadmin -P admin_password -u testuser --config/com.openexchange.capability.guard:mail=true<br />
<br />
'''Guard Drive:'''<br />
$ /opt/open-xchange/sbin/changeuser -c 1 -A oxadmin -P admin_password -u testuser --config/com.openexchange.capability.guard:drive=true<br />
<br />
'''Please Note:''' Guard Drive requires Guard Mail to be configured for the user as well.<br />
<br />
== Optional ==<br />
<br />
=== SSL Configuration ===<br />
<br />
Per default the connection between the Guard backend and the configured Open-Xchange REST API host is unencrypted. Even though that Guard will never transmit unencrypted emails to or from the REST API you can optionally encrypt the whole communication between those two components by using SSL. To enforce Guard to use SSL in the communication between those two components enable the follwing configuration in Guard configuration file. <br />
<br />
$ vim /opt/open-xchange/guard/etc/guard.properties<br />
<br />
com.openexchange.guard.backend_ssl=true<br />
<br />
The Guard backend is most commonly placed behind a load balancer (APACHE or other) and defaults to HTTP for incoming and outgoing traffic, using the load balancer to do SSL with the users. If you want Guard to use SSL for all communications, you need to set up the SSL key to use.<br />
<br />
Please note that you have to provide access to the certificates.<br />
<br />
com.openexchange.guard.useSSL: true<br />
com.openexchange.guard.SSLPort: 8443<br />
com.openexchange.guard.SSLKeyStore: //keystore location//<br />
com.openexchange.guard.SSLKeyName: //alias name here//<br />
com.openexchange.guard.SSLKeyPass: //ssl password//<br />
<br />
'''Please Note:''' Enabling SSL might decrease performance and/or create more system load due to additional encoding of the HTTP streams.<br />
<br />
== Clustering ==<br />
<br />
You can run multiple OX Guard servers in your environment to ensure high availability or enhance scalability. OX Guard integrates seamlessly into the existing Open-Xchange infrastructure by using the existing interface standards and is therefor transparent to the environment. A couple of things have to be prepared in order to loosely couple OX Guard servers with Open-Xchange servers in a cluster.<br />
<br />
=== MySQL ===<br />
<br />
The MySQL servers need to be configured in order to allow access to the configdb of Open-Xchange. To do so you need to set the following configuration in the MySQL my.cnf:<br />
<br />
bind = 0.0.0.0<br />
<br />
This allows the Guard backend to bind to the MySQL host which is configured in the guard.properties file with com.openexchange.guard.configdbHostname. After the bind for the MySQL instance is configured and the OX Guard backend would be able to connect to the configured host, you have to grant access for the OX Guard service on the MySQL instance to manage the databases. Do so by connecting to the MySQL server via the mysql client. Authenticate if necessary and execute the following, please note that you have to modify the hostname / IP address of the client who should be able to connect to this database, it should include all possible OX Guard servers:<br />
<br />
GRANT ALL PRIVILEGES ON *.* TO 'openexchange'@'oxguard.example.com' IDENTIFIED BY ‘secret’;<br />
<br />
=== Apache ===<br />
<br />
OX Guard uses the Open-Xchange REST API to store and fetch data from the Open-Xchange databases. The REST API is a servlet running in the Grizzly container. By default it is not exposed as a servlet through Apache and is only accessibly via port 8009. In order to use Apache's load balancing via mod_proxy we need to add a servlet called "preliminary" to proxy_http.conf, example based on a clustered mod_proxy configuration:<br />
<br />
<Location /preliminary><br />
Order Deny,Allow<br />
Deny from all<br />
# Only allow access from Guard servers within the network. Do not expose this<br />
# location outside of your network. In case you use a load balancing service in front<br />
# of your Apache infrastructure you should make sure that access to /preliminary will<br />
# be blocked from the internet / outside clients. Examples:<br />
# Allow from 192.168.0.1<br />
# Allow from 192.168.1.1 192.168.1.2<br />
# Allow from 192.168.0.<br />
ProxyPass /preliminary balancer://oxcluster/preliminary<br />
</Location><br />
<br />
Make sure that the balancer is properly configured in the mod_proxy configuration. Examples on how to do so can be found in our clustering configuration for Open-Xchange AppSuite. Like explained in the example above, please make sure that this location is only available in your internal network, there is no need to expose /preliminary to the public, it is only used by Guard servers to connect to the OX backend. If you have a load balancer in front of the Apache cluster you should consider blocking access to /preliminary from WAN to restrict access to the servlet to internal network services only.<br />
<br />
Now add the OX Guard BalancerMembers to the oxguard balancer configuration (also in proxy_http.conf) to address all your OX Guard nodes in the cluster in this balancer configuration. The configuration has to be applied to all Apache nodes within the cluster.<br />
<br />
If the Apache server is a dedicated server / instance you also have to install the OX Guard UI-Static package on all Apache nodes in the cluster in order to provide static files like images or CSS to the OX Guard client. Example for Debian (the OX Guard repository has to be configured in the package management prior):<br />
<br />
$ apt-get install open-xchange-guard-ui-static<br />
<br />
=== Open-Xchange ===<br />
<br />
Disable the Open-Xchange IPCheck for session verification. This is required because OX Guard will use the users session cookie to connect to the Open-Xchange REST API, but as a different IP address than the OX Guard server has been used during authentication the request would fail if you don't disable the IPCheck:<br />
<br />
$ vim /opt/open-xchange/etc/server.properties<br />
<br />
and set:<br />
<br />
com.openexchange.IPCheck=false<br />
<br />
The OX Guard UI package has to be installed on all Open-Xchange backend nodes as well, example for Debian (the OX Guard repository has to be configured in the package management prior):<br />
<br />
$ apt-get install open-xchange-guard-ui<br />
<br />
Restart the Open-Xchange service afterwards.<br />
<br />
=== OX Guard ===<br />
<br />
After all the services like MySQL, Apache and Open-Xchange have been configured you need to update the OX Guard backend configuration to point to the correct API endpoints. Set the REST API endpoint to an Apache server by setting the following value in /opt/open-xchange/guard/etc/guard.properties:<br />
<br />
com.openexchange.guard.restApiHostname=apache.example.com<br />
<br />
Per default Guard will try to connect to port 8009 to this host, but as we configured the REST API to be proxies thorugh the serblet /preliminary on every Apache we now also need to change the target port for the REST API. You can do so by adding the following line into /opt/open-xchange/guard/etc/guard.properties:<br />
<br />
com.openexchange.guard.oxBackendPort=80<br />
<br />
Please also change all settings in regards to MySQL like com.openexchange.guard.configdbHostname, com.openexchange.guard.oxguardDatabaseHostname, com.openexchange.guard.databaseUsername or com.openexchange.guard.databasePassword. Afterwards restart the OX Guard service and check the logfile if the OX Guard backend is able to connect to the configured REST API.</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:OX_Guard&diff=18706
AppSuite:OX Guard
2014-10-10T12:00:50Z
<p>Sonja.krause-harder: /* Debian GNU/Linux 7.0 */</p>
<hr />
<div>= OX Guard =<br />
<br />
OX Guard is a security solution that provides protection for email communications and files. Fully integrated with both OX as a Service and standard OX App Suite installations, it allows users to send and read encrypted messages and store and share encrypted files – and requires no additional setup or knowledge. OX Guard offers a simple way to increase security by limiting the opportunity for unauthorized access while data is en-route or in-storage, creating extra peace of mind.<br />
<br />
This article will guide you through the installation of Guard and describes the basic configuration and software requirements. As it is intended as a quick walk-through it assumes an existing installation of the operating system including a single server App Suite setup as well as average system administration skills. This guide will also show you how to setup a basic installation with none of the typically used distributed environment settings. The objective of this guide is:<br />
<br />
* To setup a single server installation<br />
* To setup a single Guard instance on an existing Open-Xchange installation, no cluster<br />
* To use the database service on the existing Open-Xchange installation for Guard, no replication<br />
* To provide a basic configuration setup, no mailserver configuration<br />
<br />
== Key features ==<br />
<br />
* Simple security at the touch of a button<br />
* Provides user based security - Separate from provider<br />
* Supplementary security to Provider based security - Layered<br />
* Powerful features yet simple to use and understand<br />
* Security - Inside and outside of the OX environment<br />
* Email and Drive integration<br />
* Uses proven PGP security<br />
<br />
== Availability ==<br />
<br />
If an OX App Suite customer would like to evaluate OX Guard integration, the first step is to contact OX Sales. OX Sales will then work on the request and send prices and license/API (for the hosted infrastructure) key details to the customer.<br />
<br />
== Requirements ==<br />
<br />
Please review following URL for remaining requirements <br />
<br />
Please review [[AppSuite:OX_System_Requirements#OX_Guard|OX Guard Requirements]] for a full list of requirements.<br />
<br />
Since OX Guard is a Microservice it can either be added to an existing Open-Xchange installation or it can be deployed on a dedicated environment without having any of the other Open-Xchange App Suite core services installed. OX App Suite v7.6.0 or later is required to operate this extension both in a single or multi server environments.<br />
<br />
Prerequisites:<br />
* Open-Xchange REST API<br />
* Grizzly HTTP connector (open-xchange-grizzly)<br />
* A supported Java Virtual Machine (Java 7)<br />
* An Open-Xchange App Suite installation v7.6.0 or later<br />
* Please Note: To get access to the latest minor features and bug fixes, you need to have a valid license. The article [[AppSuite:UpdatingOXPackages|Updating OX-Packages]] explains how that can be done.<br />
<br />
== Please Note ==<br />
<br />
OX Guard version 1.0 supports branding / theming using the configuration cascade, defining a templateID for a user or context. Additional details will be provided in customization documentation<br />
<br />
= Download and Installation =<br />
<br />
=== General ===<br />
The installation of the open-xchange-rest package which is required for Guard will eventually execute database update tasks if installed and activated. Please take this into account.<br />
<br />
=== Redhat Enterprise Linux 6 or CentOS 6 ===<br />
<br />
If not already done, add the following repositories to your Open-Xchange yum configuration:<br />
<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products|pc2n=rhelname|pc2v=RHEL6|appsuite/stable/guard-backend}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products|pc2n=rhelname|pc2v=RHEL6|appsuite/stable/guard-ui}}<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-rest open-xchange-guard open-xchange-guard-ui open-xchange-guard-ui-static<br />
<br />
=== Debian GNU/Linux 7.0 ===<br />
<br />
If not already done, add the following repositories to your Open-Xchange apt configuration:<br />
<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products|pc2n=debianname|pc2v=DebianWheezy|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|appsuite/stable/guard-backend}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products|pc2n=debianname|pc2v=DebianWheezy|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|appsuite/stable/guard-ui}}<br />
<br />
and run<br />
<br />
$ apt-get update<br />
$ apt-get install open-xchange-rest open-xchange-guard open-xchange-guard-ui open-xchange-guard-ui-static<br />
<br />
=== SUSE Linux Enterprise Server 11 ===<br />
<br />
Add the package repository using zypper if not already present:<br />
<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products|pc2n=susename|pc2v=SLES11|appsuite/stable/guard-backend}}<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products|pc2n=susename|pc2v=SLES11|appsuite/stable/guard-ui}}<br />
<br />
and run<br />
<br />
$ zypper ref<br />
$ zypper in open-xchange-rest open-xchange-guard open-xchange-guard-ui open-xchange-guard-ui-static<br />
<br />
Guard requires Java 1.7, which will be installed through the Guard packages, still SUSE Linux Enterprise Server 11 will not use Java 1.7 by default. Therefor we have to set Java 1.7 as the default instead of Java 1.6:<br />
<br />
$ update-alternatives --config java<br />
<br />
Now select the Java 1.7 JRE, example:<br />
<br />
There are 2 alternatives which provide `java'.<br />
<br />
Selection Alternative<br />
-----------------------------------------------<br />
* 1 /usr/lib64/jvm/jre-1.6.0-ibm/bin/java<br />
+ 2 /usr/lib64/jvm/jre-1.7.0-ibm/bin/java<br />
<br />
Press enter to keep the default[*], or type selection number: 2<br />
Using '/usr/lib64/jvm/jre-1.7.0-ibm/bin/java' to provide 'java'.<br />
<br />
= Update OX Guard =<br />
<br />
=== Redhat Enterprise Linux 6 or CentOS 6 ===<br />
<br />
If not already done, add the following repositories to your Open-Xchange yum configuration:<br />
<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|appsuite/7.6.0/guard-backend/updates}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|appsuite/7.6.0/guard-ui/updates}}<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum upgrade<br />
<br />
After the new packages are installed, the guard process needs a restart:<br />
<br />
<pre>$ /etc/init.d/open-xchange-guard restart</pre><br />
<br />
=== Debian GNU/Linux 7.0 ===<br />
<br />
If not already done, add the following repositories to your Open-Xchange apt configuration:<br />
<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products|pc2n=debianname|pc2v=DebianWheezy|appsuite/7.6.0/guard-backend/updates}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products|pc2n=debianname|pc2v=DebianWheezy|appsuite/7.6.0/guard-ui/updates}}<br />
<br />
Then run<br />
<br />
$ apt-get update<br />
$ apt-get dist-upgrade<br />
<br />
If you want to see, what apt-get is going to do without actually doing it, you can run:<br />
<br />
$ apt-get dist-upgrade -s<br />
<br />
After the new packages are installed, the guard process needs a restart:<br />
<br />
<pre>$ /etc/init.d/open-xchange-guard restart</pre><br />
<br />
=== SUSE Linux Enterprise Server 11 ===<br />
<br />
Add the package repository using zypper if not already present:<br />
<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products|pc2n=susename|pc2v=SLES11|appsuite/7.6.0/guard-backend/updates}}<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products|pc2n=susename|pc2v=SLES11|appsuite/7.6.0/guard-ui/updates}}<br />
<br />
and run<br />
<br />
$ zypper dup -r appsuite-7.6.0-guard-backend-updates<br />
$ zypper dup -r appsuite-7.6.0-guard-ui-updates<br />
<br />
You might need to run<br />
<br />
$ zypper ref<br />
<br />
to update the repository metadata before running ''zypper up''.<br />
<br />
After the new packages are installed, the guard process needs a restart:<br />
<br />
<pre>$ open-xchange-guard restart</pre><br />
<br />
= Configuration =<br />
<br />
The following gives an overview of the most important settings to enable Guard for users on the Open-Xchange installation. Some of those settings have to be modified in order to establish the database and REST API access from the Guard service. All settings relating to the Guard backend component are located in the configuration file guard.properties located in /opt/open-xchange/guard/etc. The default configuration should be sufficient for a basic "up-and-running" setup (with the exception of defining the database username and password). Please refer to the inline documentation of the configuration file for more advanced options.<br />
<br />
$ vim /opt/open-xchange/guard/etc/guard.properties<br />
<br />
Open-Xchange config_db host - Guard will establish a connection to the config_db<br />
<br />
com.openexchange.guard.configdbHostname=localhost<br />
<br />
Guard database for storing user keys<br />
<br />
com.openexchange.guard.oxguardDatabaseHostname=localhost<br />
<br />
Username and Password for the two databases above<br />
<br />
com.openexchange.guard.databaseUsername=openexchange<br />
com.openexchange.guard.databasePassword=db_password<br />
<br />
Open-Xchange REST API host<br />
<br />
com.openexchange.guard.restApiHostname=localhost<br />
<br />
External URL for this Open-Xchange installation. This setting will be used to generate the link to the secure content for external recipients<br />
<br />
com.openexchange.guard.externalEmailURL=URL_TO_OX<br />
<br />
== Configure services ==<br />
<br />
=== Apache ===<br />
<br />
Configure the mod_proxy_http module by adding the Guard API.<br />
<br />
'''Redhat Enterprise Linux 6 or CentOS 6'''<br />
$ vim /etc/httpd/conf.d/proxy_http.conf<br />
<br />
'''Debian GNU/Linux 7.0 and SUSE Linux Enterprise Server 11'''<br />
$ vim /etc/apache2/conf.d/proxy_http.conf<br />
<br />
<Proxy balancer://oxguard><br />
Order deny,allow<br />
Allow from all<br><br />
BalancerMember http://localhost:8080/oxguard timeout=1800 smax=0 ttl=60 retry=60 loadfactor=100 route=OX1<br />
ProxySet stickysession=JSESSIONID|jsessionid scolonpathdelim=ON<br />
SetEnv proxy-initial-not-pooled<br />
SetEnv proxy-sendchunked<br />
</Proxy><br><br />
<br />
ProxyPass /appsuite/api/oxguard balancer://oxguard<br />
<br />
'''Please Note:''' The Guard API settings must be inserted before the existing “<Proxy /appsuite/api>” parameter.<br />
<br />
After the configuration is done, restart the Apache webserver<br />
<br />
$ apachectl restart<br />
<br />
=== Open-Xchange ===<br />
<br />
Please add the following settings to a new configuration file on the Open-Xchange backend servers:<br />
<br />
$ vim /opt/open-xchange/etc/guard.properties<br />
<br />
# OX GUard general permission, required to activate Guard in the AppSuite UI.<br />
com.openexchange.capability.guard=true<br />
<br />
# Default theme template id for all users that have no custom template id configured.<br />
com.openexchange.guard.templateID=0<br />
<br />
=== SELinux ===<br />
<br />
Running SELinux prohibits your local Open-Xchange backend service to connect to localhost:8080, which is where the Guard backend service listens to. In order to allow localhost connections to 8080 execute the following:<br />
<br />
$ setsebool -P httpd_can_network_connect 1<br />
<br />
== Initiating the Guard database and key store ==<br />
<br />
Once the Guard configuration (database and backend configuration) and the service configuration has been applied, the Guard administration script needs to be executed in order to create the Guard databases. The administration script also takes care of the creation of the master keys and the master password file in /opt/open-xchange/guard. The initiation only needs to be done once for a multi server setup, for details please see “Optional / Clustering”.<br />
<br />
/opt/open-xchange/guard/sbin/guard init<br />
<br />
'''Please Note:''' It is important to understand that the master password file located at /opt/open-xchange/guard/oxguardpass is required to reset user passwords, without them the administrator will not be able to reset user passwords anymore in the future. The file contains the passwords used to encrypt the master database key, as well as passwords used to encrypt protected data in the users table.<br />
<br />
== Start Guard ==<br />
<br />
The services have been configured and the database has been initiated, it's time to start Guard<br />
<br />
$ /etc/init.d/open-xchange-guard start<br />
<br />
== Enabling Guard for Users ==<br />
<br />
Guard provides two capabilities for users in the environment:<br />
<br />
* '''Guard Mail:''' com.openexchange.capability.guard:mail<br />
* '''Guard Drive:''' com.openexchange.capability.guard:drive<br />
<br />
Each of those two Guard components is enabled for all users that have the according capability configured. Please note that users need to have the Drive permission set to use Guard Drive. So the users that have Guard Drive enabled must be a subset of those users with OX Drive permission. Since v7.6.0 we enforce this via the default configuration. Those capabilities can be activated for specific user by using the Open-Xchange provisioning scripts:<br />
<br />
'''Guard Mail:'''<br />
$ /opt/open-xchange/sbin/changeuser -c 1 -A oxadmin -P admin_password -u testuser --config/com.openexchange.capability.guard:mail=true<br />
<br />
'''Guard Drive:'''<br />
$ /opt/open-xchange/sbin/changeuser -c 1 -A oxadmin -P admin_password -u testuser --config/com.openexchange.capability.guard:drive=true<br />
<br />
'''Please Note:''' Guard Drive requires Guard Mail to be configured for the user as well.<br />
<br />
== Optional ==<br />
<br />
=== SSL Configuration ===<br />
<br />
Per default the connection between the Guard backend and the configured Open-Xchange REST API host is unencrypted. Even though that Guard will never transmit unencrypted emails to or from the REST API you can optionally encrypt the whole communication between those two components by using SSL. To enforce Guard to use SSL in the communication between those two components enable the follwing configuration in Guard configuration file. <br />
<br />
$ vim /opt/open-xchange/guard/etc/guard.properties<br />
<br />
com.openexchange.guard.backend_ssl=true<br />
<br />
The Guard backend is most commonly placed behind a load balancer (APACHE or other) and defaults to HTTP for incoming and outgoing traffic, using the load balancer to do SSL with the users. If you want Guard to use SSL for all communications, you need to set up the SSL key to use.<br />
<br />
Please note that you have to provide access to the certificates.<br />
<br />
com.openexchange.guard.useSSL: true<br />
com.openexchange.guard.SSLPort: 8443<br />
com.openexchange.guard.SSLKeyStore: //keystore location//<br />
com.openexchange.guard.SSLKeyName: //alias name here//<br />
com.openexchange.guard.SSLKeyPass: //ssl password//<br />
<br />
'''Please Note:''' Enabling SSL might decrease performance and/or create more system load due to additional encoding of the HTTP streams.<br />
<br />
== Clustering ==<br />
<br />
You can run multiple OX Guard servers in your environment to ensure high availability or enhance scalability. OX Guard integrates seamlessly into the existing Open-Xchange infrastructure by using the existing interface standards and is therefor transparent to the environment. A couple of things have to be prepared in order to loosely couple OX Guard servers with Open-Xchange servers in a cluster.<br />
<br />
=== MySQL ===<br />
<br />
The MySQL servers need to be configured in order to allow access to the configdb of Open-Xchange. To do so you need to set the following configuration in the MySQL my.cnf:<br />
<br />
bind = 0.0.0.0<br />
<br />
This allows the Guard backend to bind to the MySQL host which is configured in the guard.properties file with com.openexchange.guard.configdbHostname. After the bind for the MySQL instance is configured and the OX Guard backend would be able to connect to the configured host, you have to grant access for the OX Guard service on the MySQL instance to manage the databases. Do so by connecting to the MySQL server via the mysql client. Authenticate if necessary and execute the following, please note that you have to modify the hostname / IP address of the client who should be able to connect to this database, it should include all possible OX Guard servers:<br />
<br />
GRANT ALL PRIVILEGES ON *.* TO 'openexchange'@'oxguard.example.com' IDENTIFIED BY ‘secret’;<br />
<br />
=== Apache ===<br />
<br />
OX Guard uses the Open-Xchange REST API to store and fetch data from the Open-Xchange databases. The REST API is a servlet running in the Grizzly container. By default it is not exposed as a servlet through Apache and is only accessibly via port 8009. In order to use Apache's load balancing via mod_proxy we need to add a servlet called "preliminary" to proxy_http.conf, example based on a clustered mod_proxy configuration:<br />
<br />
<Location /preliminary><br />
Order Deny,Allow<br />
Deny from all<br />
# Only allow access from Guard servers within the network. Do not expose this<br />
# location outside of your network. In case you use a load balancing service in front<br />
# of your Apache infrastructure you should make sure that access to /preliminary will<br />
# be blocked from the internet / outside clients. Examples:<br />
# Allow from 192.168.0.1<br />
# Allow from 192.168.1.1 192.168.1.2<br />
# Allow from 192.168.0.<br />
ProxyPass /preliminary balancer://oxcluster/preliminary<br />
</Location><br />
<br />
Make sure that the balancer is properly configured in the mod_proxy configuration. Examples on how to do so can be found in our clustering configuration for Open-Xchange AppSuite. Like explained in the example above, please make sure that this location is only available in your internal network, there is no need to expose /preliminary to the public, it is only used by Guard servers to connect to the OX backend. If you have a load balancer in front of the Apache cluster you should consider blocking access to /preliminary from WAN to restrict access to the servlet to internal network services only.<br />
<br />
Now add the OX Guard BalancerMembers to the oxguard balancer configuration (also in proxy_http.conf) to address all your OX Guard nodes in the cluster in this balancer configuration. The configuration has to be applied to all Apache nodes within the cluster.<br />
<br />
If the Apache server is a dedicated server / instance you also have to install the OX Guard UI-Static package on all Apache nodes in the cluster in order to provide static files like images or CSS to the OX Guard client. Example for Debian (the OX Guard repository has to be configured in the package management prior):<br />
<br />
$ apt-get install open-xchange-guard-ui-static<br />
<br />
=== Open-Xchange ===<br />
<br />
Disable the Open-Xchange IPCheck for session verification. This is required because OX Guard will use the users session cookie to connect to the Open-Xchange REST API, but as a different IP address than the OX Guard server has been used during authentication the request would fail if you don't disable the IPCheck:<br />
<br />
$ vim /opt/open-xchange/etc/server.properties<br />
<br />
and set:<br />
<br />
com.openexchange.IPCheck=false<br />
<br />
The OX Guard UI package has to be installed on all Open-Xchange backend nodes as well, example for Debian (the OX Guard repository has to be configured in the package management prior):<br />
<br />
$ apt-get install open-xchange-guard-ui<br />
<br />
Restart the Open-Xchange service afterwards.<br />
<br />
=== OX Guard ===<br />
<br />
After all the services like MySQL, Apache and Open-Xchange have been configured you need to update the OX Guard backend configuration to point to the correct API endpoints. Set the REST API endpoint to an Apache server by setting the following value in /opt/open-xchange/guard/etc/guard.properties:<br />
<br />
com.openexchange.guard.restApiHostname=apache.example.com<br />
<br />
Per default Guard will try to connect to port 8009 to this host, but as we configured the REST API to be proxies thorugh the serblet /preliminary on every Apache we now also need to change the target port for the REST API. You can do so by adding the following line into /opt/open-xchange/guard/etc/guard.properties:<br />
<br />
com.openexchange.guard.oxBackendPort=80<br />
<br />
Please also change all settings in regards to MySQL like com.openexchange.guard.configdbHostname, com.openexchange.guard.oxguardDatabaseHostname, com.openexchange.guard.databaseUsername or com.openexchange.guard.databasePassword. Afterwards restart the OX Guard service and check the logfile if the OX Guard backend is able to connect to the configured REST API.</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:OX_Guard&diff=18705
AppSuite:OX Guard
2014-10-10T12:00:03Z
<p>Sonja.krause-harder: /* Redhat Enterprise Linux 6 or CentOS 6 */</p>
<hr />
<div>= OX Guard =<br />
<br />
OX Guard is a security solution that provides protection for email communications and files. Fully integrated with both OX as a Service and standard OX App Suite installations, it allows users to send and read encrypted messages and store and share encrypted files – and requires no additional setup or knowledge. OX Guard offers a simple way to increase security by limiting the opportunity for unauthorized access while data is en-route or in-storage, creating extra peace of mind.<br />
<br />
This article will guide you through the installation of Guard and describes the basic configuration and software requirements. As it is intended as a quick walk-through it assumes an existing installation of the operating system including a single server App Suite setup as well as average system administration skills. This guide will also show you how to setup a basic installation with none of the typically used distributed environment settings. The objective of this guide is:<br />
<br />
* To setup a single server installation<br />
* To setup a single Guard instance on an existing Open-Xchange installation, no cluster<br />
* To use the database service on the existing Open-Xchange installation for Guard, no replication<br />
* To provide a basic configuration setup, no mailserver configuration<br />
<br />
== Key features ==<br />
<br />
* Simple security at the touch of a button<br />
* Provides user based security - Separate from provider<br />
* Supplementary security to Provider based security - Layered<br />
* Powerful features yet simple to use and understand<br />
* Security - Inside and outside of the OX environment<br />
* Email and Drive integration<br />
* Uses proven PGP security<br />
<br />
== Availability ==<br />
<br />
If an OX App Suite customer would like to evaluate OX Guard integration, the first step is to contact OX Sales. OX Sales will then work on the request and send prices and license/API (for the hosted infrastructure) key details to the customer.<br />
<br />
== Requirements ==<br />
<br />
Please review following URL for remaining requirements <br />
<br />
Please review [[AppSuite:OX_System_Requirements#OX_Guard|OX Guard Requirements]] for a full list of requirements.<br />
<br />
Since OX Guard is a Microservice it can either be added to an existing Open-Xchange installation or it can be deployed on a dedicated environment without having any of the other Open-Xchange App Suite core services installed. OX App Suite v7.6.0 or later is required to operate this extension both in a single or multi server environments.<br />
<br />
Prerequisites:<br />
* Open-Xchange REST API<br />
* Grizzly HTTP connector (open-xchange-grizzly)<br />
* A supported Java Virtual Machine (Java 7)<br />
* An Open-Xchange App Suite installation v7.6.0 or later<br />
* Please Note: To get access to the latest minor features and bug fixes, you need to have a valid license. The article [[AppSuite:UpdatingOXPackages|Updating OX-Packages]] explains how that can be done.<br />
<br />
== Please Note ==<br />
<br />
OX Guard version 1.0 supports branding / theming using the configuration cascade, defining a templateID for a user or context. Additional details will be provided in customization documentation<br />
<br />
= Download and Installation =<br />
<br />
=== General ===<br />
The installation of the open-xchange-rest package which is required for Guard will eventually execute database update tasks if installed and activated. Please take this into account.<br />
<br />
=== Redhat Enterprise Linux 6 or CentOS 6 ===<br />
<br />
If not already done, add the following repositories to your Open-Xchange yum configuration:<br />
<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products|pc2n=rhelname|pc2v=RHEL6|appsuite/stable/guard-backend}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products|pc2n=rhelname|pc2v=RHEL6|appsuite/stable/guard-ui}}<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-rest open-xchange-guard open-xchange-guard-ui open-xchange-guard-ui-static<br />
<br />
=== Debian GNU/Linux 7.0 ===<br />
<br />
If not already done, add the following repositories to your Open-Xchange apt configuration:<br />
<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products|pc2n=debianname|pc2v=DebianWheezy|appsuite/stable/guard-backend}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products|pc2n=debianname|pc2v=DebianWheezy|appsuite/stable/guard-ui}}<br />
<br />
and run<br />
<br />
$ apt-get update<br />
$ apt-get install open-xchange-rest open-xchange-guard open-xchange-guard-ui open-xchange-guard-ui-static<br />
<br />
=== SUSE Linux Enterprise Server 11 ===<br />
<br />
Add the package repository using zypper if not already present:<br />
<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products|pc2n=susename|pc2v=SLES11|appsuite/stable/guard-backend}}<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products|pc2n=susename|pc2v=SLES11|appsuite/stable/guard-ui}}<br />
<br />
and run<br />
<br />
$ zypper ref<br />
$ zypper in open-xchange-rest open-xchange-guard open-xchange-guard-ui open-xchange-guard-ui-static<br />
<br />
Guard requires Java 1.7, which will be installed through the Guard packages, still SUSE Linux Enterprise Server 11 will not use Java 1.7 by default. Therefor we have to set Java 1.7 as the default instead of Java 1.6:<br />
<br />
$ update-alternatives --config java<br />
<br />
Now select the Java 1.7 JRE, example:<br />
<br />
There are 2 alternatives which provide `java'.<br />
<br />
Selection Alternative<br />
-----------------------------------------------<br />
* 1 /usr/lib64/jvm/jre-1.6.0-ibm/bin/java<br />
+ 2 /usr/lib64/jvm/jre-1.7.0-ibm/bin/java<br />
<br />
Press enter to keep the default[*], or type selection number: 2<br />
Using '/usr/lib64/jvm/jre-1.7.0-ibm/bin/java' to provide 'java'.<br />
<br />
= Update OX Guard =<br />
<br />
=== Redhat Enterprise Linux 6 or CentOS 6 ===<br />
<br />
If not already done, add the following repositories to your Open-Xchange yum configuration:<br />
<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|appsuite/7.6.0/guard-backend/updates}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|appsuite/7.6.0/guard-ui/updates}}<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum upgrade<br />
<br />
After the new packages are installed, the guard process needs a restart:<br />
<br />
<pre>$ /etc/init.d/open-xchange-guard restart</pre><br />
<br />
=== Debian GNU/Linux 7.0 ===<br />
<br />
If not already done, add the following repositories to your Open-Xchange apt configuration:<br />
<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products|pc2n=debianname|pc2v=DebianWheezy|appsuite/7.6.0/guard-backend/updates}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products|pc2n=debianname|pc2v=DebianWheezy|appsuite/7.6.0/guard-ui/updates}}<br />
<br />
Then run<br />
<br />
$ apt-get update<br />
$ apt-get dist-upgrade<br />
<br />
If you want to see, what apt-get is going to do without actually doing it, you can run:<br />
<br />
$ apt-get dist-upgrade -s<br />
<br />
After the new packages are installed, the guard process needs a restart:<br />
<br />
<pre>$ /etc/init.d/open-xchange-guard restart</pre><br />
<br />
=== SUSE Linux Enterprise Server 11 ===<br />
<br />
Add the package repository using zypper if not already present:<br />
<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products|pc2n=susename|pc2v=SLES11|appsuite/7.6.0/guard-backend/updates}}<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products|pc2n=susename|pc2v=SLES11|appsuite/7.6.0/guard-ui/updates}}<br />
<br />
and run<br />
<br />
$ zypper dup -r appsuite-7.6.0-guard-backend-updates<br />
$ zypper dup -r appsuite-7.6.0-guard-ui-updates<br />
<br />
You might need to run<br />
<br />
$ zypper ref<br />
<br />
to update the repository metadata before running ''zypper up''.<br />
<br />
After the new packages are installed, the guard process needs a restart:<br />
<br />
<pre>$ open-xchange-guard restart</pre><br />
<br />
= Configuration =<br />
<br />
The following gives an overview of the most important settings to enable Guard for users on the Open-Xchange installation. Some of those settings have to be modified in order to establish the database and REST API access from the Guard service. All settings relating to the Guard backend component are located in the configuration file guard.properties located in /opt/open-xchange/guard/etc. The default configuration should be sufficient for a basic "up-and-running" setup (with the exception of defining the database username and password). Please refer to the inline documentation of the configuration file for more advanced options.<br />
<br />
$ vim /opt/open-xchange/guard/etc/guard.properties<br />
<br />
Open-Xchange config_db host - Guard will establish a connection to the config_db<br />
<br />
com.openexchange.guard.configdbHostname=localhost<br />
<br />
Guard database for storing user keys<br />
<br />
com.openexchange.guard.oxguardDatabaseHostname=localhost<br />
<br />
Username and Password for the two databases above<br />
<br />
com.openexchange.guard.databaseUsername=openexchange<br />
com.openexchange.guard.databasePassword=db_password<br />
<br />
Open-Xchange REST API host<br />
<br />
com.openexchange.guard.restApiHostname=localhost<br />
<br />
External URL for this Open-Xchange installation. This setting will be used to generate the link to the secure content for external recipients<br />
<br />
com.openexchange.guard.externalEmailURL=URL_TO_OX<br />
<br />
== Configure services ==<br />
<br />
=== Apache ===<br />
<br />
Configure the mod_proxy_http module by adding the Guard API.<br />
<br />
'''Redhat Enterprise Linux 6 or CentOS 6'''<br />
$ vim /etc/httpd/conf.d/proxy_http.conf<br />
<br />
'''Debian GNU/Linux 7.0 and SUSE Linux Enterprise Server 11'''<br />
$ vim /etc/apache2/conf.d/proxy_http.conf<br />
<br />
<Proxy balancer://oxguard><br />
Order deny,allow<br />
Allow from all<br><br />
BalancerMember http://localhost:8080/oxguard timeout=1800 smax=0 ttl=60 retry=60 loadfactor=100 route=OX1<br />
ProxySet stickysession=JSESSIONID|jsessionid scolonpathdelim=ON<br />
SetEnv proxy-initial-not-pooled<br />
SetEnv proxy-sendchunked<br />
</Proxy><br><br />
<br />
ProxyPass /appsuite/api/oxguard balancer://oxguard<br />
<br />
'''Please Note:''' The Guard API settings must be inserted before the existing “<Proxy /appsuite/api>” parameter.<br />
<br />
After the configuration is done, restart the Apache webserver<br />
<br />
$ apachectl restart<br />
<br />
=== Open-Xchange ===<br />
<br />
Please add the following settings to a new configuration file on the Open-Xchange backend servers:<br />
<br />
$ vim /opt/open-xchange/etc/guard.properties<br />
<br />
# OX GUard general permission, required to activate Guard in the AppSuite UI.<br />
com.openexchange.capability.guard=true<br />
<br />
# Default theme template id for all users that have no custom template id configured.<br />
com.openexchange.guard.templateID=0<br />
<br />
=== SELinux ===<br />
<br />
Running SELinux prohibits your local Open-Xchange backend service to connect to localhost:8080, which is where the Guard backend service listens to. In order to allow localhost connections to 8080 execute the following:<br />
<br />
$ setsebool -P httpd_can_network_connect 1<br />
<br />
== Initiating the Guard database and key store ==<br />
<br />
Once the Guard configuration (database and backend configuration) and the service configuration has been applied, the Guard administration script needs to be executed in order to create the Guard databases. The administration script also takes care of the creation of the master keys and the master password file in /opt/open-xchange/guard. The initiation only needs to be done once for a multi server setup, for details please see “Optional / Clustering”.<br />
<br />
/opt/open-xchange/guard/sbin/guard init<br />
<br />
'''Please Note:''' It is important to understand that the master password file located at /opt/open-xchange/guard/oxguardpass is required to reset user passwords, without them the administrator will not be able to reset user passwords anymore in the future. The file contains the passwords used to encrypt the master database key, as well as passwords used to encrypt protected data in the users table.<br />
<br />
== Start Guard ==<br />
<br />
The services have been configured and the database has been initiated, it's time to start Guard<br />
<br />
$ /etc/init.d/open-xchange-guard start<br />
<br />
== Enabling Guard for Users ==<br />
<br />
Guard provides two capabilities for users in the environment:<br />
<br />
* '''Guard Mail:''' com.openexchange.capability.guard:mail<br />
* '''Guard Drive:''' com.openexchange.capability.guard:drive<br />
<br />
Each of those two Guard components is enabled for all users that have the according capability configured. Please note that users need to have the Drive permission set to use Guard Drive. So the users that have Guard Drive enabled must be a subset of those users with OX Drive permission. Since v7.6.0 we enforce this via the default configuration. Those capabilities can be activated for specific user by using the Open-Xchange provisioning scripts:<br />
<br />
'''Guard Mail:'''<br />
$ /opt/open-xchange/sbin/changeuser -c 1 -A oxadmin -P admin_password -u testuser --config/com.openexchange.capability.guard:mail=true<br />
<br />
'''Guard Drive:'''<br />
$ /opt/open-xchange/sbin/changeuser -c 1 -A oxadmin -P admin_password -u testuser --config/com.openexchange.capability.guard:drive=true<br />
<br />
'''Please Note:''' Guard Drive requires Guard Mail to be configured for the user as well.<br />
<br />
== Optional ==<br />
<br />
=== SSL Configuration ===<br />
<br />
Per default the connection between the Guard backend and the configured Open-Xchange REST API host is unencrypted. Even though that Guard will never transmit unencrypted emails to or from the REST API you can optionally encrypt the whole communication between those two components by using SSL. To enforce Guard to use SSL in the communication between those two components enable the follwing configuration in Guard configuration file. <br />
<br />
$ vim /opt/open-xchange/guard/etc/guard.properties<br />
<br />
com.openexchange.guard.backend_ssl=true<br />
<br />
The Guard backend is most commonly placed behind a load balancer (APACHE or other) and defaults to HTTP for incoming and outgoing traffic, using the load balancer to do SSL with the users. If you want Guard to use SSL for all communications, you need to set up the SSL key to use.<br />
<br />
Please note that you have to provide access to the certificates.<br />
<br />
com.openexchange.guard.useSSL: true<br />
com.openexchange.guard.SSLPort: 8443<br />
com.openexchange.guard.SSLKeyStore: //keystore location//<br />
com.openexchange.guard.SSLKeyName: //alias name here//<br />
com.openexchange.guard.SSLKeyPass: //ssl password//<br />
<br />
'''Please Note:''' Enabling SSL might decrease performance and/or create more system load due to additional encoding of the HTTP streams.<br />
<br />
== Clustering ==<br />
<br />
You can run multiple OX Guard servers in your environment to ensure high availability or enhance scalability. OX Guard integrates seamlessly into the existing Open-Xchange infrastructure by using the existing interface standards and is therefor transparent to the environment. A couple of things have to be prepared in order to loosely couple OX Guard servers with Open-Xchange servers in a cluster.<br />
<br />
=== MySQL ===<br />
<br />
The MySQL servers need to be configured in order to allow access to the configdb of Open-Xchange. To do so you need to set the following configuration in the MySQL my.cnf:<br />
<br />
bind = 0.0.0.0<br />
<br />
This allows the Guard backend to bind to the MySQL host which is configured in the guard.properties file with com.openexchange.guard.configdbHostname. After the bind for the MySQL instance is configured and the OX Guard backend would be able to connect to the configured host, you have to grant access for the OX Guard service on the MySQL instance to manage the databases. Do so by connecting to the MySQL server via the mysql client. Authenticate if necessary and execute the following, please note that you have to modify the hostname / IP address of the client who should be able to connect to this database, it should include all possible OX Guard servers:<br />
<br />
GRANT ALL PRIVILEGES ON *.* TO 'openexchange'@'oxguard.example.com' IDENTIFIED BY ‘secret’;<br />
<br />
=== Apache ===<br />
<br />
OX Guard uses the Open-Xchange REST API to store and fetch data from the Open-Xchange databases. The REST API is a servlet running in the Grizzly container. By default it is not exposed as a servlet through Apache and is only accessibly via port 8009. In order to use Apache's load balancing via mod_proxy we need to add a servlet called "preliminary" to proxy_http.conf, example based on a clustered mod_proxy configuration:<br />
<br />
<Location /preliminary><br />
Order Deny,Allow<br />
Deny from all<br />
# Only allow access from Guard servers within the network. Do not expose this<br />
# location outside of your network. In case you use a load balancing service in front<br />
# of your Apache infrastructure you should make sure that access to /preliminary will<br />
# be blocked from the internet / outside clients. Examples:<br />
# Allow from 192.168.0.1<br />
# Allow from 192.168.1.1 192.168.1.2<br />
# Allow from 192.168.0.<br />
ProxyPass /preliminary balancer://oxcluster/preliminary<br />
</Location><br />
<br />
Make sure that the balancer is properly configured in the mod_proxy configuration. Examples on how to do so can be found in our clustering configuration for Open-Xchange AppSuite. Like explained in the example above, please make sure that this location is only available in your internal network, there is no need to expose /preliminary to the public, it is only used by Guard servers to connect to the OX backend. If you have a load balancer in front of the Apache cluster you should consider blocking access to /preliminary from WAN to restrict access to the servlet to internal network services only.<br />
<br />
Now add the OX Guard BalancerMembers to the oxguard balancer configuration (also in proxy_http.conf) to address all your OX Guard nodes in the cluster in this balancer configuration. The configuration has to be applied to all Apache nodes within the cluster.<br />
<br />
If the Apache server is a dedicated server / instance you also have to install the OX Guard UI-Static package on all Apache nodes in the cluster in order to provide static files like images or CSS to the OX Guard client. Example for Debian (the OX Guard repository has to be configured in the package management prior):<br />
<br />
$ apt-get install open-xchange-guard-ui-static<br />
<br />
=== Open-Xchange ===<br />
<br />
Disable the Open-Xchange IPCheck for session verification. This is required because OX Guard will use the users session cookie to connect to the Open-Xchange REST API, but as a different IP address than the OX Guard server has been used during authentication the request would fail if you don't disable the IPCheck:<br />
<br />
$ vim /opt/open-xchange/etc/server.properties<br />
<br />
and set:<br />
<br />
com.openexchange.IPCheck=false<br />
<br />
The OX Guard UI package has to be installed on all Open-Xchange backend nodes as well, example for Debian (the OX Guard repository has to be configured in the package management prior):<br />
<br />
$ apt-get install open-xchange-guard-ui<br />
<br />
Restart the Open-Xchange service afterwards.<br />
<br />
=== OX Guard ===<br />
<br />
After all the services like MySQL, Apache and Open-Xchange have been configured you need to update the OX Guard backend configuration to point to the correct API endpoints. Set the REST API endpoint to an Apache server by setting the following value in /opt/open-xchange/guard/etc/guard.properties:<br />
<br />
com.openexchange.guard.restApiHostname=apache.example.com<br />
<br />
Per default Guard will try to connect to port 8009 to this host, but as we configured the REST API to be proxies thorugh the serblet /preliminary on every Apache we now also need to change the target port for the REST API. You can do so by adding the following line into /opt/open-xchange/guard/etc/guard.properties:<br />
<br />
com.openexchange.guard.oxBackendPort=80<br />
<br />
Please also change all settings in regards to MySQL like com.openexchange.guard.configdbHostname, com.openexchange.guard.oxguardDatabaseHostname, com.openexchange.guard.databaseUsername or com.openexchange.guard.databasePassword. Afterwards restart the OX Guard service and check the logfile if the OX Guard backend is able to connect to the configured REST API.</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:OX_Guard&diff=18704
AppSuite:OX Guard
2014-10-10T11:57:52Z
<p>Sonja.krause-harder: /* Redhat Enterprise Linux 6 or CentOS 6 */</p>
<hr />
<div>= OX Guard =<br />
<br />
OX Guard is a security solution that provides protection for email communications and files. Fully integrated with both OX as a Service and standard OX App Suite installations, it allows users to send and read encrypted messages and store and share encrypted files – and requires no additional setup or knowledge. OX Guard offers a simple way to increase security by limiting the opportunity for unauthorized access while data is en-route or in-storage, creating extra peace of mind.<br />
<br />
This article will guide you through the installation of Guard and describes the basic configuration and software requirements. As it is intended as a quick walk-through it assumes an existing installation of the operating system including a single server App Suite setup as well as average system administration skills. This guide will also show you how to setup a basic installation with none of the typically used distributed environment settings. The objective of this guide is:<br />
<br />
* To setup a single server installation<br />
* To setup a single Guard instance on an existing Open-Xchange installation, no cluster<br />
* To use the database service on the existing Open-Xchange installation for Guard, no replication<br />
* To provide a basic configuration setup, no mailserver configuration<br />
<br />
== Key features ==<br />
<br />
* Simple security at the touch of a button<br />
* Provides user based security - Separate from provider<br />
* Supplementary security to Provider based security - Layered<br />
* Powerful features yet simple to use and understand<br />
* Security - Inside and outside of the OX environment<br />
* Email and Drive integration<br />
* Uses proven PGP security<br />
<br />
== Availability ==<br />
<br />
If an OX App Suite customer would like to evaluate OX Guard integration, the first step is to contact OX Sales. OX Sales will then work on the request and send prices and license/API (for the hosted infrastructure) key details to the customer.<br />
<br />
== Requirements ==<br />
<br />
Please review following URL for remaining requirements <br />
<br />
Please review [[AppSuite:OX_System_Requirements#OX_Guard|OX Guard Requirements]] for a full list of requirements.<br />
<br />
Since OX Guard is a Microservice it can either be added to an existing Open-Xchange installation or it can be deployed on a dedicated environment without having any of the other Open-Xchange App Suite core services installed. OX App Suite v7.6.0 or later is required to operate this extension both in a single or multi server environments.<br />
<br />
Prerequisites:<br />
* Open-Xchange REST API<br />
* Grizzly HTTP connector (open-xchange-grizzly)<br />
* A supported Java Virtual Machine (Java 7)<br />
* An Open-Xchange App Suite installation v7.6.0 or later<br />
* Please Note: To get access to the latest minor features and bug fixes, you need to have a valid license. The article [[AppSuite:UpdatingOXPackages|Updating OX-Packages]] explains how that can be done.<br />
<br />
== Please Note ==<br />
<br />
OX Guard version 1.0 supports branding / theming using the configuration cascade, defining a templateID for a user or context. Additional details will be provided in customization documentation<br />
<br />
= Download and Installation =<br />
<br />
=== General ===<br />
The installation of the open-xchange-rest package which is required for Guard will eventually execute database update tasks if installed and activated. Please take this into account.<br />
<br />
=== Redhat Enterprise Linux 6 or CentOS 6 ===<br />
<br />
If not already done, add the following repositories to your Open-Xchange yum configuration:<br />
<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products|pc2n=rhelname|pc2v=RHEL6|appsuite/stable/guard-backend}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products|pc2n=rhelname|pc2v=RHEL6|appsuite/stable/guard-ui}}<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-rest open-xchange-guard open-xchange-guard-ui open-xchange-guard-ui-static<br />
<br />
=== Debian GNU/Linux 7.0 ===<br />
<br />
If not already done, add the following repositories to your Open-Xchange apt configuration:<br />
<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products|pc2n=debianname|pc2v=DebianWheezy|appsuite/stable/guard-backend}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products|pc2n=debianname|pc2v=DebianWheezy|appsuite/stable/guard-ui}}<br />
<br />
and run<br />
<br />
$ apt-get update<br />
$ apt-get install open-xchange-rest open-xchange-guard open-xchange-guard-ui open-xchange-guard-ui-static<br />
<br />
=== SUSE Linux Enterprise Server 11 ===<br />
<br />
Add the package repository using zypper if not already present:<br />
<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products|pc2n=susename|pc2v=SLES11|appsuite/stable/guard-backend}}<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products|pc2n=susename|pc2v=SLES11|appsuite/stable/guard-ui}}<br />
<br />
and run<br />
<br />
$ zypper ref<br />
$ zypper in open-xchange-rest open-xchange-guard open-xchange-guard-ui open-xchange-guard-ui-static<br />
<br />
Guard requires Java 1.7, which will be installed through the Guard packages, still SUSE Linux Enterprise Server 11 will not use Java 1.7 by default. Therefor we have to set Java 1.7 as the default instead of Java 1.6:<br />
<br />
$ update-alternatives --config java<br />
<br />
Now select the Java 1.7 JRE, example:<br />
<br />
There are 2 alternatives which provide `java'.<br />
<br />
Selection Alternative<br />
-----------------------------------------------<br />
* 1 /usr/lib64/jvm/jre-1.6.0-ibm/bin/java<br />
+ 2 /usr/lib64/jvm/jre-1.7.0-ibm/bin/java<br />
<br />
Press enter to keep the default[*], or type selection number: 2<br />
Using '/usr/lib64/jvm/jre-1.7.0-ibm/bin/java' to provide 'java'.<br />
<br />
= Update OX Guard =<br />
<br />
=== Redhat Enterprise Linux 6 or CentOS 6 ===<br />
<br />
If not already done, add the following repositories to your Open-Xchange yum configuration:<br />
<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products|pc2n=rhelname|pc2v=RHEL6|appsuite/7.6.0/guard-backend/updates}}<br />
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|appsuite/7.6.0/guard-ui/updates}}<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum upgrade<br />
<br />
After the new packages are installed, the guard process needs a restart:<br />
<br />
<pre>$ /etc/init.d/open-xchange-guard restart</pre><br />
<br />
=== Debian GNU/Linux 7.0 ===<br />
<br />
If not already done, add the following repositories to your Open-Xchange apt configuration:<br />
<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products|pc2n=debianname|pc2v=DebianWheezy|appsuite/7.6.0/guard-backend/updates}}<br />
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products|pc2n=debianname|pc2v=DebianWheezy|appsuite/7.6.0/guard-ui/updates}}<br />
<br />
Then run<br />
<br />
$ apt-get update<br />
$ apt-get dist-upgrade<br />
<br />
If you want to see, what apt-get is going to do without actually doing it, you can run:<br />
<br />
$ apt-get dist-upgrade -s<br />
<br />
After the new packages are installed, the guard process needs a restart:<br />
<br />
<pre>$ /etc/init.d/open-xchange-guard restart</pre><br />
<br />
=== SUSE Linux Enterprise Server 11 ===<br />
<br />
Add the package repository using zypper if not already present:<br />
<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products|pc2n=susename|pc2v=SLES11|appsuite/7.6.0/guard-backend/updates}}<br />
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products|pc2n=susename|pc2v=SLES11|appsuite/7.6.0/guard-ui/updates}}<br />
<br />
and run<br />
<br />
$ zypper dup -r appsuite-7.6.0-guard-backend-updates<br />
$ zypper dup -r appsuite-7.6.0-guard-ui-updates<br />
<br />
You might need to run<br />
<br />
$ zypper ref<br />
<br />
to update the repository metadata before running ''zypper up''.<br />
<br />
After the new packages are installed, the guard process needs a restart:<br />
<br />
<pre>$ open-xchange-guard restart</pre><br />
<br />
= Configuration =<br />
<br />
The following gives an overview of the most important settings to enable Guard for users on the Open-Xchange installation. Some of those settings have to be modified in order to establish the database and REST API access from the Guard service. All settings relating to the Guard backend component are located in the configuration file guard.properties located in /opt/open-xchange/guard/etc. The default configuration should be sufficient for a basic "up-and-running" setup (with the exception of defining the database username and password). Please refer to the inline documentation of the configuration file for more advanced options.<br />
<br />
$ vim /opt/open-xchange/guard/etc/guard.properties<br />
<br />
Open-Xchange config_db host - Guard will establish a connection to the config_db<br />
<br />
com.openexchange.guard.configdbHostname=localhost<br />
<br />
Guard database for storing user keys<br />
<br />
com.openexchange.guard.oxguardDatabaseHostname=localhost<br />
<br />
Username and Password for the two databases above<br />
<br />
com.openexchange.guard.databaseUsername=openexchange<br />
com.openexchange.guard.databasePassword=db_password<br />
<br />
Open-Xchange REST API host<br />
<br />
com.openexchange.guard.restApiHostname=localhost<br />
<br />
External URL for this Open-Xchange installation. This setting will be used to generate the link to the secure content for external recipients<br />
<br />
com.openexchange.guard.externalEmailURL=URL_TO_OX<br />
<br />
== Configure services ==<br />
<br />
=== Apache ===<br />
<br />
Configure the mod_proxy_http module by adding the Guard API.<br />
<br />
'''Redhat Enterprise Linux 6 or CentOS 6'''<br />
$ vim /etc/httpd/conf.d/proxy_http.conf<br />
<br />
'''Debian GNU/Linux 7.0 and SUSE Linux Enterprise Server 11'''<br />
$ vim /etc/apache2/conf.d/proxy_http.conf<br />
<br />
<Proxy balancer://oxguard><br />
Order deny,allow<br />
Allow from all<br><br />
BalancerMember http://localhost:8080/oxguard timeout=1800 smax=0 ttl=60 retry=60 loadfactor=100 route=OX1<br />
ProxySet stickysession=JSESSIONID|jsessionid scolonpathdelim=ON<br />
SetEnv proxy-initial-not-pooled<br />
SetEnv proxy-sendchunked<br />
</Proxy><br><br />
<br />
ProxyPass /appsuite/api/oxguard balancer://oxguard<br />
<br />
'''Please Note:''' The Guard API settings must be inserted before the existing “<Proxy /appsuite/api>” parameter.<br />
<br />
After the configuration is done, restart the Apache webserver<br />
<br />
$ apachectl restart<br />
<br />
=== Open-Xchange ===<br />
<br />
Please add the following settings to a new configuration file on the Open-Xchange backend servers:<br />
<br />
$ vim /opt/open-xchange/etc/guard.properties<br />
<br />
# OX GUard general permission, required to activate Guard in the AppSuite UI.<br />
com.openexchange.capability.guard=true<br />
<br />
# Default theme template id for all users that have no custom template id configured.<br />
com.openexchange.guard.templateID=0<br />
<br />
=== SELinux ===<br />
<br />
Running SELinux prohibits your local Open-Xchange backend service to connect to localhost:8080, which is where the Guard backend service listens to. In order to allow localhost connections to 8080 execute the following:<br />
<br />
$ setsebool -P httpd_can_network_connect 1<br />
<br />
== Initiating the Guard database and key store ==<br />
<br />
Once the Guard configuration (database and backend configuration) and the service configuration has been applied, the Guard administration script needs to be executed in order to create the Guard databases. The administration script also takes care of the creation of the master keys and the master password file in /opt/open-xchange/guard. The initiation only needs to be done once for a multi server setup, for details please see “Optional / Clustering”.<br />
<br />
/opt/open-xchange/guard/sbin/guard init<br />
<br />
'''Please Note:''' It is important to understand that the master password file located at /opt/open-xchange/guard/oxguardpass is required to reset user passwords, without them the administrator will not be able to reset user passwords anymore in the future. The file contains the passwords used to encrypt the master database key, as well as passwords used to encrypt protected data in the users table.<br />
<br />
== Start Guard ==<br />
<br />
The services have been configured and the database has been initiated, it's time to start Guard<br />
<br />
$ /etc/init.d/open-xchange-guard start<br />
<br />
== Enabling Guard for Users ==<br />
<br />
Guard provides two capabilities for users in the environment:<br />
<br />
* '''Guard Mail:''' com.openexchange.capability.guard:mail<br />
* '''Guard Drive:''' com.openexchange.capability.guard:drive<br />
<br />
Each of those two Guard components is enabled for all users that have the according capability configured. Please note that users need to have the Drive permission set to use Guard Drive. So the users that have Guard Drive enabled must be a subset of those users with OX Drive permission. Since v7.6.0 we enforce this via the default configuration. Those capabilities can be activated for specific user by using the Open-Xchange provisioning scripts:<br />
<br />
'''Guard Mail:'''<br />
$ /opt/open-xchange/sbin/changeuser -c 1 -A oxadmin -P admin_password -u testuser --config/com.openexchange.capability.guard:mail=true<br />
<br />
'''Guard Drive:'''<br />
$ /opt/open-xchange/sbin/changeuser -c 1 -A oxadmin -P admin_password -u testuser --config/com.openexchange.capability.guard:drive=true<br />
<br />
'''Please Note:''' Guard Drive requires Guard Mail to be configured for the user as well.<br />
<br />
== Optional ==<br />
<br />
=== SSL Configuration ===<br />
<br />
Per default the connection between the Guard backend and the configured Open-Xchange REST API host is unencrypted. Even though that Guard will never transmit unencrypted emails to or from the REST API you can optionally encrypt the whole communication between those two components by using SSL. To enforce Guard to use SSL in the communication between those two components enable the follwing configuration in Guard configuration file. <br />
<br />
$ vim /opt/open-xchange/guard/etc/guard.properties<br />
<br />
com.openexchange.guard.backend_ssl=true<br />
<br />
The Guard backend is most commonly placed behind a load balancer (APACHE or other) and defaults to HTTP for incoming and outgoing traffic, using the load balancer to do SSL with the users. If you want Guard to use SSL for all communications, you need to set up the SSL key to use.<br />
<br />
Please note that you have to provide access to the certificates.<br />
<br />
com.openexchange.guard.useSSL: true<br />
com.openexchange.guard.SSLPort: 8443<br />
com.openexchange.guard.SSLKeyStore: //keystore location//<br />
com.openexchange.guard.SSLKeyName: //alias name here//<br />
com.openexchange.guard.SSLKeyPass: //ssl password//<br />
<br />
'''Please Note:''' Enabling SSL might decrease performance and/or create more system load due to additional encoding of the HTTP streams.<br />
<br />
== Clustering ==<br />
<br />
You can run multiple OX Guard servers in your environment to ensure high availability or enhance scalability. OX Guard integrates seamlessly into the existing Open-Xchange infrastructure by using the existing interface standards and is therefor transparent to the environment. A couple of things have to be prepared in order to loosely couple OX Guard servers with Open-Xchange servers in a cluster.<br />
<br />
=== MySQL ===<br />
<br />
The MySQL servers need to be configured in order to allow access to the configdb of Open-Xchange. To do so you need to set the following configuration in the MySQL my.cnf:<br />
<br />
bind = 0.0.0.0<br />
<br />
This allows the Guard backend to bind to the MySQL host which is configured in the guard.properties file with com.openexchange.guard.configdbHostname. After the bind for the MySQL instance is configured and the OX Guard backend would be able to connect to the configured host, you have to grant access for the OX Guard service on the MySQL instance to manage the databases. Do so by connecting to the MySQL server via the mysql client. Authenticate if necessary and execute the following, please note that you have to modify the hostname / IP address of the client who should be able to connect to this database, it should include all possible OX Guard servers:<br />
<br />
GRANT ALL PRIVILEGES ON *.* TO 'openexchange'@'oxguard.example.com' IDENTIFIED BY ‘secret’;<br />
<br />
=== Apache ===<br />
<br />
OX Guard uses the Open-Xchange REST API to store and fetch data from the Open-Xchange databases. The REST API is a servlet running in the Grizzly container. By default it is not exposed as a servlet through Apache and is only accessibly via port 8009. In order to use Apache's load balancing via mod_proxy we need to add a servlet called "preliminary" to proxy_http.conf, example based on a clustered mod_proxy configuration:<br />
<br />
<Location /preliminary><br />
Order Deny,Allow<br />
Deny from all<br />
# Only allow access from Guard servers within the network. Do not expose this<br />
# location outside of your network. In case you use a load balancing service in front<br />
# of your Apache infrastructure you should make sure that access to /preliminary will<br />
# be blocked from the internet / outside clients. Examples:<br />
# Allow from 192.168.0.1<br />
# Allow from 192.168.1.1 192.168.1.2<br />
# Allow from 192.168.0.<br />
ProxyPass /preliminary balancer://oxcluster/preliminary<br />
</Location><br />
<br />
Make sure that the balancer is properly configured in the mod_proxy configuration. Examples on how to do so can be found in our clustering configuration for Open-Xchange AppSuite. Like explained in the example above, please make sure that this location is only available in your internal network, there is no need to expose /preliminary to the public, it is only used by Guard servers to connect to the OX backend. If you have a load balancer in front of the Apache cluster you should consider blocking access to /preliminary from WAN to restrict access to the servlet to internal network services only.<br />
<br />
Now add the OX Guard BalancerMembers to the oxguard balancer configuration (also in proxy_http.conf) to address all your OX Guard nodes in the cluster in this balancer configuration. The configuration has to be applied to all Apache nodes within the cluster.<br />
<br />
If the Apache server is a dedicated server / instance you also have to install the OX Guard UI-Static package on all Apache nodes in the cluster in order to provide static files like images or CSS to the OX Guard client. Example for Debian (the OX Guard repository has to be configured in the package management prior):<br />
<br />
$ apt-get install open-xchange-guard-ui-static<br />
<br />
=== Open-Xchange ===<br />
<br />
Disable the Open-Xchange IPCheck for session verification. This is required because OX Guard will use the users session cookie to connect to the Open-Xchange REST API, but as a different IP address than the OX Guard server has been used during authentication the request would fail if you don't disable the IPCheck:<br />
<br />
$ vim /opt/open-xchange/etc/server.properties<br />
<br />
and set:<br />
<br />
com.openexchange.IPCheck=false<br />
<br />
The OX Guard UI package has to be installed on all Open-Xchange backend nodes as well, example for Debian (the OX Guard repository has to be configured in the package management prior):<br />
<br />
$ apt-get install open-xchange-guard-ui<br />
<br />
Restart the Open-Xchange service afterwards.<br />
<br />
=== OX Guard ===<br />
<br />
After all the services like MySQL, Apache and Open-Xchange have been configured you need to update the OX Guard backend configuration to point to the correct API endpoints. Set the REST API endpoint to an Apache server by setting the following value in /opt/open-xchange/guard/etc/guard.properties:<br />
<br />
com.openexchange.guard.restApiHostname=apache.example.com<br />
<br />
Per default Guard will try to connect to port 8009 to this host, but as we configured the REST API to be proxies thorugh the serblet /preliminary on every Apache we now also need to change the target port for the REST API. You can do so by adding the following line into /opt/open-xchange/guard/etc/guard.properties:<br />
<br />
com.openexchange.guard.oxBackendPort=80<br />
<br />
Please also change all settings in regards to MySQL like com.openexchange.guard.configdbHostname, com.openexchange.guard.oxguardDatabaseHostname, com.openexchange.guard.databaseUsername or com.openexchange.guard.databasePassword. Afterwards restart the OX Guard service and check the logfile if the OX Guard backend is able to connect to the configured REST API.</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:UI_build_system&diff=18678
AppSuite:UI build system
2014-10-02T13:24:34Z
<p>Sonja.krause-harder: </p>
<hr />
<div>{{Stability-deprecated}}<br />
<br />
<div class="title">Build System</div><br />
<br />
'''Abstract:''' This document describes the build system of OX App Suite. It is intended for app developers who use the build system to create apps as well as for OX App Suite developers who not only use the build system but also may wish to extend it.<br />
<br />
The build system is used to create source archives from source files. These source archives can be used to compile installable packages for various Linux distributions. The build system can generate archives for the core UI as well as for independently installed apps.<br />
<br />
The OX App Suite build system uses [https://github.com/mde/jake Jake], a port of Rake from Ruby to [http://nodejs.org Node.js]. Both Rake and Jake are dependency-based build systems like Make, which allows quick incremental builds. But unlike Make, Jake doesn't have its own syntax. Instead, it provides an API in JavaScript. The API is used not only to specify dependencies between files using a full programming language, but also to implement the generation of files in the same language. This allows easy implementation of complex build systems, of which the OX App Suite build system is an example. Using the same language for the developed project and for its build system also allows any core developer to quickly extend the build system without having to switch to another language.<br />
<br />
== Using the Build System ==<br />
<br />
While easily extensible, most of the time the build system will be used as-is. This chapter describes how to set up and use the build system to develop apps and the OX App Suite core.<br />
<br />
All command examples are given for the Debian operating system. The instructions should work similarly on other POSIX systems. The first character of each command indicates whether it should be executed as root (#) or as a normal user ($).<br />
<br />
== Installing ==<br />
<br />
Installing the right environment for running the <code>appserver</code> and the UI build system is described in [[AppSuite:GettingStarted#Installing | the getting started article]].<br />
<br />
== Running ==<br />
<br />
The build system is executed by invoking the command <code>build-appsuite</code>. Similar to most build systems, the build system can perform multiple tasks, which are specified as parameters on the command line. Each task can require any number of parameters. These parameters can be specified either on the command line, using the syntax <code>name=value</code>, or as environment variables.<br />
<br />
If present, the file <code>local.conf</code> is sourced by a shell script before the build process starts. This file can export environment variables which are specific to the local system, without checking them into a version control system. Typically, it defines values for <code>[[#builddir|builddir]]</code> and <code>[[#debug|debug]]</code>.<br />
<br />
Since the build system is based on Jake, it also accepts all other Jake options. In addition, the environment variable <code>$nodeopts</code> can be used to pass command line parameters to Node.js. One of the most useful parameters is <code>--debug-brk</code>, which can be used to debug the build system.<br />
<br />
When developing external apps, the build system must be run from the top directory of the app's source. As a safety precaution, execution is aborted if the subdirectory <code>apps</code>, which usually contains JavaScript source code, is not found. This Article is written assuming, you're working in your workspace directory, containing the subfolder <code>apps</code>.<br />
<br />
== Workflow ==<br />
<br />
The build system is used not only to create source archives for packaging. It can also directly install and update the built UI in a directory during development, help with the setup of the source of a new external app and more. While all of these tasks are described in the reference section, daily work involves just a few of them.<br />
<br />
To have an easy example about how to [[AppSuite:GettingStarted#Writing | write]], [[AppSuite:GettingStarted#Building | build]] & [[AppSuite:GettingStarted#Running | host]] your javascript code and how to [[AppSuite:GettingStarted#Initialization | initialize]] & [[AppSuite:GettingStarted#Building_Packages | build]] your packages, please have a look at the [[AppSuite:GettingStarted | GettingStarted article]].<br />
<br />
==== JSHINT ====<br />
<br />
One step of the build process is running jshint to statically analyse the sources for certain errors. JSHint is configured with (what we think) sane defaults, but if you want to configure your own rules, edit <code>.jshintrc</code> in your project`s root folder, according to your needs.<br />
<br />
=== default ===<br />
<br />
The default task is used instead of the app task when building the core OX App Suite. Since it is the default Jake task, it is not necessary to specify it on the command line when it's the only task.<br />
<br />
The top directory of OX App Suite source code includes the script <code>build.sh</code>, which should be used instead of calling a potentially unrelated version of <code>build-appsuite</code>. The script changes the current directory to its own, so that it can be called from any directory.<br />
<br />
$ web/ui/build.sh<br />
<br />
=== clean ===<br />
<br />
The build system uses dependencies and file timestamps to decide which files to rebuild. This assumes that any change to a file increases its timestamp to a value which is greater than the timestamp of any existing file. When this assumption is violated (e.g. after switching to a different source control branch with older files) it may become necessary to rebuild everything to restore the assumption about timestamps. The simplest way to achieve this is the clean task, which simply deletes all generated files.<br />
<br />
WARNING: This can be potentially dangerous, since the clean task simply deletes the directories specified by the variables builddir, destDir, l10nDir, manifestDir, and helpDir.<br />
<br />
=== dist ===<br />
<br />
When the app is ready to be shipped, or rather all the time on a continuous build system, the app needs to be packaged in a format suitable for installation on a production system. Since there already exist tools to create packages from suitably arranged source code archives, the OX App Suite build system merely prepares such source archives.<br />
<br />
The dist task creates an archive with the source (the one ending in .orig.tar.bz2) and a few additional files necessary for Debian packaging. RPM packages can be generated using the same source archive and the .spec file created by init-packaging. The version of the package is extracted from the newest entry in the file debian/changelog.<br />
<br />
Debian packages can also be generated manually either from the temporary directory left behind by dist, or even directly from the source tree. The second option pollutes the source tree with generated files, so it is not recommended, although the .gitignore file created by init-packaging can handle these generated files.<br />
<br />
$ build-appsuite dist<br />
$ ls tmp/packaging/<br />
example-app-0.0.1 example-app_0.0.1-1.dsc<br />
example-app_0.0.1-1.debian.tar.bz2 example-app_0.0.1.orig.tar.bz2<br />
$ cd tmp/packaging/example-app-0.0.1/<br />
$ dpkg-buildpackage -b<br />
<br />
== Reference ==<br />
<br />
=== Variables ===<br />
<br />
==== BASEDIR ====<br />
The top directory of the build system.<br />
<br />
<b>Used by:</b> all tasks.<br />
<br />
<b>Default:</b> installation directory of the build system<br />
<br />
Required to build external apps, since in this case, the build<br />
system is not installed in the current directory. This variable is<br />
automatically set as an environment variable by the build system<br />
executable based on <code>$OX_APPSUITE_DEV</code>.<br />
<br />
==== branch ====<br />
The Subversion branch of the CLDR to checkout.<br />
<br />
<b>Used by:</b> <code>update-i18n</code>.<br />
<br />
==== builddir ====<br />
The target directory for generated files.<br />
<br />
<b>Used by:</b> <code>app</code>, <code>clean</code>,<br />
<code>default</code>, <code>dist</code>, <code>docs</code>,<br />
<code>jakedeps</code>.<br />
<br />
Default: <code>build</code><br />
<br />
==== copyright ====<br />
The copyright line to be included in packaging metadata.<br />
<br />
<b>Used by:</b> <code>[[#init-packaging|init-packaging]]</code>.<br />
<br />
<b>Example:</b> <code>2012 Open-Xchange, Inc</code><br />
<br />
==== coreDir ====<br />
Location of OX App Suite UI files.<br />
<br />
<b>Used by:</b> <code>[[#app|app]]</code>, <code>[[#default|default]]</code>.<br />
<br />
<b>Default:</b> same as <code>[[#builddir|builddir]]</code><br />
<br />
Some tasks depend on installed files from the OX App Suite. When building external apps, <code>[[#coreDir|coreDir]]</code> specified the directory which contains these files.<br />
<br />
Currently, this parameter is used to compile <code>.less</code> files for every installed theme. This can be disabled by setting <code>[[#skipLess|skipLess]]</code>.<br />
<br />
==== debug ====<br />
Enables a debug build.<br />
<br />
<b>Used by:</b> <code>app</code>, <code>default</code>.<br />
<br />
<b>Default:</b> <code>false</code><br />
<br />
To simplify debugging of OX App Suite, compression of source code<br />
can be disabled by specifying <code>on</code>, <code>yes</code>,<br />
<code>true</code> or <code>1</code>.<br />
<br />
==== description ====<br />
<b>Used by:</b> <code>init-packaging</code>.<br />
<br />
The description of the app to be included in packaging metadata.<br />
<br />
==== destDir ====<br />
Output directory for source archives created by<br />
the <code>dist</code> task.<br />
<br />
<b>Used by:</b> <code>clean</code>, <code>dist</code>.<br />
<br />
<b>Default:</b> <code>tmp/packaging</code><br />
<br />
==== disableStrictMode ====<br />
Removes all <code>"use strict"</code> directives from processed<br />
JavaScript code.<br />
<br />
<b>Used by:</b> <code>app</code>, <code>default</code>.<br />
<br />
<b>Default:</b> <code>false</code><br />
<br />
Some debugging tools which use code instrumentation have problems<br />
when the debugged code uses strict mode. This setting enables code<br />
processing even whe using <code>debug</code> mode, so line numbers<br />
will not match the original source code.<br />
<br />
==== forceDeb ====<br />
Whether an error during the generation of Debian source packages is an error.<br />
<br />
<b>Used by:</b> <code>dist</code>.<br />
<br />
<b>Default:</b> <code>false</code><br />
<br />
This is useful when Debian packages are generated automatically, and a failure of <code>dpkg-source</code> is also a failure of the entire build. By default it merely produces a warning.<br />
<br />
==== from ====<br />
The root of the printed dependency tree between Jake tasks.<br />
<br />
<b>Used by:</b> <code>jakedeps</code>.<br />
<br />
==== helpDir ====<br />
The location of online help files.<br />
<br />
<b>Used by:</b> <code>clean</code>, <code>default</code>,<br />
<code>dist</code>.<br />
<br />
<b>Default:</b> same as <code>builddir</code><br />
<br />
If the value contains the string <code>@lang@</code>, it will be<br />
replaced by the lowercase language code (e.g. <code>en-us</code>) to<br />
allow per-language directories.<br />
<br />
==== l10nDir ====<br />
The location of compiled l10n files.<br />
<br />
<b>Used by:</b> <code>app</code>, <code>clean</code>,<br />
<code>default</code>, <code>dist</code>.<br />
<br />
<b>Default:</b> same as <code>builddir</code><br />
<br />
If the value contains the string <code>@lang@</code>, it will be<br />
replaced by the lowercase language code (e.g. <code>en-us</code>) to<br />
allow per-language directories.<br />
<br />
==== license ====<br />
File name of the full text of the distribution license.<br />
<br />
<b>Used by:</b> <code>init-packaging</code>.<br />
<br />
<b>Default:</b> based on <code>licenseName</code>.<br />
<br />
==== licenseName ====<br />
Name of the distribution license to be included in packaging<br />
metadata.<br />
<br />
<b>Used by:</b> <code>init-packaging</code>.<br />
<br />
<b>Default:</b> <code>CC-BY-NC-SA-3.0</code><br />
<br />
==== manifestDir ====<br />
The location of the combined manifest file.<br />
<br />
<b>Used by:</b> <code>app</code>, <code>clean</code>,<br />
<code>default</code>, <code>dist</code>.<br />
<br />
<b>Default:</b> same as <code>builddir</code><br />
<br />
==== maintainer ====<br />
Name and email address of the package maintainer.<br />
<br />
<b>Used by:</b> <code>init-packaging</code>.<br />
<br />
<b>Format:</b> <code><var>Name</var> &lt;<var>email</var>&gt;</code><br />
<br />
==== package ====<br />
The name of the package for the built app.<br />
<br />
<b>Used by:</b> all tasks.<br />
<br />
<b>Default:</b> the package name in the first line of<br />
<code>debian/changelog</code><br />
<br />
Since the name of the manifest file contains the package name and it<br />
is required to determine build dependencies, the package name must<br />
be always known. This means either <code>debian/changelog</code><br />
must exist and contain at least one entry, or the parameter must be<br />
explicitly specified.<br />
<br />
==== reverse ====<br />
Reverses the direction of printed dependencies.<br />
<br />
<b>Used by:</b> <code>deps</code>.<br />
<br />
When specified, the <code>deps</code> task prints modules which<br />
depend on the specified modules, instead of modules on which<br />
the specified module depends.<br />
<br />
==== revision ====<br />
Revision number of the package for the app.<br />
<br />
<b>Used by:</b> <code>app</code>, <code>default</code>,<br />
<code>dist</code>.<br />
<br />
<b>Default:</b> <code>1</code><br />
<br />
The revision number must increase with each rebuild of the same<br />
version to enable the creation of unique version strings. These are<br />
required in package names and to control content caching in clients.<br />
<br />
==== root ====<br />
Specifies for which module to print the dependencies.<br />
<br />
<b>Used by:</b> <code>deps</code>.<br />
<br />
<b>Default:</b> print all roots<br />
<br />
If specified, only the dependencies of the specified module are<br />
printed. Otherwise, the dependencies of all modules are printed.<br />
<br />
==== skipDeb ====<br />
Whether to skip the generation of Debian source packages.<br />
<br />
<b>Used by:</b> <code>dist</code>.<br />
<br />
<b>Default:</b> <code>false</code><br />
<br />
This is useful when Debian packages are not required and/or<br />
<code>dpkg-source</code> is not available, e.g. on RPM based<br />
systems.<br />
<br />
Even when using this flag, at least the file<br />
<code>debian/changelog</code> is still required, because it is used<br />
to store the package name and version. <br />
<br />
==== skipLess ====<br />
Whether to skip the preprocessing of LessCSS files.<br />
<br />
<b>Used by:</b> <code>app</code>, <code>default</code>.<br />
<br />
<b>Default:</b> <code>false</code><br />
<br />
This flag skips the generation of CSS files in<br />
the <code>apps/themes/*/less</code> directories of all themes.<br />
It is used by the packaging system, where the LessCSS files are<br />
precompiled after installation on the target system instead of<br />
while building the package.<br />
<br />
==== tag ====<br />
The Subversion tag of the CLDR to checkout.<br />
<br />
<b>Used by:</b> <code>update-i18n</code>.<br />
<br />
==== to ====<br />
The leaf task in the printed dependency path between Jake tasks.<br />
<br />
<b>Used by:</b> <code>jakedeps</code>.<br />
<br />
When specified, only a single path from the root to the leaf task is<br />
printed (in reverse order).<br />
<br />
==== version ====<br />
Version number of the app.<br />
<br />
<b>Used by:</b> <code>app</code>, <code>default</code>,<br />
<code>dist</code>, <code>init-packaging</code>.<br />
<br />
<b>Default:</b> <code>0.0.1</code><br />
<br />
The version should consist of a major, minor and patch version<br />
separated by dots.<br />
<br />
=== Tasks ===<br />
<p><br />
An up-to-date list of tasks can be printed using the -T command line option.<br />
<br />
==== app ====<br />
Builds an external app.<br />
<br />
<b>Variables:</b> <code>[[#BASEDIR|BASEDIR]]</code>, <code>[[#builddir|builddir]]</code>, <code>[[#coreDir|coreDir]]</code>, <code>[[#debug|debug]]</code>, <code>[[#disableStrictMode|disableStrictMode]]</code>, <code>[[#l10nDir|l10nDir]]</code>, <code>[[#manifestDir|manifestDir]]</code>, <code>[[#package|package]]</code>, <code>[[#revision|revision]]</code>, <code>[[#version|version]]</code>.<br />
<br />
This is the main task used to build external apps.<br />
<br />
It works without explicitly specifying any variables, but during<br />
development, <code>[[#builddir|builddir]]</code> is usually pointed to<br />
the directory of a locally installed OX App Suite UI to avoid<br />
additional copying steps. For debugging, <code>[[#debug|debug]]</code> is also<br />
often used. Note that <code>[[#clean|clean]]</code> must be called when<br />
changing any of the variables.<br />
<br />
==== clean ====<br />
Removes all generated files.<br />
<br />
<b>Variables:</b> <code>BASEDIR</code>, <code>builddir</code>,<br />
<code>destDir</code>, <code>l10nDir</code>,<br />
<code>manifestDir</code>, <code>package</code>.<br />
<br />
This task should be executed before a normal build using<br />
<code>app</code> or <code>default</code> after changing any build<br />
variables and after a switch between Git branches. Normal<br />
incremental builds can miss changed files if a branch switch<br />
replaces files by older versions.<br />
<br />
==== default ====<br />
Builds OX App Suite.<br />
<br />
<b>Variables:</b> <code>[[#BASEDIR|BASEDIR]]</code>, <code>[[#builddir|builddir]]</code>, <code>[[#debug|debug]]</code>, <code>[[#disableStrictMode|disableStrictMode]]</code>, <code>[[#l10nDir|l10nDir]]</code>, <code>[[#manifestDir|manifestDir]]</code>, <code>[[#package|package]]</code>, <code>[[#revision|revision]]</code>, <code>[[#version|version]]</code>.<br />
<br />
This is the main task to build OX App Suite. Since it is the default<br />
Jake task, it does not need to be specified explicitly on<br />
the command line when it is the only task.<br />
<br />
It works without explicitly specifying any variables, but during<br />
development, <code>[[#builddir|builddir]]</code> is usually pointed to<br />
a directory which is accessible to a local web server. For<br />
debugging, <code>[[#debug|debug]]</code> is also often used. Note that<br />
<code>[[#clean|clean]]</code> must be called when changing any of<br />
the variables.<br />
<br />
==== deps ====<br />
Prints module dependencies.<br />
<br />
<b>Variables:</b> <code>BASEDIR</code>, <code>package</code>,<br />
<code>reverse</code>, <code>root</code>.<br />
<br />
This task visualizes dependencies of RequireJS modules. It prints<br />
a tree of dependencies to <code>stdout</code>.<br />
<br />
If <code>root</code> is specified, then only the dependencies of<br />
that module are printed. Otherwise, the dependencies of all modules,<br />
on which no other module depends are printed in sequence. <br />
<br />
If <code>reverse</code> is specified, then this task prints<br />
dependants instead of dependencies, i.e. modules which depend on<br />
the specified module instead of modules on which the specified<br />
module depends.<br />
<br />
==== dist ====<br />
Creates source packages.<br />
<br />
<b>Variables:</b> <code>BASEDIR</code>, <code>builddir</code>,<br />
<code>destDir</code>, <code>forceDeb</code>, <code>l10nDir</code>,<br />
<code>manifestDir</code>, <code>package</code>,<br />
<code>revision</code>, <code>skipDeb</code>,<br />
<code>version</code>.<br />
<br />
This task cleans the source tree by calling <code>clean</code> and<br />
packs the source into an archive which can be used to create Debian<br />
and RPM packages. The necessary Debian metadata is created alongside<br />
the source archive. All files necessary for Debian packaging are<br />
placed in the directory specified by <code>destDir</code>.<br />
The generated <code>.orig.tar.bz2</code> archive can also be used<br />
together with the <code>.spec</code> file to generate RPM packages.<br />
<br />
Unless the variable <code>skipDeb</code> is set to<br />
<code>true</code>, the program <code>dpkg-source</code> is required<br />
by this task. It is used to generate Debian-specific packaging<br />
metadata.<br />
<br />
==== init-packaging ====<br />
Initializes packaging information for a new app.<br />
<br />
<b>Variables:</b> <code>BASEDIR</code>, <code>copyright</code>,<br />
<code>description</code>, <code>license</code>,<br />
<code>licenseName</code>, <code>maintainer</code>,<br />
<code>package</code>, <code>version</code>.<br />
<br />
This task is the first task called when starting with<br />
the development of a new external app. The directory from which it<br />
is called must already contain at least the <code>apps</code><br />
subdirectory. This is also the only task where<br />
the <code>package</code> variable must be specified explicitly.<br />
Afterwards, the package name is looked up automatically in the file<br />
<code>debian/changelog</code>, which is created by this task.<br />
<br />
The variables <code>version</code>, <code>maintainer</code>,<br />
<code>copyright</code>, <code>licenseName</code>,<br />
<code>license</code>, and <code>description</code> are required to<br />
fill out all necessary packaging metadata. Any of these variables<br />
which are not specified explicitly will cause an interactive prompt.<br />
This avoids the need to remember the list of variables before one<br />
can start developing an app.<br />
<br />
==== jakedeps ====<br />
Shows the dependency chain between two Jake tasks.<br />
<br />
<b>Variables:</b> <code>BASEDIR</code>, <code>from</code>,<br />
<code>package</code>, <code>to</code>.<br />
<br />
This task visualized dependencies between Jake tasks. The variable<br />
<code>from</code> specifies the root of a dependency tree, with all<br />
dependencies of <code>from</code> as inner and leaf nodes. If<br />
<code>to</code> is not specified, then that entire tree is printed.<br />
<br />
If <code>to</code> is also specified, then only the first found<br />
dependency path from <code>from</code> to <code>to</code> is<br />
.printed with <code>to</code> at the top and <code>from</code> at<br />
the bottom.<br />
<br />
==== merge ====<br />
Updates all <code>.po</code> files with the generated<br />
<code>ox.pot</code>.<br />
<br />
<b>Variables:</b> <code>BASEDIR</code>, <code>builddir</code>,<br />
<code>debug</code>, <code>package</code>, <code>revision</code>,<br />
<code>version</code>.<br />
<br />
This task updates the list of extracted i18n strings in<br />
<code>ox.pot</code> and calls the GNU Gettext tool<br />
<code>msgmerge</code> for every language in <code>i18n/*.po</code>.<br />
<br />
<code>i18n/en_US.po</code> is not updated by this task because the original strings are already in the <code>en_US</code> locale. It would only end up with every translation mapping every string to itself. The only entries in that file should be for cases when the <code>en_US</code> text is not a suitable fallback for missing translations. The original string in such a case would be something internationally appropriate (e.&nbsp;g. a date written as "2013-01-01" instead of "01/01/2013") and <code>i18n/en_US.po</code> would contain a translation.<br />
<br />
==== update-i18n ====<br />
Updates CLDR data in the source tree.<br />
<br />
<b>Variables:</b> <code>BASEDIR</code>, <code>branch</code>,<br />
<code>package</code>, <code>tag</code>.<br />
<br />
This task downloads data from the Unicode CLDR and updates date<br />
translations for all languages in <code>i18n/*.po</code>.<br />
<br />
The exact version of CLDR data is specified as Suubversion tag or<br />
branch by the variables <code>tag</code> and <code>branch</code>,<br />
respectively. If neither is specified, then the Subversion trunk is<br />
checked out. If both are specified, <code>tag</code> is used.<br />
<br />
==== verify-doc ====<br />
Generates a documentation skeleton for extension points.<br />
<br />
<b>Variables:</b> <code>BASEDIR</code>, <code>package</code>.<br />
<br />
This task is still under development. Currently, it creates a list of all extension points, which have a constant name in the source code. In the future it is supposed to update an existing list instead of overwriting it, and to handle non-constant extension point names.<br />
<br />
The list of extension points is stored as an HTML snippet in <code>doc/extensionpoints.html</code>.<br />
<br />
<br />
[[Category:AppSuite]]<br />
[[Category:UI]]</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:Theming&diff=18677
AppSuite:Theming
2014-10-02T13:18:42Z
<p>Sonja.krause-harder: </p>
<hr />
<div>{{Stability-experimental}}<br />
<br />
<div class="title">Theming</div><br />
<br />
'''Abstract.''' In this article, you can learn how to create customized themes and use them to change the look of you appsuite installation.<br />
__TOC__<br />
== LESS.JS ==<br />
Appsuite used LESS as dynamic stylesheet language. LESS extends CSS with dynamic behavior such as variables, mixins, operations and functions.<br />
<br />
Please read [http://lesscss.org/#docs LESS.JS] documentation first.<br />
<br />
=== Using less.js ===<br />
If your theme depends on less.js, you will need one more step to make it work. Why? To accelerate the login, compilation of LessCSS files was moved from the login process in the browser to the installation process on the backend. <br />
<br />
Backend packages for themes and any apps which ship .less files require the following changes:<br />
<br />
1. Add "skipLess=1" to the build command in *.spec and in debian/rules:<br />
sh /opt/open-xchange-appsuite-dev/bin/build-appsuite app skipLess=1<br />
2. Add %post and %postun sections to *.spec:<br />
%post<br />
if [ "$1" = 1 ]; then<br />
UPDATE=/opt/open-xchange/appsuite/share/update-themes.sh<br />
[ -x $UPDATE ] && $UPDATE<br />
fi<br />
%postun<br />
UPDATE=/opt/open-xchange/appsuite/share/update-themes.sh<br />
[ -x $UPDATE ] && $UPDATE<br />
<br />
For multiple binary packages, the %post and %postun sections should apply only to backend packages <br />
which contain .less files.<br />
<br />
3. Add debian/postinst and debian/postrm containing the same content:<br />
#!/bin/sh<br />
UPDATE=/opt/open-xchange/appsuite/share/update-themes.sh<br />
[ -x $UPDATE ] && $UPDATE<br />
<br />
For multiple binary packages, the postinst and postrm files should apply only to backend packages which contain .less files.<br />
<br />
Note: Since 7.2.1, LessCSS files must have the file extension .less to be usable with the 'less' RequireJS plugin (module dependencies of the form 'less!filename.less'). Previously we were more lenient and dealt with .css, too.<br />
<br />
== File structure ==<br />
A theme basically consists of two files located in <code>/opt/open-xchange/appsuite/apps/themes/<var>THEME_ID</var>/</code>. These files are described in this and the following sections.<br />
<br />
<code><var>THEME_ID</var></code> is a unique identifier for your theme, which is not visible to users. By convention, it is best derived from a domain name you control, e.g. <code>com.example.prettytheme</code>.<br />
<br />
=== definitions.less ===<br />
This file can be used to override variables described in the "Variables" section of this article.<br />
<br />
=== style.less ===<br />
This file can be used to define any CSS you like. Before doing this, check, if there really is no variable that can be used to achieve the same thing.<br />
<br />
=== Referencing paths ===<br />
Since 7.2.1, all URLs are relative to the source .less file in which they are contained. This means that unless a theme changes an image it does not need to include that image anymore. <br />
<br />
Old themes must be updated if they change an image from the default theme: All styles from the default theme which refer to a changed image must be overwritten in the custom theme. This way the URLs resolve to the new image.<br />
<br />
== Variables ==<br />
<br />
Naming of the variables should be straight forward. Variables containing the word ''Background'' will always refer to the background color. Variables containing ''Color'' will refer to the foreground color of an element, like color of a font. ''Hover'' in most cases means "hovered" elements. ''Selected'' relates to the currently selected item. Elements that are supposed to catch the users eye can use the ''Highlight'' class and the variable contains this word.<br />
<br />
Variables are defined in variables.less from twitter-bootstrap and our default definitions.less. Variables that are defined in definitions.less always override variables from bootstrap's variables.less<br />
<br />
=== Most relevant variables ===<br />
<br />
{|<br />
! Variable (7.6.x) || Variable (7.4.x) || Default (7.6.x)<br />
|-<br />
| @topbar-background || @topbarBackground || #3774A8 (blue)<br />
|-<br />
| --- || @topbarBackgroundAlt || No longer used<br />
|-<br />
| @topbar-launcher-color || @topbarLauncherColor || rgba(255, 255, 255, 0.70)<br />
|-<br />
| @topbar-launcher-color-hover || @topbarLauncherColor-hover || #fff<br />
|-<br />
| @topbar-launcher-color-active || @topbarLauncherColorActive || #fff<br />
|-<br />
| @topbar-launcher-background-hover || @topbarLauncherBackgroundHover || rgba(0, 0, 0, 0.30)<br />
|-<br />
| @topbar-launcher-background-active || @topbarLauncherBackgroundActive || rgba(0, 0, 0, 0.20);<br />
|-<br />
| @topbar-icon-color || @topbarIconColor || #fff<br />
|-<br />
| @selected-background || @selectedBackground || #428BCA (blue)<br />
|-<br />
| @contact-picture-radius || @contactPictureRadius || 50%<br />
|-<br />
|}<br />
:<br />
<br />
<br />
The most significant visual change is achieved by changing the following variables:<br />
* '''@topbar-background''' (top navigation bar)<br />
* '''@selected-background''' (selection background color in list views and folder tree)<br />
* '''@link-color''' (almost all hyperlinks)<br />
<br />
=== Font ===<br />
<br />
{|<br />
! Variable (7.6.x) || Variable (7.4.x) || Default (7.6.x)<br />
|-<br />
| @font-family-sans-serif || @sansFontFamily || "Helvetica Neue", Helvetica, Arial, sans-serif<br />
|-<br />
| @font-family-serif || @serifFontFamily || Georgia, "Times New Roman", Times, serif<br />
|-<br />
| @font-family-monospace || @monoFontFamily || Monaco, Menlo, Consolas, "Courier New", monospace<br />
|-<br />
| @font-size-base || @baseFontSize || 14px<br />
|-<br />
| || @baseFontFamily ||<br />
|-<br />
| @line-height-base || @baseLineHeight || 1.428571429; // 20/14<br />
|-<br />
| || @altFontFamily ||<br />
|-<br />
| @font-size-touch || @touchFontSize || 15px<br />
|-<br />
| @headings-font-family || @headingsFontFamily || inherit<br />
|-<br />
| @headings-font-weight || @headingsFontWeight || 500<br />
|-<br />
| @font-size-large || @fontSizeLarge || ceil((@font-size-base * 1.25)); // ~18px<br />
|-<br />
| @font-size-small || @fontSizeSmall || ceil((@font-size-base * 0.85)); // ~12px<br />
|-<br />
| || @fontSizeMini ||<br />
|-<br />
| @vgrid-font-size || @vgridFontSize || 13px<br />
|}<br />
<br />
=== Colors ===<br />
<br />
{|<br />
! Variable (7.6.x) || Variable (7.4.x) || Default (7.6.x)<br />
|-<br />
| @background || @bodyBackground || #fff<br />
|-<br />
| @text-color || @textColor || @gray-dark<br />
|-<br />
| @link-color || @linkColor || @brand-primary<br />
|-<br />
| @link-hover-color || @linkColorHover || darken(@link-color, 15%)<br />
|-<br />
| @link-accent-color || @linkAccentColor || #ffad00<br />
|-<br />
| || @linkAccentColorHover ||<br />
|-<br />
| @badge-color || @badgeColor || @white<br />
|-<br />
| @badge-bg || @badgeBackground || #aaa<br />
|-<br />
| @headings-color || @headingsColor || inherit<br />
|-<br />
| @black || @black || #000<br />
|-<br />
| @gray-darker || @grayDarker || #222<br />
|-<br />
| @gray-dark || @grayDark || #333<br />
|-<br />
| @gray || @gray || #555<br />
|-<br />
| @gray-light || @grayLight || #999<br />
|-<br />
| @gray-lighter || @grayLighter || #eee<br />
|-<br />
| @white || @white || #fff<br />
|-<br />
| @blue || @blue || darken(#049cdb, 5%)<br />
|-<br />
| @blue-dark || @blueDark || #0064cd<br />
|-<br />
| @blue-light || @blueLight || lighten(#049cdb, 25%)<br />
|-<br />
| @green || @green || #1A8D1A<br />
|-<br />
| @green-light || @greenLight || #92D050<br />
|-<br />
| @red || @red || #cc0000<br />
|-<br />
| @yellow || @yellow || #F8E400<br />
|-<br />
| @orange || @orange || #f89406<br />
|-<br />
| @pink || @pink || #E01CD9<br />
|-<br />
| @purple || @purple || #7E16CF<br />
|-<br />
|}<br />
<br />
=== Space ===<br />
<br />
{|<br />
! Variable (7.6.x) || Variable (7.4.x) || Default (7.6.x)<br />
|-<br />
| || @paddingLarge ||<br />
|-<br />
| || @paddingSmall ||<br />
|-<br />
| || @paddingMini ||<br />
|-<br />
| @border-radius-base || @baseBorderRadius || 4px<br />
|-<br />
| @border-radius-large || @borderRadiusLarge || 6px<br />
|-<br />
| @border-radius-small || @borderRadiusSmall || 3px<br />
|}<br />
<br />
=== Pagination ===<br />
<br />
Used where pagination is done, for example in the Calendar weekview, each week is on one "page"; one can switch the week using a pagination widget styled with these variables.<br />
<br />
{|<br />
! Variable (7.6.x) || Variable (7.4.x) || Default (7.6.x)<br />
|-<br />
| @pagination-bg || @paginationBackground || #fff<br />
|-<br />
| @pagination-border || @paginationBorder || #ddd<br />
|-<br />
| @pagination-active-bg || @paginationActiveBackground || @brand-primary<br />
|}<br />
<br />
=== Buttons ===<br />
<br />
{|<br />
! Variable (7.6.x) || Variable (7.4.x) || Default (7.6.x)<br />
|-<br />
| || @btnBackground ||<br />
|-<br />
| || @btnBackgroundHighlight ||<br />
|-<br />
| || @btnBorder ||<br />
|-<br />
| @btn-primary-bg || @btnPrimaryBackground || @link-color<br />
|-<br />
| || @btnPrimaryBackgroundHighlight ||<br />
|-<br />
| @btn-info-bg || @btnInfoBackground || #5bc0de<br />
|-<br />
| || @btnInfoBackgroundHighlight ||<br />
|-<br />
| @btn-success-bg || @btnSuccessBackground || #62c462<br />
|-<br />
| || @btnSuccessBackgroundHighlight ||<br />
|-<br />
| @btn-warning-bg || @btnWarningBackground || lighten(@orange, 15%)<br />
|-<br />
| || @btnWarningBackgroundHighlight ||<br />
|-<br />
| @btn-danger-bg || @btnDangerBackground || #ee5f5b<br />
|-<br />
| || @btnDangerBackgroundHighlight ||<br />
|-<br />
| @btn-inverse-bg || @btnInverseBackground || #444<br />
|-<br />
| || @btnInverseBackgroundHighlight ||<br />
|}<br />
<br />
=== Dropdowns ===<br />
<br />
{|<br />
! Variable (7.6.x) || Variable (7.4.x) || Default (7.6.x)<br />
|-<br />
| @dropdown-bg || @dropdownBackground || #fff<br />
|-<br />
| @dropdown-border || @dropdownBorder || rgba(0,0,0,.15)<br />
|-<br />
| @dropdown-divider-bg || @dropdownDividerTop || #e5e5e5<br />
|-<br />
| @dropdown-divider-bg || @dropdownDividerBottom || #e5e5e5<br />
|-<br />
| @dropdown-link-color || @dropdownLinkColor || @gray-dark<br />
|-<br />
| @dropdown-link-hover-color || @dropdownLinkColorHover || darken(@gray-dark, 5%)<br />
|-<br />
| @dropdown-link-active-color || @dropdownLinkColorActive || @component-active-color<br />
|-<br />
| @dropdown-link-active-bg || @dropdownLinkBackgroundActive || @component-active-bg<br />
|-<br />
| @dropdown-link-hover-bg || @dropdownLinkBackgroundHover || #f5f5f5<br />
|}<br />
<br />
=== Foldertree ===<br />
{|<br />
! Variable (7.6.x) || Variable (7.4.x) || Default (7.6.x) || Description<br />
|-<br />
| @foldertree-sidepane-background || @foldertreeSidepanelBackground || #f5f5f5 ||<br />
|-<br />
| @foldertee-section-title-color || @foldertreeSectionTitleColor || #888 || Color for sectiontitles in foldertree (like "Public" folders)<br />
|-<br />
| @foldertree-active-label-color || @foldertreeActiveLabelColor || #333 || ''Active'' means, user can perform an action on this item<br />
|-<br />
|@foldertree-passive-label-color || @foldertreePassiveLabelColor ||@hc-gray || ''Passive'' means, user can '''not''' perform any action with this item <br />
|-<br />
| @foldertree-hover-background || @foldertreeHoverBackground || rgba(0, 0, 0, 0.05) ||<br />
|-<br />
| @foldertree-selected-background || @foldertreeSelectedBackground || rgba(0, 0, 0, 0.10) ||<br />
|-<br />
| @foldertree-badge-background || @foldertreeBadgeBackground || @bagde-bg || see [[#Colors]] for definition of @badge-bg<br />
|-<br />
| @foldertree-badge-color || @foldertreeBadgeColor ||@badge-color || see [[#Colors]] for definition of @badge-color<br />
|}<br />
<br />
=== Calendar ===<br />
==== Appointment ====<br />
{|<br />
! Variable (7.6.x) || Variable (7.4.x) || Default (7.6.x) || Description<br />
|-<br />
| @appointment-reserved || @appointmentReserved || #08c /* blue */ || Appointment status color<br />
|-<br />
| @appointment-temporary || @appointmentTemporary || #ffbb00 /* yellow */ || Appointment status color<br />
|-<br />
| @appointment-absent || @appointmentAbsent || #913f3f /* red */ || Appointment status color<br />
|-<br />
| @appointment-free || @appointmentFree || #8eb360 /* green */ || Appointment status color<br />
|-<br />
| @appointment-private || @appointmentPrivate || #555 /* gray */ || Appointment status color<br />
|-<br />
| @appointment-declined-font || @appointmentDeclinedFont || #888 /* dark gray */|| Font color for declined Appointments<br />
|-<br />
| @appointment-unconfirmed-alpha || @appointmentUnconfirmedAlpha || 0.4 || Transparency value for unconfirmed Appointments<br />
|-<br />
| @appointment-declined-alpha || @appointmentDeclinedAlpha || 0.3 || Transparency value for declined Appointments<br />
|-<br />
| @appointment-hover-pct || @appointmentHoverPct || 15% || Percentage increase of the dark pigment content on hover effect<br />
|}<br />
<br />
==== Week View ====<br />
{|<br />
! Variable (7.6.x) || Variable (7.4.x) || Default (7.6.x) || Description<br />
|-<br />
| @weekview-appointment-lasso || @weekviewAppointmentLasso || #aeaeff || Lasso frame color<br />
|-<br />
| @weekview-day-in || @weekviewDayIn || #fff /* white */ || Default background color in week view<br />
|-<br />
| @weekview-day-out || @weekviewDayOut || #e0e0e0 /* grey */ || Background color outside of the mean working time<br />
|-<br />
| @weekview-timeline || @weekviewTimeline || rgba(243, 15, 170, 0.4) || Color of the Line indicating the current time<br />
|-<br />
| @weekview-time-width || @weekviewTimeWith || 58px || With of the time labels on the left side<br />
|-<br />
| @calendar-toolbar-height || @calendarToolbarHeight || 47px || Height of the control toolbar <br />
|}<br />
<br />
==== Month View ====<br />
{|<br />
! Variable (7.6.x) || Variable (7.4.x) || Default (7.6.x) || Description<br />
|-<br />
| @monthview-appointment-out || @monthviewAppointmentOut || #aaa /* light gray */ || Color of appointments, which are not in focus<br />
|-<br />
| @monthview-today || @monthviewToday || #daefff /* light blue */|| Background color of the current day<br />
|-<br />
| || @monthview@calendarToolbarHeight || ||<br />
|}<br />
<br />
== Area names ==<br />
<br />
The variables sometimes refer to common areas. To identify which area is located where, see the following annotated screenshots.<br />
<br />
[[File:Colors_mail.png|800px||Mail application]]<br />
<br />
[[File:Colors_launchpad.png|800px||Launchpad application]]<br />
<br />
== Replacing the logo ==<br />
<br />
One of the most common theme changes which requires editing <code>style.css</code> is changing the logo in the top right corner. The logo is displayed as the background image for an element with the ID <code>io-ox-top-logo-small</code>. A theme can therefore change the size and URL of the image:<br />
#io-ox-top-logo-small {<br />
width: 60px;<br />
height: 22px;<br />
margin: 8px 13px 0 13px;<br />
background-image: url(mylogo.png);<br />
}<br />
The file <code>mylogo.png</code> is expected to be in the same directory as <code>style.css</code>. If you want to place the image somewhere else, then use a relative path in <code>url()</code>.<br />
<br />
Remember that images in OX App Suite are served by the web server and not by the application server. This means that images need to be packaged separately (for dedicated web servers) and installed in <code>/var/www/appsuite/</code> (or similar, depending on the target platform) instead of <code>/opt/open-xchange/appsuite/</code>. Direct support for multiple packages is coming in version 7.4.1. Until then, use the build system from the <code>develop</code> branch to [[AppSuite:UI_build_system#init-packaging|initialize the packaging]] if your theme contains images.<br />
<br />
== Mixins ==<br />
In LESS, it is possible to include a bunch of properties from one ruleset into another ruleset. So say we have the following class:<br />
<br />
=== Sample ===<br />
<pre class="language-css"><br />
.border-radius(@radius: 0px) {<br />
-webkit-border-radius: @radius;<br />
-moz-border-radius: @radius;<br />
-ms-border-radius: @radius;<br />
border-radius: @radius;<br />
}<br />
<br />
#menu a {<br />
color: #111;<br />
.border-radius(5px);<br />
}<br />
</pre><br />
<br />
Read [http://www.lesscss.org/#-mixins LESS Mixins]<br />
<br />
=== global OX Mixins ===<br />
<br />
they can be found at [[#definitions.less | definitions.less]]<br />
<br />
{|<br />
! Mixin || Sample || Description <br />
|-<br />
| .box-sizing(@boxmodel) || .box-sizing(border-box) ||<br />
|-<br />
| .user-select(@select) || .user-select(none) ||<br />
|-<br />
| .border-radius(@radius) || .border-radius(3px) ||<br />
|-<br />
| .box-shadow(@shadow) || .box-shadow(3px) ||<br />
|-<br />
| .vertical-gradient(@startColor, @endColor) || .vertical-gradient(#888, #555) ||<br />
|-<br />
| .radial-gradient(@color1, @color2, @color3) || .radial-gradient(#111, #222, #333) ||<br />
|-<br />
| .transition(@transition) || .transition(background-color 0.2s linear) ||<br />
|-<br />
| .animation(@animation) || .animation(slidein 300ms) ||<br />
|-<br />
| .animation-name(@name) || .animation-name(slideright) ||<br />
|-<br />
| .ellipsis || .ellipsis ||<br />
|-<br />
| .overflow(@type) || .overflow(hidden) ||<br />
|-<br />
| .overflow-x(@type) || .overflow-x(hidden) ||<br />
|-<br />
| .overflow-y(@type) || .overflow-y(hidden) ||<br />
|-<br />
| .backface-visibility(@type) || .backface-visibility(hidden) ||<br />
|}<br />
<br />
== How to activate a theme during development ==<br />
<br />
When creating a new theme, you will want to test changes quickly without building packages reinstalling them. The trick is to use [[Appsuite:Appserver|appserver]].<br />
<br />
# First, you need to add the theme to the list of available themes on the backend. Simply create a new file in <code>/opt/open-xchange/etc/settings/</code> with the extension <code>.properties</code> and add a line for your theme to it: <pre>io.ox/core/settingOptions//themes/<var>ID</var>=<var>Theme Name</var></pre> Replace <var>ID</var> by the identifier (directory name) of your theme, and <var>Theme Name</var> by the human-readable name which should appear in the UI.<br />
# The server needs to be restarted to read the new settings.<br />
# Now, you can use <code>appserver</code> ([[AppSuite:appserver#Use_with_Apache|with a local web server]] if your theme includes images) to get your theme in combination with the UI which is already installed on the backend.<br />
# Finally, activate your theme the list in the <code>Settings -> Basic</code> view behind the option <code>Theme</code>.<br />
<br />
In case you also want to access the same backend without <code>appserver</code> while your theme is selected, that theme (or at least some empty <code>.less</code> files) should be also installed on the backend to avoid errors. To just use an empty theme, run the following as root:<br />
touch /opt/open-xchange/appsuite/apps/themes/<var>ID</var>/definitions.less<br />
touch /opt/open-xchange/appsuite/apps/themes/<var>ID</var>/style.less<br />
/opt/open-xchange/appsuite/share/update-themes.sh<br />
The value of <var>ID</var> here must be the same as in your <code>.properties</code> file.<br />
<br />
== Favicons and mobile homescreen icons ==<br />
'''Note''': This chapter is not about changing AppSuite icons which are used in the application like the brand on the upper right.<br />
<br />
'''This documentation applies for AppSuite v.7.4.2'''<br />
<br />
AppSuite ships with a standard set of icons containing a<br />
# favicon<br />
# set of touch icons which are mainly used by mobile Safari on iOS<br />
<br />
These icons are used as default for all devices and browsers as long as you don't deliver your own icons with your theme. To provide your own icons, put them into your theme's directory, e.g. <tt>apps/themes/<var>theme-name</var>/favicon.ico</tt>.<br />
<br />
=== Favicon ===<br />
All major browsers support the use of a favicon. The favicon is a pixel image with the size of 16x16 (32x32) and the "ico" file ending. (see [http://en.wikipedia.org/wiki/Favicon Wikipedia Favicon] for details).<br />
<br />
You should provide your custom favicon within your custom theme. If you do not add a custom favicon to your theme the global OX default will be used. The default icon is located under <tt>apps/themes/icons/default</tt> on the web server.<br />
<br />
'''Attention:''' Safari and Internet Explorer do not support dynamic changes to the favicon for a webpage. This means, the default icon will be shown even if a custom favicon is provided within a custom theme. To enable the right favicon for a theme on Safari and IE, the overall standard <tt>favicon.ico</tt> located under <tt>apps/themes/icons/default</tt> on the web server must be replaced with a custom version.<br />
<br />
=== Apple touch icons ===<br />
iOS devices (iPhone/iPad/iPod) support so called "Webclips". Webclips are bookmarks to websites or webapps which provide a App Icon that is shown on the iOS homescreen. AppSuite offers full support for Webclips by providing all needed App icons, splashscreens and full screen support. If a user uses the "Add to homescreen" button on his iOS device, a Webclip is created, taking the right icon for his current device. Most devices need custom resolutions of the Webclip icon in the '''png''' format.<br />
<br />
* iPhone 3: 57 x 57 px<br />
* iPhone 4 retina: 114x114 px<br />
* iPhone iPhone 5 retina: 120 x 120 px<br />
* iPad: 72 x 72 px<br />
* iPad (iOS 7): 76 x 76px<br />
* iPad retina: 144 x 144 px <br />
* iPad retina (iOS 7): 152 x 152 px <br />
<br />
Furthermore a fullscreen Webclip App will show a splashscreen, a jpg file that is displayed on startup during app load. There are currently three different resolutions as jpg files available. '''Note''': Splashscreens must be JPG files<br />
<br />
* iPhone: 320 x 460 px<br />
* iPhone 4: 640 x 920 px<br />
* iPhone 5: 640 x 1096 px<br />
<br />
'''Note''': We do not provide splashscreens for iPad<br />
<br />
This list may change with Apple's iOS updates. We recommend providing all of this resolutions when customizing the Webclip icons and splashscreens, even if some iOS devices use the next best resolution for an icon if a certain file is missing.<br />
<br />
=== Providing custom icons ===<br />
To provide custom Webclip icons locate the following path in the AppSuite installation on your web server:<br />
pathToAppSuite/apps/themes/icons/default<br />
<br />
This folder contains all OX default icons for Webclips icons and splashscreens. Use these as samples for your own versions.<br />
<br />
A clean installation will have all our default icons in the "default" directory. To customize the icons we recommend using our default icons as samples and save your customized version in your theme. '''Note''': The filename has to be the same as in the default folder. Otherwise the fallback will be applied and the default icons will be used. If more advanced rewriting is needed one should edit the contents of the <tt>.htaccess</tt> file located under <tt>apps/themes</tt><br />
<br />
== Theming the login page ==<br />
<br />
The login page is a little bit special. If you don’t use the [[Open-Xchange_servlet_for_external_login_masks|form login]] and provide your own login page, you might want to theme the login page, too. [[AppSuite:Theming the login page|Learn how to do this here]].<br />
<br />
=== Providing domain based login themes ===<br />
<br />
If you have a multibrand installation and you want to deliver not only custom themes but also custom login-themes this can be done via Apache mod_rewrite. You can do so by a domain-based rewrite rule to deliver custom themes to a user based on the URI he's using. The needed config file <tt>.htaccess</tt> is located under <tt>apps/themes</tt><br />
<br />
<pre><br />
# Sample config for domain based login theme<br />
RewriteCond %{HTTP_HOST} ^www\.domain\.com$<br />
RewriteCond %{REQUEST_FILENAME} -f<br />
RewriteRule ^login/(.*)$ domain_com_logintheme/$1 [L]<br />
</pre><br />
<br />
== Best practice ==<br />
<br />
To be really safe, it’s best to only define your own values for the variables shown above. If this really breaks anything, we consider this a bug, please report it [https://bugs.open-xchange.com/] in our bugzilla.<br />
<br />
Of course, using CSS in <code>style.less</code> file to define your own styles is also possible. Make sure to test your style in such cases more carefully. It is most likely safe to change minor things using this file, but if you plan to change any positions of larger elements, this might break the complete design. So please be careful when overwriting the default CSS rules.<br />
<br />
== Links ==<br />
[http://bradfrost.github.io/this-is-responsive/resources.html Responsive design]<br />
<br />
[http://lesscss.org/ LESS]<br />
<br />
== Caveats ==<br />
<br />
It is '''not''' recommended to change the size of elements or their position. If you really want to do so, please check on all devices and in all browsers and make sure you didn’t break anything. You even have to be careful when changing the font, because this might have effects on positioning, too.<br />
<br />
As mentioned before, changing colors should be safe.<br />
<br />
[[Category:AppSuite]]<br />
[[Category:UI]]</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:Main_Page_Quickinstall&diff=18584
AppSuite:Main Page Quickinstall
2014-09-24T11:38:41Z
<p>Sonja.krause-harder: </p>
<hr />
<div>= OX App Suite =<br />
<br />
== Quick Installation Guide ==<br />
<br />
To download and install the software, please use the following Installation Guides:<br />
<br />
* [[AppSuite:Open-Xchange_Installation_Guide_for_Debian_6.0|Download and Installation Guide for Debian GNU/Linux 6.0 (Squeeze)]]<br />
* [[AppSuite:Open-Xchange_Installation_Guide_for_Debian_7.0|Download and Installation Guide for Debian GNU/Linux 7.0 (Wheezy)]]<br />
* [[AppSuite:Open-Xchange_Installation_Guide_for_SLES11|Download and Installation Guide for SUSE Linux Enterprise Server 11]]<br />
* [[AppSuite:Open-Xchange_Installation_Guide_for_RHEL6|Download and Installation Guide for RedHat Enterprise Linux 6]]<br />
* [[AppSuite:Open-Xchange_Installation_Guide_for_CentOS_6|Download and Installation Guide for CentOS 6]]<br />
* [[OXSE4UCS_Installation_en|Download and Installation Guide for Univention Corporate Server]]<br />
* [[AppSuite:Demoinstallation|Download and Installation Guide for Open-Xchange SE / App Suite for UCS VMware© Demo]]<br />
<br />
== Installing the latest Updates for OX App Suite ==<br />
<br />
To get the latest features and bugfixes for OX App Suite, you need to have a valid license. The following article explains how that can be done:<br />
<br />
* [[AppSuite:UpdatingOXPackages|Updating OX App Suite packages]]<br />
* [[UpdateTasks|Update Task Management in Open-Xchange]]<br />
<br />
== Update from 6.22.x to OX App Suite ==<br />
<br />
To update the software, please use the following Guides:<br />
<br />
* [[AppSuite:Upgrade_from_6.22_Debian_6.0|Update Guide for Debian GNU/Linux 6.0 (Squeeze)]]<br />
* [[AppSuite:Upgrade_from_6.22_for_SLES11|Update Guide for SUSE Linux Enterprise Server 11]]<br />
* [[AppSuite:Upgrade_from_6.22_for_RHEL6|Update Guide for RedHat Enterprise Linux 6]]<br />
* [[AppSuite:Upgrade_from_6.22_for_CentOS6 |Update Guide for CentOS 6]]<br />
<br />
== Parallel Setup of OX App Suite UI and OX 6 UI ==<br />
<br />
* [[AppSuite:Parallel_UISupport_OX6_AppSuite_Debian_6.0|Parallel Setup Guide for Debian GNU/Linux 6.0 (Squeeze)]]<br />
* [[AppSuite:Parallel_UISupport_OX6_AppSuite_RHEL_6_CentOS_6|Parallel Setup Guide for Red Hat Enterprise Linux 6 and CentOS 6]]<br />
* [[AppSuite:Parallel_UISupport_OX6_AppSuite_SLES_11|Parallel Setup Guide for SUSE Linux Enterprise Server 11]]<br />
<br />
== OX App Suite deployment tutorials ==<br />
<br />
A complete guide of necessary tasks with a hardware and setup recommendation for different Open-Xchange Hosting environments:<br />
<br />
* [[AppSuite:OX_Tutorial_10K|OX App Suite deployment tutorial for up to 10.000 Users]]<br />
* [[AppSuite:OX_Tutorial_100K|OX App Suite deployment tutorial for up to 100.000 Users]]<br />
* [[AppSuite:OX_Tutorial_1M|OX App Suite deployment tutorial for up to 1.000.000 Users]]<br />
<br />
== Reporting Tool (Mandatory for Maintenance) ==<br />
<br />
To receive maintenance in the future, the installation of the Open-Xchange Reporting Tool is mandatory. It documents the current state of your system installation. Furthermore, the tool runs a validity check for your current maintenance. Based on the reported detail information Open-Xchange will then be able to improve its own support and maintenance offerings for you. This article explains how that can be done:<br />
<br />
* [[AppSuite:OXReportClient|OX App Suite Reporting Client]]<br />
<br />
= Open-Xchange Additional Tools and Configurations =<br />
<br />
== Open-Xchange Document Viewer ==<br />
The OX Document Viewer will choose the best preview format depending on the users device on the OX App Suite Web Interface (valid Open-Xchange license required).<br />
<br />
* [[AppSuite:DocumentViewer |Download & Install Document Viewer]]<br />
<br />
== Open-Xchange Calendar synchronization with CalDAV == <br />
<br />
The Mac OS X, iOS and Thunderbird Lightning integration makes Open-Xchange appointments available to end users through their native applications.<br />
<br />
* [[AppSuite:CalDAVClients | Configuration CalDAV with Open-Xchange]]<br />
* [[AppSuite:Caldav_carddav_Bundles| Installation CalDAV with Open-Xchange]]<br />
<br />
== Open-Xchange Contact Synchronization with CardDAV ==<br />
<br />
The Mac OS X and iOS integration makes Open-Xchange contacts available to end users through their native applications.<br />
<br />
* [[AppSuite:CardDAVClients | Configuration CardDAV with Open-Xchange]]<br />
* [[AppSuite:Caldav_carddav_Bundles| Installation CardDAV with Open-Xchange]]<br />
<br />
== Cluster-Setup ==<br />
Multiple Open-Xchange servers can form a cluster with inter-OX-communication over a network. <br />
<br />
* [[AppSuite:Running_a_cluster| Configuration Cluster-Setup]]<br />
<br />
== HTTP based Connector via Grizzly ==<br />
OX App Suite offers a second HTTP based connector for the communication between the HTTP server and the backend. This new connector is based on Oracle's Project Grizzly - a NIO and Web framework.<br />
<br />
* [[AppSuite:Grizzly| Configuration Connector based on Grizzly]]<br />
<br />
== LDAP Contact Storage ==<br />
Open-Xchange provides a new LDAP Contact Storage Integration Bundle. The new solution is available together with the current LDAP bundle. <br />
<br />
* [[ContactStorageLDAP| LDAP Contact Storage]]<br />
<br />
= Open-Xchange Additional Software =<br />
<br />
== OX Text ==<br />
<br />
OX Text, is a web-based word processor. Its main focus is on reducing the complexities of text editing while promoting collaborative document creation.<br />
<br />
* [[AppSuite:Text_Installation_Guide|Download & Installation of OX Text]]<br />
<br />
== OX Spreadsheet ==<br />
<br />
OX Spreadsheet is a cloud based spreadsheet product that can work with Microsoft Excel documents. You can also edit shared spreadsheets on various devices. OX Spreadsheet is the first browser-based spreadsheet application that reads and writes native Microsoft Excel files without loss of format or detail ("Round-trip editing").<br />
<br />
* [[AppSuite:Spreadsheet_Installation_Guide|Download & Installation of OX Spreadsheet]]<br />
<br />
== Open-Xchange Updater ==<br />
<br />
The Open-Xchange Updater is a software tool by Open-Xchange that installs the latest version of Open-Xchange client software on computers running Windows (valid Open-Xchange license required).<br />
<br />
* [[AppSuite:Open-Xchange_Updater|Installation of the Open-Xchange Updater]]<br />
<br />
== Connector for Microsoft Outlook ==<br />
<br />
The Open-Xchange Connector for Microsoft Outlook® lets users keep their Outlook client even if the organization moves to an Open-Xchange Server. Users feel right at home working with their Outlook interface while in the background the Connector synchronizes E-Mails, Calendar, Contacts and Tasks, along with Public, Shared and System Folders. Real-time synchronization enables fast response times, so teams can work as efficiently as possible (valid Open-Xchange license required).<br />
<br />
* [[AppSuite:Connector_for_Microsoft_Outlook|Installation & Configuration of the Open-Xchange Connector for Microsoft Outlook]]<br />
<br />
== Connector for Business Mobility (ActiveSync) ==<br />
<br />
Connector for Business Mobility enables you to securely manage emails, contacts, calendar and tasks on a mobile device. It is based on Microsoft Exchange Active Sync (EAS) standard (valid Open-Xchange license required).<br />
<br />
* [[AppSuite:Connector_for_Business_Mobility_Installation_Guide|Installation and information of the Connector for Business Mobility]]<br />
<br />
== OX Drive ==<br />
<br />
The OX Drive client lets you store and share your photos, files, documents and videos, anytime, anywhere. Access any file you save to OX Drive from all your computers, iPhone, iPad or from within OX App Suite itself.<br />
<br />
* [[AppSuite:OX_Drive|Installation and information of OX Drive]]<br />
<br />
== OX Guard ==<br />
<br />
OX Guard is a fully integrated security add-on to OX App Suite that provides end users with a flexible email and file encryption solution. OX Guard is a highly scalable, multi server, feature rich solution that is so simple-to-use that end users will actually use it.<br />
<br />
* [[AppSuite:OX_Guard|Installation and information of OX Guard]]<br />
<br />
==Open-Xchange Notifier==<br />
<br />
OX Notifier informs the user about the current status of E-Mails and appointments without having to display the user interface or another clients such as Outlook. Additional the new tool will provide the possibility to mount the personal InfoStore directly in the OX Notifier settings (valid Open-Xchange license required).<br />
<br />
* [[Open-Xchange_Installation_Guide_for_OX_Notifier|Installation & Configuration of the Open-Xchange Notifier]]<br />
<br />
==Microsoft Outlook® Uploader==<br />
<br />
Open-Xchange provides Open-Xchange Microsoft Outlook® Uploader (short: OXUploader), a migration tool to export data from Microsoft Outlook® or from a Microsoft Exchange Server® to the Open-Xchange Server.<br />
<br />
* [[OX_Outlook_Uploader|Download & Installation of the Open-Xchange Microsoft Outlook® Uploader]]<br />
<br />
== OX Connector for cPanel ==<br />
<br />
Integration of Open-Xchange with cPanel makes deployment and billing of Open-Xchange simple for service providers. Web hosters can offer Open-Xchange to their shared-hosting customers as well as to users of Virtual Private Servers - just by installing a software package together with cPanel.<br />
<br />
* [[Open-Xchange_cPanel_Installation|Download & Installation of the Connector for cPanel]]<br />
<br />
== OX Connector for WHMCS ==<br />
<br />
Integration of OX App Suite with WHMCS/cPanel makes the deployment of OX App Suite simple for service providers and their customers. Web hosters can easily replace their existing webmail system on WHMCS/cPanel and provide customers a state-of-the-art, web based user interface with the benefits of a best in class, full-featured mobile web application – optimized for smartphones! The combination of OX App Suite, the provisioning of cPanel and the billing system WHMCS provides the perfect package for cPanel Hosting Provider and Reseller<br />
<br />
* [[AppSuite:Connector_for_WHMCS_Installation_Guide|Download & Installation of the OX Connector for WHMCS]]<br />
<br />
== OX APS package for Parallels Operation Automation System and Plesk Panel ==<br />
<br />
Parallels Operations Automation (POA) is an operations support system (OSS) for service providers, who want to differentiate their offerings in order to reduce customer churn and attract new customers. Additional, the APS package adds a high performance, best in class email service to Parallels Plesk Panel customers.<br />
<br />
* [[Parallels_Integration|Integrate Open-Xchange with Parallels]]<br />
<br />
= Installation Information =<br />
<br />
== Information ==<br />
<br />
* [[AppSuite:Backend_API_changes_extensions|OX App Suite - API Changes & Extensions]]<br />
<br />
== Installation Requirements ==<br />
<br />
* The [[AppSuite:OX_System_Requirements|Open-Xchange software requirements page]] provides an overview about the supported components at the OX User Front-End, Connector for Microsoft Outlook, Connector for Business Mobility and OX Notifier. This overview makes no claim to be complete.<br />
* [[AppSuite:Importing_OX_Buildkey|Importing the Open-Xchange public buildkey]]<br />
<br />
[[Category: OX7]]<br />
[[Category: AppSuite]]</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:Main_Page_Quickinstall&diff=18583
AppSuite:Main Page Quickinstall
2014-09-24T11:37:43Z
<p>Sonja.krause-harder: </p>
<hr />
<div>= OX App Suite =<br />
<br />
== Quick Installation Guide ==<br />
<br />
To download and install the software, please use the following Installation Guides:<br />
<br />
* [[AppSuite:Open-Xchange_Installation_Guide_for_Debian_6.0|Download and Installation Guide for Debian GNU/Linux 6.0 (Squeeze)]]<br />
* [[AppSuite:Open-Xchange_Installation_Guide_for_Debian_7.0|Download and Installation Guide for Debian GNU/Linux 7.0 (Wheezy)]]<br />
* [[AppSuite:Open-Xchange_Installation_Guide_for_SLES11|Download and Installation Guide for SUSE Linux Enterprise Server 11]]<br />
* [[AppSuite:Open-Xchange_Installation_Guide_for_RHEL6|Download and Installation Guide for RedHat Enterprise Linux 6]]<br />
* [[AppSuite:Open-Xchange_Installation_Guide_for_CentOS_6|Download and Installation Guide for CentOS 6]]<br />
* [[OXSE4UCS_Installation_en|Download and Installation Guide for Univention Corporate Server]]<br />
* [[AppSuite:Demoinstallation|Download and Installation Guide for Open-Xchange SE / App Suite for UCS VMware© Demo]]<br />
<br />
== Installing the latest Updates for OX App Suite ==<br />
<br />
To get the latest features and bugfixes for OX App Suite, you need to have a valid license. The following article explains how that can be done:<br />
<br />
* [[AppSuite:UpdatingOXPackages|Updating OX App Suite packages]]<br />
* [[UpdateTasks|Update Task Management in Open-Xchange]]<br />
<br />
== Update from 6.22.x to OX App Suite ==<br />
<br />
To update the software, please use the following Guides:<br />
<br />
* [[AppSuite:Upgrade_from_6.22_Debian_6.0|Update Guide for Debian GNU/Linux 6.0 (Squeeze)]]<br />
* [[AppSuite:Upgrade_from_6.22_for_SLES11|Update Guide for SUSE Linux Enterprise Server 11]]<br />
* [[AppSuite:Upgrade_from_6.22_for_RHEL6|Update Guide for RedHat Enterprise Linux 6]]<br />
* [[AppSuite:Upgrade_from_6.22_for_CentOS6 |Update Guide for CentOS 6]]<br />
<br />
== Parallel Setup of OX App Suite UI and OX 6 UI ==<br />
<br />
* [[AppSuite:Parallel_UISupport_OX6_AppSuite_Debian_6.0|Parallel Setup Guide for Debian GNU/Linux 6.0 (Squeeze)]]<br />
* [[AppSuite:Parallel_UISupport_OX6_AppSuite_RHEL_6_CentOS_6|Parallel Setup Guide for Red Hat Enterprise Linux 6 and CentOS 6]]<br />
* [[AppSuite:Parallel_UISupport_OX6_AppSuite_SLES_11|Parallel Setup Guide for SUSE Linux Enterprise Server 11]]<br />
<br />
= OX App Suite deployment tutorials =<br />
<br />
A complete guide of necessary tasks with a hardware and setup recommendation for different Open-Xchange Hosting environments:<br />
<br />
* [[AppSuite:OX_Tutorial_10K|OX App Suite deployment tutorial for up to 10.000 Users]]<br />
* [[AppSuite:OX_Tutorial_100K|OX App Suite deployment tutorial for up to 100.000 Users]]<br />
* [[AppSuite:OX_Tutorial_1M|OX App Suite deployment tutorial for up to 1.000.000 Users]]<br />
<br />
== Reporting Tool (Mandatory for Maintenance) ==<br />
<br />
To receive maintenance in the future, the installation of the Open-Xchange Reporting Tool is mandatory. It documents the current state of your system installation. Furthermore, the tool runs a validity check for your current maintenance. Based on the reported detail information Open-Xchange will then be able to improve its own support and maintenance offerings for you. This article explains how that can be done:<br />
<br />
* [[AppSuite:OXReportClient|OX App Suite Reporting Client]]<br />
<br />
= Open-Xchange Additional Tools and Configurations =<br />
<br />
== Open-Xchange Document Viewer ==<br />
The OX Document Viewer will choose the best preview format depending on the users device on the OX App Suite Web Interface (valid Open-Xchange license required).<br />
<br />
* [[AppSuite:DocumentViewer |Download & Install Document Viewer]]<br />
<br />
== Open-Xchange Calendar synchronization with CalDAV == <br />
<br />
The Mac OS X, iOS and Thunderbird Lightning integration makes Open-Xchange appointments available to end users through their native applications.<br />
<br />
* [[AppSuite:CalDAVClients | Configuration CalDAV with Open-Xchange]]<br />
* [[AppSuite:Caldav_carddav_Bundles| Installation CalDAV with Open-Xchange]]<br />
<br />
== Open-Xchange Contact Synchronization with CardDAV ==<br />
<br />
The Mac OS X and iOS integration makes Open-Xchange contacts available to end users through their native applications.<br />
<br />
* [[AppSuite:CardDAVClients | Configuration CardDAV with Open-Xchange]]<br />
* [[AppSuite:Caldav_carddav_Bundles| Installation CardDAV with Open-Xchange]]<br />
<br />
== Cluster-Setup ==<br />
Multiple Open-Xchange servers can form a cluster with inter-OX-communication over a network. <br />
<br />
* [[AppSuite:Running_a_cluster| Configuration Cluster-Setup]]<br />
<br />
== HTTP based Connector via Grizzly ==<br />
OX App Suite offers a second HTTP based connector for the communication between the HTTP server and the backend. This new connector is based on Oracle's Project Grizzly - a NIO and Web framework.<br />
<br />
* [[AppSuite:Grizzly| Configuration Connector based on Grizzly]]<br />
<br />
== LDAP Contact Storage ==<br />
Open-Xchange provides a new LDAP Contact Storage Integration Bundle. The new solution is available together with the current LDAP bundle. <br />
<br />
* [[ContactStorageLDAP| LDAP Contact Storage]]<br />
<br />
= Open-Xchange Additional Software =<br />
<br />
== OX Text ==<br />
<br />
OX Text, is a web-based word processor. Its main focus is on reducing the complexities of text editing while promoting collaborative document creation.<br />
<br />
* [[AppSuite:Text_Installation_Guide|Download & Installation of OX Text]]<br />
<br />
== OX Spreadsheet ==<br />
<br />
OX Spreadsheet is a cloud based spreadsheet product that can work with Microsoft Excel documents. You can also edit shared spreadsheets on various devices. OX Spreadsheet is the first browser-based spreadsheet application that reads and writes native Microsoft Excel files without loss of format or detail ("Round-trip editing").<br />
<br />
* [[AppSuite:Spreadsheet_Installation_Guide|Download & Installation of OX Spreadsheet]]<br />
<br />
== Open-Xchange Updater ==<br />
<br />
The Open-Xchange Updater is a software tool by Open-Xchange that installs the latest version of Open-Xchange client software on computers running Windows (valid Open-Xchange license required).<br />
<br />
* [[AppSuite:Open-Xchange_Updater|Installation of the Open-Xchange Updater]]<br />
<br />
== Connector for Microsoft Outlook ==<br />
<br />
The Open-Xchange Connector for Microsoft Outlook® lets users keep their Outlook client even if the organization moves to an Open-Xchange Server. Users feel right at home working with their Outlook interface while in the background the Connector synchronizes E-Mails, Calendar, Contacts and Tasks, along with Public, Shared and System Folders. Real-time synchronization enables fast response times, so teams can work as efficiently as possible (valid Open-Xchange license required).<br />
<br />
* [[AppSuite:Connector_for_Microsoft_Outlook|Installation & Configuration of the Open-Xchange Connector for Microsoft Outlook]]<br />
<br />
== Connector for Business Mobility (ActiveSync) ==<br />
<br />
Connector for Business Mobility enables you to securely manage emails, contacts, calendar and tasks on a mobile device. It is based on Microsoft Exchange Active Sync (EAS) standard (valid Open-Xchange license required).<br />
<br />
* [[AppSuite:Connector_for_Business_Mobility_Installation_Guide|Installation and information of the Connector for Business Mobility]]<br />
<br />
== OX Drive ==<br />
<br />
The OX Drive client lets you store and share your photos, files, documents and videos, anytime, anywhere. Access any file you save to OX Drive from all your computers, iPhone, iPad or from within OX App Suite itself.<br />
<br />
* [[AppSuite:OX_Drive|Installation and information of OX Drive]]<br />
<br />
== OX Guard ==<br />
<br />
OX Guard is a fully integrated security add-on to OX App Suite that provides end users with a flexible email and file encryption solution. OX Guard is a highly scalable, multi server, feature rich solution that is so simple-to-use that end users will actually use it.<br />
<br />
* [[AppSuite:OX_Guard|Installation and information of OX Guard]]<br />
<br />
==Open-Xchange Notifier==<br />
<br />
OX Notifier informs the user about the current status of E-Mails and appointments without having to display the user interface or another clients such as Outlook. Additional the new tool will provide the possibility to mount the personal InfoStore directly in the OX Notifier settings (valid Open-Xchange license required).<br />
<br />
* [[Open-Xchange_Installation_Guide_for_OX_Notifier|Installation & Configuration of the Open-Xchange Notifier]]<br />
<br />
==Microsoft Outlook® Uploader==<br />
<br />
Open-Xchange provides Open-Xchange Microsoft Outlook® Uploader (short: OXUploader), a migration tool to export data from Microsoft Outlook® or from a Microsoft Exchange Server® to the Open-Xchange Server.<br />
<br />
* [[OX_Outlook_Uploader|Download & Installation of the Open-Xchange Microsoft Outlook® Uploader]]<br />
<br />
== OX Connector for cPanel ==<br />
<br />
Integration of Open-Xchange with cPanel makes deployment and billing of Open-Xchange simple for service providers. Web hosters can offer Open-Xchange to their shared-hosting customers as well as to users of Virtual Private Servers - just by installing a software package together with cPanel.<br />
<br />
* [[Open-Xchange_cPanel_Installation|Download & Installation of the Connector for cPanel]]<br />
<br />
== OX Connector for WHMCS ==<br />
<br />
Integration of OX App Suite with WHMCS/cPanel makes the deployment of OX App Suite simple for service providers and their customers. Web hosters can easily replace their existing webmail system on WHMCS/cPanel and provide customers a state-of-the-art, web based user interface with the benefits of a best in class, full-featured mobile web application – optimized for smartphones! The combination of OX App Suite, the provisioning of cPanel and the billing system WHMCS provides the perfect package for cPanel Hosting Provider and Reseller<br />
<br />
* [[AppSuite:Connector_for_WHMCS_Installation_Guide|Download & Installation of the OX Connector for WHMCS]]<br />
<br />
== OX APS package for Parallels Operation Automation System and Plesk Panel ==<br />
<br />
Parallels Operations Automation (POA) is an operations support system (OSS) for service providers, who want to differentiate their offerings in order to reduce customer churn and attract new customers. Additional, the APS package adds a high performance, best in class email service to Parallels Plesk Panel customers.<br />
<br />
* [[Parallels_Integration|Integrate Open-Xchange with Parallels]]<br />
<br />
= Installation Information =<br />
<br />
== Information ==<br />
<br />
* [[AppSuite:Backend_API_changes_extensions|OX App Suite - API Changes & Extensions]]<br />
<br />
== Installation Requirements ==<br />
<br />
* The [[AppSuite:OX_System_Requirements|Open-Xchange software requirements page]] provides an overview about the supported components at the OX User Front-End, Connector for Microsoft Outlook, Connector for Business Mobility and OX Notifier. This overview makes no claim to be complete.<br />
* [[AppSuite:Importing_OX_Buildkey|Importing the Open-Xchange public buildkey]]<br />
<br />
[[Category: OX7]]<br />
[[Category: AppSuite]]</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=Template:YUMRepo&diff=18452
Template:YUMRepo
2014-09-15T11:57:06Z
<p>Sonja.krause-harder: </p>
<hr />
<div>[open-xchange-{{#replace:{{{reponame}}}|/|-}}]<br />
name=Open-Xchange-{{#replace:{{{reponame}}}|/|-}}<br />
baseurl=http://{{#if:{{{ldbaccount|}}}|{{{ldbaccount}}}@|}}software.open-xchange.com/{{{path}}}/{{{reponame}}}/{{{rhelname}}}/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br /></div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=Template:YUMRepo&diff=18451
Template:YUMRepo
2014-09-15T11:55:04Z
<p>Sonja.krause-harder: </p>
<hr />
<div>[open-xchange-{{#replace:{{{reponame}}}|/|-}}]<br />
name=Open-Xchange-{{#replace:{{{reponame}}}|/|-}}<br />
baseurl=https://{{#if:{{{ldbaccount|}}}|{{{ldbaccount}}}@|}}software.open-xchange.com/{{{path}}}/{{{reponame}}}/{{{rhelname}}}/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br /></div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=Product_FAQ&diff=18380
Product FAQ
2014-09-03T08:04:12Z
<p>Sonja.krause-harder: /* Under what license do you release your products? */</p>
<hr />
<div>== How does OX App Suite compare to OX6? ==<br />
<br />
While the web frontend of OX App Suite is completely different from OX 6, the 7.2.0 release of OX App Suite is broadly comparable to OX6 in terms of features and functionality.<br />
<br />
Note: When there is no direct equivalent there is often an alternative in the form of a similar or enhanced option. <br />
<br />
== When will the OX App Store be ready? ==<br />
<br />
Open-Xchange has not formally announced when OX App Store will be available.<br />
<br />
== What other up-sell functionality does OX App Suite Offer? ==<br />
<br />
Currently OX App Suite offers a number of upsell possibilities, these include: <br />
* In-app upselling – greyed out items in the menu are clickable and bring up a customizable window – for example allowing automatic upgrade or customer defined promotions. <br />
* In email advertising. <br />
* Portal based advertising and promotions. (Widgets)<br />
<br />
For those interested a technical description of upsell capabilities can be found: [http://oxpedia.org/wiki/index.php?title=AppSuite:Upsell#Enable_upsell Here]<br />
<br />
== Can I download packages for test and evaluation purposes? ==<br />
<br />
A free version of OX App Suite is available for anybody to download. [http://oxpedia.org/wiki/index.php?title=AppSuite:Main_Page_AppSuite#quickinstall See here]. A time-limited key is available to those people wishing to evaluate the features and functionality that are only available in the commercial version. <br />
<br />
== How do I get the mobile UI? ==<br />
<br />
The mobile UI is available as standard and does not require a separate url. Just open the normal url on your device browser.<br />
<br />
== Is there a separate mobile for UI for OX App Suite? ==<br />
<br />
No, OX App Suite does not need a separate mobile app as it has a responsive design, which has been enhanced and optimized for mobile use with the release of 7.4.0.<br />
<br />
Please note: The "Mobile Web Interface" that was available for OX 6 is not supported for OX App Suite.<br />
<br />
== Which UI runs with which backend? ==<br />
<br />
There are many possible combinations, however the only supported and tested option is on the current released version.<br />
<br />
== What exactly is the community version and how does it differ from the commercial version? ==<br />
The community version of OX App Suite is a fully functioning version of the OX App Suite, but differs in three key ways:<br />
* It does not come with support<br />
* It does not come with commercial packages<br />
* No public patches<br />
* Packages for unsupported platforms will be available soon<br />
<br />
== Why can I not get the Document Viewer with the free version?==<br />
OX Document Viewer is not available as part of the free version of OX App Suite. If you wish to use OX Document Viewer you will need to upgrade to the commercial version. <br />
<br />
== What is OX Text? == <br />
OX Text is a text editor which enables web-based, collaborative word processing. Uniquely OX Text provides a seamless document Round-trip. It is compatible with MS Office and OpenOffice. More detailed information on the features and functionality of OX Text can be found: [http://www.open-xchange.com/fileadmin/user_upload/open-xchange/document/datasheet/Datasheet_OX_Text.pdf Here]<br />
<br />
== What are the key benefits of OX Text? ==<br />
* Online word processing
<br />
* More efficient collaboration
<br />
* Reduced complexity
<br />
* Increased productivity
<br />
* Greater focus on content
<br />
* Fully integrated with OX App Suite
<br />
* Anytime, anywhere access
<br />
* Compatible with Microsoft Office and OpenOffice <br />
* Lower software licensing costs<br />
<br />
== What file formats are supported? ==<br />
OX Text supports the following file formats for text import: doc, dot, rtf, docx, docm, dotx, dotm, odt. <br />
<br />
We then convert them into HTML and SVG for your viewing pleasure on all devices and most browsers. <br />
<br />
== Why does OX Text not support a specific feature such as “xyz”?==<br />
<br />
It was not a design goal of OX Text to copy all the features available in other office suites. If a feature is missing in OX Text, that you love, feel free to use it in your Desktop product. We believe user experience is key, not feature-richness.<br />
<br />
Also please keep in mind that OX Text is a new product. Some features have not yet been implemented but that does not mean you cannot include things like headers and footers in your documents. These elements might not be visible (or might appear as an placeholder) in OX Text but when you download the document back to your Desktop editor, all elements will be visible again.<br />
<br />
== What does interoperability mean for the user?==<br />
All Desktop word processors have problems to work with a foreign file format. Although open document standards like OOXML and ODF did a great job in giving users back information ownership and long-term access to their documents, they have not solved the interoperability problem, the ability to work together with different office products. The document Round-trip between two different word processors is still a problem. Documents don't look the same when they are imported and exported to another product. OX Text solved this problem.<br />
<br />
== Does OX Text come with a new file format? ==<br />
No, we have not introduced a new format the files remain unchanged. What are your plans for Spreadsheets and Presentations? These products are an integral part of Ox Documents. OX Spreadsheet and OX Presentations are under development at the moment, please check the roadmap for more information.<br />
<br />
== Can end users exchange documents with other users using Microsoft Office?==<br />
Yes. OX Text is file-compatible with Microsoft Office and OpenOffice<br />
<br />
== Which devices can be used?==<br />
End users can use any device, including rich clients (Windows desktops and notebooks), thin clients and even tablets and smartphones. The only requirement is an HTML5 compatible browser and – at least today – a network connection<br />
<br />
== What is Round-Trip editing?==<br />
<br />
Legacy documents created with some editors often embed power features not recognized by many other text editors. This is not a problem for OX Text as it has been designed with “round trip” functionality.<br />
<br />
Round trip lets you upload any document into OX Text and start working with it.<br />
When a document contains features such as Smart Art or Charts, they might not appear or are simply replaced with a placeholder. The document can then be worked upon, even in teams and online. Later, when finished, the document can again be downloaded. When it is then reopened in its native editor you find nothing is lost: the new edits are there, the power functions are also still there and working, even the formatting is completely intact. OX Text never damages your valuable work even if it does not understand it.<br />
<br />
[[File:round_trip.png|800px]]<br />
<br />
Note: Round-trip editing only works with modern OOXML (.docx) or ODF (.odt) file formats. All old Microsoft Office Binary Formats (.doc) are converted to one of the modern XML formats first.<br />
<br />
== What is OX Documents and when will it be available? ==<br />
<br />
OX Documents comprises of: <br />
* OX Text<br />
* OX Spreadsheet<br />
* OX Presentation<br />
<br />
OX Text and OX Spreadsheets have already launched and are available as an integral part of OX App Suite. OX Presentations is expected to launch in 2015.<br />
<br />
== Is OX Text available as a stand-alone product for use outside of OX App Suite?==<br />
No. There are no plans to do this at the moment.<br />
<br />
== How do I get OX Text?== <br />
You need to buy OX Text separately as an upgrade to OX App Suite. A download key is available on request. OX Text for OX App Suite for UCS is available in the Univention App Center. Please check the UMC module App Center for the installation of the OX Text at your already available environment.<br />
<br />
'''Further technical FAQ's are available here [http://sdb.open-xchange.com/faq http://sdb.open-xchange.com/faq]!'''<br />
<br />
== Is Open-Xchange an Open Source company? ==<br />
<br />
Open-Xchange is an Open-Source company. We distribute our software openly, including usage rights and source code.<br />
<br />
At the same time we are a commercial entity and need to protect both our partners' and our own business against competition (this is the reason for the non-commercial use clause in the CC license). We think we do a great job of balancing the sometimes-conflicting requirements, but we realize that we will not be able to please everybody all the time.<br />
<br />
== Under what license do you release your products?==<br />
<br />
We have licensed our backend under a GPL2 license and our frontend under a CC BY-SA-NC license. In addition we use some 3rd Party components in the backend and frontend. Further information about the different licenses for these components can be found here: http://www.open-xchange.com/agb<br />
<br />
This means that our software is free for non-commercial use – you can look at our source code, customize it if you like and even redistribute it as long as you do not sell it. For commercial use, and for service and support, you require a license key to download and install OX App Suite packages. Packages for both supported (commercial) and unsupported (non-commercial) platforms are available for download from Open-Xchange. Instructions on how to download and install OX App Suite can be found here: http://oxpedia.org/wiki/index.php?title=AppSuite:Main_Page_AppSuite#quickinstall<br />
<br />
Our source code is available for anybody to download from GIT: http://git.open-xchange.com/<br />
<br />
== What does this mean for OX Text?==<br />
<br />
OX Text is also available under a CC BY-SA-NC license.<br />
<br />
Details of how to download and install OX Text source code can be found here: http://oxpedia.org/wiki/index.php?title=AppSuite:Text_Installation_Guide<br />
<br />
Packages for major platforms can be downloaded from software.open-xchange.com as they become available.<br />
<br />
'''Please note:''' OX Text packages for commercial use, (i.e. for re-distribution for a fee) and for service and support, are only available with a valid license key. Although OX Text is an integral part of OX App Suite it is not available as part of the standard OX App Suite offering. Customers should contact their Open-Xchange Account Manager for further information and pricing.<br />
<br />
== Is CC BY-SA-NC an Open Source license accepted by the OSI?==<br />
<br />
No. As we mentioned we use a CC BY-SA-NC license for our front end and the limitation set by “NC” is not compatible with the OSI definition of Open Source.<br />
<br />
The back end GPL2 license has no such restrictions.<br />
<br />
== What is OX Drive? ==<br />
<br />
OX Drive allows users to synchronize and share files and folders from the desktop and from their mobile devices.<br />
<br />
OX Drive is available through the browser as part of OX App Suite. OX Drive clients are available for Windows, OSX, iOS and Android and allow users to synchronize files between their PC’s, Notebooks and Mobile Devices and OX App Suite.<br />
<br />
== What are the requirements for OX Drive clients? ==<br />
<br />
* OX Drive for Windows requires the latest Versions of Windows 7, Windows 8. <br />
* OX Drive for Mac OS requires at OS X 10.8 (Mountain Lion) or Mac OS X 10.9 (Mavericks) <br />
* OX Drive for iOS requires an Apple iPhone on iOS 6 / iOS 7 or an Apple iPad on iOS 6 / iOS 7 <br />
* OX Drive for Android requires a Smartphone on Android Jelly Bean (4.1 - 4.2) or Tablets on Android Jelly Bean (4.1 - 4.2)<br />
<br />
== How do I install OX Drive? ==<br />
<br />
Download and install the correct OX Drive client for your mobile device and follow the instructions in the Wizard. Be prepared to enter the server URL and your credentials for the server.<br />
<br />
== How do I share a file or folder? ==<br />
<br />
This is currently only possible from the web UI of OX App Suite. In the windows client (if the shell extension is installed) you can right click on a file/folder and click "Open in OX AppSuite" which opens the web UI of OX App Suite for you. In the web UI of OX App Suite you have the option "Share folder" or "Share this file option" - both will create a unique link that can be sent out to any external user.<br />
<br />
== I installed OX Drive ... what's next? ==<br />
<br />
On Windows you can easily enter the OX Drive folder by right clicking on the OX Drive tray icon and choosing "Open OX Drive folder". This opens the windows explorer. Maybe you can already see some files and folders that are synchronized. You can now add, change or remove files and folders normally.<br />
<br />
== I deleted a file, how to get it back? ==<br />
<br />
If the version of OX App Suite supports versioning you can just open earlier version in the OX App Suite web UI. Click on a file and in the detailed view you can click on "Show version history" where you have the option to download earlier versions.<br />
<br />
== Some files are missing, where can I find them? ==<br />
<br />
Technically speaking, there are some cases when a file does not get synchronized immediately because it's still being modified. This is normally true for office documents. As soon as the document gets released it will be synchronized. But there are also some cases that the file is ignored by OX Drive because of the filename contains one or of the following reserved characters:<br />
<br />
* < (less than)<br />
* > (greater than)<br />
* : (colon)<br />
* ” (double quote)<br />
* / (forward slash)<br />
* \ (backslash)<br />
* | (vertical bar or pipe)<br />
* ? (question mark)<br />
* * (asterisk)<br />
* Characters whose integer representations are in the range from 0 through 31<br />
* The last character is a . (dot) or ' ' (space)<br />
* It's case-invariant name without an optional extension matches one of the reserved names CON, PRN, AUX, NUL, COM1, COM2, COM3, COM4, COM5, COM6, COM7, COM8, COM9, LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, LPT7, LPT8, or LPT9<br />
* It consists solely of whitespace characters<br />
<br />
In addition folders have some more reserved conditions: <br />
* The last character of any subpath (i.e. the last part of the whole path or the part preceding the separator character /) is a . (dot) or ' ' (space) <br />
* It not equals the root path /, but ends with a / (forward slash) character <br />
* It contains two or more consecutive / (forward slash) characters <br />
<br />
Unfortunately there are more constraints: The maximum allowed length for some path segments, i.e. the parts between forward slashes (/) in directory and filenames, is restricted to 255 characters. Synchronizing a file or directory version that contains path segments longer than this limit leads to those versions being put into quarantine.<br />
<br />
== What’s new in OX App Suite v7.6.0? ==<br />
<br />
OX App Suite v7.6.0 contains many changes and improvements. Most noticeable is the redesign of the user interface to give an attractive, easy-to-use, contemporary look and feel. This includes improved handling of different drop down menus, an updated toolbar concept, new color schemes, the introduction of new email views (Horizontal, list and compact), new search functionality, new attachment preview, improved thread view and OX calendar improvements.<br />
<br />
This is just a small sampling of the many new and improved features of OX App Suite v7.6.0, to find out more please see this detailed list of changes: http://software.open-xchange.com/products/appsuite/doc/Feature_Overview_OXAppSuite_OXDocuments_7_6_0.pdf<br />
<br />
== What’s new in OX Text and OX Spreadsheets? ==<br />
<br />
OX Text and OX Spreadsheets reflect the new UI design of OX App Suite and direct links to both the apps are now part of the top menu bar. Also new is the landing page for both apps which provides a document oriented view of recently used documents and templates. There are many other changes including charts and performance enhancements for OX Spreadsheets and a new page view and collaboration enhancements for OX Text.<br />
For a full list please see here: http://software.open-xchange.com/products/appsuite/doc/Feature_Overview_OXAppSuite_OXDocuments_7_6_0.pdf<br />
<br />
== When will OX Messenger be available? ==<br />
OX Messenger v1.0 will be available in July for OXaaS customers in the US and Europe and later as a hybrid solution for selected OX App Suite customers. The official launch of OX Messenger is in September and no public announcements will be made before this date.<br />
<br />
The key features of OX Messenger v1.0 are:<br />
* Chat, Voice, Video<br />
* Integrated in the OX App Suite UI<br />
* SSO & Auto Provisioning<br />
* Cluster-wide communication<br />
* Invite System<br />
* Link based communication<br />
<br />
== When will OX Guard be available? ==<br />
<br />
OX Guard will be available in Q3 2014. The main features of OX Guard are:<br />
* Security protection against opportunistic access<br />
* Email and Files<br />
* Optional local private key storage and encryption/decryption for advanced users<br />
* Cross deployment key management services<br />
<br />
Version 1.2 will be available in November.</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:AdminGuide_7.6.0&diff=18290
AppSuite:AdminGuide 7.6.0
2014-08-19T08:26:42Z
<p>Sonja.krause-harder: /* Statistics */</p>
<hr />
<div>Older versions: [[AppSuite:AdminGuide_7.4.2|7.4.2]], [[AppSuite:AdminGuide_7.4.0|7.4.0]], [[AppSuite:AdminGuide_7_2|7.2.0]], [[AppSuite:AdminGuide_7_0_1|7.0.1]]<br />
<br />
= Open-Xchange Installation and Update =<br />
<br />
== OX App Suite ==<br />
* [[AppSuite:Open-Xchange_Installation_Guide_for_Debian_6.0|Download and Installation Guide for Debian GNU/Linux 6.0 (Squeeze)]]<br />
* [[AppSuite:Open-Xchange_Installation_Guide_for_Debian_7.0|Download and Installation Guide for Debian GNU/Linux 7.0 (Wheezy)]]<br />
* [[AppSuite:Open-Xchange_Installation_Guide_for_SLES11|Download and Installation Guide for SUSE Linux Enterprise Server 11]]<br />
* [[AppSuite:Open-Xchange_Installation_Guide_for_RHEL6|Download and Installation Guide for RedHat Enterprise Linux 6]]<br />
* [[AppSuite:Open-Xchange_Installation_Guide_for_CentOS_6|Download and Installation Guide for CentOS 6]]<br />
* [[OXSE4UCS_Installation_en|Download and Installation Guide for Univention Corporate Server]]<br />
<br />
== Open-Xchange Update ==<br />
* [[AppSuite:UpdatingOXPackages|Updating Open-Xchange AppSuite v7.0.0 to v7.4]]<br />
* [[AppSuite:Upgrade_from_6.22_Debian_6.0|Update Guide v6.22 to v7.4 for Debian GNU/Linux 6.0 (Squeeze)]]<br />
* [[AppSuite:Upgrade_from_6.22_for_SLES11|Update Guide v6.22 to v7.4 for SUSE Linux Enterprise Server 11]]<br />
* [[AppSuite:Upgrade_from_6.22_for_RHEL6|Update Guide v6.22 to v7.4 for RedHat Enterprise Linux 6]]<br />
* [[AppSuite:Upgrade_from_6.22_for_CentOS6 |Update Guide v6.22 to v7.4 for CentOS 6]]<br />
* [[UpdateTasks|Update Task Management in Open-Xchange]]<br />
<br />
== Parallel Setup of OX App Suite UI and OX 6 UI ==<br />
<br />
* [[AppSuite:Parallel_UISupport_OX6_AppSuite_Debian_6.0|Parallel Setup Guide for Debian GNU/Linux 6.0 (Squeeze)]]<br />
* [[AppSuite:Parallel_UISupport_OX6_AppSuite_RHEL_6_CentOS_6|Parallel Setup Guide for Red Hat Enterprise Linux 6 and CentOS 6]]<br />
* [[AppSuite:Parallel_UISupport_OX6_AppSuite_SLES_11|Parallel Setup Guide for SUSE Linux Enterprise Server 11]]<br />
<br />
== Additional Software ==<br />
* [[AppSuite:Text_Installation_Guide |Download & Install OX Text]]<br />
* [[AppSuite:Spreadsheet_Installation_Guide |Download & Install OX Spreadsheet]]<br />
* [[AppSuite:DocumentViewer |Download & Install Document Viewer]]<br />
* [[AppSuite:Open-Xchange_Updater|Installation of the Open-Xchange Updater]]<br />
* [[AppSuite:Connector_for_Microsoft_Outlook|Installation & Configuration of the Open-Xchange Connector for Microsoft Outlook]]<br />
* [[AppSuite:Connector_for_Business_Mobility_Installation_Guide|Installation and information of the Connector for Business Mobility]]<br />
* [[AppSuite:OX_Drive|Installation and information of OX Drive for Client]]<br />
* [[AppSuite:OX_Mobile_Web_Interface|Installation of the Open-Xchange Mobile Web Interface]]<br />
* [[Open-Xchange_Installation_Guide_for_OX_Notifier|Installation & Configuration of the Open-Xchange Notifier]]<br />
* [[Open-Xchange_cPanel_Installation|Download & Installation of the OX Connector for cPanel]]<br />
* [[AppSuite:Connector_for_WHMCS_Installation_Guide|Download & Installation of the OX Connector for WHMCS]]<br />
* [[Parallels_Integration|Integrate Open-Xchange with Parallels]]<br />
<br />
= OX App Suite Configuration =<br />
<br />
== Advanced Configuration ==<br />
* [[AppSuite:CalDAVClients | Configuration CalDAV with Open-Xchange]]<br />
* [[AppSuite:CardDAVClients | Configuration CardDAV with Open-Xchange]]<br />
* [[AppSuite:Caldav_carddav_Bundles| Installation CardDAV/CalDAV with Open-Xchange]]<br />
* [[AppSuite:Running_a_cluster| Configuration Cluster-Setup]]<br />
* [[AppSuite:Grizzly| Configuration Connector based on Grizzly]]<br />
* [[ContactStorageLDAP| LDAP Contact Storage]]<br />
* [[AppSuite:Setup_CIFS | Setup a CIFS Account as primary/additional FileStorage Account]]<br />
* [[Filtering_templates | Filtering publication templates according to their purpose]]<br />
<br />
== OX App Suite Configuration Parameter ==<br />
* [[AppSuite:Configuration_properties_7.4| Configuration properties]] - everything you ever wanted to change about the AppSuite<br />
<br />
== OX App Suite Management (CLT)==<br />
* [[AppSuite:Context management|Context management]]<br />
* [[AppSuite:User management|User management]]<br />
* [[AppSuite:Group management|Group management]]<br />
* [[AppSuite:Resource management|Resource management]]<br />
* [[AppSuite:Data management|Data management]]<br />
<br />
= Advanced Documentation =<br />
<br />
== Architecture Overview ==<br />
*[[AppSuite:Architecture_Overview|Architecture Overview]]<br />
<br />
== Importing and exporting data ==<br />
* General [[restrictions on importing data]]<br />
* Migrate a batch of users and contexts at once. Check the CSV Batch Import documentation [[Csv_import|page]].<br />
* Documentation for the [[data import format|data import format]]<br />
* [[VCard and ICal support]]<br />
* [[Using the export servlet]]<br />
* [[Using the import servlet]]<br />
* [[export ical/vcard|Example in bash to extract private contacts, tasks or appointments in ical/vcard format]]<br />
* [[CrawlerArchitecture|Architecture of the crawler bundle]]<br />
<br />
== Configuration and Tweaks ==<br />
* [[Open_Xchange_Configuration|Open-Xchange Configuration]]<br />
* [[Open-Xchange_Lighttpd|Open-Xchange and Lighttpd]]<br />
* [[On_The_Fly_Configuration_Update|On The Fly Configuration Update (experimental)]]<br />
* [[Session_Migration|Session migration]]<br />
* [[MailNotify_Bundle|Mail Notification (Push) with Open-Xchange]]<br />
* [[Tune_apache2_for_more_concurrent_connections|Apache2 tuning]]<br />
<br />
== Statistics ==<br />
<br />
* [[AppSuite:Logincounter|logincounter]]<br />
<br />
== Troubleshooting ==<br />
* [http://www.open-xchange.com/forum/ Open-Xchange Forum]<br />
* Check the [http://sdb.open-xchange.com/ Open-Xchange Support Database]<br />
* FAQs can be found in the [http://sdb.open-xchange.com/faq SDB FAQ section].<br />
* [[Passwords in Open-Xchange]]<br />
* [[Outlook_OXtender2_Best_Practice| Outlook Connector best practice]]<br />
* [[AppSuite:OX_Logging|Logging]] - configuring and understanding the LOGBACK logging system<br />
* [[AppSuite:Oxsysreport | Creating an OX Support Tarball]]<br />
<br />
== Integration Scenarios ==<br />
* [http://oxpedia.org/wiki/index.php?title=Category:Config Open-Xchange configuration options summary]<br />
* [[OX_Permission_Level | OX Permission Level Matrix]]<br />
* [[Load_balancing_and_clustering | Load balancing and OX clustering]]<br />
* [[Open-Xchange-RHEL-AD-Integration|Integration of Open-Xchange into MS Active Directory and Exchange ]]<br />
* [[ContextRestore_Bundle|Restoring contexts using the context restore bundle]]<br />
* [[Lawful_Interception|Lawful Interception (Telekommunikationsüberwachung)]]<br />
* [[OX_EMail_Push_Introduction|Introduction to EMail Push in Open-Xchange]]<br />
<br />
<br />
<br />
[[Category: OX7]]<br />
[[Category: AppSuite]]<br />
[[Category: Administrator]]</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:Logincounter&diff=18161
AppSuite:Logincounter
2014-07-21T10:32:10Z
<p>Sonja.krause-harder: </p>
<hr />
<div>= Login Counter =<br />
<br />
Whenever a user is logged in through the login servlet, the context id, user id, client identification string and a time stamp is saved to the database. If a database entry for this combination of context, user and client is already present, only the timestamp is updated. This means that the database holds the information for the '''last''' login of a specific user with a specific client. This data can be retrieved again with the <code>logincounter</code> tool to show how many users logged in through which client(s) in a given timeframe.<br />
<br />
Please note that only '''logins''' are counted. Depending on the server configuration and the client, sessions may be reused when a user re-accesses the system even after a few hours or days. In this case the login timestamp is not updated. This means that <tt>logincounter</tt> does not necessarily show the number of active users, especially if the request only covers a short timeframe.<br />
<br />
The clients provided by Open-Xchange use the following client identification strings:<br />
<br />
{|<br />
|-<br />
!Client<br />
!client identification string<br />
|-<br />
|Open-Xchange AppSuite (Web UI)<br />
|<tt>open-xchange-appsuite</tt><br />
|-<br />
|Open-Xchange Server 6 (Web UI)<br />
|<tt>com.openexchange.ox.gui.dhtml</tt><br />
|-<br />
|Connector for Business Mobility (Active Sync)<br />
|<tt>USM-EAS</tt><br />
|-<br />
|Connector 2 for Microsoft Outlook <br />
|<tt>USM-JSON</tt><br />
|-<br />
|OX Notifier<br />
|<tt>OpenXchange.HTTPClient.OXNotifier</tt><br />
|-<br />
|CardDAV<br />
|<tt>CARDDAV</tt><br />
|-<br />
|CalDAV<br />
|<tt>CALDAV</tt><br />
|-<br />
|Mobile Web App (legacy, OX6 generation)<br />
|<tt>com.openexchange.mobileapp</tt><br />
|-<br />
|OX Drive (native iOS client)<br />
|<tt>OpenXchange.iosClient.OXDrive</tt><br />
|-<br />
|OX Drive (native Android client)<br />
|<tt>OpenXchange.Android.OXDrive</tt><br />
|-<br />
|OX Drive (native Mac OS X client)<br />
|<tt>OSX.OXDrive</tt><br />
|-<br />
|OX Drive (native Windows client)<br />
|<tt>OpenXchange.HTTPClient.OXDrive</tt><br />
|}<br />
<br />
A custom login page (see [[Open-Xchange_servlet_for_external_login_masks]]) may (and should) set a custom client identification string.<br />
<br />
The output of <code>logincounter</code> can be filtered by client identification strings with the <code>-r</code> or <code>--regex</code> parameter followed by a regular expression matching the desired string(s).<br />
<br />
== Using the <code>logincounter</code> tool ==<br />
<br />
<br />
# logincounter --help<br />
usage: logincounter<br />
-a,--aggregate Optional. Aggregates the counts by users. Only the<br />
total number of logins without duplicate counts<br />
(caused by multiple clients per user) is returned.<br />
-e,--end <arg> Required. Sets the end date for the detecting range.<br />
Example: 2010-01-1 23:59:59<br />
-h,--help Prints a help text<br />
-r,--regex <arg> Optional. Limits the counter to login devices that<br />
match regex.<br />
-s,--start <arg> Required. Sets the start date for the detecting range.<br />
Example: 2009-12-31 00:00:00<br />
<br />
== Examples ==<br />
<br />
Show all logins in the month of June 2014 by clients:<br />
<br />
$ /opt/open-xchange/sbin/logincounter -s "2014-06-01 00:00:00" -e "2014-06-30 23:59:59"<br />
<br />
Show all logins in the month of June 2014, but remove duplicate logins from the "Total" count. (This means a user who logged in with two different clients is only counted once in the total count.)<br />
<br />
$ /opt/open-xchange/sbin/logincounter -s "2014-06-01 00:00:00" -e "2014-06-30 23:59:59" -a<br />
<br />
Restrict output to logins through any OX Drive client:<br />
<br />
$ /opt/open-xchange/sbin/logincounter -s "2014-06-01 00:00:00" -e "2014-06-30 23:59:59" -r ".*OXDrive"<br />
<br />
Same as above, but remove duplicates in the total count (i.e. users using OX Drive on two platforms are only counted once):<br />
<br />
$ /opt/open-xchange/sbin/logincounter -s "2014-06-01 00:00:00" -e "2014-06-30 23:59:59" -r ".*OXDrive" -a<br />
<br />
Show all logins through the App Suite Web UI:<br />
<br />
$ logincounter -s "2014-06-01 00:00:00" -e "2014-06-30 23:59:59" -r "open-xchange-appsuite"<br />
<br />
Show all logins through either the App Suite or the Open-Xchange Server 6 Web UI:<br />
<br />
$ logincounter -s "2014-06-01 00:00:00" -e "2014-06-30 23:59:59" -r "(open-xchange-appsuite|com.openexchange.ox.gui.dhtml)"</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:Logincounter&diff=18160
AppSuite:Logincounter
2014-07-21T10:30:34Z
<p>Sonja.krause-harder: </p>
<hr />
<div>= Login Counter =<br />
<br />
Whenever a user is logged in through the login servlet, the context id, user id, client identification string and a time stamp is saved to the database. If a database entry for this combination of context, user and client is already present, only the timestamp is updated. This means that the database holds the information for the '''last''' login of a specific user with a specific client. This data can be retrieved again with the <code>logincounter</code> tool to show how many users logged in through which client(s) in a given timeframe.<br />
<br />
Please note that only '''logins''' are counted. Depending on the server configuration and the client, sessions may be reused when a user re-accesses the system even after a few hours or days. In this case the login timestamp is not updated. This means that <tt>logincounter</tt> does not necessarily show the number of active users, especially if the request only covers a short timeframe.<br />
<br />
The clients provided by Open-Xchange use the following client identification strings:<br />
<br />
{|<br />
|-<br />
!Client<br />
!client identification string<br />
|-<br />
|Open-Xchange AppSuite (Web UI)<br />
|<tt>open-xchange-appsuite</tt><br />
|-<br />
|Open-Xchange Server 6 (Web UI)<br />
|<tt>com.openexchange.ox.gui.dhtml</tt><br />
|-<br />
|Connector for Business Mobility (Active Sync)<br />
|<tt>USM-EAS</tt><br />
|-<br />
|Connector 2 for Microsoft Outlook <br />
|<tt>USM-JSON</tt><br />
|-<br />
|CardDAV<br />
|<tt>CARDDAV</tt><br />
|-<br />
|CalDAV<br />
|<tt>CALDAV</tt><br />
|-<br />
|Mobile Web App (legacy, OX6 generation)<br />
|<tt>com.openexchange.mobileapp</tt><br />
|-<br />
|OX Drive (native iOS client)<br />
|<tt>OpenXchange.iosClient.OXDrive</tt><br />
|-<br />
|OX Drive (native Android client)<br />
|<tt>OpenXchange.Android.OXDrive</tt><br />
|-<br />
|OX Drive (native Mac OS X client)<br />
|<tt>OSX.OXDrive</tt><br />
|-<br />
|OX Drive (native Windows client)<br />
|<tt>OpenXchange.HTTPClient.OXDrive</tt><br />
|}<br />
<br />
A custom login page (see [[Open-Xchange_servlet_for_external_login_masks]]) may (and should) set a custom client identification string.<br />
<br />
The output of <code>logincounter</code> can be filtered by client identification strings with the <code>-r</code> or <code>--regex</code> parameter followed by a regular expression matching the desired string(s).<br />
<br />
== Using the <code>logincounter</code> tool ==<br />
<br />
<br />
# logincounter --help<br />
usage: logincounter<br />
-a,--aggregate Optional. Aggregates the counts by users. Only the<br />
total number of logins without duplicate counts<br />
(caused by multiple clients per user) is returned.<br />
-e,--end <arg> Required. Sets the end date for the detecting range.<br />
Example: 2010-01-1 23:59:59<br />
-h,--help Prints a help text<br />
-r,--regex <arg> Optional. Limits the counter to login devices that<br />
match regex.<br />
-s,--start <arg> Required. Sets the start date for the detecting range.<br />
Example: 2009-12-31 00:00:00<br />
<br />
== Examples ==<br />
<br />
Show all logins in the month of June 2014 by clients:<br />
<br />
$ /opt/open-xchange/sbin/logincounter -s "2014-06-01 00:00:00" -e "2014-06-30 23:59:59"<br />
<br />
Show all logins in the month of June 2014, but remove duplicate logins from the "Total" count. (This means a user who logged in with two different clients is only counted once in the total count.)<br />
<br />
$ /opt/open-xchange/sbin/logincounter -s "2014-06-01 00:00:00" -e "2014-06-30 23:59:59" -a<br />
<br />
Restrict output to logins through any OX Drive client:<br />
<br />
$ /opt/open-xchange/sbin/logincounter -s "2014-06-01 00:00:00" -e "2014-06-30 23:59:59" -r ".*OXDrive"<br />
<br />
Same as above, but remove duplicates in the total count (i.e. users using OX Drive on two platforms are only counted once):<br />
<br />
$ /opt/open-xchange/sbin/logincounter -s "2014-06-01 00:00:00" -e "2014-06-30 23:59:59" -r ".*OXDrive" -a<br />
<br />
Show all logins through the App Suite Web UI:<br />
<br />
$ logincounter -s "2014-06-01 00:00:00" -e "2014-06-30 23:59:59" -r "open-xchange-appsuite"<br />
<br />
Show all logins through either the App Suite or the Open-Xchange Server 6 Web UI:<br />
<br />
$ logincounter -s "2014-06-01 00:00:00" -e "2014-06-30 23:59:59" -r "(open-xchange-appsuite|com.openexchange.ox.gui.dhtml)"</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:Logincounter&diff=18156
AppSuite:Logincounter
2014-07-18T09:06:42Z
<p>Sonja.krause-harder: /* Examples */</p>
<hr />
<div>= Login Counter =<br />
<br />
Whenever a user is logged in through the login servlet, the context id, user id, client identification string and a time stamp is saved to the database. If a database entry for this combination of context, user and client is already present, only the timestamp is updated. This means that the database holds the information for the '''last''' login of a specific user with a specific client. This data can be retrieved again with the <code>logincounter</code> tool to show how many users logged in through which client(s) in a given timeframe.<br />
<br />
Please note that only '''logins''' are counted. Depending on the server configuration and the client, sessions may be reused when a user re-accesses the system even after a few hours or days. In this case the login timestamp is not updated. This means that <tt>logincounter</tt> does not necessarily show the number of active users, especially if the request only covers a short timeframe.<br />
<br />
The clients provided by Open-Xchange use the following client identification strings:<br />
<br />
{|<br />
|-<br />
!Client<br />
!client identification string<br />
|-<br />
|Open-Xchange AppSuite (Web UI)<br />
|<tt>open-xchange-appsuite</tt><br />
|-<br />
|Open-Xchange Server 6 (Web UI)<br />
|<tt>com.openexchange.ox.gui.dhtml</tt><br />
|-<br />
|Connector for Business Mobility (Active Sync)<br />
|<tt>USM-EAS</tt><br />
|-<br />
|Connector 2 for Microsoft Outlook <br />
|<tt>OpenXchange.HTTPClient.OXAddIn</tt><br />
|-<br />
|CardDAV<br />
|<tt>CARDDAV</tt><br />
|-<br />
|CalDAV<br />
|<tt>CALDAV</tt><br />
|-<br />
|Mobile Web App (legacy, OX6 generation)<br />
|<tt>com.openexchange.mobileapp</tt><br />
|-<br />
|OX Drive (native iOS client)<br />
|<tt>OpenXchange.iosClient.OXDrive</tt><br />
|-<br />
|OX Drive (native Android client)<br />
|<tt>OpenXchange.Android.OXDrive</tt><br />
|-<br />
|OX Drive (native Mac OS X client)<br />
|<tt>OSX.OXDrive</tt><br />
|-<br />
|OX Drive (native Windows client)<br />
|<tt>OpenXchange.HTTPClient.OXDrive</tt><br />
|}<br />
<br />
A custom login page (see [[Open-Xchange_servlet_for_external_login_masks]]) may (and should) set a custom client identification string.<br />
<br />
The output of <code>logincounter</code> can be filtered by client identification strings with the <code>-r</code> or <code>--regex</code> parameter followed by a regular expression matching the desired string(s).<br />
<br />
== Using the <code>logincounter</code> tool ==<br />
<br />
<br />
# logincounter --help<br />
usage: logincounter<br />
-a,--aggregate Optional. Aggregates the counts by users. Only the<br />
total number of logins without duplicate counts<br />
(caused by multiple clients per user) is returned.<br />
-e,--end <arg> Required. Sets the end date for the detecting range.<br />
Example: 2010-01-1 23:59:59<br />
-h,--help Prints a help text<br />
-r,--regex <arg> Optional. Limits the counter to login devices that<br />
match regex.<br />
-s,--start <arg> Required. Sets the start date for the detecting range.<br />
Example: 2009-12-31 00:00:00<br />
<br />
== Examples ==<br />
<br />
Show all logins in the month of June 2014 by clients:<br />
<br />
$ /opt/open-xchange/sbin/logincounter -s "2014-06-01 00:00:00" -e "2014-06-30 23:59:59"<br />
<br />
Show all logins in the month of June 2014, but remove duplicate logins from the "Total" count. (This means a user who logged in with two different clients is only counted once in the total count.)<br />
<br />
$ /opt/open-xchange/sbin/logincounter -s "2014-06-01 00:00:00" -e "2014-06-30 23:59:59" -a<br />
<br />
Restrict output to logins through any OX Drive client:<br />
<br />
$ /opt/open-xchange/sbin/logincounter -s "2014-06-01 00:00:00" -e "2014-06-30 23:59:59" -r ".*OXDrive"<br />
<br />
Same as above, but remove duplicates in the total count (i.e. users using OX Drive on two platforms are only counted once):<br />
<br />
$ /opt/open-xchange/sbin/logincounter -s "2014-06-01 00:00:00" -e "2014-06-30 23:59:59" -r ".*OXDrive" -a<br />
<br />
Show all logins through the App Suite Web UI:<br />
<br />
$ logincounter -s "2014-06-01 00:00:00" -e "2014-06-30 23:59:59" -r "open-xchange-appsuite"<br />
<br />
Show all logins through either the App Suite or the Open-Xchange Server 6 Web UI:<br />
<br />
$ logincounter -s "2014-06-01 00:00:00" -e "2014-06-30 23:59:59" -r "(open-xchange-appsuite|com.openexchange.ox.gui.dhtml)"</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:Logincounter&diff=18155
AppSuite:Logincounter
2014-07-18T09:05:06Z
<p>Sonja.krause-harder: /* Login Counter */</p>
<hr />
<div>= Login Counter =<br />
<br />
Whenever a user is logged in through the login servlet, the context id, user id, client identification string and a time stamp is saved to the database. If a database entry for this combination of context, user and client is already present, only the timestamp is updated. This means that the database holds the information for the '''last''' login of a specific user with a specific client. This data can be retrieved again with the <code>logincounter</code> tool to show how many users logged in through which client(s) in a given timeframe.<br />
<br />
Please note that only '''logins''' are counted. Depending on the server configuration and the client, sessions may be reused when a user re-accesses the system even after a few hours or days. In this case the login timestamp is not updated. This means that <tt>logincounter</tt> does not necessarily show the number of active users, especially if the request only covers a short timeframe.<br />
<br />
The clients provided by Open-Xchange use the following client identification strings:<br />
<br />
{|<br />
|-<br />
!Client<br />
!client identification string<br />
|-<br />
|Open-Xchange AppSuite (Web UI)<br />
|<tt>open-xchange-appsuite</tt><br />
|-<br />
|Open-Xchange Server 6 (Web UI)<br />
|<tt>com.openexchange.ox.gui.dhtml</tt><br />
|-<br />
|Connector for Business Mobility (Active Sync)<br />
|<tt>USM-EAS</tt><br />
|-<br />
|Connector 2 for Microsoft Outlook <br />
|<tt>OpenXchange.HTTPClient.OXAddIn</tt><br />
|-<br />
|CardDAV<br />
|<tt>CARDDAV</tt><br />
|-<br />
|CalDAV<br />
|<tt>CALDAV</tt><br />
|-<br />
|Mobile Web App (legacy, OX6 generation)<br />
|<tt>com.openexchange.mobileapp</tt><br />
|-<br />
|OX Drive (native iOS client)<br />
|<tt>OpenXchange.iosClient.OXDrive</tt><br />
|-<br />
|OX Drive (native Android client)<br />
|<tt>OpenXchange.Android.OXDrive</tt><br />
|-<br />
|OX Drive (native Mac OS X client)<br />
|<tt>OSX.OXDrive</tt><br />
|-<br />
|OX Drive (native Windows client)<br />
|<tt>OpenXchange.HTTPClient.OXDrive</tt><br />
|}<br />
<br />
A custom login page (see [[Open-Xchange_servlet_for_external_login_masks]]) may (and should) set a custom client identification string.<br />
<br />
The output of <code>logincounter</code> can be filtered by client identification strings with the <code>-r</code> or <code>--regex</code> parameter followed by a regular expression matching the desired string(s).<br />
<br />
== Using the <code>logincounter</code> tool ==<br />
<br />
<br />
# logincounter --help<br />
usage: logincounter<br />
-a,--aggregate Optional. Aggregates the counts by users. Only the<br />
total number of logins without duplicate counts<br />
(caused by multiple clients per user) is returned.<br />
-e,--end <arg> Required. Sets the end date for the detecting range.<br />
Example: 2010-01-1 23:59:59<br />
-h,--help Prints a help text<br />
-r,--regex <arg> Optional. Limits the counter to login devices that<br />
match regex.<br />
-s,--start <arg> Required. Sets the start date for the detecting range.<br />
Example: 2009-12-31 00:00:00<br />
<br />
== Examples ==<br />
<br />
Show all logins in the month of June 2014 by clients:<br />
<br />
$ /opt/open-xchange/sbin/logincounter -s "2014-06-01 00:00:00" -e "2014-06-30 23:59:59"<br />
<br />
Show all logins in the month of June 2014, but remove duplicate logins from the "Total" count. (This means a user who logged in with two different clients is only counted once in the total count.)<br />
<br />
$ /opt/open-xchange/sbin/logincounter -s "2014-06-01 00:00:00" -e "2014-06-30 23:59:59" -a<br />
<br />
Restrict output to logins through any OX Drive client:<br />
<br />
$ /opt/open-xchange/sbin/logincounter -s "2014-06-01 00:00:00" -e "2014-06-30 23:59:59" -r ".*OXDrive.*"<br />
<br />
Same as above, but remove duplicates in the total count (i.e. users using OX Drive on two platforms are only counted once):<br />
<br />
$ /opt/open-xchange/sbin/logincounter -s "2014-06-01 00:00:00" -e "2014-06-30 23:59:59" -r ".*OXDrive.*" -a<br />
<br />
Show all logins through the App Suite Web UI:<br />
<br />
$ logincounter -s "2014-06-01 00:00:00" -e "2014-06-30 23:59:59" -r "open-xchange-appsuite"<br />
<br />
Show all logins through either the App Suite or the Open-Xchange Server 6 Web UI:<br />
<br />
$ logincounter -s "2014-06-01 00:00:00" -e "2014-06-30 23:59:59" -r "(open-xchange-appsuite|com.openexchange.ox.gui.dhtml)"</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:Logincounter&diff=18154
AppSuite:Logincounter
2014-07-18T09:04:38Z
<p>Sonja.krause-harder: </p>
<hr />
<div>= Login Counter =<br />
<br />
Whenever a user is logged in through the login servlet, the context id, user id, client identification string and a time stamp is saved to the database. If a database entry for this combination of context, user and client is already present, only the timestamp is updated. This means that the database holds the information for the '''last''' login of a specific user with a specific client. This data can be retrieved again with the <code>logincounter</code> tool to show how many users logged in through which client(s) in a given timeframe.<br />
<br />
Please note: Only logins are counted. Depending on the server configuration and the client, sessions may be reused when a user re-accesses the system even after a few hours or days. In this case the login timestamp is not updated. This means that <tt>logincounter</tt> does not necessarily show the number of active users, especially if the request only covers a short timeframe.<br />
<br />
The clients provided by Open-Xchange use the following client identification strings:<br />
<br />
{|<br />
|-<br />
!Client<br />
!client identification string<br />
|-<br />
|Open-Xchange AppSuite (Web UI)<br />
|<tt>open-xchange-appsuite</tt><br />
|-<br />
|Open-Xchange Server 6 (Web UI)<br />
|<tt>com.openexchange.ox.gui.dhtml</tt><br />
|-<br />
|Connector for Business Mobility (Active Sync)<br />
|<tt>USM-EAS</tt><br />
|-<br />
|Connector 2 for Microsoft Outlook <br />
|<tt>OpenXchange.HTTPClient.OXAddIn</tt><br />
|-<br />
|CardDAV<br />
|<tt>CARDDAV</tt><br />
|-<br />
|CalDAV<br />
|<tt>CALDAV</tt><br />
|-<br />
|Mobile Web App (legacy, OX6 generation)<br />
|<tt>com.openexchange.mobileapp</tt><br />
|-<br />
|OX Drive (native iOS client)<br />
|<tt>OpenXchange.iosClient.OXDrive</tt><br />
|-<br />
|OX Drive (native Android client)<br />
|<tt>OpenXchange.Android.OXDrive</tt><br />
|-<br />
|OX Drive (native Mac OS X client)<br />
|<tt>OSX.OXDrive</tt><br />
|-<br />
|OX Drive (native Windows client)<br />
|<tt>OpenXchange.HTTPClient.OXDrive</tt><br />
|}<br />
<br />
A custom login page (see [[Open-Xchange_servlet_for_external_login_masks]]) may (and should) set a custom client identification string.<br />
<br />
The output of <code>logincounter</code> can be filtered by client identification strings with the <code>-r</code> or <code>--regex</code> parameter followed by a regular expression matching the desired string(s).<br />
<br />
== Using the <code>logincounter</code> tool ==<br />
<br />
<br />
# logincounter --help<br />
usage: logincounter<br />
-a,--aggregate Optional. Aggregates the counts by users. Only the<br />
total number of logins without duplicate counts<br />
(caused by multiple clients per user) is returned.<br />
-e,--end <arg> Required. Sets the end date for the detecting range.<br />
Example: 2010-01-1 23:59:59<br />
-h,--help Prints a help text<br />
-r,--regex <arg> Optional. Limits the counter to login devices that<br />
match regex.<br />
-s,--start <arg> Required. Sets the start date for the detecting range.<br />
Example: 2009-12-31 00:00:00<br />
<br />
== Examples ==<br />
<br />
Show all logins in the month of June 2014 by clients:<br />
<br />
$ /opt/open-xchange/sbin/logincounter -s "2014-06-01 00:00:00" -e "2014-06-30 23:59:59"<br />
<br />
Show all logins in the month of June 2014, but remove duplicate logins from the "Total" count. (This means a user who logged in with two different clients is only counted once in the total count.)<br />
<br />
$ /opt/open-xchange/sbin/logincounter -s "2014-06-01 00:00:00" -e "2014-06-30 23:59:59" -a<br />
<br />
Restrict output to logins through any OX Drive client:<br />
<br />
$ /opt/open-xchange/sbin/logincounter -s "2014-06-01 00:00:00" -e "2014-06-30 23:59:59" -r ".*OXDrive.*"<br />
<br />
Same as above, but remove duplicates in the total count (i.e. users using OX Drive on two platforms are only counted once):<br />
<br />
$ /opt/open-xchange/sbin/logincounter -s "2014-06-01 00:00:00" -e "2014-06-30 23:59:59" -r ".*OXDrive.*" -a<br />
<br />
Show all logins through the App Suite Web UI:<br />
<br />
$ logincounter -s "2014-06-01 00:00:00" -e "2014-06-30 23:59:59" -r "open-xchange-appsuite"<br />
<br />
Show all logins through either the App Suite or the Open-Xchange Server 6 Web UI:<br />
<br />
$ logincounter -s "2014-06-01 00:00:00" -e "2014-06-30 23:59:59" -r "(open-xchange-appsuite|com.openexchange.ox.gui.dhtml)"</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=OXSessionFormLogin&diff=18153
OXSessionFormLogin
2014-07-18T09:03:32Z
<p>Sonja.krause-harder: /* Parameters */</p>
<hr />
<div>= Form Login =<br />
<br />
The form login is a mechanism, that allows you to create a custom login form, by which way a user may enter the OX frontend. All you need to do, is have the form POST the necessary login information and the location of the OX frontend. The OX server will create a session, set all necessary cookies and forward the browser to the frontend. <br />
<br />
<br />
== Parameters ==<br />
<br />
The parameters that the OX servers login process expects are:<br />
<br />
; login<br />
: The login name. This will usually be a text input.<br />
; password<br />
: The users password. This will usually be a password input field.<br />
; client<br />
: The client parameter used to distinguish between programs using the same cookie store. Since we want the new session to be used by the AJAX frontend, we'll set this to '''com.openexchange.ox.gui.dhtml''' for the OX6 frontend, to '''open-xchange-appsuite''' for App Suite and '''com.openexchange.mobileapp''' for the Mobile UI. This is a hidden field. See also [[OXSessionHandlingGlossary ]]. This parameter can be given to the [[AppSuite:Logincounter|logincounter]] tool to retrieve statistics about how (and how often) end users are logging in to the system.<br />
; version<br />
: A version string. The content is not really relevant, but it will be logged, so we can later find out, where a login request came from. The UI will usually send its version, we'll send '''Form Login''' so we can see in the logfile when our spiffy new form was used to log in. This will also be a hidden field.<br />
; autologin<br />
: This tells the frontend whether to attempt to store the session data for a later autologin. This can only be true if server configuration parameter '''com.openexchange.sessiond.autologin''' is enabled as well, otherwise the UI will attempt to store the session and trigger a server error. See [[OXSessionAutologin]] for more details about the autologin process.<br />
; uiWebPath<br />
: Tells the server where to find the frontend, so it can redirect the browser there. This will usually be a relative URL, since the backend and frontend are usually accessible using the same host (they have to be to allow for the same source policy in javascript). '''Make sure to always send the browser to the index.html and NOT the ox.html'''. The index.html contains some browser checks that have to be done before entering the UI. You'll save yourself headaches by always sending the user to the index.html. Usually this will point to '''/ox6/index.html''' for the OX6 frontend or '''/appsuite/''' (note the trailing slash) for App Suite. This also is a hidden field.<br />
; authId<br />
: A random string used for tracking a login requests way through your apache / OX setup.<br />
<br />
== Example ==<br />
<br />
So, in essence, what we need is a form for POSTing to the backend with the above parameters. This is pretty basic HTML stuff:<br />
<br />
<syntaxhighlight lang='html4strict'><br />
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"><br />
<html><br />
<head><br />
<meta http-equiv="content-type" content="text/html; charset=UTF-8"><br />
<meta http-equiv="cache-control" content="no-cache"><br />
<title>Login</title><br />
<script type="text/javascript"><br />
function uuid() {<br />
function hex(len, x) {<br />
if (x === undefined) x = Math.random();<br />
var s = new Array(len);<br />
for (var i = 0; i < len; i++) {<br />
x *= 16;<br />
var digit = x & 15;<br />
s[i] = digit + (digit < 10 ? 48 : 87); // '0' and 'a' - 10<br />
}<br />
return String.fromCharCode.apply(String, s);<br />
}<br />
return [hex(8), "-", hex(4), "-4", hex(3), "-", hex(4, 0.5 + Math.random() / 4), "-", hex(12)].join("");<br />
}<br />
</script><br />
</head><br />
<body><br />
<form action="/ajax/login?action=formlogin&authId=" method="post" onSubmit="this.action += uuid();"><br />
<p><br />
<label for="login">Username: </label><br />
<input type="text" name="login" id="login"><br><br />
<label for="password">Password: </label><br />
<input type="password" name="password" id="password"><br><br />
<input type="submit" value="Login"><br />
<input type="hidden" name="version" value="Form Login"><br />
<input type="hidden" name="autologin" value="true"><br />
<br />
<!-- When using OX App Suite --><br />
<input type="hidden" name="client" value="open-xchange-appsuite"><br />
<!-- Important: value of uiWebPath MUST be terminated by a trailing slash "/" --><br />
<input type="hidden" name="uiWebPath" value="/appsuite/"><br />
<br />
<!-- When using OX6 --><br />
<!-- <input type="hidden" name="client" value="com.openexchange.ox.gui.dhtml"> --><br />
<!-- <input type="hidden" name="uiWebPath" value="/ox6/index.html"> --><br />
<br />
<!-- When using Mobile Web Interface --><br />
<!-- <input type="hidden" name="client" value="com.openexchange.mobileapp"> --><br />
<!-- <input type="hidden" name="uiWebPath" value="/mobile/index.html"> --><br />
</p><br />
</form><br />
</body><br />
</html><br />
</syntaxhighlight> <br />
<br />
Notice the form sends its entries to '''/ajax/login?action=formlogin'''. This relative URL will only work if the form is accessed using the same host name as the OX server. If you want to send the user to the OX server from a different host, specify the whole address in the forms action attribute, e.g. '''https://ox.mydomain.com/ajax/login?action=formlogin'''. The '''uiWebPath''' though is always considered relative to the OX server (regardless of where the form resides), so you're usually good when using a relative link there. <br />
<br />
Now back to the '''authId'''. In order to generate a unique String we'll define a javascript function in the head of the document.<br />
<br />
We won't worry about the details here, only one thing matters to us at this point: This bit of javascript generates a random UUID that we can use for our authId parameter. Since we want to see that parameter in the apache log files, we have to pass this as part of the URL. This means, when the user submits the form, we'll append a generated authId to the URL.<br />
<br />
If you're uncomfortable using javascript for this, you might opt for having the form page generated by a server side script and just include the random UUID in the form definition. The only thing to remember about this is: You need the '''authId''' parameter, it must be part of the URL, so it shows up in logfiles and it must be unique so that it makes sense when later tracking what happens to a login request. In total our form page looks like this:<br />
<br />
== Login Errors ==<br />
<br />
What happens if an error occurs during the login process? For example, the user might have entered the wrong password? In that case the OX Server uses an error template, you may override, to display an error message. It's basic, but functional:<br />
<br />
<syntaxhighlight lang='html4strict'><br />
<html><br />
<script type="text/javascript"><br />
// Display normal HTML for 5 seconds, then redirect via referrer.<br />
setTimeout(redirect,5000);<br />
function redirect(){<br />
var referrer=document.referrer;<br />
var redirect_url;<br />
// If referrer already contains failed parameter, we don't add a 2nd one.<br />
if(referrer.indexOf("login=failed")>=0){<br />
redirect_url=referrer;<br />
}else{<br />
// Check if referrer contains multiple parameter<br />
if(referrer.indexOf("?")<0){<br />
redirect_url=referrer+"?login=failed";<br />
}else{<br />
redirect_url=referrer+"&login=failed";<br />
}<br />
}<br />
// Redirect to referrer<br />
window.location.href=redirect_url;<br />
}<br />
</script><br />
<body><br />
<h1>ERROR_MESSAGE</h1><br />
</body><br />
</html><br />
</syntaxhighlight><br />
<br />
What does it do? It displays the error message for 5 seconds and the redirects back to the referrer, meaning: Your form. It adds a login=failed parameter to the URL, so your form may react when something went wrong. If you think (like myself) this form lacks the, ah well, je-ne-sais-quoi of a nice error page, then fret not! You can provide your own custom template. To do that, open up the file '''/opt/openexchange/etc/login.properties''' and set the '''com.openexchange.ajax.login.errorPageTemplate''' to point to a file on the OX system that contains your template. For example:<br />
<br />
com.openexchange.ajax.login.errorPageTemplate=/opt/openexchange/local/loginErrors.html<br />
<br />
<br />
Then write the template. Keep in mind, that ERROR_MESSAGE will be replaced by the actual error message of the login attempt (say "Your password was not valid" or somesuch). The template above might be a good starting point for you to start experimenting.<br />
<br />
<br />
<br />
[[Category: OX6]]<br />
[[Category: AppSuite]]<br />
[[Category: v6.22]]<br />
[[Category: HTTP API]]<br />
[[Category: Details]]<br />
[[Category: Frontend]]<br />
[[Category: Adminstrator]]</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=OXSessionFormLogin&diff=18152
OXSessionFormLogin
2014-07-18T09:03:01Z
<p>Sonja.krause-harder: /* Parameters */</p>
<hr />
<div>= Form Login =<br />
<br />
The form login is a mechanism, that allows you to create a custom login form, by which way a user may enter the OX frontend. All you need to do, is have the form POST the necessary login information and the location of the OX frontend. The OX server will create a session, set all necessary cookies and forward the browser to the frontend. <br />
<br />
<br />
== Parameters ==<br />
<br />
The parameters that the OX servers login process expects are:<br />
<br />
; login<br />
: The login name. This will usually be a text input.<br />
; password<br />
: The users password. This will usually be a password input field.<br />
; client<br />
: The client parameter used to distinguish between programs using the same cookie store. Since we want the new session to be used by the AJAX frontend, we'll set this to '''com.openexchange.ox.gui.dhtml''' for the OX6 frontend, to '''open-xchange-appsuite''' for App Suite and '''com.openexchange.mobileapp''' for the Mobile UI. This is a hidden field. See also [[OXSessionHandlingGlossary ]]. This parameter can be given to the [[AppSuite:Logincounter|logincounter]] tool to retrieve statistics about how end users are using the system.<br />
; version<br />
: A version string. The content is not really relevant, but it will be logged, so we can later find out, where a login request came from. The UI will usually send its version, we'll send '''Form Login''' so we can see in the logfile when our spiffy new form was used to log in. This will also be a hidden field.<br />
; autologin<br />
: This tells the frontend whether to attempt to store the session data for a later autologin. This can only be true if server configuration parameter '''com.openexchange.sessiond.autologin''' is enabled as well, otherwise the UI will attempt to store the session and trigger a server error. See [[OXSessionAutologin]] for more details about the autologin process.<br />
; uiWebPath<br />
: Tells the server where to find the frontend, so it can redirect the browser there. This will usually be a relative URL, since the backend and frontend are usually accessible using the same host (they have to be to allow for the same source policy in javascript). '''Make sure to always send the browser to the index.html and NOT the ox.html'''. The index.html contains some browser checks that have to be done before entering the UI. You'll save yourself headaches by always sending the user to the index.html. Usually this will point to '''/ox6/index.html''' for the OX6 frontend or '''/appsuite/''' (note the trailing slash) for App Suite. This also is a hidden field.<br />
; authId<br />
: A random string used for tracking a login requests way through your apache / OX setup.<br />
<br />
== Example ==<br />
<br />
So, in essence, what we need is a form for POSTing to the backend with the above parameters. This is pretty basic HTML stuff:<br />
<br />
<syntaxhighlight lang='html4strict'><br />
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"><br />
<html><br />
<head><br />
<meta http-equiv="content-type" content="text/html; charset=UTF-8"><br />
<meta http-equiv="cache-control" content="no-cache"><br />
<title>Login</title><br />
<script type="text/javascript"><br />
function uuid() {<br />
function hex(len, x) {<br />
if (x === undefined) x = Math.random();<br />
var s = new Array(len);<br />
for (var i = 0; i < len; i++) {<br />
x *= 16;<br />
var digit = x & 15;<br />
s[i] = digit + (digit < 10 ? 48 : 87); // '0' and 'a' - 10<br />
}<br />
return String.fromCharCode.apply(String, s);<br />
}<br />
return [hex(8), "-", hex(4), "-4", hex(3), "-", hex(4, 0.5 + Math.random() / 4), "-", hex(12)].join("");<br />
}<br />
</script><br />
</head><br />
<body><br />
<form action="/ajax/login?action=formlogin&authId=" method="post" onSubmit="this.action += uuid();"><br />
<p><br />
<label for="login">Username: </label><br />
<input type="text" name="login" id="login"><br><br />
<label for="password">Password: </label><br />
<input type="password" name="password" id="password"><br><br />
<input type="submit" value="Login"><br />
<input type="hidden" name="version" value="Form Login"><br />
<input type="hidden" name="autologin" value="true"><br />
<br />
<!-- When using OX App Suite --><br />
<input type="hidden" name="client" value="open-xchange-appsuite"><br />
<!-- Important: value of uiWebPath MUST be terminated by a trailing slash "/" --><br />
<input type="hidden" name="uiWebPath" value="/appsuite/"><br />
<br />
<!-- When using OX6 --><br />
<!-- <input type="hidden" name="client" value="com.openexchange.ox.gui.dhtml"> --><br />
<!-- <input type="hidden" name="uiWebPath" value="/ox6/index.html"> --><br />
<br />
<!-- When using Mobile Web Interface --><br />
<!-- <input type="hidden" name="client" value="com.openexchange.mobileapp"> --><br />
<!-- <input type="hidden" name="uiWebPath" value="/mobile/index.html"> --><br />
</p><br />
</form><br />
</body><br />
</html><br />
</syntaxhighlight> <br />
<br />
Notice the form sends its entries to '''/ajax/login?action=formlogin'''. This relative URL will only work if the form is accessed using the same host name as the OX server. If you want to send the user to the OX server from a different host, specify the whole address in the forms action attribute, e.g. '''https://ox.mydomain.com/ajax/login?action=formlogin'''. The '''uiWebPath''' though is always considered relative to the OX server (regardless of where the form resides), so you're usually good when using a relative link there. <br />
<br />
Now back to the '''authId'''. In order to generate a unique String we'll define a javascript function in the head of the document.<br />
<br />
We won't worry about the details here, only one thing matters to us at this point: This bit of javascript generates a random UUID that we can use for our authId parameter. Since we want to see that parameter in the apache log files, we have to pass this as part of the URL. This means, when the user submits the form, we'll append a generated authId to the URL.<br />
<br />
If you're uncomfortable using javascript for this, you might opt for having the form page generated by a server side script and just include the random UUID in the form definition. The only thing to remember about this is: You need the '''authId''' parameter, it must be part of the URL, so it shows up in logfiles and it must be unique so that it makes sense when later tracking what happens to a login request. In total our form page looks like this:<br />
<br />
== Login Errors ==<br />
<br />
What happens if an error occurs during the login process? For example, the user might have entered the wrong password? In that case the OX Server uses an error template, you may override, to display an error message. It's basic, but functional:<br />
<br />
<syntaxhighlight lang='html4strict'><br />
<html><br />
<script type="text/javascript"><br />
// Display normal HTML for 5 seconds, then redirect via referrer.<br />
setTimeout(redirect,5000);<br />
function redirect(){<br />
var referrer=document.referrer;<br />
var redirect_url;<br />
// If referrer already contains failed parameter, we don't add a 2nd one.<br />
if(referrer.indexOf("login=failed")>=0){<br />
redirect_url=referrer;<br />
}else{<br />
// Check if referrer contains multiple parameter<br />
if(referrer.indexOf("?")<0){<br />
redirect_url=referrer+"?login=failed";<br />
}else{<br />
redirect_url=referrer+"&login=failed";<br />
}<br />
}<br />
// Redirect to referrer<br />
window.location.href=redirect_url;<br />
}<br />
</script><br />
<body><br />
<h1>ERROR_MESSAGE</h1><br />
</body><br />
</html><br />
</syntaxhighlight><br />
<br />
What does it do? It displays the error message for 5 seconds and the redirects back to the referrer, meaning: Your form. It adds a login=failed parameter to the URL, so your form may react when something went wrong. If you think (like myself) this form lacks the, ah well, je-ne-sais-quoi of a nice error page, then fret not! You can provide your own custom template. To do that, open up the file '''/opt/openexchange/etc/login.properties''' and set the '''com.openexchange.ajax.login.errorPageTemplate''' to point to a file on the OX system that contains your template. For example:<br />
<br />
com.openexchange.ajax.login.errorPageTemplate=/opt/openexchange/local/loginErrors.html<br />
<br />
<br />
Then write the template. Keep in mind, that ERROR_MESSAGE will be replaced by the actual error message of the login attempt (say "Your password was not valid" or somesuch). The template above might be a good starting point for you to start experimenting.<br />
<br />
<br />
<br />
[[Category: OX6]]<br />
[[Category: AppSuite]]<br />
[[Category: v6.22]]<br />
[[Category: HTTP API]]<br />
[[Category: Details]]<br />
[[Category: Frontend]]<br />
[[Category: Adminstrator]]</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:Main_Page_Advanced&diff=18151
AppSuite:Main Page Advanced
2014-07-18T08:45:48Z
<p>Sonja.krause-harder: </p>
<hr />
<div>__NOTOC__<br />
= Overview =<br />
*[[AppSuite:Architecture_Overview|Architecture Overview]]<br />
<br />
= OX App Suite UI Development =<br />
This page contains all the information you need to get started with UI development.<br />
<br />
This covers how-to articles including server communication, extension points and how to write widgets, applications and plugins:<br />
<br />
[[AppSuite:UI | Frontend development articles]]<br />
<br />
= Groupware Server customization =<br />
* [[Automatic_Delete_OXObjects_Per_User|Automatically delete users OX-Objects and OX-Folders]]<br />
* [[Login_variations|Background Information about Login Variation]]<br />
* Auto login, session handling, single sign on<br />
** [http://www.open-xchange.com/fileadmin/user_upload/open-xchange/document/presentation/OX-HE-Authentication-Sessionhandling-en-6.18.pdf Authentication and Sessionhandling white paper (EasyLogin)]<br />
** Custom login masks<br />
*** [[Open-Xchange servlet for external login masks]]<br />
<br />
= Programming Interfaces =<br />
* The [[AppSuite:HTTP_API|HTTP API]] is used by the Open-Xchange GUI and various 3rd party applications. It consists mainly of messages in JavaScript Object Notation ([http://json.org JSON]) sent over HTTP. Here is a general [[AppSuite:Introduction to the HTTP API|Introduction to the HTTP API]].<br />
* Provisioning API to access the Open-Xchange Admin Daemon<br />
** The [http://java.sun.com/javase/technologies/core/basic/rmi/index.jsp RMI] API is used for data provisioning of Contexts, Users, Groups and Resources as well as for configuring Databases, Filestores and OX Servers. It is currently split into two parts,<br />
*** a {{DocLink|docpath=RMI/admin-core/|name=core}} and<br />
*** a {{DocLink|docpath=RMI/admin-hosting/|name=hosting}} component.<br />
** The {{DocLink|docpath=OX6-Provisioning/|name=Open-Xchange CLT}} are shell scripts that simplify groupware and service administration<br />
** Create contexts/users with with [[Csv_import]]<br />
** [[Open-Xchange-SOAP|Provisioning using SOAP]]<br />
* The [[Oxmapi|Oxmapi]] is a windows library for programmers needed to communicate with the OX server<br />
* {{DocLink|docpath=mal/|name=Open-Xchange Mail Abstraction Layer}}<br />
* The Plugin API for extending the GUI is described in two documents: [[Plugin API|an overview]] and {{DocLink|docpath=gui-plugin-api|name=the reference}}<br />
* [[UDPPush]] Open-Xchange PUSH Interface for Groupware Objects<br />
<br />
= Testing and QA =<br />
* [[Automated GUI Tests]]<br />
* [[Jmeter profile for performance tests|JMeter profile for performance tests]]<br />
* [[Gatling Performance Tests]]<br />
<br />
= Statistics =<br />
<br />
* [[AppSuite:Logincounter|logincounter]]<br />
<br />
= Translations =<br />
* [[AppSuite:Available_Translations| Available Language Translations]]<br />
* [[GUI Translation|Translate Open-Xchange to your community language]]<br />
* [[AppSuite:Translate_Open-Xchange_to_supported_language|Translate Open-Xchange to supported language]]<br />
<br />
= Installation based on source code =<br />
* [[SourceCodeAccess|Download the sourcecode]]<br />
* [[AppSuite:ISV_Development_Environment_Setup_AppSuite_backend|Backend Development via Eclipse IDE]]<br />
<br />
= Integration =<br />
* {{DocLink|docpath=whitepaper/OX-Directory-Integration-Whitepaper-English.pdf|name=Directory Integration Whitepaper}}</div>
Sonja.krause-harder
https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:AdminGuide_7.6.0&diff=18150
AppSuite:AdminGuide 7.6.0
2014-07-18T08:41:29Z
<p>Sonja.krause-harder: </p>
<hr />
<div>Older versions: [[AppSuite:AdminGuide_7.4.2|7.4.2]], [[AppSuite:AdminGuide_7.4.0|7.4.0]], [[AppSuite:AdminGuide_7_2|7.2.0]], [[AppSuite:AdminGuide_7_0_1|7.0.1]]<br />
<br />
= Open-Xchange Installation and Update =<br />
<br />
== OX App Suite ==<br />
* [[AppSuite:Open-Xchange_Installation_Guide_for_Debian_6.0|Download and Installation Guide for Debian GNU/Linux 6.0 (Squeeze)]]<br />
* [[AppSuite:Open-Xchange_Installation_Guide_for_Debian_7.0|Download and Installation Guide for Debian GNU/Linux 7.0 (Wheezy)]]<br />
* [[AppSuite:Open-Xchange_Installation_Guide_for_SLES11|Download and Installation Guide for SUSE Linux Enterprise Server 11]]<br />
* [[AppSuite:Open-Xchange_Installation_Guide_for_RHEL6|Download and Installation Guide for RedHat Enterprise Linux 6]]<br />
* [[AppSuite:Open-Xchange_Installation_Guide_for_CentOS_6|Download and Installation Guide for CentOS 6]]<br />
* [[OXSE4UCS_Installation_en|Download and Installation Guide for Univention Corporate Server]]<br />
<br />
== Open-Xchange Update ==<br />
* [[AppSuite:UpdatingOXPackages|Updating Open-Xchange AppSuite v7.0.0 to v7.4]]<br />
* [[AppSuite:Upgrade_from_6.22_Debian_6.0|Update Guide v6.22 to v7.4 for Debian GNU/Linux 6.0 (Squeeze)]]<br />
* [[AppSuite:Upgrade_from_6.22_for_SLES11|Update Guide v6.22 to v7.4 for SUSE Linux Enterprise Server 11]]<br />
* [[AppSuite:Upgrade_from_6.22_for_RHEL6|Update Guide v6.22 to v7.4 for RedHat Enterprise Linux 6]]<br />
* [[AppSuite:Upgrade_from_6.22_for_CentOS6 |Update Guide v6.22 to v7.4 for CentOS 6]]<br />
* [[UpdateTasks|Update Task Management in Open-Xchange]]<br />
<br />
== Parallel Setup of OX App Suite UI and OX 6 UI ==<br />
<br />
* [[AppSuite:Parallel_UISupport_OX6_AppSuite_Debian_6.0|Parallel Setup Guide for Debian GNU/Linux 6.0 (Squeeze)]]<br />
* [[AppSuite:Parallel_UISupport_OX6_AppSuite_RHEL_6_CentOS_6|Parallel Setup Guide for Red Hat Enterprise Linux 6 and CentOS 6]]<br />
* [[AppSuite:Parallel_UISupport_OX6_AppSuite_SLES_11|Parallel Setup Guide for SUSE Linux Enterprise Server 11]]<br />
<br />
== Additional Software ==<br />
* [[AppSuite:Text_Installation_Guide |Download & Install OX Text]]<br />
* [[AppSuite:Spreadsheet_Installation_Guide |Download & Install OX Spreadsheet]]<br />
* [[AppSuite:DocumentViewer |Download & Install Document Viewer]]<br />
* [[AppSuite:Open-Xchange_Updater|Installation of the Open-Xchange Updater]]<br />
* [[AppSuite:Connector_for_Microsoft_Outlook|Installation & Configuration of the Open-Xchange Connector for Microsoft Outlook]]<br />
* [[AppSuite:Connector_for_Business_Mobility_Installation_Guide|Installation and information of the Connector for Business Mobility]]<br />
* [[AppSuite:OX_Drive|Installation and information of OX Drive for Client]]<br />
* [[AppSuite:OX_Mobile_Web_Interface|Installation of the Open-Xchange Mobile Web Interface]]<br />
* [[Open-Xchange_Installation_Guide_for_OX_Notifier|Installation & Configuration of the Open-Xchange Notifier]]<br />
* [[Open-Xchange_cPanel_Installation|Download & Installation of the OX Connector for cPanel]]<br />
* [[AppSuite:Connector_for_WHMCS_Installation_Guide|Download & Installation of the OX Connector for WHMCS]]<br />
* [[Parallels_Integration|Integrate Open-Xchange with Parallels]]<br />
<br />
= OX App Suite Configuration =<br />
<br />
== Advanced Configuration ==<br />
* [[AppSuite:CalDAVClients | Configuration CalDAV with Open-Xchange]]<br />
* [[AppSuite:CardDAVClients | Configuration CardDAV with Open-Xchange]]<br />
* [[AppSuite:Caldav_carddav_Bundles| Installation CardDAV/CalDAV with Open-Xchange]]<br />
* [[AppSuite:Running_a_cluster| Configuration Cluster-Setup]]<br />
* [[AppSuite:Grizzly| Configuration Connector based on Grizzly]]<br />
* [[ContactStorageLDAP| LDAP Contact Storage]]<br />
* [[AppSuite:Setup_CIFS | Setup a CIFS Account as primary/additional FileStorage Account]]<br />
* [[Filtering_templates | Filtering publication templates according to their purpose]]<br />
<br />
== OX App Suite Configuration Parameter ==<br />
* [[AppSuite:Configuration_properties_7.4| Configuration properties]] - everything you ever wanted to change about the AppSuite<br />
<br />
== OX App Suite Management (CLT)==<br />
* [[AppSuite:Context management|Context management]]<br />
* [[AppSuite:User management|User management]]<br />
* [[AppSuite:Group management|Group management]]<br />
* [[AppSuite:Resource management|Resource management]]<br />
* [[AppSuite:Data management|Data management]]<br />
<br />
= Advanced Documentation =<br />
<br />
== Architecture Overview ==<br />
*[[AppSuite:Architecture_Overview|Architecture Overview]]<br />
<br />
== Importing and exporting data ==<br />
* General [[restrictions on importing data]]<br />
* Migrate a batch of users and contexts at once. Check the CSV Batch Import documentation [[Csv_import|page]].<br />
* Documentation for the [[data import format|data import format]]<br />
* [[VCard and ICal support]]<br />
* [[Using the export servlet]]<br />
* [[Using the import servlet]]<br />
* [[export ical/vcard|Example in bash to extract private contacts, tasks or appointments in ical/vcard format]]<br />
* [[CrawlerArchitecture|Architecture of the crawler bundle]]<br />
<br />
== Configuration and Tweaks ==<br />
* [[Open_Xchange_Configuration|Open-Xchange Configuration]]<br />
* [[Open-Xchange_Lighttpd|Open-Xchange and Lighttpd]]<br />
* [[On_The_Fly_Configuration_Update|On The Fly Configuration Update (experimental)]]<br />
* [[Session_Migration|Session migration]]<br />
* [[MailNotify_Bundle|Mail Notification (Push) with Open-Xchange]]<br />
* [[Tune_apache2_for_more_concurrent_connections|Apache2 tuning]]<br />
<br />
== Statistics ==<br />
<br />
* [[AppSuite:Logincounter|logincounter]]<br />
<br />
== Troubleshooting ==<br />
* [http://www.open-xchange.com/forum/ Open-Xchange Forum]<br />
* Check the [http://sdb.open-xchange.com/ Open-Xchange Support Database]<br />
* FAQs can be found in the [http://sdb.open-xchange.com/faq SDB FAQ section].<br />
* [[Passwords in Open-Xchange]]<br />
* [[Outlook_OXtender2_Best_Practice| Outlook Connector best practice]]<br />
* [[AppSuite:OX_Logging|Logging]] - configuring and understanding the LOGBACK logging system<br />
* [[AppSuite:Oxsysreport | Creating an OX Support Tarball]]<br />
<br />
== Integration Scenarios ==<br />
* [http://oxpedia.org/wiki/index.php?title=Category:Config Open-Xchange configuration options summary]<br />
* [[OX_Permission_Level | OX Permission Level Matrix]]<br />
* [[Load_balancing_and_clustering | Load balancing and OX clustering]]<br />
* [[Open-Xchange-RHEL-AD-Integration|Integration of Open-Xchange into MS Active Directory and Exchange ]]<br />
* [[ContextRestore_Bundle|Restoring contexts using the context restore bundle]]<br />
* [[Lawful_Interception|Lawful Interception (Telekommunikationsüberwachung)]]<br />
* [[OX_EMail_Push_Introduction|Introduction to EMail Push in Open-Xchange]]<br />
<br />
<br />
<br />
[[Category: OX7]]<br />
[[Category: AppSuite]]<br />
[[Category: Administrator]]</div>
Sonja.krause-harder