Difference between revisions of "AppSuite:Mobile API Facade"

Line 10: Line 10:
  
 
The OX Facade has to be installed alongside an OX App Suite installation. It requires at least OX App Suite v7.8.4.
 
The OX Facade has to be installed alongside an OX App Suite installation. It requires at least OX App Suite v7.8.4.
 +
 +
== OX Facade API ==
 +
 +
Further information about the OX Facade API can be found at:
 +
https://documentation.open-xchange.com/components/facade/develop/
 +
 +
= OX Mail Server-side Installation and Configuration on OX App Suite v7.8.x =
 +
 +
This chapter describes how the backend components of OX Mail are installed and configured on the server.
 +
 +
== Available packages ==
 +
 +
OX Facade is available with the following backend packages:
 +
 +
* ''open-xchange-mobile-push-certificates'' - Certificates for cloud-based push notifications
 +
* ''open-xchange-mailapp-backend'' - The main server components for OX Mail
 +
* ''open-xchange-mobile-push-plugin'' - Provides Push functionality
 +
 +
Installation on the server varies depending on the underlying distribution, details are available in the following chapters.
 +
 +
=== Redhat Enterprise Linux 6 or CentOS 6 ===
 +
 +
Add the following repositories to your Open-Xchange yum configuration:
 +
 +
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}
 +
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail|mailapp}}
 +
 +
and run
 +
 +
$ yum install open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin
 +
 +
=== Redhat Enterprise Linux 7 or CentOS 7 ===
 +
 +
Add the following repositories to your Open-Xchange yum configuration:
 +
 +
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL7|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}
 +
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=rhelname|pc2v=RHEL7|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail|mailapp}}
 +
 +
and run
 +
 +
$ yum install open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin
 +
 +
=== Debian GNU/Linux 7.0 (Wheezy) (valid until v7.8.2) ===
 +
 +
Add the following repositories to your Open-Xchange apt configuration:
 +
 +
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/7.8.2|pc2n=debianname|pc2v=DebianWheezy|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}
 +
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=debianname|pc2v=DebianWheezy|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail|mailapp}}
 +
 +
and run
 +
 +
$ apt-get update
 +
$ apt-get install open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin
 +
 +
=== Debian GNU/Linux 8.0 (Jessie) ===
 +
 +
Add the following repositories to your Open-Xchange apt configuration:
 +
 +
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianJessie|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}
 +
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=debianname|pc2v=DebianJessie|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail|mailapp}}
 +
 +
and run
 +
 +
$ apt-get update
 +
$ apt-get install open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin
 +
 +
 +
=== SUSE Linux Enterprise Server 11 (valid until v7.8.2) ===
 +
 +
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/7.8.2|pc2n=susename|pc2v=SLES11|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|backend/updates}}
 +
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=susename|pc2v=SLES11|mail|mailapp}}
 +
 +
$ zypper ref
 +
$ zypper install open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin
 +
 +
=== SUSE Linux Enterprise Server 12 ===
 +
 +
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLE_12|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|backend/updates}}
 +
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=susename|pc2v=SLE_12|mail|mailapp}}
 +
 +
$ zypper ref
 +
$ zypper install open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin

Revision as of 08:27, 12 June 2017

API status: In Development

IN PROGRESS - OX Facade for Mobile

General Information

The Mobile API Facade is an additional server component for OX App Suite which is required for OX Mail App v2.0. The component proxies the requests of apps to the middleware and optimizes them for usage by mobile clients by limiting their number and size.

Requirements

The OX Facade has to be installed alongside an OX App Suite installation. It requires at least OX App Suite v7.8.4.

OX Facade API

Further information about the OX Facade API can be found at: https://documentation.open-xchange.com/components/facade/develop/

OX Mail Server-side Installation and Configuration on OX App Suite v7.8.x

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

Available packages

OX Facade is available with the following backend packages:

  • open-xchange-mobile-push-certificates - Certificates for cloud-based push notifications
  • open-xchange-mailapp-backend - The main server components for OX Mail
  • open-xchange-mobile-push-plugin - Provides Push functionality

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

Redhat Enterprise Linux 6 or CentOS 6

Add the following repositories to your Open-Xchange yum configuration:

 [open-xchange-backend-updates]
name=Open-Xchange-backend-updates
baseurl=https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/stable/backend/updates/RHEL6/
gpgkey=https://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m

[open-xchange-mail] name=Open-Xchange-mail baseurl=https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/mail/stable/mail/RHEL6/ gpgkey=https://software.open-xchange.com/oxbuildkey.pub enabled=1 gpgcheck=1 metadata_expire=0m
[open-xchange-mailapp] name=Open-Xchange-mailapp baseurl=https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/mail/stable/mailapp/RHEL6/ gpgkey=https://software.open-xchange.com/oxbuildkey.pub enabled=1 gpgcheck=1 metadata_expire=0m

and run

$ yum install open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin

Redhat Enterprise Linux 7 or CentOS 7

Add the following repositories to your Open-Xchange yum configuration:

 [open-xchange-backend-updates]
name=Open-Xchange-backend-updates
baseurl=https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/stable/backend/updates/RHEL7/
gpgkey=https://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m

[open-xchange-mail] name=Open-Xchange-mail baseurl=https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/mail/stable/mail/RHEL7/ gpgkey=https://software.open-xchange.com/oxbuildkey.pub enabled=1 gpgcheck=1 metadata_expire=0m
[open-xchange-mailapp] name=Open-Xchange-mailapp baseurl=https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/mail/stable/mailapp/RHEL7/ gpgkey=https://software.open-xchange.com/oxbuildkey.pub enabled=1 gpgcheck=1 metadata_expire=0m

and run

$ yum install open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin

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

Add the following repositories to your Open-Xchange apt configuration:

deb https://software.open-xchange.com/products/appsuite/7.8.2/backend/updates/DebianWheezy /
deb https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/mail/stable/mail/DebianWheezy /
deb https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/mail/stable/mailapp/DebianWheezy /

and run

$ apt-get update
$ apt-get install open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin

Debian GNU/Linux 8.0 (Jessie)

Add the following repositories to your Open-Xchange apt configuration:

deb https://software.open-xchange.com/products/appsuite/stable/backend/updates/DebianJessie /
deb https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/mail/stable/mail/DebianJessie /
deb https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/mail/stable/mailapp/DebianJessie /

and run

$ apt-get update
$ apt-get install open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin


SUSE Linux Enterprise Server 11 (valid until v7.8.2)

$ zypper ar https://LDBUSER:LDBPASSWORD@software.open-xchange.com/products/appsuite/7.8.2/backend/updates/SLES11 backend-updates
$ zypper ar https://software.open-xchange.com/products/mail/stable/mail/SLES11 mail
$ zypper ar https://software.open-xchange.com/products/mail/stable/mailapp/SLES11 mailapp
$ zypper ref
$ zypper install open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin

SUSE Linux Enterprise Server 12

$ zypper ar https://LDBUSER:LDBPASSWORD@software.open-xchange.com/products/appsuite/stable/backend/updates/SLE_12 backend-updates
$ zypper ar https://software.open-xchange.com/products/mail/stable/mail/SLE_12 mail
$ zypper ar https://software.open-xchange.com/products/mail/stable/mailapp/SLE_12 mailapp
$ zypper ref
$ zypper install open-xchange-mobile-push-certificates open-xchange-mailapp-backend open-xchange-mobile-push-plugin